Blog

Our Blog List

Container Tracking API Integration

Index:

  • Glossary
  • API Pre Requirement
  • Examples With SourceCode
  • AvailableAPIs
    • Post New Container shortenedform
    • Post New Container full form
    • Post New Container With B/L shortenedform
    • Post New Container With B/L fullform
    • Get Container Info From https://shipsgo.com
    • Get Shipping Line List From https://shipsgo.com

 

Glossary:

ContainerTracking Service

This form in our website home page or dashboard page can be posted using our API  functionality from your application directly.

Container Tracking

Service With B/L

This form in our website dashboard page can be posted using our API functionality from  your application directly.

authCode

(security key)

Security API key (ex: 33e1r9drcy423b05bec1e70702f23a39)

Which exists in your profile under “INTEGRATION” section.

 

Find it by login to ShipsGo and from “INTEGRATION” find your security key(authCode).

https://shipsgo.com/api-integration

{containerNumber}

(ex: TGHU1619580)

Must be 4 Characters followed by 7 numbers

{shippingLine}

(ex: MAERSK LINE)

Must equal to ShipsGo values

find “Get Shipping Line List ” in this document for more details about pre-defined list

{emailAddress}

Only valid email address accepted.

{referenceNo}

any text accepted more than 5 characters and less than 50

this reference will be displayed in your dashboard grid to help you find your request easily using search.

{requestId}

Request Identifier as a number. which will be used to retrieve track information.

After posting your container form using API the returned value is {requestId} keep it and use it later to retrieve track result.

{containerNumber} is accepted to retrieve your track result, but not Recommended:

  • {requestId}: Recommended
  • {containerNumber}: Not Recommended

Post New Container

shortened form

In this case you do not need to send {emailAddress} parameter internally we will use your

registered Email Address from your account,

And also you do not need to send {referenceNo} parameter and service will bind it  automatically as:

“YourCompanyName + "-" + {containerNumber}”

Post New Container

full form

Which equal to shortened form with extra 2 parameters: {referenceNo} And {emailAddress}

{containersCount}

Used only with B/L request, just write the number of containers related to your B/L request

{blContainersRef}

Used only with B/L request, just write the B/L reference number given by your carrier

 

 

API Pre Requirement:

  • Subscribe to our “SHIPSGO  BCO  or   SHIPSGO  FREIGHT  FORWARDER”, API only these packages allowing you to use API services. Please check our package list from here. : https://shipsgo.com/#products
  • Login to ShipsGo web and from “API Code” find your security key(authCode). After login go to: https://shipsgo.com/api-integration Trial version accepted for your tests with number of posts limitation

Examples With Source Code :

 

 

Available Container Tracking APIs:

 

Post New Container shortened form

URL

https://shipsgo.com/api/ContainerService/PostContainerInfo/

HTTP Methods

POST

Parameters

a.{authCode}

b.{containerNumber}

c.{shippingLine}

 

Post New Container full form

URL

https://shipsgo.com/api/ContainerService/PostCustomContainerForm/  

HTTP Methods

POST

Parameters

a.{authCode}

b.{containerNumber}

c.{shippingLine}

d.{emailAddress}

e.{referenceNo}

 

Post New Container With B/L shortened form

URL

https://shipsgo.com/api/ContainerService/PostContainerInfoWithBl/

HTTP Methods

 POST

Parameters

a.{authCode}

b.{containerNumber}

c.{shippingLine}

d.{containersCount}

e.{blContainersRef}

 

Post New Container With B/L full form

URL

https://shipsgo.com/api/ContainerService/PostCustomContainerFormWithBl/

HTTP Methods POST

Parameters

a.{authCode}

b.{containerNumber}

f.{shippingLine}

g.{emailAddress}

h.{referenceNo}

i.{containersCount}

c.  {blContainersRef}

 

Get Container Info From https://shipsgo.com

using containerNumber(not recommended) Or return ID number(recommended) which returned by POST Form

URL

https://shipsgo.com/api/ContainerService/GetContainerInfo/

HTTP Methods  GET

Parameters

a.{authCode}

b.{requestId} or {containerNumber}

Data Preview

 

Get Shipping Line List From https://shipsgo.com

post form accepts only these values​

URL

https://shipsgo.com/api/ContainerService/GetShippingLineList

HTTP Methods

GET

Parameters

-

Data Preview

 

 

 

 

 

Categories