PUT orders/{orderNumber}/assign-label

Assign a label an optionally a tracking number to an order that is in the ready to pick or assigned state. The order will be marked as having pre-generated a label

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderNumber Order number of the order you would like to assin the label to integer Required

Body Parameters

OrderAssignLabelModel
NameDescriptionTypeAdditional information
CarrierName Name of the carrier the label was generated for string Required
TrackingNumber Tracking Number to assign to the order to be used during shipping updates string None.
Label Label to be saved against the order (in base64 string format) string Required

Request Formats

application/json, text/json

Sample:
{
  "CarrierName": "sample string 1",
  "TrackingNumber": "sample string 2",
  "Label": "sample string 3"
}

application/xml, text/xml

Sample:
<OrderAssignLabelModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CarrierName>sample string 1</CarrierName>
  <TrackingNumber>sample string 2</TrackingNumber>
  <Label>sample string 3</Label>
</OrderAssignLabelModel>

Response Information

Resource Description

Assign a label an optionally a tracking number to an order that is in the ready to pick or assigned state. The order will be marked as having pre-generated a label

OrderAssignLabelModel
NameDescriptionTypeAdditional information
CarrierName Name of the carrier the label was generated for string Required
TrackingNumber Tracking Number to assign to the order to be used during shipping updates string None.
Label Label to be saved against the order (in base64 string format) string Required

Response Formats

application/json, text/json

Sample:
{
  "CarrierName": "sample string 1",
  "TrackingNumber": "sample string 2",
  "Label": "sample string 3"
}

application/xml, text/xml

Sample:
<OrderAssignLabelModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CarrierName>sample string 1</CarrierName>
  <TrackingNumber>sample string 2</TrackingNumber>
  <Label>sample string 3</Label>
</OrderAssignLabelModel>