PUT orders/bulk-assign-label

Assign labels and optionally tracking numbers to orders in a single request. All orders must be in the Complete Ready To Pick, Assigned or Despatched status and must have a Shipping Method from a custom courier with Label Type of Customer Generated. The same order number may be supplied more than once; every label given for an order is merged into a single document and the first entry's carrier name and tracking number are applied. A maximum of 50 label assignments are supported per request. A missing or empty Label, Carrier Name or Order Number on any entry rejects the whole request with a 400, whereas a label that is supplied but invalid fails only that order's results and leaves the other orders in the request unaffected.

Request Information

URI Parameters

None.

Body Parameters

The label assignments to apply

Collection of BulkOrderAssignLabelModel

Name	Description	Type	Additional information
OrderNumber	The StoreFeeder order number to assign the label to	integer	Matching regular expression pattern: ^[1-9]\d*$
CarrierName	Name of the carrier the label was generated for	string	Required
TrackingNumber	Tracking Number to assign to the order	string	None.
Label	Label to be saved against the order (in base64 string format)	string	Required

Request Formats

application/json, text/json

Sample:

[
  {
    "OrderNumber": 12345,
    "CarrierName": "Royal Mail",
    "TrackingNumber": "TT123456789GB",
    "Label": "<base64 encoded PDF label>"
  },
  {
    "OrderNumber": 12345,
    "CarrierName": "Royal Mail",
    "TrackingNumber": "TT123456789GB",
    "Label": "<base64 encoded PDF label for the second parcel>"
  },
  {
    "OrderNumber": 12346,
    "CarrierName": "Royal Mail",
    "Label": "<base64 encoded PDF label>"
  }
]

application/xml, text/xml

Sample:

<ArrayOfBulkOrderAssignLabelModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BulkOrderAssignLabelModel>
    <OrderNumber>12345</OrderNumber>
    <CarrierName>Royal Mail</CarrierName>
    <TrackingNumber>TT123456789GB</TrackingNumber>
    <Label>&lt;base64 encoded PDF label&gt;</Label>
  </BulkOrderAssignLabelModel>
  <BulkOrderAssignLabelModel>
    <OrderNumber>12345</OrderNumber>
    <CarrierName>Royal Mail</CarrierName>
    <TrackingNumber>TT123456789GB</TrackingNumber>
    <Label>&lt;base64 encoded PDF label for the second parcel&gt;</Label>
  </BulkOrderAssignLabelModel>
  <BulkOrderAssignLabelModel>
    <OrderNumber>12346</OrderNumber>
    <CarrierName>Royal Mail</CarrierName>
    <Label>&lt;base64 encoded PDF label&gt;</Label>
  </BulkOrderAssignLabelModel>
</ArrayOfBulkOrderAssignLabelModel>

Response Information

Resource Description

Collection of Object

None.

Response Formats

application/json, text/json

Sample:

[
  {
    "OrderNumber": 12345,
    "Success": true
  },
  {
    "OrderNumber": 12346,
    "Success": false,
    "Error": "Order doesnt exist or you do not have permission to access it."
  },
  {
    "OrderNumber": 12347,
    "Success": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfBulkOrderAssignLabelResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BulkOrderAssignLabelResponse>
    <Success>true</Success>
    <OrderNumber>12345</OrderNumber>
  </BulkOrderAssignLabelResponse>
  <BulkOrderAssignLabelResponse>
    <Success>false</Success>
    <Error>Order doesnt exist or you do not have permission to access it.</Error>
    <OrderNumber>12346</OrderNumber>
  </BulkOrderAssignLabelResponse>
  <BulkOrderAssignLabelResponse>
    <Success>true</Success>
    <OrderNumber>12347</OrderNumber>
  </BulkOrderAssignLabelResponse>
</ArrayOfBulkOrderAssignLabelResponse>