POST api/ShipmentNotify/Update

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipmentGUID	string	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.
NotifyShipperDelivered	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.
NotifyConseeDelivered	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.
NotifyOtherDelivered	boolean	None.
NotifyShipperOrigQdt	boolean	None.
NotifyShipperChangeQdt	boolean	None.
NotifyConseeOrigQdt	boolean	None.
NotifyConseeChangeQdt	boolean	None.
NotifyOtherOrigQdt	boolean	None.
NotifyOtherChangeQdt	boolean	None.
NotifyShipperOutForDelivery	boolean	None.
NotifyConseeOutForDelivery	boolean	None.
NotifyOtherOutForDelivery	boolean	None.
NotifyShipperRelease	boolean	None.
NotifyConseeRelease	boolean	None.
NotifyOtherRelease	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "NotifyShipperOrderAck": true,
  "NotifyShipperOrderRouted": true,
  "NotifyShipperDispatched": true,
  "NotifyShipperPickedUp": true,
  "NotifyShipperDepToAp": true,
  "NotifyShipperObcCheckin": true,
  "NotifyShipperDropped": true,
  "NotifyShipperConfirmed": true,
  "NotifyShipperDeparted": true,
  "NotifyShipperArrived": true,
  "NotifyShipperRecovered": true,
  "NotifyShipperDelivered": true,
  "NotifyConseeOrderAck": true,
  "NotifyConseeOrderRouted": true,
  "NotifyConseeDispatched": true,
  "NotifyConseePickedUp": true,
  "NotifyConseeDepToAp": true,
  "NotifyConseeObcCheckin": true,
  "NotifyConseeDropped": true,
  "NotifyConseeConfirmed": true,
  "NotifyConseeDeparted": true,
  "NotifyConseeArrived": true,
  "NotifyConseeRecovered": true,
  "NotifyConseeDelivered": true,
  "NotifyOtherEmail": "sample string 27",
  "NotifyOtherOrderAck": true,
  "NotifyOtherOrderRouted": true,
  "NotifyOtherDispatched": true,
  "NotifyOtherPickedUp": true,
  "NotifyOtherDepToAp": true,
  "NotifyOtherObcCheckin": true,
  "NotifyOtherDropped": true,
  "NotifyOtherConfirmed": true,
  "NotifyOtherDeparted": true,
  "NotifyOtherArrived": true,
  "NotifyOtherRecovered": true,
  "NotifyOtherDelivered": true,
  "NotifyShipperOrigQdt": true,
  "NotifyShipperChangeQdt": true,
  "NotifyConseeOrigQdt": true,
  "NotifyConseeChangeQdt": true,
  "NotifyOtherOrigQdt": true,
  "NotifyOtherChangeQdt": true,
  "NotifyShipperOutForDelivery": true,
  "NotifyConseeOutForDelivery": true,
  "NotifyOtherOutForDelivery": true,
  "NotifyShipperRelease": true,
  "NotifyConseeRelease": true,
  "NotifyOtherRelease": true
}

application/xml, text/xml

Sample:

<ShipmentNotifyUpdateParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <NotifyConseeArrived>true</NotifyConseeArrived>
  <NotifyConseeChangeQdt>true</NotifyConseeChangeQdt>
  <NotifyConseeConfirmed>true</NotifyConseeConfirmed>
  <NotifyConseeDelivered>true</NotifyConseeDelivered>
  <NotifyConseeDepToAp>true</NotifyConseeDepToAp>
  <NotifyConseeDeparted>true</NotifyConseeDeparted>
  <NotifyConseeDispatched>true</NotifyConseeDispatched>
  <NotifyConseeDropped>true</NotifyConseeDropped>
  <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 27</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>
  <NotifyShipperArrived>true</NotifyShipperArrived>
  <NotifyShipperChangeQdt>true</NotifyShipperChangeQdt>
  <NotifyShipperConfirmed>true</NotifyShipperConfirmed>
  <NotifyShipperDelivered>true</NotifyShipperDelivered>
  <NotifyShipperDepToAp>true</NotifyShipperDepToAp>
  <NotifyShipperDeparted>true</NotifyShipperDeparted>
  <NotifyShipperDispatched>true</NotifyShipperDispatched>
  <NotifyShipperDropped>true</NotifyShipperDropped>
  <NotifyShipperObcCheckin>true</NotifyShipperObcCheckin>
  <NotifyShipperOrderAck>true</NotifyShipperOrderAck>
  <NotifyShipperOrderRouted>true</NotifyShipperOrderRouted>
  <NotifyShipperOrigQdt>true</NotifyShipperOrigQdt>
  <NotifyShipperOutForDelivery>true</NotifyShipperOutForDelivery>
  <NotifyShipperPickedUp>true</NotifyShipperPickedUp>
  <NotifyShipperRecovered>true</NotifyShipperRecovered>
  <NotifyShipperRelease>true</NotifyShipperRelease>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <auth>sample string 1</auth>
</ShipmentNotifyUpdateParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentNotifyUpdateResp

Name	Type	Additional information
IsSuccessful	boolean	None.
ErrorMessage	string	None.
AutoNotifySummary	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "AutoNotifySummary": "sample string 3"
}

application/xml, text/xml

Sample:

<ShipmentNotifyUpdateResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AutoNotifySummary>sample string 3</AutoNotifySummary>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ShipmentNotifyUpdateResp>