Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
any OK
Create a new order item This endpoint allows the creation of a new item that will be added to an existing order.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
POST request body
OptionalxPfStoreId: stringUse 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.
any OK
Create a new order
This endpoint allows the creation of a new order in which the default status will be draft.
OptionalxPfStoreId: stringUse 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.
OptionalrequestBody: { POST request body
Optionalcustomization?: CustomizationOptionalexternal_Order ID from the external system
Array of order items
The recipient data.
Optionalretail_Optionalshipping?: stringShipping method. Defaults to 'STANDARD'
any OK
Create a new order estimation task Use this endpoint to estimate orders with items.
OptionalxPfStoreId: stringUse 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.
OptionalrequestBody: { POST request body
Array of order items
The recipient data.
Optionalretail_any OK
Delete Order Item Remove a single item from the order.
Item ID (integer) or Item External ID (string prepended with "@" symbol)
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
void
Delete an order
Delete the order if it can be deleted. An order can be deleted if it's status is
draft, failed or cancelled. The order must also have not been charged yet
and there must be no payments pending.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
void
Retrieve an invoice
Returns the invoice for an order as a base64 encoded document. Decoding the base64 content can be different depending on the client, for most browsers this format will alow you to view and display the invoice data:application/pdf;base64,{the_base_64_content_string}.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve a single order item This endpoint will retrieve a single order item specified in the request.
Item ID (integer) or Item External ID (string prepended with "@" symbol)
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve a list of order items This endpoint retrieves the list of items that belong to the order.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
Optionaltype: stringType of items returned (order_item, branding_item). By default all items are returned.
The number of results to return per page.
Optionaloffset: numberThe number of results to not include in the response starting from the beginning of the list.
This can be used to return results after the initial 100. For example, sending offset 100
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve a single order Retrieve a single order from the specified store. The result object will contain links to the same resource, order items, and shipments.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve an order estimation task Retrieve an order cost estimation task from a specific store. Estimation results are only available for one hour after cost estimation task is done.
Order estimation task ID.
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve a list of orders Retrieve a list of orders from a specific store. The order list will be paginated with twenty items per page by default.
The number of results to return per page.
Optionaloffset: numberThe number of results to not include in the response starting from the beginning of the list.
This can be used to return results after the initial 100. For example, sending offset 100
OptionalxPfStoreId: stringUse 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.
any OK
Retrieve a list of shipments Shipments contain information about how and when your orders items will be delivered and fulfilled.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
The number of results to return per page.
Optionaloffset: numberThe number of results to not include in the response starting from the beginning of the list.
This can be used to return results after the initial 100. For example, sending offset 100
any OK
Update an order item Make a partial update of an order item. NOTE that the source of the order item can't be changed via a PATCH request, to create an order item from another source you must delete the current one and add a new one.
Item ID (integer) or Item External ID (string prepended with "@" symbol)
Order ID (integer) or Order External ID (string prepended with "@" symbol)
PATCH request body
OptionalxPfStoreId: stringUse 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.
any OK
Update an order Make a partial update of an order.
Order ID (integer) or Order External ID (string prepended with "@" symbol)
OptionalxPfStoreId: stringUse 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.
OptionalrequestBody: { PATCH request body
Optionalcustomization?: CustomizationOptionalexternal_Order ID from the external system
Optionalorder_Array of order items
Optionalrecipient?: AddressThe recipient data.
Optionalretail_Retail costs
Optionalcurrency?: stringThe code of the currency in which the retail costs are returned.
Optionaldiscount?: stringDiscount sum.
Optionalshipping?: stringShipping costs.
Optionaltax?: stringSum of taxes (not included in the item price).
Optionalshipping?: stringShipping method. Defaults to 'STANDARD'
any OK
Confirm an order This endpoint allows customers to confirm the order and start the fulfillment in the production facility.