PUT orders/mark-as-attention-required

This method allows you to mark orders as Attention Required, or remove the same flag. You can add an optional comment. If the Attention Required flag is unchecked, it will remove any existing comments. You can only update up to 50 orders at once.

Request Information

URI Parameters

None.

Body Parameters

This is a collection of MarkOrderAsAttentionRequiredResponse which contains a list of all of the orders that you want to mark as Attention Required.

Collection of MarkOrderAsAttentionRequiredModel
NameDescriptionTypeAdditional information
OrderNumber The order to mark as attention required integer Matching regular expression pattern: ^[1-9]\d*$
AttentionIsRequired Setting true will allow you to add a comment. Setting false will remove any existing flag and remove any existing comments. boolean None.
AttentionComment Optional comment valid when AttentionIsRequired is set to true. Max Length of 800 characters string Max length: 800

Request Formats

application/json, text/json

Sample: 
[
  {
    "OrderNumber": 1,
    "AttentionIsRequired": false
  },
  {
    "OrderNumber": 2,
    "AttentionIsRequired": false
  },
  {
    "OrderNumber": 3,
    "AttentionIsRequired": false
  }
]

application/xml, text/xml

Sample: 
<ArrayOfMarkOrderAsAttentionRequiredModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MarkOrderAsAttentionRequiredModel>
    <OrderNumber>1</OrderNumber>
    <AttentionIsRequired>false</AttentionIsRequired>
  </MarkOrderAsAttentionRequiredModel>
  <MarkOrderAsAttentionRequiredModel>
    <OrderNumber>2</OrderNumber>
    <AttentionIsRequired>false</AttentionIsRequired>
  </MarkOrderAsAttentionRequiredModel>
  <MarkOrderAsAttentionRequiredModel>
    <OrderNumber>3</OrderNumber>
    <AttentionIsRequired>false</AttentionIsRequired>
  </MarkOrderAsAttentionRequiredModel>
</ArrayOfMarkOrderAsAttentionRequiredModel>

Response Information

Resource Description

This method allows you to mark orders as Attention Required, or remove the same flag. You can add an optional comment. If the Attention Required flag is unchecked, it will remove any existing comments. You can only update up to 50 orders at once.

Collection of MarkOrderAsAttentionRequiredResponse
NameDescriptionTypeAdditional information
OrderNumber The StoreFeeder Order number that was to be marked as not 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": true
  }
]

application/xml, text/xml

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