Create a new reference

post

https://demo.vizionapi.com/references

Create a reference to begin tracking per the configured cadence.

Related docs:

Quick start

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Reference creation parameters

Add container reference for update tracking using a carrier code.

container_id

string

required

Container tracking identifier.

carrier_code

string

enum

required

A stable method of specifying carrier.

ANNU: ANL
APLU: APL
CMDU: CMA
COSU: COSCO
EGLV: Evergreen
HASL: Heung-A
HDMU: Hyundai Merchant Marine
HLCU: Hapag-Lloyd
KMTU: Korean Marine Transport Co
MAEU: Maersk
MATS: Matson
MSCU: MSC
NSRU: Namsung
ONEY: ONEY
OOCL: OOCL
PCIU: PIL
RCLU: RCL Group
SAFM: Safmarine
SEAU: Sealand
SMLM: SM Lines
SNKO: Sinokor
SUDU: Hamburg Sud
TMGB: TeamGlobal
WECU: WEC Lines
WHLC: Wan Hai
WWSU: Westwood
YMLU: Yang Ming
ZIMU: ZIM

callback_url

string

URL to receive webhook based updates from Vizions API.

webhooks

array of objects

webhooks

tags

array of objects

length ≤ 10

Optional tags to associate with the reference at creation time. For Bill of Lading and Booking Number references, tags are automatically applied to each child container reference when created.

tags

Responses

Callback

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json