v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

List

Lists all of a single user’s orders.

get/orders/

Query parameters

statusinteger

Order status

subscriptionstring

Subscription ID

customerstring

Customer ID (only available in API user scope)

placestring date

Order's place date exact match (yyyy-mm-dd)

place_startstring date

Order's place date later or equal than parameter (yyyy-mm-dd)

place_endstring date

Order's place date sooner or equal than parameter (yyyy-mm-dd)

createdstring date

Orders whose created date matches exactly (yyyy-mm-dd)

created_startstring date

Orders whose created datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

created_endstring date

Orders whose created datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

updatedstring date

Orders whose updated date matches exactly (yyyy-mm-dd). On order creation it is populated with same value as created field.

updated_startstring date

Orders whose updated datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

updated_endstring date

Orders whose updated datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

include_has_planboolean

If true, each order object in the response includes a has_plan field indicating whether that order contains at least one product with product_type=plan

Response

200

Example response

{
  "results": [
    {
      "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
      "customer": "00026001",
      "payment": "394a7f26d61611e88b4abc764e1043b0",
      "shipping_address": "c4cd7f86ccc411e8ada3bc764e101db1",
      "public_id": "6120b166d62d11e8aaf0bc764e107990",
      "sub_total": "95.12",
      "tax_total": "0.00",
      "shipping_total": "0.00",
      "discount_total": "91.78",
      "total": "95.12",
      "created": "2018-10-22 14:05:02",
      "updated": "2018-10-22 14:05:02",
      "place": "2018-10-22 15:06:25",
      "tries": 1,
      "status": 3,
      "type": 1,
      "rejected_message": "{\"message\": \"Unable to ingest order 2938617 into D365. Unable to find any PaymentToken against the provided CustomerProfileID\", \"code\": \"020\"}"
    }
  ]
}