POST api/GetTrackingV2

This method returns tracking feeds and milestones for a queried Container.

Request Information


URI Parameters

None.

Body Parameters

GetTrackingV2Request
NameDescriptionTypeAdditional information
cnt

Required Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.

string

None.

carrier

Optional but preferred Carrier Code e.g.: MSC

string

None.

blref

Optional but preferred Carrier Bill's Manifest Reference or Booking Number without SCAC prefix. This must be accompanied with a Carrier Code.

string

None.

apikey

Unique Value assigned by an administrator during account setup.

string

None.

username

Username Assigned by an administrator during account setup

string

None.

password

Password Assigned by an administrator during account setup

string

None.

ctoken

Optional Client Token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "cnt": "MOFU0602878",
  "carrier": "ONE",
  "blref": "HPHV07147800",
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": null
}

text/xml, application/xml

Sample:
<GetTrackingV2Request>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken />
  <password>dpassword</password>
  <username>demoapi</username>
  <blref>HPHV07147800</blref>
  <carrier>ONE</carrier>
  <cnt>MOFU0602878</cnt>
</GetTrackingV2Request>

application/x-www-form-urlencoded

Sample:
CNT=MOFU0602878&CARRIER=ONE&BLReference=HPHV07147800&ApiKey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&Username=demoapi&Password=dpassword

Response Information


Resource Description

GetTrackingV2Response
NameDescriptionTypeAdditional information
msgkey

Optional but required for Functional Acknowledegment Usage Message Routing Key

string

None.

msgid

Optional but required for Functional Acknowledegment Usage Unique Message ID

string

None.

cnt

Required Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.

string

None.

carrier

Optional but preferred Carrier Code e.g.: MSC

string

None.

blref

Optional but preferred Carrier Bill's Manifest Reference or Booking Number without SCAC prefix. This must be accompanied with a Carrier Code.

string

None.

cref

Array of Client References Format: Alpha Numeric Characters

Collection of string

None.

result

Tracking Results Version 2 for the CNT (Container)

ContainerTrackingResult

None.

ack

A flag indicating success or failure of the web service response back to the client. Default is success.

AcknowledgeType

None.

exceptions

Message back to client. Mostly used when a web service failure occurs.

Collection of ResponseExceptionDto

None.

ctoken

Optional Client Token

string

None.

Response Formats

application/json, text/json

Sample:
{
  "msgkey": null,
  "msgid": null,
  "cnt": "MOFU0602878",
  "carrier": null,
  "blref": null,
  "cref": null,
  "result": null,
  "ack": 1,
  "exceptions": null,
  "ctoken": null
}

text/xml, application/xml

Sample:
<GetTrackingV2Response>
  <ack>Success</ack>
  <ctoken />
  <exceptions />
  <blref />
  <carrier />
  <cnt>MOFU0602878</cnt>
  <cref />
  <msgid />
  <msgkey />
  <result />
</GetTrackingV2Response>