Afosto Api API Reference
Introduction
Welcome to Afosto API documentation. Here you will find resource addresses and explanations on how to use our API to access various parts of data which we provide to you - our customers. On the right side of the screen you can preview examples of the responses each API endpoint produces Please take into consideration, that there is one address, and one address only you should use for purposes of the api connections. This is the address you are required to use: https://api.afosto.io
Authentication
Afosto Uses OAuth2 with JWT tokens for its authentication
API Endpoint
https://api.afosto.io
Contact: support@afosto.com
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0
Authentication
Bearer
Some endpoints within the API require that you have access to certain scopes. A List of available scopes are defined below.
Grants read access for integrations
app:integrations:writeGrants write access for integrations
cat:channel:readGrants read access to channels
cat:channel:writeGrants write access to channels
cat:mapping:readGrants read access for mapping
cat:mapping:writeGrants write access for mapping
cat:prices:readRead product prices
cat:prices:writeWrite to product prices
cnt:files:readGrants read access for files
cnt:files:writeGrants write access to the file service
cnt:filesystems:readGrants filesystems read access
cnt:filesystems:writeGrants filesystems write access
cnt:index:readGrants tenant read access
cnt:index:writeUpdate definitions / add contents
cnt:instant:readGrants read access to instant search
cnt:instant:writeGrants write access to instant search
cnt:proxies:readGrants read access for proxies
cnt:proxies:writeGrants write access for proxies
cnt:video:readGrants read access for video / animated content
emailReturns email and verification status claims
iam:2fa:readGrants 2 factor authentication read access for current user
iam:2fa:writeGrants 2 factor authentication write access for current user
iam:audits:readRead audit logs
iam:customer:readGrants read access to customer data
iam:customer:writeGrants write access to customer data
iam:logs:readRead logs
iam:oauth:readGrants read access to oauth clients
iam:oauth:writeGrants write access to oauth clients
iam:roles:readGrants read access to rbac roles
iam:roles:writeGrants write access to rbac roles
iam:services:readGrants read access to services
iam:services:writeGrants write access to services
iam:sources:readGrants limited read access to customer payment sources
iam:sources:writeGrants write access to customer payment sources
iam:subscriptions:readGrants subscription read access
iam:subscriptions:writeGrants subscription write access
iam:tenants:readGrants tenant read access
iam:usage:readGrants usage read access
iam:users:readGrants read access to users
iam:users:writeGrants write access to users
int:afosto:writeGrants write access to bol.com
int:bol:writeGrants write access to bol.com
lcs:dpd:readGrants DPD read access
lcs:handling:readGrants read access for handling lists and parcels
lcs:handling:writeGrants write access for handling lists and parcels
lcs:locations:readGrants read access for fulfilment locations
lcs:locations:writeGrants write access for fulfilment locations
lcs:points:readGrants read access for parcel points
lcs:shipments:readGrants read access for shipments
lcs:shipments:writeGrants write access for shipments
mes:conversations:readGrants read access to conversations
mes:conversations:registerGrants access to register upon a conversation
mes:conversations:writeGrants write access to conversations
mes:domains:readGrants read access to domains
mes:domains:writeGrants write access to domains
mes:emails:readGrants email read access
mes:emails:writeGrants email write access
mes:inboxes:readGrants read access to inboxes
mes:inboxes:writeGrants write access to inboxes
mes:relays:readGrants read access for relays
mes:relays:writeGrants write access for relays
mes:subscriptions:readGrants subscription read access
mes:subscriptions:writeGrants subscription write access
mes:webhooks:readGrants subscription read access
odr:coupons:readGrants read access for coupons
odr:coupons:writeGrants write access coupons
odr:credit:readGrants read access for credit
odr:credit:writeGrants write access to credit
odr:invoices:createGrants create access for invoices
odr:invoices:readGrants read access for the invoices
odr:invoices:updateGrants update access for invoices
odr:metrics:readGrants read access for the metrics
odr:orders:readGrants read access for the orders
odr:orders:writeGrants write access to orders
odr:payments:updateGrants update access for payments
odr:providers:readGrants read access for the payment providers
odr:skus:writeGrants write access to skus for the stack service
odr:transactions:createGrants create access for transactions
openidReturns the sub / user id claim
profileReturns profile information claims
qcq:proxies:readGrants read access for proxies
qcq:proxies:writeGrants write access for proxies
rel:contacts:readGrants read access for the contacts
rel:contacts:writeGrants create access for address
rel:geocode:readgrants read access for geocoding
rel:identity:readgrants write access for identity
rel:identity:writegrants write access for identity
spl:hubs:readGrants read access for hubs
spl:hubs:writeGrants write access for hubs
spl:logs:readGrants read access to hub logs
spl:logs:writeGrants write access for logging hub information
spl:network:readGrants read access for network listings
spl:network:writeGrants write access for network listings
spl:printers:readGrants read access for printers
spl:printers:writeGrants write access for printers
spl:queue:createGrants create access to the queue
spl:queue:readGrants read access for the queued jobs
spl:queue:updateGrants update permission for jobs on the queue
tpl:themes:readGrants read access for themes
tpl:themes:writeGrants write access for themes
wms:claim:readGrants read access to claim
wms:claim:writeGrants write access to claim
wms:hops:readGrants read access to hops
wms:hops:writeGrants write access to hops
wms:item:readGrants read access to item
wms:item:writeGrants write access to item
wms:location:readGrants read access to location
wms:location:writeGrants write access to location
wms:route:readGrants read access to route
wms:route:writeGrants write access to route
wms:schedule:readGrants read access to schedule
wms:schedule:writeGrants write access to schedule
wms:sub:readGrants read access to sub
wms:sub:writeGrants write access to sub
wms:transfer:readGrants read access to transfer
wms:transfer:writeGrants write access to transfer
Apps
Apps
List apps
Returns list of apps
(no description)
(no description)
Apps
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"code": "string",
"name": "string",
"description": "string",
"tags": [
"string"
],
"author": {
"name": "string",
"description": "string",
"url": "string",
"is_third_party": "boolean"
},
"is_published": "boolean",
"is_duplicate_allowed": "boolean",
"authentication": {
"type": "string",
"schema": "string"
},
"config_schema": "string"
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View app
Returns app
(no description)
Apps
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"code": "string",
"name": "string",
"description": "string",
"tags": [
"string"
],
"author": {
"name": "string",
"description": "string",
"url": "string",
"is_third_party": "boolean"
},
"is_published": "boolean",
"is_duplicate_allowed": "boolean",
"authentication": {
"type": "string",
"schema": "string"
},
"config_schema": "string"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Install app
Activate a new app
undefined
(no description)
Request Example
{
"name": "string",
"credentials": "object",
"configuration": "object"
}
Apps
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"state": "string",
"redirect_url": "string"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Integrations
List integrations
Returns list of active integrations
(no description)
(no description)
(no description)
(no description)
List of integrations
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "integer",
"name": "string",
"configuration": "object",
"app_code": "string",
"is_installed": "boolean",
"active_at": "string (date-time)",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View integration
Get information for an integration
(no description)
List of integrations
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "integer",
"name": "string",
"configuration": "object",
"app_code": "string",
"is_installed": "boolean",
"active_at": "string (date-time)",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Update integration
Update an integrations' configuration
undefined
(no description)
Request Example
{
"name": "string",
"credentials": "object",
"configuration": "object"
}
List of integrations
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "integer",
"name": "string",
"configuration": "object",
"app_code": "string",
"is_installed": "boolean",
"active_at": "string (date-time)",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Delete integration
Update an integrations' configuration
(no description)
Integration deleted
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Catalog
Mapping
List collections
List collections
(no description)
(no description)
List collections
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"last_upsert_at": "string (date-time)",
"last_miss_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View collection
View collection
(no description)
View collection
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"last_upsert_at": "string (date-time)",
"last_miss_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
List misses
List misses for a collection
(no description)
(no description)
(no description)
List of msises for a collection
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"key": "string",
"count": "integer",
"last_miss_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
List keys
List keys for a category
(no description)
(no description)
(no description)
List of maps
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"key": "string",
"value": "string",
"upserted_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Upsert keys
Upsert keys, create or update values
- key: string
- value: string
(no description)
Request Example
[
{
"key": "978020137962",
"value": "234.SKE-4255.ABC"
}
]
Updated map
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search keys
Search keys for values
(no description)
The newly created theme
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"hits": {
"978020137962": "234.SKE-4255.ABC"
},
"misses": [
"978020137964"
]
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Groups
Get a list of price groups
Get a listing of available pricing groups
the requested page id
the requested page size
List of pricing groups
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Create a new pricing group
Add a new pricing group to the list
undefined
Request Example
{
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object"
}
The new pricing group
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a pricing group
View the pricing group by id
(no description)
The group
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Update a pricing group
Update metadata or the name of the pricing group
undefined
(no description)
Request Example
{
"name": "string",
"metadata": "object"
}
The updated group
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Disable a pricing group
Disabling a pricing group makes sure it cannot me added to new settings
(no description)
The disabled group
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Prices
Get a list of prices within a group
Get a listing of prices that are stored in the group
the requested page id
the requested page size
(no description)
US - use to filter tax rate results
Florida - use to filter tax rate results
List of prices
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string (uuid)",
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"vat": [
{
"rate": "integer",
"country": "string",
"administrative_area": "string"
}
],
"price_group_id": "string (uuid)",
"active_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search for prices
Query for a set of prices
undefined
(no description)
Request Example
{
"active_at": "string (date-time)",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
The new pricing group
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string (uuid)",
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"vat": [
{
"rate": "integer",
"country": "string",
"administrative_area": "string"
}
],
"price_group_id": "string (uuid)",
"active_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Upsert prices
Create or update prices
(no description)
Request Example
[
{
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"active_at": "string (date-time)"
}
]
The upsert results
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"success": 1
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Get a list of prices for a sku
View a historic or planned list of prices for a sku
the requested page id
the requested page size
(no description)
(no description)
Use to query only future / planned prices
List of prices
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string (uuid)",
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"vat": [
{
"rate": "integer",
"country": "string",
"administrative_area": "string"
}
],
"price_group_id": "string (uuid)",
"active_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Get price
Get a single price by its ID
(no description)
The price
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string (uuid)",
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"vat": [
{
"rate": "integer",
"country": "string",
"administrative_area": "string"
}
],
"price_group_id": "string (uuid)",
"active_at": "string (date-time)",
"created_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Vat
Get a list of vat rates
Get a listing of vat rates per country
the requested page id
the requested page size
US
Florida
List of vat groups
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"reference": "integer",
"rate": "integer",
"country": "string",
"is_default": "boolean",
"administrative_area": "string",
"active_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Upsert vat rates for skus
Create or update the vat group per country for given skus
Request Example
[
{
"sku": "string",
"rates": [
{
"country": "string",
"administrative_area": "string",
"reference": "integer"
}
]
}
]
The upsert results
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"success": 1,
"failed": 0
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Channel service
Channels
List channels
Get a list of channels
(no description)
(no description)
(no description)
(no description)
The channel
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string (uuid)",
"name": "string",
"type": "string",
"description": "string",
"client_id": "string",
"deleted_at": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Create channel
Add a new channel
undefined
Request Example
{
"name": "string",
"type": "string",
"description": "string",
"client_id": "string"
}
The channel
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string (uuid)",
"name": "string",
"type": "string",
"description": "string",
"client_id": "string",
"deleted_at": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View channel
Get a single channel
(no description)
The channel
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string (uuid)",
"name": "string",
"type": "string",
"description": "string",
"client_id": "string",
"deleted_at": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Update channel
Update an existing channel
undefined
(no description)
Request Example
{
"name": "string",
"description": "string"
}
The updated channel
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string (uuid)",
"name": "string",
"type": "string",
"description": "string",
"client_id": "string",
"deleted_at": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Delete channel
Delete / disable an existing channel
(no description)
Channel deleted
Bad Request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Contacts
Contacts
Get list of contacts
Returns a list of contact information
(no description)
(no description)
List of contacts
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"version": "string",
"email": "string",
"is_guest": "boolean",
"audience": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"organisations": {
"primary": {
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number"
}
}
}
}
}
}
}
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Upsert a new contact
Create or update an existing contact, based on its email address. This only updates the primary lists and moves existing primaries to the secondary lists when changed.
undefined
Request Example
{
"email": "string",
"is_guest": "boolean",
"audience": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"organisations": {
"primary": {
"id": "string",
"version": "string"
},
"secondary": [
"#/definitions/RelContactUpdateOrganisationsPrimary"
]
},
"billing": {
"primary": "string",
"secondary": [
"string"
]
},
"shipping": {
"primary": "string",
"secondary": [
"string"
]
},
"phone_numbers": {
"primary": "string",
"secondary": [
"string"
]
},
"metadata": "object"
}
The created / updated contact
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"email": "string",
"is_guest": "boolean",
"audience": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"organisations": {
"primary": {
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search contacts
Search contacts based on their id's or email addresses
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
The newly created invoice
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"version": "string",
"email": "string",
"is_guest": "boolean",
"audience": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"organisations": {
"primary": {
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number"
}
}
}
}
}
}
}
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a single contact
Returns a single contact by id
(no description)
(no description)
The contact data
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"email": "string",
"is_guest": "boolean",
"audience": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"organisations": {
"primary": {
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
}
}
}
}
}
}
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Delete a contact
Delete a contact by id
(no description)
Deleted
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a list of versions for a a single contact
Returns a version list for the contact
(no description)
The versions
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"version": "string",
"created_at": "string (date-time)"
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Addresses
Create a new address
Create an address
undefined
Request Example
{
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
}
The newly created address
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a single address
Returns a single address by id
(no description)
The address
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search
Search addresses
Search addresses
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
The matched addresses
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search phone numbers
Search phone numbers
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
The matched phone numbers
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search organisations
Search organisations
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
The matched organisations
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
}
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Geocoding
Geocode address
Get lat long parameters for party address
(no description)
The created id token
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Get geocode
Get lat long parameters for party address
undefined
Request Example
{
"country_code": "string",
"address": "string"
}
The created id token
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Options
Get required fiels for an address based on country
List required fields
Defaults to country that can be linked to client IP
The list of required fields
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"required": [
"string"
],
"allowed": [
"string"
],
"country_code": "string"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Start session
Start an search session
(no description)
(no description)
The newly created session token
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"session_key": "string"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search address
Search an address
undefined
Request Example
{
"session_key": "string",
"context": "string",
"query": "string"
}
The list of options
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"options": [
{
"value": "string",
"precision": "string",
"label": "string",
"description": "string",
"context": "string"
}
],
"result": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
}
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Phonenumbers
Create a new phonenumber
Create a phonenumber
undefined
Request Example
{
"country_code": "string",
"number": "string"
}
The newly created phonenumber
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a single phonenumber
Returns a single phonenumber by id
(no description)
The phonenumber
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Organisations
Get list of organisations
Returns a list of organisation information
(no description)
(no description)
List of organisations
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
[
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
}
}
]
Response Headers (200 OK)
x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Create a new organisation
Create an organisation
undefined
Request Example
{
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string"
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"billing": {
"primary": "string",
"secondary": [
"string"
]
},
"shipping": {
"primary": "string",
"secondary": [
"string"
]
},
"phone_numbers": {
"primary": "string",
"secondary": [
"string"
]
},
"administration": {
"email": "string"
}
}
The newly created organisation
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
},
"shipping": "#/definitions/RelAddressList"
}
Response Headers (200 OK)
x-task-id |
undefined |
string (uuid) |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View a single organisation
Returns a single organisation by id
(no description)
(no description)
The organisation
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
},
"shipping": "#/definitions/RelAddressList"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Update an organisation
Updates an existing organisation
undefined
(no description)
Request Example
{
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string"
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"billing": {
"primary": "string",
"secondary": [
"string"
]
},
"shipping": {
"primary": "string",
"secondary": [
"string"
]
},
"phone_numbers": {
"primary": "string",
"secondary": [
"string"
]
},
"administration": {
"email": "string"
}
}
The organisation
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
},
"shipping": "#/definitions/RelAddressList"
}
Response Headers (200 OK)
x-task-id |
undefined |
string (uuid) |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Delete an organisation
delete an existing organisation
(no description)
The organisation
Bad request
Unauthorized
Forbidden
Not found
Internal Server Error
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"version": "string",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",