GET api/P3PLShipment/{id}

Return a single value from the P3PLShipment table using the primary key as ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ServiceMap Primary Key.	integer	Required

Body Parameters

None.

Response Information

Resource Description

P3PLShipment

Name	Type	Additional information
ShipmentID	integer	None.
ClientID	integer	None.
OrderID	integer	None.
UserID	integer	None.
WarehouseID	integer	None.
ShipDate	date	None.
ConsigneeName	string	None.
ConsigneeEmail	string	None.
ConsigneePhone	string	None.
ConsigneeAddress1	string	None.
ConsigneeAddress2	string	None.
ConsigneeCity	string	None.
ConsigneeStateProvince	string	None.
ConsigneePostalCode	string	None.
ConsigneeCountry	string	None.
Comments	string	None.
ShippingServiceCode	string	None.
TotalPackageCount	integer	None.
ReferenceNumber	string	None.
ConsigneeCompany	string	None.
ConsigneeCustomerID	string	None.
ConsigneePONumber	string	None.
ReferenceAdditional	string	None.
ConsigneeNotificationCompleted	boolean	None.
ClientNotificationCompleted	boolean	None.
ClientComments	string	None.
PropackComments	string	None.
ShipmentValidated	boolean	None.
ManifestSourceID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ShipmentID": 1,
  "ClientID": 2,
  "OrderID": 3,
  "UserID": 4,
  "WarehouseID": 5,
  "ShipDate": "2025-12-06T23:42:06.9595511+00:00",
  "ConsigneeName": "sample string 7",
  "ConsigneeEmail": "sample string 8",
  "ConsigneePhone": "sample string 9",
  "ConsigneeAddress1": "sample string 10",
  "ConsigneeAddress2": "sample string 11",
  "ConsigneeCity": "sample string 12",
  "ConsigneeStateProvince": "sample string 13",
  "ConsigneePostalCode": "sample string 14",
  "ConsigneeCountry": "sample string 15",
  "Comments": "sample string 16",
  "ShippingServiceCode": "sample string 17",
  "TotalPackageCount": 18,
  "ReferenceNumber": "sample string 19",
  "ConsigneeCompany": "sample string 20",
  "ConsigneeCustomerID": "sample string 21",
  "ConsigneePONumber": "sample string 22",
  "ReferenceAdditional": "sample string 23",
  "ConsigneeNotificationCompleted": true,
  "ClientNotificationCompleted": true,
  "ClientComments": "sample string 26",
  "PropackComments": "sample string 27",
  "ShipmentValidated": true,
  "ManifestSourceID": 29
}

application/xml, text/xml

Sample:

<P3PLShipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables">
  <ClientComments>sample string 26</ClientComments>
  <ClientID>2</ClientID>
  <ClientNotificationCompleted>true</ClientNotificationCompleted>
  <Comments>sample string 16</Comments>
  <ConsigneeAddress1>sample string 10</ConsigneeAddress1>
  <ConsigneeAddress2>sample string 11</ConsigneeAddress2>
  <ConsigneeCity>sample string 12</ConsigneeCity>
  <ConsigneeCompany>sample string 20</ConsigneeCompany>
  <ConsigneeCountry>sample string 15</ConsigneeCountry>
  <ConsigneeCustomerID>sample string 21</ConsigneeCustomerID>
  <ConsigneeEmail>sample string 8</ConsigneeEmail>
  <ConsigneeName>sample string 7</ConsigneeName>
  <ConsigneeNotificationCompleted>true</ConsigneeNotificationCompleted>
  <ConsigneePONumber>sample string 22</ConsigneePONumber>
  <ConsigneePhone>sample string 9</ConsigneePhone>
  <ConsigneePostalCode>sample string 14</ConsigneePostalCode>
  <ConsigneeStateProvince>sample string 13</ConsigneeStateProvince>
  <ManifestSourceID>29</ManifestSourceID>
  <OrderID>3</OrderID>
  <PropackComments>sample string 27</PropackComments>
  <ReferenceAdditional>sample string 23</ReferenceAdditional>
  <ReferenceNumber>sample string 19</ReferenceNumber>
  <ShipDate>2025-12-06T23:42:06.9595511+00:00</ShipDate>
  <ShipmentID>1</ShipmentID>
  <ShipmentValidated>true</ShipmentValidated>
  <ShippingServiceCode>sample string 17</ShippingServiceCode>
  <TotalPackageCount>18</TotalPackageCount>
  <UserID>4</UserID>
  <WarehouseID>5</WarehouseID>
</P3PLShipment>