Type	Description
LabelUrl	string	If present, contains the shippment label(s) uri to be injected
ReturnLabel	string	If present, contains the shippment return label uri to be injected
LabelFormat	string	Represents the value of the label(s) format. All labels must come under this format. PDF and ZPL are the only formats supported
TrackingNumber	string	If present, contains the shippment tracking number or master tracking number
TrackingUrl	string	If present, contains the shippment tracking uri
LabelPerPackage	bool	This boolean value indicates the system if the shipping labels should be per packages found in the Packages object
Packages	List<Order.Models.TrackedPackages>	List of tracked Packages in the order
PackageId	int	Interger that indicates the package id associated in 3w
TrackingNumber	string	If present, contains the shippment tracking number
TrackingUrl	string	If present, contains the shippment tracking url
LabelUrl	string	If present, contains the shippment label to be used for this package
ReturnLabel	string	If present, contains the shippment return label to be used for this package
RequestCorrelationId	string	If present, this value contains an external id from where the shipping labels where processed
LabelId	string	Unique value per request, warning:this value if used on multiple requests will affect label search
Provider	string	String that contains the value of the provider where the shipping labels where generated
CarrierAccount	string	String that contains the value of the carrier account used to generate this labels
ServiceCode	string	String that contains the value of the carrier service
LabelAmounts	Order.Models.LabelAmounts
Currency	string	String that contains the value of the shipping currency(USD, EUR, etc.).
Insurance	decimal	Contains the amount of the insurance cost for the shipping order
Shipping	decimal	Contains the amount of the shipping cost for the shipping order
Total	decimal	Contains the total amount of the shipping cost for the shipping order

Sample content-type: application/hal+json

Copy to clipboard

copied

{
  "labelUrl": "str",
  "returnLabel": "str",
  "labelFormat": "str",
  "trackingNumber": "str",
  "trackingUrl": "str",
  "labelPerPackage": true,
  "packages": [
    {
      "packageId": 1,
      "trackingNumber": "str",
      "trackingUrl": "str",
      "labelUrl": "str",
      "returnLabel": "str"
    }
  ],
  "requestCorrelationId": "str",
  "labelId": "str",
  "provider": "str",
  "carrierAccount": "str",
  "serviceCode": "str",
  "labelAmounts": {
    "currency": "str",
    "insurance": 2.0,
    "shipping": 3.0,
    "total": 4.0
  }
}