LBCT
- Provider Information:
Id |
lbct |
Type |
terminal |
Trace Type |
API |
Credentials |
API Key for every customer |
Limits |
Maximum number of bookings per request is 20 |
Status |
draft |
Doc Status |
draft |
Doc Version |
1 |
- URLs:
Type |
URL |
Environment |
|---|---|---|
Request |
PRD |
|
Request |
DEV/STG |
- Sites:
Name |
Site Id |
Description |
|---|---|---|
name |
ern |
the description |
- Credentials:
Important
Credentials are customer based and they required.
{
"apiKey": "enter api key"
}
Request
Important
Booking information are returned through two separate requests, The first one is to get the booking information, and the other is to return active vessel info associated to the booking which mainly contains the information for getting all the Earliest Loading Date and all the cut offs.
Query Booking Request
Query bookings using the following two requests by adding the API_KEY for the customer in the request url as following.
First request to get the booking information.
GET http://api.lbct.com/<REPLACE_WITH_API_KEY_FOR_CUSTOMER>/API/LBCTCargoSearchWebService/cargo-numbers/{BOOKING-IDS}
Second request to get the active vessel info associated to the booking.
GET http://api.lbct.com/<REPLACE_WITH_API_KEY_FOR_CUSTOMER>/API/LBCTGetActiveVesselVisitsWebService
Note
Booking ids in the request should be separated with commas.
Responses
Query Bookings Response
GET http://api.lbct.com/<REPLACE_WITH_API_KEY_FOR_CUSTOMER>/API/LBCTCargoSearchWebService/cargo-numbers/6353167170,2035438240
Next response is for two bookings 6353167170,2035438240.
{
"id":987737857805568,
"service":"com.lbct.plugins.webservices.LBCTCargoSearchWebService",
"payload":{
"search-results":{
"requested":2,
"found-containers":0,
"found-orders":2,
"not-found":0,
"not-found-numbers":[]
},
"orders":[
{
"sub-type":"BOOK",
"gkey":8042463001,
"number":"6353167170",
"vessel-name":"COSCO DENMARK",
"outbound-voyage-number":"049",
"is-hazardous":false,
"has-reefers":false,
"port-of-discharge":"NGB",
"port-of-load":"LGB",
"creator":"-edi-",
"changed":"2023-03-08T17:43:28.102-08:00",
"changer":"n4billing",
"quantity":2,
"tally-in":2,
"tally-out":2,
"line":"COS",
"freight-kind":"FCL",
"appointments":5,
"vessel-visit-details":{
"inbound-voyage-number":"049",
"outbound-voyage-number":"049",
"outbound-call-number":1,
"vessel-visit-id":"CDNK049",
"vessel-id":"CDNK",
"vessel-name":"COSCO DENMARK",
"lloyds-id":"9516478",
"flex-string-01":"YES",
"flex-string-02":"14",
"flex-string-04":"NO",
"flex-string-05":"100896",
"flex-string-06":"YES",
"flex-string-08":"03/14/2023 08:00",
"flex-date-01":"2023-03-19T18:50:06.550-07:00",
"flex-date-02":"2023-03-15T09:20:00.000-07:00",
"flex-date-03":"2023-03-19T18:27:00.000-07:00",
"flex-date-05":"2023-03-19T20:10:20.723-07:00",
"flex-date-06":"2023-03-03T04:22:02.592-08:00",
"flex-date-07":"2023-03-14T12:00:00.000-07:00",
"flex-date-08":"2023-03-19T18:51:19.027-07:00",
"vessel-class":"CENG",
"eta":"2023-03-15T05:00:07.000-07:00",
"ata":"2023-03-15T09:20:00.000-07:00",
"etd":"2023-03-19T19:00:07.000-07:00",
"atd":"2023-03-19T18:27:00.000-07:00"
},
"order-items":[
{
"gkey":8042463042,
"creator":"-edi-",
"created":"2023-03-01T13:19:06.298-08:00",
"changer":"n4billing",
"changed":"2023-03-07T20:23:06.600-08:00",
"quantity":2,
"tally-in":2,
"tally-out":2,
"is-hazardous":false,
"has-reefers":false,
"temperature-required":false,
"is-oog":false,
"material":"UNKNOWN",
"commodity-description":"NEEMGARD 2X10LITERAGRICULTURAL INSE",
"equipment-type":{
"iso-id":"40GP",
"iso-group":"GP",
"nominal-length":40,
"nominal-height":86,
"description":"40GP - 40'x8'6\" General Purpose",
"general-class":"container"
},
"equipment-type-id":"40GP",
"equipment-height":86,
"equipment-size":40,
"appointments":5
}
]
},
{
"sub-type":"BOOK",
"gkey":8110282012,
"number":"2035438240",
"vessel-name":"OOCL EGYPT",
"outbound-voyage-number":"050",
"is-hazardous":false,
"has-reefers":false,
"port-of-discharge":"NGB",
"port-of-load":"LGB",
"creator":"-edi-",
"changed":"2023-04-06T11:03:27.693-07:00",
"changer":"-edi-",
"quantity":47,
"tally-in":18,
"tally-out":0,
"line":"OOL",
"freight-kind":"FCL",
"appointments":0,
"holds":[
{
"name":"CTF_BOOKING_HOLD",
"type":"CTF_BOOKING_HOLD",
"hold-description":"PierPass Clean Truck Booking Hold",
"entity":"BKG",
"apply-date":"2023-03-14T14:33:37.666-07:00",
"applied-by":"-edi-",
"status":"ACTIVE"
}
],
"vessel-visit-details":{
"inbound-voyage-number":"050",
"outbound-voyage-number":"050",
"outbound-call-number":1,
"vessel-visit-id":"OEGP050",
"vessel-id":"OEGP",
"vessel-name":"OOCL EGYPT",
"lloyds-id":"9622631",
"flex-string-01":"YES",
"flex-string-04":"NO",
"flex-string-08":"04/05/2023 08:00",
"flex-date-06":"2023-03-24T04:21:03.549-07:00",
"flex-date-07":"2023-04-05T16:00:00.000-07:00",
"vessel-class":"OOCM",
"eta":"2023-04-06T05:00:00.000-07:00",
"ata":"2023-04-06T06:40:00.000-07:00",
"etd":"2023-04-10T19:00:00.000-07:00"
},
"order-items":[
{
"gkey":8110282028,
"creator":"-edi-",
"created":"2023-03-14T14:33:37.698-07:00",
"changer":"-edi-",
"changed":"2023-04-06T11:03:26.891-07:00",
"quantity":27,
"tally-in":2,
"tally-out":0,
"is-hazardous":false,
"material":"UNKNOWN",
"commodity-description":"COTTON",
"equipment-type":{
"iso-id":"40GP",
"iso-group":"GP",
"nominal-length":40,
"nominal-height":86,
"description":"40GP - 40'x8'6\" General Purpose",
"general-class":"container"
},
"equipment-type-id":"40GP",
"equipment-height":86,
"equipment-size":40,
"appointments":0
},
{
"gkey":8180278586,
"creator":"-edi-",
"created":"2023-03-28T09:47:38.871-07:00",
"changer":"-edi-",
"changed":"2023-03-29T09:16:28.127-07:00",
"quantity":20,
"tally-in":16,
"tally-out":0,
"is-hazardous":false,
"material":"UNKNOWN",
"commodity-description":"COTTON",
"equipment-type":{
"iso-id":"40HQ",
"iso-group":"GP",
"nominal-length":40,
"nominal-height":96,
"description":"40HQ - 40'x9'6\" General Purpose",
"general-class":"container"
},
"equipment-type-id":"40HQ",
"equipment-height":96,
"equipment-size":40,
"appointments":0
}
]
}
],
"containers":[]
},
"status":"OK",
"type":"CargoSearch",
"date":"2023-04-07T13:12:42.925-07:00",
"node":"PRDAPI002",
"environment":"PRD"
}
Not found Booking Response
GET http://api.lbct.com/<REPLACE_WITH_API_KEY_FOR_CUSTOMER>/API/LBCTCargoSearchWebService/cargo-numbers/61873611
If Booking id 61873611 is returned as not found then API returns the next response.
{
"id":753265458919702,
"service":"com.lbct.plugins.webservices.LBCTCargoSearchWebService",
"payload":{
"search-results":{
"requested":1,
"found-containers":0,
"found-orders":0,
"not-found":1,
"not-found-numbers":["61873611"]
},
"orders":[]
"containers":[]
},
"status":"OK",
"type":"CargoSearch",
"date":"2023-04-06T07:26:59.182-07:00",
"node":"PRDAPI002",
"environment":"PRD"
}
Query Active Vessels Response
GET http://api.lbct.com/<REPLACE_WITH_API_KEY_FOR_CUSTOMER>/API/LBCTGetActiveVesselVisitsWebService
Next response is for all the active vessels.
{
"id":545647868386998,
"service":"LBCTGetActiveVesselVisitsWebService",
"payload":[
{
"facility-id":"E",
"inbound-voyage-number":"094",
"outbound-voyage-number":"094",
"outbound-call-number":1,
"vessel-visit-id":"CKAO094",
"service":"CEN",
"operator-id":"COS",
"dry-cutoff":"2023-04-25T16:00:00.000-07:00",
"haz-cutoff":"2023-04-24T16:00:00.000-07:00",
"reefer-cutoff":"2023-04-26T16:00:00.000-07:00",
"begin-receive":"2023-04-20T07:00:00.000-07:00",
"vessel-id":"CKAO",
"vessel-name":"COSCO KAOHSIUNG",
"lloyds-id":"9355563",
"flex-string-01":"YES",
"flex-string-04":"NO",
"oog-breakbulk-cutoff":"2023-04-24T16:00:00.000-07:00",
"vessel-class":"TAIC",
"eta":"2023-04-21T23:59:04.448-07:00",
"ata":"2023-04-26T08:00:04.448-07:00",
"etd":"2023-04-30T03:00:00.000-07:00",
"atd":"2023-04-30T03:00:00.000-07:00"
},
{
"facility-id": "E",
"inbound-voyage-number": "059",
"outbound-voyage-number": "059",
"outbound-call-number": 1,
"vessel-visit-id": "CITA059",
"service": "PVCS",
"operator-id": "OOL",
"dry-cutoff": "2023-05-02T16:00:00.000-07:00",
"haz-cutoff": "2023-05-01T16:00:00.000-07:00",
"reefer-cutoff": "2023-05-03T16:00:00.000-07:00",
"begin-receive": "2023-04-27T07:00:00.000-07:00",
"vessel-id": "CITA",
"vessel-name": "COSCO ITALY",
"lloyds-id": "9516454",
"flex-string-01": "YES",
"flex-string-04": "NO",
"oog-breakbulk-cutoff": "2023-05-01T16:00:00.000-07:00",
"vessel-class": "CENG",
"eta": "2023-04-22T10:16:36.270-07:00",
"ata": "2023-05-03T18:00:36.270-07:00",
"etd": "2023-05-09T03:00:00.000-07:00",
"atd": "2023-05-09T03:00:00.000-07:00"
}
],
"status":"OK",
"type":"vessel-visit-details",
"date":"2023-04-07T13:20:51.050-07:00",
"node":"PRDAPI001",
"environment":"PRD"
}
- Data Mapping:
Property |
Source Property |
Description |
|---|---|---|
id |
number |
The booking number being traced. |
providerId |
DEFAULTED |
Identifier of the provider providing the data defaulted to lbct. |
locationCode |
facility-id |
Terminal specific identifier of the location |
steamshipLine |
line |
Steamship line identifier/SCAC |
vessel |
vessel-name |
Identifier of the vessel. |
vesselNumber |
lloyds-id |
Reference number for the vessel. |
voyage |
outbound-voyage-number |
Reference number for the voyage. |
earliestLoading |
begin-receive |
Date/Time when loading starts. |
arrived |
ata |
Date/Time the vessel arrived. |
etd |
etd |
Estimated time to departure. |
eta |
eta |
Estimated arrival time. |
departed |
atd |
Date/Time the vessel departed. |
cutoff |
dry-cutoff |
General cargo cutoff date/time. |
reeferCutoff |
reefer-cutoff |
Refrigerated cargo cutoff date/time. |
hazmatCutoff |
haz-cutoff |
Hazmat cargo cutoff date/time. |
oogCutoff |
oog-breakbulk-cutoff |
Out-of-gage cargo cutoff date/time. |
hazmat
|
is-hazardous
|
Allows hazardous cargo. .
if not found then it is defaulted to False
|
reefer
|
has-reefers
|
Allows refrigerated cargo.
if not found then it is defaulted to False
|
totalContainers
|
quantity
|
Total number of containers in the booking reservation.
if not found then it is defaulted to -1
|
loadedContainers
|
tally-in
|
Number of containers that are loaded.
if not found then it is defaulted to -1
|
emptyContainers
|
tally-out
|
Number of containers that are empty
if not found then it is defaulted to -1
|
tracedAt |
DEFAULTED |
Defaulted to time where the booking was traced |
lastProviderUpdate |
changed |
Date/Time the provider updated the data. |
bookingDetails[n].temperatureRequired
|
temperatureRequired
|
Represents required temperature for a group of containers.
if not found then it is defaulted to ‘’
|
bookingDetails[n].containerIso
|
iso-id
|
Container iso id
if not found then it is defaulted to ‘’
|
bookingDetails[n].containerDescription
|
Container description
|
Container Description
if not found then it is defaulted to ‘’
|
bookingDetails[n].quantity
|
totalContainers
|
Total number of containers.
if not found then it is defaulted to -1
|
bookingDetails[n].tally-in
|
loadedContainers
|
Number of containers that are loaded.
if not found then it is defaulted to -1
|
bookingDetails[n].tally-out
|
emptyContainers
|
Number of containers that are empty.
if not found then it is defaulted to -1
|
bookingDetails[n].is-hazardous
|
hazmat
|
Represents if the containers has hazardous material.
if not found then it is defaulted to False
|
bookingDetails[n].has-reefers
|
reefer
|
Represents if the containers are refrigerated.
if not found then it is defaulted to False
|
bookingDetails[n].is-oog
|
oogAllowed
|
Represents if the containers are out of guage.
if not found then it is defaulted to False
|
appointmentsMade
|
appointments
|
Represents how many appointments are made.
if not found then it is defaulted to -1
|