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

Name	Type	Required	Example
`user_id`	Integer	N	`1001` Filter orders to a single user ID
`status`	String	N	`Received` Filter orders to a certain status One of: Received, Reviewed, Shipped, Error, Declined, Refunded, Voided, Partial, Pending
`date_start`	Date String	N	`2010-01-01` Date range beginning (inclusive)
`date_end`	Date String	N	`2010-01-31` Date range end (inclusive)
`country`	String	N	`US` A two-character country code
`limit`	Integer	N	`100` Specify a maximum amount of results to receive

Response

Name	Type	Example
`count`	Integer	`1`
`orders`	JSON 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"}]`