Orders
Introduction
Through the endpoints included in the Orders section, you will be able to:
Retrieve information about the orders
Create new orders
Retrieve information about a specific order
Cancel orders
Endpoints
Orders
Create order
Get order
Delete order
Order status
Order statuses are used to track the progress of an order and provide information about its current state. You can find a more detailed list below:
Status | Description |
---|---|
Draft | Order has been submitted but not yet confirmed. |
Accepted | Order has been confirmed and is being prepared for shipment. |
Fulfilled | Order has been completed and the product(s) is ready to be shipped. |
Generated | Order has been generated |
In Progress | Order is in progress |
Cancelled | Order has been cancelled by the customer or admin. |
Refunded | Order has been refunded to the customer. |
Partial Refund | Order has been partially refunded to the customer. |
Pending | Order has been placed by the customer and is waiting for payment to be completed. |
Error | Something went wrong during the processing of the order. |
Parameters
Key | Description |
---|---|
| Unique identifier for your orders |
| When value is set to |
| Must be used when |
| This value is used to print the shipping costs shown on the Customs Declaration Papers when a shipment is sent to NON-EU countries. The value to place here is the retail shipping price you charged your end customer. It is always used in combination with items' |
| Object contains the address and required information about end customer. There is no need of billing address. |
| End customer's email address. |
| End customer's first name. |
| End customer's last name. |
| End customer's company name when the end customer is ordering on behalf of a company. |
| End customer's street name and house number. |
| Additional address. |
| End customer's city name. |
| End customer's postal/zip code. |
| End customer's country - ISO 3166-1 numeric-3 OR |
| End customer's state name - ANSI INCITS 38:2009 digit-2. It should be used in combination with |
| It should be used in combination with |
| End customer's phone number - used in case of any problems during delivery by the shipment provider. |
| An array with one or more item objects. |
| Unique identifier for your items. |
| This value will be used to print the net item cost shown on the Customs Declaration Papers when a shipment is sent to NON-EU countries. The value to place here is the net retail selling price you charged your end customer. It is always used in combination with order's |
| The number of copies to produce of this particular item. |
| The identifier of which product variant this item is, for example "DIGI-40X30-1" is for a 40x30 cm canvas. See the guideline above: Guide to get a product variant to find out which code/id to use. |
| can be used alternatively in place of |
| Can be used alternatively instead of |
| The URL to the print file for this particular item. See more detailed about the file format, resolution and aspect ratio in the "Print Files" section below. |
| A list with one or more options set for a product variant. Some product variant have required options, for example all canvas variants have 2 required options ("Canvas border" and "Stretcher frame"). The key and value of an option can either be their ids or their names. For example, the option "Canvas border" option can be added like |
Last updated