API Reference

Index orders

get
https://api.prtmb.com/api/v2/accounts//orders

List orders.

To receive a CSV set the request header "Accept" to "text/csv".

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

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

Query Params
integer
Defaults to 50

Limit the number of resources in the response. Set to 0 to disable the limit and receive all resources in the response. Combine with the offset parameter for pagination.

integer
Defaults to 0

How many resources to offset from the beginning of the results (default: 0). Combined with the limit parameters this enables pagination through results. For example, to view the 2nd page of results, using the default limit of 50 the offset would be 50. For the 3rd page the offset would be 100 and so on.

string

ConversationGraph ID

string

Conversation ID

string

Checkout ID

string

AudienceMembership ID

string
enum

OrderStatus

  • open - open orders

  • `closed' - closed orders

  • cancelled - cancelled orders

Allowed:
string

Shopify Order ID

string

Shopify Order Number

string
enum
Defaults to inserted_at_asc

Sort resources in the response.

Each of the options represents a query more than one sort_by parameter:

  • inserted_at_asc - is ORDER BY inserted_at ASC

  • inserted_at_desc - is ORDER BY inserted_at DESC

Allowed:
Headers
string

Accept Header

Response

Callback

Updated over 4 years ago

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

Updated over 4 years ago