PUT orders/shipped-by-supplier

This allows you to mark orders as shipped by supplier in bulk. A maximum of 50 orders per request

Request Information

URI Parameters

None.

Body Parameters

This is a collection of OrderShipBySupplierModel which contains a list of all of the orders that you want to mark as shipped by supplier.

Collection of OrderShipBySupplierModel
NameDescriptionTypeAdditional information
OrderNumber The StoreFeeder Order Number you want to set as Shipped By Supplier integer Required Matching regular expression pattern: ^[1-9]\d*$
SupplierName (Optional) The supplier that this order is being shipped by string None.
TrackingNumber (Optional) The tracking number of the order string None.
ShipmentDate (Optional) The date for this shipment. Will be set to the current date and time if not supplied date None.
ShippedVia (Optional) This is the carrier that the package was shipped with string None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "SupplierName": "sample string 2",
    "TrackingNumber": "sample string 3",
    "ShipmentDate": "2025-04-02T01:22:59.6466228+00:00",
    "ShippedVia": "sample string 4"
  },
  {
    "OrderNumber": 1,
    "SupplierName": "sample string 2",
    "TrackingNumber": "sample string 3",
    "ShipmentDate": "2025-04-02T01:22:59.6466228+00:00",
    "ShippedVia": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOrderShipBySupplierModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderShipBySupplierModel>
    <OrderNumber>1</OrderNumber>
    <SupplierName>sample string 2</SupplierName>
    <TrackingNumber>sample string 3</TrackingNumber>
    <ShipmentDate>2025-04-02T01:22:59.6466228+00:00</ShipmentDate>
    <ShippedVia>sample string 4</ShippedVia>
  </OrderShipBySupplierModel>
  <OrderShipBySupplierModel>
    <OrderNumber>1</OrderNumber>
    <SupplierName>sample string 2</SupplierName>
    <TrackingNumber>sample string 3</TrackingNumber>
    <ShipmentDate>2025-04-02T01:22:59.6466228+00:00</ShipmentDate>
    <ShippedVia>sample string 4</ShippedVia>
  </OrderShipBySupplierModel>
</ArrayOfOrderShipBySupplierModel>

Response Information

Resource Description

This allows you to mark orders as shipped by supplier in bulk. A maximum of 50 orders per request

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,
    "Error": "sample string 3"
  },
  {
    "OrderNumber": 1,
    "Success": true,
    "Error": "sample string 3"
  }
]

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>
    <Error>sample string 3</Error>
    <OrderNumber>1</OrderNumber>
  </OrderDespatchResponse>
  <OrderDespatchResponse>
    <Success>true</Success>
    <Error>sample string 3</Error>
    <OrderNumber>1</OrderNumber>
  </OrderDespatchResponse>
</ArrayOfOrderDespatchResponse>