Entities

Last updated last month

Delivery

Name

Description

Schema

cod optional

Total amount charged by the shipper in cash, if the recipient did not pay before via bank transfer or credit card online.

number

dropoff required

dropoff

id optional

integer (int32)

metadata optional

JSON string for additional data given by the developer for their own use.

metadata

packages required

Product list attached to task.

< Package > array

pickup required

pickup

quoteId optional

The quota of a delivery.

integer (int32)

referenceId optional

Reference ID to index this task with an ID from your system. Used for integrations with other platforms (string)(optional).

string

sendEmail optional

Tracking email configuration for client.

boolean

sendSMS optional

Tracking sms custom configuration for companies .

boolean

status optional

string

dropoff

Name

Description

Schema

contact required

contact

date optional

Datetime in UNIX format in ms

number

location required

Place

contact

Name

Schema

email required

string

name required

string

phonenumber optional

string

metadata

Name

Description

Schema

customDeveloperLabel optional

Custom value from Developer

string

pickup

Name

Description

Schema

contact required

contact

date optional

Datetime in UNIX format in ms

number

location required

Place

contact

Name

Schema

email required

string

name required

string

phonenumber required

string

Package

Items to be delivered

Name

Description

Schema

extraInsurance optional

In case this case needs extra insurance

extraInsurance

fragile optional

Boolean to specify if the box is fragile

boolean

id optional

Product id represented in the client's platform

string

name required

box product name

string

qty required

Total amount of similar products

integer

size required

Product size refer to the table of sizes

number

extraInsurance

Name

Description

Schema

amount optional

Amount defined for the extra insurance

number

Place

Name

Description

Schema

address required

625 8th Ave, New York, NY 10018, USA

string

instructions optional

Right in front of New York Times Building

string

lat optional

Example : "-23.6028998"

string

lng optional

Example : "-46.6762638"

string

warehouse optional

Unique warehouse Identifier

string

Quote

Name

Description

Schema

city required

city Identifier

string

companyId optional

Company Identifier

string

cost optional

Quote price Example : 8.99

number

currency optional

Price currency

string

deliveryEndTime optional

UNIX Time when drop-off ends

string

deliveryStartTime optional

UNIX Time when drop-off starts

string

distance optional

Total distance in KM for the delivery

number

dropoff required

dropoff

expiration optional

Time in minutes before the quote expires

integer (int32)

pickup required

pickup

pickupEndTime optional

UNIX Time when pick up ends in ms

string

pickupStartTime optional

UNIX Time when pick up starts in ms

number

pickupMaxAvailableTime optional

UNIX Time when the pick up is valid until ms (Useful for flexible quotes)

number

quoteId required

unique identifier for the quote Example : 1560

integer (int32)

size required

Total size of the delivery

enum (xs, s, m, l, xl)

dropoff

Name

Schema

contact optional

contact

location required

Place

contact

Name

Schema

email required

string

name required

string

phonenumber required

string

pickup

Name

Schema

contact optional

contact

location optional

Place

contact

Name

Schema

email required

string

name required

string

phonumber required

string

Step

Entity which represents the activity that a shipper does in a stop

Name

Description

Schema

activity optional

It can be 'pickup' or 'delivery'

string

date optional

Time when the activity starts

string (date-time)

id optional

Unique Delivery identifier

string

Warehouse

A warehouse place, where the company stores its products. This place is used for the pickup/dropoff location

Name

Description

Schema

address required

Warehouse address location

string

id required

Warehouse unique identifier

integer

instructions optional

Specific instructions how to get to the place

string

lat required

Latitude coordinate

number

lng required

Longitude coordinate

number

name required

Warehouse name

string