PUT orders/despatch-orders

This allows you to despatch orders in bulk. You can only despatch a maximum of 50 orders at once.

Request Information

URI Parameters

None.

Body Parameters

This is a collection of OrderDespatchModel which contains a list of all of the orders that you want to despatch.

Collection of OrderDespatchModel
NameDescriptionTypeAdditional information
OrderNumber The StoreFeeder Order Number you want to despatch integer Required Matching regular expression pattern: ^[1-9]\d*$
TrackingNumber The tracking number of the despatched order. This can be left null. string None.
DespatchDate The despatch date of the order. This can be left null and it will be set at now. date None.
ShippedVia This is the carrier that the package was shipped with. For instance Royal Mail. string None.
ProductScannedBarcodes The product id and barcode of any order lines that have been validated by scanning. Dictionary of integer [key] and string [value] None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "TrackingNumber": "rm12345",
    "DespatchDate": "2024-12-21T16:00:46.8270897Z",
    "ShippedVia": "Royal Mail"
  },
  {
    "OrderNumber": 2,
    "DespatchDate": "2024-12-21T16:00:46.8270897Z",
    "ShippedVia": "Royal Mail"
  },
  {
    "OrderNumber": 3,
    "DespatchDate": "2024-12-21T16:00:46.8270897Z"
  },
  {
    "OrderNumber": 4
  }
]

Response Information

Resource Description

This allows you to despatch orders in bulk. You can only despatch a maximum of 50 orders at once.

Collection of OrderDespatchResponse
NameDescriptionTypeAdditional information
OrderNumber The Storefeeder Order Number integer None.
Success Whether the action was successful boolean None.
Error Any errors that were received Success will always be false if an error is returned. string None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample: 
<ArrayOfOrderDespatchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderDespatchResponse>
    <Success>true</Success>
    <OrderNumber>1</OrderNumber>
  </OrderDespatchResponse>
  <OrderDespatchResponse>
    <Success>false</Success>
    <Error>Order doesnt exist or you do not have permission to access it.</Error>
    <OrderNumber>2</OrderNumber>
  </OrderDespatchResponse>
</ArrayOfOrderDespatchResponse>