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.ioContact: 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:writeGrants write access for integrations
cat:channel:readGrants read access to channels
cat:channel:writeGrants write access to channels
cat:mapping:readGrants read access for mapping
cat:mapping:writeGrants write access for mapping
cat:prices:readRead product prices
cat:prices:writeWrite to product prices
cnt:files:readGrants read access for files
cnt:files:writeGrants write access to the file service
cnt:filesystems:readGrants filesystems read access
cnt:filesystems:writeGrants filesystems write access
cnt:index:readGrants tenant read access
cnt:index:writeUpdate definitions / add contents
cnt:instant:readGrants read access to instant search
cnt:instant:writeGrants write access to instant search
cnt:proxies:readGrants read access for proxies
cnt:proxies:writeGrants write access for proxies
cnt:video:readGrants read access for video / animated content
emailReturns email and verification status claims
iam:2fa:readGrants 2 factor authentication read access for current user
iam:2fa:writeGrants 2 factor authentication write access for current user
iam:audits:readRead audit logs
iam:customer:readGrants read access to customer data
iam:customer:writeGrants write access to customer data
iam:logs:readRead logs
iam:oauth:readGrants read access to oauth clients
iam:oauth:writeGrants write access to oauth clients
iam:roles:readGrants read access to rbac roles
iam:roles:writeGrants write access to rbac roles
iam:services:readGrants read access to services
iam:services:writeGrants write access to services
iam:sources:readGrants limited read access to customer payment sources
iam:sources:writeGrants write access to customer payment sources
iam:subscriptions:readGrants subscription read access
iam:subscriptions:writeGrants subscription write access
iam:tenants:readGrants tenant read access
iam:usage:readGrants usage read access
iam:users:readGrants read access to users
iam:users:writeGrants write access to users
int:afosto:writeGrants write access to bol.com
int:bol:writeGrants write access to bol.com
lcs:dpd:readGrants DPD read access
lcs:handling:readGrants read access for handling lists and parcels
lcs:handling:writeGrants write access for handling lists and parcels
lcs:locations:readGrants read access for fulfilment locations
lcs:locations:writeGrants write access for fulfilment locations
lcs:points:readGrants read access for parcel points
lcs:shipments:readGrants read access for shipments
lcs:shipments:writeGrants write access for shipments
mes:conversations:readGrants read access to conversations
mes:conversations:registerGrants access to register upon a conversation
mes:conversations:writeGrants write access to conversations
mes:domains:readGrants read access to domains
mes:domains:writeGrants write access to domains
mes:emails:readGrants email read access
mes:emails:writeGrants email write access
mes:inboxes:readGrants read access to inboxes
mes:inboxes:writeGrants write access to inboxes
mes:relays:readGrants read access for relays
mes:relays:writeGrants write access for relays
mes:subscriptions:readGrants subscription read access
mes:subscriptions:writeGrants subscription write access
mes:webhooks:readGrants subscription read access
odr:coupons:readGrants read access for coupons
odr:coupons:writeGrants write access coupons
odr:credit:readGrants read access for credit
odr:credit:writeGrants write access to credit
odr:invoices:createGrants create access for invoices
odr:invoices:readGrants read access for the invoices
odr:invoices:updateGrants update access for invoices
odr:metrics:readGrants read access for the metrics
odr:orders:readGrants read access for the orders
odr:orders:writeGrants write access to orders
odr:payments:updateGrants update access for payments
odr:providers:readGrants read access for the payment providers
odr:skus:writeGrants write access to skus for the stack service
odr:transactions:createGrants create access for transactions
openidReturns the sub / user id claim
profileReturns profile information claims
qcq:proxies:readGrants read access for proxies
qcq:proxies:writeGrants write access for proxies
rel:contacts:readGrants read access for the contacts
rel:contacts:writeGrants create access for address
rel:geocode:readgrants read access for geocoding
rel:identity:readgrants write access for identity
rel:identity:writegrants write access for identity
spl:hubs:readGrants read access for hubs
spl:hubs:writeGrants write access for hubs
spl:logs:readGrants read access to hub logs
spl:logs:writeGrants write access for logging hub information
spl:network:readGrants read access for network listings
spl:network:writeGrants write access for network listings
spl:printers:readGrants read access for printers
spl:printers:writeGrants write access for printers
spl:queue:createGrants create access to the queue
spl:queue:readGrants read access for the queued jobs
spl:queue:updateGrants update permission for jobs on the queue
tpl:themes:readGrants read access for themes
tpl:themes:writeGrants write access for themes
wms:claim:readGrants read access to claim
wms:claim:writeGrants write access to claim
wms:hops:readGrants read access to hops
wms:hops:writeGrants write access to hops
wms:item:readGrants read access to item
wms:item:writeGrants write access to item
wms:location:readGrants read access to location
wms:location:writeGrants write access to location
wms:route:readGrants read access to route
wms:route:writeGrants write access to route
wms:schedule:readGrants read access to schedule
wms:schedule:writeGrants write access to schedule
wms:sub:readGrants read access to sub
wms:sub:writeGrants write access to sub
wms:transfer:readGrants read access to transfer
wms:transfer:writeGrants write access to transfer
Apps
Apps
List apps
Returns list of apps
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
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
Activate a new app
undefined
code:
string
in path
(no description)
Request Example
{
"name": "string",
"credentials": "object",
"configuration": "object"
}
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)
{
"state": "string",
"redirect_url": "string"
}
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Integrations
List integrations
Returns list of active integrations
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)
200 OK
List of integrations
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": "integer",
"name": "string",
"configuration": "object",
"app_code": "string",
"is_installed": "boolean",
"active_at": "string (date-time)",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View integration
Get information for an integration
id:
string
in path
(no description)
200 OK
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
Update an integrations' configuration
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"credentials": "object",
"configuration": "object"
}
200 OK
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
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
List collections
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List collections
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",
"last_upsert_at": "string (date-time)",
"last_miss_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
View collection
View collection
id:
string
in path
(no description)
200 OK
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
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)
200 OK
List of msises for a collection
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",
"count": "integer",
"last_miss_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
List keys
List keys for a category
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
Upsert keys, create or update values
- 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
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 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
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
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
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
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 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
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
Create or update prices
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
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 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
Get a list of vat rates
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"
]
}
}
Upsert vat rates for skus
Create or update the vat group per country for given skus
Request Example
[
{
"sku": "string",
"rates": [
{
"country": "string",
"administrative_area": "string",
"reference": "integer"
}
]
}
]
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 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
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 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
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 / 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
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
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
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
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 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
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
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
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
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
Search phone numbers
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The matched phone numbers
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",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Search organisations
Search organisations
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The matched organisations
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",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
}
}
]
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Geocoding
Geocode address
Get lat long parameters for party address
id:
string
in path
(no description)
200 OK
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
Get lat long parameters for party address
undefined
Request Example
{
"country_code": "string",
"address": "string"
}
200 OK
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
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
Start an search session
country_code:
string
in query
(no description)
session_key:
string
in query
(no description)
200 OK
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
Search an address
undefined
Request Example
{
"session_key": "string",
"context": "string",
"query": "string"
}
200 OK
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
Create a phonenumber
undefined
Request Example
{
"country_code": "string",
"number": "string"
}
200 OK
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
Returns a single phonenumber by id
id:
string
in path
(no description)
200 OK
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
Returns a list of organisation information
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List of organisations
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",
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"administration": {
"email": "string"
},
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string",
"verification": {
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"phone_numbers": {
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
},
"billing": {
"primary": {
"id": "string",
"country_code": "string",
"administrative_area": "string",
"locality": "string",
"dependent_locality": "string",
"postal_code": "string",
"sorting_code": "string",
"address_line_1": "string",
"address_line_2": "string",
"thoroughfare": "string",
"premise_number": "integer",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"geo_location": {
"lat": "number",
"long": "number",
"box": {
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
},
"is_precise": "boolean",
"address": {
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
},
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelAddress"
]
}
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
Response Example (400 Bad Request)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (401 Unauthorized)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (403 Forbidden)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (404 Not Found)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (500 Internal Server Error)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Response Example (503 Service Unavailable)
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
Create a new organisation
Create an organisation
undefined
Request Example
{
"name": "string",
"file_id": "string",
"coc_number": "string",
"account_manager": "string",
"tags": [
"string"
],
"metadata": "object",
"registrations": [
{
"country_code": "string",
"number": "string"
}
],
"payment_settings": {
"post_payment": {
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
},
"invoice": {
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
},
"billing": {
"primary": "string",
"secondary": [
"string"
]
},
"shipping": {
"primary": "string",
"secondary": [
"string"
]
},
"phone_numbers": {
"primary": "string",
"secondary": [
"string"
]
},
"administration": {
"email": "string"
}
}
200 OK
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
Returns a single organisation by id
id:
string
in path
(no description)
version:
string
in query
(no description)
200 OK
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
Updates an existing organisation
undefined
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"
}
}
200 OK
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 an existing organisation
id:
string
in path
(no description)
200 OK
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"
]
}
}
View a list of versions for a a single organisation
Returns a version list for the organisation
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"
]
}
}
Identity
Create an identity
Returns a signed id token
undefined
client_id:
string
(uuid)
in query
context which to create the identity for
channel_id:
string
(uuid)
in query
context which to create the identity for
Request Example
{
"email": "string",
"password": "string",
"audience": "string"
}
200 OK
The created id token
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not found
409 Conflict
Identity already exists
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"token": "string",
"expires_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 (409 Conflict)
{
"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"
]
}
}
Check if the identity exists
Returns a 204 if the there exists an identity
undefined
Request Example
{
"email": "string",
"audience": "string"
}
204 No Content
The created id token
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Not found
409 Conflict
Identity already exists
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 (409 Conflict)
{
"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 token
Returns a new token to confirm identity or reset a password
undefined
client_id:
string
(uuid)
in query
context which to create the identity for
channel_id:
string
(uuid)
in query
context which to create the identity for
Request Example
{
"email": "string",
"type": "string",
"audience": "string"
}
200 OK
The created id token
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Entity not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"status": "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"
]
}
}
Reset a password
Pass a token to reset the password
undefined
client_id:
string
(uuid)
in query
context which to create the identity for
channel_id:
string
(uuid)
in query
context which to create the identity for
Request Example
{
"token": "string",
"password": "string"
}
200 OK
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)
{
"token": "string",
"expires_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"
]
}
}
Verify an identity
Mark the identity as verified
undefined
client_id:
string
(uuid)
in query
context which to create the identity for
channel_id:
string
(uuid)
in query
context which to create the identity for
Request Example
{
"token": "string"
}
200 OK
The created id token
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Entity not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"token": "string",
"expires_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"
]
}
}
Content
Barcode
Generate barcode
Render a barcode
t:
string
ean,
code_128,
code_39,
code_93,
qr
in query
Type of barcode
v:
string
in query
Value of the barcode
w:
integer
in query
Width of the barcode in pixels
h:
integer
in query
Height of the barcode in pixels
f:
string
code_128,
code_39,
code_93,
qr
in query
Fallback for failing (invalid) EAN barcodes
200 OK
The barcode
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 Content-Types: image/png
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"
]
}
}
Actions
List actions
Get a list of possible actions
200 OK
A list of actions
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",
"code": "string",
"description": "string",
"config_schema": "string",
"columns": [
{
"key": "string",
"description": "string",
"is_required": "boolean",
"regex": "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 action
Get a single action
id:
string
in path
(no description)
200 OK
A single action
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",
"code": "string",
"description": "string",
"config_schema": "string",
"columns": [
{
"key": "string",
"description": "string",
"is_required": "boolean",
"regex": "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"
]
}
}
Batches
List batches
Get a list of batches
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
code:
string
in query
(no description)
200 OK
A list of batches
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)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"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 batch
Create a new batch
undefined
Request Example
{
"action_id": "string",
"reference": "string",
"dataset_id": "string (uuid)",
"config": "object",
"import": {
"mapping": [
"object"
]
},
"export": {
"view": "string"
}
}
200 OK
The newly created batch
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)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"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"
]
}
}
Get batch
Get a single batch
id:
string
in path
(no description)
200 OK
Batch information
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)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"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 batch
Update a batch config or reference
undefined
id:
string
in path
(no description)
Request Example
{
"action_id": "string",
"reference": "string",
"dataset_id": "string (uuid)",
"config": "object",
"import": {
"mapping": [
"object"
]
},
"export": {
"view": "string"
}
}
200 OK
Batch information
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)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"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 batch
Delete an unconfirmed batch
id:
string
in path
(no description)
200 OK
Batch information
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)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"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"
]
}
}
Validate batch
Request validation for the batch and the dataset. The dataaset and the batch will be locked. When invalid, lock will be lifted. If batch is valid, is_accepted will become true
id:
string
in path
(no description)
200 OK
Accepted
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 Headers (200 OK)
| x-task-id |
Reference to backend task |
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"
]
}
}
Confirm batch
Confirm a batch for processing; processing will start. Only possible when batch is accepted
id:
string
in path
(no description)
200 OK
Accepted
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 Headers (200 OK)
| x-task-id |
Reference to backend task |
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 errors
Get a list of errors for a batch
id:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
Batch errors
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": "string (uuid)",
"errors": [
{
"column": "string",
"level": "string",
"message": "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"
]
}
}
Dataset
Get datasets
Get a set of rows
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
A set of lines
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)",
"reference": "string",
"line_count": "integer",
"file_id": "string",
"is_locked": "boolean",
"expires_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"
]
}
}
Create dataset
Add a new dataset container
undefined
Request Example
{
"reference": "string",
"expires_at": "string (date-time)"
}
200 OK
Accepted
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)",
"reference": "string",
"line_count": "integer",
"file_id": "string",
"is_locked": "boolean",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
Response Headers (200 OK)
| x-task-id |
Reference to backend task |
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 dataset
Get a set of rows
id:
string
in path
(no description)
200 OK
A set of lines
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)",
"reference": "string",
"line_count": "integer",
"file_id": "string",
"is_locked": "boolean",
"expires_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"
]
}
}
Read file
Select a file and read it to be used as input
undefined
id:
string
in path
(no description)
Request Example
{
"file_id": "string"
}
204 No Content
Accepted
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 Headers (204 No Content)
| x-task-id |
Reference to backend task |
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"
]
}
}
Upload data
Upload data as lines to the dataset
id:
string
in path
(no description)
Request Example
[
{
"reference": "string (uuid)",
"data": "object"
}
]
204 No Content
Received 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 Headers (204 No Content)
| x-task-id |
Reference to backend task |
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"
]
}
}
Export data
Request data to be exported to CSV
id:
string
in path
(no description)
204 No Content
Received request
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 Headers (204 No Content)
| x-task-id |
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 lines
Browse all dataset lines
id:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
A set of lines
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": "string (uuid)",
"data": "object"
}
]
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"
]
}
}
Proxy
Get the proxy configuration
Returns the proxy configuration
200 OK
Proxy configuration
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",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
Create a new proxy
Add a new proxy configuration
undefined
Request Content-Types: application/json
Request Example
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
200 OK
The proxy 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
Get the proxy configuration
Returns the proxy configuration
key:
string
in path
(no description)
200 OK
Proxy configuration
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",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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 the proxy configuration
Updates the proxy
undefined
key:
string
in path
(no description)
Request Content-Types: application/json
Request Example
{
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
200 OK
The signature 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
List all proxies
List all proxies for a tenant
x-page-size:
integer
25
in header
(no description)
x-page:
integer
1
in header
(no description)
200 OK
A list of proxies
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Create a new proxy for the tenant
undefined
Request Example
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
201 Created
The created proxy
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 (201 Created)
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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"
]
}
}
Show a proxy
Show a single proxy for the tenant
id:
string
in path
(no description)
200 OK
A proxy
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Update a proxy for the tenant
undefined
id:
string
in path
(no description)
Request Example
{
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
200 OK
The updated proxy
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Delete a new proxy for the tenant
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"
]
}
}
Watcher
List watchers
Get a list of watchers
200 OK
A list of watchers
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": "integer",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"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"
]
}
}
Create watcher
Create a watcher
undefined
Request Example
{
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
}
}
200 OK
A list of watchers
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": "integer",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"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"
]
}
}
Get watcher
Get a single watcher
id:
string
in path
(no description)
200 OK
A wachte
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",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"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 watcher
Update a single watcher
undefined
id:
string
in path
(no description)
Request Example
{
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
}
}
200 OK
A wachter
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",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"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 watcher
Delete a single watcher
id:
string
in path
(no description)
200 OK
A wachter
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",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"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"
]
}
}
Operations
Read object
Read the contents of an object at external storage
id:
integer
in path
(no description)
path:
string
in query
(no description)
200 OK
File contents
type
file
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)
"file"
Response Headers (200 OK)
| content-type |
application/octet-stream |
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"
]
}
}
Clone object
Clone an object to external storage
undefined
id:
integer
in path
(no description)
Request Example
{
"path": "string",
"file_id": "string"
}
204 No Content
File sync requested
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 Headers (204 No Content)
| x-task-id |
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"
]
}
}
Delete object
Delete an object at external storage
id:
integer
in path
(no description)
path:
string
in query
(no description)
204 No Content
Will delete the 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 (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 objects
List objects at external storage
id:
integer
in path
(no description)
path:
string
in query
(no description)
200 OK
Path contents
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)
[
{
"path": "string",
"basename": "string",
"type": "string",
"size": "integer"
}
]
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"
]
}
}
Storage
List storages
Get a list of storages
200 OK
A list of storages
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": "integer",
"name": "string",
"type": "string",
"configuration": "object",
"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"
]
}
}
Create storage
Add new external storage
undefined
Request Example
{
"name": "string",
"type": "string",
"configuration": "object",
"secret": "string"
}
200 OK
Tne new filesytem
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",
"type": "string",
"configuration": "object",
"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"
]
}
}
Get storage
Get a filesystem storage
id:
integer
in path
(no description)
200 OK
A list of storages
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",
"type": "string",
"configuration": "object",
"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"
]
}
}
Sync storage
Send a file to a storage
undefined
id:
integer
in path
(no description)
Request Example
{
"path": "string",
"file_id": "string"
}
204 No Content
File sync requested
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 Headers (204 No Content)
| x-task-id |
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"
]
}
}
Update storage
Update storage
undefined
id:
integer
in path
(no description)
Request Example
{
"name": "string",
"type": "string",
"configuration": "object",
"secret": "string"
}
200 OK
The updated storage
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",
"type": "string",
"configuration": "object",
"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 storage
Delete a storage
id:
integer
in path
(no description)
204 No Content
Store 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"
]
}
}
Upload storage
Send a file to a storage
undefined
id:
integer
in path
(no description)
Request Example
{
"path": "string",
"file_id": "string"
}
204 No Content
File sync requested
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 Headers (204 No Content)
| x-task-id |
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"
]
}
}
Read object
Read data from the storage
- path: string
id:
integer
in path
(no description)
path:
string
in query
path/to/file.csv
Request Example
{
"path": "path/to/file.csv"
}
200 OK
File contents
type
file
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)
"file"
Response Headers (200 OK)
| content-type |
application/octet-stream |
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 objects
Read data from the storage
- path: string
id:
integer
in path
(no description)
path:
string
in query
path/to/file.csv
Request Example
{
"path": "path/to/file.csv"
}
200 OK
Path contents
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)
[
{
"path": "string",
"basename": "string",
"type": "string",
"size": "integer"
}
]
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"
]
}
}
Test storage
Test storage connection
id:
integer
in path
(no description)
204 No Content
OK
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"
]
}
}
Test connection
Test a connection
undefined
Request Example
{
"type": "string",
"configuration": "object",
"secret": "string"
}
204 No Content
Connection is ok
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"
]
}
}
List adapters
List all filesystem adapters
200 OK
A list of filesystems adapter configurations
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)
[
{
"type": "ftp",
"schema": "ewoJIiRzY2hlbWEiOiAiaHR0cDovL2pzb24tc2NoZW1hLm9yZy9kcmFmdC0wNy9zY2hlbWEiLAoJIiRpZCI6ICJodHRwOi8vZXhhbXBsZS5jb20vZXhhbXBsZS5qc29uIiwKCSJ0eXBlIjogIm9iamVjdCIsCgkidGl0bGUiOiAiVGhlIHJvb3Qgc2NoZW1hIiwKCSJkZXNjcmlwdGlvbiI6ICJUaGUgcm9vdCBzY2hlbWEgY29tcHJpc2VzIHRoZSBlbnRpcmUgSlNPTiBkb2N1bWVudC4iLAoJImRlZmF1bHQiOiB7fSwKCSJhZGRpdGlvbmFsUHJvcGVydGllcyI6IHRydWUKfQ=="
}
]
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 logs
List all logs of sync calls
file_id:
string
in query
(no description)
storage_id:
integer
in query
(no description)
is_success:
string
in query
(no description)
200 OK
A list of filesystem logs
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)",
"file_id": "string",
"storage_id": "integer",
"is_success": "boolean",
"message": "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"
]
}
}
Types
List types
Get a list of flow types
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
code:
string
in query
(no description)
200 OK
A list of dataflow types
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)
[
{
"type": "string",
"code": "string",
"source": "string",
"trigger": "string",
"name": "string",
"is_proprietary": "boolean",
"events": [
"string"
],
"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 type
View a dataflow type
type:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
code:
string
in query
(no description)
200 OK
A list of dataflow types
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)
[
{
"type": "string",
"code": "string",
"source": "string",
"trigger": "string",
"name": "string",
"is_proprietary": "boolean",
"events": [
"string"
],
"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"
]
}
}
Flows
List dataflows
Get a list of flows
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
A list of dataflows
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",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": "string"
},
"config": "object",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"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 dataflow
Add a new dataflow
undefined
Request Example
{
"name": "string",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": {
"schedule": "string",
"timezone": "string"
}
},
"config": "object",
"secret": "string",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The new flow
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",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": "string"
},
"config": "object",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"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"
]
}
}
Get dataflow
Get a single dataflow
id:
string
in path
(no description)
200 OK
A single dataflow
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",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": "string"
},
"config": "object",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"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 dataflow
Update a single dataflow
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": {
"schedule": "string",
"timezone": "string"
}
},
"config": "object",
"secret": "string",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
Resulting dataflow
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",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": "string"
},
"config": "object",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"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 dataflow
Delete a single dataflow
id:
string
in path
(no description)
204 No Content
Deleted dataflow
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"
]
}
}
Trigger flow
Trigger an existing flow
- entity_id: string (uuid)
- clock_at: string (date-time)
id:
string
in path
(no description)
Request Example
{
"entity_id": "string (uuid)",
"clock_at": "string (date-time)"
}
204 No Content
The flow is being performed
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 Headers (204 No Content)
| 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"
]
}
}
Tester
Load data
Multi data loader
- reference: string
- entity_id: string
- entity_type: string
Request Example
[
{
"reference": "shipment_23144235",
"entity_id": "string",
"entity_type": "string"
}
]
200 OK
The data that is used to perform a flow with this data-type
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)
[
{
"reference": "shipment_23144235",
"data": "object"
}
]
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 data
Get the data-model as it is applied
model:
string
in path
(no description)
id:
string
in path
(no description)
200 OK
The data that is used to perform a flow with this data-type
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)
"object"
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"
]
}
}
Test match
Test if a flow matches the data
model:
string
in path
(no description)
id:
string
in path
(no description)
200 OK
The match results and input that was used to match against
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)
{
"result": {
"is_match": false,
"misses": {
"keys": [
"order.settings.contact.id"
],
"configs": [
"brand"
]
}
},
"input": {
"order.id": "26cfb69d-94cd-4213-b428-b5851419ccf8",
"order.number": "ODR-10000546",
"order.settings.contact.id": "gsrfiajgpw85jgop8w5j65p948ej56wip5jsa4eop5jiaerg",
"order.settings.contact.email": "peter@afosto.com"
}
}
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"
]
}
}
Video
Get info
Returns information regarding the GIF
url:
string
in query
the requested URL
200 OK
The list of orders
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)
{
"is_animated": "boolean",
"height": "integer",
"width": "integer",
"loop_count": "integer",
"size": "integer"
}
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"
]
}
}
Transform gif
Returns information regarding the GIF
url:
string
in query
the requested URL
206 Partial Content
The transcoded MP4
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"
]
}
}
Directories
Get list of directories
Returns a list of directories
dir:
string
in query
(no description)
200 OK
Directory list
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)
{
"directories": [
"emails"
]
}
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 directory
Add a directory
undefined
Request Example
{
"path": "string"
}
204 No Content
Directory created
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"
]
}
}
Delete directory
Deletes a directory
undefined
Request Example
{
"path": "string"
}
204 No Content
Directory 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"
]
}
}
Files
Get list of files
Returns a list of files
dir:
string
in query
(no description)
is_public:
string
1,
0
in query
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
File list
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",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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 a file
Returns a file
id:
string
in path
(no description)
200 OK
File list
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",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"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 a file
Deletes a file
id:
string
in path
(no description)
200 OK
The deleted file
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",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"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"
]
}
}
Create an upload signature
Returns a new upload signature
undefined
Request Content-Types: application/json
Request Example
{
"is_public": "boolean",
"path": "string",
"is_listed": "boolean",
"method": "string",
"metadata": "object"
}
200 OK
The signature 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 Content-Types: application/json
Response Example (200 OK)
{
"expires_at": "string (date-time)",
"signature": "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"
]
}
}
Upload a file
Upload a new file
signature:
string
in path
(no description)
file:
file
in formData
(no description)
200 OK
File list
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",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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"
]
}
}
Index
Run a simple search
Run a search with the option to run an aggregation
Query object
x-page:
string
in header
(no description)
x-page-size:
integer
25
in header
(no description)
Request Example
{
"codes": [
"string"
],
"models": [
"string"
],
"namespaces": [
"string"
],
"q": [
"string"
],
"is_fuzzy": "boolean",
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string"
}
200 OK
The search results
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": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
Response Headers (200 OK)
| x-page |
The next page cursor |
string |
| x-count |
Total item count |
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"
]
}
}
Run a complex search
Run a complex search
Query object
namespace:
string
default
in path
the namespace
code:
string
in path
(no description)
model:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
integer
25
in header
(no description)
Request Example
{
"q": [
"string"
],
"is_fuzzy": "boolean",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"missing": [
"string"
],
"facets": [
"string"
],
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string",
"sort": [
{
"key": "string",
"order": "string"
}
]
}
200 OK
The search results
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": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
Response Headers (200 OK)
| x-page |
The next page cursor |
string |
| x-count |
Total item count |
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 some suggestions
Run a simple, fast suggest search
q:
string
in query
The query
limit:
integer
5
in query
The query
codes:
string[]
in query
The query
models:
string[]
in query
The models we want to query
namespaces:
string[]
in query
The namesapce we want to query
200 OK
The suggestions
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": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
]
}
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 definitions
List the set of definitions
code:
string
in query
(no description)
model:
string
in query
(no description)
namespace:
string
in query
(no description)
200 OK
The search results
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",
"namespace": "string",
"code": "string",
"model": "string",
"filters": [
{
"key": "string",
"type": "string"
}
],
"tenant_id": "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"
]
}
}
Upsert a definition
Either create a new, or update an existing definition
Query object
Request Example
{
"namespace": "string",
"code": "string",
"model": "string",
"key": "string",
"type": "string"
}
200 OK
The search results
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",
"namespace": "string",
"code": "string",
"model": "string",
"filters": [
{
"key": "string",
"type": "string"
}
],
"tenant_id": "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"
]
}
}
Decode filter
Decode a relative date filter
input:
string
in query
(no description)
200 OK
The epoch timestamp
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)
{
"query": {
"quantity": "integer",
"key": "string",
"direction": "string",
"at": {
"timezone": "string",
"hour": "string",
"minute": "string",
"day_of_week": "string",
"day_of_month": "string"
}
},
"epoch": 1593505091,
"formatted": "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"
]
}
}
Relative date
Generate a relative date filter
Query object
Request Example
{
"quantity": "integer",
"key": "string",
"direction": "string",
"at": {
"timezone": "string",
"hour": "string",
"minute": "string",
"day_of_week": "string",
"day_of_month": "string"
}
}
200 OK
The epoch timestamp
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)
{
"epoch": 1593505091,
"formatted": "string (date-time)",
"filter": "_eyJxdWFudGl0eSI6NCwia2V5IjoibW9udGhzIiwiZGlyZWN0aW9uIjoiYWhlYWQiLCJhdCI6eyJob3VycyI6bnVsbCwibWludXRlcyI6bnVsbCwiZGF5X29mX3dlZWsiOm51bGwsImRheV9vZl9tb250aCI6Imxhc3QifX0="
}
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 all indexes
List all indexes for the authenticated user.
x-page-size:
integer
25
in header
(no description)
x-page:
integer
1
in header
(no description)
200 OK
A list of indexes
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",
"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 a new index
Create a new index
undefined
Request Example
{
"name": "string"
}
201 Created
The created index
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 (201 Created)
{
"id": "string (uuid)",
"name": "string",
"host": "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"
]
}
}
Show a single index
Show a single index for the tenant.
id:
string
in path
(no description)
200 OK
A single index
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",
"host": "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 a single index
Update a single index
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string"
}
200 OK
The updated index
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",
"host": "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 a single index
Delete a single index
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"
]
}
}
Create PDF
Transform HTML into a PDF
undefined
Request Example
{
"path": "string",
"filename": "string",
"size": {
"predefined": "string",
"width": "integer",
"height": "integer"
},
"margin": {
"top": "integer",
"bottom": "integer",
"left": "integer",
"right": "integer"
},
"method": "string",
"content": "string (base64)",
"wait_delay": "integer",
"wait_timeout": "integer"
}
200 OK
The reference to the generated file
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",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"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"
]
}
}
Get inline-PDF
Transform HTML into a PDF and return PDF as string
undefined
Request Example
{
"size": {
"predefined": "string",
"width": "integer",
"height": "integer"
},
"margin": {
"top": "integer",
"bottom": "integer",
"left": "integer",
"right": "integer"
},
"content": "string (base64)",
"wait_delay": "integer",
"wait_timeout": "integer"
}
200 OK
File contents
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"
]
}
}
Fulfilment
Handling
Get list of handling lists
Returns a list of handling lists
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List of Pick lists
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",
"number": "string",
"sub": "string",
"location_id": "string",
"shipments": [
"string"
],
"is_outbound": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_cancelled": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"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 handling list
Add a new handling list
undefined
Request Example
{
"shipments": [
{
"id": "string (uuid)",
"label": "string"
}
],
"due_at": "string (date-time)"
}
200 OK
The newly created shipment
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",
"sub": "string",
"shipments": [
"string"
],
"location_id": "string",
"is_outbound": "boolean",
"is_assigned": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_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"
]
}
}
Search a set of lists
Search for a set of lists
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The search results
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",
"number": "string",
"sub": "string",
"location_id": "string",
"shipments": [
"string"
],
"is_outbound": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_cancelled": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"items": [
{
"ids": [
"string"
],
"handled_ids": [
"string"
],
"shipment_id": "string",
"sku": "string",
"description": "string",
"position": "string",
"quantity": "integer",
"sorting_label": "string",
"rank": "integer"
}
],
"sorting_labels": [
{
"shipment_id": "string (uuid)",
"label": "string"
}
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 handling list
Returns a handling list
id:
string
in path
(no description)
200 OK
Detailed handling list view
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",
"number": "string",
"sub": "string",
"location_id": "string",
"shipments": [
"string"
],
"is_outbound": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_cancelled": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"items": [
{
"ids": [
"string"
],
"handled_ids": [
"string"
],
"shipment_id": "string",
"sku": "string",
"description": "string",
"position": "string",
"quantity": "integer",
"sorting_label": "string",
"rank": "integer"
}
],
"sorting_labels": [
{
"shipment_id": "string (uuid)",
"label": "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 a handling list
Delete a handling list
id:
string
in path
(no description)
204 No Content
Deleted handling list
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"
]
}
}
Update a handling list's items
Update items' state on a handling list
id:
string
in path
(no description)
Request Example
[
{
"id": "string",
"is_handled": "boolean",
"is_serviced": "boolean",
"is_finished": "boolean",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
]
204 No Content
Resulting success count
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 (204 No Content)
{
"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"
]
}
}
Update a handling list state
Update state of an handling list
undefined
id:
string
in path
(no description)
Request Example
{
"is_on_hold": "boolean",
"sub": "string"
}
204 No Content
Handling list state updated
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"
]
}
}
Shipments
List shipments
Get a list of shipments
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
The newly created shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_canceled": "boolean",
"secret": "string",
"prior_shipments": [
"string (uuid)"
],
"list_id": "string",
"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 shipment
Add a new shipment to the list
undefined
Request Example
{
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"is_outbound": "boolean",
"type": "string",
"items": [
{
"sku": "string",
"reference": "string",
"position": "string",
"quantity": "integer",
"description": "string",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
],
"references": [
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"expected_at": "string (date-time)",
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"prior_shipments": [
"string (uuid)"
]
}
200 OK
The newly created shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean"
}
]
}
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 shipment
Returns a single shipment
id:
string
in path
(no description)
200 OK
Detailed shipment view
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean"
}
]
}
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 shipment
Update the shipment method or addressing
undefined
id:
string
in path
(no description)
Request Example
{
"type": "string",
"method_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"prior_shipments": [
"string (uuid)"
],
"expected_at": "string (date-time)",
"ship_at": "string (date-time)"
}
200 OK
Detailed view for shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean"
}
]
}
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"
]
}
}
Cancel shipment
Cancel a shipment
id:
string
in path
(no description)
204 No Content
Shipment canceled
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"
]
}
}
Refresh positions
Refresh a shipment's positions to the latest known defaults
id:
string
in path
(no description)
204 No Content
Positions refreshed
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"
]
}
}
Invoice shipment
Manually trigger an invoice
id:
string
in path
(no description)
204 No Content
Invoice requested
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
Search a shipment
Search for a set of shipments
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
200 OK
The newly created shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_canceled": "boolean",
"secret": "string",
"prior_shipments": [
"string (uuid)"
],
"list_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 a fulfilment location
Search for a set of fulfilment locations
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The location set
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",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 a parcel
Search for a set of parcels
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The parcel set
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",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean",
"is_finished": "boolean",
"file_id": "string",
"ship_at": "string (date-time)",
"in_transit_at": "string (date-time)",
"finished_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 items
List items on handling list
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
200 OK
Resulting success count
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)
[
{
"ids": [
"string"
],
"sku": "string",
"quantity": "integer",
"hs_code": "string",
"description": "string",
"references": [
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
],
"lists": [
{
"id": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
],
"parcels": [
"#/definitions/LcsGroupedShipmentItemLists"
],
"positions": [
{
"code": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
],
"handled_ids": [
"string (uuid)"
],
"boxed_ids": [
"string (uuid)"
],
"listed_ids": [
"string (uuid)"
],
"finished_ids": [
"string (uuid)"
],
"missing_ids": [
"string (uuid)"
],
"shipment_id": "string (uuid)",
"totals": {
"boxed": "integer",
"handled": "integer",
"finished": "integer",
"missing": "integer",
"listed": "integer"
}
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 shipment methods
Search for shipment methods
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
Resulting success count
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",
"carrier_code": "string",
"name": "string",
"label": "string",
"description": "string",
"max_weight": "integer",
"countries": [
{
"code": "string",
"amount": "integer"
}
],
"delivery_during": "string",
"is_configured": "boolean",
"is_same_day": "boolean",
"is_sunday": "boolean",
"is_carrier_location": "boolean",
"is_neighbour_allowed": "boolean",
"provider_method_id": "string",
"provider": "string",
"is_enabled": "boolean",
"priority": "integer"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 items
Search items on handling list
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
200 OK
Resulting success count
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)
[
{
"ids": [
"string"
],
"handled_ids": [
"string"
],
"shipment_id": "string",
"sku": "string",
"description": "string",
"position": "string",
"quantity": "integer",
"sorting_label": "string",
"rank": "integer"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 items
Search parcel items
undefined
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
200 OK
Resulting success count
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",
"quantity": "integer",
"description": "string"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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"
]
}
}
Bulk
Bulk change
Update items in bulk
- command: string set_parameters
- parameters: object
-
possible keys are: [position], [parcel_id], [is_handled], [is_finished], [is_missing], [lot_number] [expires_at]
- constraints: LcsItemSearchConstraint
-
LcsItemSearchConstraint
Request Example
{
"command": "string",
"parameters": {
"is_handled": true
},
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
204 No Content
Executed command succesfully
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"
]
}
}
Items
Update a shipment's backorder items
Update the shipment's items that are backorder
id:
string
in path
(no description)
Request Example
[
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
]
200 OK
Detailed view for shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean"
}
]
}
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 shipment's overage
Update items that were not expected
id:
string
in path
(no description)
Request Example
[
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
]
200 OK
Detailed view for shipment
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",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean"
}
]
}
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"
]
}
}
Set missing
Update items that are missing
id:
string
in path
(no description)
Request Example
[
{
"id": "string (uuid)",
"is_missing": "boolean"
}
]
204 No Content
Items updated
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"
]
}
}
Methods
List methods
List all methods
country_code:
string
in query
(no description)
channel_id:
string
in query
(no description)
200 OK
The list of methods
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",
"carrier_code": "string",
"name": "string",
"label": "string",
"description": "string",
"max_weight": "integer",
"countries": [
{
"code": "string",
"amount": "integer"
}
],
"delivery_during": "string",
"is_configured": "boolean",
"is_same_day": "boolean",
"is_sunday": "boolean",
"is_carrier_location": "boolean",
"is_neighbour_allowed": "boolean",
"provider_method_id": "string",
"provider": "string",
"is_enabled": "boolean",
"priority": "integer"
}
]
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 method
List all methods
id:
string
in path
(no description)
country_code:
string
in query
(no description)
channel_id:
string
in query
(no description)
200 OK
The list of methods
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",
"carrier_code": "string",
"name": "string",
"label": "string",
"description": "string",
"max_weight": "integer",
"countries": [
{
"code": "string",
"amount": "integer"
}
],
"delivery_during": "string",
"is_configured": "boolean",
"is_same_day": "boolean",
"is_sunday": "boolean",
"is_carrier_location": "boolean",
"is_neighbour_allowed": "boolean",
"provider_method_id": "string",
"provider": "string",
"is_enabled": "boolean",
"priority": "integer"
}
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"
]
}
}
Parcels
List parcels
List all parcels
x-page:
integer
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
The list of parcels
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",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean",
"is_finished": "boolean",
"file_id": "string",
"ship_at": "string (date-time)",
"in_transit_at": "string (date-time)",
"finished_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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 parcel
Add a new parcel to the list
undefined
Request Example
{
"shipment_id": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"item_ids": [
"string"
]
}
200 OK
The newly created parcel
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",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean",
"is_finished": "boolean",
"file_id": "string",
"ship_at": "string (date-time)",
"in_transit_at": "string (date-time)",
"finished_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 parcel
Get a single parcel
id:
string
in path
(no description)
200 OK
The requested parcel
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",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean",
"is_finished": "boolean",
"file_id": "string",
"ship_at": "string (date-time)",
"in_transit_at": "string (date-time)",
"finished_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 parcel
Update the parcel parameters
undefined
id:
string
in path
(no description)
Request Example
{
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"ship_at": "string (date-time)",
"tracking_code": "string",
"tracking_url": "string",
"position": "string"
}
204 No Content
Updated the parcel settings
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"
]
}
}
Remove a parcel
Remove a parcel
id:
string
in path
(no description)
204 No Content
Deleted the parcel
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"
]
}
}
Add items to parcel
Add items to a parcel
undefined
id:
string
in path
(no description)
Request Example
{
"ids": [
"string"
]
}
200 OK
The updated parcel
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": 12,
"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"
]
}
}
Remove items from parcel
Remove items from parcel
undefined
id:
string
in path
(no description)
Request Example
{
"ids": [
"string"
]
}
200 OK
The newly created parcel
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": 12,
"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"
]
}
}
Mark transit
Mark parcel as in-transit
id:
string
in path
(no description)
204 No Content
Updated the parcel state
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"
]
}
}
Mark finished
Mark parcel as finished
id:
string
in path
(no description)
204 No Content
Updated the parcel state
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"
]
}
}
Request label
Requests a label for the parcel
id:
string
in path
(no description)
204 No Content
Requesting a label
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 Headers (204 No Content)
| x-task-id |
Reference to the task |
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"
]
}
}
Request slip
Requests packing slip
id:
string
in path
(no description)
204 No Content
Requesting a packing slip
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 Headers (204 No Content)
| x-task-id |
Reference to the task |
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"
]
}
}
Fulfilment
Get list of fulfilment locations
Returns a list of fulfilment locations
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
address_id:
string
in query
(no description)
is_disabled:
string
1,
0
in query
(no description)
200 OK
List of locations
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",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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"
]
}
}
Add a new fulfilment location
Create a new fulfilment location
undefined
Request Example
{
"name": "string",
"address_id": "string",
"is_disabled": "boolean"
}
200 OK
The created location
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",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"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"
]
}
}
Get a fulfilment location
Returns a fulfilment location
id:
string
in path
(no description)
200 OK
The location
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",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"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 fulfilment location
Updates a location
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"address_id": "string",
"is_disabled": "boolean"
}
200 OK
The location
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",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"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"
]
}
}
Get list of positions within a fulfilment location
Returns a list of fulfilment locations
id:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
List of positions
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",
"sorting": "integer",
"skus": [
{
"sku": "string",
"position": "string",
"created_at": "string (date-time)"
}
],
"created_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"
]
}
}
Reorder the positions within a location
Updates the position order for a location
id:
string
in path
(no description)
Request Example
[
"A3.32435"
]
200 OK
New list of positions
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 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"
]
}
}
Reorder the positions within a location
Updates the position order for a location
id:
string
in path
(no description)
Request Example
[
"A3.32435"
]
200 OK
New list of positions
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 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 position
Returns a single positino
id:
string
in path
(no description)
code:
string
in path
(no description)
200 OK
The position
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",
"sorting": "integer",
"skus": [
{
"sku": "string",
"position": "string",
"created_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"
]
}
}
Search a set of positions
Searches a set of positions based on sku's
id:
string
in path
(no description)
Request Example
[
"A3.32435"
]
200 OK
List of positions
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)
{
"sku": "string",
"position": "string",
"created_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"
]
}
}
Get list of sku's that are listed for the fulfilment location
Returns a list of fulfilment locations
id:
string
in path
(no description)
200 OK
List of sku's
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)
[
{
"sku": "string",
"position": "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"
]
}
}
Update one or more sku's for the location
Updates the position order for a location
id:
string
in path
(no description)
Request Example
[
{
"sku": "string",
"position": "string",
"created_at": "string (date-time)"
}
]
200 OK
New list of positions
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": 12,
"failed": 0
}
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"
]
}
}
List service points
List all service points
carrier:
string
in path
(no description)
country_code:
string
in query
(no description)
postal_code:
string
in query
(no description)
channel_id:
string
in query
(no description)
200 OK
The list of methods
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)
[
{
"distance": "number",
"point": {
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longitude": "number (float64)",
"address": {
"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": "number",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "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 a service point
Returns a single service
id:
string
in path
(no description)
carrier:
string
in path
(no description)
country_code:
string
in query
(no description)
channel_id:
string
in query
(no description)
200 OK
The list of methods
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",
"carrier": "string",
"latitude": "number (float64)",
"longitude": "number (float64)",
"address": {
"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": "number",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "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"
]
}
}
IAM
Logging
Query logs
Query audit and system logs
Log object
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"limit": "integer",
"offset": "integer"
}
200 OK
The results
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)",
"category": "string",
"code": "string",
"resource": {
"trace": "string",
"stream": "string",
"entity_type": "string",
"entity_id": "string (uuid)"
},
"actor": {
"entity_type": "string",
"entity_id": "string"
},
"metadata": "object",
"processed_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
a cursored header with the next page, and offset in it |
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"
]
}
}
Export logs
Export audit and system logs
Log object
Request Example
{
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"limit": "integer",
"offset": "integer"
}
204 No Content
Export started
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 Headers (204 No Content)
| 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"
]
}
}
2fa
Create a secret / enable 2FA
Create a new secret for 2FA
Secret request
type:
string
in path
Type that we look for
Request Example
{
"name": "string",
"backups": [
{
"channel": "string",
"address": "string"
}
]
}
200 OK
The secret that was created
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",
"type": "string",
"sub": "string",
"name": "string",
"secret": "string",
"is_confirmed": "boolean",
"qr_url": "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"
]
}
}
Get secret information
Get the secret for the type for the current user
type:
string
in path
Type that we look for
200 OK
The secret that matches the query
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",
"type": "string",
"sub": "string",
"name": "string",
"secret_last_4": "string",
"is_confirmed": "boolean",
"backups": [
{
"channel": "string",
"address": "string"
}
],
"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 secret
Update an existing secret for 2FA
Secret request
type:
string
in path
Type that we look for
Request Example
{
"backups": [
{
"channel": "string",
"address": "string"
}
]
}
200 OK
The secret that was created
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",
"type": "string",
"sub": "string",
"name": "string",
"secret_last_4": "string",
"is_confirmed": "boolean",
"backups": [
{
"channel": "string",
"address": "string"
}
],
"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 2FA
Delete the secret and disable 2FA
type:
string
in path
Type that needs to be deleted
200 OK
The secret that was 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 (200 OK)
{
"id": "string",
"type": "string",
"sub": "string",
"name": "string",
"secret_last_4": "string",
"is_confirmed": "boolean",
"backups": [
{
"channel": "string",
"address": "string"
}
],
"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"
]
}
}
Verify an otp
Verify if one time password was created with known secret
Validation request object
type:
string
in path
Type that we look for
Request Example
{
"otp": "string"
}
200 OK
The validation response
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)
{
"is_verified": "boolean"
}
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"
]
}
}
Request a backup code over the requested channel
Request a otp over the given channel
type:
string
in path
Type that we look for
channel:
string
in path
Channel of choice
200 OK
The validation response
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)
{
"address": "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"
]
}
}
Subscription
Obtain billing information
Customer information regarding billing data
200 OK
Cards that are available
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)
{
"name": "string",
"vat_number": "string",
"billing_email": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "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"
]
}
}
Update billing information
Update customer information regarding billing data
Email object
Request Example
{
"name": "string",
"vat_number": "string",
"billing_email": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
}
200 OK
Cards that are available
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)
{
"name": "string",
"vat_number": "string",
"billing_email": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "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"
]
}
}
Obtain a list of payment sources
List of payment sources
200 OK
Sources that are available
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",
"last_4": "string",
"name": "string",
"is_default": "boolean",
"brand": "string",
"expires_at": "string (date-time)",
"mandate": "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"
]
}
}
Merge a payment source to a user
Add a payment source
- source: string
Request Example
{
"source": "string"
}
200 OK
Sources that are available
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",
"last_4": "string",
"name": "string",
"is_default": "boolean",
"brand": "string",
"expires_at": "string (date-time)",
"mandate": "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"
]
}
}
Remove a payment source from the user
Remove an active payment source
id:
string
in path
(no description)
200 OK
Sources that are available
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",
"last_4": "string",
"name": "string",
"is_default": "boolean",
"brand": "string",
"expires_at": "string (date-time)",
"mandate": "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"
]
}
}
Obtain a list of products
List products
200 OK
Products that are available
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",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
}
]
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"
]
}
}
Obtain a live list of active subscriptions
List of subscribed products
200 OK
List of active subscriptions
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",
"code": "string",
"is_renewing": "boolean",
"start_at": "string (date-time)",
"end_at": "string (date-time)",
"items": [
{
"id": "string",
"product": {
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
},
"type": "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"
]
}
}
Subscribe to a service
Add a product to the subscription
undefined
Request Example
{
"code": "string"
}
200 OK
List of active subscriptions
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",
"unit": "string",
"quantity": "integer"
}
]
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"
]
}
}
Subscribe to an add on
Add an add on to a subscription
undefined
Request Example
{
"id": "string"
}
200 OK
List of active subscriptions
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",
"unit": "string",
"quantity": "integer"
}
]
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"
]
}
}
Obtain a live list of active invoices
List of the invoices
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List of active subscriptions
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",
"total": "integer",
"is_paid": "boolean",
"is_pending": "boolean",
"is_cancelled": "boolean",
"invoiced_at": "string (date-time)",
"reference": "string",
"products": [
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
}
],
"pdf": "string",
"payment_url": "string",
"start_at": "string (date-time)",
"end_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"
]
}
}
Obtain a live projection of the upcoming invoice
Get information about the next invoice
code:
string
in query
cnt
200 OK
List of active subscriptions
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",
"total": "integer",
"is_paid": "boolean",
"is_cancelled": "boolean",
"invoiced_at": "string (date-time)",
"reference": "string",
"products": [
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"quantity": "integer",
"amount": "integer",
"is_trial": "boolean",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
}
}
],
"start_at": "string (date-time)",
"end_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"
]
}
}
Obtain a live projection of the trial status
Get information about the trial
200 OK
List of active subscriptions
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)
{
"is_on_trial": "boolean",
"trial_balance": "integer",
"trial_ends_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"
]
}
}
Obtain a live list of active subscriptions
List of subscribed products
undefined
Request Example
{
"code": "string",
"unit": "string"
}
200 OK
List of active subscriptions
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",
"unit": "string",
"quantity": "integer"
}
]
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"
]
}
}
Audit
Get the audit log
Returns a list of logs.
x-page:
string
in header
The page token
x-page-size:
string
in header
The amount of results for the page
method:
string
in query
The method filter
resource:
string
in query
The resource filter
user:
string
in query
The user filter
logged_after:
string
in query
Timestamp to filter log date
200 OK
List of audit lines
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",
"method": "string",
"resource": "string",
"user": "string",
"metadata": "object",
"logged_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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 the audit log filters
Returns a list of filters for logs.
200 OK
List of audit filters
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)
{
"resource": [
"jwt"
],
"method": [
"authorize"
],
"user": [
"peter@afosto.com"
]
}
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"
]
}
}
Tenants
Create a new tenant
Returns a new authorization response
Signup object
Request Example
{
"company": {
"name": "string",
"vat_number": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
},
"user": {
"email": "string",
"password": "string",
"first_name": "string",
"last_name": "string"
}
}
200 OK
Tenant and user information
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)
{
"tenant": {
"id": "string",
"name": "string",
"is_active": "boolean",
"stripe_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
},
"user": {
"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Get a info about tenant
Return the current tenant information
id:
string
in path
Id that belongs to the tenant
200 OK
Tenants model
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_active": "boolean",
"stripe_id": "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 company name
Update the company name
- name: string
id:
string
in path
Id that belongs to the tenant
Request Example
{
"name": "CompanyName"
}
200 OK
Tenants model
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_active": "boolean",
"stripe_id": "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"
]
}
}
Request token
Requests a purge token
Purge request
- domains: string[]
-
string rel:contacts, rel:organisations, rel:addresses, rel:phonenumbers, rel:identities, rel:tokens, lcs:shipments, odr:orders, odr:invoices, odr:calculations, odr:transactions
Request Example
{
"domains": [
"string"
]
}
200 OK
Token data
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)
{
"id": "string (uuid)",
"name": "Account Admin",
"email": "admin@example.org"
}
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 token
View a purge token
token:
string
in path
(no description)
200 OK
Token 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": "integer",
"domains": [
"string"
],
"expires_at": "string (date-time)",
"token": "string",
"requester": "string",
"signer": "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"
]
}
}
Apply token
Start purge for token
token:
string
in path
(no description)
200 OK
Token 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": "integer",
"domains": [
"string"
],
"expires_at": "string (date-time)",
"token": "string",
"requester": "string",
"signer": "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"
]
}
}
Subtenants
Get a list of accessible subtenants
Returns a list of subtenants
200 OK
List of users
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",
"company": "string",
"state": "string",
"tenant_id": "string",
"signee": "string",
"type": "string",
"roles": [
"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"
]
}
}
Get a list of pending invites to subtenants
Returns a list of subtenants
state:
string
pending,
denied
pending
in query
(no description)
200 OK
List of users
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",
"company": "string",
"state": "string",
"tenant_id": "string",
"signee": "string",
"type": "string",
"roles": [
"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"
]
}
}
Get the default tenant
Returns the default tenant
200 OK
Default subtenant
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",
"company": "string",
"state": "string",
"tenant_id": "string",
"signee": "string",
"type": "string",
"roles": [
"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"
]
}
}
Update the state of an invite
Updates the invite state
- state: string approved, declined
id:
string
in path
(no description)
Request Example
{
"state": "string"
}
200 OK
List of users
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",
"company": "string",
"state": "string",
"tenant_id": "string",
"signee": "string",
"type": "string",
"roles": [
"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"
]
}
}
Get a list of pending subtenant requests
Returns a list of subtenants
200 OK
List of users
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",
"state": "string",
"signee": "string",
"roles": [
"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"
]
}
}
Send a request to access another tenant
Create a new subtenant request
- signee: string
- roles: string[]
-
string
Request Example
{
"signee": "user@example.org",
"roles": [
"string"
]
}
200 OK
The created request
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",
"state": "string",
"signee": "string",
"roles": [
"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"
]
}
}
Users
Get a list of users
Returns a list of users
is_pending_invite:
integer
1,
0
in query
(no description)
is_deleted:
integer
1,
0
0
in query
(no description)
x-page-size:
integer
in header
(no description)
x-page:
string
in header
(no description)
200 OK
List of users
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Create a new user
Returns a new authorization response
User object
Request Example
{
"email": "string",
"password": "string",
"first_name": "string",
"last_name": "string"
}
200 OK
Created user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Get a single user by id
Returns a single user
id:
string
in path
Id that belongs to the user
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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 user by id
Updates a user
User object
id:
string
in path
Id that belongs to the user
Request Example
{
"first_name": "string",
"last_name": "string"
}
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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 a user by id
Deletes a user
id:
string
in path
Id that belongs to the user
200 OK
The deleted user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Get a list of tokens
Returns a list of tokens
type:
string
in query
(no description)
id:
string
in path
Id that belongs to the user
200 OK
List of users
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",
"expires_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 user's roles by id
Updates the roles that belong to a user
Array of role id's
id:
string
in path
Id that belongs to the user
Request Example
[
"string"
]
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Join a tenant based on invite token
Accept an invite, set the password and mark user's email as verified
Reset object
Request Example
{
"token": "string",
"password": "string"
}
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Reset a user's credentials
So the user can login
Reset object
Request Example
{
"token": "string",
"password": "string"
}
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Mark user's email as verified
So the user can login
Verify object
Request Example
{
"token": "string"
}
200 OK
The user
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",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"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"
]
}
}
Request a token for the user
So the user can receive a password reset mail or confirm mail
Request reset object
Request Example
{
"email": "string",
"type": "string"
}
200 OK
The user
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",
"expires_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 all tokens of given type a user
Invalidate all pending tokens of given type for user
Request reset object
Request Example
{
"email": "string",
"type": "string"
}
200 OK
The user
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",
"expires_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"
]
}
}
Rbac
Get a list of rbac roles
Returns a list of available rbac roles
200 OK
List of roles
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",
"scopes": [
"string"
],
"is_managed": "boolean",
"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"
]
}
}
Create a new role
Make a new RBAC role available
Role object
Request Example
{
"name": "string",
"scopes": [
"string"
]
}
200 OK
The role
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",
"scopes": [
"string"
],
"is_managed": "boolean",
"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 an rbac role
Returns the rbac role
id:
integer
in path
(no description)
200 OK
List of roles
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",
"scopes": [
"string"
],
"is_managed": "boolean",
"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 an existing role
Update a RBAC role
Role object
id:
integer
in path
(no description)
Request Example
{
"name": "string",
"scopes": [
"string"
]
}
200 OK
The role
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",
"scopes": [
"string"
],
"is_managed": "boolean",
"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 an existing role
Delete a RBAC role
id:
integer
in path
(no description)
200 OK
The deleted role
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",
"scopes": [
"string"
],
"is_managed": "boolean",
"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"
]
}
}
Get a list of rbac system defined rbac roles
Returns a list of available rbac roles
client_id:
string
in query
(no description)
200 OK
List of roles
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",
"scopes": [
"string"
],
"client_id": "string",
"is_managed": "boolean",
"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"
]
}
}
Get a single rbac system defined role
Returns a single rbac role
id:
string
in path
(no description)
200 OK
List of roles
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",
"scopes": [
"string"
],
"client_id": "string",
"is_managed": "boolean",
"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"
]
}
}
Oauth
Get a list of clients
Returns a list of clients
x-page-size:
integer
in header
(no description)
x-page:
string
in header
(no description)
is_deleted:
integer
1,
0
0
in query
(no description)
scope:
string
in query
(no description)
200 OK
List of clients
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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"
]
}
}
Create a new oauth client
Returns a new client
Create object
Request Example
{
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
]
}
200 OK
The created client
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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"
]
}
}
Find the oauth client
Returns the oauth client for the given client id
id:
string
in path
Id that belongs to the oauth client
200 OK
The oauth client
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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 an oauth client
Returns an updated client
Update object
id:
string
in path
Id that belongs to the oauth client
Request Example
{
"name": "string",
"scope": [
"string"
]
}
200 OK
The updated client
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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 an oauth client
Returns the deleted client
id:
string
in path
Id that belongs to the oauth client
200 OK
The deleted client
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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"
]
}
}
Get a list of open / shared / third party
Returns a list of clients
200 OK
List of clients
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",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"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"
]
}
}
List all available scopes
Get scopes for all registered services
200 OK
The requested inbox
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",
"description": "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 a scope and it's description
Get scope by it's id
id:
string
in path
Identifier that belongs to the scope
200 OK
The list of scopes
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",
"description": "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"
]
}
}
Redirect the user to the client
Log the authorization, store approval and redirect the user
silent:
string
0,
1
in query
Pass along to change the redirect response into a response with a body. Note that this option only works on previously approved authorizations.
reference:
string
in path
Reference that belongs to the authorize request
200 OK
when silent we return the token
type
object
302 Found
Redirect the user to the (third party) app
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)
{
"token": "string",
"id_token": "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"
]
}
}
Jwt
Extend the lifetime of an access token
Returns a new access token
200 OK
An extended access 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)
{
"token_type": "string",
"expires_in": "integer",
"access_token": "string",
"refresh_token": "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"
]
}
}
Revoke access tokens
Revoke the current access token or all the users' tokens. Both options will revoke all the users' refresh tokens
tokens:
string
current,
jwt,
all
current
in query
Current (default value) will revoke only the token that is passed as Authorization header. JWT will revoke all the users' JWT tokens. All will revoke all JWT and refresh tokens that belong to the user.
200 OK
An extended access 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)
{
"token_type": "string",
"expires_in": "integer",
"access_token": "string",
"refresh_token": "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"
]
}
}
Services
Read the list of allowed phone numbers
200 OK
List of phone numbers
type
302 Found
Redirect the user to the (third party) app
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",
"number": "string",
"preferred_agent": "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"
]
}
}
Create a new whitelisted phone number
undefined
Request Example
{
"name": "string",
"country_code": "string",
"number": "string",
"preferred_agent": "string"
}
200 OK
List of phone numbers
302 Found
Redirect the user to the (third party) app
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",
"number": "string",
"preferred_agent": "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"
]
}
}
Meilisearch
Proxy
Get the proxy configuration
Returns the proxy configuration
200 OK
Proxy configuration
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",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
Create a new proxy
Add a new proxy configuration
undefined
Request Content-Types: application/json
Request Example
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
200 OK
The proxy 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
Get the proxy configuration
Returns the proxy configuration
key:
string
in path
(no description)
200 OK
Proxy configuration
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",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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 the proxy configuration
Updates the proxy
undefined
key:
string
in path
(no description)
Request Content-Types: application/json
Request Example
{
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
200 OK
The signature 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "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"
]
}
}
List all proxies
List all proxies for a tenant
x-page-size:
integer
25
in header
(no description)
x-page:
integer
1
in header
(no description)
200 OK
A list of proxies
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Create a new proxy for the tenant
undefined
Request Example
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
201 Created
The created proxy
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 (201 Created)
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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"
]
}
}
Show a proxy
Show a single proxy for the tenant
id:
string
in path
(no description)
200 OK
A proxy
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Update a proxy for the tenant
undefined
id:
string
in path
(no description)
Request Example
{
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
200 OK
The updated proxy
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",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "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 a proxy
Delete a new proxy for the tenant
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"
]
}
}
Index
Run a simple search
Run a search with the option to run an aggregation
Query object
x-page:
string
in header
(no description)
x-page-size:
integer
25
in header
(no description)
Request Example
{
"codes": [
"string"
],
"models": [
"string"
],
"namespaces": [
"string"
],
"q": [
"string"
],
"is_fuzzy": "boolean",
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string"
}
200 OK
The search results
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": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
Response Headers (200 OK)
| x-page |
The next page cursor |
string |
| x-count |
Total item count |
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"
]
}
}
Run a complex search
Run a complex search
Query object
namespace:
string
default
in path
the namespace
code:
string
in path
(no description)
model:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
integer
25
in header
(no description)
Request Example
{
"q": [
"string"
],
"is_fuzzy": "boolean",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"missing": [
"string"
],
"facets": [
"string"
],
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string",
"sort": [
{
"key": "string",
"order": "string"
}
]
}
200 OK
The search results
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": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
Response Headers (200 OK)
| x-page |
The next page cursor |
string |
| x-count |
Total item count |
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 some suggestions
Run a simple, fast suggest search
q:
string
in query
The query
limit:
integer
5
in query
The query
codes:
string[]
in query
The query
models:
string[]
in query
The models we want to query
namespaces:
string[]
in query
The namesapce we want to query
200 OK
The suggestions
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": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
]
}
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 definitions
List the set of definitions
code:
string
in query
(no description)
model:
string
in query
(no description)
namespace:
string
in query
(no description)
200 OK
The search results
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",
"namespace": "string",
"code": "string",
"model": "string",
"filters": [
{
"key": "string",
"type": "string"
}
],
"tenant_id": "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"
]
}
}
Upsert a definition
Either create a new, or update an existing definition
Query object
Request Example
{
"namespace": "string",
"code": "string",
"model": "string",
"key": "string",
"type": "string"
}
200 OK
The search results
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",
"namespace": "string",
"code": "string",
"model": "string",
"filters": [
{
"key": "string",
"type": "string"
}
],
"tenant_id": "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"
]
}
}
Decode filter
Decode a relative date filter
input:
string
in query
(no description)
200 OK
The epoch timestamp
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)
{
"query": {
"quantity": "integer",
"key": "string",
"direction": "string",
"at": {
"timezone": "string",
"hour": "string",
"minute": "string",
"day_of_week": "string",
"day_of_month": "string"
}
},
"epoch": 1593505091,
"formatted": "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"
]
}
}
Relative date
Generate a relative date filter
Query object
Request Example
{
"quantity": "integer",
"key": "string",
"direction": "string",
"at": {
"timezone": "string",
"hour": "string",
"minute": "string",
"day_of_week": "string",
"day_of_month": "string"
}
}
200 OK
The epoch timestamp
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)
{
"epoch": 1593505091,
"formatted": "string (date-time)",
"filter": "_eyJxdWFudGl0eSI6NCwia2V5IjoibW9udGhzIiwiZGlyZWN0aW9uIjoiYWhlYWQiLCJhdCI6eyJob3VycyI6bnVsbCwibWludXRlcyI6bnVsbCwiZGF5X29mX3dlZWsiOm51bGwsImRheV9vZl9tb250aCI6Imxhc3QifX0="
}
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 all indexes
List all indexes for the authenticated user.
x-page-size:
integer
25
in header
(no description)
x-page:
integer
1
in header
(no description)
200 OK
A list of indexes
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",
"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 a new index
Create a new index
undefined
Request Example
{
"name": "string"
}
201 Created
The created index
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 (201 Created)
{
"id": "string (uuid)",
"name": "string",
"host": "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"
]
}
}
Show a single index
Show a single index for the tenant.
id:
string
in path
(no description)
200 OK
A single index
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",
"host": "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 a single index
Update a single index
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string"
}
200 OK
The updated index
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",
"host": "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 a single index
Delete a single index
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"
]
}
}
Documents
Update or insert a list of documents
Update or insert a list of documents in the specified index. Enter any additional information in the metadata. Data in the metadata key is not searchable, only retrievable.
id:
string
in path
(no description)
Request Example
[
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
]
204 No Content
No content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Index 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"
]
}
}
Clears all documents from an index
Delete all documents from the specified index
id:
string
in path
(no description)
204 No Content
No content
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"
]
}
}
Delete a list of documents
Delete a list of documents from the specified index. Only those document IDs that were submitted will be removed.
id:
string
in path
(no description)
Request Example
[
"1234",
"1235"
]
204 No Content
No content
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Index 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
Search documents
Search documents: The id is the proxy key for a tenant, ex: "afosto". The count is the combined count of the results in all selected indices.
undefined
id:
string
in path
(no description)
Accept:
string
application/json,
application/vnd.instantsearch+json
application/json
in header
(no description)
Request Example
{
"q": "string",
"offset": "integer",
"limit": "integer",
"threshold": "integer",
"indices": [
"string"
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"facets": [
"string"
]
}
200 OK
The search results
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 Content-Types: application/json, application/vnd.instantsearch+json
Response Example (200 OK)
{
"results": [
{
"id": "string (uuid)",
"count": "integer",
"hits": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
]
}
],
"offset": "integer",
"limit": "integer",
"count": "integer",
"q": "string"
}
Response Headers (200 OK)
| x-page-size |
Total items per page |
string |
| x-count |
Total item count |
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 documents within a single index
Search documents within a single index, without going throuh a proxy.
undefined
id:
string
in path
(no description)
Accept:
string
application/json,
application/vnd.instantsearch+json
application/json
in header
(no description)
Request Example
{
"q": "string",
"offset": "integer",
"limit": "integer",
"threshold": "integer",
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"facets": [
"string"
]
}
200 OK
The search results
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 Content-Types: application/json, application/vnd.instantsearch+json
Response Example (200 OK)
{
"results": [
{
"id": "string (uuid)",
"count": "integer",
"hits": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
]
}
],
"offset": "integer",
"limit": "integer",
"count": "integer",
"q": "string"
}
Response Headers (200 OK)
| x-page-size |
Total items per page |
string |
| x-count |
Total item count |
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"
]
}
}
Settings
List index settings
List the settings of the specified index
id:
string
in path
(no description)
200 OK
The settings
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)
{
"synonyms": "object",
"stop_words": [
"string"
],
"ranking_rules": [
"string"
],
"facet_fields": [
"string"
],
"distinct_field": "string",
"search_fields": [
"string"
],
"display_fields": [
"string"
],
"filters": [
{
"type": "string",
"key": "string"
}
],
"last_processed_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 index settings
Update the settings of the specified index
undefined
id:
string
in path
(no description)
sync:
string
in query
Add to wait for the asynchronous update to finish
Request Example
{
"synonyms": "object",
"stop_words": [
"string"
],
"ranking_rules": [
"string"
],
"filters": [
{
"type": "string",
"key": "string"
}
]
}
204 No Content
No content
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"
]
}
}
Reset index settings
Reset the settings of the specified index
id:
string
in path
(no description)
204 No Content
No content
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"
]
}
}
Updates
List index updates
List the updates of the specified index
id:
string
in path
(no description)
200 OK
The settings
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)
[
{
"status": "string",
"updateId": "integer (int64)",
"type": {
"name": "string",
"number": "integer"
},
"duration": "number",
"enqueuedAt": "string",
"processedAt": "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 one update
Get a single update on from the specified index
id:
string
in path
(no description)
update_id:
integer
(int64)
in path
(no description)
200 OK
The settings
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)
{
"status": "string",
"updateId": "integer (int64)",
"type": {
"name": "string",
"number": "integer"
},
"duration": "number",
"enqueuedAt": "string",
"processedAt": "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"
]
}
}
Messaging
Conversations
List conversations
Returns a list of conversations
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
200 OK
The list of conversations
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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"
]
}
}
Start a conversations conversation
Instantiate a conversation
Conversation object
Request Example
{
"event": "string",
"entity_type": "string",
"name": "string",
"entity_id": "string",
"participant": {
"name": "string",
"reference": "string",
"is_machine": "boolean"
},
"metadata": "object",
"expires_at": "string (date-time)"
}
200 OK
The started conversation
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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"
]
}
}
Search for conversations
Run a complex search to find conversations
Search query object
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
200 OK
The list of search results
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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 a conversation
Retrieve a single conversation
id:
integer
in path
(no description)
200 OK
The conversation with given id
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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"
]
}
}
Add a message
Append a message to the conversation
The new message
id:
integer
in path
(no description)
Request Example
{
"content": "string",
"is_private": "boolean",
"metadata": "object",
"reference": "string"
}
200 OK
The resulting conversation
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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"
]
}
}
Add a participant
Register a new participant in the conversation
The new message
id:
integer
in path
(no description)
Request Example
{
"name": "string",
"reference": "string",
"is_machine": "boolean"
}
200 OK
The resulting conversation
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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 (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"
]
}
}
Add a subscription
Add a subscription to recieve updates on this conversation
The subscription data
id:
integer
in path
(no description)
Request Example
{
"reference": "string",
"medium": "string",
"address": "boolean"
}
200 OK
The resulting conversation
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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 (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"
]
}
}
Cancel a subscription
Remove a subscription to recieve updates on this conversation
The subscription data
id:
integer
in path
(no description)
Request Example
{
"reference": "string",
"medium": "string"
}
200 OK
The resulting conversation
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",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_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 (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"
]
}
}
Domains
Get the list of available domains
Returns a list of domains
is_verified:
integer
1,
0
in query
(no description)
200 OK
The list of domains
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",
"is_verified": "boolean",
"dns": [
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
],
"tenant_id": "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"
]
}
}
Add a new domain
Adds a domain to the list
Domain object
Request Example
{
"fqdn": "string"
}
200 OK
The newly created domain
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",
"is_verified": "boolean",
"dns": [
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
],
"tenant_id": "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"
]
}
}
Get a single domain by id
Returns a single domain
id:
string
in path
Id that belongs to the domain
200 OK
The domain
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",
"is_verified": "boolean",
"dns": [
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
],
"tenant_id": "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 a domain by id
Deletes a domain
id:
string
in path
Id that belongs to the domain
200 OK
The deleted domain
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",
"is_verified": "boolean",
"dns": [
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
],
"tenant_id": "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"
]
}
}
Inboxes
Get the list of available inboxes
Returns a list of inboxes
fqdn:
string
in query
(no description)
public:
string
1,
0
in query
(no description)
200 OK
The list of domains
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",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"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"
]
}
}
Add a new inbox
Adds a inbox to the list
Inbox object
Request Example
{
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"settings": {
"recaptcha_integration_id": "string (uuid)"
}
}
200 OK
The newly created inbox
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",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"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"
]
}
}
Get a single inbox by id
Returns a single inbox
id:
string
in path
Id that belongs to the inbox
200 OK
The inbox
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",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"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 an inbox
Update an existing inbox
Inbox object
id:
string
in path
Id that belongs to the inbox
Request Example
{
"label": "string",
"user_id": "string",
"settings": {
"recaptcha_integration_id": "string (uuid)"
}
}
200 OK
The updated inbox
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",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"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 an inbox by id
Deletes an inbox
id:
string
in path
Id that belongs to the inbox
200 OK
The deleted inbox
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",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"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"
]
}
}
Emails
Get the list of emails
Returns a list of emails
inbox:
string
in query
(no description)
folder:
string
inbox,
concept,
sent,
spam
in query
(no description)
addressee:
string
in query
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The list of emails
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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"
]
}
}
Add a new email
Adds a email
Mail object
Request Example
{
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"metadata": "object"
}
200 OK
The newly created email
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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"
]
}
}
Get an email and mark it
Mark as read and return email
id:
string
in path
Id that belongs to the email
mark_as:
string
read,
unread
read
in query
Mark the email
200 OK
The email
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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 an email
Update an existing email
Mail object
id:
string
in path
Id that belongs to the email
Request Example
{
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"metadata": "object"
}
200 OK
The updated email
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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 email
Delete an email
id:
string
in path
Id that belongs to the email
200 OK
The deleted email
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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"
]
}
}
Adds a new email (unauthenticated)
Adds a new email, unauthenticated endpoint, spam protection using recaptcha
Mail object
Request Example
{
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"recaptcha_response": "string",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"metadata": "object"
}
200 OK
The created email
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",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_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"
]
}
}
Webhooks
List events
List of events that support webhooks
200 OK
Events
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)
[
{
"event": "string",
"description": "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 active subscriptions
List currenty active webhook subscriptions
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
Subscriptions
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",
"events": [
"string"
],
"endpoint": "string",
"secret": "string",
"delivery_rate": "integer",
"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"
]
}
}
Add a webhook subscription
Create a new webhook subscription
Subscription data
Request Example
{
"events": [
"string"
],
"endpoint": "string",
"delivery_rate": "integer"
}
200 OK
The created subscription
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",
"events": [
"string"
],
"endpoint": "string",
"secret": "string",
"delivery_rate": "integer",
"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"
]
}
}
Get subscription
Get an active webhook subscription
id:
integer
in path
(no description)
200 OK
The subscription
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",
"events": [
"string"
],
"endpoint": "string",
"secret": "string",
"delivery_rate": "integer",
"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 subscription
Update webhook subscription
Subscription data
id:
integer
in path
(no description)
Request Example
{
"events": [
"string"
],
"endpoint": "string",
"delivery_rate": "integer"
}
200 OK
The updated webhook
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",
"events": [
"string"
],
"endpoint": "string",
"secret": "string",
"delivery_rate": "integer",
"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 subscription
Delete a webhook subscription
id:
integer
in path
(no description)
204 No Content
The resource was deleted successfully
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"
]
}
}
Simulate event
Test a subscription / webhook delivery for an event
undefined
id:
integer
in path
(no description)
Request Example
{
"event": "string",
"entity_id": "string"
}
200 OK
The created subscription
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",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"endpoint": "string",
"subscription": "integer",
"attempt": {
"id": "integer",
"number": "integer",
"is_success": "boolean",
"response_time": "integer",
"response_code": "integer",
"response_body": "string",
"attempted_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"
]
}
}
List messages
List of messages created in the past 30 days, both pending or deliverd
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
is_delivered:
string
1,
0
in query
(no description)
is_pending:
string
1,
0
in query
(no description)
200 OK
Subscriptions
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": "integer",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"attempts": "integer",
"endpoint": "string",
"subscription": "integer",
"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 message
Get a single message
id:
string
in path
(no description)
200 OK
Subscriptions
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",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"attempts": "integer",
"endpoint": "string",
"subscription": "integer",
"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"
]
}
}
Retry message
Manually retry a single message
id:
string
in path
(no description)
200 OK
Subscriptions
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",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"endpoint": "string",
"subscription": "integer",
"attempt": {
"id": "integer",
"number": "integer",
"is_success": "boolean",
"response_time": "integer",
"response_code": "integer",
"response_body": "string",
"attempted_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 attempts
List the delivery attempts for a single message
id:
string
in path
(no description)
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
Attempts
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": "integer",
"number": "integer",
"is_success": "boolean",
"response_time": "integer",
"response_code": "integer",
"response_body": "string",
"attempted_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 attempt delays
Get a list of delays for each attempt. The 10'th attempt will be after 24 hours (86400+ seconds)
200 OK
Attempts
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)
[
{
"attempt": 1,
"delay": 0,
"total_delay": 0
},
{
"attempt": 2,
"delay": 9,
"total_delay": 9
},
{
"attempt": 3,
"delay": 27,
"total_delay": 36
}
]
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"
]
}
}
Tasks
Get task
Get a single task
id:
string
in path
(no description)
200 OK
Task information
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",
"description": "string",
"progress": "integer",
"result": "string",
"started_at": "string (date-time)",
"completed_at": "string (date-time)",
"expires_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"
]
}
}
Order
Orders
List orders
Returns a list of orders
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
authorization_id:
string
in query
(no description)
number:
string
in query
(no description)
200 OK
The list of orders
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "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"
]
}
}
Create order
Creates and returns the new order
undefined
x-idempotency-key:
string
in header
(no description)
Request Example
{
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"settings": {
"contact": {
"id": "string (uuid)"
},
"organisation": "#/definitions/OdrSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"reference": "string (string)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"type": "string",
"metadata": "object"
}
200 OK
The order
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "string",
"type": "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 order
Returns an order
id:
string
in path
(no description)
200 OK
The order
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "string",
"type": "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"
]
}
}
Update order
Updates order settings
undefined
id:
string
in path
(no description)
Request Example
{
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"settings": {
"contact": {
"id": "string (uuid)"
},
"organisation": "#/definitions/OdrSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"reference": "string (string)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"type": "string",
"metadata": "object"
}
200 OK
The order
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "string",
"type": "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"
]
}
}
Remove order
Removes an order
id:
string
in path
(no description)
200 OK
The stack
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",
"entity_id": "string",
"entity_type": "string",
"state": {
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
},
"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"
]
}
}
Get backorders
Returns all backorders for current order
id:
string
in path
(no description)
200 OK
The order
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "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 references
Returns affiliated orders
id:
string
in path
(no description)
200 OK
The order
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "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 stacks
Returns all affiliated line sets that orginate from the order. For example inventory allocation, shipment or parcel data.
id:
string
in path
(no description)
200 OK
The order
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",
"entity_id": "string",
"entity_type": "string",
"state": {
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
},
"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"
]
}
}
Reference stack
Creates and returns the new stack
undefined
x-idempotency-key:
string
in header
(no description)
id:
string
in path
(no description)
Request Example
{
"entity_id": "string",
"entity_type": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The stack
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",
"entity_id": "string",
"entity_type": "string",
"state": {
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
},
"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"
]
}
}
Get projection
Returns an order's projection
id:
string
in path
(no description)
pricing_at:
integer
in query
Unix timestamp
200 OK
The projection
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)
{
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"currency": "string",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"client_id": "string",
"pricing_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"
]
}
}
Get calculation
Returns the newest, non expired, calculation for the order
id:
string
in path
(no description)
200 OK
The calculation
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",
"number": "string",
"reference": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
},
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "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"
]
}
}
Calculate order
Request calculation for the order
undefined
id:
string
in path
(no description)
x-idempotency-key:
string
in header
(no description)
rules:
integer
1,
0
in query
(no description)
Request Example
{
"expires_at": "string (date-time)",
"reference": "string",
"currency": "string",
"items": [
{
"item_ids": [
"string (uuid)"
],
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"pricing_at": "string (date-time)",
"metadata": "object"
}
200 OK
The calculation
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",
"number": "string",
"reference": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
},
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "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"
]
}
}
Accept order
Update the order state
id:
string
in path
(no description)
204 No Content
Accepted
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"
]
}
}
Confirm order
Update the order state
id:
string
in path
(no description)
204 No Content
Accepted
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"
]
}
}
Allocate order
allocate the order
id:
string
in path
(no description)
202 Accepted
Accepted
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 Headers (202 Accepted)
| 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"
]
}
}
Fulfil order
fulfil the order
id:
string
in path
(no description)
202 Accepted
Accepted
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 Headers (202 Accepted)
| 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"
]
}
}
Cancel order
Cancel the order
id:
string
in path
(no description)
force:
string
1,
0
in query
(no description)
200 OK
Status
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)
{
"is_accepted": "boolean",
"warnings": [
"string"
]
}
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"
]
}
}
Update state
Update the order state
- code: string
- actions: object[]
-
object - code: string
- is_handled: boolean
id:
string
in path
(no description)
Request Example
{
"code": "approval",
"actions": [
{
"code": "manager_approve",
"is_handled": true
}
]
}
204 No Content
Accepted
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"
]
}
}
Items
List items
Returns a list of items
id:
string
in path
(no description)
stack_id:
string
(uuid)
in query
(no description)
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
200 OK
The list of items
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)
[
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
],
"target": "string"
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
]
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"
]
}
}
Add items
Adds items to the stack that was previously created
id:
string
in path
(no description)
x-idempotency-key:
string
in header
(no description)
Request Example
[
{
"sku": "string",
"reference": "string (uuid)",
"description": "string",
"quantity": "integer",
"is_inbound": "boolean",
"is_backorder": "boolean",
"item_ids": [
"string (uuid)"
],
"source_order_id": "string (uuid)"
}
]
200 OK
The stack
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",
"reference": "string",
"sku": "string",
"description": "string",
"is_inbound": "boolean"
}
]
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 items
Delete items by ID
id:
string
in path
(no description)
Request Example
[
"string (uuid)"
]
204 No Content
Items 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"
]
}
}
From search
Add items to order based on item search
- is_backorder: boolean
- is_inbound: boolean
- constraints: OdrSearchConstraint
-
OdrSearchConstraint - filters: OdrSearchFilter
-
OdrSearchFilter
id:
string
in path
(no description)
Request Example
{
"is_backorder": "boolean",
"is_inbound": "boolean",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
200 OK
The list of 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",
"reference": "string",
"sku": "string",
"description": "string",
"order_id": "string (uuid)",
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
],
"stacks": [
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
]
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"
]
}
}
Attach warehouse item onto an order item
set the warehouse item on a product.
id:
string
in path
(no description)
Request Example
[
{
"order_item_id": "string (uuid)",
"inventory_item_id": "string (uuid)"
}
]
200 OK
The list of 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",
"reference": "string",
"sku": "string",
"description": "string",
"order_id": "string (uuid)",
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
],
"stacks": [
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
]
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"
]
}
}
Remove the allocation from an order item
set the warehouse item on a product.
id:
string
in path
(no description)
Request Example
[
"string"
]
204 No Content
when successfully dealocated
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"
]
}
}
List items with routing
Returns a list of items
id:
string
in path
(no description)
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
200 OK
The list of items
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)
[
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"order_id": "string (uuid)",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
],
"delivery_routes": [
{
"id": "string (uuid)",
"name": "string"
}
],
"collect_routes": [
{
"id": "string (uuid)",
"name": "string",
"delivery_routes": [
"string"
]
}
]
}
]
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"
]
}
}
Set route
Define a WMS route for a set of order items
id:
string
in path
(no description)
Request Example
[
{
"item_ids": [
"string (uuid)"
],
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)"
}
]
200 OK
The list of 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",
"reference": "string",
"sku": "string",
"description": "string",
"is_inbound": "boolean"
}
]
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"
]
}
}
Set claim
set an claim on a order item
id:
string
in path
(no description)
Request Example
[
{
"item_id": "string (uuid)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
]
200 OK
The list of 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",
"reference": "string",
"sku": "string",
"description": "string",
"order_id": "string (uuid)",
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
],
"stacks": [
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
]
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 items
Returns a list items
undefined
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
200 OK
The list of 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)
[
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
],
"target": "string"
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
]
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 items with routing
Returns a list items with routing
undefined
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
200 OK
The list of 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)
[
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"order_id": "string (uuid)",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
],
"delivery_routes": [
{
"id": "string (uuid)",
"name": "string"
}
],
"collect_routes": [
{
"id": "string (uuid)",
"name": "string",
"delivery_routes": [
"string"
]
}
]
}
]
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 items with routing
Returns a list items with routing
- order: OdrSearch
- wms: object
-
- constraints: object[]
-
object - key: string
- operator: string
- values: string[]
-
string
- use_referenced_stock: boolean
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"order": {
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
},
"wms": {
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"use_referenced_stock": "boolean"
}
}
200 OK
The list of 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)
[
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"order_id": "string (uuid)",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
],
"inventory_item_ids": [
"string (uuid)"
],
"available": "number"
}
]
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
Search for orders
Search orders by id
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
All matching orders
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)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "string"
}
]
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 calculations
Search calculations by id
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
All matching valid calculations
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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_prepaid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_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 invoices
Search invoices by ID
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
All matching invoices
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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
},
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrInvoiceAdjustmentResponse"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "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 coupons
Search coupons by code
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
All matching coupons
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",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"claims": [
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
],
"expires_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 coupon categories
Search coupon categories by id
undefined
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
All matching coupon categories
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",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"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"
]
}
}
Skus
Announce a set of skus
Provide the service with a set of valid skus
Request Example
[
{
"sku": "string",
"description": "string",
"expires_at": "string (date-time)"
}
]
200 OK
The list of skus
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)
{
"status": "string",
"count": "integer"
}
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"
]
}
}
Filters
Search filters
Returns a list of filters
undefined
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The list of 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)
[
{
"sku": "string",
"filters": "object"
}
]
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 a list of fiter sets
Get a listing filters per sku
200 OK
List of filter sets
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)
[
{
"sku": "string",
"filters": "object"
}
]
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 filters for skus
Create or update filters for products
Request Example
[
{
"sku": "string",
"filters": "object"
}
]
200 OK
The upsert results
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": "integer",
"failed": "integer"
}
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 filter keys
Returns distinct filter keys
200 OK
List of filter sets
type
string[]
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)
[
"color"
]
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 filter values for a given key
Returns distinct filter values
key:
string
in path
(no description)
200 OK
List of filter sets
type
string[]
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)
[
"red",
"yellow"
]
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"
]
}
}
Projection
Project pricing
Returns a cost projection
undefined
rules:
string
1,
0
1
in query
(no description)
Request Example
{
"client_id": "string",
"currency": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"contact_id": "string",
"organisation_id": "string",
"pricing_at": "string (date-time)",
"coupons": [
"string"
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
}
}
200 OK
The projection with applied valid discounts
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)
{
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"currency": "string",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"client_id": "string",
"pricing_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"
]
}
}
Calculations
List calculations
Returns a list of calculations
x-page:
string
1
in header
the cursor
x-page-size:
string
25
in header
the requested page size
200 OK
A list of calculations
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",
"number": "string",
"reference": "string",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_prepaid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"prepaid_at": "string (date-time)",
"order_ids": [
"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"
]
}
}
Get calculation
Returns a calculation
id:
string
in path
(no description)
200 OK
A single calculation
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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_prepaid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"prepaid_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"
]
}
}
Invoice calculation
Creates the invoice
undefined
id:
string
in path
(no description)
Request Example
{
"order_item_ids": [
"string (uuid)"
]
}
200 OK
A single 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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
},
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrInvoiceAdjustmentResponse"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "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"
]
}
}
Invoices
List invoices
Returns a list of invoices
order_id:
string
in query
(no description)
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 invoices
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",
"number": "string",
"reference": "string",
"count": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_paid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"paid_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"
]
}
}
Create invoice
Create a new invoice
undefined
Request Example
{
"reference": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"contact_id": "string",
"organisation_id": "string",
"address_id": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"currency": "string",
"pricing_at": "string (date-time)",
"metadata": "object"
}
200 OK
The newly created invoice
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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
},
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrInvoiceAdjustmentResponse"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "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 invoice
Returns a single invoice by id
id:
string
in path
(no description)
200 OK
View the invoice
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",
"number": "string",
"reference": "string",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
},
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrInvoiceAdjustmentResponse"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "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"
]
}
}
Mark paid
Mark invoice as paid
undefined
id:
string
in path
(no description)
Request Example
{
"paid_at": "string (date)"
}
200 OK
The newly created invoice
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",
"number": "string",
"reference": "string",
"count": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_paid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"paid_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"
]
}
}
Generate invoice
Generate PDF invoice
id:
string
in path
(no description)
204 No Content
No content
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 Headers (204 No Content)
| x-task-id |
Reference to the task |
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"
]
}
}
Pricing
Get a list of pricing rules
Get a listing of available pricing rules
x-page:
integer
in header
(no description)
x-page-size:
integer
25
in header
(no description)
200 OK
List of pricing rules
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-count |
undefined |
integer |
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"
]
}
}
Add a pricing rule
Add a new pricing rule to the set
undefined
Request Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"is_last_rule": "boolean",
"evaluate_at": "string",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
200 OK
The new princing rule
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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"
]
}
}
Get a pricing rule
Get a pricing rule
id:
string
in path
(no description)
200 OK
List of pricing rules
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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 rule
Update an existing pricing rule
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"is_last_rule": "boolean",
"evaluate_at": "string",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
200 OK
The updated princing rule
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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"
]
}
}
Evaluate the existing set of pricing rules
Test to see if rules would be applied
undefined
Request Example
{
"pricing_at": "string (date-time)",
"quantity": "integer",
"amount": "integer",
"client": "string",
"tags": [
"string"
],
"shipping_method": "string",
"payment_method": "string",
"coupons": [
"string"
],
"items": [
{
"reference": "string",
"sku": "string",
"filters": "object",
"quantity": "integer",
"is_discounted": "boolean"
}
]
}
200 OK
The new princing rule
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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"
]
}
}
Get a of options for constraints
Get a listing of available constraint rules
200 OK
List of pricing rules
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)
{
"amount": [
"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"
]
}
}
Services
Get services
Get a listing of available services
200 OK
List of pricing services
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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"
]
}
}
Create services
Add a new service
undefined
Request Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
200 OK
The new service
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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 services
Get a single service by ID
id:
string
in path
(no description)
200 OK
Single service
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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 service
Get a single service by ID
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
200 OK
The updated service
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",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_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"
]
}
}
Coupons
Get coupons
Get a listing of available coupons
category_id:
string
in query
(no description)
200 OK
List of coupons
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",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"claims": [
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
],
"expires_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"
]
}
}
Create coupons
Add a new coupon
undefined
Request Example
{
"code": "string",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"expires_at": "string (date-time)"
}
200 OK
The new coupon
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",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"claims": [
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
],
"expires_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"
]
}
}
View coupon
Get a single coupon by ID
code:
string
in path
(no description)
200 OK
Single coupon
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",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"claims": [
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
],
"expires_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"
]
}
}
Disable coupon
Disable a coupon: it is marked as expired
code:
string
in path
(no description)
204 No Content
Coupon code(s) disabled
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"
]
}
}
Get categories
Get a listing of available coupon categories
200 OK
List of coupon categories
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",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"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 categories
Add a new category
undefined
Request Example
{
"name": "string",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
}
}
200 OK
The new category
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",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"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 category
Get a coupon category by ID
id:
string
in path
(no description)
200 OK
Single coupon category
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",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"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 category
Update coupon category
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
}
}
200 OK
The updated service
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",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"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"
]
}
}
Credit
Apply balance
Apply balance to the credit reference
undefined
x-idempotency-key:
string
in header
(no description)
Request Example
{
"key": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"reference": "#/definitions/OdrKey",
"description": "string",
"currency": "string",
"amount": "integer",
"overdraft_allowance": "integer"
}
200 OK
The credit data
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Balance too low
404 Not Found
Not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string (uuid)",
"key": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"balance": "integer",
"currency": "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"
]
}
}
Get balance
Returns balance data
type:
string
1
in query
(no description)
id:
string
1
in query
(no description)
200 OK
The credit 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 (uuid)",
"key": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"balance": "integer",
"currency": "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"
]
}
}
List records
Returns a list of records
key_type:
string
1
in query
(no description)
key_id:
string
1
in query
(no description)
x-page:
string
1
in header
the requested page id
x-page-size:
string
25
in header
the requested page size
200 OK
The list of records
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)",
"reference": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"description": "string",
"amount": "integer",
"created_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"
]
}
}
Providers
Get list of providers
Returns a list of payment providers
200 OK
List of payment providers and their methods
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)
[
{
"name": "string",
"code": "string",
"is_active": "boolean",
"is_configured": "boolean",
"methods": [
{
"code": "string",
"name": "string",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"metadata": "object"
}
]
}
]
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"
]
}
}
Transactions
List transactions
Returns list of transactions
entity_type:
string
in query
(no description)
entity_id:
string
in query
(no description)
x-page:
string
in header
(no description)
200 OK
The transactions
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",
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"number": "string",
"amount_due": "integer",
"amount_paid": "integer",
"currency": "string",
"payments": [
{
"id": "string",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"secret": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"return_url": "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"
]
}
}
Create a transaction
Creates a new transaction
undefined
Request Example
{
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"amount": "integer",
"currency": "string",
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"return_url": "string",
"client_id": "string",
"channel_id": "string (uuid)"
}
200 OK
The created transaction
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",
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"number": "string",
"amount_due": "integer",
"amount_paid": "integer",
"currency": "string",
"payments": [
{
"id": "string",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"secret": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"return_url": "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"
]
}
}
Get transaction information
Returns the details of a transaction
secret:
string
in path
(no description)
200 OK
The transaction
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",
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"number": "string",
"amount_due": "integer",
"amount_paid": "integer",
"currency": "string",
"payments": [
{
"id": "string",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"secret": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"return_url": "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"
]
}
}
Payments
Get list of available payment methods
Returns a list of payment methods
200 OK
List of payment methods
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",
"provider_code": "string",
"name": "string",
"label": "string",
"is_prepaid": "boolean",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"is_enabled": "boolean",
"is_deferred": "boolean",
"priority": "integer"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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 method
Get single payment method
provider_code:
string
in path
(no description)
code:
string
in path
(no description)
200 OK
Payment method
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",
"provider_code": "string",
"name": "string",
"label": "string",
"is_prepaid": "boolean",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"is_enabled": "boolean",
"is_deferred": "boolean",
"priority": "integer"
}
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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"
]
}
}
Mark paid
Marks a payment as paid
secret:
string
in path
(no description)
200 OK
The created transaction
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",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_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"
]
}
}
Add payment
Start a payment for a transaction
undefined
secret:
string
in path
(no description)
Request Example
{
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"metadata": "object",
"return_url": "string"
}
200 OK
Payment information
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",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_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"
]
}
}
Create refund
Create a refund for the given transaction
undefined
secret:
string
in path
(no description)
Request Example
{
"payment_id": "string",
"amount": "integer"
}
200 OK
Payment information
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",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_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"
]
}
}
Get list of available payment methods
Returns a list of payment methods available for the transaction
secret:
string
in path
(no description)
200 OK
List of payment methods
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",
"provider_code": "string",
"name": "string",
"label": "string",
"is_prepaid": "boolean",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"is_enabled": "boolean",
"is_deferred": "boolean",
"priority": "integer"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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 live payment information
Returns the live details of a payment
secret:
string
in path
(no description)
200 OK
The payment
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)
{
"is_paid": "boolean",
"amount_paid": "integer",
"action": "string",
"url": "string",
"attempts": [
{
"psp_reference": "string",
"amount_paid": "integer",
"started_at": "string (date-time)",
"is_paid": "boolean",
"is_expired": "boolean"
}
]
}
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 payment
Start a payment for a transaction at the provider
secret:
string
in path
(no description)
204 No Content
Started transaction, use x-task-id to follow updates
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 Headers (204 No Content)
| x-task-id |
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"
]
}
}
Execute payment
Start a payment for a transaction at the provider
secret:
string
in path
(no description)
204 No Content
Performed refund
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"
]
}
}
Session
Start a checkout session
start a checkout session
undefined
Request Example
{
"expires_at": "string (datetime)",
"audience": "string"
}
200 OK
An id that is usable for the given session
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",
"expires_at": "string (datetime)"
}
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"
]
}
}
Returns the session expiry date
Returns the session expiry date
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"expires_at": "string (datetime)"
}
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"
]
}
}
Authenticate a contact for the session
Lets an user authenticate their contact through username and password
undefined
id:
string
in path
(no description)
Request Example
{
"email": "string",
"password": "string"
}
200 OK
successResponse
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)",
"email": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "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"
]
}
}
Authenticate a contact for the session
set an authenticated user on a session
- contact_id: string
id:
string
in path
(no description)
Request Example
{
"contact_id": "string"
}
200 OK
successResponse
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)",
"email": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "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"
]
}
}
Attach an order to the session
Lets an user authenticate their contact through username and password
undefined
id:
string
in path
(no description)
Request Example
{
"order_id": "string"
}
200 OK
An id that is usable for the given session
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)
{
"order_id": "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 the order reference
get the order reference
id:
string
in path
(no description)
An id that is usable for the given session
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": "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"
]
}
}
Set an reference on the order
set an reference on the order
undefined
id:
string
in path
(no description)
Request Example
{
"reference": "string"
}
An id that is usable for the given session
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": "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"
]
}
}
Validate the existence of an identity
Returns a 204 when the identity exists
undefined
id:
string
in path
(no description)
Request Example
{
"email": "string"
}
204 No Content
An id that is usable for the given session
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"
]
}
}
Add a contact phonenumber to the session
Create a phonenumber
undefined
id:
string
in path
(no description)
Request Example
{
"country_code": "string",
"number": "string"
}
202 Accepted
An id that is usable for the given session
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 (202 Accepted)
{
"id": "string (uuid)",
"country_code": "string",
"number": "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 the contact phonenumber
Returns the primary phonenumber of the customer
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"id": "string (uuid)",
"country_code": "string",
"number": "string"
},
"options": {
"contact": {
"primary": "#/definitions/OdrPhonenumber",
"secondary": [
"#/definitions/OdrPhonenumber"
]
},
"organisation": "#/definitions/OdrPhonenumberSet",
"session": "#/definitions/OdrPhonenumberSet"
}
}
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"
]
}
}
Select a phonenumber
select a phonenumber
undefined
id:
string
in path
(no description)
Request Example
{
"phone_number_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
202 Accepted
An id that is usable for the given session
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 (202 Accepted)
{
"id": "string (uuid)",
"country_code": "string",
"number": "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"
]
}
}
Add a new contact to the session
create a new contact and add it to the session
undefined
id:
string
in path
(no description)
Request Example
{
"email": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
}
204 No Content
contact is created and added to the session
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"
]
}
}
Get the current contact information
Returns the contact information
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)",
"version": "string (uuid)",
"email": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "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"
]
}
}
Get the price projection for the order
Returns a projections for the session
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrSessionCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"client_id": "string",
"pricing_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"
]
}
}
Get a calculation for the order
Returns a calculation for the session
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)",
"number": "string",
"reference": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrSessionCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
},
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "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"
]
}
}
Set billing address
set the shipping address used for the session
undefined
id:
string
in path
(no description)
Request Example
{
"address_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
200 OK
An id that is usable for the given session
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"
}
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 billing address
Returns a list of applicable shipping methods
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"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"
},
"options": {
"contact": {
"primary": "#/definitions/OdrAddress",
"secondary": [
"#/definitions/OdrAddress"
]
},
"organisation": "#/definitions/OdrAddressSet",
"session": "#/definitions/OdrAddressSet"
}
}
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 address
Create a address
undefined
id:
string
in path
(no description)
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"
}
202 Accepted
An id that is usable for the given session
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 (202 Accepted)
{
"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"
}
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"
]
}
}
Set shipping method
select the used shipping method
undefined
id:
string
in path
(no description)
Request Example
{
"is_split_allowed": "boolean",
"method_id": "string (uuid)"
}
An id that is usable for the given session
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)
{
"is_split_allowed": "boolean",
"method_id": "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"
]
}
}
Get shipping method
Returns a list of known shipping addresses
id:
string
in path
(no description)
country_code:
string
in query
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"is_split_allowed": "boolean",
"method_id": "string (uuid)"
},
"options": [
{
"id": "string",
"carrier": "string",
"name": "string",
"type": "string",
"price": "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"
]
}
}
Set shipping window
select the used shipping window
undefined
id:
string
in path
(no description)
Request Example
{
"from": "integer",
"to": "integer",
"at": "string (date)"
}
An id that is usable for the given session
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)
{
"from": "integer",
"to": "integer",
"at": "string (date)"
}
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 shipping window
Returns a list of known shipping addresses
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"from": "integer",
"to": "integer",
"at": "string (date)"
},
"options": [
"#/definitions/OdrSelectSessionShippingWindowResponse"
]
}
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"
]
}
}
Set shipping point
select the used shipping method
undefined
id:
string
in path
(no description)
Request Example
{
"spid": "string",
"country_code": "string"
}
An id that is usable for the given session
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)
{
"spid": "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 shipping point
Returns a list of known shipping addresses
id:
string
in path
(no description)
country_code:
string
in query
the country used to select shipping points
method_id:
string
in query
method_id
postal_code:
string
in query
prefiled with the postal_code of the primary address
200 OK
An id that is usable for the given session
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)
{
"active": {
"spid": "string",
"country_code": "string"
},
"options": [
{
"distance": "number",
"point": {
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longtitude": "number (float64)",
"address": {
"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"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "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"
]
}
}
Set shipping address
Select a billing address
undefined
id:
string
in path
(no description)
Request Example
{
"address_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
200 OK
An id that is usable for the given session
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"
}
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 shipping address
RReturns the shipping address and available options
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"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"
},
"options": {
"contact": {
"primary": "#/definitions/OdrAddress",
"secondary": [
"#/definitions/OdrAddress"
]
},
"organisation": "#/definitions/OdrAddressSet",
"session": "#/definitions/OdrAddressSet"
}
}
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"
]
}
}
Set billing method
Select billing method
undefined
id:
string
in path
(no description)
Request Example
{
"method_id": "string",
"issuer_id": "string"
}
An id that is usable for the given session
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)
{
"method_id": "string",
"issuer_id": "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 billing method
Returns a list of known shipping addresses
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"acitve": {
"method_id": "string",
"issuer_id": "string"
},
"options": [
{
"method_id": "string",
"name": "string",
"issuers": [
{
"method_id": "string",
"name": "string",
"metadata": "object"
}
],
"metadata": "object"
}
]
}
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"
]
}
}
Set organisation
Select an organisation
undefined
id:
string
in path
(no description)
Request Example
{
"organisation_id": "string (uuid)"
}
200 OK
organisation selected
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",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
}
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 organisation
create an organisation
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string"
}
]
}
200 OK
organisation created
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",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
}
Response Headers (200 OK)
| x-task-id |
id to track the vat verification status |
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 organisation
get the current organisation information
id:
string
in path
(no description)
200 OK
An id that is usable for the given session
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)
{
"active": {
"id": "string (uuid)",
"name": "string",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
},
"options": {
"primary": "#/definitions/OdrOrganisation",
"secondary": [
"#/definitions/OdrOrganisation"
]
}
}
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"
]
}
}
Remove active organisaton
removes the current selected organisation from the session
id:
string
in path
(no description)
204 No Content
if the organisation successfully is removed from the session
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"
]
}
}
Profielen
Profile
Profiles create the ability to create and use shareable configurations to enhance user experience,
Defintions that match over multiple profiles are interchangeable and thus results in the user having to fill in less duplicate configurations. For example we have several services using 3rd party credentials the user is only required to insert these once. Profiles can also be used to store user preferences within the application itself.
Upsert new a profile definition
Announce an new profile
Announce a profile definition for a given path
path:
string
in path
the key we want to register
Request Example
"object"
200 OK
success repsonse with the posted definition
type
object
400 Bad Request
invalid request
401 Unauthorized
invalid JWT
403 Forbidden
invalid namescape
404 Not Found
Not found
409 Conflict
conflicted schema detected
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
"object"
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 (409 Conflict)
{
"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 the definition for a profile
Announce new profiles
path:
string
in path
the key we want to register
200 OK
success repsonse with information about the service
type
object
400 Bad Request
invalid request
401 Unauthorized
Unauthorized
403 Forbidden
insufficient scopes
404 Not Found
definition not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
"object"
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 the profile's content
Update the profile content
update a profile
path:
string
in path
The correlationID of a configuration where we are updating the configuration off
channel_id:
string
(uuid)
in query
the channel_id to resolve the channel in the path for
Request Example
"object"
200 OK
success repsonse with information about the service
type
object
400 Bad Request
invalid request
type
401 Unauthorized
invalid JWT
type
403 Forbidden
invalid namescape
type
404 Not Found
Not found
409 Conflict
conflicted schema detected
type
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
"object"
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 (409 Conflict)
[
{
"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 all the profiles that match the path
Get the profiles by its key
path:
string
in path
The correlationID of a configuration where we are updating the configuration off
channel_id:
string
(uuid)
in query
the channel_id to resolve the channel in the path for
200 OK
success repsonse with information about the service
type
object
204 No Content
a schema exists, yet there is no profile posted
type
object
206 Partial Content
there are several schema's available, yet not all have data
type
object
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
you dont have the correct permissions to view this profile
type
404 Not Found
invalid namescape
type
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Example (204 No Content)
"object"
Response Example (206 Partial Content)
"object"
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"
]
}
}
Quicq
Proxy
Get the proxy configuration
Returns the proxy configuration
200 OK
Proxy configuration
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",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
},
"tenant_id": "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"
]
}
}
Create a new proxy
Add a new proxy configuration
undefined
Request Content-Types: application/json
Request Example
{
"key": "string",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
}
}
200 OK
The proxy 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
},
"tenant_id": "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"
]
}
}
Get the proxy configuration
Returns the proxy configuration
key:
string
in path
(no description)
200 OK
Proxy configuration
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",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
},
"tenant_id": "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 the proxy configuration
Updates the proxy
undefined
key:
string
in path
(no description)
Request Content-Types: application/json
Request Example
{
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
}
}
200 OK
The signature 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 Content-Types: application/json
Response Example (200 OK)
{
"key": "string",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
},
"tenant_id": "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"
]
}
}
Spooler
Printers
List the hooked printers
Returns a list of active printers
hub_id:
string
in query
ID of hub to filter for
inbox_id:
string
in query
ID of inbox to filter for
200 OK
Printer list
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",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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"
]
}
}
Add a printer
Add a new printer
The new printer
Request Example
{
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"timezone": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object"
}
200 OK
The created printer
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Hub not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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"
]
}
}
Get the printer
Returns a single printer
id:
string
in path
ID of printer to return
200 OK
Printer information
400 Bad Request
Bad Request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Printer not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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 printer
Update a printer to a new configuration
The new printer configuration
id:
string
in path
ID of printer to update
Request Example
{
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"timezone": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object"
}
200 OK
Printer updated
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Printer or hub not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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"
]
}
}
Deletes a printer
Disables a printer
id:
string
in path
ID of printer to delete
200 OK
Printer deleted
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Printer not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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 (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"
]
}
}
Attach an inbox to the printer
Update a printer to a new configuration
The new printer configuration
id:
string
in path
ID of printer to attach the inbox to
Request Example
{
"inbox_id": "string"
}
200 OK
Printer updated
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Printer or hub not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_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"
]
}
}
Settings
Get schema
Returns schema of settings
type:
string
escpos,
zpl,
pcl
in path
(no description)
200 OK
Printer settings json schema
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)
{
"type": "string",
"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"
]
}
}
Hubs
List the hubs
Returns the hub list
200 OK
The list of the currently active hubs
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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"
]
}
}
Create a new hub
Creates a new hub
The new hub
Request Example
{
"name": "string",
"description": "string"
}
200 OK
The newly created hub
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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"
]
}
}
Get the hub
Returns the hub
id:
string
in path
ID of hub to return
200 OK
The selected hub
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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 a hub
Update the hub to new hub settings
The updated hub data
id:
string
in path
ID of hub to update
Request Example
{
"name": "string",
"description": "string"
}
200 OK
Hub updated
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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"
]
}
}
Deletes a hub
id:
string
in path
ID of hub to delete
200 OK
Hub was disabled, old hub is returned
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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"
]
}
}
Get the hub status
Returns the hub information
id:
string
in path
ID of hub to look for
200 OK
Live hub status
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)
{
"is_online": "boolean",
"is_idle": "boolean",
"location": "string",
"network": {
"ip_address": "string",
"remote_ip_address": "string",
"last_connected_at": "string (date-time)"
},
"image": {
"is_up_to_date": "boolean",
"download_progress": "integer",
"version": "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 the network information
Returns the hub network list
id:
integer
in path
ID of hub to add a token for
200 OK
The list of network's devices for the given hub
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)
[
{
"description": "string",
"mac_address": "string",
"interface": {
"interface": "string",
"address": "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"
]
}
}
Set the network information
Updates the hub network
The new hub
id:
integer
in path
ID of hub to update network information for
Request Example
[
{
"description": "string",
"mac_address": "string",
"interface": {
"interface": "string",
"address": "string"
}
}
]
200 OK
The new network information
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)
[
{
"description": "string",
"mac_address": "string",
"interface": {
"interface": "string",
"address": "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"
]
}
}
List the logs
Returns the hub log list
id:
integer
in path
ID of hub to add a token for
x-page:
string
in header
(no description)
x-page-size:
integer
in header
(no description)
200 OK
The list of the unresolved logs for the given hub
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",
"message": "string",
"level": "string",
"is_resolved": "boolean",
"job_reference": "string",
"hub_id": "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"
]
}
}
Log a new hub error
Adds a new logged error for the hub
The new hub
id:
string
in path
Id of hub to add a log for
Request Example
{
"message": "string",
"level": "string",
"job_reference": "string"
}
200 OK
The added log
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",
"message": "string",
"level": "string",
"is_resolved": "boolean",
"job_reference": "string",
"hub_id": "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"
]
}
}
Get the hub by uuid
Returns the hub
id:
string
in path
The UUID of the hub to return
200 OK
The selected hub
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": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "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"
]
}
}
Queue
Get job history for account
Filter with a single value (multiple is not supported)
status:
string
printed,
scheduled,
received,
failed,
cancelled
scheduled
in query
Status values that need to be considered for filter
printer_id:
string
in query
The printer id that we want to filter
tag:
string
in query
The tag id that we want to filter for
x-page:
string
in header
The page token
x-page-size:
string
in header
The amount of results for the page
200 OK
Job list
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",
"job": "string",
"tag": "string",
"description": "string",
"artifact": "string",
"reference": "string",
"status": "string",
"hub_id": "string",
"schedule_at": "string (date-time)",
"printed_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
The pagination cursor, use this token for the next page of results |
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"
]
}
}
Add a job for a printer
The new print job
Request Example
{
"job": "string",
"tag": "string",
"description": "string",
"reference": "string",
"hub_id": "string",
"schedule_at": "string (date-time)"
}
200 OK
Job received
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Printer not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"job": "string",
"tag": "string",
"description": "string",
"artifact": "string",
"reference": "string",
"status": "string",
"hub_id": "string",
"schedule_at": "string (date-time)",
"printed_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"
]
}
}
Get the status for a printjob
Retrieve printjob status
reference:
string
in path
The id of the job that we look for, returned when job is pushed to queue
200 OK
Job data
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Job not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (200 OK)
{
"id": "string",
"job": "string",
"tag": "string",
"description": "string",
"artifact": "string",
"reference": "string",
"status": "string",
"hub_id": "string",
"schedule_at": "string (date-time)",
"printed_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"
]
}
}
Set a job to a new status
The new print job
reference:
string
in path
The id of the job that we look for, returned when job is pushed to queue
Request Example
{
"status": "string",
"changed_at": "string (date-time)"
}
201 Created
Status updated
400 Bad Request
Bad request
401 Unauthorized
Unauthorized
403 Forbidden
Forbidden
404 Not Found
Job not found
500 Internal Server Error
Internal Server Error
503 Service Unavailable
Service Unavailable
Response Example (201 Created)
{
"reference": "string",
"status": "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"
]
}
}
Theme service
Templates
List repositories
Returns a list of available repositories
secret:
string
in query
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List of repositories
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": "integer",
"name": "string",
"is_private": "boolean",
"installer": {
"username": "string",
"type": "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"
]
}
}
View repository
View a single repository
id:
string
in path
(no description)
secret:
string
in query
(no description)
200 OK
A single repository
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",
"is_private": "boolean",
"installer": {
"username": "string",
"type": "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"
]
}
}
List builds
List a single repository's builds
id:
string
in path
(no description)
secret:
string
in query
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
A single repository
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": "integer",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"is_success": "boolean",
"errors": [
{
"message": "string"
}
],
"started_at": "string (date-time)",
"ended_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"
]
}
}
Get build
List a single build
id:
string
in path
(no description)
200 OK
A single build
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",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"is_success": "boolean",
"errors": [
{
"message": "string"
}
],
"started_at": "string (date-time)",
"ended_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"
]
}
}
Themes
List themes
Returns a list of themes
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List of Pick lists
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",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"active_build": {
"id": "integer",
"repository_id": "integer",
"git_reference": "#/definitions/TplGitReference"
},
"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"
]
}
}
Add theme
Add a theme
undefined
Request Example
{
"name": "string",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
}
}
200 OK
The newly created shipment
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",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"active_build": {
"id": "integer",
"repository_id": "integer",
"git_reference": "#/definitions/TplGitReference"
},
"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 theme
Returns a list of themes
id:
string
in path
(no description)
200 OK
List of Pick lists
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",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"active_build": {
"id": "integer",
"repository_id": "integer",
"git_reference": "#/definitions/TplGitReference"
},
"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"
]
}
}
Update theme
Update a theme
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
}
}
200 OK
The newly created shipment
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",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"active_build": {
"id": "integer",
"repository_id": "integer",
"git_reference": "#/definitions/TplGitReference"
},
"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"
]
}
}
Usage
Usage
Get a list of records
Returns a list of records
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
List configuration
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",
"reference": "string",
"code": "string",
"unit": "string",
"quantity": "integer",
"processable_as": "string",
"tracked_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| 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 a usage report
Returns a set of usage records for given query
Report request object
page_size:
integer
in query
(no description)
page:
integer
in query
(no description)
Request Example
{
"interval": "string",
"code": "string",
"unit": "string",
"as": "string",
"filter": "string",
"keys": [
"string"
],
"start_at": "string (date-time)",
"end_at": "string (date-time)"
}
200 OK
The reporting data
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)
[
{
"interval": "string",
"code": "string",
"unit": "string",
"as": "string",
"filter": "string",
"start_at": "string (date-time)",
"end_at": "string (date-time)",
"buckets": [
{
"date": "string (date-time)",
"quantity": "integer",
"filter_key": "string",
"filter_value": "string"
}
]
}
]
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 a list of types
Returns a list of types
200 OK
List configuration
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",
"unit": "string",
"processable_as": "string",
"filter": "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"
]
}
}
WMS
Routing
Get a list of routes
List all routes
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
deleted_at:
integer
in query
the timestamp to compare against
200 OK
List of routes
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",
"from": "string",
"to": "string",
"hops": [
"string"
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| x-count |
undefined |
integer |
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 route
Add a new route
undefined
Request Example
{
"name": "string",
"from": "string",
"to": "string",
"hops": [
"string"
]
}
200 OK
The created route
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",
"from": "string",
"to": "string",
"hops": [
"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 the name of a route
Update a route
undefined
Request Example
{
"id": "string",
"name": "string"
}
200 OK
The created route
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",
"from": "string",
"to": "string",
"hops": [
"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"
]
}
}
Get a route
View a route
id:
string
in path
(no description)
200 OK
List of routes
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",
"from": "string",
"to": "string",
"hops": [
"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"
]
}
}
Mark a route as deleted
Marks a route as deleted
id:
string
in path
(no description)
200 OK
The deleted route
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",
"from": "string",
"to": "string",
"hops": [
"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"
]
}
}
Get a list of hops
List all hops
x-page:
integer
in header
the requested page id
x-page-size:
integer
in header
the requested page size
200 OK
List of hops
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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 a new hop
Add an hop
Hop model
Request Example
{
"from": "string",
"to": "string",
"schedules": [
"string"
]
}
200 OK
Created hop
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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 the applied schedules on a hop
update the applied schedules
Hop model
Request Example
{
"id": "string",
"schedules": [
"string"
]
}
200 OK
The hop
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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"
]
}
}
Get a hop
Get a hop
id:
string
in path
(no description)
200 OK
The hop
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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"
]
}
}
Mark a hop as deleted
Mark a hop as deleted
id:
string
in path
(no description)
200 OK
The deleted hop
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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"
]
}
}
Locations
Get a list of locations
List existing locations
X-Page-Size:
integer
25
in header
(no description)
X-Page:
integer
1
in header
(no description)
deleted_at:
integer
in query
the timestamp to compare against
200 OK
List of locations
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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 a new location
A location is a reference to a warehouse
Location model
Request Example
{
"id": "string",
"name": "string",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "string"
}
200 OK
Created location
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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 the location
Update a location
undefined
Request Example
{
"id": "string",
"name": "string"
}
200 OK
The updated location
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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"
]
}
}
Get a location
search a location for an address
- address_id: string
Request Example
{
"address_id": "string"
}
200 OK
The location
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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"
]
}
}
Get a location
Get a location
id:
string
in path
(no description)
200 OK
The location
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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"
]
}
}
Mark a location as deleted
Mark a location as deleted
id:
string
in path
(no description)
200 OK
The deleted location
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",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "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"
]
}
}
Inventory
Get positions
Get positions for a warehouse
id:
string
in path
(no description)
x-page:
string
in header
(no description)
200 OK
The list of positions
type
string[]
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)
[
"A34.254"
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| x-count |
undefined |
integer |
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 logs
Get logs for a position in a warehouse
id:
string
in path
(no description)
position:
string
in path
(no description)
x-page:
string
in header
(no description)
200 OK
The list of positions logs
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)",
"is_accurate": "boolean",
"new_items": [
"string (uuid)"
],
"missing_items": [
"string (uuid)"
],
"user_id": "string",
"verified_at": "string (date-time)",
"created_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| x-count |
undefined |
integer |
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"
]
}
}
Verify position
Verify position count in a warehouse
undefined
id:
string
in path
(no description)
position:
string
in path
(no description)
Request Example
{
"overage": [
"string"
],
"missing_ids": [
"string (uuid)"
]
}
204 No Content
Updated and logged verification
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"
]
}
}
Add Skus too location
Add sku's that can be claimed on the location that is not tracking inventory
undefined
id:
string
in path
(no description)
Request Example
[
"string"
]
200 OK
Updated and logged verification
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",
"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"
]
}
}
List Skus for location
List sku's for location
id:
string
in path
(no description)
sku:
string
in query
(no description)
x-page:
string
in header
(no description)
x-page-size:
string
in header
(no description)
200 OK
Updated and logged verification
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",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| x-count |
undefined |
integer |
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 Skus from location
remove sku's that can be claimed on the location that is not tracking inventory
id:
string
in path
(no description)
Request Example
[
"string (uuid)"
]
204 No Content
deleted skus for location
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"
]
}
}
Add overage to the location
Add overage that is available for location inventory
id:
string
in path
(no description)
Request Example
[
{
"sku": "string",
"quantity": "integer",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
]
200 OK
Updated and logged verification
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",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_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"
]
}
}
Get a list of warehouse items
Get a list of warehouse items
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer
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",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_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"
]
}
}
Search a inventory summary
Get a list of inventory summaries
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The transfer
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)
[
{
"location_id": "string",
"sku": "string",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"available": "integer",
"reserved": "integer",
"claimed": "integer",
"transit": "integer",
"missing": "integer",
"backordered": "integer",
"total": "integer"
}
]
Response Headers (200 OK)
| x-page |
undefined |
string |
| x-count |
undefined |
integer |
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"
]
}
}
Set the absolute stock at a warehouse
Get a list of inventory summaries
undefined
Request Example
{
"location_id": "string (uuid)",
"items": [
{
"sku": "string",
"quantity": "integer",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
]
}
200 OK
The transfer
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)
[
{
"location_id": "string",
"sku": "string",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"available": "integer",
"reserved": "integer",
"claimed": "integer",
"transit": "integer",
"missing": "integer",
"backordered": "integer",
"total": "integer"
}
]
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"
]
}
}
Search items inventory
Get a list of inventory items
- constraints: WmsInventoryConstraint
-
WmsInventoryConstraint
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The transfer
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",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_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"
]
}
}
Update a warehouse item
Update the warehouse item
undefined
id:
string
in path
(no description)
Request Example
{
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"metadata": "object"
}
200 OK
The transfer
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",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_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"
]
}
}
Get a warehouse item
Create an optimized set of claims
id:
string
in path
(no description)
200 OK
The transfer
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",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_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"
]
}
}
Timing
Get a list of schedules
List all schedules
X-Page-Size:
integer
25
in header
(no description)
X-Page:
integer
1
in header
(no description)
hop_id:
string
in query
(no description)
deleted_at:
integer
in query
the timestamp to compare against
200 OK
List of hops
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",
"last_call": "string",
"arrival": "string",
"duration": "integer",
"timezone": "string",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date)"
]
}
]
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 schedule
Add a schedule
Hop model
Request Example
{
"name": "string",
"last_call": "string",
"arrival": "string",
"timezone": "string",
"duration": "integer",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date-time)"
]
}
200 OK
Created hop
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_call": "string",
"arrival": "string",
"duration": "integer",
"timezone": "string",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date)"
]
}
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 schedule
update a schedule
Hop model
Request Example
{
"id": "string",
"name": "string",
"last_call": "string",
"arrival": "string",
"timezone": "string",
"duration": "integer",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date-time)"
]
}
200 OK
Created hop
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",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_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"
]
}
}
Get a schedule
Get a schedule
id:
string
in path
(no description)
200 OK
The hop
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_call": "string",
"arrival": "string",
"duration": "integer",
"timezone": "string",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date)"
]
}
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"
]
}
}
Mark a schedule as deleted
Mark a schedule as deleted
id:
string
in path
(no description)
200 OK
The deleted hop
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_call": "string",
"arrival": "string",
"duration": "integer",
"timezone": "string",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date)"
]
}
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 the real time duration of a route
returns a real time calculation for the route
Hop model
Request Example
{
"route_id": "string",
"from_location_id": "string",
"to_location_id": "string",
"calculate_at": "string (date-time)",
"arrival_at": "string (date-time)"
}
200 OK
Created hop
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)
{
"arrival_at": "string (date-time)",
"ship_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"
]
}
}
Allocation
Create a claim projection
Create a Projection to generate the available allocation options
undefined
Request Example
{
"items": [
{
"sku": "string",
"quantity": "integer"
}
],
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
List of claims
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)
{
"locations": [
"string"
],
"available": [
{
"location_id": "string (uuid)",
"sku": "string",
"amount": "integer"
}
],
"unavailable": [
{
"location_id": "string (uuid)",
"sku": "string",
"amount": "integer"
}
]
}
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 claims
Get a claim and it's status
X-Page-Size:
integer
25
in header
(no description)
X-Page:
integer
1
in header
(no description)
200 OK
Warehouse list
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Create a claim
Create an optimized set of claims
undefined
Request Example
{
"location_id": "string (uuid)",
"expires_at": "string (date-time)",
"reference": "string"
}
200 OK
List of claims
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Search claims
Returns a list for the search query
- constraints: WmsInventoryConstraint
-
WmsInventoryConstraint
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
Request Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
200 OK
The transfer
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Attach items to a claim
Create an optimized set of claims
id:
string
in path
(no description)
Request Example
[
{
"entity_type": "string",
"entity_id": "string",
"reference": "string",
"state": "string"
}
]
200 OK
List of claims
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)",
"inventory_item_id": "string (uuid)",
"position": "string",
"reference": "string",
"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"
]
}
}
Get a claim
Get a claim and it's status
id:
string
in path
(no description)
200 OK
List of claims
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Remove attached items
Create an optimized set of claims
id:
string
in path
(no description)
Request Example
[
"string (uuid)"
]
204 No Content
if the items are successfully removed
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"
]
}
}
Get claim status
returns the claim status
id:
string
in path
(no description)
200 OK
List of claims
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)
{
"is_cancelable": "boolean",
"with_warning": "boolean"
}
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"
]
}
}
Cancels the claim
cancelClaim
id:
string
in path
(no description)
204 No Content
List of claims
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"
]
}
}
Get a claim
Get a claim and it's status
id:
string
in path
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
List of claims
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)",
"inventory_item_id": "string (uuid)",
"position": "string",
"reference": "string",
"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"
]
}
}
Extend the claim
Extend the time the inventory is claimed
- expires_at: string (date-time)
id:
string
in path
(no description)
Request Example
{
"expires_at": "string (date-time)"
}
200 OK
List of claims
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Confirm the claim
Confirm a reservation claim and make it an actual claim
undefined
id:
string
in path
(no description)
Request Example
{
"target_id": "string (uuid)"
}
200 OK
List of claims
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)",
"location_id": "string",
"target": "string",
"expires_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"
]
}
}
Logistics
Create a new transfer projection
Create an optimized set of claims
undefined
Request Example
{
"target": "string (uuid)",
"arrival_at": "string (date-time)",
"collect_at": "string (uuid)",
"routing": [
{
"claim_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"delivery_route_id": "string (uuid)"
}
]
}
200 OK
The transfer
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)",
"target": "string (uuid)",
"status": "string",
"collect_at": "string (uuid)",
"collections": [
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"deliveries": [
"#/definitions/WmsSubTransferSummary"
],
"is_collection_pending": "boolean",
"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"
]
}
}
Get a list of transfers
Create an optimized set of claims
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer
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)",
"target": "string (uuid)",
"status": "string",
"collect_at": "string (uuid)",
"collections": [
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"deliveries": [
"#/definitions/WmsSubTransferSummary"
],
"is_collection_pending": "boolean",
"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 a new transfer
Create a new transfer
undefined
Request Example
{
"target": "string (uuid)",
"arrival_at": "string (date-time)",
"collect_at": "string (uuid)",
"routing": [
{
"claim_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"delivery_route_id": "string (uuid)"
}
]
}
200 OK
The transfer
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)",
"target": "string (uuid)",
"status": "string",
"collect_at": "string (uuid)",
"collections": [
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"deliveries": [
"#/definitions/WmsSubTransferSummary"
],
"is_collection_pending": "boolean",
"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"
]
}
}
Get a transfer
Create an optimized set of claims
id:
string
in path
(no description)
200 OK
The transfer
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)",
"target": "string (uuid)",
"status": "string",
"collect_at": "string (uuid)",
"collections": [
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"deliveries": [
"#/definitions/WmsSubTransferSummary"
],
"is_collection_pending": "boolean",
"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"
]
}
}
Get a list of transported items
returns a describing lsit of transfer items with their route
id:
string
in path
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer
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)
[
{
"claim_item_id": "string (uuid)",
"sku": "string",
"claim_id": "string (uuid)",
"route": [
{
"id": "string (uuid)",
"label": "string"
}
],
"transports": [
{
"id": "string (uuid)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_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"
]
}
}
Get a list of transported items summary
returns a describing lsit of transfer items with their route
id:
string
in path
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
claim_id:
string
in query
filter for a specific claim_id
200 OK
The transfer
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)
[
{
"claim_id": "string (uuid)",
"route": [
{
"id": "string (uuid)",
"label": "string"
}
],
"transports": [
{
"id": "string (uuid)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_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"
]
}
}
Get a list of transports belonging to the transfer
a list of transports for the given transfer
id:
string
in path
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer
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)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_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"
]
}
}
Update transport state
Create an optimized set of claims
- state: string pending, shipped, delivered
transfer_id:
string
in path
(no description)
id:
string
in path
(no description)
Request Example
{
"state": "string"
}
200 OK
The transfer
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)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_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"
]
}
}
Attach a shipment to the transport
Create an optimized set of claims
- inbound_shipment_id: string
- outbound_shipment_id: string
transfer_id:
string
in path
(no description)
id:
string
in path
(no description)
Request Example
{
"inbound_shipment_id": "string",
"outbound_shipment_id": "string"
}
200 OK
The transport
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)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_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"
]
}
}
Get a list of sub transfers
Create an optimized set of claims
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer
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",
"transfer_id": "string",
"from": "string",
"status": "string",
"route_id": "string",
"ship_at": "string (date-time)",
"expected_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"
]
}
}
Get a sub transfer
Returns a sub transfer
id:
string
in path
(no description)
200 OK
The transfer
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",
"transfer_id": "string",
"from": "string",
"status": "string",
"route_id": "string",
"ship_at": "string (date-time)",
"expected_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"
]
}
}
Get a subtransfer items
Returns a sub transfer items
id:
string
in path
(no description)
x-page:
string
in header
the requested page id
x-page-size:
string
in header
the requested page size
200 OK
The transfer items
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)
[
{
"transfer_item_id": "string",
"status": "string",
"claim_item_id": "string",
"inventory_item_id": "string",
"reference": "string",
"sku": "string",
"location_id": "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"
]
}
}
Report a set of items at a location
reports claim items at a certain location
Transfer request object
Request Example
{
"target": "string (uuid)",
"item_claims": [
{
"claim_item_id": "string (uuid)",
"position": "string"
}
]
}
204 No Content
The current claim as a result
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"
]
}
}
Webhooks
Relays
List relays
Lists all relays
type:
string
in query
(no description)
200 OK
List of relays
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",
"config": "object",
"endpoint": "string",
"limit_requests_per_second": "integer",
"is_system_object": "boolean",
"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 relay
Adds a new relay
undefined
Request Example
{
"name": "string",
"type": "string",
"config": "object"
}
200 OK
The projection with applied valid discounts
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",
"config": "object",
"endpoint": "string",
"limit_requests_per_second": "integer",
"is_system_object": "boolean",
"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 relay
Returns relay
id:
string
in path
(no description)
200 OK
The projection with applied valid discounts
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",
"config": "object",
"endpoint": "string",
"limit_requests_per_second": "integer",
"is_system_object": "boolean",
"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 relay
Update relay configuration
undefined
id:
string
in path
(no description)
Request Example
{
"name": "string",
"type": "string",
"config": "object"
}
200 OK
Updated relay
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",
"config": "object",
"endpoint": "string",
"limit_requests_per_second": "integer",
"is_system_object": "boolean",
"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 relay
Deletes a relay
id:
string
in path
(no description)
204 No Content
Ok
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"
]
}
}
List messages
List a relay's received messages
id:
string
in path
(no description)
is_valid:
string
1,
0
in query
(no description)
is_relayed:
string
1,
0
in query
(no description)
is_duplicate:
string
1,
0
in query
(no description)
200 OK
The projection with applied valid discounts
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)",
"hash": "string",
"payload": "string",
"is_valid": "boolean",
"is_relayed": "boolean",
"is_duplicate": "boolean",
"source": {
"ip": "string",
"city": "string",
"country_code": "string",
"user_agent": "string"
},
"relayed_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 message
Get a single relay message
id:
string
in path
(no description)
message_id:
string
in path
(no description)
is_valid:
string
1,
0
in query
(no description)
is_relayed:
string
1,
0
in query
(no description)
is_duplicate:
string
1,
0
in query
(no description)
200 OK
The projection with applied valid discounts
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)",
"hash": "string",
"payload": "string",
"is_valid": "boolean",
"is_relayed": "boolean",
"is_duplicate": "boolean",
"source": {
"ip": "string",
"city": "string",
"country_code": "string",
"user_agent": "string"
},
"relayed_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"
]
}
}
Dpd-service
Dpd
Get servicepoints
Return DPD's servicepoints
country_code:
string
in query
(no description)
postal_code:
string
in query
(no description)
200 OK
The list of types
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)
{
"parcelShop": [
{
"parcelShopId": "number",
"pudoId": "string",
"company": "string",
"street": "string",
"houseNo": "string",
"country": "string",
"countryNum": "number",
"zipCode": "string",
"city": "string",
"town": "string",
"phone": "string",
"fax": "string",
"email": "string",
"homepage": "string",
"latitude": "number",
"longitude": "number",
"coordinateX": "number",
"coordinateY": "number",
"coordinateZ": "number",
"distance": "number",
"expressPickupTime": "string",
"extraInfo": "string",
"openingHours": [
{
"weekday": "string",
"openMorning": "string",
"closeMorning": "string",
"closeAfternoon": "string",
"openAfternoon": "string"
}
],
"services": [
"object"
]
}
]
}
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 servicepoint
Return a DPD servicepoint by ID
id:
string
in path
(no description)
200 OK
The list of types
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)
{
"parcelShop": [
{
"parcelShopId": "number",
"pudoId": "string",
"company": "string",
"street": "string",
"houseNo": "string",
"country": "string",
"countryNum": "number",
"zipCode": "string",
"city": "string",
"town": "string",
"phone": "string",
"fax": "string",
"email": "string",
"homepage": "string",
"latitude": "number",
"longitude": "number",
"coordinateX": "number",
"coordinateY": "number",
"coordinateZ": "number",
"distance": "number",
"expressPickupTime": "string",
"extraInfo": "string",
"openingHours": [
{
"weekday": "string",
"openMorning": "string",
"closeMorning": "string",
"closeAfternoon": "string",
"openAfternoon": "string"
}
],
"services": [
"object"
]
}
]
}
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"
]
}
}
Schema Definitions
GraphQLQuery: object
- variables: object
- query: string
- operationName: string
Example
{
"variables": "object",
"query": "string",
"operationName": "string"
}
Error: object
- code: integer
- message: string
- reference: string
- errors: object
Example
{
"code": "integer",
"message": "string",
"reference": "string",
"errors": {
"invalid value": [
"property1"
],
"required": [
"property2"
]
}
}
MesNotify: object
- address: string
- medium: string sms, email, fcm
Example
{
"address": "string",
"medium": "string"
}
MesConversation: object
- id: string
- event: string update, memo
- entity_type: string order, invoice, stock
- entity_id: string
- messages: MesMessage
-
MesMessage - participants: MesParticipant
-
MesParticipant - metadata: MesMetadata
- started_at: string (date-time)
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"event": "string",
"entity_type": "string",
"entity_id": "string",
"messages": [
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
],
"participants": [
{
"name": "string",
"reference": "string",
"is_machine": "boolean",
"notifications": [
{
"address": "string",
"medium": "string"
}
]
}
],
"metadata": "#/definitions/MesMetadata",
"started_at": "string (date-time)",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesMessage: object
- content: string
- participant_reference: string
- is_private: boolean
- metadata: MesMetadata
- created_at: string (date-time)
Example
{
"content": "string",
"participant_reference": "string",
"is_private": "boolean",
"metadata": "object",
"created_at": "string (date-time)"
}
MesSearchConstraint: object
- key: string ids, event, entity_type, entity_ids, medium, participant
- operator: string in
- value: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
MesSearch: object
- constraints: MesSearchConstraint
-
MesSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
MesConversationCreate: object
- event: string update, memo
- entity_type: string order, invoice, stock
- name: string
- entity_id: string
- participant: MesParticipantCreate
- metadata: MesMetadata
- expires_at: string (date-time)
Example
{
"event": "string",
"entity_type": "string",
"name": "string",
"entity_id": "string",
"participant": {
"name": "string",
"reference": "string",
"is_machine": "boolean"
},
"metadata": "object",
"expires_at": "string (date-time)"
}
MesMessageAdd: object
- content: string
- is_private: boolean
- metadata: MesMetadata
- reference: string
Example
{
"content": "string",
"is_private": "boolean",
"metadata": "object",
"reference": "string"
}
MesParticipantCreate: object
- name: string
- reference: string
- is_machine: boolean
Example
{
"name": "string",
"reference": "string",
"is_machine": "boolean"
}
MesSubscription: object
- reference: string
- medium: string
- address: boolean
Example
{
"reference": "string",
"medium": "string",
"address": "boolean"
}
MesCancel: object
- reference: string
- medium: string
Example
{
"reference": "string",
"medium": "string"
}
OdrAttachFiltersResponse: object
- success: integer
- failed: integer
Example
{
"success": "integer",
"failed": "integer"
}
OdrAttachWarehouseItemsRequest: object
- order_item_id: string (uuid)
- inventory_item_id: string (uuid)
Example
{
"order_item_id": "string (uuid)",
"inventory_item_id": "string (uuid)"
}
OdrCancelState: object
- is_accepted: boolean
- warnings: string[]
-
string
Example
{
"is_accepted": "boolean",
"warnings": [
"string"
]
}
OdrCalculationAdjustment: object
- reference: string
- description: string
- amount: number 0
- is_percentage: boolean
- is_discount: boolean
- result: OdrCalculationAdjustmentResult
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
OdrCalculationAdjustmentResult: object
- is_applied_rule: boolean
- rule_id: string
- output: integer
-
The result of the rule. Will be negative in case of a discount.
Example
{
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
OdrContact: object
- tags: string[]
-
string - vat_country_code: string NL
- contact: OdrContactContact
Example
{
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
}
OdrContactContact: object
- email: string
- vat_number: string
- coc_number: string
- organisation_id: string
- organisation_version: string
- address_id: string
- phone_number_id: string
- id: string
- version: string
Example
{
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
OdrProjection: object
- items: OdrProjectionItem
-
OdrProjectionItem - subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - services: OdrServiceItem
-
OdrServiceItem - total: integer
- vat: OdrVatResult
-
OdrVatResult - customer: OdrContact
- vendor: OdrContact
- currency: string
- is_including_vat: boolean
- is_vat_shifted: boolean
- client_id: string
- pricing_at: string (date-time)
Example
{
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"currency": "string",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"client_id": "string",
"pricing_at": "string (date-time)"
}
OdrProjectionItem: object
- reference: string
- sku: string
- description: string
- type: string product, handling, shipping
- amount: integer
- is_discounted: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - vat_percentage: integer
- total: integer
- total_revenue: integer
Example
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer"
}
OdrServiceItem: object
- description: string
- type: string product, handling, shipping
- amount: number
- is_percentage: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrServiceAdjustment
-
OdrServiceAdjustment - vat_percentage: integer
- total: integer
Example
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
OdrServiceAdjustment: object
- reference: string
- description: string
- amount: number
- is_percentage: boolean
- is_discount: boolean
- result: OdrServiceAdjustmentResult
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
OdrServiceAdjustmentResult: object
- is_applied_rule: boolean
- rule_id: string (uuid)
- output: integer
Example
{
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
OdrOrderCalculationRequest: object
- expires_at: string (date-time)
- reference: string
- currency: string
- items: OdrCalculationItemModel
-
OdrCalculationItemModel - adjustments: OdrAdjustment
-
OdrAdjustment - pricing_at: string (date-time)
- metadata: object
Example
{
"expires_at": "string (date-time)",
"reference": "string",
"currency": "string",
"items": [
{
"item_ids": [
"string (uuid)"
],
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"pricing_at": "string (date-time)",
"metadata": "object"
}
OdrAdjustment: object
- reference: string
- description: string
- amount: number 0
- is_percentage: boolean
- is_discount: boolean
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
OdrCalculationItemModel: object
- item_ids: string[]
-
string (uuid) - description: string
- amount: integer
- is_discounted: boolean
- adjustments: OdrAdjustment
-
OdrAdjustment - vat_percentage: integer
Example
{
"item_ids": [
"string (uuid)"
],
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
OdrCalculations: object
- id: string
- number: string
- reference: string
- items: OdrCalculationItems
-
OdrCalculationItems - services: OdrServiceItem
-
OdrServiceItem - subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - total: integer
- vat: OdrVatResult
-
OdrVatResult - settings: OdrOrderCalculationSettings
- currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_prepaid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- invoiced_at: string (date-time)
- prepaid_at: string (date-time)
- order_ids: string[]
-
string - coupons: string[]
-
string - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"reference": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
},
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string"
}
}
}
OdrOrderCalculationSettings: object
- billing: OdrOrderCalculationSettingsBilling
- shipping: OdrOrderCalculationSettingsShipping
Example
{
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
}
OdrOrderCalculationSettingsBilling: object
- method_code: string
- issuer_code: string
- provider_code: string
- vat: OdrOrderSettingsBillingVat
Example
{
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
}
OdrOrderCalculationSettingsShipping: object
- method_id: string (uuid)
Example
{
"method_id": "string (uuid)"
}
OdrCalculationItems: object
- reference: string
- sku: string
- description: string
- type: string product, handling, shipping
- amount: integer
- is_discounted: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - vat_percentage: integer
- total: integer
- total_revenue: integer
- order_items: OdrCalculationStackItem
-
OdrCalculationStackItem
Example
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
OdrCalculationStackItem: object
- id: string
- is_invoiced: boolean
- invoice_id: string (uuid)
Example
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
OdrVatResult: object
- rate: integer
- amount: integer
Example
{
"rate": "integer",
"amount": "integer"
}
OdrSettings: object
- contact: OdrSettingsContact
- organisation: OdrSettingsContact
- phone_number_id: string (uuid)
- coupons: string[]
-
string - due_at: string (date)
- reference: string (string)
- return_url: string
- billing: OdrOrderModelSettingsBilling
- shipping: OdrOrderSettingsShipping
Example
{
"contact": {
"id": "string (uuid)"
},
"organisation": "#/definitions/OdrSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"reference": "string (string)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
}
OdrOrderModelSettingsBilling: object
- address_id: string (uuid)
- method_code: string
- issuer_code: string
- provider_code: string
- vat: OdrOrderSettingsBillingVat
Example
{
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
}
OdrOrderSettingsBillingVat: object
- is_shift_disabled: boolean false
- is_shift_required: boolean false
Example
{
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
OdrOrderSettings: object
- contact: OdrOrderSettingsContact
- organisation: OdrOrderSettingsContact
- phone_number_id: string (uuid)
- coupons: string[]
-
string - due_at: string (date)
- return_url: string
- billing: OdrOrderSettingsBilling
- shipping: OdrOrderSettingsShipping
Example
{
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
}
OdrOrderSettingsContact: object
- id: string (uuid)
- version: string (uuid)
Example
{
"id": "string (uuid)",
"version": "string (uuid)"
}
OdrOrderSettingsBilling: object
- address_id: string (uuid)
- method_code: string
- issuer_code: string
- provider_code: string
Example
{
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
}
OdrOrderSettingsShipping: object
- address_id: string (uuid)
- source_address_id: string (uuid)
- method_id: string (uuid)
- spid: string
- window: OdrOrderSettingsShippingWindow
- is_split_allowed: boolean
Example
{
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
OdrOrderSettingsShippingWindow: object
- from: integer
- to: integer
- delivery_at: string (date)
- code: string
Example
{
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
}
OdrOrderStep: object
- code: string
- order: integer
- is_reversible: boolean false
- trigger: string lock, accept, confirm confirm
- actions: OdrStepAction
-
OdrStepAction
Example
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
OdrStepAction: object
- code: string
- order: integer
- label: string
- is_handled: boolean
- handled_at: string (date-time)
Example
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
OdrOrder: object
- id: string (uuid)
- number: string
- state: OdrOrderState
- settings: OdrOrderSettings
- processing: OdrProcessing
- acceptances: OdrOrderAcceptances
-
OdrOrderAcceptances - calculations: OdrOrderCalculations
-
OdrOrderCalculations - client_id: string
- channel_id: string (uuid)
- tags: string[]
-
string - stack_id: string
- type: string
- last_accepted_at: string (date-time)
- last_confirmed_at: string (date-time)
- last_canceled_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"number": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
},
"settings": {
"contact": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"organisation": "#/definitions/OdrOrderSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"acceptances": [
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
],
"calculations": [
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
],
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"stack_id": "string",
"type": "string",
"last_accepted_at": "string (date-time)"
}
OdrOrderState: object
- is_locked: boolean
- is_accepted: boolean
- is_confirmed: boolean
- is_finished: boolean
- is_canceled: boolean
- type: string cart, order, backorder, wishlist
- flow: OdrOrderStep
-
OdrOrderStep - progress: OdrOrderStateProgress
Example
{
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean",
"is_canceled": "boolean",
"type": "string",
"flow": [
{
"code": "string",
"order": "integer",
"is_reversible": "boolean",
"trigger": "string",
"actions": [
{
"code": "string",
"order": "integer",
"label": "string",
"is_handled": "boolean",
"handled_at": "string (date-time)"
}
]
}
],
"progress": {
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
}
OdrOrderStateProgress: object
- allocation: string
- fulfilment: string
- billing: string
Example
{
"allocation": "string",
"fulfilment": "string",
"billing": "string"
}
OdrOrderAcceptances: object
- id: string (uuid)
- amount: integer
- is_prepaid: boolean
- is_settlement: boolean
- is_paid: boolean
- calculation_id: string (uuid)
- transaction_secret: string
- created_at: string (date-time)
- accepted_at: string (date-time)
Example
{
"id": "string (uuid)",
"amount": "integer",
"is_prepaid": "boolean",
"is_settlement": "boolean",
"is_paid": "boolean",
"calculation_id": "string (uuid)",
"transaction_secret": "string",
"created_at": "string (date-time)",
"accepted_at": "string (date-time)"
}
OdrOrderCalculations: object
- id: string (uuid)
- reference: string
- currency: string
- client_id: string (uuid)
- channel_id: string (uuid)
- amount: integer
- is_valid: boolean
- is_accepted: boolean
- is_confirmed: boolean
- expires_at: string (date-time)
Example
{
"id": "string (uuid)",
"reference": "string",
"currency": "string",
"client_id": "string (uuid)",
"channel_id": "string (uuid)",
"amount": "integer",
"is_valid": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"expires_at": "string (date-time)"
}
OdrProcessing: object
- confirm: string auto, manual
- allocation: string auto, manual, none
- fulfilment: string auto, manual, none
- capture: string auto, manual, none
Example
{
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
}
OdrStack: object
- id: string
- entity_id: string
- entity_type: string
- state: OdrStackState
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"entity_id": "string",
"entity_type": "string",
"state": {
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrStackState: object
- is_accepted: boolean
- is_confirmed: boolean
- is_finished: boolean
Example
{
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
OdrOrderModel: object
- processing: OdrProcessing
- settings: OdrSettings
- client_id: string
- channel_id: string (uuid)
- tags: string[]
-
string - type: string
- metadata: object
Example
{
"processing": {
"confirm": "string",
"allocation": "string",
"fulfilment": "string",
"capture": "string"
},
"settings": {
"contact": {
"id": "string (uuid)"
},
"organisation": "#/definitions/OdrSettingsContact",
"phone_number_id": "string (uuid)",
"coupons": [
"string"
],
"due_at": "string (date)",
"reference": "string (string)",
"return_url": "string",
"billing": {
"address_id": "string (uuid)",
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"address_id": "string (uuid)",
"source_address_id": "string (uuid)",
"method_id": "string (uuid)",
"spid": "string",
"window": {
"from": "integer",
"to": "integer",
"delivery_at": "string (date)",
"code": "string"
},
"is_split_allowed": "boolean"
}
},
"client_id": "string",
"channel_id": "string (uuid)",
"tags": [
"string"
],
"type": "string",
"metadata": "object"
}
OdrOrderAuthorizationResponse: object
- is_locked: boolean true
- is_accepted: boolean false
- is_confirmed: boolean false
- transaction_secret: string
Example
{
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"transaction_secret": "string"
}
OdrReferenceModel: object
- entity_id: string
- entity_type: string
- constraints: OdrSearchConstraint
-
OdrSearchConstraint
Example
{
"entity_id": "string",
"entity_type": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrSimpleOrderItem: object
- id: string
- reference: string
- sku: string
- description: string
- is_inbound: boolean false
Example
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"is_inbound": "boolean"
}
OdrOrderItem: object
- id: string
- reference: string
- sku: string
- description: string
- order_id: string (uuid)
- references: OdrOrderItemReferences
- filters: OdrFilter
-
OdrFilter
Example
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"order_id": "string (uuid)",
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
],
"stacks": [
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
OdrOrderItemReferences: object
Example
{
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
],
"stacks": [
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
]
}
OdrOrderItemReferencesOrder: object
- id: string (uuid)
- is_inbound: boolean false
- is_available: boolean false
- is_backorder: boolean false
- warehouse: OdrOrderItemReferencesOrderWarehouse
- shipments: OdrOrderItemReferencesOrderShipment
-
OdrOrderItemReferencesOrderShipment - backorders: string[]
-
string - target: string
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_available": "boolean",
"is_backorder": "boolean",
"warehouse": {
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
],
"backorders": [
"string"
],
"target": "string"
}
OdrOrderItemReferencesOrderWarehouse: object
- claimed_at: string (date-time)
- claim_id: string (uuid)
- claim_item_id: string (uuid)
- route_id: string (uuid)
- is_reservation: boolean false
- transfer_id: string (uuid)
Example
{
"claimed_at": "string (date-time)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
}
OdrOrderItemReferencesOrderShipment: object
- id: string (uuid)
- is_inbound: boolean
- is_missing: boolean
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
OdrFilter: object
- key: string
- values: string[]
-
string
Example
{
"key": "string",
"values": [
"string"
]
}
OdrOrderItemModel: object
- sku: string
- reference: string (uuid)
- description: string
- quantity: integer
- is_inbound: boolean false
- is_backorder: boolean false
- item_ids: string[]
-
string (uuid) - source_order_id: string (uuid)
Example
{
"sku": "string",
"reference": "string (uuid)",
"description": "string",
"quantity": "integer",
"is_inbound": "boolean",
"is_backorder": "boolean",
"item_ids": [
"string (uuid)"
],
"source_order_id": "string (uuid)"
}
OdrGroup: object
- sku: string
- reference: string
- description: string
- quantity: integer
- ids: string[]
-
string (uuid) - references: OdrGroupReferences
- filters: OdrFilter
-
OdrFilter
Example
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
],
"target": "string"
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
OdrGroupReferences: object
- orders: OdrGroupReferencesOrder
-
OdrGroupReferencesOrder - backorders: string[]
-
string (uuid) - target: string
Example
{
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
],
"target": "string"
}
OdrGroupReferencesOrder: object
- id: string (uuid)
- is_inbound: boolean false
- is_backordered: boolean false
- is_unavailable: boolean
- warehouse: OdrGroupReferencesOrderWarehouse
- shipments: OdrGroupReferencesOrderShipment
-
OdrGroupReferencesOrderShipment
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
OdrGroupReferencesOrderWarehouse: object
- claim_id: string (uuid)
- delivery_route_id: string (uuid)
- collect_route_id: string (uuid)
- is_reservation: boolean false
- address_id: string
- transfer_id: string (uuid)
Example
{
"claim_id": "string (uuid)",
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"is_reservation": "boolean",
"address_id": "string",
"transfer_id": "string (uuid)"
}
OdrGroupReferencesOrderShipment: object
- id: string (uuid)
- is_inbound: boolean
- is_missing: boolean
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
OdrGroupRoute: object
- sku: string
- reference: string
- description: string
- quantity: integer
- order_id: string (uuid)
- ids: string[]
-
string (uuid) - references: OdrGroupRouteReferences
- filters: OdrFilter
-
OdrFilter - delivery_routes: OdrGroupRouteDeliveryRoute
-
OdrGroupRouteDeliveryRoute - collect_routes: OdrGroupRouteCollectRoute
-
OdrGroupRouteCollectRoute
Example
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"order_id": "string (uuid)",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
],
"delivery_routes": [
{
"id": "string (uuid)",
"name": "string"
}
],
"collect_routes": [
{
"id": "string (uuid)",
"name": "string",
"delivery_routes": [
"string"
]
}
]
}
OdrGroupRouteReferences: object
- orders: OdrGroupRouteReferencesOrder
-
OdrGroupRouteReferencesOrder - backorders: string[]
-
string (uuid)
Example
{
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
}
OdrGroupRouteReferencesOrder: object
- id: string (uuid)
- is_inbound: boolean false
- is_backordered: boolean false
- is_unavailable: boolean
- warehouse: OdrGroupRouteReferencesOrderWarehouse
- shipments: OdrGroupRouteReferencesOrderShipment
-
OdrGroupRouteReferencesOrderShipment
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
OdrGroupRouteReferencesOrderWarehouse: object
- claim_id: string (uuid)
- route_id: string (uuid)
- is_reservation: boolean false
- transfer_id: string (uuid)
Example
{
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
}
OdrGroupRouteReferencesOrderShipment: object
- id: string (uuid)
- is_inbound: boolean
- is_missing: boolean
Example
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
OdrGroupRouteDeliveryRoute: object
- id: string (uuid)
- name: string
Example
{
"id": "string (uuid)",
"name": "string"
}
OdrGroupRouteCollectRoute: object
- id: string (uuid)
- name: string
- delivery_routes: string[]
-
delivery routes that originate from the collect route
-
string
Example
{
"id": "string (uuid)",
"name": "string",
"delivery_routes": [
"string"
]
}
OdrGroupAttach: object
- sku: string
- reference: string
- description: string
- quantity: integer
- order_id: string (uuid)
- ids: string[]
-
string (uuid) - references: OdrGroupRouteReferences
- filters: OdrFilter
-
OdrFilter - inventory_item_ids: string[]
-
string (uuid) - available: number
Example
{
"sku": "string",
"reference": "string",
"description": "string",
"quantity": "integer",
"order_id": "string (uuid)",
"ids": [
"string (uuid)"
],
"references": {
"orders": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_backordered": "boolean",
"is_unavailable": "boolean",
"warehouse": {
"claim_id": "string (uuid)",
"route_id": "string (uuid)",
"is_reservation": "boolean",
"transfer_id": "string (uuid)"
},
"shipments": [
{
"id": "string (uuid)",
"is_inbound": "boolean",
"is_missing": "boolean"
}
]
}
],
"backorders": [
"string (uuid)"
]
},
"filters": [
{
"key": "string",
"values": [
"string"
]
}
],
"inventory_item_ids": [
"string (uuid)"
],
"available": "number"
}
OdrStackReference: object
- id: string
- type: string
- state: OdrStackReferenceState
Example
{
"id": "string",
"type": "string",
"state": {
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
}
OdrStackReferenceState: object
- is_locked: boolean
- is_accepted: boolean
- is_confirmed: boolean
- is_finished: boolean
Example
{
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_finished": "boolean"
}
OdrSearch: object
- constraints: OdrSearchConstraint
-
OdrSearchConstraint - filters: OdrSearchFilter
-
OdrSearchFilter
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"filters": [
{
"key": "string",
"values": [
"string"
]
}
]
}
OdrSearchConstraint: object
- key: string item_ids, order_ids, stack_ids, skus, order_count, is_unavailable, is_backordered, is_inbound, backorder_count, backorder_ids, target, shipment_count
- operator: string in, gte, lte
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrOrderSearch: object
- constraints: OdrOrderSearchConstraint
-
OdrOrderSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrOrderSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrSearchFilter: object
- key: string
- values: string[]
-
string
Example
{
"key": "string",
"values": [
"string"
]
}
OdrFilterSearch: object
- constraints: OdrFilterSearchConstraint
-
OdrFilterSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrFilterSearchConstraint: object
- key: string skus
- operator: string in, gte, lte
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrSetClaimRequest: object
- item_id: string (uuid)
- claim_id: string (uuid)
- claim_item_id: string (uuid)
Example
{
"item_id": "string (uuid)",
"claim_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
OdrSku: object
- sku: string
- description: string
- expires_at: string (date-time)
Example
{
"sku": "string",
"description": "string",
"expires_at": "string (date-time)"
}
OdrSetRouteRequest: object
- item_ids: string[]
-
string (uuid) - delivery_route_id: string (uuid)
- collect_route_id: string (uuid)
Example
{
"item_ids": [
"string (uuid)"
],
"delivery_route_id": "string (uuid)",
"collect_route_id": "string (uuid)"
}
OdrSkuResult: object
- status: string
- count: integer
Example
{
"status": "string",
"count": "integer"
}
IntApp: object
- code: string
- name: string
- description: string
- tags: string[]
-
string - author: IntAuthor
- is_published: boolean
- is_duplicate_allowed: boolean false
- authentication: object
-
- type: string redirect, post
- schema: string
- config_schema: string
Example
{
"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"
}
IntAuthor: object
- name: string
- description: string
- url: string
- is_third_party: boolean
Example
{
"name": "string",
"description": "string",
"url": "string",
"is_third_party": "boolean"
}
IntIntegration: object
- 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)
Example
{
"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)"
}
IntIntegrationModel: object
- name: string
- credentials: object
- configuration: object
Example
{
"name": "string",
"credentials": "object",
"configuration": "object"
}
IntInstallResult: object
- state: string pending_authentication, success, failed
- redirect_url: string
Example
{
"state": "string",
"redirect_url": "string"
}
MesMailModel: object
- from: MesContactModel
- to: MesContactModel
-
MesContactModel - cc: MesContactModel
-
MesContactModel - bcc: MesContactModel
-
MesContactModel - reply_to: MesContactModel
- subject: string
- html_body: string
- attachments: string[]
-
string - folder: string
- is_unread: boolean
- metadata: object
Example
{
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"metadata": "object"
}
MesFormMailModel: object
- from: MesContactModel
- to: MesContactModel
-
MesContactModel - cc: MesContactModel
-
MesContactModel - bcc: MesContactModel
-
MesContactModel - reply_to: MesContactModel
- recaptcha_response: string
- subject: string
- html_body: string
- attachments: string[]
-
string - folder: string sent
- is_unread: boolean
- metadata: object
Example
{
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"recaptcha_response": "string",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"metadata": "object"
}
MesMail: object
- id: string
- from: MesContactModel
- to: MesContactModel
-
MesContactModel - cc: MesContactModel
-
MesContactModel - bcc: MesContactModel
-
MesContactModel - reply_to: MesContactModel
- subject: string
- html_body: string
- attachments: string[]
-
string - folder: string inbox, concept, sent, spam
- is_unread: boolean
- inbox_id: string
- metadata: object
- delivered_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"from": {
"name": "string",
"email": "string"
},
"to": [
"#/definitions/MesContactModel"
],
"cc": [
"#/definitions/MesContactModel"
],
"bcc": [
"#/definitions/MesContactModel"
],
"reply_to": "#/definitions/MesContactModel",
"subject": "string",
"html_body": "string",
"attachments": [
"string"
],
"folder": "string",
"is_unread": "boolean",
"inbox_id": "string",
"metadata": "object",
"delivered_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesInbox: object
- id: string
- label: string
- fqdn: string
- prefix: string
- user_id: string
- folders: string[]
-
string - settings: MesInboxSettings
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"folders": [
"string"
],
"settings": {
"recaptcha_integration_id": "string (uuid)"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesInboxModel: object
- label: string
- fqdn: string
- prefix: string
- user_id: string
-
ID of the user; only allowed for non to.afosto.io domains
- settings: MesInboxSettings
Example
{
"label": "string",
"fqdn": "string",
"prefix": "string",
"user_id": "string",
"settings": {
"recaptcha_integration_id": "string (uuid)"
}
}
MesInboxSettings: object
- recaptcha_integration_id: string (uuid)
Example
{
"recaptcha_integration_id": "string (uuid)"
}
MesInboxUpdateModel: object
- label: string
- user_id: string
- settings: MesInboxSettings
Example
{
"label": "string",
"user_id": "string",
"settings": {
"recaptcha_integration_id": "string (uuid)"
}
}
MesDnsRecord: object
- type: string
- name: string
- value: string
- is_verified: boolean false
Example
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
MesDomain: object
- id: string
- is_verified: boolean
- dns: MesDnsRecord
-
MesDnsRecord - tenant_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"is_verified": "boolean",
"dns": [
{
"type": "string",
"name": "string",
"value": "string",
"is_verified": "boolean"
}
],
"tenant_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrCoupon: object
- code: string
- usage: OdrCouponUsage
- category_id: string (uuid)
- claims: OdrCouponClaim
-
OdrCouponClaim - expires_at: string (date-time)
- created_at: string (date-time)
Example
{
"code": "string",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"claims": [
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
],
"expires_at": "string (date-time)",
"created_at": "string (date-time)"
}
OdrCouponUsage: object
- is_unlimited: boolean false
- remaining: integer
Example
{
"is_unlimited": "boolean",
"remaining": "integer"
}
OdrCouponClaim: object
- order_id: string (uuid)
- is_confirmed: boolean
Example
{
"order_id": "string (uuid)",
"is_confirmed": "boolean"
}
OdrCouponModel: object
- code: string
- usage: OdrCouponUsage
- category_id: string (uuid)
- expires_at: string (date-time)
Example
{
"code": "string",
"usage": {
"is_unlimited": "boolean",
"remaining": "integer"
},
"category_id": "string (uuid)",
"expires_at": "string (date-time)"
}
OdrCouponCategory: object
- id: string (uuid)
- name: string
- defaults: OdrCouponCategoryDefaults
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrCouponCategoryDefaults: object
- expires_after: integer
-
Time in seconds
- usage: OdrCouponCategoryDefaultsUsage
Example
{
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
}
OdrCouponCategoryDefaultsUsage: object
- is_unlimited: boolean false
- limit: integer
Example
{
"is_unlimited": "boolean",
"limit": "integer"
}
OdrCouponCategoryModel: object
- name: string
- defaults: OdrCouponCategoryDefaults
Example
{
"name": "string",
"defaults": {
"expires_after": "integer",
"usage": {
"is_unlimited": "boolean",
"limit": "integer"
}
}
}
OdrService: object
- id: string (uuid)
- name: string
- constraints: OdrPricingRuleConstraint
-
OdrPricingRuleConstraint - type: string handling, shipping
- amount: number
- is_percentage: boolean
- vat_settings: OdrServiceVatConfiguration
-
OdrServiceVatConfiguration - priority: integer
- metadata: object
- active_at: string (date-time)
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrServiceModel: object
- name: string
- constraints: OdrPricingRuleConstraint
-
OdrPricingRuleConstraint - type: string handling, shipping
- amount: number
- is_percentage: boolean
- vat_settings: OdrServiceVatConfiguration
-
OdrServiceVatConfiguration - priority: integer
- metadata: object
- active_at: string (date-time)
- expires_at: string (date-time)
Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"vat_settings": [
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
],
"priority": "integer",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
OdrServiceVatConfiguration: object
- type: string fixed, max, weighed
- reference: integer
- country_code: string
Example
{
"type": "string",
"reference": "integer",
"country_code": "string"
}
OdrCalculatedInvoiceRequest: object
- order_item_ids: string[]
-
string (uuid)
Example
{
"order_item_ids": [
"string (uuid)"
]
}
OdrListedCalculation: object
- id: string
- number: string
- reference: string
- subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - total: integer
- vat: OdrVatResult
-
OdrVatResult - currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_prepaid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- invoiced_at: string (date-time)
- prepaid_at: string (date-time)
- order_ids: string[]
-
string - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"reference": "string",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_prepaid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"prepaid_at": "string (date-time)",
"order_ids": [
"string"
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrCalculation: object
- id: string
- number: string
- reference: string
- items: OdrCalculationItem
-
OdrCalculationItem - services: OdrServiceItem
-
OdrServiceItem - subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - total: integer
- vat: OdrVatResult
-
OdrVatResult - currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_prepaid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- invoiced_at: string (date-time)
- prepaid_at: string (date-time)
- order_ids: string[]
-
string - coupons: string[]
-
string - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"reference": "string",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_prepaid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"prepaid_at": "string (date-time)",
"order_ids": [
null
]
}
OdrCalculationItem: object
- id: string
- reference: string
- sku: string
- description: string
- type: string product, handling, shipping
- amount: integer
- is_discounted: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrCalculationAdjustment
-
OdrCalculationAdjustment - vat_percentage: integer
- total: integer
- total_revenue: integer
- order_items: OdrCalculationOrderItem
-
OdrCalculationOrderItem
Example
{
"id": "string",
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
OdrInvoiceItem: object
- id: string (uuid)
-
The ID of this invoice item
- sku: string
- description: string
- type: string product, handling, shipping, purchasable
- amount: integer
- is_discounted: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrInvoiceAdjustmentResponse
-
OdrInvoiceAdjustmentResponse - vat_percentage: integer
- total: integer
- total_revenue: integer
- order_items: OdrCalculationOrderItem
-
OdrCalculationOrderItem
Example
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
OdrCalculationOrderItem: object
- id: string
- is_invoiced: boolean
- invoice_id: string
Example
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
OdrInvoice: object
- id: string
- number: string
- reference: string
- items: OdrInvoiceItem
-
OdrInvoiceItem - services: OdrServiceItem
-
OdrServiceItem - settings: OdrInvoiceSettings
- subtotal: integer
- adjustments: OdrInvoiceAdjustmentResponse
-
OdrInvoiceAdjustmentResponse - total: integer
- vat: OdrVatResult
-
OdrVatResult - currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_paid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- paid_at: string (date-time)
- order_ids: string[]
-
string (uuid) - coupons: string[]
-
string (uuid) - calculation_id: string (uuid)
- shipment_id: string (uuid)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"reference": "string",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
},
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrInvoiceAdjustmentResponse"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact"
}
OdrInvoiceSettings: object
- billing: OdrInvoiceSettingsBilling
- shipping: OdrInvoiceSettingsShipping
Example
{
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
}
OdrInvoiceSettingsBilling: object
- method_code: string
- issuer_code: string
- provider_code: string
- vat: OdrInvoiceSettingsBillingVat
Example
{
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
}
OdrInvoiceSettingsBillingVat: object
- is_shift_disabled: boolean
- is_shift_required: boolean
Example
{
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
OdrInvoiceListItem: object
- id: string
- number: string
- reference: string
- count: integer
- subtotal: integer
- adjustments: OdrInvoiceAdjustmentResponse
-
OdrInvoiceAdjustmentResponse - total: integer
- vat: OdrVatResult
-
OdrVatResult - currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_paid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- invoiced_at: string (date-time)
- paid_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"reference": "string",
"count": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string",
"version": "string"
}
},
"vendor": "#/definitions/OdrContact",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"is_paid": "boolean",
"client_id": "string",
"channel_id": "string (uuid)",
"file_id": "string",
"metadata": "object",
"pricing_at": "string (date-time)",
"invoiced_at": "string (date-time)",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrInvoiceRequest: object
- reference: string
- client_id: string
- channel_id: string (uuid)
- contact_id: string
- organisation_id: string
- address_id: string
- items: OdrInvoiceItemModel
-
OdrInvoiceItemModel - adjustments: OdrAdjustment
-
OdrAdjustment - currency: string
- pricing_at: string (date-time)
- metadata: object
Example
{
"reference": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"contact_id": "string",
"organisation_id": "string",
"address_id": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"currency": "string",
"pricing_at": "string (date-time)",
"metadata": "object"
}
OdrInvoiceItemModel: object
- reference: string
- sku: string
- description: string
- amount: integer
- is_discounted: boolean
- quantity: integer
- adjustments: OdrAdjustment
-
OdrAdjustment - vat_percentage: integer
Example
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
OdrItemModel: object
- reference: string
- sku: string
- description: string
- amount: integer
- is_discounted: boolean
- quantity: integer
- adjustments: OdrAdjustment
-
OdrAdjustment - vat_percentage: integer
Example
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
OdrProjectionModel: object
- client_id: string
- currency: string
- items: OdrItemModel
-
OdrItemModel - adjustments: OdrAdjustment
-
OdrAdjustment - contact_id: string
- organisation_id: string
- pricing_at: string (date-time)
- coupons: string[]
-
string - settings: OdrProjectionModelSettings
Example
{
"client_id": "string",
"currency": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"vat_percentage": "integer"
}
],
"adjustments": [
"#/definitions/OdrAdjustment"
],
"contact_id": "string",
"organisation_id": "string",
"pricing_at": "string (date-time)",
"coupons": [
"string"
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
}
}
OdrProjectionModelSettings: object
- billing: OdrProjectionModelSettingsBilling
- shipping: OdrProjectionModelSettingsShipping
Example
{
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string"
}
}
OdrProjectionModelSettingsBilling: object
- method_code: string
- issuer_code: string
- provider_code: string
- vat: OdrProjectionModelSettingsBillingVat
Example
{
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
}
OdrProjectionModelSettingsBillingVat: object
- is_shift_disabled: boolean false
- is_shift_required: boolean false
Example
{
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
OdrInvoiceAdjustmentResponse: object
- reference: string
- description: string
- amount: number 0
- is_percentage: boolean
- is_discount: boolean
- result: OdrInvoiceAdjustmentResponseResult
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"output": "integer"
}
}
OdrInvoiceAdjustmentResponseResult: object
- output: integer
-
The result of the rule. Will be negative in case of a discount.
Example
{
"output": "integer"
}
OdrPricingRuleModel: object
- name: string
- constraints: OdrPricingRuleConstraint
-
OdrPricingRuleConstraint - filters: OdrPricingRuleFilter
-
OdrPricingRuleFilter - adjustments: OdrAdjustment
-
OdrAdjustment - apply_to: string lines_handling, lines_shipping, lines_cheapest, lines_all, filter_result, filter_cheapest
- grant_limit: integer 0
- priority: integer
- is_last_rule: boolean
- evaluate_at: string rule, order, line
- metadata: object
- active_at: string (date-time)
- expires_at: string (date-time)
Example
{
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"is_last_rule": "boolean",
"evaluate_at": "string",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)"
}
OdrPricingRule: object
- id: string
- name: string
- constraints: OdrPricingRuleConstraint
-
OdrPricingRuleConstraint - filters: OdrPricingRuleFilter
-
OdrPricingRuleFilter - adjustments: OdrAdjustment
-
OdrAdjustment - apply_to: string lines_handling, lines_shipping, lines_cheapest, lines_all, filter_result, filter_cheapest
- grant_limit: integer 0
- priority: integer
- evaluate_at: string rule, order, line
- is_last_rule: boolean
- metadata: object
- active_at: string (date-time)
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
],
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"apply_to": "string",
"grant_limit": "integer",
"priority": "integer",
"evaluate_at": "string",
"is_last_rule": "boolean",
"metadata": "object",
"active_at": "string (date-time)",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrPricingRuleFilter: object
- key: string sku, filter, is_discounted, per
- operator: string in
- values: object[]
-
object
Example
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
OdrPricingRuleConstraint: object
- key: string quantity, amount, client, tags, shipping_method, payment_method, coupon
- operator: string in, gte, gt, lte, lt
- values: object[]
-
object
Example
{
"key": "string",
"operator": "string",
"values": [
"object"
]
}
OdrPriceRuleEvaluation: object
- pricing_at: string (date-time)
- quantity: integer
-
Count of items on invoice
- amount: integer
-
Invoice total
- client: string
-
Id of the client that should be used
- tags: string[]
-
Tags of customer groups
-
string - shipping_method: string
-
Id of shipping method that should be used
- payment_method: string
-
Id of payment method that should be used
- coupons: string[]
-
Ids of coupons that should be tested
-
string - items: OdrEvaluationItem
-
OdrEvaluationItem
Example
{
"pricing_at": "string (date-time)",
"quantity": "integer",
"amount": "integer",
"client": "string",
"tags": [
"string"
],
"shipping_method": "string",
"payment_method": "string",
"coupons": [
"string"
],
"items": [
{
"reference": "string",
"sku": "string",
"filters": "object",
"quantity": "integer",
"is_discounted": "boolean"
}
]
}
OdrEvaluationItem: object
- reference: string
- sku: string
- filters: object
- quantity: integer
- is_discounted: boolean
Example
{
"reference": "string",
"sku": "string",
"filters": "object",
"quantity": "integer",
"is_discounted": "boolean"
}
OdrInvoiceSearch: object
- constraints: OdrInvoiceSearchConstraint
-
OdrInvoiceSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrInvoiceSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrCalculationSearch: object
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrCalculationSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrCouponCategorySearch: object
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrCouponCategorySearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
OdrCouponSearch: object
- constraints: OdrCouponSearchConstraint
-
OdrCouponSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
OdrCouponSearchConstraint: object
- key: string codes, is_available
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CntAction: object
- id: string
- code: string
- description: string
- config_schema: string
- columns: CntColumnConfig
-
CntColumnConfig
Example
{
"id": "string",
"code": "string",
"description": "string",
"config_schema": "string",
"columns": [
{
"key": "string",
"description": "string",
"is_required": "boolean",
"regex": "string"
}
]
}
CntColumnConfig: object
- key: string
- description: string
- is_required: boolean
- regex: string
Example
{
"key": "string",
"description": "string",
"is_required": "boolean",
"regex": "string"
}
CntDataset: object
- id: string (uuid)
- reference: string
- line_count: integer
- file_id: string
- is_locked: boolean false
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"reference": "string",
"line_count": "integer",
"file_id": "string",
"is_locked": "boolean",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntDatasetRequest: object
- reference: string
- expires_at: string (date-time)
Example
{
"reference": "string",
"expires_at": "string (date-time)"
}
CntBatchRequest: object
- action_id: string
- reference: string
- dataset_id: string (uuid)
- config: object
- import: object
-
- mapping: object[]
-
object
- export: object
-
- view: string
Example
{
"action_id": "string",
"reference": "string",
"dataset_id": "string (uuid)",
"config": "object",
"import": {
"mapping": [
"object"
]
},
"export": {
"view": "string"
}
}
CntBatch: object
- id: string (uuid)
- action_id: string
- reference: string
- is_import: boolean
- is_locked: boolean
- is_accepted: boolean
- is_confirmed: boolean
- is_ready: boolean false
- is_failing: boolean false
- config: object
- import: object
-
- mapping: object
- export: object
-
- view: string
- task_id: string (uuid)
- dataset_id: string (uuid)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"action_id": "string",
"reference": "string",
"is_import": "boolean",
"is_locked": "boolean",
"is_accepted": "boolean",
"is_confirmed": "boolean",
"is_ready": "boolean",
"is_failing": "boolean",
"config": "object",
"import": {
"mapping": "object"
},
"export": {
"view": "string"
},
"task_id": "string (uuid)",
"dataset_id": "string (uuid)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntLine: object
- reference: string (uuid)
- data: object
Example
{
"reference": "string (uuid)",
"data": "object"
}
CntLineError: object
- reference: string (uuid)
- errors: CntColumnError
-
CntColumnError
Example
{
"reference": "string (uuid)",
"errors": [
{
"column": "string",
"level": "string",
"message": "string"
}
]
}
CntColumnError: object
- column: string
- level: string error, warning, notice
- message: string
Example
{
"column": "string",
"level": "string",
"message": "string"
}
IamLog: object
- id: string (uuid)
- category: string AUDIT, ERROR, REQUEST
- code: string order.confirmed, E45245.24625, 500
-
order.confirmed for AUDIT, E44532543 for ERROR, http statuscode for REQUEST
- resource: object
-
- trace: string
- stream: string integrations/342524545243455, transactions/provider/paynl, orders, POST
- entity_type: string
- entity_id: string (uuid)
- actor: object
-
- entity_type: string user, system, machine
-
User when action was triggered by a human. System in case the action was caused by the system. Machine in case the action was performaned by a machine.
- entity_id: string
-
User ID, service (APP_NAME) or client ID
- metadata: object
- processed_at: string (date-time)
- created_at: string (date-time)
Example
{
"id": "string (uuid)",
"category": "string",
"code": "string",
"resource": {
"trace": "string",
"stream": "string",
"entity_type": "string",
"entity_id": "string (uuid)"
},
"actor": {
"entity_type": "string",
"entity_id": "string"
},
"metadata": "object",
"processed_at": "string (date-time)",
"created_at": "string (date-time)"
}
IamQuery: object
- filter: IamQueryConstraint
-
IamQueryConstraint - limit: integer
- offset: integer
Example
{
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"limit": "integer",
"offset": "integer"
}
IamQueryConstraint: object
- key: string
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CatMapCollection: object
- id: string
- last_upsert_at: string (date-time)
- last_miss_at: string (date-time)
Example
{
"id": "string",
"last_upsert_at": "string (date-time)",
"last_miss_at": "string (date-time)"
}
CatMapCollectionMiss: object
- key: string
- count: integer
- last_miss_at: string (date-time)
Example
{
"key": "string",
"count": "integer",
"last_miss_at": "string (date-time)"
}
CatMap: object
- key: string
- value: string
- upserted_at: string (date-time)
Example
{
"key": "string",
"value": "string",
"upserted_at": "string (date-time)"
}
LcsDPDServicePointResponse: object
- parcelShop: LcsDPDServicePoint
-
LcsDPDServicePoint
Example
{
"parcelShop": [
{
"parcelShopId": "number",
"pudoId": "string",
"company": "string",
"street": "string",
"houseNo": "string",
"country": "string",
"countryNum": "number",
"zipCode": "string",
"city": "string",
"town": "string",
"phone": "string",
"fax": "string",
"email": "string",
"homepage": "string",
"latitude": "number",
"longitude": "number",
"coordinateX": "number",
"coordinateY": "number",
"coordinateZ": "number",
"distance": "number",
"expressPickupTime": "string",
"extraInfo": "string",
"openingHours": [
{
"weekday": "string",
"openMorning": "string",
"closeMorning": "string",
"closeAfternoon": "string",
"openAfternoon": "string"
}
],
"services": [
"object"
]
}
]
}
LcsDPDServicePoint: object
- parcelShopId: number
- pudoId: string
- company: string
- street: string
- houseNo: string
- country: string
- countryNum: number
- zipCode: string
- city: string
- town: string
- phone: string
- fax: string
- email: string
- homepage: string
- latitude: number
- longitude: number
- coordinateX: number
- coordinateY: number
- coordinateZ: number
- distance: number
- expressPickupTime: string
- extraInfo: string
- openingHours: object[]
-
object - weekday: string
- openMorning: string
- closeMorning: string
- closeAfternoon: string
- openAfternoon: string
- services: object[]
-
object
Example
{
"parcelShopId": "number",
"pudoId": "string",
"company": "string",
"street": "string",
"houseNo": "string",
"country": "string",
"countryNum": "number",
"zipCode": "string",
"city": "string",
"town": "string",
"phone": "string",
"fax": "string",
"email": "string",
"homepage": "string",
"latitude": "number",
"longitude": "number",
"coordinateX": "number",
"coordinateY": "number",
"coordinateZ": "number",
"distance": "number",
"expressPickupTime": "string",
"extraInfo": "string",
"openingHours": [
{
"weekday": "string",
"openMorning": "string",
"closeMorning": "string",
"closeAfternoon": "string",
"openAfternoon": "string"
}
],
"services": [
"object"
]
}
IamBackup: object
- channel: string sms, email
- address: string
Example
{
"channel": "string",
"address": "string"
}
IamBackupResponse: object
- address: string
- created_at: string (date-time)
Example
{
"address": "string",
"created_at": "string (date-time)"
}
IamSecretRead: object
Example
{
"id": "string",
"type": "string",
"sub": "string",
"name": "string",
"secret_last_4": "string",
"is_confirmed": "boolean",
"backups": [
{
"channel": "string",
"address": "string"
}
],
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamSecret: object
- id: string
- type: string
- sub: string
- name: string
- secret: string
- is_confirmed: boolean
- qr_url: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"type": "string",
"sub": "string",
"name": "string",
"secret": "string",
"is_confirmed": "boolean",
"qr_url": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrKey: object
- entity_id: string (uuid)
- entity_type: string
Example
{
"entity_id": "string (uuid)",
"entity_type": "string"
}
OdrBalanceRequest: object
Example
{
"key": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"reference": "#/definitions/OdrKey",
"description": "string",
"currency": "string",
"amount": "integer",
"overdraft_allowance": "integer"
}
OdrBalance: object
- id: string (uuid)
- key: OdrKey
- balance: integer
- currency: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"key": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"balance": "integer",
"currency": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrRecord: object
- id: string (uuid)
- reference: OdrKey
- description: string
- amount: integer
- created_at: string (date-time)
Example
{
"id": "string (uuid)",
"reference": {
"entity_id": "string (uuid)",
"entity_type": "string"
},
"description": "string",
"amount": "integer",
"created_at": "string (date-time)"
}
SplPrinter: object
- id: string
- name: string
- hub_id: string
- default_encoding: string escpos
- connection: SplConnection
- settings: SplSettings
- inbox_id: string
- disabled_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object",
"inbox_id": "string",
"disabled_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
SplPrinterModel: object
- name: string
- hub_id: string
- default_encoding: string
- timezone: string Europe/Amsterdam
- connection: SplConnection
- settings: SplSettings
Example
{
"name": "string",
"hub_id": "string",
"default_encoding": "string",
"timezone": "string",
"connection": {
"interface": "string",
"address": "string"
},
"settings": "object"
}
SplConnection: object
- interface: string usb, ethernet
- address: string
Example
{
"interface": "string",
"address": "string"
}
SplSettingsSchema: object
- type: string
- schema: string
Example
{
"type": "string",
"schema": "string"
}
CntProxy: object
- key: string
- origin: string
- config: CntConfig
- secret: string
- tenant_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
},
"secret": "string",
"tenant_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntProxyModel: object
- key: string
- origin: string
- config: CntConfig
Example
{
"key": "string",
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
CntProxyUpdateModel: object
- origin: string
- config: CntConfig
Example
{
"origin": "string",
"config": {
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
}
CntConfig: object
- is_origin_cache_ignored: boolean true
- is_canonical_added: boolean true
- watermark_url: string
Example
{
"is_origin_cache_ignored": "boolean",
"is_canonical_added": "boolean",
"watermark_url": "string"
}
IamUpcomingInvoice: object
- id: string
- total: integer
- is_paid: boolean
- is_cancelled: boolean
- invoiced_at: string (date-time)
- reference: string
- products: IamInvoiceProduct
-
IamInvoiceProduct - start_at: string (date-time)
- end_at: string (date-time)
Example
{
"id": "string",
"total": "integer",
"is_paid": "boolean",
"is_cancelled": "boolean",
"invoiced_at": "string (date-time)",
"reference": "string",
"products": [
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"quantity": "integer",
"amount": "integer",
"is_trial": "boolean",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
}
}
],
"start_at": "string (date-time)",
"end_at": "string (date-time)"
}
IamInvoice: object
- id: string
- total: integer
- is_paid: boolean
- is_pending: boolean
- is_cancelled: boolean
- invoiced_at: string (date-time)
- reference: string
- products: IamProduct
-
IamProduct - pdf: string
- payment_url: string
- start_at: string (date-time)
- end_at: string (date-time)
Example
{
"id": "string",
"total": "integer",
"is_paid": "boolean",
"is_pending": "boolean",
"is_cancelled": "boolean",
"invoiced_at": "string (date-time)",
"reference": "string",
"products": [
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
}
],
"pdf": "string",
"payment_url": "string",
"start_at": "string (date-time)",
"end_at": "string (date-time)"
}
IamBillingCompany: object
- name: string
- vat_number: string
- billing_email: string
- phone_number: string
- address: IamAddress
Example
{
"name": "string",
"vat_number": "string",
"billing_email": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
}
IamAddress: object
- address_line_1: string
- address_line_2: string
- postal_code: string
- city: string
- country_code: string
Example
{
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
IamPaymentSource: object
- id: string
- last_4: string
- name: string
- is_default: boolean
- brand: string
- expires_at: string (date-time)
- mandate: string
Example
{
"id": "string",
"last_4": "string",
"name": "string",
"is_default": "boolean",
"brand": "string",
"expires_at": "string (date-time)",
"mandate": "string"
}
IamSubscription: object
- id: string
- code: string
- is_renewing: boolean
- start_at: string (date-time)
- end_at: string (date-time)
- items: IamSubscriptionItem
-
IamSubscriptionItem
Example
{
"id": "string",
"code": "string",
"is_renewing": "boolean",
"start_at": "string (date-time)",
"end_at": "string (date-time)",
"items": [
{
"id": "string",
"product": {
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
},
"type": "string"
}
]
}
IamSubscriptionItem: object
- id: string
- product: IamProduct
- type: string license, usage
Example
{
"id": "string",
"product": {
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
},
"type": "string"
}
IamTrial: object
- is_on_trial: boolean
- trial_balance: integer
- trial_ends_at: string (date-time)
Example
{
"is_on_trial": "boolean",
"trial_balance": "integer",
"trial_ends_at": "string (date-time)"
}
IamInvoiceProduct: object
- id: string
-
The stripe id
- code: string
-
Three letter string that is also used to prefix scopes
- name: string
- description: string
- unit: string
- quantity: integer
- amount: integer
- is_trial: boolean
- plan: IamPlan
Example
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"quantity": "integer",
"amount": "integer",
"is_trial": "boolean",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
}
}
IamProduct: object
- id: string
-
The stripe id
- code: string
-
Three letter string that is also used to prefix scopes
- name: string
- description: string
- unit: string
- plan: IamPlan
- is_add_on: boolean
Example
{
"id": "string",
"code": "string",
"name": "string",
"description": "string",
"unit": "string",
"plan": {
"id": "string",
"interval": "string",
"type": "string",
"amount": "integer",
"tiers": [
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
]
},
"is_add_on": "boolean"
}
IamTier: object
- up_to: integer
- flat_amount: integer
- unit_amount: integer
Example
{
"up_to": "integer",
"flat_amount": "integer",
"unit_amount": "integer"
}
IamUsageRecord: object
- code: string
- unit: string
- quantity: integer
Example
{
"code": "string",
"unit": "string",
"quantity": "integer"
}
CntObjectCloneRequest: object
- path: string
- file_id: string
Example
{
"path": "string",
"file_id": "string"
}
CntFilesystemLog: object
- id: string (uuid)
- file_id: string
- storage_id: integer
- is_success: boolean
- message: string
- created_at: string (date-time)
Example
{
"id": "string (uuid)",
"file_id": "string",
"storage_id": "integer",
"is_success": "boolean",
"message": "string",
"created_at": "string (date-time)"
}
CntWatcher: object
- id: integer
- description: string
- storage_id: integer
- source: CntWatcherSource
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntWatcherSource: object
- type: string directory
- config: object
Example
{
"type": "string",
"config": "object"
}
CntWatcherModel: object
- description: string
- storage_id: integer
- source: CntWatcherSource
Example
{
"description": "string",
"storage_id": "integer",
"source": {
"type": "string",
"config": "object"
}
}
CntStorage: object
- id: integer
- name: string
- type: string ftp, sftp
- configuration: object
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"name": "string",
"type": "string",
"configuration": "object",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntStorageModel: object
- name: string
- type: string ftp, sftp
- configuration: object
- secret: string
Example
{
"name": "string",
"type": "string",
"configuration": "object",
"secret": "string"
}
CntStorageTest: object
- type: string ftp, sftp
- configuration: object
- secret: string
Example
{
"type": "string",
"configuration": "object",
"secret": "string"
}
CntStorageObject: object
- path: string
-
The file / directory path at the external storage
- basename: string
- type: string file, dir
- size: integer
Example
{
"path": "string",
"basename": "string",
"type": "string",
"size": "integer"
}
CntStorageSyncCommand: object
- path: string
-
The file / directory path at the external storage, required for download
- file_id: string
Example
{
"path": "string",
"file_id": "string"
}
CntFile: object
- id: string
- filename: string
- label: string
- dir: string
- type: string image, file, video
- mime: string
- url: string
- is_public: boolean
- is_listed: boolean
- metadata: object
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamTrackedRecord: object
- id: string
- reference: string
- code: string
- unit: string
- quantity: integer
- processable_as: string sum, avg
- tracked_at: string (date-time)
- created_at: string (date-time)
Example
{
"id": "string",
"reference": "string",
"code": "string",
"unit": "string",
"quantity": "integer",
"processable_as": "string",
"tracked_at": "string (date-time)",
"created_at": "string (date-time)"
}
IamReportRequest: object
- interval: string 1h, 1d, 1m
- code: string
- unit: string
- as: string avg, sum
- filter: string
- keys: string[]
-
string - start_at: string (date-time)
- end_at: string (date-time)
Example
{
"interval": "string",
"code": "string",
"unit": "string",
"as": "string",
"filter": "string",
"keys": [
"string"
],
"start_at": "string (date-time)",
"end_at": "string (date-time)"
}
IamReport: object
Example
{
"interval": "string",
"code": "string",
"unit": "string",
"as": "string",
"filter": "string",
"start_at": "string (date-time)",
"end_at": "string (date-time)",
"buckets": [
{
"date": "string (date-time)",
"quantity": "integer",
"filter_key": "string",
"filter_value": "string"
}
]
}
IamBucket: object
- date: string (date-time)
- quantity: integer
- filter_key: string
- filter_value: string
Example
{
"date": "string (date-time)",
"quantity": "integer",
"filter_key": "string",
"filter_value": "string"
}
IamType: object
- code: string
- unit: string
- processable_as: string sum, avg
- filter: string
Example
{
"code": "string",
"unit": "string",
"processable_as": "string",
"filter": "string"
}
SplHub: object
- id: string
- uuid: string
- name: string
- description: string
- properties: SplProperty
-
SplProperty - status: string online, offline
- status_updated_at: string (date-time)
- disabled_at: string (date-time) null
- pubnub: SplPubnub
- integration: SplIntegration
- os_file_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"uuid": "string",
"name": "string",
"description": "string",
"properties": [
{
"key": "string",
"value": "string"
}
],
"status": "string",
"status_updated_at": "string (date-time)",
"disabled_at": "string (date-time)",
"pubnub": {
"tokens": [
{
"key": "string",
"expires_at": "string (date-time)"
}
]
},
"integration": {
"id": "string"
},
"os_file_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
SplHubModel: object
- name: string
- description: string
Example
{
"name": "string",
"description": "string"
}
SplToken: object
- key: string
- expires_at: string (date-time)
Example
{
"key": "string",
"expires_at": "string (date-time)"
}
SplHubError: object
- id: string
- message: string
- level: string public, private
- is_resolved: boolean false
- job_reference: string
- hub_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"message": "string",
"level": "string",
"is_resolved": "boolean",
"job_reference": "string",
"hub_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
SplHubErrorModel: object
- message: string
- level: string public, private
- job_reference: string
Example
{
"message": "string",
"level": "string",
"job_reference": "string"
}
SplHubStatus: object
- is_online: boolean
- is_idle: boolean
- location: string
- network: SplHubNetwork
- image: SplHubImage
Example
{
"is_online": "boolean",
"is_idle": "boolean",
"location": "string",
"network": {
"ip_address": "string",
"remote_ip_address": "string",
"last_connected_at": "string (date-time)"
},
"image": {
"is_up_to_date": "boolean",
"download_progress": "integer",
"version": "string"
}
}
SplHubNetwork: object
- ip_address: string
- remote_ip_address: string
- last_connected_at: string (date-time)
Example
{
"ip_address": "string",
"remote_ip_address": "string",
"last_connected_at": "string (date-time)"
}
SplHubImage: object
- is_up_to_date: boolean
- download_progress: integer
- version: string
Example
{
"is_up_to_date": "boolean",
"download_progress": "integer",
"version": "string"
}
SplNetworkDevice: object
- description: string
- mac_address: string
- interface: SplConnection
- created_at: string (date-time)
Example
{
"description": "string",
"mac_address": "string",
"interface": {
"interface": "string",
"address": "string"
},
"created_at": "string (date-time)"
}
SplCreateNetworkDevice: object
- description: string
- mac_address: string
- interface: SplConnection
Example
{
"description": "string",
"mac_address": "string",
"interface": {
"interface": "string",
"address": "string"
}
}
IamAuditLog: object
- id: string
- method: string
- resource: string
- user: string
- metadata: object
- logged_at: string (date-time)
- created_at: string (date-time)
Example
{
"id": "string",
"method": "string",
"resource": "string",
"user": "string",
"metadata": "object",
"logged_at": "string (date-time)",
"created_at": "string (date-time)"
}
CntDataflowType: object
- type: string
- code: string
- source: string
- trigger: string realtime, scheduled
- name: string
- is_proprietary: boolean
- events: string[]
-
string - schema: string
Example
{
"type": "string",
"code": "string",
"source": "string",
"trigger": "string",
"name": "string",
"is_proprietary": "boolean",
"events": [
"string"
],
"schema": "string"
}
CntDataflow: object
- id: string (uuid)
- name: string
- source: string order, calculation
- type: string bigquery, email
- trigger: object
-
- type: string scheduled, realtime
- events: string[]
-
string - crontab: string
- config: object
- filter: CntDataflowFilter
-
CntDataflowFilter - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": "string"
},
"config": "object",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntDataflowFilter: object
- key: string
- operator: string in, gte, gt, lte, lt
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CntDataflowModel: object
- name: string
- source: string calculation, order
- type: string bigquery, email
- trigger: object
-
- type: string scheduled, realtime
- events: string[]
-
string - crontab: object
-
- schedule: string
- timezone: string
- config: object
- secret: string
- filter: CntDataflowFilter
-
CntDataflowFilter
Example
{
"name": "string",
"source": "string",
"type": "string",
"trigger": {
"type": "string",
"events": [
"string"
],
"crontab": {
"schedule": "string",
"timezone": "string"
}
},
"config": "object",
"secret": "string",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
CntGifInfo: object
- is_animated: boolean
- height: integer
- width: integer
- loop_count: integer
- size: integer
Example
{
"is_animated": "boolean",
"height": "integer",
"width": "integer",
"loop_count": "integer",
"size": "integer"
}
IamPhoneNumber: object
- id: string
- name: string
- number: string
- preferred_agent: string Niels, Sander, Peter, Sjoerd, Tjeuke
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"number": "string",
"preferred_agent": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamPhoneNumberModel: object
- name: string
- country_code: string
- number: string
- preferred_agent: string Niels, Sander, Peter, Sjoerd, Tjeuke
Example
{
"name": "string",
"country_code": "string",
"number": "string",
"preferred_agent": "string"
}
IamSubtenant: object
- id: string
- company: string
- state: string pending, approved, revoked, expired
- tenant_id: string
- signee: string
- type: string invite, request
- roles: string[]
-
string - created_at: string (date-time)
Example
{
"id": "string",
"company": "string",
"state": "string",
"tenant_id": "string",
"signee": "string",
"type": "string",
"roles": [
"string"
],
"created_at": "string (date-time)"
}
IamPendingRequest: object
- id: string
- state: string pending, approved, revoked, expired
- signee: string
- roles: string[]
-
string - created_at: string (date-time)
Example
{
"id": "string",
"state": "string",
"signee": "string",
"roles": [
"string"
],
"created_at": "string (date-time)"
}
IamPurgeToken: object
- id: integer
- domains: string[]
-
string - expires_at: string (date-time)
- token: string
- requester: string
- signer: string
- created_at: string (date-time)
Example
{
"id": "integer",
"domains": [
"string"
],
"expires_at": "string (date-time)",
"token": "string",
"requester": "string",
"signer": "string",
"created_at": "string (date-time)"
}
IamPendingAuthorization: object
- id: string
- email: string
- roles: string[]
-
string - state: string pending, approved, revoked, expired
- created_at: string (date-time)
Example
{
"id": "string",
"email": "string",
"roles": [
"string"
],
"state": "string",
"created_at": "string (date-time)"
}
IamAuthorization: object
- id: string
- user: IamSubtenantUser
- roles: string[]
-
string - type: string invite, request
- state: string pending, approved, revoked
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"user": {
"first_name": "string",
"last_name": "string",
"email": "string",
"company": "string"
},
"roles": [
"string"
],
"type": "string",
"state": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamSubtenantUser: object
- first_name: string
- last_name: string
- email: string
- company: string
Example
{
"first_name": "string",
"last_name": "string",
"email": "string",
"company": "string"
}
IamRole: object
- id: string
- name: string
- scopes: string[]
-
string - is_managed: boolean
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"scopes": [
"string"
],
"is_managed": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamSystemRole: object
- id: string
- name: string
- scopes: string[]
-
string - client_id: string
- is_managed: boolean
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"scopes": [
"string"
],
"client_id": "string",
"is_managed": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamRoleModel: object
- name: string
- scopes: string[]
-
string
Example
{
"name": "string",
"scopes": [
"string"
]
}
IamAccessToken: object
- token_type: string Bearer
- expires_in: integer 3600
- access_token: string
- refresh_token: string
Example
{
"token_type": "string",
"expires_in": "integer",
"access_token": "string",
"refresh_token": "string"
}
IamTokenRequest: object
- client_id: string
- client_secret: string
- grant_type: string
- scope: string
Example
{
"client_id": "string",
"client_secret": "string",
"grant_type": "string",
"scope": "string"
}
IamAuthorizationResponse: object
Example
{
"forward_uri": "string",
"client_name": "string",
"client_redirect_uri": "string",
"scope": [
{
"id": "string",
"description": "string"
}
],
"is_authorization_approved": "boolean",
"is_id_token_issued": "boolean",
"expires_in": "integer"
}
IamClientModel: object
- name: string
- redirect_uri: string
- grant_types: string[]
-
string - scope: string[]
-
string
Example
{
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
]
}
IamClientUpdateModel: object
- name: string
- scope: string[]
-
string
Example
{
"name": "string",
"scope": [
"string"
]
}
IamClient: object
- id: string
- client_id: string
- client_secret: string
- name: string
- redirect_uri: string
- grant_types: string[]
-
string - scope: string[]
-
string - tenant_id: string
- is_approved: boolean
- is_deleted: boolean
- author: string
- deleted_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"client_id": "string",
"client_secret": "string",
"name": "string",
"redirect_uri": "string",
"grant_types": [
"string"
],
"scope": [
"string"
],
"tenant_id": "string",
"is_approved": "boolean",
"is_deleted": "boolean",
"author": "string",
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamUserModel: object
- email: string
- password: string
- first_name: string
- last_name: string
Example
{
"email": "string",
"password": "string",
"first_name": "string",
"last_name": "string"
}
IamUserUpdateModel: object
- first_name: string
- last_name: string
Example
{
"first_name": "string",
"last_name": "string"
}
IamPasswordReset: object
- token: string
- password: string
Example
{
"token": "string",
"password": "string"
}
IamUser: object
- id: string
- email: string
- first_name: string
- last_name: string
- is_verified: boolean
- is_pending_invite: boolean
- is_primary: boolean
- is_deleted: boolean
- tenant_id: string
- roles: string[]
-
string - deleted_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"is_verified": "boolean",
"is_pending_invite": "boolean",
"is_primary": "boolean",
"is_deleted": "boolean",
"tenant_id": "string",
"roles": [
"string"
],
"deleted_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamTenant: object
- id: string
- name: string
- is_active: boolean true
- stripe_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"is_active": "boolean",
"stripe_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
IamCompany: object
- name: string
- vat_number: string
- phone_number: string
- address: IamAddress
Example
{
"name": "string",
"vat_number": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
}
IamUserTokenRequest: object
- email: string
- type: string verify, reset
Example
{
"email": "string",
"type": "string"
}
IamUserTokenResponse: object
- id: string
- expires_at: string (date-time)
Example
{
"id": "string",
"expires_at": "string (date-time)"
}
IamSignup: object
- company: IamCompany
- user: IamUserModel
Example
{
"company": {
"name": "string",
"vat_number": "string",
"phone_number": "string",
"address": {
"address_line_1": "string",
"address_line_2": "string",
"postal_code": "string",
"city": "string",
"country_code": "string"
}
},
"user": {
"email": "string",
"password": "string",
"first_name": "string",
"last_name": "string"
}
}
TplRepository: object
- id: integer
- name: string
- is_private: boolean
- installer: object
-
- username: string
- type: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"name": "string",
"is_private": "boolean",
"installer": {
"username": "string",
"type": "string"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
TplBuild: object
- id: integer
- git_reference: TplGitReference
- is_success: boolean
- errors: TplBuildError
-
TplBuildError - started_at: string (date-time)
- ended_at: string (date-time)
Example
{
"id": "integer",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"is_success": "boolean",
"errors": [
{
"message": "string"
}
],
"started_at": "string (date-time)",
"ended_at": "string (date-time)"
}
TplThemeUpdateModel: object
- name: string
- secret: string
- git_reference: TplGitReference
Example
{
"name": "string",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
}
}
TplGitReference: object
- type: string tag, branch
- tag: object
-
- value: string
- branch: object
-
- name: string
- commit_sha: string latest
Example
{
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
}
TplThemeCreateModel: object
- name: string
- repository_id: integer
- secret: string
- git_reference: TplGitReference
Example
{
"name": "string",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
}
}
TplTheme: object
- id: string (uuid)
- name: string
- repository_id: integer
- secret: string
- git_reference: TplGitReference
- active_build: object
-
- id: integer
- repository_id: integer
- git_reference: TplGitReference
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"repository_id": "integer",
"secret": "string",
"git_reference": {
"type": "string",
"tag": {
"value": "string"
},
"branch": {
"name": "string",
"commit_sha": "string"
}
},
"active_build": {
"id": "integer",
"repository_id": "integer",
"git_reference": "#/definitions/TplGitReference"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrProvider: object
- name: string
- code: string
- is_active: boolean
- is_configured: boolean
- methods: OdrProviderMethod
-
OdrProviderMethod
Example
{
"name": "string",
"code": "string",
"is_active": "boolean",
"is_configured": "boolean",
"methods": [
{
"code": "string",
"name": "string",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"metadata": "object"
}
]
}
OdrMethod: object
Example
{
"code": "string",
"provider_code": "string",
"name": "string",
"label": "string",
"is_prepaid": "boolean",
"issuers": [
{
"code": "string",
"name": "string",
"metadata": "object"
}
],
"is_enabled": "boolean",
"is_deferred": "boolean",
"priority": "integer"
}
OdrReference: object
- entity_id: string
- entity_type: string
Example
{
"entity_id": "string",
"entity_type": "string"
}
OdrIssuer: object
- code: string
- name: string
- metadata: object
Example
{
"code": "string",
"name": "string",
"metadata": "object"
}
OdrPaymentIntent: object
- amount: integer
- provider_code: string
- method_code: string
- issuer_code: string
- metadata: object
- return_url: string
Example
{
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"metadata": "object",
"return_url": "string"
}
OdrRefundIntent: object
- payment_id: string
- amount: integer
Example
{
"payment_id": "string",
"amount": "integer"
}
OdrPayment: object
- id: string
- secret: string
- amount: integer
- provider_code: string
- method_code: string
- issuer_code: string
- is_refund: boolean false
- is_pending: boolean true
- is_paid: boolean false
- is_authorized: boolean true
- is_captured: boolean false
- return_url: string
- source_payment_id: string
- metadata: object
- paid_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrProcess: object
- is_paid: boolean
- amount_paid: integer
- action: string start, follow, execute, void, return
-
Start will trigger the transaction, the client can follow the progress via x-task. Follow will send the client to the bank. Execute acutally performs the payment (refund-only). Void means no further actions are possible. Return is the same as [follow] indicating that the payment is complete.
- url: string
- attempts: OdrAttempt
-
OdrAttempt
Example
{
"is_paid": "boolean",
"amount_paid": "integer",
"action": "string",
"url": "string",
"attempts": [
{
"psp_reference": "string",
"amount_paid": "integer",
"started_at": "string (date-time)",
"is_paid": "boolean",
"is_expired": "boolean"
}
]
}
OdrAttempt: object
- psp_reference: string
- amount_paid: integer
- started_at: string (date-time)
- is_paid: boolean
- is_expired: boolean
Example
{
"psp_reference": "string",
"amount_paid": "integer",
"started_at": "string (date-time)",
"is_paid": "boolean",
"is_expired": "boolean"
}
OdrTransaction: object
- id: string
- reference: OdrReference
- description: string
- number: string
- amount_due: integer
- amount_paid: integer
- currency: string
- payments: OdrPayment
-
OdrPayment - metadata: object
- purchase: OdrPurchase
- preset: OdrPreset
- secret: string
- client_id: string
- channel_id: string (uuid)
- return_url: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"number": "string",
"amount_due": "integer",
"amount_paid": "integer",
"currency": "string",
"payments": [
{
"id": "string",
"secret": "string",
"amount": "integer",
"provider_code": "string",
"method_code": "string",
"issuer_code": "string",
"is_refund": "boolean",
"is_pending": "boolean",
"is_paid": "boolean",
"is_authorized": "boolean",
"is_captured": "boolean",
"return_url": "string",
"source_payment_id": "string",
"metadata": "object",
"paid_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"secret": "string",
"client_id": "string",
"channel_id": "string (uuid)",
"return_url": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrPurchase: object
- contact_id: string
- items: OdrPurchaseItem
-
OdrPurchaseItem
Example
{
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
}
OdrTransactionModel: object
- reference: OdrReference
- description: string
- amount: integer
- currency: string EUR
- metadata: object
- purchase: OdrPurchase
- preset: OdrPreset
- return_url: string
- client_id: string
- channel_id: string (uuid)
Example
{
"reference": {
"entity_id": "string",
"entity_type": "string"
},
"description": "string",
"amount": "integer",
"currency": "string",
"metadata": "object",
"purchase": {
"contact_id": "string",
"items": [
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
]
},
"preset": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
},
"return_url": "string",
"client_id": "string",
"channel_id": "string (uuid)"
}
OdrPreset: object
- method_code: string
- issuer_code: string
- provider_code: string
Example
{
"method_code": "string",
"issuer_code": "string",
"provider_code": "string"
}
OdrPurchaseItem:
- sku: string
- description: string
- type: string product, handling, shipping
- amount: integer
- quantity: integer
- vat_rate: integer
Example
{
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"quantity": "integer",
"vat_rate": "integer"
}
QcqProxy: object
- key: string
- routes: QcqRoute
-
QcqRoute - auth: object
-
- signature: object
-
- secret: string
- auth: QcqAuthConfig
- cache: QcqCacheConfig
- oauth: object
-
- issuer: string
- client_id: string
- authorize_url: string
- return_url_key: string
- tenant_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"key": "string",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
},
"tenant_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
QcqRoute: object
- path: string
- origin: object
-
- is_bucket: boolean false
- uri: string
- settings: object
-
- cache: QcqCacheConfig
- auth: QcqAuthConfig
Example
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
QcqAuthConfig: object
- is_required: boolean false
- scope: string
Example
{
"is_required": "boolean",
"scope": "string"
}
QcqCacheConfig: object
- is_as_origin: boolean
- is_public: boolean
- age: integer
Example
{
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
}
QcqProxyModel: object
- key: string
- routes: QcqRoute
-
QcqRoute - auth: object
-
- signature: object
-
- secret: string
- auth: QcqAuthConfig
- cache: QcqCacheConfig
- oauth: object
-
- issuer: string
- client_id: string
- authorize_url: string
- return_url_key: string
Example
{
"key": "string",
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
}
}
QcqProxyUpdateModel: object
- routes: QcqRoute
-
QcqRoute - auth: object
-
- signature: object
-
- secret: string
- auth: QcqAuthConfig
- cache: QcqCacheConfig
- oauth: object
-
- issuer: string
- client_id: string
- authorize_url: string
- return_url_key: string
Example
{
"routes": [
{
"path": "string",
"origin": {
"is_bucket": "boolean",
"uri": "string"
},
"settings": {
"cache": {
"is_as_origin": "boolean",
"is_public": "boolean",
"age": "integer"
},
"auth": {
"is_required": "boolean",
"scope": "string"
}
}
}
],
"auth": {
"signature": {
"secret": "string",
"auth": "#/definitions/QcqAuthConfig",
"cache": "#/definitions/QcqCacheConfig"
}
},
"oauth": {
"issuer": "string",
"client_id": "string",
"authorize_url": "string",
"return_url_key": "string"
}
}
MesWebhookDelay: object
- attempt: integer
- delay: integer
- total_delay: integer
Example
{
"attempt": "integer",
"delay": "integer",
"total_delay": "integer"
}
MesWebhookAttempt: object
- id: integer
- number: integer
- is_success: boolean
- response_time: integer
- response_code: integer
- response_body: string
- attempted_at: string (date-time)
Example
{
"id": "integer",
"number": "integer",
"is_success": "boolean",
"response_time": "integer",
"response_code": "integer",
"response_body": "string",
"attempted_at": "string (date-time)"
}
MesWebhookTestMessage: object
- id: integer
- event: string
- entity_id: string
- payload: string
- is_pending: boolean
- is_delivered: boolean
- signature: string
- endpoint: string
- subscription: integer
- attempt: MesWebhookAttempt
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"endpoint": "string",
"subscription": "integer",
"attempt": {
"id": "integer",
"number": "integer",
"is_success": "boolean",
"response_time": "integer",
"response_code": "integer",
"response_body": "string",
"attempted_at": "string (date-time)"
},
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesWebhookMessage: object
- id: integer
- event: string
- entity_id: string
- payload: string
- is_pending: boolean
- is_delivered: boolean
- signature: string
- attempts: integer
- endpoint: string
- subscription: integer
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"event": "string",
"entity_id": "string",
"payload": "string",
"is_pending": "boolean",
"is_delivered": "boolean",
"signature": "string",
"attempts": "integer",
"endpoint": "string",
"subscription": "integer",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesWebhookEvent: object
- event: string
- description: string
Example
{
"event": "string",
"description": "string"
}
MesTrigger: object
- event: string
- entity_id: string
Example
{
"event": "string",
"entity_id": "string"
}
MesSubscriptionModel: object
- events: string[]
-
string - endpoint: string
- delivery_rate: integer
-
Delivery attempts per second
Example
{
"events": [
"string"
],
"endpoint": "string",
"delivery_rate": "integer"
}
MesWebhookSubscription: object
- id: integer
- events: string[]
-
string - endpoint: string
- secret: string
- delivery_rate: integer
-
Delivery attempts per second
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "integer",
"events": [
"string"
],
"endpoint": "string",
"secret": "string",
"delivery_rate": "integer",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsStock: object
- location_id: string
- sku: string
- position: string
- lot_number: string
- expires_at: string (date-time)
- available: integer
- reserved: integer
- claimed: integer
- transit: integer
- missing: integer
- backordered: integer
- total: integer
Example
{
"location_id": "string",
"sku": "string",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"available": "integer",
"reserved": "integer",
"claimed": "integer",
"transit": "integer",
"missing": "integer",
"backordered": "integer",
"total": "integer"
}
WmsStockUpRequest: object
- location_id: string (uuid)
- items: WmsStockUpItem
-
WmsStockUpItem
Example
{
"location_id": "string (uuid)",
"items": [
{
"sku": "string",
"quantity": "integer",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
]
}
WmsStockUpItem: object
- sku: string
- quantity: integer
- position: string
- lot_number: string
- expires_at: string (date-time)
Example
{
"sku": "string",
"quantity": "integer",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
WmsInventorySummaryConstraint: object
- key: string sku, position, location_id, claim_id, is_managed, state, is_tracking_inventory
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
WmsInventoryConstraint: object
- key: string sku, location_id, state, claim_id, position, inventory_item_id
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
WmsUpdateInventoryItemRequest: object
- position: string
-
refers to the position within the warehouse
- lot_number: string
- expires_at: string (date-time)
- metadata: WmsMetadata
Example
{
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"metadata": "object"
}
WmsCreateRouteRequest: object
- name: string
- from: string
-
Location id
- to: string
-
Location id
- hops: string[]
-
string
Example
{
"name": "string",
"from": "string",
"to": "string",
"hops": [
"string"
]
}
WmsAttachItemClaimRequest: object
- entity_type: string sku, inventory_item
- entity_id: string
- reference: string
- state: string available, backordered
Example
{
"entity_type": "string",
"entity_id": "string",
"reference": "string",
"state": "string"
}
WmsCreateHopRequest: object
- from: string
-
Location id
- to: string
-
Location id
- schedules: string[]
-
string the schedule id
Example
{
"from": "string",
"to": "string",
"schedules": [
"string"
]
}
WmsCreateHopScheduleRequest: object
- id: string
- schedules: string[]
-
string the schedule id
Example
{
"id": "string",
"schedules": [
"string"
]
}
WmsCreateLocationRequest: object
- id: string
- name: string
- country_iso: string
- is_supplier: boolean
- is_managed: boolean
- is_customer: boolean
- is_tracking_inventory: boolean
- address_id: string
Example
{
"id": "string",
"name": "string",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "string"
}
WmsUpdateLocationRequest: object
- id: string
- name: string
Example
{
"id": "string",
"name": "string"
}
WmsCreateScheduleRequest: object
- name: string
- last_call: string
-
timestamp for the given timezone
- arrival: string
-
timestamp for the given timezone
- timezone: string
- duration: integer
- available_weekdays: integer[]
-
As noted in ISO 8601 weekdays start at monday
-
integer - active_at: string[]
-
string (date-time)
Example
{
"name": "string",
"last_call": "string",
"arrival": "string",
"timezone": "string",
"duration": "integer",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date-time)"
]
}
WmsUpdateScheduleRequest: object
- id: string
- name: string
- last_call: string
-
timestamp for the given timezone
- arrival: string
-
timestamp for the given timezone
- timezone: string
- duration: integer
- available_weekdays: integer[]
-
As noted in ISO 8601 weekdays start at monday
-
integer - active_at: string[]
-
string (date-time)
Example
{
"id": "string",
"name": "string",
"last_call": "string",
"arrival": "string",
"timezone": "string",
"duration": "integer",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date-time)"
]
}
WmsCreateDurationRequest: object
- route_id: string
- from_location_id: string
- to_location_id: string
- calculate_at: string (date-time)
- arrival_at: string (date-time)
Example
{
"route_id": "string",
"from_location_id": "string",
"to_location_id": "string",
"calculate_at": "string (date-time)",
"arrival_at": "string (date-time)"
}
WmsCreateProjectionRequest: object
- items: object[]
-
object - sku: string
- quantity: integer
- constraints: WmsConstraint
-
WmsConstraint
Example
{
"items": [
{
"sku": "string",
"quantity": "integer"
}
],
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
WmsAvailableProjectionItem: object
- location_id: string (uuid)
- sku: string
- amount: integer
Example
{
"location_id": "string (uuid)",
"sku": "string",
"amount": "integer"
}
WmsCreateClaimRequest: object
- location_id: string (uuid)
- expires_at: string (date-time)
- reference: string
Example
{
"location_id": "string (uuid)",
"expires_at": "string (date-time)",
"reference": "string"
}
WmsCreateTransferRequest: object
- target: string (uuid)
-
Target location
- arrival_at: string (date-time)
-
Optional value: use when you want to set a delivery in the feature
- collect_at: string (uuid)
-
Optional value: use when order should be collected in single location
- routing: object[]
-
object - claim_id: string (uuid)
- collect_route_id: string (uuid)
- delivery_route_id: string (uuid)
Example
{
"target": "string (uuid)",
"arrival_at": "string (date-time)",
"collect_at": "string (uuid)",
"routing": [
{
"claim_id": "string (uuid)",
"collect_route_id": "string (uuid)",
"delivery_route_id": "string (uuid)"
}
]
}
WmsPositionLogResponse: object
- id: string (uuid)
- is_accurate: boolean
- new_items: string[]
-
string (uuid) - missing_items: string[]
-
string (uuid) - user_id: string
- verified_at: string (date-time)
- created_at: string (date-time)
Example
{
"id": "string (uuid)",
"is_accurate": "boolean",
"new_items": [
"string (uuid)"
],
"missing_items": [
"string (uuid)"
],
"user_id": "string",
"verified_at": "string (date-time)",
"created_at": "string (date-time)"
}
WmsPositionVerificationRequest: object
- overage: string[]
-
string - missing_ids: string[]
-
string (uuid)
Example
{
"overage": [
"string"
],
"missing_ids": [
"string (uuid)"
]
}
WmsInventoryItem: object
- id: string
- sku: string
- claim_id: string
- location_id: string
- metadata: WmsMetadata
- state: string available, pending, claimed, transit, missing, backordered
- position: string
- lot_number: string
-
the lot number of the inventory item
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"sku": "string",
"claim_id": "string",
"location_id": "string",
"metadata": "object",
"state": "string",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsRoute: object
- id: string
- name: string
- from: string
-
Location id
- to: string
-
Location id
- hops: string[]
-
string - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"from": "string",
"to": "string",
"hops": [
"string"
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsHop: object
- id: string
- from: string
-
Location id
- to: string
-
Location id
- schedules: string[]
-
a list of applied schedules
-
string - created_at: string (date-time)
- deleted_at: string (date-time)
Example
{
"id": "string",
"from": "string",
"to": "string",
"schedules": [
"string"
],
"created_at": "string (date-time)",
"deleted_at": "string (date-time)"
}
WmsLocation: object
- id: string
- name: string
- country_iso: string
- is_supplier: boolean
- is_managed: boolean
- is_customer: boolean
- is_tracking_inventory: boolean
- address_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"country_iso": "string",
"is_supplier": "boolean",
"is_managed": "boolean",
"is_customer": "boolean",
"is_tracking_inventory": "boolean",
"address_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsSchedule: object
- id: string
- last_call: string
-
timestamp for the given timezone
- arrival: string
-
timestamp for the given timezone
- duration: integer
-
the amount of days it takes to arive at its destination
- timezone: string
- available_weekdays: integer[]
-
A Weekday specifies a day of the week (Sunday = 0, ...)
-
integer 0, 1, 2, 3, 4, 5, 6, 7 - active_at: string[]
-
string (date)
Example
{
"id": "string",
"last_call": "string",
"arrival": "string",
"duration": "integer",
"timezone": "string",
"available_weekdays": [
"integer"
],
"active_at": [
"string (date)"
]
}
WmsTransferReport: object
- target: string (uuid)
- item_claims: WmsTransferReportItem
-
WmsTransferReportItem
Example
{
"target": "string (uuid)",
"item_claims": [
{
"claim_item_id": "string (uuid)",
"position": "string"
}
]
}
WmsTransferReportItem: object
- claim_item_id: string (uuid)
- position: string
Example
{
"claim_item_id": "string (uuid)",
"position": "string"
}
WmsProjection: object
- locations: string[]
-
string - available: WmsAvailableProjectionItem
-
WmsAvailableProjectionItem - unavailable: WmsUnavailableProjectionItem
-
WmsUnavailableProjectionItem
Example
{
"locations": [
"string"
],
"available": [
{
"location_id": "string (uuid)",
"sku": "string",
"amount": "integer"
}
],
"unavailable": [
{
"location_id": "string (uuid)",
"sku": "string",
"amount": "integer"
}
]
}
WmsConstraint: object
- key: string location, route, hop_count
- operator: string in, lt, lte, gt, gte
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
WmsClaim: object
- id: string (uuid)
- location_id: string
- target: string
- expires_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"location_id": "string",
"target": "string",
"expires_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsClaimItem: object
- id: string (uuid)
- inventory_item_id: string (uuid)
- position: string
- reference: string
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"inventory_item_id": "string (uuid)",
"position": "string",
"reference": "string",
"updated_at": "string (date-time)"
}
WmsTransfer: object
- id: string (uuid)
- target: string (uuid)
-
Target location
- status: string pending, transit, delivered
- collect_at: string (uuid)
- collections: WmsSubTransferSummary
-
Optional: used when order should be packed in a single box for the target
-
WmsSubTransferSummary - deliveries: WmsSubTransferSummary
-
WmsSubTransferSummary - is_collection_pending: boolean
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"target": "string (uuid)",
"status": "string",
"collect_at": "string (uuid)",
"collections": [
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
],
"deliveries": [
"#/definitions/WmsSubTransferSummary"
],
"is_collection_pending": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsSubTransferSummary: object
- id: string (uuid)
- from: string (uuid)
-
Location id
- status: string pending, partial, delivered
- route_id: string (uuid)
- ship_at: string (date-time)
- expected_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"from": "string (uuid)",
"status": "string",
"route_id": "string (uuid)",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsDurationResponse: object
- arrival_at: string (date-time)
- ship_at: string (date-time)
Example
{
"arrival_at": "string (date-time)",
"ship_at": "string (date-time)"
}
WmsSubTransfer: object
- id: string
- transfer_id: string
- from: string
-
Location id
- status: string pending, partial, delivered
- route_id: string
- ship_at: string (date-time)
- expected_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"transfer_id": "string",
"from": "string",
"status": "string",
"route_id": "string",
"ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsSubTransferItem: object
- transfer_item_id: string
- status: string
- claim_item_id: string
- inventory_item_id: string
- reference: string
- sku: string
- location_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"transfer_item_id": "string",
"status": "string",
"claim_item_id": "string",
"inventory_item_id": "string",
"reference": "string",
"sku": "string",
"location_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
WmsTransport: object
- id: string (uuid)
- previous: string (uuid)
- next: string (uuid)
- status: string pending, shipped, delivered
- inbound_shipment_id: string
- outbound_shipment_id: string
- reference: string
- from: string (uuid)
- departure_at: string (date-time)
- to: string (uuid)
- arrival_at: string (date-time)
Example
{
"id": "string (uuid)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_at": "string (date-time)"
}
WmsDescriptiveLocation: object
- id: string (uuid)
- label: string
Example
{
"id": "string (uuid)",
"label": "string"
}
WmsTraveledRoute: object
- claim_item_id: string (uuid)
- sku: string
- claim_id: string (uuid)
- route: WmsDescriptiveLocation
-
WmsDescriptiveLocation - transports: WmsTransport
-
WmsTransport
Example
{
"claim_item_id": "string (uuid)",
"sku": "string",
"claim_id": "string (uuid)",
"route": [
{
"id": "string (uuid)",
"label": "string"
}
],
"transports": [
{
"id": "string (uuid)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_at": "string (date-time)"
}
]
}
WmsTraveledRouteSummary: object
- claim_id: string (uuid)
- route: WmsDescriptiveLocation
-
WmsDescriptiveLocation - transports: WmsTransport
-
WmsTransport
Example
{
"claim_id": "string (uuid)",
"route": [
{
"id": "string (uuid)",
"label": "string"
}
],
"transports": [
{
"id": "string (uuid)",
"previous": "string (uuid)",
"next": "string (uuid)",
"status": "string",
"inbound_shipment_id": "string",
"outbound_shipment_id": "string",
"reference": "string",
"from": "string (uuid)",
"departure_at": "string (date-time)",
"to": "string (uuid)",
"arrival_at": "string (date-time)"
}
]
}
WmsAddAvailableSkuResponse: object
- id: string (uuid)
- sku: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"sku": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrStartSessionRequest: object
- expires_at: string (datetime)
- audience: string
Example
{
"expires_at": "string (datetime)",
"audience": "string"
}
OdrStartSessionResponse: object
- id: string
- expires_at: string (datetime)
Example
{
"id": "string",
"expires_at": "string (datetime)"
}
OdrSelectSessionBillingMethodRequest: object
- method_id: string
- issuer_id: string
Example
{
"method_id": "string",
"issuer_id": "string"
}
OdrSelectSessionBillingRequest: object
- address_id: string
- contact: object
-
- primary: boolean
- secondary: boolean
- organisation: object
-
- primary: boolean
Example
{
"address_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
OdrSelectSessionOrganisationRequest: object
- organisation_id: string (uuid)
Example
{
"organisation_id": "string (uuid)"
}
OdrSelectSessionShippingMethodRequest: object
- is_split_allowed: boolean
- method_id: string (uuid)
Example
{
"is_split_allowed": "boolean",
"method_id": "string (uuid)"
}
OdrSelectSessionShippingRequest: object
one of the following keys is required for shipping
- address_id: string
- contact: object
-
- primary: boolean
- secondary: boolean
- organisation: object
-
- primary: boolean
Example
{
"address_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
OdrSelectSessionPhonenumberRequest: object
one of the following keys is required for shipping
- phone_number_id: string
- contact: object
-
- primary: boolean
- secondary: boolean
- organisation: object
-
- primary: boolean
Example
{
"phone_number_id": "string",
"contact": {
"primary": "boolean",
"secondary": "boolean"
},
"organisation": {
"primary": "boolean"
}
}
OdrGetSessionShippingResponse: array
- distance: number
- point: OdrPoint
Example
[
{
"distance": "number",
"point": {
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longtitude": "number (float64)",
"address": {
"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"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "string"
}
]
}
]
}
}
]
OdrGetSessionShippingMethodResponse: object
- id: string
- carrier: string
- name: string
- type: string pick, homedelivery, servicepoint
- price: number
Example
{
"id": "string",
"carrier": "string",
"name": "string",
"type": "string",
"price": "number"
}
OdrSelectSessionShippingPointRequest: object
- spid: string
- country_code: string
Example
{
"spid": "string",
"country_code": "string"
}
OdrSelectSessionShippingWindowRequest: object
- from: integer
- to: integer
- at: string (date)
Example
{
"from": "integer",
"to": "integer",
"at": "string (date)"
}
OdrSelectSessionShippingWindowResponse: object
- from: integer
- to: integer
- at: string (date)
Example
{
"from": "integer",
"to": "integer",
"at": "string (date)"
}
OdrGetSessionResponse: object
- expires_at: string (datetime)
Example
{
"expires_at": "string (datetime)"
}
OdrGetSessionOrganisationOptionsResponse: object
- primary: OdrOrganisation
- secondary: OdrOrganisation
-
OdrOrganisation
Example
{
"primary": {
"id": "string (uuid)",
"name": "string",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
},
"secondary": [
"#/definitions/OdrOrganisation"
]
}
OdrAuthenticationRequest: object
- email: string
- password: string
Example
{
"email": "string",
"password": "string"
}
OdrAuthenticationResponse: object
- id: string (uuid)
- email: string
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
Example
{
"id": "string (uuid)",
"email": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
}
OdrAuthorizationRequest: object
- calculation_id: string (uuid)
Example
{
"calculation_id": "string (uuid)"
}
OdrAuthorizationResponse: object
- accepted: boolean
- forward_uri: string (url)
Example
{
"accepted": "boolean",
"forward_uri": "string (url)"
}
OdrCombinedAddressSet: object
- contact: OdrAddressSet
- organisation: OdrAddressSet
- session: OdrAddressSet
Example
{
"contact": {
"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"
},
"secondary": [
"#/definitions/OdrAddress"
]
},
"organisation": "#/definitions/OdrAddressSet",
"session": "#/definitions/OdrAddressSet"
}
OdrAddressSet: object
- primary: OdrAddress
- secondary: OdrAddress
-
OdrAddress
Example
{
"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"
},
"secondary": [
"#/definitions/OdrAddress"
]
}
OdrCombinedPhoneNumberSet: object
- contact: OdrPhonenumberSet
- organisation: OdrPhonenumberSet
- session: OdrPhonenumberSet
Example
{
"contact": {
"primary": {
"id": "string (uuid)",
"country_code": "string",
"number": "string"
},
"secondary": [
"#/definitions/OdrPhonenumber"
]
},
"organisation": "#/definitions/OdrPhonenumberSet",
"session": "#/definitions/OdrPhonenumberSet"
}
OdrPhonenumberSet: object
- primary: OdrPhonenumber
- secondary: OdrPhonenumber
-
OdrPhonenumber
Example
{
"primary": {
"id": "string (uuid)",
"country_code": "string",
"number": "string"
},
"secondary": [
"#/definitions/OdrPhonenumber"
]
}
OdrPoint: object
- id: string
- name: string
- carrier: string
- latitude: number (float64)
- longtitude: number (float64)
- address: OdrAddress
- openings: object[]
-
object - weekday: number
- windows: object[]
-
object - start: string
- end: string
Example
{
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longtitude": "number (float64)",
"address": {
"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"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "string"
}
]
}
]
}
OdrAddress: object
- id: string
- country_code: string
-
Two letter counpremise_numbertry code
- administrative_area: string
-
The state or province name or abbreviation (optional)
- locality: string
-
City
- dependent_locality: string
-
Additional information about the locality (optional)
- postal_code: string
-
The complete postal code for the delivery point
- sorting_code: string
-
Allow sorting, for example to route mail (optional)
- address_line_1: string
-
The first address line
- address_line_2: string
-
The second address line (optional)
- thoroughfare: string
- premise_number: integer
- premise_number_suffix: string
- organisation: string
-
The name of the recipient, firm, or company at this address (optional)
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
Example
{
"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"
}
OdrSessionProjection: object
- items: OdrSessionProjectionItem
-
OdrSessionProjectionItem - services: OdrSessionCalculationServiceItem
-
OdrSessionCalculationServiceItem - subtotal: integer
- adjustments: OdrSessionCalculationAdjustment
-
OdrSessionCalculationAdjustment - total: integer
- vat: OdrVatResult
-
OdrVatResult - currency: string
- is_including_vat: boolean
- is_vat_shifted: boolean
- client_id: string
- pricing_at: string (date-time)
Example
{
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrSessionCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"currency": "string",
"is_including_vat": "boolean",
"is_vat_shifted": "boolean",
"client_id": "string",
"pricing_at": "string (date-time)"
}
OdrSessionCalculation: object
- id: string (uuid)
- number: string
- reference: string
- items: OdrSessionProjectionItem
-
OdrSessionProjectionItem - services: OdrSessionCalculationServiceItem
-
OdrSessionCalculationServiceItem - subtotal: integer
- adjustments: OdrSessionCalculationAdjustment
-
OdrSessionCalculationAdjustment - total: integer
- vat: OdrVatResult
-
OdrVatResult - settings: OdrSessionCalculationSettings
- currency: string
- customer: OdrContact
- vendor: OdrContact
- is_including_vat: boolean
- is_vat_shifted: boolean
- is_prepaid: boolean
- client_id: string
- channel_id: string (uuid)
- file_id: string
- metadata: object
- pricing_at: string (date-time)
- invoiced_at: string (date-time)
- prepaid_at: string (date-time)
- order_ids: string[]
-
string - coupons: string[]
-
string - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"number": "string",
"reference": "string",
"items": [
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
],
"services": [
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
],
"subtotal": "integer",
"adjustments": [
"#/definitions/OdrSessionCalculationAdjustment"
],
"total": "integer",
"vat": [
{
"rate": "integer",
"amount": "integer"
}
],
"settings": {
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
},
"currency": "string",
"customer": {
"tags": [
"string"
],
"vat_country_code": "string",
"contact": {
"email": "string",
"vat_number": "string",
"coc_number": "string",
"organisation_id": "string",
"organisation_version": "string",
"address_id": "string",
"phone_number_id": "string",
"id": "string"
}
}
}
OdrSessionCalculationSettings: object
- billing: OdrSessionCalculationSettingsBilling
- shipping: OdrSessionCalculationSettingsShipping
Example
{
"billing": {
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
},
"shipping": {
"method_id": "string (uuid)"
}
}
OdrSessionCalculationSettingsBilling: object
- method_code: string
- issuer_code: string
- provider_code: string
- vat: OdrSessionSettingsBillingVat
Example
{
"method_code": "string",
"issuer_code": "string",
"provider_code": "string",
"vat": {
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
}
OdrSessionSettingsBillingVat: object
- is_shift_disabled: boolean false
- is_shift_required: boolean false
Example
{
"is_shift_disabled": "boolean",
"is_shift_required": "boolean"
}
OdrSessionCalculationSettingsShipping: object
- method_id: string (uuid)
Example
{
"method_id": "string (uuid)"
}
OdrSessionCalculationServiceItem: object
- description: string
- type: string product, handling, shipping
- amount: number
- is_percentage: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrSessionCalculationServiceAdjustment
-
OdrSessionCalculationServiceAdjustment - vat_percentage: integer
- total: integer
Example
{
"description": "string",
"type": "string",
"amount": "number",
"is_percentage": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer"
}
OdrSessionCalculationServiceAdjustment: object
- reference: string
- description: string
- amount: number
- is_percentage: boolean
- is_discount: boolean
- result: OdrSessionCalculationServiceAdjustmentResult
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
}
OdrSessionCalculationServiceAdjustmentResult: object
- is_applied_rule: boolean
- rule_id: string (uuid)
- output: integer
Example
{
"is_applied_rule": "boolean",
"rule_id": "string (uuid)",
"output": "integer"
}
OdrSessionProjectionItem: object
- reference: string
- sku: string
- description: string
- type: string product, handling, shipping
- amount: integer
- is_discounted: boolean
- quantity: integer
- subtotal: integer
- adjustments: OdrSessionCalculationAdjustment
-
OdrSessionCalculationAdjustment - vat_percentage: integer
- total: integer
- total_revenue: integer
- order_items: OdrSessionCalculationStackItem
-
OdrSessionCalculationStackItem
Example
{
"reference": "string",
"sku": "string",
"description": "string",
"type": "string",
"amount": "integer",
"is_discounted": "boolean",
"quantity": "integer",
"subtotal": "integer",
"adjustments": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"vat_percentage": "integer",
"total": "integer",
"total_revenue": "integer",
"order_items": [
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
]
}
OdrSessionCalculationStackItem: object
- id: string
- is_invoiced: boolean
- invoice_id: string (uuid)
Example
{
"id": "string",
"is_invoiced": "boolean",
"invoice_id": "string (uuid)"
}
OdrSessionCalculationAdjustment: object
- reference: string
- description: string
- amount: number 0
- is_percentage: boolean
- is_discount: boolean
- result: OdrSessionCalculationAdjustmentResult
Example
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
OdrSessionCalculationAdjustmentResult: object
- is_applied_rule: boolean
- rule_id: string
- output: integer
-
The result of the rule. Will be negative in case of a discount.
Example
{
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
OdrNewPhonenumber: object
- country_code: string
-
Two letter counpremise_numbertry code
- number: string
-
Last name
Example
{
"country_code": "string",
"number": "string"
}
OdrPhonenumber: object
- id: string (uuid)
- country_code: string
-
Two letter counpremise_numbertry code
- number: string
-
Last name
Example
{
"id": "string (uuid)",
"country_code": "string",
"number": "string"
}
OdrNewContact: object
- email: string
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
Example
{
"email": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
}
OdrNewAddress: object
- country_code: string
-
Two letter counpremise_numbertry code
- administrative_area: string
-
The state or province name or abbreviation (optional)
- locality: string
-
City
- dependent_locality: string
-
Additional information about the locality (optional)
- postal_code: string
-
The complete postal code for the delivery point
- sorting_code: string
-
Allow sorting, for example to route mail (optional)
- address_line_1: string
-
The first address line
- address_line_2: string
-
The second address line (optional)
- thoroughfare: string
- premise_number: integer
- premise_number_suffix: string
- organisation: string
-
The name of the recipient, firm, or company at this address (optional)
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
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"
}
OdrSessionContact: object
- id: string (uuid)
- version: string (uuid)
- email: string
- tags: string[]
-
string - given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"version": "string (uuid)",
"email": "string",
"tags": [
"string"
],
"given_name": "string",
"additional_name": "string",
"family_name": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
OdrSessionProviderMethod: object
- method_id: string
- name: string
- issuers: OdrSessionIssuer
-
OdrSessionIssuer - metadata: object
Example
{
"method_id": "string",
"name": "string",
"issuers": [
{
"method_id": "string",
"name": "string",
"metadata": "object"
}
],
"metadata": "object"
}
OdrOrganisation: object
- id: string (uuid)
- name: string
-
The name of the recipient, firm, or company at this address (optional)
- coc_number: string
- registrations: OdrVatRegistration
-
OdrVatRegistration
Example
{
"id": "string (uuid)",
"name": "string",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
}
OdrNewOrganisation: object
- name: string
-
The name of the recipient, firm, or company at this address (optional)
- coc_number: string
- registrations: OdrVatRegistration
-
OdrVatRegistration
Example
{
"name": "string",
"coc_number": "string",
"registrations": [
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
]
}
OdrVatRegistration: object
- country_code: string
- number: string
- is_valid: boolean
- is_pending: boolean
Example
{
"country_code": "string",
"number": "string",
"is_valid": "boolean",
"is_pending": "boolean"
}
OdrSessionIssuer: object
- method_id: string
- name: string
- metadata: object
Example
{
"method_id": "string",
"name": "string",
"metadata": "object"
}
CntUploadRequest: object
- is_public: boolean
- path: string
- is_listed: boolean
- method: string resolve, strict, upsert strict
- metadata: object
Example
{
"is_public": "boolean",
"path": "string",
"is_listed": "boolean",
"method": "string",
"metadata": "object"
}
CntUploadResponse: object
- expires_at: string (date-time)
- signature: string
Example
{
"expires_at": "string (date-time)",
"signature": "string"
}
CntSimpleQuery: object
- codes: string[]
-
string - models: string[]
-
string - namespaces: string[]
-
string - q: string[]
-
string - is_fuzzy: boolean true
- limit: integer
- threshold: number (double) 1
- page_cursor: string
Example
{
"codes": [
"string"
],
"models": [
"string"
],
"namespaces": [
"string"
],
"q": [
"string"
],
"is_fuzzy": "boolean",
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string"
}
CntFilter: object
- key: string
- operator: string in, gt, gte, lt, lte, prefix, not_in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CntRelativeDate: object
- quantity: integer
- key: string minutes, hours, days, weeks, months
- direction: string ago, ahead
- at: object
-
- timezone: string
- hour: string 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 0, now
- minute: string 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 0, now
- day_of_week: string monday, tuesday, wednesday, thursday, friday, saterday, sunday
- day_of_month: string 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, last
Example
{
"quantity": "integer",
"key": "string",
"direction": "string",
"at": {
"timezone": "string",
"hour": "string",
"minute": "string",
"day_of_week": "string",
"day_of_month": "string"
}
}
CntSearchQuery: object
Example
{
"q": [
"string"
],
"is_fuzzy": "boolean",
"filter": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"missing": [
"string"
],
"facets": [
"string"
],
"limit": "integer",
"threshold": "number (double)",
"page_cursor": "string",
"sort": [
{
"key": "string",
"order": "string"
}
]
}
CntSimpleSeachResponse: object
- hits: CntSimpleDocumentResponse
-
CntSimpleDocumentResponse - pagination: CntPagination
Example
{
"hits": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
CntSeachResponse: object
- hits: CntDocumentResponse
-
CntDocumentResponse - facets: CntFacet
-
CntFacet - pagination: CntPagination
Example
{
"hits": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
],
"pagination": {
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
}
CntSuggestResponse: object
Example
{
"hits": [
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
]
}
CntDocumentResponse: object
- reference: string
- title: string
- description: string
- sub: string
- metadata: object
- filters: object
Example
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
CntSimpleDocumentResponse: object
- reference: string
- title: string
- code: string
- model: string
- namespace: string
- description: string
- sub: string
- metadata: object
Example
{
"reference": "string",
"title": "string",
"code": "string",
"model": "string",
"namespace": "string",
"description": "string",
"sub": "string",
"metadata": "object"
}
CntField: object
- key: string
- type: string datetime, text, short_text, keyword, integer, boolean, autocomplete, metadata
Example
{
"key": "string",
"type": "string"
}
CntDefinitionModel: object
- namespace: string
- code: string
- model: string
- key: string
- type: string datetime, text, short_text, keyword, integer, boolean, autocomplete, metadata
Example
{
"namespace": "string",
"code": "string",
"model": "string",
"key": "string",
"type": "string"
}
CntDefinition: object
Example
{
"id": "string",
"namespace": "string",
"code": "string",
"model": "string",
"filters": [
{
"key": "string",
"type": "string"
}
],
"tenant_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntPagination: object
- entity_count: integer
- page_limit: integer
- page_count: integer
- next_page_cursor: string
Example
{
"entity_count": "integer",
"page_limit": "integer",
"page_count": "integer",
"next_page_cursor": "string"
}
CatChannel: object
- id: string (uuid)
- name: string
- type: string pos, storefront, order, integration
- description: string
- client_id: string
- deleted_at: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"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)"
}
CatCreateChannel: object
- name: string
- type: string pos, storefront, order, integration
- description: string
- client_id: string
Example
{
"name": "string",
"type": "string",
"description": "string",
"client_id": "string"
}
CatUpdateChannel: object
- name: string
- description: string
Example
{
"name": "string",
"description": "string"
}
MesRelay: object
- id: string (uuid)
- name: string
- type: string logger, sendcloud, paynl, mollie
- config: object
- endpoint: string
- limit_requests_per_second: integer
- is_system_object: boolean
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"type": "string",
"config": "object",
"endpoint": "string",
"limit_requests_per_second": "integer",
"is_system_object": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
MesRelayModel: object
- name: string
- type: string logger, sendcloud, paynl, mollie
- config: object
Example
{
"name": "string",
"type": "string",
"config": "object"
}
MesRelayMessage: object
- id: string (uuid)
- hash: string
- payload: string
- is_valid: boolean
- is_relayed: boolean
- is_duplicate: boolean
- source: object
-
- ip: string
- city: string
- country_code: string
- user_agent: string
- relayed_at: string (date-time)
- created_at: string (date-time)
Example
{
"id": "string (uuid)",
"hash": "string",
"payload": "string",
"is_valid": "boolean",
"is_relayed": "boolean",
"is_duplicate": "boolean",
"source": {
"ip": "string",
"city": "string",
"country_code": "string",
"user_agent": "string"
},
"relayed_at": "string (date-time)",
"created_at": "string (date-time)"
}
LcsShipmentItemMissing: object
- id: string (uuid)
- is_missing: boolean
Example
{
"id": "string (uuid)",
"is_missing": "boolean"
}
LcsShipmentItemCorrection: object
- sku: string
- quantity: integer
- description: string
- position: string
Example
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
LcsListSearch: object
- constraints: LcsListSearchConstraint
-
LcsListSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
LcsListSearchConstraint: object
- key: string ids, sub, location_id, is_on_hold, is_in_progress, is_finished, is_assigned
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
LcsShipmentSearch: object
- constraints: LcsShipmentSearchConstraint
-
LcsShipmentSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
LcsShipmentSearchConstraint: object
- key: string ids, secret, is_outbound, from_id, from_type, to_id, to_type, prior_ids
- operator: string in
- value: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
LcsLocationSearch: object
- constraints: LcsLocationSearchConstraint
-
LcsLocationSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
LcsLocationSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
LcsShipmentMethodSearch: object
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
LcsShipmentMethodSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
LcsParcelSearch: object
- constraints: LcsParcelSearchConstraint
-
LcsParcelSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
LcsParcelSearchConstraint: object
- key: string ids, is_delivered
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
LcsItemSearch: object
- constraints: LcsItemSearchConstraint
-
LcsItemSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
LcsItemSearchConstraint: object
- key: string ids, skus, position, is_listed, is_missing, is_in_transit, is_boxed, is_finished, is_labeled, is_serviced, is_handled, is_outbound, list_ids, parcel_ids, shipment_ids
- operator: string in
- value: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
LcsLocationSku: object
- sku: string
- position: string
- created_at: string (date-time)
Example
{
"sku": "string",
"position": "string",
"created_at": "string (date-time)"
}
LcsHandlingListUpdate: object
- is_on_hold: boolean
- sub: string
Example
{
"is_on_hold": "boolean",
"sub": "string"
}
LcsHandlingListItemUpdate: object
- id: string
- is_handled: boolean
- is_serviced: boolean
- is_finished: boolean
- position: string
- lot_number: string
- expires_at: string (date-time)
Example
{
"id": "string",
"is_handled": "boolean",
"is_serviced": "boolean",
"is_finished": "boolean",
"position": "string",
"lot_number": "string",
"expires_at": "string (date-time)"
}
LcsHandlingListItem: object
- ids: string[]
-
string - handled_ids: string[]
-
string - shipment_id: string
- sku: string
- description: string
- position: string
- quantity: integer
- sorting_label: string
- rank: integer
Example
{
"ids": [
"string"
],
"handled_ids": [
"string"
],
"shipment_id": "string",
"sku": "string",
"description": "string",
"position": "string",
"quantity": "integer",
"sorting_label": "string",
"rank": "integer"
}
LcsHandlingModel: object
- shipments: LcsHandlingModelShipments
-
LcsHandlingModelShipments - due_at: string (date-time)
Example
{
"shipments": [
{
"id": "string (uuid)",
"label": "string"
}
],
"due_at": "string (date-time)"
}
LcsHandlingModelShipments: object
- id: string (uuid)
- label: string
Example
{
"id": "string (uuid)",
"label": "string"
}
LcsHandlingListResponse: object
- id: string
- sub: string
- shipments: string[]
-
string - location_id: string
- is_outbound: boolean
- is_assigned: boolean
- is_in_progress: boolean
- is_on_hold: boolean
- is_finished: boolean
- started_at: string (date-time)
- finished_at: string (date-time)
- due_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"sub": "string",
"shipments": [
"string"
],
"location_id": "string",
"is_outbound": "boolean",
"is_assigned": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsHandlingList: object
- id: string
- number: string
- sub: string
- location_id: string
- shipments: string[]
-
string - is_outbound: boolean
- is_in_progress: boolean
- is_on_hold: boolean
- is_cancelled: boolean
- is_finished: boolean
- started_at: string (date-time)
- finished_at: string (date-time)
- due_at: string (date-time)
- items: LcsHandlingListItem
-
LcsHandlingListItem - sorting_labels: LcsHandlingListSortingLabels
-
LcsHandlingListSortingLabels - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"sub": "string",
"location_id": "string",
"shipments": [
"string"
],
"is_outbound": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_cancelled": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"items": [
{
"ids": [
"string"
],
"handled_ids": [
"string"
],
"shipment_id": "string",
"sku": "string",
"description": "string",
"position": "string",
"quantity": "integer",
"sorting_label": "string",
"rank": "integer"
}
],
"sorting_labels": [
{
"shipment_id": "string (uuid)",
"label": "string"
}
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsHandlingListSortingLabels: object
- shipment_id: string (uuid)
- label: string
Example
{
"shipment_id": "string (uuid)",
"label": "string"
}
LcsListedHandlingList: object
- id: string
- number: string
- sub: string
- location_id: string
- shipments: string[]
-
string - is_outbound: boolean
- is_in_progress: boolean
- is_on_hold: boolean
- is_cancelled: boolean
- is_finished: boolean
- started_at: string (date-time)
- finished_at: string (date-time)
- due_at: string (date-time)
- items: LcsShipmentItem
-
LcsShipmentItem - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"sub": "string",
"location_id": "string",
"shipments": [
"string"
],
"is_outbound": "boolean",
"is_in_progress": "boolean",
"is_on_hold": "boolean",
"is_cancelled": "boolean",
"is_finished": "boolean",
"started_at": "string (date-time)",
"finished_at": "string (date-time)",
"due_at": "string (date-time)",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsLocationPosition: object
- code: string
- sorting: integer
- skus: LcsLocationSku
-
LcsLocationSku - created_at: string (date-time)
Example
{
"code": "string",
"sorting": "integer",
"skus": [
{
"sku": "string",
"position": "string",
"created_at": "string (date-time)"
}
],
"created_at": "string (date-time)"
}
LcsMethod: object
- id: string
- carrier_code: string
- name: string
- label: string
- description: string
- max_weight: integer
- countries: LcsCountry
-
LcsCountry - delivery_during: string daytime, morning, afternoon, evening
- is_configured: boolean false
- is_same_day: boolean
- is_sunday: boolean
- is_carrier_location: boolean
- is_neighbour_allowed: boolean
- provider_method_id: string
- provider: string sendcloud, default
- is_enabled: boolean false
- priority: integer 100
Example
{
"id": "string",
"carrier_code": "string",
"name": "string",
"label": "string",
"description": "string",
"max_weight": "integer",
"countries": [
{
"code": "string",
"amount": "integer"
}
],
"delivery_during": "string",
"is_configured": "boolean",
"is_same_day": "boolean",
"is_sunday": "boolean",
"is_carrier_location": "boolean",
"is_neighbour_allowed": "boolean",
"provider_method_id": "string",
"provider": "string",
"is_enabled": "boolean",
"priority": "integer"
}
LcsListedShipment: object
- id: string
- number: string
- type: string delivery, collect, internal
- method_id: string
- contact_id: string
- channel_id: string (uuid)
- addressing: LcsListedShipmentAddressing
- ship_at: string (date-time)
- estimated_ship_at: string (date-time)
- expected_at: string (date-time)
- stack_id: string
- is_editable: boolean
- is_outbound: boolean
- is_listed: boolean
- is_finished: boolean
- is_in_transit: boolean
- is_complete: boolean
- is_overcomplete: boolean
- is_canceled: boolean
- secret: string
- prior_shipments: string[]
-
string (uuid) - list_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_canceled": "boolean",
"secret": "string",
"prior_shipments": [
"string (uuid)"
],
"list_id": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsListedShipmentAddressing: object
- to: LcsShipmentAddressing
- from: LcsShipmentAddressing
Example
{
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
}
LcsShipment: object
- id: string
- number: string
- type: string delivery, collect, internal
- method_id: string
- contact_id: string
- channel_id: string (uuid)
- order_id: string
- addressing: LcsListedShipmentAddressing
- ship_at: string (date-time)
- estimated_ship_at: string (date-time)
- expected_at: string (date-time)
- stack_id: string
- is_editable: boolean
- is_outbound: boolean
- is_labeled: boolean
- is_serviced: boolean
- is_complete: boolean
-
False in case listed items does not match packaged items
- is_overcomplete: boolean
- is_boxed: boolean
- is_handled: boolean
-
True in case shipment was picked (outbound) or sorted (inbound)
- is_listed: boolean
-
True whe shipment is placed on handling list
- is_finished: boolean
-
True in case no further actions are required for this shipment
- is_in_transit: boolean
-
If true, items are beeing shipped and have not yet arrived
- is_canceled: boolean
- items: LcsShipmentItem
-
LcsShipmentItem - backorders: LcsShipmentItemCorrection
-
LcsShipmentItemCorrection - overage: LcsShipmentItemCorrection
-
LcsShipmentItemCorrection - parcels: LcsParcel
-
LcsParcel - secret: string
- prior_shipments: string[]
-
string (uuid) - list_id: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"type": "string",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"expected_at": "string (date-time)",
"stack_id": "string",
"is_editable": "boolean",
"is_outbound": "boolean",
"is_labeled": "boolean",
"is_serviced": "boolean",
"is_complete": "boolean",
"is_overcomplete": "boolean",
"is_boxed": "boolean",
"is_handled": "boolean",
"is_listed": "boolean",
"is_finished": "boolean",
"is_in_transit": "boolean",
"is_canceled": "boolean",
"items": [
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"parcels": [
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean"
}
]
}
LcsShipmentAddressing: object
- entity_type: string address, location
- entity_id: string
- carrier: LcsShipmentAddressingCarrier
Example
{
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
}
LcsShipmentAddressingCarrier: object
- is_carrier_location: boolean
- carrier_location_reference: string
Example
{
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
LcsShipmentItemModel: object
- sku: string
- reference: string
- position: string
- quantity: integer
- description: string
- hs_code: string
- service: LcsServiceOption
-
LcsServiceOption - references: LcsShipmentItemModelReferences
-
LcsShipmentItemModelReferences
Example
{
"sku": "string",
"reference": "string",
"position": "string",
"quantity": "integer",
"description": "string",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
],
"references": [
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
]
}
LcsGroupedShipmentItem: object
- ids: string[]
-
string - sku: string
- quantity: integer
- hs_code: string
- description: string
- references: LcsShipmentItemModelReferences
-
LcsShipmentItemModelReferences - lists: LcsGroupedShipmentItemLists
-
LcsGroupedShipmentItemLists - parcels: LcsGroupedShipmentItemLists
-
LcsGroupedShipmentItemLists - positions: LcsGroupedShipmentItemPositions
-
LcsGroupedShipmentItemPositions - handled_ids: string[]
-
string (uuid) - boxed_ids: string[]
-
string (uuid) - listed_ids: string[]
-
string (uuid) - finished_ids: string[]
-
string (uuid) - missing_ids: string[]
-
string (uuid) - shipment_id: string (uuid)
- totals: LcsGroupedShipmentItemTotals
Example
{
"ids": [
"string"
],
"sku": "string",
"quantity": "integer",
"hs_code": "string",
"description": "string",
"references": [
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
],
"lists": [
{
"id": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
],
"parcels": [
"#/definitions/LcsGroupedShipmentItemLists"
],
"positions": [
{
"code": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
],
"handled_ids": [
"string (uuid)"
],
"boxed_ids": [
"string (uuid)"
],
"listed_ids": [
"string (uuid)"
],
"finished_ids": [
"string (uuid)"
],
"missing_ids": [
"string (uuid)"
],
"shipment_id": "string (uuid)",
"totals": {
"boxed": "integer",
"handled": "integer",
"finished": "integer",
"missing": "integer",
"listed": "integer"
}
}
LcsShipmentItemModelReferences: object
- order_item_id: string (uuid)
- claim_item_id: string (uuid)
Example
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
LcsGroupedShipmentItemLists: object
- id: string (uuid)
- item_ids: string[]
-
string (uuid)
Example
{
"id": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
LcsGroupedShipmentItemPositions: object
- code: string (uuid)
- item_ids: string[]
-
string (uuid)
Example
{
"code": "string (uuid)",
"item_ids": [
"string (uuid)"
]
}
LcsGroupedShipmentItemTotals: object
- boxed: integer
- handled: integer
- finished: integer
- missing: integer
- listed: integer
Example
{
"boxed": "integer",
"handled": "integer",
"finished": "integer",
"missing": "integer",
"listed": "integer"
}
LcsShipmentItem: object
- id: string
- reference: string
- sku: string
- position: string
- order_item_id: string (uuid)
- claim_item_id: string (uuid)
- description: string
- is_listed: boolean
- is_handled: boolean
- is_boxed: boolean
- is_in_transit: boolean
- is_finished: boolean
- is_missing: boolean
- hs_code: string
- service: LcsServiceOption
-
LcsServiceOption
Example
{
"id": "string",
"reference": "string",
"sku": "string",
"position": "string",
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)",
"description": "string",
"is_listed": "boolean",
"is_handled": "boolean",
"is_boxed": "boolean",
"is_in_transit": "boolean",
"is_finished": "boolean",
"is_missing": "boolean",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
]
}
LcsParcelItem: object
- id: string (uuid)
- sku: string
- quantity: integer
- description: string
Example
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
LcsServiceOption: object
- option: string giftwrap
- configuration: LcsServiceOptionConfiguration
-
LcsServiceOptionConfiguration
Example
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
LcsServiceOptionConfiguration: object
- key: string packing_paper
- value: string
Example
{
"key": "string",
"value": "string"
}
LcsParcel: object
- id: string
- number: string
- weight: integer
- length: integer
- width: integer
- height: integer
- tracking_code: string
- tracking_url: string
- position: string
- label: LcsParcelLabel
- shipment_id: string (uuid)
- count: integer
- items: LcsParcelItem
-
LcsParcelItem - is_in_transit: boolean
- is_delivered: boolean
- is_outbound: boolean
- is_finished: boolean
- file_id: string
- ship_at: string (date-time)
- in_transit_at: string (date-time)
- finished_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"number": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"position": "string",
"label": {
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
},
"shipment_id": "string (uuid)",
"count": "integer",
"items": [
{
"id": "string (uuid)",
"sku": "string",
"quantity": "integer",
"description": "string"
}
],
"is_in_transit": "boolean",
"is_delivered": "boolean",
"is_outbound": "boolean",
"is_finished": "boolean",
"file_id": "string",
"ship_at": "string (date-time)",
"in_transit_at": "string (date-time)",
"finished_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsParcelLabel: object
- file_id: string
- reference: string
- label_text: string
- requested_at: string (date-time)
Example
{
"file_id": "string",
"reference": "string",
"label_text": "string",
"requested_at": "string (date-time)"
}
LcsParcelCreateModel: object
- shipment_id: string
- weight: integer
- length: integer
- width: integer
- height: integer
- tracking_code: string
- tracking_url: string
- item_ids: string[]
-
string
Example
{
"shipment_id": "string",
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"tracking_code": "string",
"tracking_url": "string",
"item_ids": [
"string"
]
}
LcsParcelModel: object
- weight: integer
- length: integer
- width: integer
- height: integer
- ship_at: string (date-time)
- tracking_code: string
- tracking_url: string
- position: string
Example
{
"weight": "integer",
"length": "integer",
"width": "integer",
"height": "integer",
"ship_at": "string (date-time)",
"tracking_code": "string",
"tracking_url": "string",
"position": "string"
}
LcsFulfilmentLocation: object
- id: string
- name: string
- reference: string (uuid)
- address_id: string
- is_disabled: boolean
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"name": "string",
"reference": "string (uuid)",
"address_id": "string",
"is_disabled": "boolean",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
LcsFulfilmentLocationModel: object
- name: string
- address_id: string
- is_disabled: boolean false
Example
{
"name": "string",
"address_id": "string",
"is_disabled": "boolean"
}
LcsShipmentUpdateModel: object
- type: string delivery, collect, internal
- method_id: string
- addressing: LcsShipmentUpdateModelAddressing
- prior_shipments: string[]
-
string (uuid) - expected_at: string (date-time)
- ship_at: string (date-time)
Example
{
"type": "string",
"method_id": "string",
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"prior_shipments": [
"string (uuid)"
],
"expected_at": "string (date-time)",
"ship_at": "string (date-time)"
}
LcsShipmentModel: object
- addressing: LcsShipmentUpdateModelAddressing
- is_outbound: boolean
- type: string delivery, collect, internal
- items: LcsShipmentItemModel
-
LcsShipmentItemModel - backorders: LcsShipmentItemCorrection
-
LcsShipmentItemCorrection - overage: LcsShipmentItemCorrection
-
LcsShipmentItemCorrection - expected_at: string (date-time)
- ship_at: string (date-time)
- estimated_ship_at: string (date-time)
- method_id: string
- contact_id: string
- channel_id: string (uuid)
- order_id: string
- prior_shipments: string[]
-
string (uuid)
Example
{
"addressing": {
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
},
"is_outbound": "boolean",
"type": "string",
"items": [
{
"sku": "string",
"reference": "string",
"position": "string",
"quantity": "integer",
"description": "string",
"hs_code": "string",
"service": [
{
"option": "string",
"configuration": [
{
"key": "string",
"value": "string"
}
]
}
],
"references": [
{
"order_item_id": "string (uuid)",
"claim_item_id": "string (uuid)"
}
]
}
],
"backorders": [
{
"sku": "string",
"quantity": "integer",
"description": "string",
"position": "string"
}
],
"overage": [
"#/definitions/LcsShipmentItemCorrection"
],
"expected_at": "string (date-time)",
"ship_at": "string (date-time)",
"estimated_ship_at": "string (date-time)",
"method_id": "string",
"contact_id": "string",
"channel_id": "string (uuid)",
"order_id": "string",
"prior_shipments": [
"string (uuid)"
]
}
LcsShipmentUpdateModelAddressing: object
- to: LcsShipmentAddressing
- from: LcsShipmentAddressing
Example
{
"to": {
"entity_type": "string",
"entity_id": "string",
"carrier": {
"is_carrier_location": "boolean",
"carrier_location_reference": "string"
}
},
"from": "#/definitions/LcsShipmentAddressing"
}
LcsAddress: object
- country_code: string
-
Two letter country code
- administrative_area: string
-
The state or province name or abbreviation (optional)
- locality: string
-
City
- dependent_locality: string
-
Additional information about the locality (optional)
- postal_code: string
-
The complete postal code for the delivery point
- sorting_code: string
-
Allow sorting, for example to route mail (optional)
- address_line_1: string
-
The first address line
- address_line_2: string
-
The second address line (optional)
- thoroughfare: string
- premise_number: number
- premise_number_suffix: string
- organisation: string
-
The name of the recipient, firm, or company at this address (optional)
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
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": "number",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
}
LcsPoints: array
- distance: number
- point: LcsPoint
Example
[
{
"distance": "number",
"point": {
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longitude": "number (float64)",
"address": {
"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": "number",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "string"
}
]
}
]
}
}
]
LcsPoint: object
- id: string
- name: string
- carrier: string
- latitude: number (float64)
- longitude: number (float64)
- address: LcsAddress
- openings: LcsPointOpenings
-
LcsPointOpenings
Example
{
"id": "string",
"name": "string",
"carrier": "string",
"latitude": "number (float64)",
"longitude": "number (float64)",
"address": {
"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": "number",
"premise_number_suffix": "string",
"organisation": "string",
"given_name": "string",
"additional_name": "string",
"family_name": "string"
},
"openings": [
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "string"
}
]
}
]
}
LcsPointOpenings: object
- weekday: number
- windows: LcsPointOpeningsWindows
-
LcsPointOpeningsWindows
Example
{
"weekday": "number",
"windows": [
{
"start": "string",
"end": "string"
}
]
}
LcsPointOpeningsWindows: object
- start: string
- end: string
Example
{
"start": "string",
"end": "string"
}
SplJob: object
- id: string
- job: string
- tag: string
- description: string
- artifact: string
- reference: string
- status: string scheduled, pending, printed, failed, cancelled
- hub_id: string
- schedule_at: string (date-time)
- printed_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"job": "string",
"tag": "string",
"description": "string",
"artifact": "string",
"reference": "string",
"status": "string",
"hub_id": "string",
"schedule_at": "string (date-time)",
"printed_at": "string (date-time)",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
SplJobModel: object
- job: string
- tag: string
- description: string
- reference: string
- hub_id: string
- schedule_at: string (date-time)
Example
{
"job": "string",
"tag": "string",
"description": "string",
"reference": "string",
"hub_id": "string",
"schedule_at": "string (date-time)"
}
SplJobResult: object
- reference: string
- status: string scheduled, pending, success, failed, cancelled
Example
{
"reference": "string",
"status": "string"
}
SplStatus: object
- status: string
- changed_at: string (date-time)
Example
{
"status": "string",
"changed_at": "string (date-time)"
}
MesTask: object
- id: string (uuid)
- name: string
- description: string
- progress: integer
- result: string
- started_at: string (date-time)
- completed_at: string (date-time)
- expires_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"description": "string",
"progress": "integer",
"result": "string",
"started_at": "string (date-time)",
"completed_at": "string (date-time)",
"expires_at": "string (date-time)"
}
CntHtmlToInlinePdfRequest: object
- size: object
-
- predefined: string a3, a4, a5, a6, letter, legal, tabloid, custom
- width: integer
-
Size in mm
- height: integer
-
Size in mm
- margin: object
-
- top: integer 0
- bottom: integer 0
- left: integer 0
- right: integer 0
- content: string (base64)
- wait_delay: integer 2
- wait_timeout: integer 10
Example
{
"size": {
"predefined": "string",
"width": "integer",
"height": "integer"
},
"margin": {
"top": "integer",
"bottom": "integer",
"left": "integer",
"right": "integer"
},
"content": "string (base64)",
"wait_delay": "integer",
"wait_timeout": "integer"
}
CntHtmlToPdfRequest: object
- path: string
- filename: string
- size: object
-
- predefined: string a3, a4, a5, a6, letter, legal, tabloid, custom
- width: integer
-
Size in mm
- height: integer
-
Size in mm
- margin: object
-
- top: integer 0
- bottom: integer 0
- left: integer 0
- right: integer 0
- method: string upsert, resolve, strict
- content: string (base64)
- wait_delay: integer 2
- wait_timeout: integer 10
Example
{
"path": "string",
"filename": "string",
"size": {
"predefined": "string",
"width": "integer",
"height": "integer"
},
"margin": {
"top": "integer",
"bottom": "integer",
"left": "integer",
"right": "integer"
},
"method": "string",
"content": "string (base64)",
"wait_delay": "integer",
"wait_timeout": "integer"
}
CntPdf: object
- id: string
- filename: string
- label: string
- dir: string
- type: string file
- mime: string
- url: string
- is_public: boolean
- is_listed: boolean
- metadata: object
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string",
"filename": "string",
"label": "string",
"dir": "string",
"type": "string",
"mime": "string",
"url": "string",
"is_public": "boolean",
"is_listed": "boolean",
"metadata": "object",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntInstantProxy: object
- key: string
- indexes: CntInstantProxyIndex
-
CntInstantProxyIndex - created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
],
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntCreateProxyRequest: object
- key: string
- indexes: CntInstantProxyIndex
-
CntInstantProxyIndex
Example
{
"key": "string",
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
CntUpdateProxyRequest: object
- indexes: CntInstantProxyIndex
-
CntInstantProxyIndex
Example
{
"indexes": [
{
"index_id": "string (uuid)",
"alias": "string"
}
]
}
CntInstantProxyIndex: object
- index_id: string (uuid)
- alias: string
Example
{
"index_id": "string (uuid)",
"alias": "string"
}
CntListIndex: object
- id: string (uuid)
- name: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntIndex: object
- id: string (uuid)
- name: string
- host: string
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"id": "string (uuid)",
"name": "string",
"host": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
CntListIndexFilter: object
- type: string string, boolean, number
- key: string
Example
{
"type": "string",
"key": "string"
}
CntInputDocument: object
- reference: string
- title: string
- description: string
- sub: string
- metadata: object
-
The data to return in search results
- filters: object
-
The data to be used for filters and faceting
Example
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
CntSearchRequest: object
- q: string
- offset: integer
- limit: integer
- threshold: integer
- indices: string[]
-
string - filters: CntInstantFilter
-
CntInstantFilter - facets: string[]
-
string
Example
{
"q": "string",
"offset": "integer",
"limit": "integer",
"threshold": "integer",
"indices": [
"string"
],
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"facets": [
"string"
]
}
CntSearchIndexRequest: object
- q: string
- offset: integer
- limit: integer
- threshold: integer
- filters: CntInstantFilter
-
CntInstantFilter - facets: string[]
-
string
Example
{
"q": "string",
"offset": "integer",
"limit": "integer",
"threshold": "integer",
"filters": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"facets": [
"string"
]
}
CntInstantFilter: object
- key: string
- operator: string in, gt, gte, lt, lte, not_in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CntSearchResponse: object
"results" contains the search results for each selected index.
- results: CntIndexResponse
-
CntIndexResponse - offset: integer
- limit: integer
- count: integer
- q: string
Example
{
"results": [
{
"id": "string (uuid)",
"count": "integer",
"hits": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
]
}
],
"offset": "integer",
"limit": "integer",
"count": "integer",
"q": "string"
}
CntIndexResponse: object
- id: string (uuid)
- count: integer
- hits: CntDocumentResponse
-
CntDocumentResponse - facets: CntFacet
-
CntFacet
Example
{
"id": "string (uuid)",
"count": "integer",
"hits": [
{
"reference": "string",
"title": "string",
"description": "string",
"sub": "string",
"metadata": "object",
"filters": "object"
}
],
"facets": [
{
"key": "string",
"buckets": [
{
"value": "string",
"count": "string"
}
]
}
]
}
CntIndexSettings: object
- synonyms: CntIndexSettingsSynonyms
- stop_words: string[]
-
string - ranking_rules: string[]
-
string - facet_fields: string[]
-
string - distinct_field: string
- search_fields: string[]
-
string - display_fields: string[]
-
string - filters: CntListIndexFilter
-
CntListIndexFilter - last_processed_at: string (date-time)
Example
{
"synonyms": "object",
"stop_words": [
"string"
],
"ranking_rules": [
"string"
],
"facet_fields": [
"string"
],
"distinct_field": "string",
"search_fields": [
"string"
],
"display_fields": [
"string"
],
"filters": [
{
"type": "string",
"key": "string"
}
],
"last_processed_at": "string (date-time)"
}
CntIndexSettingsUpdate: object
- synonyms: CntIndexSettingsSynonyms
- stop_words: string[]
-
string - ranking_rules: string[]
-
string - filters: CntListIndexFilter
-
CntListIndexFilter
Example
{
"synonyms": "object",
"stop_words": [
"string"
],
"ranking_rules": [
"string"
],
"filters": [
{
"type": "string",
"key": "string"
}
]
}
CntIndexUpdateType: object
- name: string DocumentsAddition, DocumentsPartial, DocumentsDeletion, Settings
- number: integer
Example
{
"name": "string",
"number": "integer"
}
CntIndexUpdate: object
- status: string
- updateId: integer (int64)
- type: CntIndexUpdateType
- duration: number
- enqueuedAt: string
- processedAt: string
Example
{
"status": "string",
"updateId": "integer (int64)",
"type": {
"name": "string",
"number": "integer"
},
"duration": "number",
"enqueuedAt": "string",
"processedAt": "string"
}
CatGroup: object
- id: string
- name: string
- is_including_vat: boolean
-
True when prices are stored including taxes
- currency: string EUR
- metadata: object
- deleted_at: string (date-time)
- created_at: string (date-time)
- updated_at: string (date-time)
Example
{
"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)"
}
CatGroupCreate: object
- name: string
- is_including_vat: boolean
-
True when prices are stored including taxes
- currency: string
- metadata: object
Example
{
"name": "string",
"is_including_vat": "boolean",
"currency": "string",
"metadata": "object"
}
CatGroupUpdate: object
- name: string
- metadata: object
Example
{
"name": "string",
"metadata": "object"
}
CatNewPrice: object
- sku: string
- amount: integer
- original_amount: integer
- active_at: string (date-time)
Example
{
"sku": "string",
"amount": "integer",
"original_amount": "integer",
"active_at": "string (date-time)"
}
CatPrice: object
Example
{
"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)"
}
CatPriceSearch: object
- active_at: string (date-time)
- constraints: CatPriceConstraint
-
CatPriceConstraint
Example
{
"active_at": "string (date-time)",
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
CatPriceConstraint: object
- key: string sku
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
CatProductVatModel: object
- sku: string
- rates: CatVatModel
-
CatVatModel
Example
{
"sku": "string",
"rates": [
{
"country": "string",
"administrative_area": "string",
"reference": "integer"
}
]
}
CatVatModel: object
- country: string
- administrative_area: string
- reference: integer
Example
{
"country": "string",
"administrative_area": "string",
"reference": "integer"
}
CatVat: object
- rate: integer
- country: string
- administrative_area: string
Example
{
"rate": "integer",
"country": "string",
"administrative_area": "string"
}
CatVatRate: object
- reference: integer
- rate: integer
- country: string
- is_default: boolean
- administrative_area: string
- active_at: string (date-time)
Example
{
"reference": "integer",
"rate": "integer",
"country": "string",
"is_default": "boolean",
"administrative_area": "string",
"active_at": "string (date-time)"
}
RelAddressQuery: object
- session_key: string
- context: string
- query: string
Example
{
"session_key": "string",
"context": "string",
"query": "string"
}
RelAddressResults: object
- options: RelAddressResultsOptions
-
RelAddressResultsOptions - result: RelGeoLocation
Example
{
"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"
}
}
}
RelAddressResultsOptions: object
- value: string
- precision: string Locality, Street, PostalCode, PartialAddress, Address
- label: string
- description: string
- context: string
Example
{
"value": "string",
"precision": "string",
"label": "string",
"description": "string",
"context": "string"
}
RelGeocodeRequest: object
- country_code: string
-
Two letter counpremise_numbertry code
- address: string
-
The address
Example
{
"country_code": "string",
"address": "string"
}
RelGeoLocation: object
- lat: number
- long: number
- box: RelGeolocationBox
- is_precise: boolean
- address: RelGeolocationAddress
Example
{
"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"
}
}
RelGeolocationBox: object
- north_east: object
-
- lat: number
- long: number
- south_west: object
-
- lat: number
- long: number
Example
{
"north_east": {
"lat": "number",
"long": "number"
},
"south_west": {
"lat": "number",
"long": "number"
}
}
RelGeolocationAddress: object
- premise_number: integer
- premise_number_suffix: string
-
Might be null, depends on source API
- thoroughfare: string
- postal_code: string
- locality: string
- administrative_area: string
- country_code: string
Example
{
"premise_number": "integer",
"premise_number_suffix": "string",
"thoroughfare": "string",
"postal_code": "string",
"locality": "string",
"administrative_area": "string",
"country_code": "string"
}
RelIdentityExistsRequest: object
- email: string
- audience: string
Example
{
"email": "string",
"audience": "string"
}
RelCreateIdentityRequest: object
- email: string
- password: string
- audience: string
Example
{
"email": "string",
"password": "string",
"audience": "string"
}
RelCreateTokenRequest: object
- email: string
- type: string reset, confirm
- audience: string
Example
{
"email": "string",
"type": "string",
"audience": "string"
}
RelCreateResetRequest: object
- token: string
- password: string
Example
{
"token": "string",
"password": "string"
}
RelSignedTokenResponse: object
- token: string
- expires_at: string (date-time)
Example
{
"token": "string",
"expires_at": "string (date-time)"
}
RelConstraint: object
- key: string id
- operator: string in
- value: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
RelSearch: object
- constraints: RelConstraint
-
RelConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"value": [
"string"
]
}
]
}
RelFieldList: object
- required: string[]
-
string - allowed: string[]
-
string - country_code: string
-
Country code that was used for the query
Example
{
"required": [
"string"
],
"allowed": [
"string"
],
"country_code": "string"
}
RelContact: object
- id: string
- version: string
- email: string
- is_guest: boolean
- audience: string default
- tags: string[]
-
string - given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
- organisations: RelOrganisationList
- billing: RelAddressList
- shipping: RelAddressList
- phone_numbers: RelPhoneNumberList
- metadata: RelMetadata
- created_at: string (date-time)
- updated_at: string (date-time)
- deleted_at: string (date-time)
Example
{
"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"
}
},
"is_precise": "boolean"
}
}
}
}
}
}
RelContactUpdate: object
- email: string
- is_guest: boolean false
- audience: string default
- tags: string[]
-
string - given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
- organisations: RelContactUpdateOrganisations
- billing: RelContactUpdateBilling
- shipping: RelContactUpdateShipping
- phone_numbers: RelContactUpdatePhoneNumbers
- metadata: RelMetadata
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"
}
RelContactUpdateOrganisations: object
Example
{
"primary": {
"id": "string",
"version": "string"
},
"secondary": [
"#/definitions/RelContactUpdateOrganisationsPrimary"
]
}
RelContactUpdateOrganisationsPrimary: object
- id: string
- version: string
Example
{
"id": "string",
"version": "string"
}
RelContactUpdateBilling: object
- primary: string
- secondary: string[]
-
string
Example
{
"primary": "string",
"secondary": [
"string"
]
}
RelContactUpdateShipping: object
- primary: string
- secondary: string[]
-
string
Example
{
"primary": "string",
"secondary": [
"string"
]
}
RelContactUpdatePhoneNumbers: object
- primary: string
- secondary: string[]
-
string
Example
{
"primary": "string",
"secondary": [
"string"
]
}
RelOrganisationList: object
- primary: RelOrganisation
- secondary: RelOrganisation
-
RelOrganisation
Example
{
"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"
}
},
"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"
]
}
}
}
RelOrganisation: object
- id: string
- version: string
- name: string
-
The name of the recipient, firm, or company at this address (optional)
- file_id: string
-
The file_id ( logo ) of the organisation
- coc_number: string
- account_manager: string
- administration: object
-
- email: string
- tags: string[]
-
string - metadata: RelMetadata
- registrations: RelVatRegistration
-
RelVatRegistration - payment_settings: RelOrganisationPaymentSettings
- phone_numbers: RelPhoneNumberList
- billing: RelAddressList
- shipping: RelAddressList
- created_at: string (date-time)
- updated_at: string (date-time)
- deleted_at: string (date-time)
Example
{
"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",
"created_at": "string (date-time)"
}
RelOrganisationPaymentSettings: object
- post_payment: RelOrganisationPaymentSettingsPostPayment
- invoice: RelOrganisationPaymentSettingsInvoice
Example
{
"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"
}
}
RelOrganisationPaymentSettingsPostPayment: object
- spending_limit: integer (int64)
- current_due_amount: integer
- due_after: integer
- iban: string[]
-
string
Example
{
"spending_limit": "integer (int64)",
"current_due_amount": "integer",
"due_after": "integer",
"iban": [
"string"
]
}
RelOrganisationPaymentSettingsInvoice: object
- is_expected_through_post_mail: boolean
- is_expected_through_email: boolean
- is_expected_at_delivery: boolean
Example
{
"is_expected_through_post_mail": "boolean",
"is_expected_through_email": "boolean",
"is_expected_at_delivery": "boolean"
}
RelOrganisationUpdateModel: object
- name: string
-
The name of the recipient, firm, or company at this address (optional)
- file_id: string
-
The file_id ( logo ) of the organisation
- coc_number: string
- account_manager: string
- tags: string[]
-
string - metadata: RelMetadata
- registrations: RelVatRegistrationModel
-
RelVatRegistrationModel - payment_settings: RelOrganisationPaymentSettings
- billing: RelContactUpdateBilling
- shipping: RelContactUpdateShipping
- phone_numbers: RelContactUpdatePhoneNumbers
- administration: RelOrganisationUpdateAdministration
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"
}
}
RelVatRegistrationModel: object
- country_code: string
- number: string
Example
{
"country_code": "string",
"number": "string"
}
RelVatRegistration: object
- country_code: string
- number: string
- verification: RelVatRegistrationVerification
Example
{
"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)"
}
}
RelVatRegistrationVerification: object
- is_pending: boolean true
- is_valid: boolean false
- country_code: string
- name: string
- type: string
- metadata: object
- verified_at: string (date-time)
Example
{
"is_pending": "boolean",
"is_valid": "boolean",
"country_code": "string",
"name": "string",
"type": "string",
"metadata": "object",
"verified_at": "string (date-time)"
}
RelPhoneNumber: object
- id: string
- country_code: string
-
Two letter country code
- number: string
-
The actual phonenumber formatted as E164
- national: string
-
The actual phonenumber formatted as national number
- type: string fixed_number, mobile, toll-free, premium, shared_cost, voip, personal
- created_at: string (date-time)
Example
{
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
}
RelPhoneNumberList: object
- primary: RelPhoneNumber
- secondary: RelPhoneNumber
-
RelPhoneNumber
Example
{
"primary": {
"id": "string",
"country_code": "string",
"number": "string",
"national": "string",
"type": "string",
"created_at": "string (date-time)"
},
"secondary": [
"#/definitions/RelPhoneNumber"
]
}
RelPhoneNumberModel: object
- country_code: string
-
Two letter country code
- number: string
-
The actual phonenumber
Example
{
"country_code": "string",
"number": "string"
}
RelAddressList: object
- primary: RelAddress
- secondary: RelAddress
-
RelAddress
Example
{
"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"
]
}
RelAddressModel: object
- country_code: string
-
Two letter country code
- administrative_area: string
-
The state or province name or abbreviation (optional)
- locality: string
-
City
- dependent_locality: string
-
Additional information about the locality (optional)
- postal_code: string
-
The complete postal code for the delivery point
- sorting_code: string
-
Allow sorting, for example to route mail (optional)
- address_line_1: string
-
The first address line
- address_line_2: string
-
The second address line (optional)
- thoroughfare: string
- premise_number: integer
- premise_number_suffix: string
- organisation: string
-
The name of the recipient, firm, or company at this address (optional)
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
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"
}
RelAddress: object
- id: string
- country_code: string
-
Two letter counpremise_numbertry code
- administrative_area: string
-
The state or province name or abbreviation (optional)
- locality: string
-
City
- dependent_locality: string
-
Additional information about the locality (optional)
- postal_code: string
-
The complete postal code for the delivery point
- sorting_code: string
-
Allow sorting, for example to route mail (optional)
- address_line_1: string
-
The first address line
- address_line_2: string
-
The second address line (optional)
- thoroughfare: string
- premise_number: integer
- premise_number_suffix: string
- organisation: string
-
The name of the recipient, firm, or company at this address (optional)
- given_name: string
-
First name
- additional_name: string
-
Patronymic
- family_name: string
-
Last name
- geo_location: RelGeoLocation
- created_at: string (date-time)
Example
{
"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)"
}
RelAddressSearch: object
- constraints: RelAddressSearchConstraint
-
RelAddressSearchConstraint
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
RelAddressSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
RelPhoneNumberSearch: object
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
RelPhoneNumberSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
RelOrganisationSearch: object
Example
{
"constraints": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
]
}
RelOrganisationSearchConstraint: object
- key: string ids
- operator: string in
- values: string[]
-
string
Example
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}