PUT orders/override-order-statuses

This method allows you override order statuses. You can get a list of statuses that you are allowed to override to by going the OrderStatus endpoint and checking the UserCanOverrideToStatus flag. You can only update up to 50 orders at once.

Request Information

URI Parameters

None.

Body Parameters

This is a collection of orders and the status that you wish to override them to.

Collection of OverrideOrderStatusModel
NameDescriptionTypeAdditional information
OrderNumber The Order that you wish to override the status of. integer Matching regular expression pattern: ^[1-9]\d*$
OrderStatus The status that you wish to override the order to. Only some order statuses can be overridden to. You can find a list via the OrderStatuses endpoint. Statuses None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "OrderStatus": "OnHold"
  },
  {
    "OrderNumber": 2,
    "OrderStatus": "CancelledByClient"
  },
  {
    "OrderNumber": 3,
    "OrderStatus": "CourierClaim"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOverrideOrderStatusModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OverrideOrderStatusModel>
    <OrderNumber>1</OrderNumber>
    <OrderStatus>OnHold</OrderStatus>
  </OverrideOrderStatusModel>
  <OverrideOrderStatusModel>
    <OrderNumber>2</OrderNumber>
    <OrderStatus>CancelledByClient</OrderStatus>
  </OverrideOrderStatusModel>
  <OverrideOrderStatusModel>
    <OrderNumber>3</OrderNumber>
    <OrderStatus>CourierClaim</OrderStatus>
  </OverrideOrderStatusModel>
</ArrayOfOverrideOrderStatusModel>

Response Information

Resource Description

This method allows you override order statuses. You can get a list of statuses that you are allowed to override to by going the OrderStatus endpoint and checking the UserCanOverrideToStatus flag. You can only update up to 50 orders at once.

Collection of OverrideOrderStatusResponse
NameDescriptionTypeAdditional information
OrderNumber The StoreFeeder Order number that was to be marked as downloaded integer None.
OrderStatus The order status specified to be updated to. Statuses 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,
    "OrderStatus": "OnHold",
    "Success": true
  },
  {
    "OrderNumber": 2,
    "OrderStatus": "CancelledByClient",
    "Success": false,
    "Error": "Order doesnt exist or you do not have permission to access it."
  },
  {
    "OrderNumber": 20,
    "OrderStatus": "PendingWaitingAllStock",
    "Success": false,
    "Error": "Order cannot be overrriden to the given status."
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOverrideOrderStatusResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OverrideOrderStatusResponse>
    <Success>true</Success>
    <OrderNumber>1</OrderNumber>
    <OrderStatus>OnHold</OrderStatus>
  </OverrideOrderStatusResponse>
  <OverrideOrderStatusResponse>
    <Success>false</Success>
    <Error>Order doesnt exist or you do not have permission to access it.</Error>
    <OrderNumber>2</OrderNumber>
    <OrderStatus>CancelledByClient</OrderStatus>
  </OverrideOrderStatusResponse>
  <OverrideOrderStatusResponse>
    <Success>false</Success>
    <Error>Order cannot be overrriden to the given status.</Error>
    <OrderNumber>20</OrderNumber>
    <OrderStatus>PendingWaitingAllStock</OrderStatus>
  </OverrideOrderStatusResponse>
</ArrayOfOverrideOrderStatusResponse>