POST api/orders/wmsstatus

Sets the WMS status of specified order.

Request Information

URI Parameters

None.

Body Parameters

WmsStatusRequest
NameDescriptionTypeAdditional information
OrderId

Id of the order

 integer

None.
SellerBranchId

Id of the seller branch.

 integer

None.
WmsStatus

Wms status to set

 integer

None.

Remarks

See WmsStatusErrorCode in WmsStatusResponse.WmsStatusError for error codes.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderId": 1,
  "SellerBranchId": 2,
  "WmsStatus": 3
}

application/xml, text/xml

Sample: 
<WmsStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <OrderId>1</OrderId>
  <SellerBranchId>2</SellerBranchId>
  <WmsStatus>3</WmsStatus>
</WmsStatusRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WmsStatusRequest'.

Response Information

Resource Description

Returns a WmsStatusResponse.

WmsStatusResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Errors

Collection of WmsStatusError

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<WmsStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <Errors>
    <WmsStatusError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </WmsStatusError>
    <WmsStatusError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </WmsStatusError>
  </Errors>
  <Success>true</Success>
</WmsStatusResponse>