Inco Terms API

Use the Inco Terms API to manage the Inco Terms catalog for the authenticated tenant. The API also exposes the global catalog and lets a tenant copy a global term into its own catalog.

All requests require the authentication described in API Authentication. Tenant endpoints always operate on the tenant associated with the authenticated request; do not supply an organization or tenant ID in the route.

Tenant catalog endpoints

Method	Endpoint	Description
GET	/v1/incoterms	Returns the authenticated tenant's Inco Terms, ordered by code.
GET	/v1/incoterms/{TermID}	Returns one tenant Inco Term.
POST	/v1/incoterms	Creates a tenant Inco Term.
PATCH	/v1/incoterms/{TermID}	Updates a tenant Inco Term.
DELETE	/v1/incoterms/{TermID}	Deletes a tenant Inco Term.

Tenant Inco Term fields

Field	Description
termID	Velosity identifier for the tenant Inco Term. The API generates one when creating a term if it is omitted.
code	Inco Term code, such as FOB or EXW.
name	Display name of the term.
description	Term description. Velosity stores this value as the term's notes.
notes	Alternate field for the term description. When both description and notes are supplied, description is used.
isActive	Whether the term is active in the tenant catalog.

The tenant catalog persists code, name, the description or notes, and isActive. Use the returned termID when updating or deleting the term.

Create a tenant term

POST /v1/incoterms HTTP/1.1
Host: api.velosity.one
X-APIKEY: your-api-key
Content-Type: application/json

{
  "code": "FOB",
  "name": "Free On Board",
  "description": "Free On Board",
  "isActive": true
}

Global catalog endpoints

Method	Endpoint	Description
GET	/v1/global/incoterms	Returns all global Inco Terms, ordered by code.
GET	/v1/global/incoterms/{TermID}	Returns one global Inco Term.
POST	/v1/global/incoterms	Creates a global Inco Term.
PATCH	/v1/global/incoterms/{TermID}	Updates a global Inco Term.
DELETE	/v1/global/incoterms/{TermID}	Deletes a global Inco Term.
POST	/v1/global/incoterms/{TermID}/copy-to-tenant	Copies a global term into the authenticated tenant's catalog.

Global Inco Term fields

Field	Description
termID	Velosity identifier for the global Inco Term.
code	Inco Term code.
name	Display name of the term.
description	Description of the term.
effectiveYear	Incoterms edition or effective year, such as 2020.

Copy a global term to the tenant catalog

POST /v1/global/incoterms/{TermID}/copy-to-tenant HTTP/1.1
Host: api.velosity.one
X-APIKEY: your-api-key

The copied term is active in the tenant catalog. The endpoint returns 404 when the global term does not exist and 409 when the tenant already has a term with the same code.

For how Inco Terms flow from the tenant catalog to customers, Ship-To addresses, and sales quotes, see Inco Terms.