Get Customer Shipments

get

https://api.talkdeskapp.com/erc/ecommerce/customers/{customer_id}/shipments

Read the customer shipments for the provided customer id.

Required fields:

customer_id

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

erc-ecommerce-customers:read

Path Params

customer_id

string

required

length between 1 and 255

The unique identifier for the customer whose shipments need to be retrieved.

Query Params

order_id

string

length between 1 and 255

The order id you want to query.

order_ids

array of strings

The order id array you want to query.

order_ids

shipping_provider

string

length between 1 and 255

The shipping provider of shipments you want to query.

tracking_number

string

length between 1 and 255

The tracking number of shipments you want to query.

item_id

string

length between 1 and 255

The item id you want to query.

product_id

string

length between 1 and 255

The product id you want to query.

delivery_id

string

length between 1 and 255

The delivery id you want to query.

delivery_statuses

array of strings

The array of delivery statuses you want to filter by.

delivery_statuses

brand

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.

limit

integer

1 to 100

Defaults to 50

The amount of shipments you want to get.

cursor

string

length between 1 and 255

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

order_by

string

length between 1 and 255

The parameter to be sorted for. Use order_by=key1:desc for descending, order_by=key1:asc for ascending.

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

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

application/json

Scope

200The list of customer shipments found for the provided customer id.

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method not supported

500Internal Server Error

502Bad Gateway