PUT orders/mark-orders-as-downloaded
This method allows you mark orders as Downloaded. You can only update up to 50 orders at once.
Request Information
URI Parameters
None.
Body Parameters
This is a collection of MarkOrderAsDownloadedResponse which contains a list of all of the orders that you want to mark as downloaded.
Collection of MarkOrderAsDownloadedModel
Name | Description | Type | Additional information |
---|---|---|---|
OrderNumber | integer | Matching regular expression pattern: ^[1-9]\d*$ |
Request Formats
application/json, text/json
Sample:
[ { "OrderNumber": 1 }, { "OrderNumber": 2 }, { "OrderNumber": 3 }, { "OrderNumber": 4 } ]
application/xml, text/xml
Sample:
<ArrayOfMarkOrderAsDownloadedModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MarkOrderAsDownloadedModel> <OrderNumber>1</OrderNumber> </MarkOrderAsDownloadedModel> <MarkOrderAsDownloadedModel> <OrderNumber>2</OrderNumber> </MarkOrderAsDownloadedModel> <MarkOrderAsDownloadedModel> <OrderNumber>3</OrderNumber> </MarkOrderAsDownloadedModel> <MarkOrderAsDownloadedModel> <OrderNumber>4</OrderNumber> </MarkOrderAsDownloadedModel> </ArrayOfMarkOrderAsDownloadedModel>
Response Information
Resource Description
This method allows you mark orders as Downloaded. You can only update up to 50 orders at once.
Collection of MarkOrderAsDownloadedResponseName | Description | Type | Additional information |
---|---|---|---|
OrderNumber | The StoreFeeder Order number that was to be marked as downloaded | 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." }, { "OrderNumber": 3, "Success": false, "Error": "Order already marked as downloaded." } ]
application/xml, text/xml
Sample:
<ArrayOfMarkOrderAsDownloadedResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MarkOrderAsDownloadedResponse> <Success>true</Success> <OrderNumber>1</OrderNumber> </MarkOrderAsDownloadedResponse> <MarkOrderAsDownloadedResponse> <Success>false</Success> <Error>Order doesnt exist or you do not have permission to access it.</Error> <OrderNumber>2</OrderNumber> </MarkOrderAsDownloadedResponse> <MarkOrderAsDownloadedResponse> <Success>false</Success> <Error>Order already marked as downloaded.</Error> <OrderNumber>3</OrderNumber> </MarkOrderAsDownloadedResponse> </ArrayOfMarkOrderAsDownloadedResponse>