GET api/BookingContainer?TPID={TPID}&ShipmentNumber={ShipmentNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
TPID

string

Required

ShipmentNumber

string

Required

Body Parameters

None.

Response Information

Resource Description

TContainerBookingDocument
NameDescriptionTypeAdditional information
TPID

string

Required

Max length: 8

ShipmentNumber

string

Max length: 15

TimeStamp

string

Max length: 17

LastAPIResultSuccess

string

None.

POL_ETS

date

None.

POD_ETA

date

None.

BLPrinted

boolean

None.

BLInvoiced

boolean

None.

Header

TBookingHeader

None.

Item

Collection of TContainerBookingItem

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-09T04:14:43.7699333+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",
      "WaiverNumber": "sample string 3",
      "CTN": "sample string 4",
      "CustomsDocumentType": "sample string 5",
      "CustomsDocumentNumber": "sample string 6",
      "CustomsDocumentDate": "2025-05-09T04:14:43.7699333+02:00",
      "CustomsDocumentClearanceDate": "2025-05-09T04:14:43.7699333+02:00",
      "CustomsCleared": true,
      "CommodityCode": "sample string 8",
      "Volume": 1.0,
      "VolumeUOM": "sample string 9",
      "WeightUOM": "sample string 10",
      "Weight": 11.1,
      "SetTemperature": 1.0,
      "MinTemperature": 1.0,
      "MaxTemperature": 1.0,
      "TemperatureUOM": "sample string 12",
      "ContainerType": "sample string 13",
      "ContainerSize": "sample string 14",
      "ContainerNo": "sample string 15",
      "ShipperOwned": true,
      "Seal1": "sample string 17",
      "Seal2": "sample string 18",
      "Seal3": "sample string 19",
      "Seal4": "sample string 20",
      "PackageType": "sample string 21",
      "PackageQty": 1,
      "VGMMethod": "sample string 22",
      "VGMWeight": 1.0,
      "VGMWeightUOM": "sample string 23",
      "VGMAuthParty": "sample string 24",
      "VGMDate": "2025-05-09T04:14:43.7699333+02:00",
      "ContainerRemarks": "sample string 25",
      "NoVehicles": 26,
      "BLIssuanceOption": "sample string 27",
      "ShipperEmail": "sample string 28",
      "ClearingAgent": "sample string 29",
      "AdditionalShipperEmail": "sample string 30",
      "DescriptionOfGoods": [
        {
          "TextRow": "sample string 1"
        },
        {
          "TextRow": "sample string 1"
        }
      ],
      "SourceTerminal": "sample string 31",
      "DropOffLocation": "sample string 32",
      "Tracking": [
        {
          "Event": 0,
          "DateTime": "2025-05-09T04:14:43.7699333+02:00"
        },
        {
          "Event": 0,
          "DateTime": "2025-05-09T04:14:43.7699333+02:00"
        }
      ],
      "SIConfirmed": true,
      "LastAPIResultCode": "sample string 34",
      "LastAPIResultMessage": "sample string 35"
    },
    {
      "TPID_ItemUniqueSystemReference": "sample string 1",
      "WaiverNumber": "sample string 3",
      "CTN": "sample string 4",
      "CustomsDocumentType": "sample string 5",
      "CustomsDocumentNumber": "sample string 6",
      "CustomsDocumentDate": "2025-05-09T04:14:43.7699333+02:00",
      "CustomsDocumentClearanceDate": "2025-05-09T04:14:43.7699333+02:00",
      "CustomsCleared": true,
      "CommodityCode": "sample string 8",
      "Volume": 1.0,
      "VolumeUOM": "sample string 9",
      "WeightUOM": "sample string 10",
      "Weight": 11.1,
      "SetTemperature": 1.0,
      "MinTemperature": 1.0,
      "MaxTemperature": 1.0,
      "TemperatureUOM": "sample string 12",
      "ContainerType": "sample string 13",
      "ContainerSize": "sample string 14",
      "ContainerNo": "sample string 15",
      "ShipperOwned": true,
      "Seal1": "sample string 17",
      "Seal2": "sample string 18",
      "Seal3": "sample string 19",
      "Seal4": "sample string 20",
      "PackageType": "sample string 21",
      "PackageQty": 1,
      "VGMMethod": "sample string 22",
      "VGMWeight": 1.0,
      "VGMWeightUOM": "sample string 23",
      "VGMAuthParty": "sample string 24",
      "VGMDate": "2025-05-09T04:14:43.7699333+02:00",
      "ContainerRemarks": "sample string 25",
      "NoVehicles": 26,
      "BLIssuanceOption": "sample string 27",
      "ShipperEmail": "sample string 28",
      "ClearingAgent": "sample string 29",
      "AdditionalShipperEmail": "sample string 30",
      "DescriptionOfGoods": [
        {
          "TextRow": "sample string 1"
        },
        {
          "TextRow": "sample string 1"
        }
      ],
      "SourceTerminal": "sample string 31",
      "DropOffLocation": "sample string 32",
      "Tracking": [
        {
          "Event": 0,
          "DateTime": "2025-05-09T04:14:43.7699333+02:00"
        },
        {
          "Event": 0,
          "DateTime": "2025-05-09T04:14:43.7699333+02:00"
        }
      ],
      "SIConfirmed": true,
      "LastAPIResultCode": "sample string 34",
      "LastAPIResultMessage": "sample string 35"
    }
  ],
  "TPID": "sample string 1",
  "ShipmentNumber": "sample string 2",
  "TimeStamp": "sample string 3",
  "LastAPIResultSuccess": "sample string 4",
  "POL_ETS": "2025-05-09T04:14:43.7699333+02:00",
  "POD_ETA": "2025-05-09T04:14:43.7699333+02:00",
  "BLPrinted": true,
  "BLInvoiced": true
}

application/xml, text/xml

Sample:
<TContainerBookingDocument 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-09T04:14:43.7699333+02:00</VoyageDeparture>
  </Header>
  <Item>
    <TContainerBookingItem>
      <AdditionalShipperEmail>sample string 30</AdditionalShipperEmail>
      <BLIssuanceOption>sample string 27</BLIssuanceOption>
      <CTN>sample string 4</CTN>
      <ClearingAgent>sample string 29</ClearingAgent>
      <CommodityCode>sample string 8</CommodityCode>
      <ContainerNo>sample string 15</ContainerNo>
      <ContainerRemarks>sample string 25</ContainerRemarks>
      <ContainerSize>sample string 14</ContainerSize>
      <ContainerType>sample string 13</ContainerType>
      <CustomsCleared>true</CustomsCleared>
      <CustomsDocumentClearanceDate>2025-05-09T04:14:43.7699333+02:00</CustomsDocumentClearanceDate>
      <CustomsDocumentDate>2025-05-09T04:14:43.7699333+02:00</CustomsDocumentDate>
      <CustomsDocumentNumber>sample string 6</CustomsDocumentNumber>
      <CustomsDocumentType>sample string 5</CustomsDocumentType>
      <DescriptionOfGoods>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
      </DescriptionOfGoods>
      <DropOffLocation>sample string 32</DropOffLocation>
      <LastAPIResultCode>sample string 34</LastAPIResultCode>
      <LastAPIResultMessage>sample string 35</LastAPIResultMessage>
      <MaxTemperature>1</MaxTemperature>
      <MinTemperature>1</MinTemperature>
      <NoVehicles>26</NoVehicles>
      <PackageQty>1</PackageQty>
      <PackageType>sample string 21</PackageType>
      <SIConfirmed>true</SIConfirmed>
      <Seal1>sample string 17</Seal1>
      <Seal2>sample string 18</Seal2>
      <Seal3>sample string 19</Seal3>
      <Seal4>sample string 20</Seal4>
      <SetTemperature>1</SetTemperature>
      <ShipperEmail>sample string 28</ShipperEmail>
      <ShipperOwned>true</ShipperOwned>
      <SourceTerminal>sample string 31</SourceTerminal>
      <TPID_ItemUniqueSystemReference>sample string 1</TPID_ItemUniqueSystemReference>
      <TemperatureUOM>sample string 12</TemperatureUOM>
      <Tracking>
        <TContainerBookingItemEvent>
          <DateTime>2025-05-09T04:14:43.7699333+02:00</DateTime>
          <Event>OutOfTerminalEmptyExport</Event>
        </TContainerBookingItemEvent>
        <TContainerBookingItemEvent>
          <DateTime>2025-05-09T04:14:43.7699333+02:00</DateTime>
          <Event>OutOfTerminalEmptyExport</Event>
        </TContainerBookingItemEvent>
      </Tracking>
      <VGMAuthParty>sample string 24</VGMAuthParty>
      <VGMDate>2025-05-09T04:14:43.7699333+02:00</VGMDate>
      <VGMMethod>sample string 22</VGMMethod>
      <VGMWeight>1</VGMWeight>
      <VGMWeightUOM>sample string 23</VGMWeightUOM>
      <Volume>1</Volume>
      <VolumeUOM>sample string 9</VolumeUOM>
      <WaiverNumber>sample string 3</WaiverNumber>
      <Weight>11.1</Weight>
      <WeightUOM>sample string 10</WeightUOM>
    </TContainerBookingItem>
    <TContainerBookingItem>
      <AdditionalShipperEmail>sample string 30</AdditionalShipperEmail>
      <BLIssuanceOption>sample string 27</BLIssuanceOption>
      <CTN>sample string 4</CTN>
      <ClearingAgent>sample string 29</ClearingAgent>
      <CommodityCode>sample string 8</CommodityCode>
      <ContainerNo>sample string 15</ContainerNo>
      <ContainerRemarks>sample string 25</ContainerRemarks>
      <ContainerSize>sample string 14</ContainerSize>
      <ContainerType>sample string 13</ContainerType>
      <CustomsCleared>true</CustomsCleared>
      <CustomsDocumentClearanceDate>2025-05-09T04:14:43.7699333+02:00</CustomsDocumentClearanceDate>
      <CustomsDocumentDate>2025-05-09T04:14:43.7699333+02:00</CustomsDocumentDate>
      <CustomsDocumentNumber>sample string 6</CustomsDocumentNumber>
      <CustomsDocumentType>sample string 5</CustomsDocumentType>
      <DescriptionOfGoods>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
        <TBookingDoG>
          <TextRow>sample string 1</TextRow>
        </TBookingDoG>
      </DescriptionOfGoods>
      <DropOffLocation>sample string 32</DropOffLocation>
      <LastAPIResultCode>sample string 34</LastAPIResultCode>
      <LastAPIResultMessage>sample string 35</LastAPIResultMessage>
      <MaxTemperature>1</MaxTemperature>
      <MinTemperature>1</MinTemperature>
      <NoVehicles>26</NoVehicles>
      <PackageQty>1</PackageQty>
      <PackageType>sample string 21</PackageType>
      <SIConfirmed>true</SIConfirmed>
      <Seal1>sample string 17</Seal1>
      <Seal2>sample string 18</Seal2>
      <Seal3>sample string 19</Seal3>
      <Seal4>sample string 20</Seal4>
      <SetTemperature>1</SetTemperature>
      <ShipperEmail>sample string 28</ShipperEmail>
      <ShipperOwned>true</ShipperOwned>
      <SourceTerminal>sample string 31</SourceTerminal>
      <TPID_ItemUniqueSystemReference>sample string 1</TPID_ItemUniqueSystemReference>
      <TemperatureUOM>sample string 12</TemperatureUOM>
      <Tracking>
        <TContainerBookingItemEvent>
          <DateTime>2025-05-09T04:14:43.7699333+02:00</DateTime>
          <Event>OutOfTerminalEmptyExport</Event>
        </TContainerBookingItemEvent>
        <TContainerBookingItemEvent>
          <DateTime>2025-05-09T04:14:43.7699333+02:00</DateTime>
          <Event>OutOfTerminalEmptyExport</Event>
        </TContainerBookingItemEvent>
      </Tracking>
      <VGMAuthParty>sample string 24</VGMAuthParty>
      <VGMDate>2025-05-09T04:14:43.7699333+02:00</VGMDate>
      <VGMMethod>sample string 22</VGMMethod>
      <VGMWeight>1</VGMWeight>
      <VGMWeightUOM>sample string 23</VGMWeightUOM>
      <Volume>1</Volume>
      <VolumeUOM>sample string 9</VolumeUOM>
      <WaiverNumber>sample string 3</WaiverNumber>
      <Weight>11.1</Weight>
      <WeightUOM>sample string 10</WeightUOM>
    </TContainerBookingItem>
  </Item>
  <LastAPIResultSuccess>sample string 4</LastAPIResultSuccess>
  <POD_ETA>2025-05-09T04:14:43.7699333+02:00</POD_ETA>
  <POL_ETS>2025-05-09T04:14:43.7699333+02:00</POL_ETS>
  <ShipmentNumber>sample string 2</ShipmentNumber>
  <TPID>sample string 1</TPID>
  <TimeStamp>sample string 3</TimeStamp>
</TContainerBookingDocument>