GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussions API Change LogOpenAPI Specification Download
API Endpoints
Home
  1. Public API
  2. Retail Experience Cloud Bridge

Schedule Customer Shipments

post
https://api.talkdeskapp.com/erc/ecommerce/customers//shipments/schedule

Schedule the customer shipment for the provided order id or delivery id.

Required fields:

  • customer_id
  • id (slot ID to schedule)

A successful request schedules the shipment slot and returns the shipment details.

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

Scope

erc-ecommerce-customers:write

Path Params
string
required
length between 1 and 255

The unique identifier for the customer who wants to schedule the shipment.

Query Params
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.

Body Params

The shipment slot to schedule

The customer shipment slot to schedule, notes that at least one of order id, delivery id is required

string
required
length between 1 and 255

The slot id which user wants to schedule

string
length between 1 and 255

The order id

string
length between 1 and 255

The delivery id

Responses
200

OK

Updated 2 months ago

Did this page help you?
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 2 months ago

Did this page help you?