Get Shipment Available Slots

get

https://api.talkdeskapp.com/erc/ecommerce/customers/shipments/available-slots

Read the customer shipment available slots for the provided customer id, order id or delivery id.

A successful request returns the list of available shipment slots.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

erc-ecommerce-customers:read

Query Params

customer_id

string

length between 1 and 255

The unique identifier for the customer whose shipment available slots need to be retrieved.

order_id

string

length between 1 and 255

The order id you want to query.

delivery_id

string

length ≤ 255

The delivery id you want to query.

start_time

date-time

The start time for the shipment available slots query.

end_time

date-time

The end time for the shipment available slots query.

zip_code

string

length between 5 and 10

The zip code for the shipment available slots query.

brand

string

length between 1 and 255

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

limit

integer

1 to 100

Defaults to 50

The amount of shipment available slots you want to get.

cursor

string

length between 1 and 255

The opaque string that represents the cursor after which the 'limit' amount of available slots 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 available slots found for the provided customer id.

400Bad Request

401Unauthorized

403Forbidden

404Not found

405Method not supported

500Internal Server Error

502Bad Gateway