GET api/ManifestShipment/InitializeFromShipment/{auth}/{ShipmentGUID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

string

Required

ShipmentGUID

string

Required

Body Parameters

None.

Response Information

Resource Description

InitializeFromShipmentResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

string

None.

Manifest

ManifestItem

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Manifest": {
    "ManifestGUID": "sample string 1",
    "ManifestNumber": 2,
    "CompanyID": 3,
    "Status": "sample string 4",
    "ManagingOfficeID": 5,
    "DispatchOfficeID": 1,
    "ManifestDate": "2024-09-19T09:15:05.9880322+00:00",
    "ManifestType": "sample string 7",
    "ManifestTypeName": "sample string 8",
    "CarrierID": 1,
    "CarrierName": "sample string 9",
    "CarrierIataID": "sample string 10",
    "CarrierKey": "sample string 11",
    "CarrierServiceID": 1,
    "CarrierServiceName": "sample string 12",
    "CarrierAccountID": 1,
    "CarrierAccountNumber": "sample string 13",
    "WaybillNumber": "sample string 14",
    "ExportCountryID": "sample string 15",
    "ExportCountryName": "sample string 16",
    "ImportCountryID": "sample string 17",
    "ImportCountryName": "sample string 18",
    "DepartHubID": "sample string 19",
    "ArriveHubID": "sample string 20",
    "TotalWeight": 21.0,
    "WeightUOM": "sample string 22",
    "WeightDescription": "sample string 23",
    "ConsignToLine1": "sample string 24",
    "ConsignToLine2": "sample string 25",
    "ConsignToLine3": "sample string 26",
    "DropDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DropDateTimeUTC": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverDateTimeUTC": "2024-09-19T09:15:05.9880322+00:00",
    "Note": "sample string 27",
    "InsertUserID": 28,
    "InsertDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "ManifestEditLink": "sample string 30",
    "DepartIataIDAndRouteNumber": "sample string 31",
    "CostTotal": 1.0,
    "UsePickupCourier": true,
    "DropOfficeID": 1,
    "DropOfficeAlertDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DropOfficeConfirmDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DropOfficeAlertUserGUID": "sample string 33",
    "DropOfficeAlertUserName": "sample string 34",
    "DropInstructions": "sample string 35",
    "DropCourierID": 1,
    "DropCourierKey": "sample string 36",
    "DropCourierName": "sample string 37",
    "DropCourierPhoneNumber": "sample string 38",
    "DropCourierServiceID": 1,
    "DropCourierServiceName": "sample string 39",
    "DropAlertStatus": 40,
    "DropAlertVia": "sample string 41",
    "DropAlertHow": "sample string 42",
    "DropAlertUserID": 1,
    "DropAlertUserName": "sample string 43",
    "DropSpokeWith": "sample string 44",
    "DropSentDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DropAcceptedDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DropActualAttemptCount": 1,
    "DropActualWaitingTime": 1,
    "DropActualDistance": 1,
    "DropActualDistanceUOM": "sample string 45",
    "DropActualWeight": 1.0,
    "DropActualWeightUOM": "sample string 46",
    "UseDeliveryCourier": true,
    "RecoverType": "sample string 48",
    "RecoverOfficeID": 1,
    "RecoverOfficeAlertDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverOfficeConfirmDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverOfficeAlertUserGUID": "sample string 49",
    "RecoverOfficeAlertUserName": "sample string 50",
    "RecoverInstructions": "sample string 51",
    "RecoverCourierID": 1,
    "RecoverCourierKey": "sample string 52",
    "RecoverCourierName": "sample string 53",
    "RecoverCourierPhoneNumber": "sample string 54",
    "RecoverCourierServiceID": 1,
    "RecoverCourierServiceName": "sample string 55",
    "RecoverAlertStatus": 56,
    "RecoverAlertVia": "sample string 57",
    "RecoverAlertHow": "sample string 58",
    "RecoverAlertUserID": 1,
    "RecoverAlertUserName": "sample string 59",
    "RecoverSpokeWith": "sample string 60",
    "RecoverSentDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverAcceptedDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "RecoverActualAttemptCount": 1,
    "RecoverActualWaitingTime": 1,
    "RecoverActualDistance": 1,
    "RecoverActualDistanceUOM": "sample string 61",
    "RecoverActualWeight": 1.0,
    "RecoverActualWeightUOM": "sample string 62",
    "CloseDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "CloseUserGUID": "sample string 63",
    "DeletedDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "DeletedUserGUID": "sample string 64",
    "ConfirmedDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "ConfirmedUserGUID": "sample string 65",
    "LastUpdateDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "UpdateUserID": 1,
    "Weight1": 1.0,
    "BagGUID1": "sample string 66",
    "Weight2": 1.0,
    "BagGUID2": "sample string 67",
    "Weight3": 1.0,
    "BagGUID3": "sample string 68",
    "Weight4": 1.0,
    "BagGUID4": "sample string 69",
    "Weight5": 1.0,
    "BagGUID5": "sample string 70",
    "LockCost": true,
    "StatusName": "sample string 72",
    "ManifestDescription": "sample string 73",
    "CreatedOn": "sample string 74",
    "ShipperMawbShortLine": "sample string 75",
    "ShipperAccountNumber": "sample string 76",
    "ShipperName": "sample string 77",
    "ShipperAddress": "sample string 78",
    "ShipperAddress2": "sample string 79",
    "ShipperPlace": "sample string 80",
    "ShipperStateProv": "sample string 81",
    "ShipperPostalCode": "sample string 82",
    "ShipperCountryID": "sample string 83",
    "ShipperCountryName": "sample string 84",
    "ShipperContactID1": "sample string 85",
    "ShipperContactNumber1": "sample string 86",
    "ShipperContactID2": "sample string 87",
    "ShipperContactNumber2": "sample string 88",
    "ShipperCode": "sample string 89",
    "ShipperType": "sample string 90",
    "IsShipperTypeAgent": true,
    "IsShipperTypeCustomer": true,
    "IsShipperTypeAddress": true,
    "ConseeMawbShortLine": "sample string 94",
    "ConseeAccountNumber": "sample string 95",
    "ConseeName": "sample string 96",
    "ConseeAddress": "sample string 97",
    "ConseeAddress2": "sample string 98",
    "ConseePlace": "sample string 99",
    "ConseeStateProv": "sample string 100",
    "ConseePostalCode": "sample string 101",
    "ConseeCountryID": "sample string 102",
    "ConseeCountryName": "sample string 103",
    "ConseeContactID1": "sample string 104",
    "ConseeContactNumber1": "sample string 105",
    "ConseeContactID2": "sample string 106",
    "ConseeContactNumber2": "sample string 107",
    "ConseeCode": "sample string 108",
    "ConseeType": "sample string 109",
    "IsConseeTypeAgent": true,
    "IsConseeTypeBroker": true,
    "IsConseeTypeAddress": true,
    "AgentAccountNumber": "sample string 113",
    "AgentIATACargoAgentNumber": "sample string 114",
    "AgentCASSAddress": "sample string 115",
    "AgentName": "sample string 116",
    "AgentPlace": "sample string 117",
    "SpotQuoteReference": "sample string 118",
    "DimFactor_Dom_In": 1,
    "DimFactor_Dom_Cm": 1,
    "DimFactor_Intl_In": 1,
    "DimFactor_Intl_Cm": 1,
    "CutoffDateTime": "2024-09-19T09:15:05.9880322+00:00",
    "SCICode": "sample string 119",
    "CustomsStatus": "sample string 120",
    "CustomsBrokerGUID": "sample string 121",
    "CustomsBrokerName": "sample string 122",
    "CustomsExceptionGUID": "sample string 123",
    "CustomsExceptionName": "sample string 124",
    "AmsSiteID": "sample string 125",
    "AmsWaybillOriginator": "sample string 126",
    "IgnoreRouting": true,
    "PrebookContents": "sample string 128",
    "Routing": "sample string 129",
    "PickupPostalCode": "sample string 130",
    "DeliveryPostalCode": "sample string 131",
    "DropOfficeConfirmUserGUID": "sample string 132",
    "DropOfficeConfirmUserName": "sample string 133",
    "DropOfficeNote": "sample string 134",
    "RecoverOfficeConfirmUserGUID": "sample string 135",
    "RecoverOfficeConfirmUserName": "sample string 136",
    "RecoverOfficeNote": "sample string 137",
    "ShipperMawbIdentifier": "sample string 138",
    "ConseeMawbIdentifier": "sample string 139",
    "ShipperContactName": "sample string 140",
    "ConseeContactName": "sample string 141",
    "GermanyLBAUserID": 1,
    "GermanyLBAUserName": "sample string 142",
    "GermanyLBADateTime": "2024-09-19T09:15:05.9880322+00:00",
    "IsGermanyLBA": true,
    "GermanyLBAInfo": "sample string 144",
    "ShipperAeoNumber": "sample string 145",
    "ConseeAeoNumber": "sample string 146"
  }
}

application/xml, text/xml

Sample:
<InitializeFromShipmentResp 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>
  <Manifest>
    <AgentAccountNumber>sample string 113</AgentAccountNumber>
    <AgentCASSAddress>sample string 115</AgentCASSAddress>
    <AgentIATACargoAgentNumber>sample string 114</AgentIATACargoAgentNumber>
    <AgentName>sample string 116</AgentName>
    <AgentPlace>sample string 117</AgentPlace>
    <AmsSiteID>sample string 125</AmsSiteID>
    <AmsWaybillOriginator>sample string 126</AmsWaybillOriginator>
    <ArriveHubID>sample string 20</ArriveHubID>
    <BagGUID1>sample string 66</BagGUID1>
    <BagGUID2>sample string 67</BagGUID2>
    <BagGUID3>sample string 68</BagGUID3>
    <BagGUID4>sample string 69</BagGUID4>
    <BagGUID5>sample string 70</BagGUID5>
    <CarrierAccountID>1</CarrierAccountID>
    <CarrierAccountNumber>sample string 13</CarrierAccountNumber>
    <CarrierID>1</CarrierID>
    <CarrierIataID>sample string 10</CarrierIataID>
    <CarrierKey>sample string 11</CarrierKey>
    <CarrierName>sample string 9</CarrierName>
    <CarrierServiceID>1</CarrierServiceID>
    <CarrierServiceName>sample string 12</CarrierServiceName>
    <CloseDateTime>2024-09-19T09:15:05.9880322+00:00</CloseDateTime>
    <CloseUserGUID>sample string 63</CloseUserGUID>
    <CompanyID>3</CompanyID>
    <ConfirmedDateTime>2024-09-19T09:15:05.9880322+00:00</ConfirmedDateTime>
    <ConfirmedUserGUID>sample string 65</ConfirmedUserGUID>
    <ConseeAccountNumber>sample string 95</ConseeAccountNumber>
    <ConseeAddress>sample string 97</ConseeAddress>
    <ConseeAddress2>sample string 98</ConseeAddress2>
    <ConseeAeoNumber>sample string 146</ConseeAeoNumber>
    <ConseeCode>sample string 108</ConseeCode>
    <ConseeContactID1>sample string 104</ConseeContactID1>
    <ConseeContactID2>sample string 106</ConseeContactID2>
    <ConseeContactName>sample string 141</ConseeContactName>
    <ConseeContactNumber1>sample string 105</ConseeContactNumber1>
    <ConseeContactNumber2>sample string 107</ConseeContactNumber2>
    <ConseeCountryID>sample string 102</ConseeCountryID>
    <ConseeCountryName>sample string 103</ConseeCountryName>
    <ConseeMawbIdentifier>sample string 139</ConseeMawbIdentifier>
    <ConseeMawbShortLine>sample string 94</ConseeMawbShortLine>
    <ConseeName>sample string 96</ConseeName>
    <ConseePlace>sample string 99</ConseePlace>
    <ConseePostalCode>sample string 101</ConseePostalCode>
    <ConseeStateProv>sample string 100</ConseeStateProv>
    <ConseeType>sample string 109</ConseeType>
    <ConsignToLine1>sample string 24</ConsignToLine1>
    <ConsignToLine2>sample string 25</ConsignToLine2>
    <ConsignToLine3>sample string 26</ConsignToLine3>
    <CostTotal>1</CostTotal>
    <CreatedOn>sample string 74</CreatedOn>
    <CustomsBrokerGUID>sample string 121</CustomsBrokerGUID>
    <CustomsBrokerName>sample string 122</CustomsBrokerName>
    <CustomsExceptionGUID>sample string 123</CustomsExceptionGUID>
    <CustomsExceptionName>sample string 124</CustomsExceptionName>
    <CustomsStatus>sample string 120</CustomsStatus>
    <CutoffDateTime>2024-09-19T09:15:05.9880322+00:00</CutoffDateTime>
    <DeletedDateTime>2024-09-19T09:15:05.9880322+00:00</DeletedDateTime>
    <DeletedUserGUID>sample string 64</DeletedUserGUID>
    <DeliveryPostalCode>sample string 131</DeliveryPostalCode>
    <DepartHubID>sample string 19</DepartHubID>
    <DepartIataIDAndRouteNumber>sample string 31</DepartIataIDAndRouteNumber>
    <DimFactor_Dom_Cm>1</DimFactor_Dom_Cm>
    <DimFactor_Dom_In>1</DimFactor_Dom_In>
    <DimFactor_Intl_Cm>1</DimFactor_Intl_Cm>
    <DimFactor_Intl_In>1</DimFactor_Intl_In>
    <DispatchOfficeID>1</DispatchOfficeID>
    <DropAcceptedDateTime>2024-09-19T09:15:05.9880322+00:00</DropAcceptedDateTime>
    <DropActualAttemptCount>1</DropActualAttemptCount>
    <DropActualDistance>1</DropActualDistance>
    <DropActualDistanceUOM>sample string 45</DropActualDistanceUOM>
    <DropActualWaitingTime>1</DropActualWaitingTime>
    <DropActualWeight>1</DropActualWeight>
    <DropActualWeightUOM>sample string 46</DropActualWeightUOM>
    <DropAlertHow>sample string 42</DropAlertHow>
    <DropAlertStatus>40</DropAlertStatus>
    <DropAlertUserID>1</DropAlertUserID>
    <DropAlertUserName>sample string 43</DropAlertUserName>
    <DropAlertVia>sample string 41</DropAlertVia>
    <DropCourierID>1</DropCourierID>
    <DropCourierKey>sample string 36</DropCourierKey>
    <DropCourierName>sample string 37</DropCourierName>
    <DropCourierPhoneNumber>sample string 38</DropCourierPhoneNumber>
    <DropCourierServiceID>1</DropCourierServiceID>
    <DropCourierServiceName>sample string 39</DropCourierServiceName>
    <DropDateTime>2024-09-19T09:15:05.9880322+00:00</DropDateTime>
    <DropDateTimeUTC>2024-09-19T09:15:05.9880322+00:00</DropDateTimeUTC>
    <DropInstructions>sample string 35</DropInstructions>
    <DropOfficeAlertDateTime>2024-09-19T09:15:05.9880322+00:00</DropOfficeAlertDateTime>
    <DropOfficeAlertUserGUID>sample string 33</DropOfficeAlertUserGUID>
    <DropOfficeAlertUserName>sample string 34</DropOfficeAlertUserName>
    <DropOfficeConfirmDateTime>2024-09-19T09:15:05.9880322+00:00</DropOfficeConfirmDateTime>
    <DropOfficeConfirmUserGUID>sample string 132</DropOfficeConfirmUserGUID>
    <DropOfficeConfirmUserName>sample string 133</DropOfficeConfirmUserName>
    <DropOfficeID>1</DropOfficeID>
    <DropOfficeNote>sample string 134</DropOfficeNote>
    <DropSentDateTime>2024-09-19T09:15:05.9880322+00:00</DropSentDateTime>
    <DropSpokeWith>sample string 44</DropSpokeWith>
    <ExportCountryID>sample string 15</ExportCountryID>
    <ExportCountryName>sample string 16</ExportCountryName>
    <GermanyLBADateTime>2024-09-19T09:15:05.9880322+00:00</GermanyLBADateTime>
    <GermanyLBAInfo>sample string 144</GermanyLBAInfo>
    <GermanyLBAUserID>1</GermanyLBAUserID>
    <GermanyLBAUserName>sample string 142</GermanyLBAUserName>
    <IgnoreRouting>true</IgnoreRouting>
    <ImportCountryID>sample string 17</ImportCountryID>
    <ImportCountryName>sample string 18</ImportCountryName>
    <InsertDateTime>2024-09-19T09:15:05.9880322+00:00</InsertDateTime>
    <InsertUserID>28</InsertUserID>
    <IsConseeTypeAddress>true</IsConseeTypeAddress>
    <IsConseeTypeAgent>true</IsConseeTypeAgent>
    <IsConseeTypeBroker>true</IsConseeTypeBroker>
    <IsGermanyLBA>true</IsGermanyLBA>
    <IsShipperTypeAddress>true</IsShipperTypeAddress>
    <IsShipperTypeAgent>true</IsShipperTypeAgent>
    <IsShipperTypeCustomer>true</IsShipperTypeCustomer>
    <LastUpdateDateTime>2024-09-19T09:15:05.9880322+00:00</LastUpdateDateTime>
    <LockCost>true</LockCost>
    <ManagingOfficeID>5</ManagingOfficeID>
    <ManifestDate>2024-09-19T09:15:05.9880322+00:00</ManifestDate>
    <ManifestDescription>sample string 73</ManifestDescription>
    <ManifestEditLink>sample string 30</ManifestEditLink>
    <ManifestGUID>sample string 1</ManifestGUID>
    <ManifestNumber>2</ManifestNumber>
    <ManifestType>sample string 7</ManifestType>
    <ManifestTypeName>sample string 8</ManifestTypeName>
    <Note>sample string 27</Note>
    <PickupPostalCode>sample string 130</PickupPostalCode>
    <PrebookContents>sample string 128</PrebookContents>
    <RecoverAcceptedDateTime>2024-09-19T09:15:05.9880322+00:00</RecoverAcceptedDateTime>
    <RecoverActualAttemptCount>1</RecoverActualAttemptCount>
    <RecoverActualDistance>1</RecoverActualDistance>
    <RecoverActualDistanceUOM>sample string 61</RecoverActualDistanceUOM>
    <RecoverActualWaitingTime>1</RecoverActualWaitingTime>
    <RecoverActualWeight>1</RecoverActualWeight>
    <RecoverActualWeightUOM>sample string 62</RecoverActualWeightUOM>
    <RecoverAlertHow>sample string 58</RecoverAlertHow>
    <RecoverAlertStatus>56</RecoverAlertStatus>
    <RecoverAlertUserID>1</RecoverAlertUserID>
    <RecoverAlertUserName>sample string 59</RecoverAlertUserName>
    <RecoverAlertVia>sample string 57</RecoverAlertVia>
    <RecoverCourierID>1</RecoverCourierID>
    <RecoverCourierKey>sample string 52</RecoverCourierKey>
    <RecoverCourierName>sample string 53</RecoverCourierName>
    <RecoverCourierPhoneNumber>sample string 54</RecoverCourierPhoneNumber>
    <RecoverCourierServiceID>1</RecoverCourierServiceID>
    <RecoverCourierServiceName>sample string 55</RecoverCourierServiceName>
    <RecoverDateTime>2024-09-19T09:15:05.9880322+00:00</RecoverDateTime>
    <RecoverDateTimeUTC>2024-09-19T09:15:05.9880322+00:00</RecoverDateTimeUTC>
    <RecoverInstructions>sample string 51</RecoverInstructions>
    <RecoverOfficeAlertDateTime>2024-09-19T09:15:05.9880322+00:00</RecoverOfficeAlertDateTime>
    <RecoverOfficeAlertUserGUID>sample string 49</RecoverOfficeAlertUserGUID>
    <RecoverOfficeAlertUserName>sample string 50</RecoverOfficeAlertUserName>
    <RecoverOfficeConfirmDateTime>2024-09-19T09:15:05.9880322+00:00</RecoverOfficeConfirmDateTime>
    <RecoverOfficeConfirmUserGUID>sample string 135</RecoverOfficeConfirmUserGUID>
    <RecoverOfficeConfirmUserName>sample string 136</RecoverOfficeConfirmUserName>
    <RecoverOfficeID>1</RecoverOfficeID>
    <RecoverOfficeNote>sample string 137</RecoverOfficeNote>
    <RecoverSentDateTime>2024-09-19T09:15:05.9880322+00:00</RecoverSentDateTime>
    <RecoverSpokeWith>sample string 60</RecoverSpokeWith>
    <RecoverType>sample string 48</RecoverType>
    <Routing>sample string 129</Routing>
    <SCICode>sample string 119</SCICode>
    <ShipperAccountNumber>sample string 76</ShipperAccountNumber>
    <ShipperAddress>sample string 78</ShipperAddress>
    <ShipperAddress2>sample string 79</ShipperAddress2>
    <ShipperAeoNumber>sample string 145</ShipperAeoNumber>
    <ShipperCode>sample string 89</ShipperCode>
    <ShipperContactID1>sample string 85</ShipperContactID1>
    <ShipperContactID2>sample string 87</ShipperContactID2>
    <ShipperContactName>sample string 140</ShipperContactName>
    <ShipperContactNumber1>sample string 86</ShipperContactNumber1>
    <ShipperContactNumber2>sample string 88</ShipperContactNumber2>
    <ShipperCountryID>sample string 83</ShipperCountryID>
    <ShipperCountryName>sample string 84</ShipperCountryName>
    <ShipperMawbIdentifier>sample string 138</ShipperMawbIdentifier>
    <ShipperMawbShortLine>sample string 75</ShipperMawbShortLine>
    <ShipperName>sample string 77</ShipperName>
    <ShipperPlace>sample string 80</ShipperPlace>
    <ShipperPostalCode>sample string 82</ShipperPostalCode>
    <ShipperStateProv>sample string 81</ShipperStateProv>
    <ShipperType>sample string 90</ShipperType>
    <SpotQuoteReference>sample string 118</SpotQuoteReference>
    <Status>sample string 4</Status>
    <StatusName>sample string 72</StatusName>
    <TotalWeight>21</TotalWeight>
    <UpdateUserID>1</UpdateUserID>
    <UseDeliveryCourier>true</UseDeliveryCourier>
    <UsePickupCourier>true</UsePickupCourier>
    <WaybillNumber>sample string 14</WaybillNumber>
    <Weight1>1</Weight1>
    <Weight2>1</Weight2>
    <Weight3>1</Weight3>
    <Weight4>1</Weight4>
    <Weight5>1</Weight5>
    <WeightDescription>sample string 23</WeightDescription>
    <WeightUOM>sample string 22</WeightUOM>
  </Manifest>
</InitializeFromShipmentResp>