The Order REST API contains resources that cover aspects of the checkout process and order handling.

A typical checkout process requires a series of REST requests, some of which are based on one another and must therefore take place in a defined sequence. This cannot be sufficiently represented by the OpenAPI documentation only.
Detailed descriptions of various checkout scenarios can be found in the Business Guide "Basket & Checkout REST API" in the Intershop Knowledge Base.

Please also refer to the Basket REST API v1, which you can use to create and prepare baskets for checkout.

API Versioning & Accept-Header

Media-type-based versioning is used to distinguish between different API versions. For requests to the Order REST API v1, the REST client must set the following HTTP Accept header:

Accept: application/vnd.intershop.order.v1+json

Changelog

Version 1.5.0

• Added new query parameters lineItem_product, lineItem_customerProductID and lineItem_partialOrderNo to OrderListResource for order search based on line item search criteria
• Added new query parameters documentNumber, customerOrderID, creationDateFrom, creationDateTo to OrderListResource for order search
• Deprecated query parameter orderDocumentNo in order search for later removal, use the new parameter documentNumber instead
• Deprecated query parameter customerOrderId in order search for later removal, use the new parameter customerOrderID instead
• Deprecated query parameter creationFromDate in order search for later removal, use the new parameter creationDateFrom instead
• Deprecated query parameter creationToDate in order search for later removal, use the new parameter creationDateTo instead

Version 1.4.0

• BETA | Added new attribute customFields to OrderRO_v1 and OrderLineItemRO_v1
• Added new query parameters limit and offset to OrderListResource for pagination of orders from order search
• Deprecated query parameter page[limit] in order search for later removal, use the new parameter limit instead
• Added new query parameters orderDocumentNo, customerOrderId, creationFromDate, creationToDate to OrderListResource for order search

Version 1.3.0

• Added this changelog
• Deprecated externalOrderReference in OrderRO_v1 for later removal, use the new customerOrderID instead
• Added new attribute supplierOrderID to OrderRO_v1
• Added new attributes customerProductID and partialOrderNo to OrderLineItemRO_v1