Documentation
Discussions

Creates Order

post
https://preview.threekit.com/api/orders

Creates an order and generates an UUID as well as a shortID which can be used to retrieve the order. Any token (public or private) can be used to create an order. NOTE - 'items' has been deprecated and replaced by 'cart'. In order to maintain backwards compatibility, items will still be populated with incoming data. However it will converted to the correct format and also saved in 'cart'. If the data is in incorrect format, it will not be touched. Please ensure that 'cart' field is used instead of 'items' field.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

Body Params

Order creation information.

string

Name of the order. It can only be maximum 255 characters long

string

ID of the customer.

string

ID of the original organization.

platform
object

Platform details. This will be an object and contain the e-commerce order ID, platform name and the store name in the e-Commerce platform. See example body schema for the format

metadata
object

Metadata related to this order. Attribute keys with valid attribute option values.

items
array of objects
deprecated

Deprecated, This only exists for backwards compatibility. Please use 'cart' instead

items
cart
array of objects

Items related to this order. This should be an array of objects. Each object should contain a configuration id and a count. Arbitary metadata can be optionally added to each object . See example schema for the format.

cart
derivative
object

Derivative related to this order. Attribute keys with valid attribute option values.

string
enum

Status of this order. Default value of the status is 'New'

Allowed:
string

Organization which owns the order.

Responses

Updated about 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago