API Reference

List Orders

get
https://marketplace-integrations.nelo.co/v1/admin/orders

Retrieve a list of Orders. The orders can be filtered by fields such as status or display_id. The order can also be paginated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

term to search orders' shipping address, first name, email, and display ID

string

Filter by ID.

status
array of strings

Filter by status

status
fulfillment_status
array of strings

Filter by fulfillment status

fulfillment_status
payment_status
array of strings

Filter by payment status

payment_status
string

Filter by display ID

string

Filter by cart ID

string

Filter by customer ID

string

Filter by email

Filter by region IDs.

ID of a Region.

string

Filter by currency codes.

string

Filter by tax rate.

created_at
object

Filter by a creation date range.

updated_at
object

Filter by an update date range.

canceled_at
object

Filter by a cancelation date range.

sales_channel_id
array of strings

Filter by Sales Channel IDs

sales_channel_id
integer
Defaults to 0

The number of orders to skip when retrieving the orders.

integer
Defaults to 50

Limit the number of orders returned.

string

Comma-separated relations that should be expanded in the returned order.

string

Comma-separated fields that should be included in the returned order.

string

Field to sort retrieved orders by.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 9 months ago