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
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
MesConversations
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": "object",
"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": "object",
"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": "object",
"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": "object",
"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": "object",
"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": "object",
"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": "object",
"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": "object",
"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"
]
}
}
OdrOrders
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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": {
"id": "string (uuid)"
},
"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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": {
"id": "string (uuid)"
},
"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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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 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": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean",
"result": {
"is_applied_rule": "boolean",
"rule_id": "string",
"output": "integer"
}
}
],
"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": {
"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"
}
},
"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": [
{
"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"
}
],
"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",
"version": "string"
}
},
"vendor": {
"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"
}
},
"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"
],
"coupons": [
"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"
]
}
}
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": [
{
"reference": "string",
"description": "string",
"amount": "number",
"is_percentage": "boolean",
"is_discount": "boolean"
}
],
"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": [
{
"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"
}
],
"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",
"version": "string"
}
},
"vendor": {
"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"
}
},
"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"
],
"coupons": [
"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"
]
}
}
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"
]
}
}
OdrItems
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"
]
}
}
OdrSearch
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": {
"id": "string (uuid)",
"version": "string (uuid)"
},
"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)",
"last_confirmed_at": "string (date-time)",
"last_canceled_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"
]
}
}
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": [
{
"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": {
"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"
}
},
"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"
],
"coupons": [
"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"
]
}
}
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": [
{
"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": [
{
"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": {
"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"
}
},
"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 (uuid)"
],
"coupons": [
"string (uuid)"
],
"calculation_id": "string (uuid)",
"shipment_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"
]
}
}
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"
]
}
}
OdrSkus
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