GET api/BookingSync?TPID={TPID}&TPID_ItemUniqueSystemReference={TPID_ItemUniqueSystemReference}

Request Information

URI Parameters

Name	Description	Type	Additional information
TPID		string	Required
TPID_ItemUniqueSystemReference		string	Required

Body Parameters

None.

Response Information

Resource Description

TBookingDocument

Name	Description	Type	Additional information
TPID	Agreed Cutomer Identification Code also referred as "Trading Partner ID"	string	Required Max length: 8
ShipmentNumber	Unique Booking Reference provided by Grimaldi/ACL (ie S3-12345678) If empty, the Bookign Document is assumed to be new booking request; If filled with a vaild reference previously received from Grimaldi ERP, is considered to be an update of existing booking;	string	Max length: 15
TimeStamp	Timestamp (e.g. 20210927081512789) This timestamp must be stored in the customer's system. It identifies when the shipment has been updated for the last time. It is used to understand if the client is updating the shipment based on the latest version available.	string	Max length: 17
LastAPIResultSuccess	READ ONLY - Latest result of data exchanged. 100 means "Success" anythings else would mean the last exchange failed	string	None.
POL_ETS	READ ONLY - Estimated Time of Sailing/Departure from Port of Load	date	None.
POD_ETA	READ ONLY - Estimated Time of Arrival at Port of Discharge	date	None.
BLPrinted	READ ONLY - Bill of Lading document has been printed	boolean	None.
BLInvoiced	READ ONLY - Bill of Lading has been invoices	boolean	None.
Header	Placeholder for header Booking Elements like Customer/Voyage/POL/POD:	TBookingHeader	None.
Item	Vehicle or Container details	Collection of TBookingItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Party": [
      {
        "Role": 0,
        "Name": "sample string 1",
        "NameEx": "sample string 2",
        "AddressLine1": "sample string 3",
        "AddressLine2": "sample string 4",
        "City": "sample string 5",
        "PostalCode": "sample string 6",
        "CountryCode": "sample string 7"
      },
      {
        "Role": 0,
        "Name": "sample string 1",
        "NameEx": "sample string 2",
        "AddressLine1": "sample string 3",
        "AddressLine2": "sample string 4",
        "City": "sample string 5",
        "PostalCode": "sample string 6",
        "CountryCode": "sample string 7"
      }
    ],
    "NoOriginalBL": 1,
    "NoCopyBL": 1,
    "Paymode": "sample string 1",
    "CustomerBookingReference": "sample string 1",
    "NVO": true,
    "Voyage": "sample string 3",
    "VoyageDeparture": "2025-05-08T21:47:45.791512+02:00",
    "POL": "sample string 4",
    "POD": "sample string 5",
    "CustomsCode": "sample string 6",
    "FactoryOfProduction": "sample string 7",
    "DestinationMarket": "sample string 8",
    "TariffMatchingCode": "sample string 9",
    "InTransitToCountry": "sample string 10"
  },
  "Item": [
    {
      "TPID_ItemUniqueSystemReference": "sample string 1",
      "VehicleType": "sample string 3",
      "VehicleRegistrationNo": "sample string 4",
      "TruckOfTrailerRegistrationNo": "sample string 5",
      "LengthUOM": "sample string 6",
      "Length": 7.1,
      "HeightUOM": "sample string 8",
      "Height": 9.1,
      "WidthUOM": "sample string 10",
      "Width": 11.1,
      "WeightUOM": "sample string 12",
      "Weight": 13.1,
      "MeasuredLength": 1.1,
      "MeasuredHeight": 1.1,
      "MeasuredWidth": 1.1,
      "MeasuredWeight": 1.1,
      "MeasuredDate": "2025-05-08T21:47:45.791512+02:00",
      "IsHazardous": true,
      "ReeferTemp": 1,
      "DriverNames": "sample string 15",
      "Remarks": "sample string 16",
      "VRID": "sample string 17",
      "VIN": "sample string 18",
      "MakeModelCode": "sample string 19",
      "Priority": "sample string 20",
      "ModelYear": 1,
      "LoadMode": "sample string 21",
      "WaiverNumber": "sample string 22",
      "CTN": "sample string 23",
      "CustomsDocumentType": "sample string 24",
      "CustomsDocumentNumber": "sample string 25",
      "CustomsDocumentDate": "2025-05-08T21:47:45.791512+02:00",
      "CustomsDocumentClearanceDate": "2025-05-08T21:47:45.791512+02:00",
      "CustomsCleared": true,
      "Tracked": true,
      "MainUnitID": "sample string 28",
      "CommodityCode": "sample string 29",
      "PackageType": "sample string 30",
      "BLIssuanceOption": "sample string 31",
      "ShipperEmail": "sample string 32",
      "ClearingAgent": "sample string 33",
      "AdditionalShipperEmail": "sample string 34",
      "DescriptionOfGoods": [
        {
          "TextRow": "sample string 1"
        },
        {
          "TextRow": "sample string 1"
        }
      ],
      "Tracking": [
        {
          "Event": 0,
          "DateTime": "2025-05-08T21:47:45.791512+02:00"
        },
        {
          "Event": 0,
          "DateTime": "2025-05-08T21:47:45.791512+02:00"
        }
      ],
      "LastAPIResultCode": "sample string 35",
      "LastAPIResultMessage": "sample string 36",
      "RoRoUnitStatus": 0
    },
    {
      "TPID_ItemUniqueSystemReference": "sample string 1",
      "VehicleType": "sample string 3",
      "VehicleRegistrationNo": "sample string 4",
      "TruckOfTrailerRegistrationNo": "sample string 5",
      "LengthUOM": "sample string 6",
      "Length": 7.1,
      "HeightUOM": "sample string 8",
      "Height": 9.1,
      "WidthUOM": "sample string 10",
      "Width": 11.1,
      "WeightUOM": "sample string 12",
      "Weight": 13.1,
      "MeasuredLength": 1.1,
      "MeasuredHeight": 1.1,
      "MeasuredWidth": 1.1,
      "MeasuredWeight": 1.1,
      "MeasuredDate": "2025-05-08T21:47:45.791512+02:00",
      "IsHazardous": true,
      "ReeferTemp": 1,
      "DriverNames": "sample string 15",
      "Remarks": "sample string 16",
      "VRID": "sample string 17",
      "VIN": "sample string 18",
      "MakeModelCode": "sample string 19",
      "Priority": "sample string 20",
      "ModelYear": 1,
      "LoadMode": "sample string 21",
      "WaiverNumber": "sample string 22",
      "CTN": "sample string 23",
      "CustomsDocumentType": "sample string 24",
      "CustomsDocumentNumber": "sample string 25",
      "CustomsDocumentDate": "2025-05-08T21:47:45.791512+02:00",
      "CustomsDocumentClearanceDate": "2025-05-08T21:47:45.791512+02:00",
      "CustomsCleared": true,
      "Tracked": true,
      "MainUnitID": "sample string 28",
      "CommodityCode": "sample string 29",
      "PackageType": "sample string 30",
      "BLIssuanceOption": "sample string 31",
      "ShipperEmail": "sample string 32",
      "ClearingAgent": "sample string 33",
      "AdditionalShipperEmail": "sample string 34",
      "DescriptionOfGoods": [
        {
          "TextRow": "sample string 1"
        },
        {
          "TextRow": "sample string 1"
        }
      ],
      "Tracking": [
        {
          "Event": 0,
          "DateTime": "2025-05-08T21:47:45.791512+02:00"
        },
        {
          "Event": 0,
          "DateTime": "2025-05-08T21:47:45.791512+02:00"
        }
      ],
      "LastAPIResultCode": "sample string 35",
      "LastAPIResultMessage": "sample string 36",
      "RoRoUnitStatus": 0
    }
  ],
  "TPID": "sample string 1",
  "ShipmentNumber": "sample string 2",
  "TimeStamp": "sample string 3",
  "LastAPIResultSuccess": "sample string 4",
  "POL_ETS": "2025-05-08T21:47:45.791512+02:00",
  "POD_ETA": "2025-05-08T21:47:45.791512+02:00",
  "BLPrinted": true,
  "BLInvoiced": true
}

application/xml, text/xml

Sample:

<TBookingDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EServiceAPI.Models">
  <BLInvoiced>true</BLInvoiced>
  <BLPrinted>true</BLPrinted>
  <Header>
    <CustomerBookingReference>sample string 1</CustomerBookingReference>
    <CustomsCode>sample string 6</CustomsCode>
    <DestinationMarket>sample string 8</DestinationMarket>
    <FactoryOfProduction>sample string 7</FactoryOfProduction>
    <InTransitToCountry>sample string 10</InTransitToCountry>
    <NVO>true</NVO>
    <NoCopyBL>1</NoCopyBL>
    <NoOriginalBL>1</NoOriginalBL>
    <POD>sample string 5</POD>
    <POL>sample string 4</POL>
    <Party>
      <TBookingParty>
        <AddressLine1>sample string 3</AddressLine1>
        <AddressLine2>sample string 4</AddressLine2>
        <City>sample string 5</City>
        <CountryCode>sample string 7</CountryCode>
        <Name>sample string 1</Name>
        <NameEx>sample string 2</NameEx>
        <PostalCode>sample string 6</PostalCode>
        <Role>Shipper</Role>
      </TBookingParty>
      <TBookingParty>
        <AddressLine1>sample string 3</AddressLine1>
        <AddressLine2>sample string 4</AddressLine2>
        <City>sample string 5</City>
        <CountryCode>sample string 7</CountryCode>
        <Name>sample string 1</Name>
        <NameEx>sample string 2</NameEx>
        <PostalCode>sample string 6</PostalCode>
        <Role>Shipper</Role>
      </TBookingParty>
    </Party>
    <Paymode>sample string 1</Paymode>
    <TariffMatchingCode>sample string 9</TariffMatchingCode>
    <Voyage>sample string 3</Voyage>
    <VoyageDeparture>2025-05-08T21:47:45.791512+02:00</VoyageDeparture>
  </Header>
  <Item>
    <TBookingItem>
      <AdditionalShipperEmail>sample string 34</AdditionalShipperEmail>
      <BLIssuanceOption>sample string 31</BLIssuanceOption>
      <CTN>sample string 23</CTN>
      <ClearingAgent>sample string 33</ClearingAgent>
      <CommodityCode>sample string 29</CommodityCode>
      <CustomsCleared>true</CustomsCleared>
      <CustomsDocumentClearanceDate>2025-05-08T21:47:45.791512+02:00</CustomsDocumentClearanceDate>
      <CustomsDocumentDate>2025-05-08T21:47:45.791512+02:00</CustomsDocumentDate>
      <CustomsDocumentNumber>sample string 25</CustomsDocumentNumber>
      <CustomsDocumentType>sample string 24</CustomsDocumentType>
      <DescriptionOfGoods>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
      </DescriptionOfGoods>
      <DriverNames>sample string 15</DriverNames>
      <Height>9.1</Height>
      <HeightUOM>sample string 8</HeightUOM>
      <IsHazardous>true</IsHazardous>
      <LastAPIResultCode>sample string 35</LastAPIResultCode>
      <LastAPIResultMessage>sample string 36</LastAPIResultMessage>
      <Length>7.1</Length>
      <LengthUOM>sample string 6</LengthUOM>
      <LoadMode>sample string 21</LoadMode>
      <MainUnitID>sample string 28</MainUnitID>
      <MakeModelCode>sample string 19</MakeModelCode>
      <MeasuredDate>2025-05-08T21:47:45.791512+02:00</MeasuredDate>
      <MeasuredHeight>1.1</MeasuredHeight>
      <MeasuredLength>1.1</MeasuredLength>
      <MeasuredWeight>1.1</MeasuredWeight>
      <MeasuredWidth>1.1</MeasuredWidth>
      <ModelYear>1</ModelYear>
      <PackageType>sample string 30</PackageType>
      <Priority>sample string 20</Priority>
      <ReeferTemp>1</ReeferTemp>
      <Remarks>sample string 16</Remarks>
      <RoRoUnitStatus>Booked</RoRoUnitStatus>
      <ShipperEmail>sample string 32</ShipperEmail>
      <TPID_ItemUniqueSystemReference>sample string 1</TPID_ItemUniqueSystemReference>
      <Tracked>true</Tracked>
      <Tracking>
        <TBookingItemEvent>
          <DateTime>2025-05-08T21:47:45.791512+02:00</DateTime>
          <Event>Booked</Event>
        </TBookingItemEvent>
        <TBookingItemEvent>
          <DateTime>2025-05-08T21:47:45.791512+02:00</DateTime>
          <Event>Booked</Event>
        </TBookingItemEvent>
      </Tracking>
      <TruckOfTrailerRegistrationNo>sample string 5</TruckOfTrailerRegistrationNo>
      <VIN>sample string 18</VIN>
      <VRID>sample string 17</VRID>
      <VehicleRegistrationNo>sample string 4</VehicleRegistrationNo>
      <VehicleType>sample string 3</VehicleType>
      <WaiverNumber>sample string 22</WaiverNumber>
      <Weight>13.1</Weight>
      <WeightUOM>sample string 12</WeightUOM>
      <Width>11.1</Width>
      <WidthUOM>sample string 10</WidthUOM>
    </TBookingItem>
    <TBookingItem>
      <AdditionalShipperEmail>sample string 34</AdditionalShipperEmail>
      <BLIssuanceOption>sample string 31</BLIssuanceOption>
      <CTN>sample string 23</CTN>
      <ClearingAgent>sample string 33</ClearingAgent>
      <CommodityCode>sample string 29</CommodityCode>
      <CustomsCleared>true</CustomsCleared>
      <CustomsDocumentClearanceDate>2025-05-08T21:47:45.791512+02:00</CustomsDocumentClearanceDate>
      <CustomsDocumentDate>2025-05-08T21:47:45.791512+02:00</CustomsDocumentDate>
      <CustomsDocumentNumber>sample string 25</CustomsDocumentNumber>
      <CustomsDocumentType>sample string 24</CustomsDocumentType>
      <DescriptionOfGoods>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
      </DescriptionOfGoods>
      <DriverNames>sample string 15</DriverNames>
      <Height>9.1</Height>
      <HeightUOM>sample string 8</HeightUOM>
      <IsHazardous>true</IsHazardous>
      <LastAPIResultCode>sample string 35</LastAPIResultCode>
      <LastAPIResultMessage>sample string 36</LastAPIResultMessage>
      <Length>7.1</Length>
      <LengthUOM>sample string 6</LengthUOM>
      <LoadMode>sample string 21</LoadMode>
      <MainUnitID>sample string 28</MainUnitID>
      <MakeModelCode>sample string 19</MakeModelCode>
      <MeasuredDate>2025-05-08T21:47:45.791512+02:00</MeasuredDate>
      <MeasuredHeight>1.1</MeasuredHeight>
      <MeasuredLength>1.1</MeasuredLength>
      <MeasuredWeight>1.1</MeasuredWeight>
      <MeasuredWidth>1.1</MeasuredWidth>
      <ModelYear>1</ModelYear>
      <PackageType>sample string 30</PackageType>
      <Priority>sample string 20</Priority>
      <ReeferTemp>1</ReeferTemp>
      <Remarks>sample string 16</Remarks>
      <RoRoUnitStatus>Booked</RoRoUnitStatus>
      <ShipperEmail>sample string 32</ShipperEmail>
      <TPID_ItemUniqueSystemReference>sample string 1</TPID_ItemUniqueSystemReference>
      <Tracked>true</Tracked>
      <Tracking>
        <TBookingItemEvent>
          <DateTime>2025-05-08T21:47:45.791512+02:00</DateTime>
          <Event>Booked</Event>
        </TBookingItemEvent>
        <TBookingItemEvent>
          <DateTime>2025-05-08T21:47:45.791512+02:00</DateTime>
          <Event>Booked</Event>
        </TBookingItemEvent>
      </Tracking>
      <TruckOfTrailerRegistrationNo>sample string 5</TruckOfTrailerRegistrationNo>
      <VIN>sample string 18</VIN>
      <VRID>sample string 17</VRID>
      <VehicleRegistrationNo>sample string 4</VehicleRegistrationNo>
      <VehicleType>sample string 3</VehicleType>
      <WaiverNumber>sample string 22</WaiverNumber>
      <Weight>13.1</Weight>
      <WeightUOM>sample string 12</WeightUOM>
      <Width>11.1</Width>
      <WidthUOM>sample string 10</WidthUOM>
    </TBookingItem>
  </Item>
  <LastAPIResultSuccess>sample string 4</LastAPIResultSuccess>
  <POD_ETA>2025-05-08T21:47:45.791512+02:00</POD_ETA>
  <POL_ETS>2025-05-08T21:47:45.791512+02:00</POL_ETS>
  <ShipmentNumber>sample string 2</ShipmentNumber>
  <TPID>sample string 1</TPID>
  <TimeStamp>sample string 3</TimeStamp>
</TBookingDocument>