Create Tracker

post

https://sandbox.api.deliverysolutions.co/api/v2/tracker

Use this API to create a tracker using the tracking number provided by the carrier.

Body Params

provider

string

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

storeExternalId

string

StoreExternalId of the pickup location. Either storeExternalId or pickup is mandatory.

trackerExternalId

string

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

trackingNumber

string

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

type

string

Tracker type. Options are delivery/ in-store-pickup/ curbside/ shipping. Defaults to shipping.

groupId

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.

orderValue

double

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

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

deliveryAddress

object

Address to deliver the package to. Not needed for tracker type: in-store-pickup and curbside.

packages

array of objects

Package details. Package dimension and weight details of trackers.

packages

pickupInstructions

string

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

deliveryInstructions

string

Delivery instructions for drop-off.

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

barcodes

array of strings

Barcodes sent to the provider for scanning the packages

barcodes

pickup

object

Information about the pickup. Either storeExternalId or pickup is mandatory.

locale

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.

createdDate

int32

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

Responses

200200

400400