POST api/ListOnHoldOrders_V1
Get the list of onhold orders in 2ship
Request Information
URI Parameters
None.
Body Parameters
The request is presented below!
WS_Repository.Models.Requests.Hold.ListOnHoldRequestName | Description | Type | Additional information |
---|---|---|---|
WS_Key |
(Mandatory) Webservice Key provided by 2ship support |
string |
None. |
Request Formats
application/json, text/json
Sample:
{ "WS_Key": "sample string 1" }
application/xml, text/xml
Sample:
<ListOnHoldRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Hold"> <WS_Key>sample string 1</WS_Key> </ListOnHoldRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
WS_Repository.Models.Responses.Hold.ListOnHoldResponseName | Description | Type | Additional information |
---|---|---|---|
OnHoldOrders |
List of all onhold orders returned |
Collection of WS_Repository.Models.Responses.Hold.OnHoldOrder |
None. |
Response Formats
application/json, text/json
Sample:
{ "OnHoldOrders": [ { "OrderNumber": "sample string 1", "HoldShipmentId": 2 }, { "OrderNumber": "sample string 1", "HoldShipmentId": 2 } ] }
application/xml, text/xml
Sample:
<ListOnHoldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Hold"> <OnHoldOrders> <OnHoldOrder> <HoldShipmentId>2</HoldShipmentId> <OrderNumber>sample string 1</OrderNumber> </OnHoldOrder> <OnHoldOrder> <HoldShipmentId>2</HoldShipmentId> <OrderNumber>sample string 1</OrderNumber> </OnHoldOrder> </OnHoldOrders> </ListOnHoldResponse>