Schedules API

API Entry Point https://sirius.searates.com/schedule
HTTP Method GET

Запросить параметры

Parameter name Description
sealine SCAC codes - number from list below.
List of available sealines:
SeaLine Name SCAC codes
APL APLU
ARKAS ARKU
CMA CGM CMDU
COSCO COSU
HAMBURG SUD SUDU
HAPAG-LLOYD HLCU
MAERSK CMCU, CAMN, MAEU
MSC MSCU
ONE ONEY, NYKU, NYKS, MOLU, KKLU
OOCL OOLU
SAFMARINE SAFM
SEALAND SEJJ, MCCQ
SINOKOR SKLU
WAN HAI 22AA
YANG MING YMLU
ZIM ZIMU
portcode UN/LOCODE - the UN/LOCODE of departure port.
portdestinationcode UN/LOCODE - the UN/LOCODE of arrival port.
fromdate Start from date - specify the date in format dd-mm-yyyy or today.
weeksahead Weeks ahead - weeks to display.
direction Direction value
List of available directions:
Value Description
D Earliest Departure Date
A Latest Arrival Date
service_mode_from Origin service mode
List of available origin service modes:
Value Description
CY Container yard
SD Store door
service_mode_to Destination service mode
List of available destination service modes:
Value Description
CY Container yard
SD Store door
api_key API Key - to get api key, please contact us.

Ответ

All possible status's
SUCCESS Schedule received.
NO_RESPONSE_FROM_CARRIER We can't retrieve the schedule. Maybe sealine number is incorrect or sealine does not provide the schedule for requested route. Check input or try again later.
WRONG_SEALINE_SCAC Inputed sealine SCAC code is not valid.
WRONG_START_DATE_FORMAT Inputed start date has the wrong format.
WRONG_WEEKS_AHEAD_NUMBER Inputed weeks ahead number is not valid.
WRONG_PORT_CODE_FORMAT Inputed UN/LOCODE of departure port is not valid.
WRONG_PORT_DESTINATION_CODE_FORMAT Inputed UN/LOCODE of arrival port is not valid.
WRONG_DIRECTION Inputed direction value is not valid.
WRONG_SERVICE_MODE_FROM_FORMAT Inputed origin service mode value is not valid.
WRONG_SERVICE_MODE_TO_FORMAT Inputed destination service mode value is not valid.
API_KEY_WRONG API Key is incorrect.
API_KEY_NO_ACCESS This API Key is not assigned to this product.
API_KEY_EXPIRED API Key is expired, please contact us to extend it.
REQUEST_RATE_TOO_HIGH Request rate is too high for this API key.
TOO_MANY_REQUESTS Your API key has reached its limit for this month. Please contact us to extend your subscription.
UNEXPECTED_ERROR Error. Please, contact us and explain, in what situation its happen.
All possible type's
1 transported by VESSEL
2 transported by FEEDER
3 transported by LAND

JSON Response Structure:

        
responsearray
|-----statusstring
|-----routesarray//all routes by schedule
|-----|-----[0]
|-----|-----|---transShipmentsarray//array of subroutes
|-----|-----|---|-----typenumber//the type of transport provided
|-----|-----|---|-----vesselNamestring//the name of vessel
|-----|-----|---|-----vesselCodestring//the code of vessel
|-----|-----|---|-----voyagestring
|-----|-----|---|-----departurearray//all departure info
|-----|-----|---|-----|-----datenumber//timestampt of departure date
|-----|-----|---|-----|-----portNamestring//the name of departure port
|-----|-----|---|-----|-----portUnlocodestring//the UN/LOCODE of departure port
|-----|-----|---|-----|-----terminalstring//address of departure terminal
|-----|-----|---|-----arrivalarray//all arrival info
|-----|-----|---|-----|-----datenumber//timestampt of arrival date
|-----|-----|---|-----|-----portNamestring//the name of arrival port
|-----|-----|---|-----|-----portUnlocodestring//the UN/LOCODE of arrival port
|-----|-----|---|-----|-----terminalstring//address of arrival terminal
|-----|-----|---|-----servicestring//service name
|-----|-----|---cutOffnumber//timestamp of cut off date
|-----|-----|---transitTimenumber//days of transit time

Notes*