POST api/ManifestShipment/InsertByShipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	None.
ShipmentGUID	string	None.
ManifestGUID	string	None.
ManifestDate	date	None.
ManagingOfficeID	integer	None.
Status	string	None.
CarrierID	integer	None.
CarrierServiceID	integer	None.
CarrierAccountID	integer	None.
WaybillNumber	string	None.
DepartHubID	string	None.
ArriveHubID	string	None.
TotalWeight	decimal number	None.
WeightUOM	string	None.
Weight1	decimal number	None.
Weight2	decimal number	None.
Weight3	decimal number	None.
Weight4	decimal number	None.
Weight5	decimal number	None.
Weight6	decimal number	None.
Weight7	decimal number	None.
Weight8	decimal number	None.
Weight9	decimal number	None.
Weight10	decimal number	None.
BagGUID1	string	None.
BagGUID2	string	None.
BagGUID3	string	None.
BagGUID4	string	None.
BagGUID5	string	None.
BagGUID6	string	None.
BagGUID7	string	None.
BagGUID8	string	None.
BagGUID9	string	None.
BagGUID10	string	None.
DropOfficeID	integer	None.
DropCourierID	integer	None.
DropCourierServiceID	integer	None.
DropAlertVia	string	None.
DropAlertHow	string	None.
DropAlertUserID	integer	None.
DropSpokeWith	string	None.
DropSentDateTime	date	None.
DropAcceptedDateTime	date	None.
DropActualWaitingTime	integer	None.
DropActualDistance	integer	None.
DropActualWeight	decimal number	None.
DropActualDistanceUOM	string	None.
DropActualWeightUOM	string	None.
DropDateTime	date	None.
RecoverOfficeID	integer	None.
RecoverCourierID	integer	None.
RecoverCourierServiceID	integer	None.
RecoverAlertVia	string	None.
RecoverAlertHow	string	None.
RecoverSpokeWith	string	None.
RecoverActualWaitingTime	integer	None.
RecoverActualDistance	integer	None.
RecoverActualWeight	decimal number	None.
RecoverActualDistanceUOM	string	None.
RecoverActualWeightUOM	string	None.
RecoverDateTime	date	None.
RecoverType	string	None.
AlertType	string	None.
DropInstructions	string	None.
RecoverInstructions	string	None.
ConseeAcct	string	None.
ConseeName	string	None.
ConseeAddr	string	None.
ConseeAddr2	string	None.
ConseePlace	string	None.
ConseeState	string	None.
ConseePostal	string	None.
ConseeCountry	string	None.
ConseeContactID1	string	None.
ConseeContactNum1	string	None.
ConseeContactID2	string	None.
ConseeContactNum2	string	None.
SpotQuoteReference	string	None.
CutoffDateTime	date	None.
SCICode	string	None.
CustomsStatus	string	None.
AmsSiteID	string	None.
AmsWaybillOriginator	string	None.
ConseeCode	string	None.
ConseeMawbIdentifier	string	None.
ConseeContactName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "ManifestGUID": "sample string 3",
  "ManifestDate": "2025-12-03T12:35:19.0259684+00:00",
  "ManagingOfficeID": 5,
  "Status": "sample string 6",
  "CarrierID": 1,
  "CarrierServiceID": 1,
  "CarrierAccountID": 1,
  "WaybillNumber": "sample string 7",
  "DepartHubID": "sample string 8",
  "ArriveHubID": "sample string 9",
  "TotalWeight": 10.0,
  "WeightUOM": "sample string 11",
  "Weight1": 1.0,
  "Weight2": 1.0,
  "Weight3": 1.0,
  "Weight4": 1.0,
  "Weight5": 1.0,
  "Weight6": 1.0,
  "Weight7": 1.0,
  "Weight8": 1.0,
  "Weight9": 1.0,
  "Weight10": 1.0,
  "BagGUID1": "sample string 12",
  "BagGUID2": "sample string 13",
  "BagGUID3": "sample string 14",
  "BagGUID4": "sample string 15",
  "BagGUID5": "sample string 16",
  "BagGUID6": "sample string 17",
  "BagGUID7": "sample string 18",
  "BagGUID8": "sample string 19",
  "BagGUID9": "sample string 20",
  "BagGUID10": "sample string 21",
  "DropOfficeID": 1,
  "DropCourierID": 1,
  "DropCourierServiceID": 1,
  "DropAlertVia": "sample string 22",
  "DropAlertHow": "sample string 23",
  "DropAlertUserID": 1,
  "DropSpokeWith": "sample string 24",
  "DropSentDateTime": "2025-12-03T12:35:19.0415943+00:00",
  "DropAcceptedDateTime": "2025-12-03T12:35:19.0415943+00:00",
  "DropActualWaitingTime": 1,
  "DropActualDistance": 1,
  "DropActualWeight": 1.0,
  "DropActualDistanceUOM": "sample string 25",
  "DropActualWeightUOM": "sample string 26",
  "DropDateTime": "2025-12-03T12:35:19.0415943+00:00",
  "RecoverOfficeID": 1,
  "RecoverCourierID": 1,
  "RecoverCourierServiceID": 1,
  "RecoverAlertVia": "sample string 27",
  "RecoverAlertHow": "sample string 28",
  "RecoverSpokeWith": "sample string 29",
  "RecoverActualWaitingTime": 1,
  "RecoverActualDistance": 1,
  "RecoverActualWeight": 1.0,
  "RecoverActualDistanceUOM": "sample string 30",
  "RecoverActualWeightUOM": "sample string 31",
  "RecoverDateTime": "2025-12-03T12:35:19.0415943+00:00",
  "RecoverType": "sample string 32",
  "AlertType": "sample string 33",
  "DropInstructions": "sample string 34",
  "RecoverInstructions": "sample string 35",
  "ConseeAcct": "sample string 36",
  "ConseeName": "sample string 37",
  "ConseeAddr": "sample string 38",
  "ConseeAddr2": "sample string 39",
  "ConseePlace": "sample string 40",
  "ConseeState": "sample string 41",
  "ConseePostal": "sample string 42",
  "ConseeCountry": "sample string 43",
  "ConseeContactID1": "sample string 44",
  "ConseeContactNum1": "sample string 45",
  "ConseeContactID2": "sample string 46",
  "ConseeContactNum2": "sample string 47",
  "SpotQuoteReference": "sample string 48",
  "CutoffDateTime": "2025-12-03T12:35:19.0415943+00:00",
  "SCICode": "sample string 49",
  "CustomsStatus": "sample string 50",
  "AmsSiteID": "sample string 51",
  "AmsWaybillOriginator": "sample string 52",
  "ConseeCode": "sample string 53",
  "ConseeMawbIdentifier": "sample string 54",
  "ConseeContactName": "sample string 55"
}

application/xml, text/xml

Sample:

<InsertByShipmentParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AlertType>sample string 33</AlertType>
  <AmsSiteID>sample string 51</AmsSiteID>
  <AmsWaybillOriginator>sample string 52</AmsWaybillOriginator>
  <ArriveHubID>sample string 9</ArriveHubID>
  <BagGUID1>sample string 12</BagGUID1>
  <BagGUID10>sample string 21</BagGUID10>
  <BagGUID2>sample string 13</BagGUID2>
  <BagGUID3>sample string 14</BagGUID3>
  <BagGUID4>sample string 15</BagGUID4>
  <BagGUID5>sample string 16</BagGUID5>
  <BagGUID6>sample string 17</BagGUID6>
  <BagGUID7>sample string 18</BagGUID7>
  <BagGUID8>sample string 19</BagGUID8>
  <BagGUID9>sample string 20</BagGUID9>
  <CarrierAccountID>1</CarrierAccountID>
  <CarrierID>1</CarrierID>
  <CarrierServiceID>1</CarrierServiceID>
  <ConseeAcct>sample string 36</ConseeAcct>
  <ConseeAddr>sample string 38</ConseeAddr>
  <ConseeAddr2>sample string 39</ConseeAddr2>
  <ConseeCode>sample string 53</ConseeCode>
  <ConseeContactID1>sample string 44</ConseeContactID1>
  <ConseeContactID2>sample string 46</ConseeContactID2>
  <ConseeContactName>sample string 55</ConseeContactName>
  <ConseeContactNum1>sample string 45</ConseeContactNum1>
  <ConseeContactNum2>sample string 47</ConseeContactNum2>
  <ConseeCountry>sample string 43</ConseeCountry>
  <ConseeMawbIdentifier>sample string 54</ConseeMawbIdentifier>
  <ConseeName>sample string 37</ConseeName>
  <ConseePlace>sample string 40</ConseePlace>
  <ConseePostal>sample string 42</ConseePostal>
  <ConseeState>sample string 41</ConseeState>
  <CustomsStatus>sample string 50</CustomsStatus>
  <CutoffDateTime>2025-12-03T12:35:19.0415943+00:00</CutoffDateTime>
  <DepartHubID>sample string 8</DepartHubID>
  <DropAcceptedDateTime>2025-12-03T12:35:19.0415943+00:00</DropAcceptedDateTime>
  <DropActualDistance>1</DropActualDistance>
  <DropActualDistanceUOM>sample string 25</DropActualDistanceUOM>
  <DropActualWaitingTime>1</DropActualWaitingTime>
  <DropActualWeight>1</DropActualWeight>
  <DropActualWeightUOM>sample string 26</DropActualWeightUOM>
  <DropAlertHow>sample string 23</DropAlertHow>
  <DropAlertUserID>1</DropAlertUserID>
  <DropAlertVia>sample string 22</DropAlertVia>
  <DropCourierID>1</DropCourierID>
  <DropCourierServiceID>1</DropCourierServiceID>
  <DropDateTime>2025-12-03T12:35:19.0415943+00:00</DropDateTime>
  <DropInstructions>sample string 34</DropInstructions>
  <DropOfficeID>1</DropOfficeID>
  <DropSentDateTime>2025-12-03T12:35:19.0415943+00:00</DropSentDateTime>
  <DropSpokeWith>sample string 24</DropSpokeWith>
  <ManagingOfficeID>5</ManagingOfficeID>
  <ManifestDate>2025-12-03T12:35:19.0259684+00:00</ManifestDate>
  <ManifestGUID>sample string 3</ManifestGUID>
  <RecoverActualDistance>1</RecoverActualDistance>
  <RecoverActualDistanceUOM>sample string 30</RecoverActualDistanceUOM>
  <RecoverActualWaitingTime>1</RecoverActualWaitingTime>
  <RecoverActualWeight>1</RecoverActualWeight>
  <RecoverActualWeightUOM>sample string 31</RecoverActualWeightUOM>
  <RecoverAlertHow>sample string 28</RecoverAlertHow>
  <RecoverAlertVia>sample string 27</RecoverAlertVia>
  <RecoverCourierID>1</RecoverCourierID>
  <RecoverCourierServiceID>1</RecoverCourierServiceID>
  <RecoverDateTime>2025-12-03T12:35:19.0415943+00:00</RecoverDateTime>
  <RecoverInstructions>sample string 35</RecoverInstructions>
  <RecoverOfficeID>1</RecoverOfficeID>
  <RecoverSpokeWith>sample string 29</RecoverSpokeWith>
  <RecoverType>sample string 32</RecoverType>
  <SCICode>sample string 49</SCICode>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <SpotQuoteReference>sample string 48</SpotQuoteReference>
  <Status>sample string 6</Status>
  <TotalWeight>10</TotalWeight>
  <WaybillNumber>sample string 7</WaybillNumber>
  <Weight1>1</Weight1>
  <Weight10>1</Weight10>
  <Weight2>1</Weight2>
  <Weight3>1</Weight3>
  <Weight4>1</Weight4>
  <Weight5>1</Weight5>
  <Weight6>1</Weight6>
  <Weight7>1</Weight7>
  <Weight8>1</Weight8>
  <Weight9>1</Weight9>
  <WeightUOM>sample string 11</WeightUOM>
  <auth>sample string 1</auth>
</InsertByShipmentParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

Name	Description	Type	Additional information
IsSuccessful		boolean	None.
ErrorMessage		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/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>