Skip to main content
POST
Create Delivery Location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A delivery address to save on a third party.

relation_id
string
required

Opaque identifier of the third party this address belongs to.

Maximum string length: 36
address
AddressCreate · object
required

The address itself; the country is required.

name
string | null

Label of the location, to tell two addresses of the same third party apart.

Maximum string length: 100
identifier
string | null

Identifier of the location itself, typically a GLN. Requires identifier_scheme.

Maximum string length: 30
identifier_scheme
string | null

4-digit Peppol scheme code, e.g. 0088 for a GLN. Requires identifier.

Response

Successful Response

A delivery address saved on a third party.

id
string
required

Opaque unique identifier of the delivery location.

relation_id
string | null

Opaque identifier of the third party this address belongs to (resolvable via GET /relations/{id}).

name
string | null

Label of the location, e.g. Warehouse Liège.

address
AddressOut · object | null

The address itself.

identifier
string | null

Identifier of the location itself, typically a GLN.

identifier_scheme
string | null

Scheme identifier belongs to — 4-digit Peppol scheme code, e.g. 0088 for a GLN.