POST api/ShippingLabels/Print

Print a shipping label. Requires ShippingQuoteId from api/client/ShippingRates.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ParcelOptions	Options for when shipping over Parcel.	ParcelOptions	None.
LTLOptions	Options for when shipping over Freight.	LTLOptions	None.
ShippingQuoteId	Generated from api/client/ShippingRates.	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "ParcelOptions": {
    "OverrideValidation": true,
    "DutyTerm": "sample string 2",
    "Signature": "sample string 3"
  },
  "LTLOptions": {
    "OriginAccessorials": [
      1,
      2
    ],
    "DestinationAccessorials": [
      1,
      2
    ],
    "UnitStackable": true,
    "OriginFacilityType": 4,
    "DestinationFacilityType": 5,
    "OriginSpecialInstructions": "sample string 6",
    "DestinationSpecialInstructions": "sample string 7",
    "ReadyTime": "2026-02-03T13:51:32.4709494+00:00",
    "CloseTime": "2026-02-03T13:51:32.4709494+00:00",
    "DestinationReadyTime": "2026-02-03T13:51:32.4709494+00:00",
    "DestinationCloseTime": "2026-02-03T13:51:32.4709494+00:00"
  },
  "ShippingQuoteId": 1
}

application/xml, text/xml

Sample:

<ShippingPublicController.Print_Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <LTLOptions>
    <AutoCalculatedClass>sample string 13</AutoCalculatedClass>
    <AutoCalculatedHeight>14</AutoCalculatedHeight>
    <AutoCalculatedWeight>15</AutoCalculatedWeight>
    <AutoHandlingQuantity>17</AutoHandlingQuantity>
    <AutoNMFC>sample string 12</AutoNMFC>
    <AutoPalletLength>10</AutoPalletLength>
    <AutoPalletWeight>9</AutoPalletWeight>
    <AutoPalletWidth>11</AutoPalletWidth>
    <AutoPieces>16</AutoPieces>
    <AutoStack>true</AutoStack>
    <CarrierSCAC>sample string 1</CarrierSCAC>
    <CloseTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-03T13:51:32.4709494Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </CloseTime>
    <DestinationAccessorials xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DestinationAccessorials>
    <DestinationCloseTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-03T13:51:32.4709494Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DestinationCloseTime>
    <DestinationFacilityType>5</DestinationFacilityType>
    <DestinationReadyTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-03T13:51:32.4709494Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </DestinationReadyTime>
    <DestinationSpecialInstructions>sample string 7</DestinationSpecialInstructions>
    <OriginAccessorials xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </OriginAccessorials>
    <OriginFacilityType>4</OriginFacilityType>
    <OriginSpecialInstructions>sample string 6</OriginSpecialInstructions>
    <QuoteId>sample string 18</QuoteId>
    <RateQuoteAmount>3</RateQuoteAmount>
    <ReadyTime xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-02-03T13:51:32.4709494Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </ReadyTime>
    <UnitStackable>true</UnitStackable>
  </LTLOptions>
  <ParcelOptions>
    <DutyTerm>sample string 2</DutyTerm>
    <OverrideValidation>true</OverrideValidation>
    <Signature>sample string 3</Signature>
  </ParcelOptions>
  <ShippingQuoteId>1</ShippingQuoteId>
</ShippingPublicController.Print_Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShippingLabel_Response

Name	Description	Type	Additional information
IsSuccess	Indicates if there was an error printing your shipping label.	boolean	None.
Message	If there was an error, this is where it will be displayed.	string	None.
Label	Base64 PDF of the shipping label(s).	string	None.
Label2	Base64 PDF of the customs forms (if applicable).	string	None.
BOL	Bill of Lading, only returned if shipping freight.	string	None.
labelCount	Number of shipping labels for this shipment.	integer	None.
ShippingLabelId	Primary label's ShippingLabelId.	integer	None.
OrderId	The OrderId this shipment shipped under. Useful for voiding.	integer	None.
TrackingNumbers	Tracking numbers for each package.	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Message": "sample string 2",
  "Label": "sample string 3",
  "Label2": "sample string 4",
  "BOL": "sample string 5",
  "labelCount": 6,
  "ShippingLabelId": 1,
  "OrderId": 7,
  "TrackingNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ShippingLabel_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <BOL>sample string 5</BOL>
  <IsSuccess>true</IsSuccess>
  <Label>sample string 3</Label>
  <Label2>sample string 4</Label2>
  <Message>sample string 2</Message>
  <OrderId>7</OrderId>
  <ShippingLabelId>1</ShippingLabelId>
  <TrackingNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </TrackingNumbers>
  <labelCount>6</labelCount>
</ShippingLabel_Response>