POST api/GetChangesV2

Request Information

URI Parameters

None.

Body Parameters

TwoShipAPI.Controllers.GetChangesV2Request
NameDescriptionTypeAdditional information
WS_Key

string

None.

Start

date

None.

End

date

None.

SetInitialTimeStamp

boolean

None.

FreightType

WS_Repository.Models.Common.FreightType

None.

Request Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1",
  "Start": "2020-02-21T15:36:56.3210152-05:00",
  "End": "2020-02-21T15:36:56.3210152-05:00",
  "SetInitialTimeStamp": true,
  "FreightType": 1
}

application/xml, text/xml

Sample:
<GetChangesV2Request xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TwoShipAPI.Controllers">
  <End>2020-02-21T15:36:56.3210152-05:00</End>
  <FreightType>SmallPackage</FreightType>
  <SetInitialTimeStamp>true</SetInitialTimeStamp>
  <Start>2020-02-21T15:36:56.3210152-05:00</Start>
  <WS_Key>sample string 1</WS_Key>
</GetChangesV2Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

WS_Repository.Models.Responses.Ship.GetChangesResponseV2
NameDescriptionTypeAdditional information
Shipments

A list of basic shipment information that have changed in 2Ship in the returned timeframe.

Collection of WS_Repository.Models.Responses.Ship.GetChangesShipment

None.

Start

Start date and time for the returned result.

date

None.

End

End date and time for the returned result.

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Shipments": [
    {
      "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"
    }
  ],
  "Start": "2020-02-21T15:36:56.3268819-05:00",
  "End": "2020-02-21T15:36:56.3268819-05:00"
}

application/xml, text/xml

Sample:
<GetChangesResponseV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Ship">
  <End>2020-02-21T15:36:56.3268819-05:00</End>
  <Shipments>
    <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>
  </Shipments>
  <Start>2020-02-21T15:36:56.3268819-05:00</Start>
</GetChangesResponseV2>