latestOpenAPI 3.0.02026-08-105585620.8 KB

18e2f2e178dd

Orders API

Update order data

Updates unsubmitted order and optionally submits it for the fulfillment.

Note that you need to post only the fields that need to be changed, not all required fields.

If items array is given in the update data, the items will be:

a) updated, if the update data contains the item id or external_id parameter that alreay exists

b) deleted, if the request doesn't contain the item with previously existing id

c) created as new if the id is not given or does not already exist

put/orders/{id}

Path parameters

string required
OR
integer required

Order ID (integer) or External ID (if prefixed with @)

Query parameters

confirmboolean

Automatically submit the newly created order for fulfillment (skip the Draft phase)

Headers

X-PF-Store-Idstring

Use this to specify which store you want to use (required only for account level token).

The store IDs can be retrieved with the Get basic information about stores endpoint.

Request body

Order required— unresolved $ref

Response

OK

codeinteger

Response status code 200

resultOrder — unresolved $ref