API ReferenceHelp CenterAPI Status
API Reference
API ReferenceHelp CenterAPI Status
API Reference

Edit Tracker

put
https://sandbox.api.deliverysolutions.co/api/v2/tracker/
Path Params
string
required

Unique Id of the tracker generated in your system and configured in our system, has to be unique.

Body Params
string

Tracking number given by the carrier. trackingNumber is mandatory in case provider is passed.

string

Name of the provider configured in business. Provider is mandatory in case trackingNumber is passed.

double

Value of the order in major units as decimals. e.g., 10.00 or 116.50.

string

Provider's service type. Provider is mandatory in case serviceType is passed.

pickupTime
object

Time Window in which the package will be ready to be picked up. null defaults to ASAP.

dropoffTime
object

Time Window in which the package must be delivered by. null defaults to ASAP. Not needed for pickup type of tracker.

deliveryContact
object

Customer Information

string

Delivery instructions for drop-off.

string

Pickup instruction for the location. This will override the instructions configured with the pickup location.

string

Group ID allows you to group a number of orders and trackers together. It further helps in providing a combined post-purchase experience for them.

itemList
array of objects

Array of items in the tracker. Details offer improved post-purchase experiences. In the absence of packages, cubic dimensions and weight will be derived from this list

itemList
string

Preferred locale by the customer for a tracker. Value to be sent in the format of language code(ISO-639-1)-country code(ISO-3166-1-alpha-2). E.g fr-CA, en-US. Here, fr, en are language codes & CA, US are country codes.

string

Date at which the order was originally created in Unix time in milliseconds. e.g., 1500616800000

Responses

Updated 10 months ago

Language
Credentials
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 10 months ago