POST api/Integration/Status

This method is used internally to process integration status messages. It is also the template you should use when creating a web service that will receive status messages from a ParcelLogic TMS system (ShipSameday)

Request Information

URI Parameters

None.

Body Parameters

IntegrationStatusItem

Name	Description	Type	Additional information
UserGUID	User identifier of company sending status message (assigned by receiving company)	string	None.
ShipmentNumber	Unique shipment number in senders system	string	None.
Reference	Reference number for this order provided by receiver (ShipmentNumber if PLTMS)	string	None.
SenderID	Identifier of company sending this message (Senders CompanyID if PLTMS)	string	None.
ReceiverID	Identifier of company receiving this message (Receivers CompanyID if PLTMS)	string	None.
EventCode	The type of event: ORDERACK = order/alert acknowledged and confirmed accepted DISPATCHED = courier has been dispatched to pickup PICKEDUP = order has been picked-up/collected OFD = shipment is out for delivery DELIVERED = shipment delivered QDTORIG = original quoted delivery time established QDTCHANGE = quoted delivery time changed	string	None.
EventDateTime	The actual date/time UTC that the event occured (null means that event did not occur yet)	string	None.
Latitude	If available, the current latitude of the shipment reported in this event	decimal number	None.
Longitude	If available, the current longitude of the shipment reported in this event	decimal number	None.
SignatureText	The textual represetation of the pickup or delivery signature	string	None.
Pieces	Total pieces	integer	None.
Weight	Total weight	decimal number	None.
WeightUOM	Weight UOM (LB, KG)	string	None.
Length	Length	integer	None.
Width	Width	integer	None.
Height	Height	integer	None.
SizeUOM	Size UOM (IN,CM)	string	None.
Distance	Distance between pickup and delivery	integer	None.
DistanceUOM	Distance unit (MI,KM)	string	None.
PickupWaitingTime	Amount of waiting time minutes at pickup	integer	None.
PickupAttemptCount	Number of pickup attempts	integer	None.
DeliveryWaitingTime	Amount of waiting time minutes at delivery	integer	None.
DeliveryAttemptCount	Number of delivery attempt	integer	None.
QuotedDeliveryDateTime	The original quoted delivery date/time	string	None.
UpdatedDeliveryDateTime	The updated quoted delivery date/time	string	None.
Images	Contains images associated with this shipment status including photos and signature	Collection of ImageItem	None.
AcknowledgeUserName	Name of user that acknowledged the order	string	None.

Request Formats

application/json, text/json

Sample:

{
  "UserGUID": "sample string 1",
  "ShipmentNumber": "sample string 2",
  "Reference": "sample string 3",
  "SenderID": "sample string 4",
  "ReceiverID": "sample string 5",
  "EventCode": "sample string 6",
  "EventDateTime": "sample string 7",
  "Latitude": 1.0,
  "Longitude": 1.0,
  "SignatureText": "sample string 8",
  "Pieces": 9,
  "Weight": 1.0,
  "WeightUOM": "sample string 10",
  "Length": 1,
  "Width": 1,
  "Height": 1,
  "SizeUOM": "sample string 11",
  "Distance": 1,
  "DistanceUOM": "sample string 12",
  "PickupWaitingTime": 1,
  "PickupAttemptCount": 1,
  "DeliveryWaitingTime": 1,
  "DeliveryAttemptCount": 1,
  "QuotedDeliveryDateTime": "sample string 13",
  "UpdatedDeliveryDateTime": "sample string 14",
  "Images": [
    {
      "FileName": "sample string 1",
      "ImageData": "sample string 2",
      "ImageType": "sample string 3"
    },
    {
      "FileName": "sample string 1",
      "ImageData": "sample string 2",
      "ImageType": "sample string 3"
    }
  ],
  "AcknowledgeUserName": "sample string 15"
}

application/xml, text/xml

Sample:

<IntegrationStatusItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <AcknowledgeUserName>sample string 15</AcknowledgeUserName>
  <DeliveryAttemptCount>1</DeliveryAttemptCount>
  <DeliveryWaitingTime>1</DeliveryWaitingTime>
  <Distance>1</Distance>
  <DistanceUOM>sample string 12</DistanceUOM>
  <EventCode>sample string 6</EventCode>
  <EventDateTime>sample string 7</EventDateTime>
  <Height>1</Height>
  <Images>
    <ImageItem>
      <FileName>sample string 1</FileName>
      <ImageData>sample string 2</ImageData>
      <ImageType>sample string 3</ImageType>
    </ImageItem>
    <ImageItem>
      <FileName>sample string 1</FileName>
      <ImageData>sample string 2</ImageData>
      <ImageType>sample string 3</ImageType>
    </ImageItem>
  </Images>
  <Latitude>1</Latitude>
  <Length>1</Length>
  <Longitude>1</Longitude>
  <PickupAttemptCount>1</PickupAttemptCount>
  <PickupWaitingTime>1</PickupWaitingTime>
  <Pieces>9</Pieces>
  <QuotedDeliveryDateTime>sample string 13</QuotedDeliveryDateTime>
  <ReceiverID>sample string 5</ReceiverID>
  <Reference>sample string 3</Reference>
  <SenderID>sample string 4</SenderID>
  <ShipmentNumber>sample string 2</ShipmentNumber>
  <SignatureText>sample string 8</SignatureText>
  <SizeUOM>sample string 11</SizeUOM>
  <UpdatedDeliveryDateTime>sample string 14</UpdatedDeliveryDateTime>
  <UserGUID>sample string 1</UserGUID>
  <Weight>1</Weight>
  <WeightUOM>sample string 10</WeightUOM>
  <Width>1</Width>
</IntegrationStatusItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful	Set to true if method was successful	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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