GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home

Get Customer Orders

get
https://api.talkdeskapp.com/erc/ecommerce/customers//orders

Read the customer orders provided by the customer id.

Required fields:

  • customer_id

A successful request returns the list of orders for the provided customer.

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

Scope

erc-ecommerce-orders:read

Path Params
string
required

The customer id

Query Params
string
length between 1 and 255

The brand of the provider you want to filter by. If the account is multi-brand, this parameter is required.

integer
1 to 50
Defaults to 10

The amount of orders we want to get

string

The opaque string that represents the cursor after which the 'limit' amount of orders are retrieved

string

The order number (or order number prefix) we want to search by

string
length between 1 and 255
Defaults to purchase_datetime:desc

The parameter to sort by. Use order_by=key1:desc for descending, order_by=key1:asc for ascending. Allowed fields: purchase_datetime, id, order_number, items_number. Multiple fields can be comma-separated (e.g. purchase_datetime:desc,order_number:asc).

Responses

Updated about 2 months ago

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

Updated about 2 months ago