PUT api/BookingSync?TPID={TPID}&ShipmentNumber={ShipmentNumber}&Timestamp={Timestamp}

Request Information

URI Parameters

Name	Type	Additional information
TPID	string	Required
ShipmentNumber	string	Required
Timestamp	string	Required

Body Parameters

TBookingHeader

Name	Description	Type	Additional information
CustomerBookingReference	Cutomer reference number \| Optional Will be saved and sent back to customer exactly as provided	string	Max length: 17
NVO	Only for US Customers	boolean	None.
Voyage	Voyage (ie CRO0121A) \| Mandatory when VoyageDeparture (see below) not provided This is the suggested way to communicate booking requests	string	Max length: 8
VoyageDeparture	VoyageDeparture (ie 2021-05-10 10:30) is the date time the customer wish to depart from Port of Loading. Is required if Voyage (see above) is not provided. Grimaldi system will put the booking on the next departure after DateTime provided plus operational offset, which may differ by port. We recommend to use Voyage instead.	date	None.
POL	Port of Loading UN/LOCODE (ie ITCVV or DEHAM) - Mandatory	string	Required Max length: 5
POD	Port of Discharge UN LOCODE (ie ESBCN or SNDKR)- Mandatory	string	Required Max length: 5
CustomsCode	EU, EX or T1 for ShortSea Shipping EU, EX, TR for DeepSea Shipping	string	Max length: 5
FactoryOfProduction	Extra Rating Factor1	string	Max length: 20
DestinationMarket	Extra Rating Factor2	string	Max length: 20
TariffMatchingCode	Tariff matching code \| Optional	string	Max length: 15
InTransitToCountry	In Transit To Country UNLOCODE \| OPTIONAL	string	Max length: 2
Party	Shipper \| Consignee \| Notify	Collection of TBookingParty	None.
NoOriginalBL	Number of B/L original	integer	None.
NoCopyBL	Number of B/L copies	integer	None.
Paymode	P = Prepaid, C = Collect	string	None.

Request Formats

application/json, text/json

Sample:

{
  "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-08T18:07:16.2557765+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"
}

application/xml, text/xml

Sample:

<TBookingHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EServiceAPI.Models">
  <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-08T18:07:16.2557765+02:00</VoyageDeparture>
</TBookingHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.