Delivery Solutions

Shipment

The Shipment object encapsulates comprehensive shipment details including required tracking number and URL, label information, shipment status, estimated pickup and delivery times in Unix milliseconds, estimated provider charges as integer minor units, and optionally package details and a breakdown of charges.

Shipment Object

The Shipment object contains details about a shipment, including tracking information, label, package details, status, estimated times, and charges.

Properties

  • trackingNumber (string, required): Provider tracking number.
  • trackingUrl (string, required): Shipment tracking URL.
  • label (Label, required): Shipment label details.
  • package (Package, optional): Package details of the shipment.
  • status (Order Statuses, required): Status of the shipment.
  • estimatedPickupTime (integer, required): Provider estimated Pickup Start Time. Unix time in milliseconds (e.g., 1500616800000).
  • estimatedPickupTimeEnds (integer, required): Provider estimated Pickup End Time. Unix time in milliseconds (e.g., 1500616800000).
  • estimatedDeliveryTimeEnds (integer, required): Provider estimated Delivery End Time. Unix time in milliseconds (e.g., 1500616800000).
  • amount (integer, required): The estimated amount that the provider will charge. Amount as integer minor unit (e.g., 1295 indicates 12.95).
  • chargeDetails (array, optional): Provider's breakup of charge, if provided.