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.

type
oauth2
authorizationUrl
https://app.afosto.io/scopes
flow
implicit
scopes
app:integrations:read

Grants read access for integrations

app:integrations:write

Grants write access for integrations

cat:channel:read

Grants read access to channels

cat:channel:write

Grants write access to channels

cat:mapping:read

Grants read access for mapping

cat:mapping:write

Grants write access for mapping

cat:prices:read

Read product prices

cat:prices:write

Write to product prices

cnt:files:read

Grants read access for files

cnt:files:write

Grants write access to the file service

cnt:filesystems:read

Grants filesystems read access

cnt:filesystems:write

Grants filesystems write access

cnt:index:read

Grants tenant read access

cnt:index:write

Update definitions / add contents

cnt:instant:read

Grants read access to instant search

cnt:instant:write

Grants write access to instant search

cnt:proxies:read

Grants read access for proxies

cnt:proxies:write

Grants write access for proxies

cnt:video:read

Grants read access for video / animated content

email

Returns email and verification status claims

iam:2fa:read

Grants 2 factor authentication read access for current user

iam:2fa:write

Grants 2 factor authentication write access for current user

iam:audits:read

Read audit logs

iam:customer:read

Grants read access to customer data

iam:customer:write

Grants write access to customer data

iam:logs:read

Read logs

iam:oauth:read

Grants read access to oauth clients

iam:oauth:write

Grants write access to oauth clients

iam:roles:read

Grants read access to rbac roles

iam:roles:write

Grants write access to rbac roles

iam:services:read

Grants read access to services

iam:services:write

Grants write access to services

iam:sources:read

Grants limited read access to customer payment sources

iam:sources:write

Grants write access to customer payment sources

iam:subscriptions:read

Grants subscription read access

iam:subscriptions:write

Grants subscription write access

iam:tenants:read

Grants tenant read access

iam:usage:read

Grants usage read access

iam:users:read

Grants read access to users

iam:users:write

Grants write access to users

int:bol:write

Grants write access to bol.com

lcs:dpd:read

Grants DPD read access

lcs:handling:read

Grants read access for handling lists and parcels

lcs:handling:write

Grants write access for handling lists and parcels

lcs:locations:read

Grants read access for fulfilment locations

lcs:locations:write

Grants write access for fulfilment locations

lcs:points:read

Grants read access for parcel points

lcs:shipments:read

Grants read access for shipments

lcs:shipments:write

Grants write access for shipments

mes:conversations:read

Grants read access to conversations

mes:conversations:register

Grants access to register upon a conversation

mes:conversations:write

Grants write access to conversations

mes:domains:read

Grants read access to domains

mes:domains:write

Grants write access to domains

mes:emails:read

Grants email read access

mes:emails:write

Grants email write access

mes:inboxes:read

Grants read access to inboxes

mes:inboxes:write

Grants write access to inboxes

mes:relays:read

Grants read access for relays

mes:relays:write

Grants write access for relays

mes:subscriptions:read

Grants subscription read access

mes:subscriptions:write

Grants subscription write access

mes:webhooks:read

Grants subscription read access

odr:coupons:read

Grants read access for coupons

odr:coupons:write

Grants write access coupons

odr:credit:read

Grants read access for credit

odr:credit:write

Grants write access to credit

odr:invoices:create

Grants create access for invoices

odr:invoices:read

Grants read access for the invoices

odr:invoices:update

Grants update access for invoices

odr:metrics:read

Grants read access for the metrics

odr:orders:read

Grants read access for the orders

odr:orders:write

Grants write access to orders

odr:payments:update

Grants update access for payments

odr:providers:read

Grants read access for the payment providers

odr:skus:write

Grants write access to skus for the stack service

odr:transactions:create

Grants create access for transactions

openid

Returns the sub / user id claim

profile

Returns profile information claims

qcq:proxies:read

Grants read access for proxies

qcq:proxies:write

Grants write access for proxies

rel:contacts:read

Grants read access for the contacts

rel:contacts:write

Grants create access for address

rel:geocode:read

grants read access for geocoding

rel:identity:read

grants write access for identity

rel:identity:write

grants write access for identity

spl:hubs:read

Grants read access for hubs

spl:hubs:write

Grants write access for hubs

spl:logs:read

Grants read access to hub logs

spl:logs:write

Grants write access for logging hub information

spl:network:read

Grants read access for network listings

spl:network:write

Grants write access for network listings

spl:printers:read

Grants read access for printers

spl:printers:write

Grants write access for printers

spl:queue:create

Grants create access to the queue

spl:queue:read

Grants read access for the queued jobs

spl:queue:update

Grants update permission for jobs on the queue

tpl:themes:read

Grants read access for themes

tpl:themes:write

Grants write access for themes

wms:claim:read

Grants read access to claim

wms:claim:write

Grants write access to claim

wms:hops:read

Grants read access to hops

wms:hops:write

Grants write access to hops

wms:item:read

Grants read access to item

wms:item:write

Grants write access to item

wms:location:read

Grants read access to location

wms:location:write

Grants write access to location

wms:route:read

Grants read access to route

wms:route:write

Grants write access to route

wms:schedule:read

Grants read access to schedule

wms:schedule:write

Grants write access to schedule

wms:sub:read

Grants read access to sub

wms:sub:write

Grants write access to sub

wms:transfer:read

Grants read access to transfer

wms:transfer:write

Grants write access to transfer

Apps

Apps

List apps

GET /int/apps/store

Returns list of apps

x-page-size: integer 25
in header

(no description)

x-page: integer 1
in header

(no description)

200 OK

Apps

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /int/apps/store/{code}

Returns app

code: string
in path

(no description)

200 OK

Apps

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /int/apps/store/{code}

Activate a new app

code: string
in path

(no description)

Request Example
{
  "name": "string",
  "credentials": "object",
  "configuration": "object"
}

Apps

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /int/apps/integrations

Returns list of active integrations

app_code: string
in query

(no description)

is_deleted: string 1, 0 0
in query

(no description)

x-page-size: integer 25
in header

(no description)

x-page: integer 1
in header

(no description)

List of integrations

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /int/apps/integrations/{id}

Get information for an integration

id: string
in path

(no description)

List of integrations

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /int/apps/integrations/{id}

Update an integrations' configuration

id: string
in path

(no description)

Request Example
{
  "name": "string",
  "credentials": "object",
  "configuration": "object"
}

List of integrations

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

DELETE /int/apps/integrations/{id}

Update an integrations' configuration

id: string
in path

(no description)

204 No Content

Integration deleted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/maps/collections

List collections

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

List collections

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/maps/collections/{id}

View collection

id: string
in path

(no description)

View collection

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/maps/collections/{id}/misses

List misses for a collection

id: string
in path

(no description)

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

List of msises for a collection

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/maps/collections/{id}/keys

List keys for a category

id: string
in path

(no description)

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

200 OK

List of maps

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /cat/maps/collections/{id}/keys

Upsert keys, create or update values

object
key: string
value: string
id: string
in path

(no description)

Request Example
[
  {
    "key": "978020137962",
    "value": "234.SKE-4255.ABC"
  }
]
204 No Content

Updated map

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /cat/maps/collections/{id}/search

Search keys for values

id: string
in path

(no description)

200 OK

The newly created theme

type
object
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/groups

Get a listing of available pricing groups

x-page: string 1
in header

the requested page id

x-page-size: string 25
in header

the requested page size

200 OK

List of pricing groups

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /cat/groups

Add a new pricing group to the list

undefined

Request Example
{
  "name": "string",
  "is_including_vat": "boolean",
  "currency": "string",
  "metadata": "object"
}
200 OK

The new pricing group

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/groups/{id}

View the pricing group by id

id: string
in path

(no description)

200 OK

The group

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /cat/groups/{id}

Update metadata or the name of the pricing group

undefined

id: string
in path

(no description)

Request Example
{
  "name": "string",
  "metadata": "object"
}
200 OK

The updated group

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

DELETE /cat/groups/{id}

Disabling a pricing group makes sure it cannot me added to new settings

id: string
in path

(no description)

200 OK

The disabled group

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/groups/{id}/prices

Get a listing of prices that are stored in the group

x-page: string 1
in header

the requested page id

x-page-size: string 25
in header

the requested page size

id: string
in path

(no description)

country: string
in query

US - use to filter tax rate results

administrative_area: string
in query

Florida - use to filter tax rate results

200 OK

List of prices

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /cat/groups/{id}/prices

Query for a set of prices

undefined

id: string
in path

(no description)

Request Example
{
  "active_at": "string (date-time)",
  "constraints": [
    {
      "key": "string",
      "operator": "string",
      "values": [
        "string"
      ]
    }
  ]
}
200 OK

The new pricing group

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /cat/groups/{id}/prices

Create or update prices

CatNewPrice
id: string
in path

(no description)

Request Example
[
  {
    "sku": "string",
    "amount": "integer",
    "original_amount": "integer",
    "active_at": "string (date-time)"
  }
]
200 OK

The upsert results

type
object
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /cat/groups/{id}/prices/{sku}

View a historic or planned list of prices for a sku

x-page: string 1
in header

the requested page id

x-page-size: string 25
in header

the requested page size

id: string
in path

(no description)

sku: string
in path

(no description)

is_planned: string 1, 0 0
in query

Use to query only future / planned prices

200 OK

List of prices

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/prices/{id}

Get a single price by its ID

id: string
in path

(no description)

200 OK

The price

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

Vat

Get a list of vat rates

GET /cat/vat

Get a listing of vat rates per country

x-page: string 1
in header

the requested page id

x-page-size: string 25
in header

the requested page size

country: string
in query

US

administrative_area: string
in query

Florida

200 OK

List of vat groups

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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"
    ]
  }
}
Vat

Upsert vat rates for skus

PUT /cat/vat/products

Create or update the vat group per country for given skus

Request Example
[
  {
    "sku": "string",
    "rates": [
      {
        "country": "string",
        "administrative_area": "string",
        "reference": "integer"
      }
    ]
  }
]
200 OK

The upsert results

type
object
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/channels

Get a list of channels

is_deleted: string 0, 1 0
in query

(no description)

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

type: string
in query

(no description)

200 OK

The channel

type
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /cat/channels

Add a new channel

undefined

Request Example
{
  "name": "string",
  "type": "string",
  "description": "string",
  "client_id": "string"
}
200 OK

The channel

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/channels/{id}

Get a single channel

id: string
in path

(no description)

200 OK

The channel

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /cat/channels/{id}

Update an existing channel

undefined

id: string
in path

(no description)

Request Example
{
  "name": "string",
  "description": "string"
}
200 OK

The updated channel

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /cat/channels/{id}

Delete / disable an existing channel

id: string
in path

(no description)

204 No Content

Channel deleted

400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/contacts

Returns a list of contact information

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

200 OK

List of contacts

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /rel/contacts

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"
}
200 OK

The created / updated contact

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/contacts

Search contacts based on their id's or email addresses

undefined

Request Example
{
  "constraints": [
    {
      "key": "string",
      "operator": "string",
      "value": [
        "string"
      ]
    }
  ]
}
200 OK

The newly created invoice

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/contacts/{id}

Returns a single contact by id

id: string
in path

(no description)

version: string
in query

(no description)

200 OK

The contact data

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /rel/contacts/{id}

Delete a contact by id

id: string
in path

(no description)

204 No Content

Deleted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/contacts/{id}/versions

Returns a version list for the contact

id: string
in path

(no description)

200 OK

The versions

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/addresses

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"
}
200 OK

The newly created address

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/addresses/{id}

Returns a single address by id

id: string
in path

(no description)

200 OK

The address

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/search/address

Search addresses

undefined

Request Example
{
  "constraints": [
    {
      "key": "string",
      "operator": "string",
      "values": [
        "string"
      ]
    }
  ]
}
200 OK

The matched addresses

type
400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/search/phonenumbers

Search phone numbers

Request Example
{
  "constraints": [
    {
      "key": "string",
      "operator": "string",
      "values": [
        "string"
      ]
    }
  ]
}

The matched phone numbers

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/search/organisations

Search organisations

Request Example
{
  "constraints": [
    {
      "key": "string",
      "operator": "string",
      "values": [
        "string"
      ]
    }
  ]
}

The matched organisations

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /rel/addresses/{id}/geocode

Get lat long parameters for party address

id: string
in path

(no description)

The created id token

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/geocode

Get lat long parameters for party address

undefined

Request Example
{
  "country_code": "string",
  "address": "string"
}

The created id token

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/options/addresses

List required fields

country_code: string
in query

Defaults to country that can be linked to client IP

200 OK

The list of required fields

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/search/addresses

Start an search session

country_code: string
in query

(no description)

session_key: string
in query

(no description)

The newly created session token

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/search/addresses

Search an address

undefined

Request Example
{
  "session_key": "string",
  "context": "string",
  "query": "string"
}

The list of options

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/phonenumbers

Create a phonenumber

Request Example
{
  "country_code": "string",
  "number": "string"
}

The newly created phonenumber

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/phonenumbers/{id}

Returns a single phonenumber by id

id: string
in path

(no description)

The phonenumber

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/organisations

Returns a list of organisation information

x-page: string
in header

(no description)

x-page-size: string
in header

(no description)

List of organisations

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

POST /rel/organisations

Create an organisation

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

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

GET /rel/organisations/{id}

Returns a single organisation by id

id: string
in path

(no description)

version: string
in query

(no description)

The organisation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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

PUT /rel/organisations/{id}

Updates an existing organisation

id: string
in path

(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

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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 /rel/organisations/{id}

delete an existing organisation

id: string
in path

(no description)

The organisation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

500 Internal Server Error

Internal Server Error

503 Service Unavailable

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_