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…

🔐
Authentication
✔️ Application API Scope
✔️ Storefront API Scope (including with trust_level: recognized)
Note: Application API Scope with Bulk Operations permission is required to list orders for more than one customer.

Response Body Definitions

Name	Type	Description	Example
merchant	string	Merchant ID	"275dbe1d77f34aca968fb75a8dbb4c82"
customer	string	Customer ID	"11100-C01"
payment	string	Payment record ID	"25e4d2761d294dd48efd96fdf668a2d9"
shipping_address	string	Shipping address record ID	"03197d2512904301aaed774a256e71c8"
public_id	string	Order Public ID	"f9cb2f93e1c845eb9de9eff46ddb3cbf"
currency_code	string	Three letter ISO currency code	"USD"
tax_total	string	Tax applied to order	"22.44"
shipping_total	string	Shipping cost applied to order	"0.00"
discount_total	string	Discount applied to order	"15.00"
total	string	Total price of order	"undefined"
created	string	Date time the order was created	"2017-02-29 00:00:00"
updated	string	Date time the order was last modified	"2025-02-29 00:00:00"
place	string	Date for order placement	"2017-02-29 00:00:00"
cancelled	string	Date of cancellation; 'null' = not cancelled	"null"
tries	integer	Number of order attempts	1
generic_error_count	integer		0
status	integer	Order status	1
type	string	Order Type	1
order_merchant_id	string	Order ID in your system	"301617"
rejected_message	string	Rejection message from merchant	""
extra_data	string	Raw JSON string that should be JSON.parse() as key/value store for any extra information	"{"some": "extra", "fields": "here"}"
locked	boolean		false
oos_free_shipping	boolean		false

When the query param ?include_has_plan=true is provided, each order object in the response will include a has_plan boolean field indicating whether the order contains at least one product with product_type=plan.

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

Authentication

Response Body Definitions

200200

403403