List all orders

get https://{youraccountname}.api-us1.com/api/3/ecomOrders

List all existing e-commerce order resources.

{
  "ecomOrders": [
    {
      "externalid": "3246315234",
      "source": "1",
      "email": "alice@example.com",
      "currency": "USD",
      "connectionid": "1",
      "customerid": "1",
      "orderUrl": "https://example.com/orders/3246315233",
      "shippingMethod": "UPS Ground",
      "totalPrice": 9111,
      "shippingAmount": 200,
      "taxAmount": 500,
      "discountAmount": 100,
      "externalCreatedDate": "2016-09-13T16:41:39-05:00",
      "totalProducts": 2,
      "createdDate": "2019-09-05T12:16:18-05:00",
      "updatedDate": "2019-09-05T12:16:18-05:00",
      "state": 1,
      "connection": "1",
      "orderProducts": [
        "1",
        "2"
      ],
      "customer": "1",
      "orderDate": "2016-09-13T16:41:39-05:00",
      "tstamp": "2019-09-05T12:16:18-05:00",
      "links": {
        "connection": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/connection",
        "customer": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/customer",
        "orderProducts": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderProducts",
        "orderDiscounts": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts",
        "orderActivities": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderActivities"
      },
      "id": "1"
    },
    {
      "externalid": "47856739866",
      "source": "1",
      "email": "example@example.com",
      "currency": "USD",
      "connectionid": "1",
      "customerid": "2",
      "orderUrl": "https://example.com/orders/47856739866",
      "shippingMethod": "UPS Ground",
      "totalPrice": 3450,
      "shippingAmount": 100,
      "taxAmount": 0,
      "discountAmount": 0,
      "externalCreatedDate": "2019-09-06T2:10:00-05:00",
      "totalProducts": 2,
      "createdDate": "2019-09-06T2:10:00-05:00",
      "updatedDate": "2019-09-06T2:10:00-05:00",
      "state": 1,
      "connection": "1",
      "orderProducts": [
        "3"
      ],
      "customer": "2",
      "orderDate": "2019-09-06T2:10:00-05:00",
      "tstamp": "2019-09-06T2:10:00-05:00",
      "links": {
        "connection": "https://exampleaccount.api-us1.com/api/3/ecomOrders/2/connection",
        "customer": "https://exampleaccount.api-us1.com/api/3/ecomOrders/2/customer",
        "orderProducts": "https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderProducts",
        "orderDiscounts": "https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderDiscounts",
        "orderActivities": "https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderActivities"
      },
      "id": "2"
    },
  ],
  "meta": {
    "total": "2"
  }
}

Query Params

filters[connectionid]

int32

Filter by the connection id. Must be greater than 0.

filters[externalid]

int32

Filter by the external id of the order.

filters[externalcheckoutid]

string

Filter by the external checkout id

filters[email]

string

Filter by the customer email address.

filters[state]

int32

Filter by the state of the order. 0 = Pending, 1 = Completed, 2 = Abandoned, 3 = Recovered, 4 = Waiting (Customer checked out but payment is not yet completed)

filters[customerid]

string

Filter by the customer id

filters[external_created_date]

date

Filter by the external created date

orders[connectionid]

int32

Order by connection ID. Accepted values are ASC or DESC.

orders[externalid]

int32

Order by external ID. Accepted values are ASC or DESC.

orders[externalcheckoutid]

string

Order by external checkout ID. Accepted values are ASC or DESC.

orders[email]

string

Order by email. Accepted values are ASC or DESC.

orders[state]

int32

Order by state. Accepted values are ASC or DESC.

orders[customerid]

string

Order by customer ID. Accepted values are ASC or DESC.

orders[external_created_date]

date

Order by external created date. Accepted values are ASC or DESC.

Responses

200200

422422