{ "info": { "_postman_id": "b3ce7837-4194-493f-a88e-222e6acb85e3", "name": "API Container Tracking", "description": "Welcome to the documentation of the Container Tracking API\n\n

Compatibility guidelines

\n\n

The HTTP API is versioned with a single number, which is currently 1

\n\n

This number symbolizes the major version number. New features can be added to the API in the same version number if there is no breaking change.

\n\n

The version number is present in the url, for instance /container/api/v1 for the current version.

\n\n

Authentication

\n\n

Every endpoints of this API require authentication using an API key.

\n\n

If you don't have an API Key and you need to use the Container Traking API, you need to ask Sinay to have one.

\n\n

To use the API Key, you must add a header named API_KEY with your API Key as a value.

\n\n

Test the API with Swagger-ui

\n\n

To test the API using Swagger-ui, you must click on the button Authorize and then fill the apiKey field and click on Authorize.

\n\n

Swagger-ui will then use the api key automatically in each request.

\n\n

On every endpoints, you can click on Try it out, you can modify the body and then click on Execute

\n\n

You will be able to see the response.

\n\n

Release note

\n\n

1.1.0

\n\n

Retrieve container location

Retrieve location for every container in Bk or BL

\n\n

1.0.0

\n\n

Retrieve Container Status

Retrieve status for every container in Bk or BL

", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25382989", "_collection_link": "https://www.postman.com/sinayapi/workspace/sinay/collection/18525517-b3ce7837-4194-493f-a88e-222e6acb85e3?action=share&source=collection_link&creator=25382989" }, "item": [ { "name": "status", "item": [ { "name": "Retrieve container status.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/status/container?number=zesd2603536", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "status", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] }, "description": "

This endpoint is used to retrieve the status of a given container.

It will return both the last event and the next event of the container.

Example

If the last event is \"Container Loaded\" and the Next is \"Container discharge\", you'll know that your container is onboard a vessel.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/status/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "status", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"containerId\": \"\",\n \"lastEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n \"nextEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/status/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "status", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] }, { "name": "Retrieve containers status in BK or BL.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/status/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "status", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] }, "description": "

This endpoint is used to retrieve the status of every container in a given booking or bill or lading on the given sealine.

For each container, it will return both the last event and the next event.

Example

If the last event is \"Container Loaded\" and the Next is \"Container discharge\", you'll know that your container is onboard a vessel.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/status/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "status", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"containerId\": \"\",\n \"lastEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n \"nextEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n },\n {\n \"containerId\": \"\",\n \"lastEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n \"nextEvent\": {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n }\n]" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/status/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "status", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] } ] }, { "name": "location", "item": [ { "name": "Retrieve container location.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/location/container?number=qHAc4656056", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "location", "container" ], "query": [ { "key": "number", "value": "qHAc4656056", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] }, "description": "

This endpoint is used to retrieve the location of a given container.

" }, "response": [ { "name": "Successful Response
If the location object is null it means we failed to get to container location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/location/container?number=qHAc4656056", "host": [ "{{baseUrl}}" ], "path": [ "location", "container" ], "query": [ { "key": "number", "value": "qHAc4656056" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"containerId\": \"FANU1172910\",\n \"location\": {\n \"longitude\": -0.39362358826455934,\n \"latitude\": 49.20156472251085\n }\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/location/container?number=qHAc4656056", "host": [ "{{baseUrl}}" ], "path": [ "location", "container" ], "query": [ { "key": "number", "value": "qHAc4656056" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": 79339213,\n \"message\": \"ex veniam consequat in labore\",\n \"details\": [\n \"cillum quis non\",\n \"dolor anim aliquip non\"\n ],\n \"time\": \"1980-07-29T05:00:02.987Z\"\n}" } ] }, { "name": "Retrieve containers location in BK or BL.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/location/blorbk?documentType=&documentNumber=pariatur do fugiat consequat amet&sealine=", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "location", "blorbk" ], "query": [ { "key": "documentType", "value": "", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "pariatur do fugiat consequat amet", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] }, "description": "

This endpoint is used to retrieve the locations of every container in a given booking or bill or lading on the given sealine.

" }, "response": [ { "name": "Successful Response
If the location object is null it means we failed to get to container location", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/location/blorbk?documentType=&documentNumber=pariatur do fugiat consequat amet&sealine=", "host": [ "{{baseUrl}}" ], "path": [ "location", "blorbk" ], "query": [ { "key": "documentType", "value": "" }, { "key": "documentNumber", "value": "pariatur do fugiat consequat amet" }, { "key": "sealine", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"containerId\": \"FANU1172910\",\n \"location\": {\n \"longitude\": -0.39362358826455934,\n \"latitude\": 49.20156472251085\n }\n },\n {\n \"containerId\": \"FANU1172910\",\n \"location\": {\n \"longitude\": -0.39362358826455934,\n \"latitude\": 49.20156472251085\n }\n }\n]" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/location/blorbk?documentType=&documentNumber=pariatur do fugiat consequat amet&sealine=", "host": [ "{{baseUrl}}" ], "path": [ "location", "blorbk" ], "query": [ { "key": "documentType", "value": "" }, { "key": "documentNumber", "value": "pariatur do fugiat consequat amet" }, { "key": "sealine", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": 79339213,\n \"message\": \"ex veniam consequat in labore\",\n \"details\": [\n \"cillum quis non\",\n \"dolor anim aliquip non\"\n ],\n \"time\": \"1980-07-29T05:00:02.987Z\"\n}" } ] } ] }, { "name": "sealines", "item": [ { "name": "Get supported sealines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/sealines", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "sealines" ] }, "description": "

The endpoint allows you to retrieve supported sealines

" }, "response": [ { "name": "Supported sealines", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/sealines", "host": [ "{{baseUrl}}" ], "path": [ "sealines" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\"\n }\n]" }, { "name": "The authentication failed", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/sealines", "host": [ "{{baseUrl}}" ], "path": [ "sealines" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" }, { "name": "An error occurend on server side", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/sealines", "host": [ "{{baseUrl}}" ], "path": [ "sealines" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" }, { "name": "default", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/sealines", "host": [ "{{baseUrl}}" ], "path": [ "sealines" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] } ] }, { "name": "events", "item": [ { "name": "Retrieve container events.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/events/container?number=zesd2603536", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "events", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] }, "description": "

This endpoint is used to retrieve all events of a given container, in the past of the future.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/events/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "events", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"containerId\": \"\",\n \"events\": [\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n ]\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/events/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "events", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] }, { "name": "Retrieve containers events in BK or BL.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/events/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "events", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] }, "description": "

This endpoint is used to retrieve events of every container in a given booking or bill or lading on the given sealine.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/events/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "events", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"containerId\": \"\",\n \"events\": [\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n ]\n },\n {\n \"containerId\": \"\",\n \"events\": [\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n },\n {\n \"code\": \"\",\n \"text\": \"\",\n \"portCode\": \"\",\n \"location\": \"\",\n \"date\": \"\"\n }\n ]\n }\n]" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/events/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "events", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] } ] }, { "name": "eta", "item": [ { "name": "Retrieve container ETA.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1//eta/container?number=zesd2603536", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "", "eta", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] }, "description": "

This endpoint is used to retrieve the eta of a given container. It will return both the ETA at the next port of discharge and at the last port of discharge. If there are no expected transhipments, next and last will return the same value.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/eta/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "eta", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"containerId\": \"\",\n \"nextPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"lastPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"complementaryMessage\": \"\"\n}" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/eta/container?number=zesd2603536", "host": [ "{{baseUrl}}" ], "path": [ "eta", "container" ], "query": [ { "key": "number", "value": "zesd2603536", "description": "(Required) A Container Number is unique alpha-numeric combination of seven numbers and four letters used for identifying containers internationally." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] }, { "name": "Retrieve containers ETA in BK or BL.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1//eta/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "", "eta", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] }, "description": "

This endpoint is used to retrieve the ETA of every container in a given booking or bill or lading on the given sealine.

" }, "response": [ { "name": "Successful Response", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/eta/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "eta", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"containerId\": \"\",\n \"nextPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"lastPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"complementaryMessage\": \"\"\n },\n {\n \"containerId\": \"\",\n \"nextPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"lastPortArrival\": {\n \"locode\": \"\",\n \"date\": \"\"\n },\n \"complementaryMessage\": \"\"\n }\n]" }, { "name": "Validation Error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/eta/blorbk?documentType=BK&documentNumber=&sealine=KKLU", "host": [ "{{baseUrl}}" ], "path": [ "eta", "blorbk" ], "query": [ { "key": "documentType", "value": "BK", "description": "(Required) Choose which type of document to use for retrieving data: BL = Bill of Lading, BK = Booking" }, { "key": "documentNumber", "value": "", "description": "(Required) A bill of lading number is a ten-digit number that's assigned by the carrier to identify the bill of lading. The booking number will usually consist of two letters and six digits." }, { "key": "sealine", "value": "KKLU", "description": "(Required) Sealine code is a 4 digits alphanumeric character string, uniquely identifying the sealine." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": \"\",\n \"message\": \"\",\n \"details\": [\n \"\",\n \"\"\n ],\n \"time\": \"\"\n}" } ] } ] }, { "name": "Retrieve your monthly usages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "https://api.sinay.ai/container-tracking/api/v1/usages?startTime=1945-06-25T10:22:09.035Z&endTime=1945-06-25T10:22:09.035Z", "protocol": "https", "host": [ "api", "sinay", "ai" ], "path": [ "container-tracking", "api", "v1", "usages" ], "query": [ { "key": "startTime", "value": "1945-06-25T10:22:09.035Z", "description": "Start time at which usages must be found" }, { "key": "endTime", "value": "1945-06-25T10:22:09.035Z", "description": "End time at which usages must be found" } ] }, "description": "

The endpoint allows you to retrieve your monthly usages of the API

" }, "response": [ { "name": "The monthly usages", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/usages?startTime=1945-06-25T10:22:09.035Z&endTime=1945-06-25T10:22:09.035Z", "host": [ "{{baseUrl}}" ], "path": [ "usages" ], "query": [ { "key": "startTime", "value": "1945-06-25T10:22:09.035Z" }, { "key": "endTime", "value": "1945-06-25T10:22:09.035Z" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"allCalls\": 15,\n \"successCalls\": 13,\n \"clientErrorCalls\": 1,\n \"serverErrorCalls\": 1,\n \"consumedApiUnits\": 25,\n \"periodicUsages\": {\n \"2022-05\": {\n \"allCalls\": 15,\n \"successCalls\": 13,\n \"clientErrorCalls\": 1,\n \"serverErrorCalls\": 1,\n \"consumedApiUnits\": 25\n }\n }\n}" }, { "name": "The authentication failed", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/usages?startTime=1945-06-25T10:22:09.035Z&endTime=1945-06-25T10:22:09.035Z", "host": [ "{{baseUrl}}" ], "path": [ "usages" ], "query": [ { "key": "startTime", "value": "1945-06-25T10:22:09.035Z" }, { "key": "endTime", "value": "1945-06-25T10:22:09.035Z" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": 79339213,\n \"message\": \"ex veniam consequat in labore\",\n \"details\": [\n \"cillum quis non\",\n \"dolor anim aliquip non\"\n ],\n \"time\": \"1980-07-29T05:00:02.987Z\"\n}" }, { "name": "An error occurend on server side", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/usages?startTime=1945-06-25T10:22:09.035Z&endTime=1945-06-25T10:22:09.035Z", "host": [ "{{baseUrl}}" ], "path": [ "usages" ], "query": [ { "key": "startTime", "value": "1945-06-25T10:22:09.035Z" }, { "key": "endTime", "value": "1945-06-25T10:22:09.035Z" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": 79339213,\n \"message\": \"ex veniam consequat in labore\",\n \"details\": [\n \"cillum quis non\",\n \"dolor anim aliquip non\"\n ],\n \"time\": \"1980-07-29T05:00:02.987Z\"\n}" }, { "name": "default", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "API_KEY", "value": "" } ], "url": { "raw": "{{baseUrl}}/usages?startTime=1945-06-25T10:22:09.035Z&endTime=1945-06-25T10:22:09.035Z", "host": [ "{{baseUrl}}" ], "path": [ "usages" ], "query": [ { "key": "startTime", "value": "1945-06-25T10:22:09.035Z" }, { "key": "endTime", "value": "1945-06-25T10:22:09.035Z" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"errorCode\": 79339213,\n \"message\": \"ex veniam consequat in labore\",\n \"details\": [\n \"cillum quis non\",\n \"dolor anim aliquip non\"\n ],\n \"time\": \"1980-07-29T05:00:02.987Z\"\n}" } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{API_KEY}}", "type": "string" }, { "key": "key", "value": "API_KEY", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "{{ serverUrl }}", "type": "string" } ] }