{id} Try Now

Get Shipping Lable by Label Id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Shipping Label Id (Uniqueidentifier)	string	Required

Body Parameters

None.

Response Information

Resource Description

ShippingLabel

Name	Description	Type	Additional information
SubscriberId	The subscriber Uniqueidentifier.	string	None.
LabelId	Shipping Label Uniqueidentifier	string	None.
ShipFrom	Shipping Label Ship From Information	ShippingInformation	None.
ShipTo	Shipping Label Ship To Information	ShippingInformation	None.
Carrier	Shipping Label Carrier	ShippingCarrier	None.
ReferenceNumber	Shipping Label reference number for internal tracking	integer	None.
PackageDetails	Shipping Label Package Details	ShippingPackageDetails	None.
ShipmentDetails	Shipping Label Shipment Details	ShipmentDetails	None.
DiscountedRate	Discount applied to Shipping Label	Money	None.
DiscountedRateBase	Gets the discounted rate base.	Money	None.
Discount	Discount applied to Shipping Label	decimal number	None.
UserRate	Shipping Label Rate	Money	None.
UserDiscount	Shipping Label user discount	decimal number	None.
StandardRate	Shipping Label standard rate	Money	None.
StandardRateBase	Shipping Label standard base rate	Money	None.
IsExternalLabel	Flag to identify Shipping Label is generated externally or not	boolean	None.
IsTestLabel	Flag to identify Shipping Label is generated for testing or not	boolean	None.
TrackingNumber	Shipping Label tracking number	string	None.
DateCreated	The Date/Time of Shipping Label Creation.	date	None.
CreatedBy	Describes who created this Label.	string	None.
CancelDate	The Date/Time of Shipping Label Cancellation.	date	None.
IsBillable	True if this Shipping Label is billable, false if not.	boolean	None.
BillingInvoiceId	The billing invoice identifier.	string	None.
BillingRefundInvoiceId	The billing refund invoice identifier.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "SubscriberId": "",
  "LabelId": "",
  "ShipFrom": {
    "StateName": "",
    "Country": "",
    "Company": "",
    "ContactName": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Phone": "",
    "Extension": "",
    "IsResidential": true
  },
  "ShipTo": {
    "StateName": "",
    "Country": "",
    "Company": "",
    "ContactName": "",
    "Address1": "",
    "Address2": "",
    "City": "",
    "State": "",
    "Zip": "",
    "Phone": "",
    "Extension": "",
    "IsResidential": true
  },
  "Carrier": "None",
  "ReferenceNumber": 3,
  "PackageDetails": {
    "PaperType": "Letter",
    "InvoiceNumber": "",
    "DeclareValue": 2.1,
    "PackageType": "",
    "ServiceId": "",
    "ServiceName": "",
    "ServiceCode": "",
    "ShipDate": "2024-12-01T19:30",
    "SignatureOption": "DeliverWithoutSignature",
    "IsSaturdayPickup": true,
    "DeclareValueCurrency": "",
    "EmailNotificationMessage": "",
    "EmailNotificationRecepients": [],
    "EmailNotificationSender": "",
    "EnableEmailNotifications": true
  },
  "ShipmentDetails": {
    "StartDate": "2024-12-01T19:30",
    "DeliveryDate": "2024-12-01T19:30",
    "DeliveryStatus": ""
  },
  "DiscountedRate": {
    "Currency": "",
    "Amount": 1.0
  },
  "DiscountedRateBase": {
    "Currency": "",
    "Amount": 1.0
  },
  "Discount": 4.1,
  "UserRate": {
    "Currency": "",
    "Amount": 1.0
  },
  "UserDiscount": 5.1,
  "StandardRate": {
    "Currency": "",
    "Amount": 1.0
  },
  "StandardRateBase": {
    "Currency": "",
    "Amount": 1.0
  },
  "IsExternalLabel": true,
  "IsTestLabel": true,
  "TrackingNumber": "",
  "DateCreated": "2024-12-01T19:30",
  "CreatedBy": "",
  "CancelDate": "2024-12-01T19:30",
  "IsBillable": true,
  "BillingInvoiceId": "",
  "BillingRefundInvoiceId": ""
}