List all orders

GET  https://:account.api-us1.com/api/3/ecomOrders

• cURL

curl --request GET \
  --url https:///:account.api-us1.com/api/3/ecomOrders

• Node

var request = require("request");

var options = { method: 'GET',
  url: 'https:///:account.api-us1.com/api/3/ecomOrders' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

• Ruby

require 'uri'
require 'net/http'

url = URI("https:///:account.api-us1.com/api/3/ecomOrders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

• JavaScript

var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https:///:account.api-us1.com/api/3/ecomOrders");

xhr.send(data);

• Python

import requests

url = "https:///:account.api-us1.com/api/3/ecomOrders"

response = requests.request("GET", url)

print(response.text)

 

200 OK

{
  "ecomOrders": [
    {
      "customerid": "1",
      "connectionid": "1",
      "externalid": "3246315233",
      "source": "1",
      "orderNumber": "1057",
      "email": "[e-mail]",
      "totalPrice": "9111",
      "totalProducts": "2",
      "currency": "USD",
      "shippingMethod": "UPS Ground",
      "orderUrl": "https://example.com/orders/3246315233",
      "orderDate": "2016-09-13 17:41:39",
      "tstamp": "2017-02-07T11:36:38-06:00",
      "orderProducts": [
        "4",
        "5"
      ],
      "links": {
        "customer": "/api/3/ecomOrders/1/customer",
        "orderProducts": "/api/3/ecomOrders/1/orderProducts"
      },
      "id": "1",
      "customer": "1"
    },
    {
      "customerid": "1",
      "connectionid": "1",
      "externalid": "3246312135",
      "source": "1",
      "orderNumber": "1001",
      "email": "[e-mail]",
      "totalPrice": "14486",
      "totalProducts": "2",
      "currency": "USD",
      "shippingMethod": "Standard Shipping",
      "orderUrl": "https://example.com/orders/3246312135",
      "orderDate": "2016-05-31 11:07:52",
      "tstamp": "2017-02-07T11:38:23-06:00",
      "orderProducts": [
        "3"
      ],
      "links": {
        "customer": "/api/3/ecomOrders/2/customer",
        "orderProducts": "/api/3/ecomOrders/2/orderProducts"
      },
      "id": "2",
      "customer": "1"
    }
  ],
  "ecomOrderProducts": [
    {
      "orderid": "1",
      "connectionid": "1",
      "externalid": "PROD12345",
      "name": "Pogo Stick",
      "price": "4900",
      "quantity": "1",
      "category": "Toys",
      "tstamp": "2017-02-07T11:38:26-06:00",
      "links": {
        "ecomOrder": "/api/3/ecomOrderProducts/4/ecomOrder"
      },
      "id": "4",
      "ecomOrder": "1"
    },
    {
      "orderid": "1",
      "connectionid": "1",
      "externalid": "PROD23456",
      "name": "Skateboard",
      "price": "3000",
      "quantity": "1",
      "category": "Toys",
      "tstamp": "2017-02-07T11:38:26-06:00",
      "links": {
        "ecomOrder": "/api/3/ecomOrderProducts/5/ecomOrder"
      },
      "id": "5",
      "ecomOrder": "1"
    },
    {
      "orderid": "2",
      "connectionid": "1",
      "externalid": "PROD119993",
      "name": "Galaxy S7 case",
      "price": "7000",
      "quantity": "2",
      "category": "Mobile",
      "tstamp": "2017-02-07T11:38:23-06:00",
      "links": {
        "ecomOrder": "/api/3/ecomOrderProducts/3/ecomOrder"
      },
      "id": "3",
      "ecomOrder": "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[email]

string                                         Filter by the customer email address.