API Reference

Track an externally documented return

post
https://api.whereismyorder.io/v3/returns/externally-documented
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Externally documented returns request

from
object
string
required

Carrier code. If rules are to be use this parameter should be set to 'auto'.

string
required

Service code. If rules are to be use this parameter should be set to 'auto'.

string | null
Defaults to DEFAULT

Alias identifier of the cost center. If none set, DEFAULT will be assumed

string | null
required

Distribution center identifier

string
required

Reference of the shipping order in the client systems

string
required

Reference of the shipping order in the carrier systems

string

Date when the expedition is to be shipped

string | null

Description of the expedition articles (required for crossborder international expeditions if no description by parcel[items] is present)

string | null

Total amount or price of the expedition articles (required for crossborder international expeditions if no amount by parcel[items] is present)

parcels
array of objects
parcels
serviceAttributes
object

Additional service attributes. Availability depends on the carrier and service.

clientAdditionalInfo
object

Additional information, relevant for the client and/or Deliverea but not sent to the carrier

bulky
object

Parameters for bulky type shipments

customs
object

Information required for cross-border international customs

Responses

Updated over 2 years ago

Did this page help you?
Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago

Did this page help you?