Order - Add

Create a new manual order with specified items, shipping address, and order details.

POST /order/add

Order - Add

cURL

curl --request POST \
  --url https://api.skulabs.com/order/add \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "store_id": "507f1f77bcf86cd799439011",
  "order_number": "<string>",
  "stash": {},
  "tags": [
    "507f1f77bcf86cd799439011",
    "507f1f77bcf86cd799439012"
  ]
}
'

import requests

url = "https://api.skulabs.com/order/add"

payload = {
    "store_id": "507f1f77bcf86cd799439011",
    "order_number": "<string>",
    "stash": {},
    "tags": ["507f1f77bcf86cd799439011", "507f1f77bcf86cd799439012"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    store_id: '507f1f77bcf86cd799439011',
    order_number: '<string>',
    stash: {},
    tags: ['507f1f77bcf86cd799439011', '507f1f77bcf86cd799439012']
  })
};

fetch('https://api.skulabs.com/order/add', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.skulabs.com/order/add",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'store_id' => '507f1f77bcf86cd799439011',
    'order_number' => '<string>',
    'stash' => [
        
    ],
    'tags' => [
        '507f1f77bcf86cd799439011',
        '507f1f77bcf86cd799439012'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.skulabs.com/order/add"

	payload := strings.NewReader("{\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"stash\": {},\n  \"tags\": [\n    \"507f1f77bcf86cd799439011\",\n    \"507f1f77bcf86cd799439012\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.skulabs.com/order/add")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"stash\": {},\n  \"tags\": [\n    \"507f1f77bcf86cd799439011\",\n    \"507f1f77bcf86cd799439012\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.skulabs.com/order/add")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"store_id\": \"507f1f77bcf86cd799439011\",\n  \"order_number\": \"<string>\",\n  \"stash\": {},\n  \"tags\": [\n    \"507f1f77bcf86cd799439011\",\n    \"507f1f77bcf86cd799439012\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "store_id": "507f1f77bcf86cd799439011",
  "order_number": "<string>"
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

{
  "error": {
    "message": "<string>",
    "statusCode": 123,
    "code": "<string>",
    "overview": "<string>",
    "origin": "<string>",
    "skulabsTraceId": "<string>",
    "user_error": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

store_id · string · required

Store ID to add the order to

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number for the new order

stash · object · required

Order data object

tags · string[]

Tag IDs to apply to the order (ObjectId strings referencing the tag collection)

Example:

[
  "507f1f77bcf86cd799439011",
  "507f1f77bcf86cd799439012"
]

Response

200

application/json

Order added

success · boolean · required

Whether the operation succeeded

store_id · string · required

Store ID of the created order

Example:

"507f1f77bcf86cd799439011"

order_number · string · required

Order number of the created order