List

get

https://restapi.ordergroove.com/orders/

Lists all of a single user’s orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

int32

Order status

subscription

string

Subscription ID

customer

string

Customer ID (only available in API user scope)

place

date

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

place_start

date

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

place_end

date

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

created

date

Orders whose created date matches exactly (yyyy-mm-dd)

created_start

date

Orders whose created datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

created_end

date

Orders whose created datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

updated

date

Orders whose updated date matches exactly (yyyy-mm-dd). On order creation it is populated with same value as created field.

updated_start

date

Orders whose updated datetime is greater than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

updated_end

date

Orders whose updated datetime is less than or equal to the given datetime (yyyy-mm-dd or yyyy-mm-ddThh:mm:ss)

include_has_plan

boolean

Defaults to false

If true, each order object in the response includes a has_plan field indicating whether that order contains at least one product with product_type=plan

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

403403