GET api/ShipmentNotify/{auth}/{ShipmentGUID}

Request Information

URI Parameters

Name	Description	Type	Additional information
auth		string	Required
ShipmentGUID		string	Required

Body Parameters

None.

Response Information

Resource Description

ShipmentNotifyResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
ShipmentGUID	string	None.
CompanyID	integer	None.
NotifyShipper	boolean	None.
NotifyShipperOrderAck	boolean	None.
NotifyShipperOrderRouted	boolean	None.
NotifyShipperDispatched	boolean	None.
NotifyShipperPickedUp	boolean	None.
NotifyShipperDepToAp	boolean	None.
NotifyShipperObcCheckin	boolean	None.
NotifyShipperDropped	boolean	None.
NotifyShipperConfirmed	boolean	None.
NotifyShipperDeparted	boolean	None.
NotifyShipperArrived	boolean	None.
NotifyShipperRecovered	boolean	None.
NotifyShipperOutForDelivery	boolean	None.
NotifyShipperDelivered	boolean	None.
NotifyShipperOrigQdt	boolean	None.
NotifyShipperChangeQdt	boolean	None.
NotifyConsee	boolean	None.
NotifyConseeOrderAck	boolean	None.
NotifyConseeOrderRouted	boolean	None.
NotifyConseeDispatched	boolean	None.
NotifyConseePickedUp	boolean	None.
NotifyConseeDepToAp	boolean	None.
NotifyConseeObcCheckin	boolean	None.
NotifyConseeDropped	boolean	None.
NotifyConseeConfirmed	boolean	None.
NotifyConseeDeparted	boolean	None.
NotifyConseeArrived	boolean	None.
NotifyConseeRecovered	boolean	None.
NotifyConseeOutForDelivery	boolean	None.
NotifyConseeDelivered	boolean	None.
NotifyConseeOrigQdt	boolean	None.
NotifyConseeChangeQdt	boolean	None.
NotifyOtherEmail	string	None.
NotifyOtherOrderAck	boolean	None.
NotifyOtherOrderRouted	boolean	None.
NotifyOtherDispatched	boolean	None.
NotifyOtherPickedUp	boolean	None.
NotifyOtherDepToAp	boolean	None.
NotifyOtherObcCheckin	boolean	None.
NotifyOtherDropped	boolean	None.
NotifyOtherConfirmed	boolean	None.
NotifyOtherDeparted	boolean	None.
NotifyOtherArrived	boolean	None.
NotifyOtherRecovered	boolean	None.
NotifyOtherOutForDelivery	boolean	None.
NotifyOtherDelivered	boolean	None.
NotifyOtherOrigQdt	boolean	None.
NotifyOtherChangeQdt	boolean	None.
NotifyShipperEmail	string	None.
NotifyConseeEmail	string	None.
NotifyShipperRelease	boolean	None.
NotifyConseeRelease	boolean	None.
NotifyOtherRelease	boolean	None.
DropAirportID	string	None.
RecoverAirportID	string	None.
OrderState	string	None.
OrderStatus	integer	None.
IsNoShow	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "ShipmentGUID": "sample string 3",
  "CompanyID": 4,
  "NotifyShipper": true,
  "NotifyShipperOrderAck": true,
  "NotifyShipperOrderRouted": true,
  "NotifyShipperDispatched": true,
  "NotifyShipperPickedUp": true,
  "NotifyShipperDepToAp": true,
  "NotifyShipperObcCheckin": true,
  "NotifyShipperDropped": true,
  "NotifyShipperConfirmed": true,
  "NotifyShipperDeparted": true,
  "NotifyShipperArrived": true,
  "NotifyShipperRecovered": true,
  "NotifyShipperOutForDelivery": true,
  "NotifyShipperDelivered": true,
  "NotifyShipperOrigQdt": true,
  "NotifyShipperChangeQdt": true,
  "NotifyConsee": true,
  "NotifyConseeOrderAck": true,
  "NotifyConseeOrderRouted": true,
  "NotifyConseeDispatched": true,
  "NotifyConseePickedUp": true,
  "NotifyConseeDepToAp": true,
  "NotifyConseeObcCheckin": true,
  "NotifyConseeDropped": true,
  "NotifyConseeConfirmed": true,
  "NotifyConseeDeparted": true,
  "NotifyConseeArrived": true,
  "NotifyConseeRecovered": true,
  "NotifyConseeOutForDelivery": true,
  "NotifyConseeDelivered": true,
  "NotifyConseeOrigQdt": true,
  "NotifyConseeChangeQdt": true,
  "NotifyOtherEmail": "sample string 37",
  "NotifyOtherOrderAck": true,
  "NotifyOtherOrderRouted": true,
  "NotifyOtherDispatched": true,
  "NotifyOtherPickedUp": true,
  "NotifyOtherDepToAp": true,
  "NotifyOtherObcCheckin": true,
  "NotifyOtherDropped": true,
  "NotifyOtherConfirmed": true,
  "NotifyOtherDeparted": true,
  "NotifyOtherArrived": true,
  "NotifyOtherRecovered": true,
  "NotifyOtherOutForDelivery": true,
  "NotifyOtherDelivered": true,
  "NotifyOtherOrigQdt": true,
  "NotifyOtherChangeQdt": true,
  "NotifyShipperEmail": "sample string 53",
  "NotifyConseeEmail": "sample string 54",
  "NotifyShipperRelease": true,
  "NotifyConseeRelease": true,
  "NotifyOtherRelease": true,
  "DropAirportID": "sample string 58",
  "RecoverAirportID": "sample string 59",
  "OrderState": "sample string 60",
  "OrderStatus": 61,
  "IsNoShow": true
}

application/xml, text/xml

Sample:

<ShipmentNotifyResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <CompanyID>4</CompanyID>
  <DropAirportID>sample string 58</DropAirportID>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsNoShow>true</IsNoShow>
  <IsSuccessful>true</IsSuccessful>
  <NotifyConsee>true</NotifyConsee>
  <NotifyConseeArrived>true</NotifyConseeArrived>
  <NotifyConseeChangeQdt>true</NotifyConseeChangeQdt>
  <NotifyConseeConfirmed>true</NotifyConseeConfirmed>
  <NotifyConseeDelivered>true</NotifyConseeDelivered>
  <NotifyConseeDepToAp>true</NotifyConseeDepToAp>
  <NotifyConseeDeparted>true</NotifyConseeDeparted>
  <NotifyConseeDispatched>true</NotifyConseeDispatched>
  <NotifyConseeDropped>true</NotifyConseeDropped>
  <NotifyConseeEmail>sample string 54</NotifyConseeEmail>
  <NotifyConseeObcCheckin>true</NotifyConseeObcCheckin>
  <NotifyConseeOrderAck>true</NotifyConseeOrderAck>
  <NotifyConseeOrderRouted>true</NotifyConseeOrderRouted>
  <NotifyConseeOrigQdt>true</NotifyConseeOrigQdt>
  <NotifyConseeOutForDelivery>true</NotifyConseeOutForDelivery>
  <NotifyConseePickedUp>true</NotifyConseePickedUp>
  <NotifyConseeRecovered>true</NotifyConseeRecovered>
  <NotifyConseeRelease>true</NotifyConseeRelease>
  <NotifyOtherArrived>true</NotifyOtherArrived>
  <NotifyOtherChangeQdt>true</NotifyOtherChangeQdt>
  <NotifyOtherConfirmed>true</NotifyOtherConfirmed>
  <NotifyOtherDelivered>true</NotifyOtherDelivered>
  <NotifyOtherDepToAp>true</NotifyOtherDepToAp>
  <NotifyOtherDeparted>true</NotifyOtherDeparted>
  <NotifyOtherDispatched>true</NotifyOtherDispatched>
  <NotifyOtherDropped>true</NotifyOtherDropped>
  <NotifyOtherEmail>sample string 37</NotifyOtherEmail>
  <NotifyOtherObcCheckin>true</NotifyOtherObcCheckin>
  <NotifyOtherOrderAck>true</NotifyOtherOrderAck>
  <NotifyOtherOrderRouted>true</NotifyOtherOrderRouted>
  <NotifyOtherOrigQdt>true</NotifyOtherOrigQdt>
  <NotifyOtherOutForDelivery>true</NotifyOtherOutForDelivery>
  <NotifyOtherPickedUp>true</NotifyOtherPickedUp>
  <NotifyOtherRecovered>true</NotifyOtherRecovered>
  <NotifyOtherRelease>true</NotifyOtherRelease>
  <NotifyShipper>true</NotifyShipper>
  <NotifyShipperArrived>true</NotifyShipperArrived>
  <NotifyShipperChangeQdt>true</NotifyShipperChangeQdt>
  <NotifyShipperConfirmed>true</NotifyShipperConfirmed>
  <NotifyShipperDelivered>true</NotifyShipperDelivered>
  <NotifyShipperDepToAp>true</NotifyShipperDepToAp>
  <NotifyShipperDeparted>true</NotifyShipperDeparted>
  <NotifyShipperDispatched>true</NotifyShipperDispatched>
  <NotifyShipperDropped>true</NotifyShipperDropped>
  <NotifyShipperEmail>sample string 53</NotifyShipperEmail>
  <NotifyShipperObcCheckin>true</NotifyShipperObcCheckin>
  <NotifyShipperOrderAck>true</NotifyShipperOrderAck>
  <NotifyShipperOrderRouted>true</NotifyShipperOrderRouted>
  <NotifyShipperOrigQdt>true</NotifyShipperOrigQdt>
  <NotifyShipperOutForDelivery>true</NotifyShipperOutForDelivery>
  <NotifyShipperPickedUp>true</NotifyShipperPickedUp>
  <NotifyShipperRecovered>true</NotifyShipperRecovered>
  <NotifyShipperRelease>true</NotifyShipperRelease>
  <OrderState>sample string 60</OrderState>
  <OrderStatus>61</OrderStatus>
  <RecoverAirportID>sample string 59</RecoverAirportID>
  <ShipmentGUID>sample string 3</ShipmentGUID>
</ShipmentNotifyResp>