POST api/Manifest/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
auth	string	Required
ManifestGUID	string	Max length: 25
ManagingOfficeID	integer	Required
Status	string	Required
ManifestDate	date	Required
ManifestType	string	Required Max length: 1
CarrierID	integer	None.
CarrierServiceID	integer	None.
CarrierAccountID	integer	None.
WaybillNumber	string	Max length: 20
DepartHubID	string	Max length: 3
ArriveHubID	string	Max length: 3
TotalWeight	decimal number	Required
WeightUOM	string	Required Max length: 2
DropDateTime	date	None.
RecoverDateTime	date	None.
DropOfficeID	integer	None.
DropCourierID	integer	None.
DropCourierServiceID	integer	None.
DropAlertVia	string	Max length: 100
DropAlertHow	string	Max length: 3
DropAlertUserID	integer	None.
DropSpokeWith	string	Max length: 50
DropSentDateTime	date	None.
DropAcceptedDateTime	date	None.
DropActualWaitingTime	integer	None.
DropActualDistance	integer	None.
DropActualWeight	decimal number	None.
DropActualDistanceUOM	string	Max length: 2
DropActualWeightUOM	string	Max length: 2
RecoverOfficeID	integer	None.
RecoverCourierID	integer	None.
RecoverCourierServiceID	integer	None.
RecoverAlertVia	string	Max length: 100
RecoverAlertHow	string	Max length: 3
RecoverSpokeWith	string	Max length: 50
RecoverActualWaitingTime	integer	None.
RecoverActualDistance	integer	None.
RecoverActualWeight	decimal number	None.
RecoverActualDistanceUOM	string	Required Max length: 2
RecoverActualWeightUOM	string	Required Max length: 2
CreateFirstBag	boolean	Required
BagTypeID	integer	None.
LockCost	boolean	Required
RecoverType	string	Required Max length: 1
IsShipperTypeAgent	boolean	Required
IsShipperTypeCustomer	boolean	Required
IsShipperTypeAddress	boolean	Required
ShipperCode	string	Max length: 20
ShipperAccountNumber	string	Max length: 14
ShipperName	string	Max length: 35
ShipperAddress	string	Max length: 35
ShipperAddress2	string	Max length: 35
ShipperPlace	string	Max length: 17
ShipperStateProv	string	Max length: 9
ShipperPostalCode	string	Max length: 9
ShipperCountryID	string	Max length: 2
ShipperContactID1	string	Max length: 2
ShipperContactNumber1	string	Max length: 25
ShipperContactID2	string	Max length: 2
ShipperContactNumber2	string	Max length: 25
ShipperContactName	string	Max length: 50
IsConseeTypeAgent	boolean	Required
IsConseeTypeBroker	boolean	Required
IsConseeTypeAddress	boolean	Required
ConseeCode	string	Max length: 20
ConseeAccountNumber	string	Max length: 14
ConseeName	string	Max length: 40
ConseeAddress	string	Max length: 40
ConseeAddress2	string	Max length: 40
ConseePlace	string	Max length: 17
ConseeStateProv	string	Max length: 9
ConseePostalCode	string	Max length: 9
ConseeCountryID	string	Max length: 2
ConseeContactID1	string	Max length: 2
ConseeContactNumber1	string	Max length: 25
ConseeContactID2	string	Max length: 2
ConseeContactNumber2	string	Max length: 25
ConseeContactName	string	Max length: 50
AgentAccountNumber	string	Max length: 14
AgentIATACargoAgentNumber	string	Max length: 7
AgentCASSAddress	string	Max length: 4
AgentName	string	Max length: 35
AgentPlace	string	Max length: 17
DropInstructions	string	Max length: 1000
RecoverInstructions	string	Max length: 1000
SpotQuoteReference	string	Max length: 20
CutoffDateTime	date	None.
SCICode	string	Max length: 2
CustomsStatus	string	Max length: 18
CustomsBrokerGUID	string	Max length: 36
CustomsExceptionGUID	string	Max length: 36
AmsSiteID	string	Max length: 4
AmsWaybillOriginator	string	Max length: 4
IgnoreRouting	boolean	Required
PrebookContents	string	Max length: 15
ShipperMawbIdentifier	string	Max length: 30
ConseeMawbIdentifier	string	Max length: 30
GermanyLBAUserID	integer	None.
GermanyLBADateTime	date	None.
ShipperAeoNumber	string	Max length: 30
ConseeAeoNumber	string	Max length: 30

Request Formats

application/json, text/json

Sample:

{
  "auth": "sample string 1",
  "ManifestGUID": "sample string 2",
  "ManagingOfficeID": 3,
  "Status": "sample string 4",
  "ManifestDate": "2024-09-19T09:08:26.26755+00:00",
  "ManifestType": "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",
  "DropDateTime": "2024-09-19T09:08:26.26755+00:00",
  "RecoverDateTime": "2024-09-19T09:08:26.2833837+00:00",
  "DropOfficeID": 1,
  "DropCourierID": 1,
  "DropCourierServiceID": 1,
  "DropAlertVia": "sample string 12",
  "DropAlertHow": "sample string 13",
  "DropAlertUserID": 1,
  "DropSpokeWith": "sample string 14",
  "DropSentDateTime": "2024-09-19T09:08:26.2833837+00:00",
  "DropAcceptedDateTime": "2024-09-19T09:08:26.2833837+00:00",
  "DropActualWaitingTime": 1,
  "DropActualDistance": 1,
  "DropActualWeight": 1.0,
  "DropActualDistanceUOM": "sample string 15",
  "DropActualWeightUOM": "sample string 16",
  "RecoverOfficeID": 1,
  "RecoverCourierID": 1,
  "RecoverCourierServiceID": 1,
  "RecoverAlertVia": "sample string 17",
  "RecoverAlertHow": "sample string 18",
  "RecoverSpokeWith": "sample string 19",
  "RecoverActualWaitingTime": 1,
  "RecoverActualDistance": 1,
  "RecoverActualWeight": 1.0,
  "RecoverActualDistanceUOM": "sample string 20",
  "RecoverActualWeightUOM": "sample string 21",
  "CreateFirstBag": true,
  "BagTypeID": 1,
  "LockCost": true,
  "RecoverType": "sample string 24",
  "IsShipperTypeAgent": true,
  "IsShipperTypeCustomer": true,
  "IsShipperTypeAddress": true,
  "ShipperCode": "sample string 28",
  "ShipperAccountNumber": "sample string 29",
  "ShipperName": "sample string 30",
  "ShipperAddress": "sample string 31",
  "ShipperAddress2": "sample string 32",
  "ShipperPlace": "sample string 33",
  "ShipperStateProv": "sample string 34",
  "ShipperPostalCode": "sample string 35",
  "ShipperCountryID": "sample string 36",
  "ShipperContactID1": "sample string 37",
  "ShipperContactNumber1": "sample string 38",
  "ShipperContactID2": "sample string 39",
  "ShipperContactNumber2": "sample string 40",
  "ShipperContactName": "sample string 41",
  "IsConseeTypeAgent": true,
  "IsConseeTypeBroker": true,
  "IsConseeTypeAddress": true,
  "ConseeCode": "sample string 45",
  "ConseeAccountNumber": "sample string 46",
  "ConseeName": "sample string 47",
  "ConseeAddress": "sample string 48",
  "ConseeAddress2": "sample string 49",
  "ConseePlace": "sample string 50",
  "ConseeStateProv": "sample string 51",
  "ConseePostalCode": "sample string 52",
  "ConseeCountryID": "sample string 53",
  "ConseeContactID1": "sample string 54",
  "ConseeContactNumber1": "sample string 55",
  "ConseeContactID2": "sample string 56",
  "ConseeContactNumber2": "sample string 57",
  "ConseeContactName": "sample string 58",
  "AgentAccountNumber": "sample string 59",
  "AgentIATACargoAgentNumber": "sample string 60",
  "AgentCASSAddress": "sample string 61",
  "AgentName": "sample string 62",
  "AgentPlace": "sample string 63",
  "DropInstructions": "sample string 64",
  "RecoverInstructions": "sample string 65",
  "SpotQuoteReference": "sample string 66",
  "CutoffDateTime": "2024-09-19T09:08:26.2833837+00:00",
  "SCICode": "sample string 67",
  "CustomsStatus": "sample string 68",
  "CustomsBrokerGUID": "sample string 69",
  "CustomsExceptionGUID": "sample string 70",
  "AmsSiteID": "sample string 71",
  "AmsWaybillOriginator": "sample string 72",
  "IgnoreRouting": true,
  "PrebookContents": "sample string 74",
  "ShipperMawbIdentifier": "sample string 75",
  "ConseeMawbIdentifier": "sample string 76",
  "GermanyLBAUserID": 1,
  "GermanyLBADateTime": "2024-09-19T09:08:26.2833837+00:00",
  "ShipperAeoNumber": "sample string 77",
  "ConseeAeoNumber": "sample string 78"
}

application/xml, text/xml

Sample:

<ManifestCreateParms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <AgentAccountNumber>sample string 59</AgentAccountNumber>
  <AgentCASSAddress>sample string 61</AgentCASSAddress>
  <AgentIATACargoAgentNumber>sample string 60</AgentIATACargoAgentNumber>
  <AgentName>sample string 62</AgentName>
  <AgentPlace>sample string 63</AgentPlace>
  <AmsSiteID>sample string 71</AmsSiteID>
  <AmsWaybillOriginator>sample string 72</AmsWaybillOriginator>
  <ArriveHubID>sample string 9</ArriveHubID>
  <BagTypeID>1</BagTypeID>
  <CarrierAccountID>1</CarrierAccountID>
  <CarrierID>1</CarrierID>
  <CarrierServiceID>1</CarrierServiceID>
  <ConseeAccountNumber>sample string 46</ConseeAccountNumber>
  <ConseeAddress>sample string 48</ConseeAddress>
  <ConseeAddress2>sample string 49</ConseeAddress2>
  <ConseeAeoNumber>sample string 78</ConseeAeoNumber>
  <ConseeCode>sample string 45</ConseeCode>
  <ConseeContactID1>sample string 54</ConseeContactID1>
  <ConseeContactID2>sample string 56</ConseeContactID2>
  <ConseeContactName>sample string 58</ConseeContactName>
  <ConseeContactNumber1>sample string 55</ConseeContactNumber1>
  <ConseeContactNumber2>sample string 57</ConseeContactNumber2>
  <ConseeCountryID>sample string 53</ConseeCountryID>
  <ConseeMawbIdentifier>sample string 76</ConseeMawbIdentifier>
  <ConseeName>sample string 47</ConseeName>
  <ConseePlace>sample string 50</ConseePlace>
  <ConseePostalCode>sample string 52</ConseePostalCode>
  <ConseeStateProv>sample string 51</ConseeStateProv>
  <CreateFirstBag>true</CreateFirstBag>
  <CustomsBrokerGUID>sample string 69</CustomsBrokerGUID>
  <CustomsExceptionGUID>sample string 70</CustomsExceptionGUID>
  <CustomsStatus>sample string 68</CustomsStatus>
  <CutoffDateTime>2024-09-19T09:08:26.2833837+00:00</CutoffDateTime>
  <DepartHubID>sample string 8</DepartHubID>
  <DropAcceptedDateTime>2024-09-19T09:08:26.2833837+00:00</DropAcceptedDateTime>
  <DropActualDistance>1</DropActualDistance>
  <DropActualDistanceUOM>sample string 15</DropActualDistanceUOM>
  <DropActualWaitingTime>1</DropActualWaitingTime>
  <DropActualWeight>1</DropActualWeight>
  <DropActualWeightUOM>sample string 16</DropActualWeightUOM>
  <DropAlertHow>sample string 13</DropAlertHow>
  <DropAlertUserID>1</DropAlertUserID>
  <DropAlertVia>sample string 12</DropAlertVia>
  <DropCourierID>1</DropCourierID>
  <DropCourierServiceID>1</DropCourierServiceID>
  <DropDateTime>2024-09-19T09:08:26.26755+00:00</DropDateTime>
  <DropInstructions>sample string 64</DropInstructions>
  <DropOfficeID>1</DropOfficeID>
  <DropSentDateTime>2024-09-19T09:08:26.2833837+00:00</DropSentDateTime>
  <DropSpokeWith>sample string 14</DropSpokeWith>
  <GermanyLBADateTime>2024-09-19T09:08:26.2833837+00:00</GermanyLBADateTime>
  <GermanyLBAUserID>1</GermanyLBAUserID>
  <IgnoreRouting>true</IgnoreRouting>
  <IsConseeTypeAddress>true</IsConseeTypeAddress>
  <IsConseeTypeAgent>true</IsConseeTypeAgent>
  <IsConseeTypeBroker>true</IsConseeTypeBroker>
  <IsShipperTypeAddress>true</IsShipperTypeAddress>
  <IsShipperTypeAgent>true</IsShipperTypeAgent>
  <IsShipperTypeCustomer>true</IsShipperTypeCustomer>
  <LockCost>true</LockCost>
  <ManagingOfficeID>3</ManagingOfficeID>
  <ManifestDate>2024-09-19T09:08:26.26755+00:00</ManifestDate>
  <ManifestGUID>sample string 2</ManifestGUID>
  <ManifestType>sample string 6</ManifestType>
  <PrebookContents>sample string 74</PrebookContents>
  <RecoverActualDistance>1</RecoverActualDistance>
  <RecoverActualDistanceUOM>sample string 20</RecoverActualDistanceUOM>
  <RecoverActualWaitingTime>1</RecoverActualWaitingTime>
  <RecoverActualWeight>1</RecoverActualWeight>
  <RecoverActualWeightUOM>sample string 21</RecoverActualWeightUOM>
  <RecoverAlertHow>sample string 18</RecoverAlertHow>
  <RecoverAlertVia>sample string 17</RecoverAlertVia>
  <RecoverCourierID>1</RecoverCourierID>
  <RecoverCourierServiceID>1</RecoverCourierServiceID>
  <RecoverDateTime>2024-09-19T09:08:26.2833837+00:00</RecoverDateTime>
  <RecoverInstructions>sample string 65</RecoverInstructions>
  <RecoverOfficeID>1</RecoverOfficeID>
  <RecoverSpokeWith>sample string 19</RecoverSpokeWith>
  <RecoverType>sample string 24</RecoverType>
  <SCICode>sample string 67</SCICode>
  <ShipperAccountNumber>sample string 29</ShipperAccountNumber>
  <ShipperAddress>sample string 31</ShipperAddress>
  <ShipperAddress2>sample string 32</ShipperAddress2>
  <ShipperAeoNumber>sample string 77</ShipperAeoNumber>
  <ShipperCode>sample string 28</ShipperCode>
  <ShipperContactID1>sample string 37</ShipperContactID1>
  <ShipperContactID2>sample string 39</ShipperContactID2>
  <ShipperContactName>sample string 41</ShipperContactName>
  <ShipperContactNumber1>sample string 38</ShipperContactNumber1>
  <ShipperContactNumber2>sample string 40</ShipperContactNumber2>
  <ShipperCountryID>sample string 36</ShipperCountryID>
  <ShipperMawbIdentifier>sample string 75</ShipperMawbIdentifier>
  <ShipperName>sample string 30</ShipperName>
  <ShipperPlace>sample string 33</ShipperPlace>
  <ShipperPostalCode>sample string 35</ShipperPostalCode>
  <ShipperStateProv>sample string 34</ShipperStateProv>
  <SpotQuoteReference>sample string 66</SpotQuoteReference>
  <Status>sample string 4</Status>
  <TotalWeight>10</TotalWeight>
  <WaybillNumber>sample string 7</WaybillNumber>
  <WeightUOM>sample string 11</WeightUOM>
  <auth>sample string 1</auth>
</ManifestCreateParms>

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>