Template Title

GET

https://restapi.ordergroove.com/orders/ (COPY)

GET

/orders/ (COPY)

curl https://restapi.ordergroove.com/orders/ (COPY) \
     -H "x-api-key: <apiKey>"

{
  "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",
      "place": "2018-10-22 15:06:25",
      "cancelled": null,
      "tries": 1,
      "generic_error_count": 0,
      "status": 3,
      "type": 1,
      "order_merchant_id": null,
      "rejected_message": "{\"message\": \"Unable to ingest order 2938617 into D365. Unable to find any PaymentToken against the provided CustomerProfileID\", \"code\": \"020\"}",
      "extra_data": null,
      "locked": false,
      "oos_free_shipping": false
    }
  ]
}

{Single sentence describing the function.}

Authentication

x-api-keystring

Application API Scope — server-to-server, sent in the x-api-key header. See Authentication.

authorizationstring

Storefront API Scope — client-side, scoped to one customer, sent as a signature in the authorization header. See Authentication.

Query parameters

statusintegerOptional

Order status

subscriptionstringOptional

Subscription ID

customerstringOptional

Customer ID (only available in API user scope)

placedateOptional

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

place_startdateOptional

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

place_enddateOptional

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

createddateOptional

Order’s created date exact match (yyyy-mm-dd)

created_startdateOptional

Order’s created date later or equal than parameter (yyyy-mm-dd)

created_enddateOptional

Order’s created date sooner or equal than parameter (yyyy-mm-dd)

updateddateOptional

Order’s updated date exact match (yyyy-mm-dd). On order creation is populated with same value as created field.

updated_startdateOptional

Order’s updated date later or equal than parameter (yyyy-mm-dd)

updated_enddateOptional

Order’s updated date sooner or equal than parameter (yyyy-mm-dd)

Response

200

Errors

403

Forbidden Error