Creating a tracker

post/trackers

Request

  • Base URL: https://api.shipcloud.io/v1
  • URL: https://api.shipcloud.io/v1/trackers
  • Auth: HTTP basic

Request body

carrier_tracking_nostring required

Tracking number (provided by the carrier) of the shipment which should be monitored

carrier'dhl' | 'dpd' | 'gls' | 'ups' required

acronym of the carrier the shipment was created with

notification_emailstring

email address that we should notify once there's an update for this shipment. Usually the recipients'

Response

A tracker has been created

carrier_tracking_nostring required

tracking number (provided by the carrier) for this shipment

status'registered' | 'label_created' | 'picked_up' | 'delivered' | 'not_delivered' | 'transit' | 'exception' | 'out_for_delivery' | 'destroyed' | 'unknown' | 'canceled' required

key describing the current status

created_atstring date-time required

timestamp the tracker was created

tracking_status_updated_atstring date-time nullable required

timestamp the tracking status was last updated

last_polling_atstring date-time nullable required

timestamp the shipment status was last polled at the carrier

next_polling_atstring date-time required

timestamp the shipment status will be polled the next time

shipment_idstring required

id of the corresponding shipment within shipcloud

carrier'dhl' | 'dpd' | 'gls' | 'ups' required

acronym of the carrier the shipment was sent with

idstring required

the tracker id that can be used for requesting info about a tracker

Changes

No recorded changes to this operation across all 1 revision of this API.