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"
  ]
}
'

200

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

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