My Orders

This endpoint can only be used with an access token created with the password flow or with an anonymous session. It gives access to orders that belong to the customer or the anonymous session linked to the access token.

Representations

Responses are equal to the responses on the order endpoint, but requests differ. Orders can not be changed via this endpoint once created, and paymentState and orderNumber can not be set.

MyOrderFromCartDraft

  • id - String - Required
    The unique ID of the cart from which an order is created.
  • version - Number - Required

Get Order by ID

Endpoint: /{projectKey}/me/orders/{id}
Method: GET
OAuth2 Scopes: manage_my_orders:{projectKey}
Response Representation: Order

Query Orders

Endpoint: /{projectKey}/me/orders
Method: GET
OAuth2 Scopes: manage_my_orders:{projectKey}
Response Representation: PagedQueryResult with the results array of Order
Query Parameters:

Create Order from a Cart

Creates an order from a Cart. The cart must have a shipping address set which is used for the tax calculation.

The cart data is copied to the created order.

Endpoint: /{projectKey}/me/orders
Method: POST
OAuth2 Scopes: manage_orders:{projectKey}
Request Representation: MyOrderFromCartDraft
Response Representation: Order

Specific Error Codes:

This method produces the OrderCreated message.