latestOpenAPI 3.0.02026-08-101013821017.9 KB

4b69392f93b9

Orders

Get shopper order

To get a shopper's order by ID, specify the order ID in the {id} URI path parameter.

get/v1/shoppers/me/orders/{orderId}

Path parameters

orderIdstring required

Provide the order's identifier.

Query parameters

tokenstring

Provide the authorized or anonymous token for a shopper.

orderStatestring required

Specifies the current state of the order. The possible values are as follows. Open, In Process, Cancelled, or Submitted.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

Response

Successful response.

OR