For AI agents: visit https://docs.contained.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.

Jump to Content

Guides API Reference Changelog Discussions

v1.0

API Reference

v1.0Guides API Reference Changelog Discussions

Proc V3 - External REST API V1.0

Proc V3 External API Overview
Authorization Key
- Using Your Authorization Key
Orders
Suppliers
- List Suppliersget
Hauliers
- List Hauliersget
CSV Mapsget

CDS V2 - External REST API V1

CDS V3 External API Overview
List Currenciesget
Codes
- List of Code Typesget
- List of Codes by Code Typesget

Location - External REST API V1.0

Locations External API Overview
Coordinatesget

Octosenses

/
/qr
- getget
/search
- getget
/address
- postpost
/manifest
- postpost
/profile
- postpost

Octosense Interactions

/
- postpost
/archive
- postpost
/search
- postpost
/validate
- postpost
/index
- postpost

Octosense Sensor Configuration

/
- getget
- postpost

Octosense Alarms

/
- getget
- postpost
/persist
- postpost
/cleared
- postpost
/alreadyraised
- postpost
/index
- postpost

Alarm Thresholds

/
- postpost
/search
- postpost

Location Services

/
- getget
/eta
- getget
/wifi
- postpost
/coordinates
- getget

HMRC - Custom Declaration Service (CDS)

/
- getget
- putput
/declaration
- putput
- postpost
/notification
- getget
/notifications
- getget
/conversation
- getget
/errors
- postpost
/token
- getget
- putput
/status
- getget
/cancel
- postpost
/upload
- postpost
/codes
- getget
/arrival
- postpost

HMRC - ICS NI Services

/
- getget
- putput
/acknowledge
- getget
/notification
- postpost
/message
- getget
/declaration
- putput
- postpost

HMRC - ICS Safety & Security (GB)

/
- getget
- putput
/declaration
- putput
- postpost
/token
- getget
- putput
/outcome
- getget
- deletedel
/bulklist
- getget
/notification
- getget
- deletedel
/outcomes
- getget
/notifications
- getget
/mrn
- putput

HMRC - Goods Vehicle Movement Service (GVMS)

/
- getget
/token
- getget
/report
- getget
/reference-data-cron-trigger
- getget
/gmr/{gmrId}
/push
- getget
- postpost
/authorize
- getget
/reference-data
- getget
/gmr
- postpost
/dashboardLists
- getget
/stats
- getget

Manifests

/
/completed
- postpost
/cancel
- putput
/search
- getget
/operator
- getget
/jobcompleted
- getget
/octosense
- putput
/haulier
- putput

CMR Services

/
- putput
/status
- postpost
/delivery
- putput

Blockchain Services

/
- getget
- postpost
/sign
- postpost

User & Role Management

/
- getget
/manage
/check
- getget

Profiles

/
- getget
- postpost
/search
- getget
/country
- getget

Powered by

CDS V3 External API Overview

This page will help you get started with CDS V2 - External REST API V1.0.

Updated almost 3 years ago

Updated almost 3 years ago