Skip to content
ShopentlyLearn
English

Orders

Retrieve orders from your store and send them to other systems. View their details, check available statuses and change an order’s status or payment status.

Operations

Available order statusesCheck which statuses you can assign to an order. GET Order listFind orders by number, status or creation date. GET Order detailsGet order items, customer details, delivery and totals. GET Changing payment statusUpdate the payment status recorded for an order. PATCH Changing order statusAssign one of your store’s available statuses to an order. PATCH Orders · Product filesList the product files attached to this order. Choose a category permitted by your API key. GET Orders · Digital releasesRead releases already acquired with this order. Historical update terms do not grant access to new files. GET Orders · Download · FileDownload one file attached to this order. Every request checks your token and the purchase’s current access. GET Orders · HeadersCheck access and download headers without receiving the file body. The same permissions as GET apply. HEAD List digital order allocationsList the individual units assigned to an order, including pending, replaced and deleted items. The list never reveals the code itself. GET Read an allocated code or fileDownload one specific allocation from an order. Codes return JSON; files return binary content. GET Check allocated content headersCheck access and response headers for a specific order allocation without downloading its body. HEAD Delete allocated digital contentPermanently remove the content of an issued unit while preserving its order and warehouse history. POST Replace an order allocationGive the buyer a replacement from the existing available pool. The original allocation remains in history. POST

How it works

The list contains order summaries. For purchased products and full totals, get the details of an order. If you already know its identifier, you can go straight to the details.

Product files

List the product files attached to this order. Choose a category permitted by your API key. Download one file attached to this order. Every request checks your token and the purchase’s current access.

Choose a valid PDF, ZIP, EPUB, MP3, MP4, WebP, PNG, JPG, SVG or AVIF file. Up to 250 MiB per file. A product can have up to 20 active files.