API Service Documentation

Command: get_orders

Retrieves a listing of orders in JSON format
Address data is tailored for shipping
A request with no filters present is treated as an error to prevent a potentially large response

Request

NameTypeRequiredExample
user_idIntegerN1001

Filter orders to a single user ID

statusStringNReceived

Filter orders to a certain status
One of: Received, Reviewed, Shipped, Error, Declined, Refunded, Voided, Partial, Pending

date_startDate StringN2010-01-01

Date range beginning (inclusive)

date_endDate StringN2010-01-31

Date range end (inclusive)

countryStringNUS

A two-character country code

limitIntegerN100

Specify a maximum amount of results to receive

Response

NameTypeExample
countInteger1
ordersJSON Encoded String[{"order_id":"100","date_added":"2010-01-01 23:59:59","userID":"1001","products":[{"code":"abc-123","name":"Generic Product","price":"19.95","qty":"2"}],"first_name":"John","last_name":"Smith","company":"John's Construction","address_1":"123 Fake St","address_2":"Apt 2B","city":"Springfield","region":"IL","postal_code":"12345","country":"US","phone":"8005551234","email":"john.smith@example.com"}]