Update Order

put

https://preview.threekit.com/api/orders/{id}

Updates an existing order from its ID or short ID. Only works for orders belonging to the token's organization. This API accepts conditionally accepts both tokens a) If the order status is 'List' or 'In Cart', either public or private token can be used to update the order details b) If the order status is 'New', 'In Progress' or 'Complete', only a private token can be used to update the order details

Path Params

string

required

ID or short ID of the order to be modified

Query Params

bearer_token

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 update information.

name

string

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

status

string

enum

Status of this order.

Allowed:

metadata

object

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

derivative

object

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

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the modified order and its information

401The token provided is not authorized to make the request or the token is invalid.

403User provides the ID of an order which cannot be edited using a public token

404No order was found for the given ID