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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

bypass_duplicate_check

boolean

Defaults to false

Create the reference even when your organization is already tracking a matching one. Requires the duplicate-override capability: without it the request is rejected with 403, whether or not a duplicate exists. Contact [email protected] to have it enabled. Has no effect for organizations that do not have duplicate reference prevention enabled in the first place.

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.

ALPJ: Allcargo Logistics
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

200Reference successfully created

4XXInvalid request