URL Expired

The URL for this request expired after 30 days.

Shipment Details

Fields

• shipmentId
  string
  required

• carrierSelectionId
  string
  required

• partnerManifestId
  string
  The partner provided identifier for the manifest that includes this shipment. This can be supplied to facilitate looking up the manifest for a shipment, when viewing the shipment using Shipium's UI or API.

• effectiveShipDateTime
  date-time
  The ISO-8601 date-time that the carrier departed with this shipment. If this is not supplied, it will be retrieved from the specified carrier selection.

• estimatedDeliveryDate
  date-time
  The ISO-8601 date-time by when the shipment is estimated to be delivered to the customer. If this is not supplied, it will be retrieved from the specified carrier selection.

• estimatedInjectionDateTime
  date-time
  When the shipment will, or did, arrive at the injection site. If this is not supplied, it will be retrieved from the specified carrier selection.

• labelCreationDateTime
  date-time
  The ISO-8601 date-time that the label was created. If this is not supplied, the label import date-time will be used.

• manifestDateTime
  date-time
  The ISO-8601 date-time that the label was manifested by the partner. If this is not supplied, the label import date-time will be used.

• carrier
  string
  required
  Shipium's unique identifier of the carrier that the label is for. This must match a carrier that Shipium supports.

• carrierAccountNumber
  string
  The account number for the carrier that was used.

• carrierServiceMethodId
  string
  required
  Shipium's unique identifier for the carrier service method that the label is for. This must match a carrier service method that Shipium supports.

• carrierShipmentId
  string
  Carrier's identification for the shipment.

• carrierTrackingId
  string
  Carrier's tracking identification for the package.

• carrierTrackingLink
  string
  Carrier's direct tracking Link (URL) for the package

• shipiumTrackingId
  string
  Shipium's tracking identification for the package. This can only be provided by Shipium users and services.

• carrierGroupId
  string
  Carrier's identification for grouping multiple packages together. For example, Canada Post groups shipments for manifesting.

• packageScannableId
  string
  Identifier provided that matches the scannable barcode on the label

• partnerThirdPartyBillingAccountId
  string
  The partner-provided ID the third party billing account that was used if the label was billed to a third party. If this is not supplied, it will populated using the corresponding value in the carrier selection.

• shipiumThirdPartyBillingAccountId
  string
  The Shipium generated ID of the third party billing account that was used if the label was billed to a third party. If this is not supplied, it will populated using the corresponding value in the carrier selection.

• carrierLabelCurrencyCode
  string
  Currency code which the price of the label is in. If the carrierLabelPrice is supplied, then this must also be provided.

• carrierLabelPrice
  float
  Cost charged by the carrier for shipping the package at the chosen service level.

• billableWeight
  object
  The weight of this type of packaging empty.

• billableCubicVolume
  object
  Cubic volume that was used to generate the rate.

• labelCostLineItems
  array of objects
  Breakdown of the costs of the label as communicated by the carrier.

• documents
  array of objects
  List of links to labels generated, by format, for the shipment.

• internationalDocuments
  array of objects
  List of international customs documents generated by the carrier for the shipment.

• hazardousMaterialsDocuments
  array of objects
  List of hazardous materials documents generated by the carrier for the shipment.

• trackingInfo
  object
  Details of the tracking history and status of the package.

• testMode
  boolean
  A flag denoting whether the label is a test label.

Responses

• 200 Label imported for the shipment.
• 400 Invalid inputs were provided.

Example CURL Command

curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/shipment/shipmentId/carrierSelection/carrierSelectionId/labelImport \
     --header 'accept: application/json' \
     --header 'content-type: application/json'