POST api/GetChangedShipmentsByIds

Request Information

URI Parameters

None.

Body Parameters

TwoShipAPI.Controllers.GetChangedShipmentsByIdsRequest
NameDescriptionTypeAdditional information
WS_Key

string

None.

ShipmentIds

Collection of integer

None.

RetrieveBase64StringDocuments

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "WS_Key": "sample string 1",
  "ShipmentIds": [
    1,
    2
  ],
  "RetrieveBase64StringDocuments": true
}

application/xml, text/xml

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

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.GetChangedShipmentsByIdsRequest'.

Response Information

Resource Description

Collection of WS_Repository.Models.Responses.Ship.CarrierShipResponse
NameDescriptionTypeAdditional information
ShipDocuments

Array of Ship Documents

Collection of WS_Repository.Models.Responses.Ship.ShipDocument

None.

ShipId

Internal 2ship Shipment Id

integer

None.

OrderNumber

Order number, optional, assigned by callers on the request

string

None.

CloseAggregationId

Specify if the shipment is aggregated with other shipments at close transaction - the close aggregation id represent the firstshipment id from the group of aggregated shipments - Used on GetShipments transaction

integer

None.

Service

Rate Service

WS_Repository.Models.Responses.Rate.RateService

None.

Carrier

Rate Service

WS_Repository.Models.Responses.Rate.Carrier

None.

LocationId

2Ship Location Id

integer

None.

LocationName

2Ship Location Name

string

None.

ProNumber

Pro Number - will be populated when the carrier is LTL and was shipped with a Pro Number

string

None.

TrackingNumber

Carrier Master TrackingNumber of the shipment

string

None.

TrackingUrl

2Ship Tracking Url

string

None.

AirwayBillNumber

Carrier Airway Bill Number of the shipment (not used by all carriers)

string

None.

PackageTrackingNumbers

Carrier Package TrackingNumbers of the shipment

Collection of string

None.

ShipmentDetails

Details of the shipment

WS_Repository.Models.Responses.Ship.ShipmentDetails

None.

ExchangeRate

Exchange Rate object available if the RateCurrencySelect is specify on the ship request

WS_Repository.Models.Responses.Ship.ExchangeRate

None.

MycarrierDetails

when the carrier is My Carrier(999) here are populated your carrier info

WS_Repository.Models.Responses.Ship.MyCarrierDetails

None.

Status

The current status of the shipment (returned only from GetChanges ws call): Shipped, Deleted, Closed, DeletedOnHold, Imported

string

None.

StatusTimestamp

The timestamp when the shipment changed to the given status (returned only from GetChanges ws call)

string

None.

QRCodeValue

QR Code Value

string

None.

QRCodeImageURL

QR Code Image URL

string

None.

ClientId

ClientId of Client created the shipment

integer

None.

ExternalClientID

External client ID

string

None.

UserId

UserId of user created the shipment

integer

None.

UserName

User name of user created the shipment

string

None.

WebsiteUrl

(Only available on ShipmentStatusChange webhooks at ship/delete) WebsiteUrl

string

None.

OriginHubCode

Origin Hub/Airport Code

string

None.

DestinationHubCode

Origin Hub/Airport Code

string

None.

InternalNotes

Internal notes

string

None.

ShipWithoutPrinterMessage

(Optional) Use this filter to find the Carrier services that allow you to ship without the need for a printed label

string

None.

WebhookType

Webhook Type

string

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path '[0].ShipmentDetails.Contents.Commodities[0].BundleComponents'.

text/json

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'WS_Repository.Models.Responses.Ship.Commodity'. Path '[0].ShipmentDetails.Contents.Commodities[0].BundleComponents'.

application/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Object graph for type 'WS_Repository.Models.Responses.Ship.Commodity' contains cycles and cannot be serialized if reference tracking is disabled.

text/xml

Sample:

An exception has occurred while using the formatter 'System.Net.Http.Formatting.XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Object graph for type 'WS_Repository.Models.Responses.Ship.Commodity' contains cycles and cannot be serialized if reference tracking is disabled.