POST api/GetOrdersStatus

Provides status change logs for the shipments.

Request Information

URI Parameters

None.

Body Parameters

Request that contains WS_Key and OrderNumbers list

TwoShipAPI.Controllers.GetOrdersStatusRequest

Name	Description	Type	Additional information
WS_Key		string	None.
OrderNumbers		Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "OrderNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<GetOrdersStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TwoShipAPI.Controllers">
  <OrderNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </OrderNumbers>
  <WS_Key>sample string 1</WS_Key>
</GetOrdersStatusRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'TwoShipAPI.Controllers.GetOrdersStatusRequest'.

Response Information

Resource Description

The shipments statuses

Collection of WS_Repository.Models.Responses.Ship.GetChangesShipment

Name	Description	Type	Additional information
ShipId	Internal 2ship Shipment Id	integer	None.
OrderNumber	Order number, optional, assigned by callers on the request	string	None.
TrackingNumber	Carrier Master TrackingNumber of the shipment	string	None.
Status	The current status of the shipment (returned only from GetChangesV2 ws call): Shipped, Deleted, Closed, DeletedOnHold	string	None.
StatusTimestamp	The timestamp when the shipment changed to the given status (returned only from GetChangesV2 ws call)	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ShipId": 1,
    "OrderNumber": "sample string 2",
    "TrackingNumber": "sample string 3",
    "Status": "sample string 4",
    "StatusTimestamp": "sample string 5"
  },
  {
    "ShipId": 1,
    "OrderNumber": "sample string 2",
    "TrackingNumber": "sample string 3",
    "Status": "sample string 4",
    "StatusTimestamp": "sample string 5"
  }
]

application/xml, text/xml

Sample:

<ArrayOfGetChangesShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Ship">
  <GetChangesShipment>
    <OrderNumber>sample string 2</OrderNumber>
    <ShipId>1</ShipId>
    <Status>sample string 4</Status>
    <StatusTimestamp>sample string 5</StatusTimestamp>
    <TrackingNumber>sample string 3</TrackingNumber>
  </GetChangesShipment>
  <GetChangesShipment>
    <OrderNumber>sample string 2</OrderNumber>
    <ShipId>1</ShipId>
    <Status>sample string 4</Status>
    <StatusTimestamp>sample string 5</StatusTimestamp>
    <TrackingNumber>sample string 3</TrackingNumber>
  </GetChangesShipment>
</ArrayOfGetChangesShipment>