Introduction
The Booqable API is a RESTful JSON API as such is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use standard HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients.
Endpoint
All API requests need to be directed to the correct company-specific endpoint. The format is as follows:
https://{company_slug}.booqable.com/api/boomerang/
Response types
The Booqable API supports two response types jsonapi and json.
By default, the API returns jsonapi responses. These responses are designed to return graph data more efficiently and also include links to related resources.
You can, however, also request data in nested structure by appending .json to the path of each request.
A typical JSON API response:
GET /api/boomerang/orders?include=customer
{
"data": [
{
"id": "54808378-a247-4715-89f6-0a8da2e7ad62",
"type": "orders",
"attributes": {
"starts_at": "2021-11-12T15:00:00+00:00",
"stops_at": "2021-11-13T15:00:00+00:00"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/24e54970-7473-49a9-a71a-8c07eb97e510"
},
"data": {
"type": "customers",
"id": "24e54970-7473-49a9-a71a-8c07eb97e510"
}
}
}
}
],
"included": [
{
"id": "24e54970-7473-49a9-a71a-8c07eb97e510",
"type": "customers",
"attributes": {
"name": "John Doe"
},
"relationships": {
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=24e54970-7473-49a9-a71a-8c07eb97e510&filter[owner_type]=Customer"
}
}
}
}
],
"links": {
"self": "api/boomerang/orders?fields%5Bcustomer%5D=name&fields%5Borders%5D=starts_at%2Cstops_at&include=customer&page%5Bnumber%5D=1&page%5Bsize%5D=25",
"first": "api/boomerang/orders?fields%5Bcustomer%5D=name&fields%5Borders%5D=starts_at%2Cstops_at&include=customer&page%5Bnumber%5D=1&page%5Bsize%5D=25",
"last": "api/boomerang/orders?fields%5Bcustomer%5D=name&fields%5Borders%5D=starts_at%2Cstops_at&include=customer&page%5Bnumber%5D=1&page%5Bsize%5D=25"
},
"meta": {}
}
A JSON response:
GET /api/boomerang/orders.json?include=customer
{
"data": [
{
"id": "30d35575-c8d1-4f5c-b4c6-cc0abc32c6ed",
"starts_at": "2021-11-12T15:15:00+00:00",
"stops_at": "2021-11-13T15:15:00+00:00",
"customer": {
"id": "92ec8fee-423e-4f7e-8565-3e6028a0f437",
"name": "John Doe"
}
}
]
}
Fields
For every resource, fields can be written, read, filtered, sorted, and aggregated. The behavior of fields is described for each resource.
On every request, you can specify fields to be returned in the response. Note that you can also specify fields of included resources.
Including specific fields can be done like this:
?fields[orders]=starts_at,stops_at&fields[plannings]=reserved_from,reserved_till
Filtering
Collections returned in list requests can be filtered on specific fields; filters support the following operators:
| Type | Operators |
|---|---|
| String | eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
| Uuid | eq, not_eq |
| Enum | eq, not_eq |
| Integer | eq, not_eq, gt, gte, lt, lte |
| Integer | eq, not_eq, gt, gte, lt, lte |
| Big Decimal | eq, not_eq, gt, gte, lt, lte |
| Float | eq, not_eq, gt, gte, lt, lte |
| Boolean | eq |
| Date | eq, not_eq, gt, gte, lt, lte |
| DateTime | eq, not_eq, gt, gte, lt, lte |
| Hash | eq |
| Array | eq |
How to filter a request:
/api/boomerang/orders?filter[starts_at][gte]=1980-11-16T09:00:00+00:00&filter[starts_at][lte]=1990-11-16T09:00:00+00:00&filter[status]=reserved
Includes
The Booqable API consists of many resources related to each other. Therefore the API supports loading associated resources in a single request. Use the dot-syntax to deeply nest includes.
Including associated data:
GET api/boomerang/orders?include=customer,customer.properties
{
"data": {
"id": "f2afdb0e-55bd-4993-b9c2-4f04b569419d",
"type": "orders",
"attributes": {
"starts_at": "2021-11-12T16:00:00+00:00",
"stops_at": "2021-11-13T16:00:00+00:00"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/404021af-c889-4d72-9296-481640f4c750"
},
"data": {
"type": "customers",
"id": "404021af-c889-4d72-9296-481640f4c750"
}
},
}
},
"included": [
{
"id": "404021af-c889-4d72-9296-481640f4c750",
"type": "customers",
"attributes": {
"name": "John Doe"
},
"relationships": {
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=404021af-c889-4d72-9296-481640f4c750&filter[owner_type]=Customer"
},
"data": [
{
"type": "properties",
"id": "9625bd15-732e-4301-8c1c-f5b3e03c1bed"
}
]
},
}
},
{
"id": "9625bd15-732e-4301-8c1c-f5b3e03c1bed",
"type": "properties",
"attributes": {
"name": "Phone",
"value": "+31600000000"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/404021af-c889-4d72-9296-481640f4c750"
}
}
}
}
],
"meta": {}
}
Stats
Results from list requests can be aggregated by providing stats. These stats are always computed over the unpaginated filtered collection. The following aggregations are supported: count, count_each, average, sum, maximum, minimum. You can supply multiple types for each field.
Example of how to request stats:
?stats[to_be_paid_in_cents][]=sum&stats[grand_total_in_cents][]=average&stats[grand_total_in_cents][]=sum&stats[total]=count&stats[payment_status]=count
"meta": {
"stats": {
"to_be_paid_in_cents": {
"sum": 79000
},
"grand_total_in_cents": {
"average": 25000,
"sum": 1198000
},
"total": {
"count": 237
},
"payment_status": {
"count": {
"payment_due": 161,
"paid": 51,
"partially_paid": 13,
"overpaid": 11,
"process_deposit": 1
}
}
}
}
Sideposting
Due to the nature of actions in the API, the API does not support official JSON API compliant side posting. Instead, actions are designed in a way that related resources are managed automatically.
There are a few exceptions though, in these cases, resources can be created or associated by setting:
{resource_name}_attributesarray of resources to create, update and associate.{resource_name}_idsarray of resources to associate.{resource_name}_idid off the resource to associate.
When side posting is supported, it will be mentioned in the resource-specific documentation.
Advanced search
The following resources support advanced searching with POST requests:
- Order
- Item
- Bundle
- ProductGroup
- Product
- Document
- Planning
- Customer
With advanced search you can make logical filter groups with and/or operators. The example on the right yields:
(starts_at >= date AND starts_at <= date) OR (stops_at >= date AND stops_at <= date)
{
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"starts_at": {
"gte": "2022-04-27T12:54:37Z"
}
},
{
"starts_at": {
"lte": "2022-04-30T12:54:37Z"
}
}
]
},
{
"operator": "and",
"attributes": [
{
"stops_at": {
"gte": "2022-04-27T12:54:37Z"
}
},
{
"stops_at": {
"lte": "2022-04-30T12:54:37Z"
}
}
]
}
]
}
}
}
Authentication
To interact with the Booqable API, first, you have to have a means of authentification, here's how to setup authentication.
Access Token
- Go to your account settings page
{company-name-here}.booqable.com/employees/current - Name your new token
- Click "Create new authentication method"
You can manage your Access Tokens from your account. You can have multiple Access Tokens active at one time.
Example of an authorized request
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'Authorization: Bearer 9bcabeaa827810ad6383d2e15feab2d0c7d039093e22fdd955f11fe83437a32a'
You authenticate to the Booqable API by providing on of your Access Tokens in the request.
Request signing
Single-Use Tokens to sign requests are generated on the client and can only be used once for one particular request. The Booqable API supports the following signing algorithms:
ES256RS256HS256
- Go to your account settings page
{company-name-here}.booqable.com/employees/current - Name your new authentication method
- Insert your public key (for
ES256andRS256only) - Click "Create new authentication method"
You can manage your authentication methods from your account. You can have multiple authentication methods active at one time.
Signing a request (in Ruby, other languages should work like this as well)
# To prevent tampering with the request (making a DELETE from a GET, or posting different params with
# the same signature) we include all request data in the data value. Note that we generate a SHA256 from it.
request_method = 'POST'
# Encoded request params
fullpath = '/api/boomerang/orders/?filter%5Bcreated_at%5D%5Bgte%5D%3D1231232131132'
# Base64 encoded SHA256 body
body = '{"note":"Let me in!"}'
encoded_body = Base64.strict_encode64(::OpenSSL::Digest::SHA256.new(body).digest)
# Compute data value
data = Base64.strict_encode64(
::OpenSSL::Digest::SHA256.new([request_method, fullpath, encoded_body].join('.').join('.')).digest
)
# Generate a unique request identifier (can be anything unique)
uuid = Digest::UUID.uuid_v4
# We define the authentication method id (which you have obtained in a previous step) and kind in the header
headers = { kid: authentication_method_id, kind: 'single_use' }
payload = {
iss: 'http://company-name.booqable.com',
sub: employee_id,
aud: company_id,
exp: (Time.current + 10.minutes).to_i, # Can not exceed 10 minutes
iat: Time.current.to_i,
jti: "#{uuid}.#{data}"
}
# Note that with HS256 you don't have to supply a public key but a secret is generated for you.
token = JWT.encode payload, private_key, 'ES256', headers
token #=> eyJraWQiOiIwZTJkM2I2YS00OTU0LTQyZTItYTAyNS1kYjMzODE1ZDU2YzUiLCJraW5kIjoic2luZ2xlX3VzZSIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJodHRwOi8vY29tcGFueS1uYW1lLmJvb3FhYmxlLmNvbSIsInN1YiI6IjVlMWViZmFmLWM5YmEtNDMyOC1hM2U1LThlNzNmZGQ1NGNiOSIsImF1ZCI6IjE4ZGI4YTE0LThhYzctNDE1OS05NmJkLTMxMzI0NmRhYTExMCIsImV4cCI6MTYzNTk0ODk3MiwiaWF0IjoxNjM1OTQ4MzcyLCJqdGkiOiJmMTNkZjNlOC0zMWNjLTQxYTUtOWVlNy1mZjgzMTdmNWQ0Y2EuVUU5VFZDNHZQMlpwYkhSbGNpVTFRbU55WldGMFpXUmZZWFFsTlVRbE5VSm5kR1VsTlVRbE0wUXhNak14TWpNeU1UTXhNVE15TGpWemNGcEhSak5IZFdVeVoycFZRVVZ3ZUhsVll6VTVVbTlIZW5sb2NHMXNWbVo0WlVGNVRrSlZUazA5In0.7S2eI3R6meFPPgZ5iyZQOsTDBHRCihKozKMjvIrNHeYoEsxzKltQhGjb2rnfSlpGrCL38-ub-FTs5EXP39rJfw
The algorithm to generate the data value in the payload looks like this:
Base64(
SHA256(
[
request_method,
encoded_request_fullpath_with_paramaters,
Base64(
SHA256(request_body)
)
].join('.')
)
)
Example of an authorized request
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'Authorization: Bearer eyJraWQiOiIwZTJkM2I2YS00OTU0LTQyZTItYTAyNS1kYjMzODE1ZDU2YzUiLCJraW5kIjoic2luZ2xlX3VzZSIsImFsZyI6IkVTMjU2In0.eyJpc3MiOiJodHRwOi8vY29tcGFueS1uYW1lLmJvb3FhYmxlLmNvbSIsInN1YiI6IjVlMWViZmFmLWM5YmEtNDMyOC1hM2U1LThlNzNmZGQ1NGNiOSIsImF1ZCI6IjE4ZGI4YTE0LThhYzctNDE1OS05NmJkLTMxMzI0NmRhYTExMCIsImV4cCI6MTYzNTk0ODk3MiwiaWF0IjoxNjM1OTQ4MzcyLCJqdGkiOiJmMTNkZjNlOC0zMWNjLTQxYTUtOWVlNy1mZjgzMTdmNWQ0Y2EuVUU5VFZDNHZQMlpwYkhSbGNpVTFRbU55WldGMFpXUmZZWFFsTlVRbE5VSm5kR1VsTlVRbE0wUXhNak14TWpNeU1UTXhNVE15TGpWemNGcEhSak5IZFdVeVoycFZRVVZ3ZUhsVll6VTVVbTlIZW5sb2NHMXNWbVo0WlVGNVRrSlZUazA5In0.7S2eI3R6meFPPgZ5iyZQOsTDBHRCihKozKMjvIrNHeYoEsxzKltQhGjb2rnfSlpGrCL38-ub-FTs5EXP39rJfw
You authenticate to the Booqable API by signing the request.
Errors
The Booqable API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- You are not authenticated. |
| 403 | Forbidden -- The resource requested is hidden for administrators only. |
| 404 | Not Found -- The specified resource could not be found. |
| 405 | Method Not Allowed -- You tried to access a resource with an invalid method. |
| 406 | Not Acceptable -- You requested a format that isn't json. |
| 410 | Gone -- The resource requested has been removed from our servers. |
| 418 | I'm a teapot. |
| 422 | Unprocessible Entity -- Something wen't wrong saving your data. |
| 429 | Too Many Requests -- You're doing too many requests! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Resources
Barcodes
You can assign barcodes to products (or their variations), individually tracked stock items, and customers (for use on a customer card, for example).
Booqable supports the following barcode formats:
- QR code: QR codes are flexible in size, have high fault tolerance, and fast readability.
- EAN-8: Ideal for identifying small items, stores eight digits.
- EAN-13: Can store a relatively large amount of data (13 digits) in a small area.
- Code 39: Stores both digits and characters. The size of the barcode makes them unsuitable to use on small items.
- Code 93: A more compact alternative to Code 39 (about 25% shorter).
- Code 128: A high-density barcode that can store any character of the ASCII 128 character set.
Note that when using URLs as numbers, it's advised to base64 encode the number before filtering.
Endpoints
GET /api/boomerang/barcodes
DELETE /api/boomerang/barcodes/{id}
GET /api/boomerang/barcodes/{id}
PUT /api/boomerang/barcodes/{id}
POST /api/boomerang/barcodes
Fields
Every barcode has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
number |
String The barcode data, can be a number, code or url. Leave blank to let Booqable create one. When using a URL, it's advised to base64 encode the number before filtering. |
barcode_type |
String One of code39, code93, code128, ean8, ean13, qr_code |
image_url |
String readonlyThe barcode as an image |
owner_id |
Uuid ID of its owner |
owner_type |
String The resource type of the owner. One of orders, products, customers, stock_items |
Relationships
Barcodes have the following relationships:
| Name | Description |
|---|---|
owner |
Customer, Product, Order, Stock item Associated Owner |
Listing barcodes
How to fetch a list of barcodes:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/barcodes' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "97477a6a-cd91-4746-8525-0133ef521924",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:12+00:00",
"updated_at": "2024-04-29T09:24:12+00:00",
"number": "http://bqbl.it/97477a6a-cd91-4746-8525-0133ef521924",
"barcode_type": "qr_code",
"image_url": "http://company-name-54.lvh.me:/barcodes/97477a6a-cd91-4746-8525-0133ef521924/image",
"owner_id": "980a5c00-aa17-4bfc-9623-c3c20819849d",
"owner_type": "customers"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/980a5c00-aa17-4bfc-9623-c3c20819849d"
}
}
}
}
],
"meta": {}
}
How to find an owner by a barcode number:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/barcodes?filter%5Bnumber%5D=http%3A%2F%2Fbqbl.it%2Fc2c711cc-04c6-45e1-a74c-5e8cf56eaf63&include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "c2c711cc-04c6-45e1-a74c-5e8cf56eaf63",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:13+00:00",
"updated_at": "2024-04-29T09:24:13+00:00",
"number": "http://bqbl.it/c2c711cc-04c6-45e1-a74c-5e8cf56eaf63",
"barcode_type": "qr_code",
"image_url": "http://company-name-55.lvh.me:/barcodes/c2c711cc-04c6-45e1-a74c-5e8cf56eaf63/image",
"owner_id": "2011fc9f-0a47-4443-ab1c-175ea74656ec",
"owner_type": "customers"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/2011fc9f-0a47-4443-ab1c-175ea74656ec"
},
"data": {
"type": "customers",
"id": "2011fc9f-0a47-4443-ab1c-175ea74656ec"
}
}
}
}
],
"included": [
{
"id": "2011fc9f-0a47-4443-ab1c-175ea74656ec",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:24:13+00:00",
"updated_at": "2024-04-29T09:24:13+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=2011fc9f-0a47-4443-ab1c-175ea74656ec&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=2011fc9f-0a47-4443-ab1c-175ea74656ec&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=2011fc9f-0a47-4443-ab1c-175ea74656ec&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
How to find an owner by a barcode number containing a url:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/barcodes?filter%5Bnumber%5D=aHR0cDovL2JxYmwuaXQvM2Y1NTVkZjktNjJlZS00ZGVhLThjZmEtMjcyZmIwZTNkMjY2&include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "3f555df9-62ee-4dea-8cfa-272fb0e3d266",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:14+00:00",
"updated_at": "2024-04-29T09:24:14+00:00",
"number": "http://bqbl.it/3f555df9-62ee-4dea-8cfa-272fb0e3d266",
"barcode_type": "qr_code",
"image_url": "http://company-name-56.lvh.me:/barcodes/3f555df9-62ee-4dea-8cfa-272fb0e3d266/image",
"owner_id": "f1ccf65c-221f-4a2a-a33f-a90695bb1adc",
"owner_type": "customers"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/f1ccf65c-221f-4a2a-a33f-a90695bb1adc"
},
"data": {
"type": "customers",
"id": "f1ccf65c-221f-4a2a-a33f-a90695bb1adc"
}
}
}
}
],
"included": [
{
"id": "f1ccf65c-221f-4a2a-a33f-a90695bb1adc",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:24:14+00:00",
"updated_at": "2024-04-29T09:24:14+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=f1ccf65c-221f-4a2a-a33f-a90695bb1adc&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=f1ccf65c-221f-4a2a-a33f-a90695bb1adc&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=f1ccf65c-221f-4a2a-a33f-a90695bb1adc&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/barcodes
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[barcodes]=created_at,updated_at,number |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
number |
String eq |
barcode_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
owner
Destroying a barcode
How to delete a barcode:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/barcodes/4264c8dc-2b09-4cba-a053-80d92dc97ec2' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "4264c8dc-2b09-4cba-a053-80d92dc97ec2",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:14+00:00",
"updated_at": "2024-04-29T09:24:14+00:00",
"number": "http://bqbl.it/4264c8dc-2b09-4cba-a053-80d92dc97ec2",
"barcode_type": "qr_code",
"image_url": "http://company-name-57.lvh.me:/barcodes/4264c8dc-2b09-4cba-a053-80d92dc97ec2/image",
"owner_id": "01a044bd-41b5-4f62-bc4a-50065576e4cc",
"owner_type": "customers"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/01a044bd-41b5-4f62-bc4a-50065576e4cc"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/barcodes/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[barcodes]=created_at,updated_at,number |
Includes
This request accepts the following includes:
owner
Fetching a barcode
How to fetch a barcode:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/barcodes/b75eb383-d269-4f96-bb88-b9512a874c3e?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "b75eb383-d269-4f96-bb88-b9512a874c3e",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:15+00:00",
"updated_at": "2024-04-29T09:24:15+00:00",
"number": "http://bqbl.it/b75eb383-d269-4f96-bb88-b9512a874c3e",
"barcode_type": "qr_code",
"image_url": "http://company-name-58.lvh.me:/barcodes/b75eb383-d269-4f96-bb88-b9512a874c3e/image",
"owner_id": "aea78d2c-f946-4c48-865f-7a1a035baff6",
"owner_type": "customers"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/aea78d2c-f946-4c48-865f-7a1a035baff6"
},
"data": {
"type": "customers",
"id": "aea78d2c-f946-4c48-865f-7a1a035baff6"
}
}
}
},
"included": [
{
"id": "aea78d2c-f946-4c48-865f-7a1a035baff6",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:24:15+00:00",
"updated_at": "2024-04-29T09:24:15+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=aea78d2c-f946-4c48-865f-7a1a035baff6&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=aea78d2c-f946-4c48-865f-7a1a035baff6&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=aea78d2c-f946-4c48-865f-7a1a035baff6&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/barcodes/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[barcodes]=created_at,updated_at,number |
Includes
This request accepts the following includes:
owner
Updating a barcode
How to update a barcode:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/barcodes/dd8c3fb1-e279-4e45-bd0c-9f3c83cc0ee9' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "dd8c3fb1-e279-4e45-bd0c-9f3c83cc0ee9",
"type": "barcodes",
"attributes": {
"number": "https://myfancysite.com"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "dd8c3fb1-e279-4e45-bd0c-9f3c83cc0ee9",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:16+00:00",
"updated_at": "2024-04-29T09:24:16+00:00",
"number": "https://myfancysite.com",
"barcode_type": "qr_code",
"image_url": "http://company-name-59.lvh.me:/barcodes/dd8c3fb1-e279-4e45-bd0c-9f3c83cc0ee9/image",
"owner_id": "ff5f5a42-f125-451a-b955-77c93160ed24",
"owner_type": "customers"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/barcodes/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[barcodes]=created_at,updated_at,number |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][number] |
String The barcode data, can be a number, code or url. Leave blank to let Booqable create one. When using a URL, it's advised to base64 encode the number before filtering. |
data[attributes][barcode_type] |
String One of code39, code93, code128, ean8, ean13, qr_code |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of orders, products, customers, stock_items |
Includes
This request accepts the following includes:
owner
Creating a barcode
How to create a barcode:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/barcodes' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "barcodes",
"attributes": {
"barcode_type": "qr_code",
"owner_id": "04affaa8-8882-4900-99fb-71e4d7956599",
"owner_type": "customers"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "9f8397bf-3001-401a-9f89-72703ab10c30",
"type": "barcodes",
"attributes": {
"created_at": "2024-04-29T09:24:16+00:00",
"updated_at": "2024-04-29T09:24:16+00:00",
"number": "http://bqbl.it/9f8397bf-3001-401a-9f89-72703ab10c30",
"barcode_type": "qr_code",
"image_url": "http://company-name-60.lvh.me:/barcodes/9f8397bf-3001-401a-9f89-72703ab10c30/image",
"owner_id": "04affaa8-8882-4900-99fb-71e4d7956599",
"owner_type": "customers"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/barcodes
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[barcodes]=created_at,updated_at,number |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][number] |
String The barcode data, can be a number, code or url. Leave blank to let Booqable create one. When using a URL, it's advised to base64 encode the number before filtering. |
data[attributes][barcode_type] |
String One of code39, code93, code128, ean8, ean13, qr_code |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of orders, products, customers, stock_items |
Includes
This request accepts the following includes:
owner
Bundle items
Bundle items define which products and product groups are associated with a bundle. When bundles are planned on an order the quantity and discount percentage defined in a bundle item will apply.
When product_id is left blank, and the associated product group has variations, the variation needs to be specified when adding this bundle to an order (see order bookings for more information).
Endpoints
POST /api/boomerang/bundle_items
DELETE /api/boomerang/bundle_items/{id}
GET /api/boomerang/bundle_items
GET /api/boomerang/bundle_items/{id}
PUT /api/boomerang/bundle_items/{id}
Fields
Every bundle item has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
quantity |
Integer The quantity of the item |
discount_percentage |
Float The discount percentage for this product when rented out in a bundle |
position |
Integer Position of the product in bundle list |
bundle_id |
Uuid The associated Bundle |
product_group_id |
Uuid The associated Product group |
product_id |
Uuid nullableThe associated Product |
Relationships
Bundle items have the following relationships:
| Name | Description |
|---|---|
bundle |
Bundles readonlyAssociated Bundle |
product_group |
Product groups Associated Product group |
product |
Products readonlyAssociated Product |
Creating a bundle item
How to create a bundle item:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/bundle_items' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "bundle_items",
"attributes": {
"bundle_id": "7a0033d5-c2fb-458a-9a90-e19bcc70c642",
"product_group_id": "0624add3-20dc-4a3d-b3a1-c8b6c80c20aa",
"product_id": "d3a2fe0c-de68-428b-8999-46f92a86d32c",
"quantity": 2,
"discount_percentage": 15
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "619ac434-0607-4e54-9296-f18745e8d2ef",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:30:28+00:00",
"updated_at": "2024-04-29T09:30:28+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 2,
"bundle_id": "7a0033d5-c2fb-458a-9a90-e19bcc70c642",
"product_group_id": "0624add3-20dc-4a3d-b3a1-c8b6c80c20aa",
"product_id": "d3a2fe0c-de68-428b-8999-46f92a86d32c"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/bundle_items
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=bundle,product,product_group |
fields[] |
Array List of comma seperated fields to include ?fields[bundle_items]=created_at,updated_at,quantity |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][quantity] |
Integer The quantity of the item |
data[attributes][discount_percentage] |
Float The discount percentage for this product when rented out in a bundle |
data[attributes][position] |
Integer Position of the product in bundle list |
data[attributes][bundle_id] |
Uuid The associated Bundle |
data[attributes][product_group_id] |
Uuid The associated Product group |
data[attributes][product_id] |
Uuid The associated Product |
Includes
This request accepts the following includes:
bundle
product =>
photo
product_group =>
photo
Deleting a bundle item
How to delete a bundle item:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/bundle_items/4a4cda83-dbbd-4f59-b438-22203e308f18' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "4a4cda83-dbbd-4f59-b438-22203e308f18",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:30:29+00:00",
"updated_at": "2024-04-29T09:30:29+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 1,
"bundle_id": "242219d3-7ebf-4c0d-aa79-6156029bc7f1",
"product_group_id": "96f28f77-32f8-419d-bd1a-2e0dc24be116",
"product_id": "22dc11d6-7098-49e0-ae86-6495fcadf240"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/bundle_items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[bundle_items]=created_at,updated_at,quantity |
Includes
This request does not accept any includes
Listing bundle items
How to fetch a list of bundle items:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/bundle_items?filter%5Bbundle_id%5D=9967a641-3e77-46e3-b587-7a69c11897ea' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "45ce5307-695c-4792-b78f-78007ef318b5",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:30:31+00:00",
"updated_at": "2024-04-29T09:30:31+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 1,
"bundle_id": "9967a641-3e77-46e3-b587-7a69c11897ea",
"product_group_id": "89dcd1b2-0f7b-4c01-a28e-b920810faf11",
"product_id": "e7dc06bd-48ec-4588-b2b5-a6ed321f74e9"
},
"relationships": {
"bundle": {
"links": {
"related": "api/boomerang/bundles/9967a641-3e77-46e3-b587-7a69c11897ea"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/89dcd1b2-0f7b-4c01-a28e-b920810faf11"
}
},
"product": {
"links": {
"related": "api/boomerang/products/e7dc06bd-48ec-4588-b2b5-a6ed321f74e9"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/bundle_items
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=bundle,product,product_group |
fields[] |
Array List of comma seperated fields to include ?fields[bundle_items]=created_at,updated_at,quantity |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
quantity |
Integer eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
position |
Integer eq, not_eq, gt, gte, lt, lte |
bundle_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq, not_eq |
product_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
bundle
product =>
photo
product_group =>
photo
Fetching a bundle item
How to fetch a bundle item:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/bundle_items/33977649-c3af-4e75-bcfd-3223dd2244ad' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "33977649-c3af-4e75-bcfd-3223dd2244ad",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:30:32+00:00",
"updated_at": "2024-04-29T09:30:32+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 1,
"bundle_id": "da791739-c067-4845-9e80-9b3831bce432",
"product_group_id": "0fc8e0db-71c8-4380-9927-0ae805ee8b3a",
"product_id": "ad586330-d0e6-4a9b-bda2-9b268d530493"
},
"relationships": {
"bundle": {
"links": {
"related": "api/boomerang/bundles/da791739-c067-4845-9e80-9b3831bce432"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/0fc8e0db-71c8-4380-9927-0ae805ee8b3a"
}
},
"product": {
"links": {
"related": "api/boomerang/products/ad586330-d0e6-4a9b-bda2-9b268d530493"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/bundle_items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=bundle,product,product_group |
fields[] |
Array List of comma seperated fields to include ?fields[bundle_items]=created_at,updated_at,quantity |
Includes
This request accepts the following includes:
bundle
product =>
photo
product_group =>
photo
Updating a bundle item
How to update a bundle item:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/bundle_items/43d51e8a-2e55-4374-92eb-2b7bbd632bbc' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "43d51e8a-2e55-4374-92eb-2b7bbd632bbc",
"type": "bundle_items",
"attributes": {
"quantity": 3,
"discount_percentage": 20
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "43d51e8a-2e55-4374-92eb-2b7bbd632bbc",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:30:33+00:00",
"updated_at": "2024-04-29T09:30:33+00:00",
"quantity": 3,
"discount_percentage": 20.0,
"position": 1,
"bundle_id": "917feba1-55bb-443f-a594-a9968ccc341d",
"product_group_id": "ae014dad-c89d-4466-9663-4b3151569d75",
"product_id": "bbfb1abc-e6d1-417b-bb15-cb01884203be"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/bundle_items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=bundle,product,product_group |
fields[] |
Array List of comma seperated fields to include ?fields[bundle_items]=created_at,updated_at,quantity |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][quantity] |
Integer The quantity of the item |
data[attributes][discount_percentage] |
Float The discount percentage for this product when rented out in a bundle |
data[attributes][position] |
Integer Position of the product in bundle list |
data[attributes][bundle_id] |
Uuid The associated Bundle |
data[attributes][product_group_id] |
Uuid The associated Product group |
data[attributes][product_id] |
Uuid The associated Product |
Includes
This request accepts the following includes:
bundle
product =>
photo
product_group =>
photo
Bundles
Bundles allow for a single product to be made up of multiple other products. This makes it possible to track the status of multiple smaller products within a single larger product (the bundle).
Endpoints
POST api/boomerang/bundles/search
DELETE /api/boomerang/bundles/{id}
GET /api/boomerang/bundles/{id}
POST /api/boomerang/bundles
PUT /api/boomerang/bundles/{id}
GET /api/boomerang/bundles
Fields
Every bundle has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether item is archived |
archived_at |
Datetime nullable readonlyWhen the item was archived |
type |
String readonlyOne of product_groups, products, bundles |
name |
String Name of the item |
slug |
String readonlySlug of the item |
product_type |
String readonlyOne of rental, consumable, service |
extra_information |
String nullableExtra information about the item, shown on orders and documents |
photo_url |
String readonlyMain photo url |
remote_photo_url |
String writeonlyUrl to an image on the web |
photo_base64 |
String writeonlyBase64 encoded photo, use this field to store a main photo |
description |
String nullableDescription used in the online store |
show_in_store |
Boolean Whether to show this item in the online |
sorting_weight |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
discountable |
Boolean Whether discounts should be applied to items in this bundle |
taxable |
Boolean Whether item is taxable |
bundle_items_attributes |
Array writeonlyThe bundle items to associate |
seo_title |
String SEO title tag |
seo_description |
String SEO meta description tag |
tag_list |
Array List of tags |
photo_id |
Uuid The associated Photo |
tax_category_id |
Uuid The associated Tax category |
Relationships
Bundles have the following relationships:
| Name | Description |
|---|---|
photo |
Photos readonlyAssociated Photo |
tax_category |
Tax categories readonlyAssociated Tax category |
bundle_items |
Bundle items readonlyAssociated Bundle items |
inventory_levels |
Inventory levels readonlyAssociated Inventory levels |
Searching bundles
Use advanced search to make logical filter groups with and/or operators.
How to search for bundles:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/bundles/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"bundles": "id"
},
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"discountable": true
},
{
"taxable": true
}
]
},
{
"operator": "and",
"attributes": [
{
"show_in_store": true
},
{
"taxable": true
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "2d298a8d-9df5-48e1-90c4-bde23b90371e"
},
{
"id": "d5473ad0-af21-4a21-b6a7-a5d960b5be43"
},
{
"id": "153de47a-c8e3-4625-aa81-95e412ac2c01"
}
]
}
HTTP Request
POST api/boomerang/bundles/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,inventory_levels |
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
q |
String eq |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
show_in_store |
Array count |
tax_category_id |
Array count |
Includes
This request accepts the following includes:
photo
inventory_levels
Archiving a bundle
How to delete a bundle:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/bundles/0d5c7a9e-ed82-4660-ae88-2addac51ceff' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "0d5c7a9e-ed82-4660-ae88-2addac51ceff",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:26:04+00:00",
"updated_at": "2024-04-29T09:26:04+00:00",
"archived": true,
"archived_at": "2024-04-29T09:26:04+00:00",
"type": "bundles",
"name": "iPad Bundle",
"slug": "ipad-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"bundle_items": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/bundles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Fetching a bundle
How to fetch a bundle:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/bundles/d91efa6d-d0f6-40b7-8ad0-f394ca668182' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "d91efa6d-d0f6-40b7-8ad0-f394ca668182",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:26:04+00:00",
"updated_at": "2024-04-29T09:26:04+00:00",
"archived": false,
"archived_at": null,
"type": "bundles",
"name": "iPad Bundle",
"slug": "ipad-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"bundle_items": {
"links": {
"related": "api/boomerang/bundle_items?filter[bundle_id]=d91efa6d-d0f6-40b7-8ad0-f394ca668182"
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=d91efa6d-d0f6-40b7-8ad0-f394ca668182"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/bundles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,bundle_items,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
photo
bundle_items =>
product_group =>
photo
product =>
photo
tax_category
Creating a bundle
How to create a bundle with bundle items:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/bundles' \
--header 'content-type: application/json' \
--data '{
"include": "bundle_items",
"data": {
"type": "bundles",
"attributes": {
"name": "iPad Pro Bundle",
"bundle_items_attributes": [
{
"quantity": 2,
"discount_percentage": 10,
"product_group_id": "a8425cca-d353-4401-9331-d5e0db76f608",
"product_id": "26a4a5ad-9aaf-4803-b014-11e06c62ca63"
},
{
"quantity": 2,
"discount_percentage": 15,
"product_group_id": "a977cdcf-5c24-4998-8fe4-6f88abcf34ae",
"product_id": "1d1f34be-a84d-41b1-91ba-d4b8616d22c4"
}
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "4e318d7e-169c-446c-bd57-8189f94280d6",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:26:06+00:00",
"updated_at": "2024-04-29T09:26:06+00:00",
"archived": false,
"archived_at": null,
"type": "bundles",
"name": "iPad Pro Bundle",
"slug": "ipad-pro-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"bundle_items": {
"data": [
{
"type": "bundle_items",
"id": "25bc83c8-092a-4768-befd-e0b862902490"
},
{
"type": "bundle_items",
"id": "a68abf4d-aa17-4f29-97f3-50761e75a5cd"
},
{
"type": "bundle_items",
"id": "b95d80fb-f989-4163-8b1c-474a728f8e0c"
},
{
"type": "bundle_items",
"id": "429465af-19a4-4b6d-91c0-99e0d65dada7"
}
]
},
"inventory_levels": {
"meta": {
"included": false
}
}
}
},
"included": [
{
"id": "25bc83c8-092a-4768-befd-e0b862902490",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:06+00:00",
"updated_at": "2024-04-29T09:26:06+00:00",
"quantity": 2,
"discount_percentage": 10.0,
"position": 1,
"bundle_id": "4e318d7e-169c-446c-bd57-8189f94280d6",
"product_group_id": "a8425cca-d353-4401-9331-d5e0db76f608",
"product_id": "26a4a5ad-9aaf-4803-b014-11e06c62ca63"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
{
"id": "a68abf4d-aa17-4f29-97f3-50761e75a5cd",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:06+00:00",
"updated_at": "2024-04-29T09:26:06+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 2,
"bundle_id": "4e318d7e-169c-446c-bd57-8189f94280d6",
"product_group_id": "a977cdcf-5c24-4998-8fe4-6f88abcf34ae",
"product_id": "1d1f34be-a84d-41b1-91ba-d4b8616d22c4"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
{
"id": "b95d80fb-f989-4163-8b1c-474a728f8e0c",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:06+00:00",
"updated_at": "2024-04-29T09:26:06+00:00",
"quantity": 2,
"discount_percentage": 10.0,
"position": 3,
"bundle_id": "4e318d7e-169c-446c-bd57-8189f94280d6",
"product_group_id": "a8425cca-d353-4401-9331-d5e0db76f608",
"product_id": "26a4a5ad-9aaf-4803-b014-11e06c62ca63"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
{
"id": "429465af-19a4-4b6d-91c0-99e0d65dada7",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:06+00:00",
"updated_at": "2024-04-29T09:26:06+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 4,
"bundle_id": "4e318d7e-169c-446c-bd57-8189f94280d6",
"product_group_id": "a977cdcf-5c24-4998-8fe4-6f88abcf34ae",
"product_id": "1d1f34be-a84d-41b1-91ba-d4b8616d22c4"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/bundles
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,bundle_items,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the item |
data[attributes][extra_information] |
String Extra information about the item, shown on orders and documents |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][photo_base64] |
String Base64 encoded photo, use this field to store a main photo |
data[attributes][show_in_store] |
Boolean Whether to show this item in the online |
data[attributes][sorting_weight] |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
data[attributes][discountable] |
Boolean Whether discounts should be applied to items in this bundle |
data[attributes][taxable] |
Boolean Whether item is taxable |
data[attributes][bundle_items_attributes][] |
Array The bundle items to associate |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][tag_list][] |
Array List of tags |
data[attributes][photo_id] |
Uuid The associated Photo |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
Includes
This request accepts the following includes:
photo
bundle_items =>
product_group =>
photo
product =>
photo
tax_category
Updating a bundle
How to update a bundle with bundle items:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/bundles/b1065fa2-f526-44a3-a498-8047a40b1003' \
--header 'content-type: application/json' \
--data '{
"include": "bundle_items",
"data": {
"id": "b1065fa2-f526-44a3-a498-8047a40b1003",
"type": "bundles",
"attributes": {
"name": "iPad Pro Bundle",
"bundle_items_attributes": [
{
"id": "fc84cd29-07c9-4402-8f42-5846fc32ec91",
"_destroy": true
},
{
"quantity": 2,
"discount_percentage": 15,
"product_group_id": "7918d536-f6c1-47f6-931c-e19f7d58a3a8",
"product_id": "af9231d0-6445-4254-8560-a5c7f71ca5bf"
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b1065fa2-f526-44a3-a498-8047a40b1003",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:26:07+00:00",
"updated_at": "2024-04-29T09:26:08+00:00",
"archived": false,
"archived_at": null,
"type": "bundles",
"name": "iPad Pro Bundle",
"slug": "ipad-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"bundle_items": {
"data": [
{
"type": "bundle_items",
"id": "c1c7ab9e-629c-4aa9-8c10-bf918871978d"
},
{
"type": "bundle_items",
"id": "bc5a8195-f0e8-4ed6-ad3a-58f6d1ba9c6c"
}
]
},
"inventory_levels": {
"meta": {
"included": false
}
}
}
},
"included": [
{
"id": "c1c7ab9e-629c-4aa9-8c10-bf918871978d",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:08+00:00",
"updated_at": "2024-04-29T09:26:08+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 2,
"bundle_id": "b1065fa2-f526-44a3-a498-8047a40b1003",
"product_group_id": "7918d536-f6c1-47f6-931c-e19f7d58a3a8",
"product_id": "af9231d0-6445-4254-8560-a5c7f71ca5bf"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
},
{
"id": "bc5a8195-f0e8-4ed6-ad3a-58f6d1ba9c6c",
"type": "bundle_items",
"attributes": {
"created_at": "2024-04-29T09:26:08+00:00",
"updated_at": "2024-04-29T09:26:08+00:00",
"quantity": 2,
"discount_percentage": 15.0,
"position": 3,
"bundle_id": "b1065fa2-f526-44a3-a498-8047a40b1003",
"product_group_id": "7918d536-f6c1-47f6-931c-e19f7d58a3a8",
"product_id": "af9231d0-6445-4254-8560-a5c7f71ca5bf"
},
"relationships": {
"bundle": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"product": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/bundles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,bundle_items,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the item |
data[attributes][extra_information] |
String Extra information about the item, shown on orders and documents |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][photo_base64] |
String Base64 encoded photo, use this field to store a main photo |
data[attributes][show_in_store] |
Boolean Whether to show this item in the online |
data[attributes][sorting_weight] |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
data[attributes][discountable] |
Boolean Whether discounts should be applied to items in this bundle |
data[attributes][taxable] |
Boolean Whether item is taxable |
data[attributes][bundle_items_attributes][] |
Array The bundle items to associate |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][tag_list][] |
Array List of tags |
data[attributes][photo_id] |
Uuid The associated Photo |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
Includes
This request accepts the following includes:
photo
bundle_items =>
product_group =>
photo
product =>
photo
tax_category
Listing bundles
How to fetch a list of bundles:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/bundles' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "5c849499-cab4-4a30-aa38-d4affede6bec",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:26:08+00:00",
"updated_at": "2024-04-29T09:26:08+00:00",
"archived": false,
"archived_at": null,
"type": "bundles",
"name": "iPad Bundle",
"slug": "ipad-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"bundle_items": {
"links": {
"related": "api/boomerang/bundle_items?filter[bundle_id]=5c849499-cab4-4a30-aa38-d4affede6bec"
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=5c849499-cab4-4a30-aa38-d4affede6bec"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/bundles
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,inventory_levels |
fields[] |
Array List of comma seperated fields to include ?fields[bundles]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
q |
String eq |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
show_in_store |
Array count |
tax_category_id |
Array count |
Includes
This request accepts the following includes:
photo
inventory_levels
Clusters
A cluster is a group of locations that share their inventory (and availability). Stock can move between locations within the same cluster, meaning they can be picked up at one location and returned to another.
Endpoints
GET /api/boomerang/clusters
DELETE /api/boomerang/clusters/{id}
POST /api/boomerang/clusters
PUT /api/boomerang/clusters/{id}
GET /api/boomerang/clusters/{id}
Fields
Every cluster has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the cluster |
location_ids |
Array The locations that belong to this cluster |
Relationships
Clusters have the following relationships:
| Name | Description |
|---|---|
locations |
Locations readonlyAssociated Locations |
Listing clusters
How to fetch clusters:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/clusters' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "9e706c7a-a5b3-48c7-b55c-93a0068cadf5",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:26:12+00:00",
"updated_at": "2024-04-29T09:26:12+00:00",
"name": "Main",
"location_ids": []
},
"relationships": {
"locations": {
"links": {
"related": "api/boomerang/locations?filter[cluster_id]=9e706c7a-a5b3-48c7-b55c-93a0068cadf5"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/clusters
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=locations |
fields[] |
Array List of comma seperated fields to include ?fields[clusters]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
location_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
locations
Deleting a cluster
To delete a cluster make sure no active locations are associated with it anymore.
How to delete a cluster:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/clusters/ac76edb9-9c36-4403-8ddd-4bd78a5f836e' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "ac76edb9-9c36-4403-8ddd-4bd78a5f836e",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:26:14+00:00",
"updated_at": "2024-04-29T09:26:14+00:00",
"name": "Main",
"location_ids": []
},
"relationships": {
"locations": {
"links": {
"related": "api/boomerang/locations?filter[cluster_id]=ac76edb9-9c36-4403-8ddd-4bd78a5f836e"
}
}
}
},
"meta": {}
}
A failure due to a cluster still being associated with locations:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/clusters/b2cb6c7c-c7cb-4d3f-98e6-c8db2d22c8b1' \
--header 'content-type: application/json' \
A 422 status response looks like this:
{
"errors": [
{
"code": "cluster_has_locations",
"status": "422",
"title": "Cluster has locations",
"detail": "This cluster has 1 or more active locations",
"meta": {
"location_ids": [
"e5f65a46-a701-4941-84b4-969988770bce"
]
}
}
]
}
HTTP Request
DELETE /api/boomerang/clusters/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=locations |
fields[] |
Array List of comma seperated fields to include ?fields[clusters]=created_at,updated_at,name |
Includes
This request accepts the following includes:
locations
Creating a cluster
How to create a cluster:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/clusters' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "clusters",
"attributes": {
"name": "Amsterdam"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "5f36a2d1-63ba-4ad1-9367-28dcba3f9a2b",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:26:16+00:00",
"updated_at": "2024-04-29T09:26:16+00:00",
"name": "Amsterdam",
"location_ids": []
},
"relationships": {
"locations": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/clusters
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=locations |
fields[] |
Array List of comma seperated fields to include ?fields[clusters]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the cluster |
data[attributes][location_ids][] |
Array The locations that belong to this cluster |
Includes
This request accepts the following includes:
locations
Updating a cluster
How to update a cluster:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/clusters/cae1b8aa-4246-419f-bf46-29c1f2cc2343' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "cae1b8aa-4246-419f-bf46-29c1f2cc2343",
"type": "clusters",
"attributes": {
"name": "Rotterdam"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "cae1b8aa-4246-419f-bf46-29c1f2cc2343",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:26:17+00:00",
"updated_at": "2024-04-29T09:26:17+00:00",
"name": "Rotterdam",
"location_ids": []
},
"relationships": {
"locations": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/clusters/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=locations |
fields[] |
Array List of comma seperated fields to include ?fields[clusters]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the cluster |
data[attributes][location_ids][] |
Array The locations that belong to this cluster |
Includes
This request accepts the following includes:
locations
Fetching a cluster
How to fetch a single cluster:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/clusters/63a866e6-f916-4984-a4c9-2ad3055ccbc8' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "63a866e6-f916-4984-a4c9-2ad3055ccbc8",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:26:18+00:00",
"updated_at": "2024-04-29T09:26:18+00:00",
"name": "Main",
"location_ids": []
},
"relationships": {
"locations": {
"links": {
"related": "api/boomerang/locations?filter[cluster_id]=63a866e6-f916-4984-a4c9-2ad3055ccbc8"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/clusters/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=locations |
fields[] |
Array List of comma seperated fields to include ?fields[clusters]=created_at,updated_at,name |
Includes
This request accepts the following includes:
locations
Companies
Every action performed in a Booqable account is scoped to a company; A company holds information and configuration about an account.
Endpoints
PUT /api/boomerang/companies/current
GET /api/boomerang/companies/current
Fields
Every company has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the company |
slug |
String readonlyCompany's slug, used in urls |
email |
String Used in customer communication, on documents and as the reply-to address for emails that are being sent |
billing_email |
String Used to send billing emails to |
phone |
String Phone number |
website |
String Website |
address_line_1 |
String First address line |
address_line_2 |
String Second address line |
zipcode |
String Zipcode |
city |
String City |
region |
String Region |
country |
String Country |
market |
String The market the company operates in |
use_billing_address |
Boolean Whether to use billing address on invoices received from Booqable |
billing_company |
String Company name (used for invoices received from Booqable) |
billing_address_line_1 |
String First address line (used for invoices received from Booqable) |
billing_address_line_2 |
String Second address line (used for invoices received from Booqable) |
billing_address_zipcode |
String Zipcode (used for invoices received from Booqable) |
billing_address_city |
String City (used for invoices received from Booqable) |
billing_address_region |
String Region (used for invoices received from Booqable) |
billing_address_country |
String Country (used for invoices received from Booqable) |
logo_url |
String readonlyUrl of the uploaded logo |
logo_base64 |
String writeonlyTo update a logo send it as base64 encoded string |
remove_logo |
Boolean writeonlyRemove current logo |
favicon_url |
String readonlyCompany favicon url |
favicon_base64 |
String writeonlyTo upload a favicon send it as a base64 encoded string |
remove_favicon |
Boolean writeonlyRemove current favicon |
default_timezone |
String Company's default timezone |
currency |
String Currency of the company |
financial_line_1 |
String First extra financial information line (line bank account) used in customer communication, on documents and as the reply-to address for emails that are being sent |
financial_line_2 |
String Second extra financial information line (line bank account) used in customer communication, on documents and as the reply-to address for emails that are being sent |
vat_number |
String Company's vat number, used in customer communication and to define tax exempts |
custom_domain |
String Custom domain to use for hosted store and checkout |
development |
Boolean readonlyWhether this is a development account |
shop_theme_id |
Uuid ID of installed shop theme |
installed_online_store |
Boolean readonlyIf the online store is installed, this boolean will return true |
years_active |
String readonlyThe amount of active years, given during signup |
source |
String readonlyUTM source present during signup |
medium |
String readonlyUTM medium present during signup |
tenant_token |
String readonlyToken |
pending_subscription |
Boolean readonlyWhether the company has a pending subscription |
address |
String readonlyThe full address |
main_address_attributes |
Hash writeonlyA hash with the company main address fields. Use it when updating the company main address. See address property type for more information |
main_address |
Hash readonlyA hash with the company main address fields. Use it when fetching the company. See address property type for more information |
billing_address_attributes |
Hash writeonlyA hash with the company billing address fields. Use it when updating the company billing address. See address property type for more information |
billing_address |
Hash readonlyA hash with the company billing address fields. Use it when fetching the company. See address property type for more information |
in_europe |
Boolean readonlyWhether company is situated in europe |
continent |
String readonlyContinent the company is situated |
subscription |
Hash readonlyDetails about the subscription |
third_party_id |
String readonlyID used for third party tools |
Updating a company
How to update a company:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/companies/current' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "fcb94f98-fc8b-4fa5-8348-c78f2e817e67",
"type": "companies",
"attributes": {
"name": "iRent LLC"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "fcb94f98-fc8b-4fa5-8348-c78f2e817e67",
"type": "companies",
"attributes": {
"created_at": "2024-04-29T09:31:17+00:00",
"updated_at": "2024-04-29T09:31:17+00:00",
"name": "iRent LLC",
"slug": "irent",
"email": "[email protected]",
"billing_email": null,
"phone": "0581234567",
"website": "www.booqable.com",
"address_line_1": "Blokhuispoort",
"address_line_2": "Leeuwarden",
"zipcode": "8900AB",
"city": "Leeuwarden",
"region": null,
"country": "the Netherlands",
"market": "AV / Camera",
"use_billing_address": false,
"billing_company": null,
"billing_address_line_1": null,
"billing_address_line_2": null,
"billing_address_zipcode": null,
"billing_address_city": null,
"billing_address_region": null,
"billing_address_country": null,
"logo_url": null,
"favicon_url": null,
"default_timezone": "UTC",
"currency": "usd",
"financial_line_1": "Blokhuispoort",
"financial_line_2": "Leeuwarden",
"vat_number": null,
"custom_domain": null,
"development": false,
"shop_theme_id": null,
"installed_online_store": false,
"years_active": null,
"source": null,
"medium": null,
"tenant_token": "33cb495457a70b10b6a824b1f31ff86e",
"pending_subscription": false,
"address": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands",
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuispoort",
"address2": "Leeuwarden",
"city": "Leeuwarden",
"region": null,
"zipcode": "8900AB",
"country": "the Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands"
},
"billing_address": null
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/companies/current
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[companies]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the company |
data[attributes][email] |
String Used in customer communication, on documents and as the reply-to address for emails that are being sent |
data[attributes][billing_email] |
String Used to send billing emails to |
data[attributes][phone] |
String Phone number |
data[attributes][website] |
String Website |
data[attributes][address_line_1] |
String First address line |
data[attributes][address_line_2] |
String Second address line |
data[attributes][zipcode] |
String Zipcode |
data[attributes][city] |
String City |
data[attributes][region] |
String Region |
data[attributes][country] |
String Country |
data[attributes][market] |
String The market the company operates in |
data[attributes][use_billing_address] |
Boolean Whether to use billing address on invoices received from Booqable |
data[attributes][billing_company] |
String Company name (used for invoices received from Booqable) |
data[attributes][billing_address_line_1] |
String First address line (used for invoices received from Booqable) |
data[attributes][billing_address_line_2] |
String Second address line (used for invoices received from Booqable) |
data[attributes][billing_address_zipcode] |
String Zipcode (used for invoices received from Booqable) |
data[attributes][billing_address_city] |
String City (used for invoices received from Booqable) |
data[attributes][billing_address_region] |
String Region (used for invoices received from Booqable) |
data[attributes][billing_address_country] |
String Country (used for invoices received from Booqable) |
data[attributes][logo_base64] |
String To update a logo send it as base64 encoded string |
data[attributes][remove_logo] |
Boolean Remove current logo |
data[attributes][favicon_base64] |
String To upload a favicon send it as a base64 encoded string |
data[attributes][remove_favicon] |
Boolean Remove current favicon |
data[attributes][default_timezone] |
String Company's default timezone |
data[attributes][currency] |
String Currency of the company |
data[attributes][financial_line_1] |
String First extra financial information line (line bank account) used in customer communication, on documents and as the reply-to address for emails that are being sent |
data[attributes][financial_line_2] |
String Second extra financial information line (line bank account) used in customer communication, on documents and as the reply-to address for emails that are being sent |
data[attributes][vat_number] |
String Company's vat number, used in customer communication and to define tax exempts |
data[attributes][custom_domain] |
String Custom domain to use for hosted store and checkout |
data[attributes][shop_theme_id] |
Uuid ID of installed shop theme |
data[attributes][main_address_attributes] |
Hash A hash with the company main address fields. Use it when updating the company main address. See address property type for more information |
data[attributes][billing_address_attributes] |
Hash A hash with the company billing address fields. Use it when updating the company billing address. See address property type for more information |
Includes
This request does not accept any includes
Fetching subscription details
The subscription has the following fields:
| Name | Description |
|---|---|
trial_ends_at |
Datetime readonlyWhen the trial ends |
activated |
Boolean readonlyWhether subscription is active |
suspended |
Boolean readonlyWhether account is suspended |
canceled |
Boolean readonlyWhether subscription is canceled |
canceled_at |
Datetime readonlyWhen the subscription is canceled (can also be in the future) |
on_hold |
Boolean readonlyWhether account is on-hold |
needs_activation |
Boolean readonlyWhether account needs to activate a subscription |
legacy |
Datetime readonlyWhether it's a legacy subscription |
product |
String readonlyWhich product is active, one of Essential, Pro, Premium, Legacy |
plan_id |
String readonlyID of the product (used internally by Booqable) |
interval |
String readonlyBilling interval, one of month, year |
current_period_end |
Datetime readonlyWhen the current billing period ends |
quantity |
Integer readonlyQuantity of the subscription (used for legacy subscriptions to buy seats) |
extra_employees |
Integer readonlyExtra employees billed for |
extra_locations |
Integer readonlyExtra locations billed for |
amount_in_cents |
Integer readonlyAmount in cents |
discount_in_cents |
Integer readonlyDiscount in cents |
balance_in_cents |
Integer readonlyBalance in cents, will be deducted from the next invoice(s) |
coupon |
String readonlyCoupon that's currently active |
coupon_percent_off |
String* readonly Percentage of discount on the current active coupon |
coupon_duration |
String* readonly Duration type of the current active coupon, one of forever, once, repeating |
coupon_duration_in_months |
String* readonly Amount of months the coupon is active. Only present when coupon duration is repeating. |
strategy |
String readonlyBilling strategy, one of send_invoice, charge_automatically |
source |
Hash readonlyInformation about the payment source |
enabled_features |
Hash readonlyBeta features that are currently enabled |
allowed_features |
Hash readonlyList of allowed features for plan |
restrictions |
Hash readonlyRestrictions applied to this account |
How to fetch details about the company its subscription:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/companies/current?extra_fields%5Bcompanies%5D=subscription&fields%5Bcompanies%5D=subscription' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "c60fe46c-731d-4b75-88d5-d5eb150e1fae",
"type": "companies",
"attributes": {
"subscription": {
"trial_ends_at": "2024-05-13T09:31:17.936Z",
"activated": false,
"active_subscription": false,
"suspended": false,
"canceled": false,
"canceled_at": null,
"on_hold": false,
"needs_activation": false,
"product": "Premium",
"plan_id": "premium_monthly",
"interval": "month",
"current_period_end": null,
"extra_employees": 0,
"extra_locations": 0,
"amount_in_cents": 29900,
"discount_in_cents": 0,
"balance_in_cents": 0,
"coupon": null,
"coupon_percent_off": null,
"coupon_duration": null,
"coupon_duration_in_months": null,
"strategy": "charge_automatically",
"source": null,
"enabled_features": [],
"allowed_features": [
"bundles",
"multiple_locations",
"advanced_pricing",
"api",
"custom_fields",
"overbookings",
"categories",
"customer_auth",
"custom_domain",
"barcodes",
"reports",
"permissions",
"exports",
"coupons",
"shop_tracking",
"sso",
"iprestrictions",
"2fa_enforcing",
"remove_powered_by"
],
"restrictions": {
"employees": 15,
"email_max_recipients": 1000,
"rate_limit_max": 250,
"rate_limit_period": 60,
"locations": 3
},
"can_try_plan": true
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/companies/current
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[companies]=created_at,updated_at,name |
Includes
This request does not accept any includes
Fetching a company
How to fetch a companies:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/companies/current' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "18adfe0a-00ff-4506-b2a5-399e46a63304",
"type": "companies",
"attributes": {
"created_at": "2024-04-29T09:31:18+00:00",
"updated_at": "2024-04-29T09:31:18+00:00",
"name": "iRent",
"slug": "irent",
"email": "[email protected]",
"billing_email": null,
"phone": "0581234567",
"website": "www.booqable.com",
"address_line_1": "Blokhuispoort",
"address_line_2": "Leeuwarden",
"zipcode": "8900AB",
"city": "Leeuwarden",
"region": null,
"country": "the Netherlands",
"market": "AV / Camera",
"use_billing_address": false,
"billing_company": null,
"billing_address_line_1": null,
"billing_address_line_2": null,
"billing_address_zipcode": null,
"billing_address_city": null,
"billing_address_region": null,
"billing_address_country": null,
"logo_url": null,
"favicon_url": null,
"default_timezone": "UTC",
"currency": "usd",
"financial_line_1": "Blokhuispoort",
"financial_line_2": "Leeuwarden",
"vat_number": null,
"custom_domain": null,
"development": false,
"shop_theme_id": null,
"installed_online_store": false,
"years_active": null,
"source": null,
"medium": null,
"tenant_token": "30d3084d3b55b4d523513cd90a99595b",
"pending_subscription": false,
"address": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands",
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuispoort",
"address2": "Leeuwarden",
"city": "Leeuwarden",
"region": null,
"zipcode": "8900AB",
"country": "the Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands"
},
"billing_address": null
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/companies/current
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[companies]=created_at,updated_at,name |
Includes
This request does not accept any includes
Countries
The Country resource describes countries, including the information required to validate the format of addresses.
Fields
Every country has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String readonlyName of the country |
alpha2 |
String readonlyISO 3166-1 alpha-2 code |
province_required |
Boolean readonlyWhether a province is required for addresses in this country |
province_type |
String readonlyThe province type of this country. One of county, emirate, governorate, prefecture, province, region, state, state_and_territory |
form_layout |
String readonlyThe layout of the address form |
show_layout |
String readonlyThe layout of the address when shown |
zipcode_required |
Boolean readonlyWhether a zipcode is required for addresses in this country |
zipcode_autofill |
String readonlyThe value to use for the zipcode when autofilling |
zipcode_format |
String readonlyThe format of the zipcode, as a regular expression |
zipcode_placeholder |
String readonlyThe placeholder to use for the zipcode |
zipcode_type |
String readonlyThe zipcode type of this country. One of eircode, pincode, postal_code, postal_index, postcode, zipcode |
city_autofill |
String readonlyThe value to use for the city when autofilling |
Listing countries
How to fetch a list of countries:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/countries' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "c3493acc-2290-413f-8e8b-0c668a9d4ff6",
"type": "countries",
"attributes": {
"created_at": "2024-04-29T09:23:08+00:00",
"updated_at": "2024-04-29T09:23:08+00:00",
"name": "Netherlands",
"alpha2": "NL",
"province_required": false,
"province_type": "province",
"form_layout": "{country}\n{first_name}{last_name}\n{address1}\n{address2}\n{zipcode}{city}",
"show_layout": "{first_name} {last_name}\n{address1}\n{address2}\n{zipcode} {city}\n{country}",
"zipcode_required": true,
"zipcode_autofill": null,
"zipcode_format": "\\d{4} ?[A-Z]{2}",
"zipcode_placeholder": "1234 AB",
"zipcode_type": "postcode",
"city_autofill": null
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/countries
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[countries]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
alpha2 |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Coupons
Create codes to discount orders by a fixed amount or a percentage. Customers can redeem the codes online at checkout. Coupons can also be added to orders.
Endpoints
PUT /api/boomerang/coupons/{id}
GET /api/boomerang/coupons
DELETE /api/boomerang/coupons/{id}
GET /api/boomerang/coupons/{id}
POST /api/boomerang/coupons
Fields
Every coupon has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether coupon is archived |
archived_at |
Datetime nullable readonlyWhen the coupon was archived |
identifier |
String The code that customers need to type in |
coupon_type |
String One of percentage, cents |
value |
Integer A percentage for type percentage or a value in cents for cents |
active |
Boolean Whether coupon can be redeemed at the moment |
Updating a coupon
When updating a coupon the existing one is archived and a new one gets created:
How to update a coupon:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/coupons/c32a518e-e7a8-4236-bae2-ed872f143db1' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "c32a518e-e7a8-4236-bae2-ed872f143db1",
"type": "coupons",
"attributes": {
"identifier": "SUMMER30OFF",
"coupon_type": "percentage",
"value": 30
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "1110715e-e322-43cf-aede-9fd1799ad55d",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:20+00:00",
"updated_at": "2024-04-29T09:30:20+00:00",
"archived": false,
"archived_at": null,
"identifier": "SUMMER30OFF",
"coupon_type": "percentage",
"value": 30,
"active": false
}
},
"meta": {}
}
How to deativate a coupon:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/coupons/fd9afc90-669b-43e7-813d-cc9e8dd1221e' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "fd9afc90-669b-43e7-813d-cc9e8dd1221e",
"type": "coupons",
"attributes": {
"active": false
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "f8b5750b-e373-4413-8b6c-d214b5295bd2",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:22+00:00",
"updated_at": "2024-04-29T09:30:22+00:00",
"archived": false,
"archived_at": null,
"identifier": "SUMMER20OFF",
"coupon_type": "percentage",
"value": 20,
"active": false
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/coupons/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[coupons]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][identifier] |
String The code that customers need to type in |
data[attributes][coupon_type] |
String One of percentage, cents |
data[attributes][value] |
Integer A percentage for type percentage or a value in cents for cents |
data[attributes][active] |
Boolean Whether coupon can be redeemed at the moment |
Includes
This request does not accept any includes
Listing coupons
How to fetch a list of coupons:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/coupons' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "7769010f-6093-41ab-812d-970dace7e79c",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:23+00:00",
"updated_at": "2024-04-29T09:30:23+00:00",
"archived": false,
"archived_at": null,
"identifier": "SUMMER20OFF",
"coupon_type": "percentage",
"value": 20,
"active": true
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/coupons
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[coupons]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
identifier |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
coupon_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
value |
Integer eq, not_eq, gt, gte, lt, lte |
active |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Archiving a coupon
How to archive a coupon:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/coupons/bc90a731-ae70-4f49-bfec-e939059ae690' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "bc90a731-ae70-4f49-bfec-e939059ae690",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:25+00:00",
"updated_at": "2024-04-29T09:30:25+00:00",
"archived": true,
"archived_at": "2024-04-29T09:30:25+00:00",
"identifier": "SUMMER20OFF",
"coupon_type": "percentage",
"value": 20,
"active": true
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/coupons/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[coupons]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Fetching a coupon
How to fetch a coupon:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/coupons/f1efac98-17a1-43f1-97ee-012183cc9fd8' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "f1efac98-17a1-43f1-97ee-012183cc9fd8",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:25+00:00",
"updated_at": "2024-04-29T09:30:25+00:00",
"archived": false,
"archived_at": null,
"identifier": "SUMMER20OFF",
"coupon_type": "percentage",
"value": 20,
"active": true
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/coupons/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[coupons]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Creating a coupon
How to create a coupon:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/coupons' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "coupons",
"attributes": {
"identifier": "WINTERDISCOUNT",
"coupon_type": "cents",
"value": 2000,
"active": true
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "cf7c588b-09af-48e4-9073-00c102b17985",
"type": "coupons",
"attributes": {
"created_at": "2024-04-29T09:30:27+00:00",
"updated_at": "2024-04-29T09:30:27+00:00",
"archived": false,
"archived_at": null,
"identifier": "WINTERDISCOUNT",
"coupon_type": "cents",
"value": 2000,
"active": true
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/coupons
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[coupons]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][identifier] |
String The code that customers need to type in |
data[attributes][coupon_type] |
String One of percentage, cents |
data[attributes][value] |
Integer A percentage for type percentage or a value in cents for cents |
data[attributes][active] |
Boolean Whether coupon can be redeemed at the moment |
Includes
This request does not accept any includes
Customers
Customers are an essential part of your business. You can manage settings and custom data. Stored customer information like addresses, customer tax profiles, discounts, and customized security deposits are applied to associated orders when created or when assigned a new customer.
Endpoints
GET /api/boomerang/customers/{id}
DELETE /api/boomerang/customers/{id}
PUT /api/boomerang/customers/{id}
GET /api/boomerang/customers
POST api/boomerang/customers/search
POST /api/boomerang/customers
Fields
Every customer has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether customer is archived |
archived_at |
Datetime nullable readonlyWhen the customer was archived |
number |
Integer readonlyThe assigned number |
name |
String Person or Company name |
email |
String nullableE-mail address used for communication |
deposit_type |
String One of default, none, percentage_total, percentage, fixed |
deposit_value |
Float The value to use for deposit_type |
discount_percentage |
Float Default discount applied to each new order for this customer |
legal_type |
String Either person or commercial |
properties |
Hash readonlyA hash containing all basic property values (include properties if you need more detailed information about properties) |
properties_attributes |
Array writeonlyCreate or update multiple properties associated with this customer |
tag_list |
Array Case insensitive tag list |
merge_suggestion_customer_id |
Uuid The associated Merge suggestion customer |
tax_region_id |
Uuid nullableThe associated Tax region |
Relationships
Customers have the following relationships:
| Name | Description |
|---|---|
merge_suggestion_customer |
Customers readonlyAssociated Merge suggestion customer |
tax_region |
Tax regions readonlyAssociated Tax region |
properties |
Properties readonlyAssociated Properties |
barcode |
Barcodes Associated Barcode |
notes |
Notes readonlyAssociated Notes |
Fetching a customer
How to fetch a customers:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/customers/92ea44f5-0e57-43da-b796-8881c1ed4d6b?include=barcode%2Cproperties' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "92ea44f5-0e57-43da-b796-8881c1ed4d6b",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:28:24+00:00",
"updated_at": "2024-04-29T09:28:24+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=92ea44f5-0e57-43da-b796-8881c1ed4d6b&filter[owner_type]=customers"
},
"data": []
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=92ea44f5-0e57-43da-b796-8881c1ed4d6b&filter[owner_type]=customers"
},
"data": null
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=92ea44f5-0e57-43da-b796-8881c1ed4d6b&filter[owner_type]=customers"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/customers/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,properties,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
barcode
properties
tax_region
Archiving a customer
How to archive a customer:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/customers/cefc7d8d-a488-4393-8abc-88afa64b0b6e' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "cefc7d8d-a488-4393-8abc-88afa64b0b6e",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:28:25+00:00",
"updated_at": "2024-04-29T09:28:25+00:00",
"archived": true,
"archived_at": "2024-04-29T09:28:25+00:00",
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=cefc7d8d-a488-4393-8abc-88afa64b0b6e&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=cefc7d8d-a488-4393-8abc-88afa64b0b6e&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=cefc7d8d-a488-4393-8abc-88afa64b0b6e&filter[owner_type]=customers"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/customers/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Updating a customer
How to update a customer:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/customers/5e132e20-77f4-414f-8861-add03156bbb9' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "5e132e20-77f4-414f-8861-add03156bbb9",
"type": "customers",
"attributes": {
"name": "Jane Doe"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "5e132e20-77f4-414f-8861-add03156bbb9",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:28:27+00:00",
"updated_at": "2024-04-29T09:28:27+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "Jane Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/customers/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,properties,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Person or Company name |
data[attributes][email] |
String E-mail address used for communication |
data[attributes][deposit_type] |
String One of default, none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][discount_percentage] |
Float Default discount applied to each new order for this customer |
data[attributes][legal_type] |
String Either person or commercial |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this customer |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][merge_suggestion_customer_id] |
Uuid The associated Merge suggestion customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
Includes
This request accepts the following includes:
barcode
properties
tax_region
Listing customers
How to fetch a list of customers:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "b19bd84b-8a97-438c-a653-14721be60d99",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:28:29+00:00",
"updated_at": "2024-04-29T09:28:29+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=b19bd84b-8a97-438c-a653-14721be60d99&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=b19bd84b-8a97-438c-a653-14721be60d99&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=b19bd84b-8a97-438c-a653-14721be60d99&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/customers
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,properties,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
number |
Integer eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
email |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_value |
Float eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
legal_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
merge_suggestion_customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
q |
String eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
legal_type |
Array count |
tag_list |
Array count |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
barcode
properties
tax_region
Searching customers
Use advanced search to make logical filter groups with and/or operators.
How to search for customers:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/customers/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"customers": "id"
},
"filter": {
"conditions": {
"operator": "and",
"attributes": [
{
"operator": "or",
"attributes": [
{
"name": "john"
},
{
"name": "jane"
}
]
},
{
"operator": "and",
"attributes": [
{
"discount_percentage": {
"gte": 50
}
},
{
"deposit_type": "none"
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "1779cc06-4ee0-48b5-8de6-c8320fe95f19"
},
{
"id": "a9b21dd0-d7fa-45ef-a0a0-ca4784b2b90d"
}
]
}
HTTP Request
POST api/boomerang/customers/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,properties,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
number |
Integer eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
email |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_value |
Float eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
legal_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
merge_suggestion_customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
q |
String eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
legal_type |
Array count |
tag_list |
Array count |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
barcode
properties
tax_region
Creating a customer
How to create a customer:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "customers",
"attributes": {
"name": "John Doe",
"email": "[email protected]"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "958bf4bc-92c6-4e80-a25b-53298fa3cd97",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:28:33+00:00",
"updated_at": "2024-04-29T09:28:33+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/customers
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,properties,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[customers]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Person or Company name |
data[attributes][email] |
String E-mail address used for communication |
data[attributes][deposit_type] |
String One of default, none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][discount_percentage] |
Float Default discount applied to each new order for this customer |
data[attributes][legal_type] |
String Either person or commercial |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this customer |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][merge_suggestion_customer_id] |
Uuid The associated Merge suggestion customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
Includes
This request accepts the following includes:
barcode
properties
tax_region
Default properties
Booqable comes with standard fields but you can also add custom properties to capture additional data. Default properties show up in forms within Booqable and can be connected to checkout fields. Default properties are searchable, show up in exports and can be used in email templates. The actual values of those properties are stored in the Property resource.
Properties inherit their fields from a default property when they are connected. When creating properties, they are mapped with their default when one of the following fields correspond:
nameidentifierdefault_property_id
Endpoints
DELETE /api/boomerang/default_properties/{id}
GET /api/boomerang/default_properties
PUT /api/boomerang/default_properties/{id}
POST /api/boomerang/default_properties
GET /api/boomerang/default_properties/{id}
Fields
Every default property has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the property (used as label and to compute identifier if left blank) |
identifier |
String Key that will be used in exports, responses and custom field variables in templates |
position |
Integer Which position the property has |
property_type |
String One of address, date_field, email, phone, select, text_area, text_field |
show_on |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
validation_required |
Boolean Whether this property has to be validated |
owner_type |
String The resource type of the owner. One of orders, product_groups, customers, users |
select_options |
Array For type select. The select options as array. |
editable |
Boolean readonlyWhether this property is editable |
Deleting a default property
How to delete a default property:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/default_properties/4768638d-844d-465a-8435-30fecbca4463' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "4768638d-844d-465a-8435-30fecbca4463",
"type": "default_properties",
"attributes": {
"created_at": "2024-04-29T09:30:47+00:00",
"updated_at": "2024-04-29T09:30:47+00:00",
"name": "Phone",
"identifier": "phone",
"position": 1,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"owner_type": "customers",
"select_options": [],
"editable": true
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/default_properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[default_properties]=created_at,updated_at,name |
Includes
This request does not accept any includes
Listing default properties
How to fetch a list of default properties:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/default_properties?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "abd3f56b-6bc6-4a17-8cd2-780899efafa9",
"type": "default_properties",
"attributes": {
"created_at": "2024-04-29T09:30:48+00:00",
"updated_at": "2024-04-29T09:30:48+00:00",
"name": "Phone",
"identifier": "phone",
"position": 1,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"owner_type": "customers",
"select_options": [],
"editable": true
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/default_properties
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[default_properties]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
identifier |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
validation_required |
Boolean eq |
owner_type |
String eq, not_eq |
editable |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Updating a default property
How to update a default property:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/default_properties/b231253b-a308-4470-bdf8-080c8c26936e' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "b231253b-a308-4470-bdf8-080c8c26936e",
"type": "default_properties",
"attributes": {
"property_type": "text_field"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b231253b-a308-4470-bdf8-080c8c26936e",
"type": "default_properties",
"attributes": {
"created_at": "2024-04-29T09:30:49+00:00",
"updated_at": "2024-04-29T09:30:49+00:00",
"name": "Phone",
"identifier": "phone",
"position": 1,
"property_type": "text_field",
"show_on": [],
"validation_required": false,
"owner_type": "customers",
"select_options": [],
"editable": true
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/default_properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[default_properties]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the property (used as label and to compute identifier if left blank) |
data[attributes][identifier] |
String Key that will be used in exports, responses and custom field variables in templates |
data[attributes][position] |
Integer Which position the property has |
data[attributes][property_type] |
String One of address, date_field, email, phone, select, text_area, text_field |
data[attributes][show_on][] |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
data[attributes][validation_required] |
Boolean Whether this property has to be validated |
data[attributes][owner_type] |
String The resource type of the owner. One of orders, product_groups, customers, users |
data[attributes][select_options][] |
Array For type select. The select options as array. |
Includes
This request does not accept any includes
Creating a default property
How to create a default property and assign it to an owner:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/default_properties' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "default_properties",
"attributes": {
"name": "Mobile phone",
"property_type": "phone",
"owner_type": "customers"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "6435331d-8cf8-4c02-b874-95b972876ba3",
"type": "default_properties",
"attributes": {
"created_at": "2024-04-29T09:30:50+00:00",
"updated_at": "2024-04-29T09:30:50+00:00",
"name": "Mobile phone",
"identifier": "mobile_phone",
"position": 2,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"owner_type": "customers",
"select_options": [],
"editable": true
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/default_properties
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[default_properties]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the property (used as label and to compute identifier if left blank) |
data[attributes][identifier] |
String Key that will be used in exports, responses and custom field variables in templates |
data[attributes][position] |
Integer Which position the property has |
data[attributes][property_type] |
String One of address, date_field, email, phone, select, text_area, text_field |
data[attributes][show_on][] |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
data[attributes][validation_required] |
Boolean Whether this property has to be validated |
data[attributes][owner_type] |
String The resource type of the owner. One of orders, product_groups, customers, users |
data[attributes][select_options][] |
Array For type select. The select options as array. |
Includes
This request does not accept any includes
Fetching a default property
How to fetch a default properties:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/default_properties/d5377e72-3a5d-4dbf-97ef-cbdb7555545a?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "d5377e72-3a5d-4dbf-97ef-cbdb7555545a",
"type": "default_properties",
"attributes": {
"created_at": "2024-04-29T09:30:51+00:00",
"updated_at": "2024-04-29T09:30:51+00:00",
"name": "Phone",
"identifier": "phone",
"position": 1,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"owner_type": "customers",
"select_options": [],
"editable": true
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/default_properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[default_properties]=created_at,updated_at,name |
Includes
This request does not accept any includes
Documents
Documents hold financial and or legal information about an order. There are three types of documents: quote, contract, invoice.
When creating quotes and contracts, the following data is copied from the current state of the order:
- Customer information (when present)
- Pricing and deposit
- Lines
Quotes and contracts are always finalized; to make a revision, archive the document, make changes to the order, and create a new one.
Invoices are automatically generated and updated based on changes made to an order. When an invoice is finalized, and further changes are made to the order, a new invoice is created with prorated changes. The payment status of the invoice is automatically updated when payments are made for the associated order.
Endpoints
GET /api/boomerang/documents
PUT /api/boomerang/documents/{id}
POST /api/boomerang/documents
DELETE /api/boomerang/documents/{id}
GET /api/boomerang/documents/{id}
POST api/boomerang/documents/search
Fields
Every document has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether document is archived |
archived_at |
Datetime nullable readonlyWhen the document was archived |
document_type |
String One of invoice, contract, quote |
number |
Integer The document number, must be unique per type. Automatically generated if left blank. |
prefix |
String Add a prefix to document numbers to make it easier to identify different documents. You can add dynamic values (like a year or order number) and custom prefixes e.g. {year}-{customer_number}. |
prefix_with_number |
String readonlyRendered prefix with document number |
date |
Date Date the document was finalized |
due_date |
Date The latest date by which the invoice must be fully paid |
name |
String Customer name. If left blank, automatically populated with the customer name of the associated order |
address |
String Customer Address. If left blank, automatically populated with the customer address of the associated order |
reference |
String A project number or other reference |
revised |
Boolean Whether document is revised (applies only to invoice) |
finalized |
Boolean Whether document is finalized ( quote and contract are always finalized) |
sent |
Boolean Whether document is sent (with Booqable) |
confirmed |
Boolean Whether document is confirmed, applies to quote and contract |
status |
String One of confirmed, unconfirmed, revised, partially_paid, payment_due, paid, process_deposit, overpaid |
signature_url |
String readonlyUrl where the signature is stored |
deposit_type |
String nullableOne of none, percentage_total, percentage, fixed |
deposit_value |
Float The value to use for deposit_type |
tag_list |
Array Case insensitive tag list |
price_in_cents |
Integer readonlySubtotal excl. taxes (excl. deposit) |
grand_total_in_cents |
Integer readonlyTotal excl. taxes (excl. deposit) |
grand_total_with_tax_in_cents |
Integer readonlyAmount incl. taxes (excl. deposit) |
discount_in_cents |
Integer readonlyDiscount (incl. or excl. taxes based on tax_strategy |
coupon_discount_in_cents |
Integer readonlyCoupon discount (incl. or excl. taxes based on tax_strategy |
total_discount_in_cents |
Integer readonlyTotal discount (incl. or excl. taxes based on tax_strategy |
deposit_in_cents |
Integer readonlyDeposit |
deposit_paid_in_cents |
Integer readonlyHow much of the deposit is paid |
deposit_refunded_in_cents |
Integer readonlyHow much of the deposit is refunded |
deposit_held_in_cents |
Integer readonlyAmount of deposit held |
deposit_to_refund_in_cents |
Integer readonlyAmount of deposit (still) to be refunded |
to_be_paid_in_cents |
Integer readonlyAmount that (still) has to be paid |
paid_in_cents |
Integer readonlyHow much was paid |
tax_in_cents |
Integer readonlyTotal tax |
discount_percentage |
Float The discount percentage applied to this order |
order_id |
Uuid The associated Order |
customer_id |
Uuid nullableThe associated Customer |
tax_region_id |
Uuid nullableThe associated Tax region |
coupon_id |
Uuid nullableThe associated Coupon |
body |
String readonlyCustom content displayed on a document, agreement details on a contract, for instance. Applicable to quote and contract. Populated with setting {document_type}.body, but can also be overridden for a specific document |
footer |
String readonlyThe footer of a document. Populated with setting {document_type}.footer, but can also be overridden for a specific document |
Relationships
Documents have the following relationships:
| Name | Description |
|---|---|
order |
Orders Associated Order |
customer |
Customers Associated Customer |
tax_region |
Tax regions Associated Tax region |
coupon |
Coupons Associated Coupon |
lines |
Lines readonlyAssociated Lines |
tax_values |
Tax values readonlyAssociated Tax values |
Listing documents
How to fetch a list of documents:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/documents' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "22bbd0d2-edce-42f0-9315-13c06519aa5b",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:23:18+00:00",
"updated_at": "2024-04-29T09:23:18+00:00",
"archived": false,
"archived_at": null,
"document_type": "invoice",
"number": null,
"prefix": null,
"prefix_with_number": null,
"date": null,
"due_date": null,
"name": "John Doe",
"address": null,
"reference": null,
"revised": false,
"finalized": false,
"sent": false,
"confirmed": false,
"status": "payment_due",
"signature_url": null,
"deposit_type": "percentage",
"deposit_value": 10.0,
"tag_list": [],
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"tax_in_cents": 15167,
"discount_percentage": 10.0,
"order_id": "e1b1e84f-9cfd-482e-8df6-ea42a6000bae",
"customer_id": "5d9740ac-1d8f-456c-a6e9-ba3947b364fc",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/e1b1e84f-9cfd-482e-8df6-ea42a6000bae"
}
},
"customer": {
"links": {
"related": "api/boomerang/customers/5d9740ac-1d8f-456c-a6e9-ba3947b364fc"
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=22bbd0d2-edce-42f0-9315-13c06519aa5b&filter[owner_type]=documents"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=22bbd0d2-edce-42f0-9315-13c06519aa5b&filter[owner_type]=documents"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/documents
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order |
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
document_type |
String eq, not_eq |
number |
Integer eq, not_eq, gt, gte, lt, lte |
prefix |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
prefix_with_number |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
date |
Date eq, not_eq, gt, gte, lt, lte |
due_date |
Date eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
address |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
revised |
Boolean eq |
finalized |
Boolean eq |
sent |
Boolean eq |
confirmed |
Boolean eq |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_with_tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
coupon_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
total_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_refunded_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_held_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_to_refund_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
to_be_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
order_id |
Uuid eq, not_eq |
customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
coupon_id |
Uuid eq, not_eq |
q |
String eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
status |
Array count |
tag_list |
Array count |
tax_strategy |
Array count |
currency |
Array count |
deposit_type |
Array count |
price_in_cents |
Array sum, maximum, minimum, average |
grand_total_in_cents |
Array sum, maximum, minimum, average |
grand_total_with_tax_in_cents |
Array sum, maximum, minimum, average |
discount_in_cents |
Array sum, maximum, minimum, average |
coupon_discount_in_cents |
Array sum, maximum, minimum, average |
total_discount_in_cents |
Array sum, maximum, minimum, average |
deposit_in_cents |
Array sum, maximum, minimum, average |
deposit_paid_in_cents |
Array sum, maximum, minimum, average |
deposit_refunded_in_cents |
Array sum, maximum, minimum, average |
deposit_held_in_cents |
Array sum, maximum, minimum, average |
deposit_to_refund_in_cents |
Array sum, maximum, minimum, average |
to_be_paid_in_cents |
Array sum, maximum, minimum, average |
paid_in_cents |
Array sum, maximum, minimum, average |
tax_in_cents |
Array sum, maximum, minimum, average |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
customer
order
Updating a document
How to update a document:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/documents/b4c33018-09eb-4d13-b832-4e5d004c8f2b' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "b4c33018-09eb-4d13-b832-4e5d004c8f2b",
"type": "documents",
"attributes": {
"name": "Jane Doe"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b4c33018-09eb-4d13-b832-4e5d004c8f2b",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:23:20+00:00",
"updated_at": "2024-04-29T09:23:21+00:00",
"archived": false,
"archived_at": null,
"document_type": "invoice",
"number": null,
"prefix": null,
"prefix_with_number": null,
"date": null,
"due_date": null,
"name": "Jane Doe",
"address": null,
"reference": null,
"revised": false,
"finalized": false,
"sent": false,
"confirmed": false,
"status": "payment_due",
"signature_url": null,
"deposit_type": "percentage",
"deposit_value": 10.0,
"tag_list": [],
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"tax_in_cents": 15167,
"discount_percentage": 10.0,
"order_id": "68044856-bb36-46fd-a7cc-66b273556e78",
"customer_id": "39749db8-c1db-44a1-b268-9d0dc557a545",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/documents/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][document_type] |
String One of invoice, contract, quote |
data[attributes][number] |
Integer The document number, must be unique per type. Automatically generated if left blank. |
data[attributes][prefix] |
String Add a prefix to document numbers to make it easier to identify different documents. You can add dynamic values (like a year or order number) and custom prefixes e.g. {year}-{customer_number}. |
data[attributes][date] |
Date Date the document was finalized |
data[attributes][due_date] |
Date The latest date by which the invoice must be fully paid |
data[attributes][name] |
String Customer name. If left blank, automatically populated with the customer name of the associated order |
data[attributes][address] |
String Customer Address. If left blank, automatically populated with the customer address of the associated order |
data[attributes][reference] |
String A project number or other reference |
data[attributes][revised] |
Boolean Whether document is revised (applies only to invoice) |
data[attributes][finalized] |
Boolean Whether document is finalized ( quote and contract are always finalized) |
data[attributes][sent] |
Boolean Whether document is sent (with Booqable) |
data[attributes][confirmed] |
Boolean Whether document is confirmed, applies to quote and contract |
data[attributes][status] |
String One of confirmed, unconfirmed, revised, partially_paid, payment_due, paid, process_deposit, overpaid |
data[attributes][deposit_type] |
String One of none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][discount_percentage] |
Float The discount percentage applied to this order |
data[attributes][order_id] |
Uuid The associated Order |
data[attributes][customer_id] |
Uuid The associated Customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
data[attributes][coupon_id] |
Uuid The associated Coupon |
Includes
This request accepts the following includes:
customer
order
tax_region
lines =>
item =>
photo
tax_values
coupon
Creating a document
How to create a contract:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/documents' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "documents",
"attributes": {
"document_type": "contract",
"order_id": "56114a04-9845-4d48-9566-334f164aa5c5"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "04d39050-3dd5-42c2-b430-c00036c0aa62",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:23:24+00:00",
"updated_at": "2024-04-29T09:23:24+00:00",
"archived": false,
"archived_at": null,
"document_type": "contract",
"number": 1,
"prefix": null,
"prefix_with_number": "1",
"date": "2024-04-29",
"due_date": null,
"name": "John Doe",
"address": "",
"reference": null,
"revised": false,
"finalized": true,
"sent": false,
"confirmed": false,
"status": "unconfirmed",
"signature_url": null,
"deposit_type": "percentage",
"deposit_value": 10.0,
"tag_list": [],
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"tax_in_cents": 15167,
"discount_percentage": 10.0,
"order_id": "56114a04-9845-4d48-9566-334f164aa5c5",
"customer_id": "cd5a31ad-c9de-4cff-896e-30335715aa3a",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/documents
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][document_type] |
String One of invoice, contract, quote |
data[attributes][number] |
Integer The document number, must be unique per type. Automatically generated if left blank. |
data[attributes][prefix] |
String Add a prefix to document numbers to make it easier to identify different documents. You can add dynamic values (like a year or order number) and custom prefixes e.g. {year}-{customer_number}. |
data[attributes][date] |
Date Date the document was finalized |
data[attributes][due_date] |
Date The latest date by which the invoice must be fully paid |
data[attributes][name] |
String Customer name. If left blank, automatically populated with the customer name of the associated order |
data[attributes][address] |
String Customer Address. If left blank, automatically populated with the customer address of the associated order |
data[attributes][reference] |
String A project number or other reference |
data[attributes][revised] |
Boolean Whether document is revised (applies only to invoice) |
data[attributes][finalized] |
Boolean Whether document is finalized ( quote and contract are always finalized) |
data[attributes][sent] |
Boolean Whether document is sent (with Booqable) |
data[attributes][confirmed] |
Boolean Whether document is confirmed, applies to quote and contract |
data[attributes][status] |
String One of confirmed, unconfirmed, revised, partially_paid, payment_due, paid, process_deposit, overpaid |
data[attributes][deposit_type] |
String One of none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][discount_percentage] |
Float The discount percentage applied to this order |
data[attributes][order_id] |
Uuid The associated Order |
data[attributes][customer_id] |
Uuid The associated Customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
data[attributes][coupon_id] |
Uuid The associated Coupon |
Includes
This request accepts the following includes:
customer
order
tax_region
lines =>
item =>
photo
tax_values
coupon
Archiving a document
When archiving an invoice make sure delete_invoices permission is enabled.
How to archive a document:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/documents/99283065-aa84-4731-a6fa-16ab628753d0' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "99283065-aa84-4731-a6fa-16ab628753d0",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:23:25+00:00",
"updated_at": "2024-04-29T09:23:26+00:00",
"archived": true,
"archived_at": "2024-04-29T09:23:26+00:00",
"document_type": "invoice",
"number": null,
"prefix": null,
"prefix_with_number": null,
"date": null,
"due_date": null,
"name": "John Doe",
"address": null,
"reference": null,
"revised": false,
"finalized": false,
"sent": false,
"confirmed": false,
"status": "payment_due",
"signature_url": null,
"deposit_type": "percentage",
"deposit_value": 10.0,
"tag_list": [],
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"tax_in_cents": 15167,
"discount_percentage": 10.0,
"order_id": "ee16dc77-9ece-4c78-8f58-91fe6d3b68aa",
"customer_id": "46a79cc4-c19d-4828-8b56-38e2852d6087",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/ee16dc77-9ece-4c78-8f58-91fe6d3b68aa"
}
},
"customer": {
"links": {
"related": "api/boomerang/customers/46a79cc4-c19d-4828-8b56-38e2852d6087"
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=99283065-aa84-4731-a6fa-16ab628753d0&filter[owner_type]=documents"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=99283065-aa84-4731-a6fa-16ab628753d0&filter[owner_type]=documents"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/documents/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Fetching a document
How to fetch a documents:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/documents/99bfb1d1-9bbe-43a8-94b3-7c9b6e479882' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "99bfb1d1-9bbe-43a8-94b3-7c9b6e479882",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:23:28+00:00",
"updated_at": "2024-04-29T09:23:28+00:00",
"archived": false,
"archived_at": null,
"document_type": "invoice",
"number": null,
"prefix": null,
"prefix_with_number": null,
"date": null,
"due_date": null,
"name": "John Doe",
"address": null,
"reference": null,
"revised": false,
"finalized": false,
"sent": false,
"confirmed": false,
"status": "payment_due",
"signature_url": null,
"deposit_type": "percentage",
"deposit_value": 10.0,
"tag_list": [],
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"tax_in_cents": 15167,
"discount_percentage": 10.0,
"order_id": "c1961694-2371-4df7-a635-ec4aaace5fb2",
"customer_id": "c9d1b795-5151-4936-b8aa-33f9bc2b93ee",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/c1961694-2371-4df7-a635-ec4aaace5fb2"
}
},
"customer": {
"links": {
"related": "api/boomerang/customers/c9d1b795-5151-4936-b8aa-33f9bc2b93ee"
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=99bfb1d1-9bbe-43a8-94b3-7c9b6e479882&filter[owner_type]=documents"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=99bfb1d1-9bbe-43a8-94b3-7c9b6e479882&filter[owner_type]=documents"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/documents/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order,tax_region |
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
customer
order
tax_region
lines =>
item =>
photo
tax_values
coupon
Searching documents
Use advanced search to make logical filter groups with and/or operators.
How to search for documents:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/documents/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"documents": "id"
},
"filter": {
"conditions": {
"operator": "and",
"attributes": [
{
"operator": "or",
"attributes": [
{
"status": "paid"
},
{
"deposit_type": "none"
}
]
},
{
"operator": "and",
"attributes": [
{
"date": {
"gte": "2024-04-26T09:23:34.834Z"
}
},
{
"date": {
"lte": "2024-05-02T09:23:34.834Z"
}
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "97dff9f5-c7ff-4e3a-bcd3-93a7824667ad"
},
{
"id": "24f19ce3-cda3-4832-96c7-adc5ca9ab3f9"
}
]
}
HTTP Request
POST api/boomerang/documents/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order |
fields[] |
Array List of comma seperated fields to include ?fields[documents]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
document_type |
String eq, not_eq |
number |
Integer eq, not_eq, gt, gte, lt, lte |
prefix |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
prefix_with_number |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
date |
Date eq, not_eq, gt, gte, lt, lte |
due_date |
Date eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
address |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
revised |
Boolean eq |
finalized |
Boolean eq |
sent |
Boolean eq |
confirmed |
Boolean eq |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_with_tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
coupon_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
total_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_refunded_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_held_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_to_refund_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
to_be_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
order_id |
Uuid eq, not_eq |
customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
coupon_id |
Uuid eq, not_eq |
q |
String eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
status |
Array count |
tag_list |
Array count |
tax_strategy |
Array count |
currency |
Array count |
deposit_type |
Array count |
price_in_cents |
Array sum, maximum, minimum, average |
grand_total_in_cents |
Array sum, maximum, minimum, average |
grand_total_with_tax_in_cents |
Array sum, maximum, minimum, average |
discount_in_cents |
Array sum, maximum, minimum, average |
coupon_discount_in_cents |
Array sum, maximum, minimum, average |
total_discount_in_cents |
Array sum, maximum, minimum, average |
deposit_in_cents |
Array sum, maximum, minimum, average |
deposit_paid_in_cents |
Array sum, maximum, minimum, average |
deposit_refunded_in_cents |
Array sum, maximum, minimum, average |
deposit_held_in_cents |
Array sum, maximum, minimum, average |
deposit_to_refund_in_cents |
Array sum, maximum, minimum, average |
to_be_paid_in_cents |
Array sum, maximum, minimum, average |
paid_in_cents |
Array sum, maximum, minimum, average |
tax_in_cents |
Array sum, maximum, minimum, average |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
customer
order
Email templates
Email templates allow for creating pre-filled emails with dynamic data. Booqable comes with automated templates which can be updated but not deleted.
For more information about using variables for dynamic data in e-mail templates see our help center
Endpoints
PUT /api/boomerang/email_templates/{id}
GET /api/boomerang/email_templates
POST /api/boomerang/email_templates
DELETE /api/boomerang/email_templates/{id}
GET /api/boomerang/email_templates/{id}
Fields
Every email template has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the template |
identifier |
String readonlyA unique identifier assigned to this template |
subject |
String Email subject line template |
context |
String Which resource or process the template applies to. One of order, invoice, document, all, payment, user |
body |
String Email body template |
default |
Boolean readonlyWhether this is a system default template |
automated |
Boolean readonlyWhen true, this template is used by built-in features and can not be deleted. Updating is possible. |
Updating an email template
How to update a default email template:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/email_templates/5f4f78ef-a88a-4fe2-923f-51851c9a8a45' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "5f4f78ef-a88a-4fe2-923f-51851c9a8a45",
"type": "email_templates",
"attributes": {
"name": "Order confirmation"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "5f4f78ef-a88a-4fe2-923f-51851c9a8a45",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:49+00:00",
"updated_at": "2024-04-29T09:27:49+00:00",
"name": "Order confirmation",
"identifier": "webshop_confirmation",
"subject": "We received your order",
"context": "all",
"body": "We'll get started on it right away",
"default": true,
"automated": false
}
},
"meta": {}
}
How to update an email template:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/email_templates/b8aa4d5c-0cb6-43c2-acb8-01c2e427ae41' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "b8aa4d5c-0cb6-43c2-acb8-01c2e427ae41",
"type": "email_templates",
"attributes": {
"name": "Order confirmation"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b8aa4d5c-0cb6-43c2-acb8-01c2e427ae41",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:50+00:00",
"updated_at": "2024-04-29T09:27:50+00:00",
"name": "Order confirmation",
"identifier": "webshop_confirmation",
"subject": "We received your order",
"context": "all",
"body": "We'll get started on it right away",
"default": false,
"automated": false
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/email_templates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[email_templates]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the template |
data[attributes][subject] |
String Email subject line template |
data[attributes][context] |
String Which resource or process the template applies to. One of order, invoice, document, all, payment, user |
data[attributes][body] |
String Email body template |
Includes
This request does not accept any includes
Listing email templates
How to fetch a list of email templates:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/email_templates' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "b7d3c4fe-b6c8-41d1-b6aa-43407f616e55",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:51+00:00",
"updated_at": "2024-04-29T09:27:51+00:00",
"name": "Webshop confirmation",
"identifier": "webshop_confirmation",
"subject": "We received your order",
"context": "all",
"body": "We'll get started on it right away",
"default": false,
"automated": false
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/email_templates
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[email_templates]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
identifier |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
context |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
default |
Boolean eq |
automated |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Creating an email template
How to create a email template:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/email_templates' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "email_templates",
"attributes": {
"name": "Webshop confirmation",
"subject": "We received your order (#{{order.number}})",
"body": "We'll get started on it right away. Your order number is #{{order.number}}.",
"context": "order"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "12f9272d-f21c-4421-8aaa-6af9a30461cb",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:52+00:00",
"updated_at": "2024-04-29T09:27:52+00:00",
"name": "Webshop confirmation",
"identifier": "webshop_confirmation",
"subject": "We received your order (#{{order.number}})",
"context": "order",
"body": "We'll get started on it right away. Your order number is #{{order.number}}.",
"default": false,
"automated": false
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/email_templates
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[email_templates]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the template |
data[attributes][subject] |
String Email subject line template |
data[attributes][context] |
String Which resource or process the template applies to. One of order, invoice, document, all, payment, user |
data[attributes][body] |
String Email body template |
Includes
This request does not accept any includes
Deleting an email template
How to delete a email template:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/email_templates/5b77c072-9236-4fe4-bd9b-e64dcf460f5a' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "5b77c072-9236-4fe4-bd9b-e64dcf460f5a",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:53+00:00",
"updated_at": "2024-04-29T09:27:53+00:00",
"name": "Sales Tax",
"identifier": "sales_tax",
"subject": "This is a subject!",
"context": "all",
"body": "Hi there user!",
"default": false,
"automated": false
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/email_templates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[email_templates]=created_at,updated_at,name |
Includes
This request does not accept any includes
Fetching an email template
How to fetch an email templates:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/email_templates/d87643ce-f5ac-4713-8e38-0712269e1a13' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "d87643ce-f5ac-4713-8e38-0712269e1a13",
"type": "email_templates",
"attributes": {
"created_at": "2024-04-29T09:27:54+00:00",
"updated_at": "2024-04-29T09:27:54+00:00",
"name": "Webshop confirmation",
"identifier": "webshop_confirmation",
"subject": "We received your order",
"context": "all",
"body": "We'll get started on it right away",
"default": false,
"automated": false
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/email_templates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=emails |
fields[] |
Array List of comma seperated fields to include ?fields[email_templates]=created_at,updated_at,name |
Includes
This request accepts the following includes:
emails
Emails
Emails allow you to easily communicate with your customers by using optional templates. Booqable keeps a history of e-mail being sent for orders or customers.
Endpoints
GET /api/boomerang/emails
POST /api/boomerang/emails
Fields
Every email has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
subject |
String Email subject |
body |
String Email body |
recipients |
String Comma seperated list of recipient email addresses, all addresses must be valid for the email to send. |
document_ids |
Array Documents to send as attachments to the email |
order_id |
Uuid The associated Order |
customer_id |
Uuid The associated Customer |
email_template_id |
Uuid The associated Email template |
employee_id |
Uuid readonlyThe associated Employee |
Relationships
Emails have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
customer |
Customers readonlyAssociated Customer |
email_template |
Email templates readonlyAssociated Email template |
employee |
Employees readonlyAssociated Employee |
Listing emails
How to fetch a list of emails for a specific order:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/emails?filter%5Border_id%5D=add6f4fd-debf-491e-a37f-fec05dc89a2a' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "6d974c07-b1ab-456e-8376-472883255314",
"type": "emails",
"attributes": {
"created_at": "2024-04-29T09:25:02+00:00",
"updated_at": "2024-04-29T09:25:02+00:00",
"subject": "Order confirmation",
"body": "We hereby confirm your order with number #123",
"recipients": "[email protected]",
"document_ids": [],
"order_id": "add6f4fd-debf-491e-a37f-fec05dc89a2a",
"customer_id": "bb44b83d-9b45-477e-8c07-26242af63aac",
"email_template_id": null,
"employee_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/add6f4fd-debf-491e-a37f-fec05dc89a2a"
}
},
"customer": {
"links": {
"related": "api/boomerang/customers/bb44b83d-9b45-477e-8c07-26242af63aac"
}
},
"email_template": {
"links": {
"related": null
}
},
"employee": {
"links": {
"related": null
}
}
}
}
],
"meta": {}
}
How to fetch a list of emails:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/emails' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "30aecaca-8383-4d1f-bcf8-8af288df1b16",
"type": "emails",
"attributes": {
"created_at": "2024-04-29T09:25:03+00:00",
"updated_at": "2024-04-29T09:25:03+00:00",
"subject": "Order confirmation",
"body": "We hereby confirm your order with number #123",
"recipients": "[email protected]",
"document_ids": [],
"order_id": null,
"customer_id": "9081e64f-22a1-467e-9133-b9897b38fbbf",
"email_template_id": null,
"employee_id": null
},
"relationships": {
"order": {
"links": {
"related": null
}
},
"customer": {
"links": {
"related": "api/boomerang/customers/9081e64f-22a1-467e-9133-b9897b38fbbf"
}
},
"email_template": {
"links": {
"related": null
}
},
"employee": {
"links": {
"related": null
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/emails
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order |
fields[] |
Array List of comma seperated fields to include ?fields[emails]=created_at,updated_at,subject |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
order_id |
Uuid eq, not_eq |
customer_id |
Uuid eq, not_eq |
email_template_id |
Uuid eq, not_eq |
employee_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
has_error |
Array count |
Includes
This request accepts the following includes:
customer
order
Creating and sending an email
How to create and send an email:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/emails' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "emails",
"attributes": {
"recipients": "[email protected],[email protected]",
"subject": "Order confirmation",
"body": "Hi {{customer.name}}",
"email_template_id": "97bfc1d1-e8bd-4376-ad08-1a4ae11aa6dd",
"order_id": "4048c658-fff5-4995-8c74-25fed763f532",
"customer_id": "1098a0d6-4da9-4cde-ab8c-78e9dcbf2e46",
"document_ids": [
"b275e588-0be8-46b1-b0c0-e53804b04a0e"
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "b1bfbc9b-a604-4041-8243-e037a4716e69",
"type": "emails",
"attributes": {
"created_at": "2024-04-29T09:25:03+00:00",
"updated_at": "2024-04-29T09:25:03+00:00",
"subject": "Order confirmation",
"body": "Hi {{customer.name}}",
"recipients": "[email protected],[email protected]",
"document_ids": [
"b275e588-0be8-46b1-b0c0-e53804b04a0e"
],
"order_id": "4048c658-fff5-4995-8c74-25fed763f532",
"customer_id": "1098a0d6-4da9-4cde-ab8c-78e9dcbf2e46",
"email_template_id": "97bfc1d1-e8bd-4376-ad08-1a4ae11aa6dd",
"employee_id": "07c94414-9873-4731-bdbd-bbc55fa494ce"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"customer": {
"meta": {
"included": false
}
},
"email_template": {
"meta": {
"included": false
}
},
"employee": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/emails
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,order,email_template |
fields[] |
Array List of comma seperated fields to include ?fields[emails]=created_at,updated_at,subject |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][subject] |
String Email subject |
data[attributes][body] |
String Email body |
data[attributes][recipients] |
String Comma seperated list of recipient email addresses, all addresses must be valid for the email to send. |
data[attributes][document_ids][] |
Array Documents to send as attachments to the email |
data[attributes][order_id] |
Uuid The associated Order |
data[attributes][customer_id] |
Uuid The associated Customer |
data[attributes][email_template_id] |
Uuid The associated Email template |
Includes
This request accepts the following includes:
customer
order
email_template
Employees
Employees give access to a Booqable account. You can set different permissions for each employee and let other people use Booqable without giving them access to sensitive information (or taking other unwanted actions).
Employees also allow you to streamline Booqable's interface for specific roles or use cases. For example, if you create an account for someone dedicated to looking after your financials and accounting, it wouldn't need to manage your products and stock levels.
Endpoints
GET /api/boomerang/employees
PUT /api/boomerang/employees/{id}
GET /api/boomerang/employees/{id}
Fields
Every employee has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String readonlyFull name of the employee |
firstname |
String First name of the employee |
lastname |
String Last name of the employee |
locale |
String Locale of the employee, used as application locale |
email |
String Employee's e-mail address |
unconfirmed_email |
String readonlyUnconfirmed e-mail address if present |
current_password |
String writeonlyCurrent password, needed to update password or email address |
password |
String writeonlySet a new password |
password_confirmation |
String writeonlyConfirm new password |
active |
Boolean Whether this employee is active (counts towards billing) |
deactivated_at |
Datetime writeonlyEmployee deactivation date |
owner |
Boolean readonlyWhether this employee is the account owner |
confirmed |
Boolean readonlyWheter this employee confirmed it's email address |
time_to_confirm |
Integer readonlyTime in days left to confirm |
permissions |
Array Any of: reports, products, settings, security_settings, account, exports, cancel_orders, revert_orders, delete_invoices, make_invoice_revisions, override_rental_period. All permissions are always returned when this feature is not included in the current pricing plan or if the employee is the account owner |
avatar_base64 |
String writeonlyBase64 encoded avatar |
remove_avatar |
Boolean writeonlyRemove current avatar |
has_two_factor_autentication |
Boolean readonlyWheter two factor authentication is enabled |
avatar_url |
String readonlyUrl to avatar |
large_avatar_url |
String readonlyUrl to avatar (Large) |
third_party_id |
String readonlyID used for third party tools |
Listing employees
How to fetch a list of employees:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/employees' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "ae263cb9-1c40-4c85-8346-e4005a9cb878",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:17+00:00",
"updated_at": "2024-04-29T09:24:17+00:00",
"name": "John Doe",
"firstname": "John",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": true,
"owner": true,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"products",
"settings",
"security_settings",
"account",
"exports",
"cancel_orders",
"revert_orders",
"delete_invoices",
"make_invoice_revisions",
"override_rental_period"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=mm&size=200"
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/employees
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[employees]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
locale |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
email |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
active |
Boolean eq |
deactivated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
owner |
Boolean eq |
confirmed |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Updating an employee
How to update an employee:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/employees/d7ed6190-e946-4eef-aa6d-514a3d217388' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "d7ed6190-e946-4eef-aa6d-514a3d217388",
"type": "employees",
"attributes": {
"firstname": "Jane"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "d7ed6190-e946-4eef-aa6d-514a3d217388",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:18+00:00",
"updated_at": "2024-04-29T09:24:18+00:00",
"name": "Jane Doe",
"firstname": "Jane",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": true,
"owner": false,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"products",
"settings",
"security_settings",
"account",
"exports",
"cancel_orders",
"revert_orders",
"delete_invoices",
"make_invoice_revisions",
"override_rental_period"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=mm&size=200"
}
},
"meta": {}
}
How to de-activate an employee:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/employees/b76080f4-6aa4-419a-8b02-219022cd24f1' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "b76080f4-6aa4-419a-8b02-219022cd24f1",
"type": "employees",
"attributes": {
"active": false
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b76080f4-6aa4-419a-8b02-219022cd24f1",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:19+00:00",
"updated_at": "2024-04-29T09:24:19+00:00",
"name": "John Doe",
"firstname": "John",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": false,
"owner": false,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"products",
"settings",
"security_settings",
"account",
"exports",
"cancel_orders",
"revert_orders",
"delete_invoices",
"make_invoice_revisions",
"override_rental_period"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=mm&size=200"
}
},
"meta": {}
}
How to set permissions:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/employees/b53c291b-508d-49e2-bc42-7a43e75654cf' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "b53c291b-508d-49e2-bc42-7a43e75654cf",
"type": "employees",
"attributes": {
"permissions": [
"reports",
"settings"
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b53c291b-508d-49e2-bc42-7a43e75654cf",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:19+00:00",
"updated_at": "2024-04-29T09:24:19+00:00",
"name": "John Doe",
"firstname": "John",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": true,
"owner": false,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"settings"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/35f5782642e9fa0f6cfff5a552e2ae97.png?d=mm&size=200"
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/employees/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[employees]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][firstname] |
String First name of the employee |
data[attributes][lastname] |
String Last name of the employee |
data[attributes][locale] |
String Locale of the employee, used as application locale |
data[attributes][email] |
String Employee's e-mail address |
data[attributes][current_password] |
String Current password, needed to update password or email address |
data[attributes][password] |
String Set a new password |
data[attributes][password_confirmation] |
String Confirm new password |
data[attributes][active] |
Boolean Whether this employee is active (counts towards billing) |
data[attributes][deactivated_at] |
Datetime Employee deactivation date |
data[attributes][permissions][] |
Array Any of: reports, products, settings, security_settings, account, exports, cancel_orders, revert_orders, delete_invoices, make_invoice_revisions, override_rental_period. All permissions are always returned when this feature is not included in the current pricing plan or if the employee is the account owner |
data[attributes][avatar_base64] |
String Base64 encoded avatar |
data[attributes][remove_avatar] |
Boolean Remove current avatar |
Includes
This request does not accept any includes
Fetching an employee
How to fetch a employee:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/employees/a5759108-22a2-488f-b2f6-4ca862dc072b' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "a5759108-22a2-488f-b2f6-4ca862dc072b",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:20+00:00",
"updated_at": "2024-04-29T09:24:20+00:00",
"name": "John Doe",
"firstname": "John",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": true,
"owner": true,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"products",
"settings",
"security_settings",
"account",
"exports",
"cancel_orders",
"revert_orders",
"delete_invoices",
"make_invoice_revisions",
"override_rental_period"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=mm&size=200"
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/employees/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[employees]=created_at,updated_at,name |
Includes
This request does not accept any includes
Inventory levels
Inventory levels provide information on item availability. It describes availability, stock counts, and planned quantities for given items.
Endpoints
GET /api/boomerang/inventory_levels
Fields
Every inventory level has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
item_id |
Uuid The associated Item |
order_id |
Uuid readonlyReturn data for all items on an order |
location_id |
Uuid The associated Location |
location_available |
Integer readonlyThe available quantity for the given location |
location_stock_count |
Integer readonlyThe quantity of stock present for the given the location |
location_plannable |
Integer readonlyThe number of products that can be planned for the given location |
location_planned |
Integer readonlyThe planned quantity for the given location |
location_needed |
Integer readonlyThe needed quantity for the given location. This quantity does not contain what has already been returned for an order ( planned - stopped) |
cluster_available |
Integer readonlyThe available quantity for the cluster the given location is part of |
cluster_stock_count |
Integer readonlyThe stock count for the cluster the given location is part of |
cluster_plannable |
Integer readonlyThe planned quantity for the cluster the given location is part of |
cluster_planned |
Integer readonlyThe planned quantity for the cluster the given location is part of |
cluster_needed |
Integer readonlyThe needed quantity for the cluster the given location is part of. This quantity does not contain what has already been returned for an order ( planned - stopped) |
Relationships
Inventory levels have the following relationships:
| Name | Description |
|---|---|
item |
Items readonlyAssociated Item |
location |
Locations readonlyAssociated Location |
Obtaining inventory levels for a product
How to fetch inventory levels for a product:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/inventory_levels?filter%5Bfrom%5D=2022-01-01+09%3A00%3A00&filter%5Bitem_id%5D=cb7cc2de-ba26-43a1-a653-e03bb638e611&filter%5Btill%5D=2022-01-02+09%3A00%3A00' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "65ecefbf-5a4f-5363-b8f8-cd17ef9aaaab",
"type": "inventory_levels",
"attributes": {
"item_id": "cb7cc2de-ba26-43a1-a653-e03bb638e611",
"order_id": null,
"location_id": "bf3b660c-8fc7-4e25-8c70-80563863ecf9",
"location_available": 0,
"location_stock_count": 0,
"location_plannable": 0,
"location_planned": 0,
"location_needed": 0,
"cluster_available": 0,
"cluster_stock_count": 0,
"cluster_plannable": 0,
"cluster_planned": 0,
"cluster_needed": 0
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/cb7cc2de-ba26-43a1-a653-e03bb638e611"
}
},
"location": {
"links": {
"related": "api/boomerang/locations/bf3b660c-8fc7-4e25-8c70-80563863ecf9"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/inventory_levels
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=item,location |
fields[] |
Array List of comma seperated fields to include ?fields[inventory_levels]=item_id,order_id,location_id |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
item_id |
Uuid eq |
order_id |
Uuid eq |
location_id |
Uuid eq |
from |
Datetime requiredeq |
till |
Datetime requiredeq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
item
location
Obtaining inventory levels for a product for a specific location
How to fetch inventory levels for a product for a specific location:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/inventory_levels?filter%5Bfrom%5D=2022-01-01+09%3A00%3A00&filter%5Bitem_id%5D=b384221e-1e5f-4009-b1b0-6d7ebcf2cf6b&filter%5Blocation_id%5D=c89cf6f2-a8c1-4e4f-99c3-6e1a655628b4&filter%5Btill%5D=2022-01-02+09%3A00%3A00' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "027974f7-38c6-5e5c-b122-ce244024834b",
"type": "inventory_levels",
"attributes": {
"item_id": "b384221e-1e5f-4009-b1b0-6d7ebcf2cf6b",
"order_id": null,
"location_id": "c89cf6f2-a8c1-4e4f-99c3-6e1a655628b4",
"location_available": 0,
"location_stock_count": 0,
"location_plannable": 0,
"location_planned": 0,
"location_needed": 0,
"cluster_available": 0,
"cluster_stock_count": 0,
"cluster_plannable": 0,
"cluster_planned": 0,
"cluster_needed": 0
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/b384221e-1e5f-4009-b1b0-6d7ebcf2cf6b"
}
},
"location": {
"links": {
"related": "api/boomerang/locations/c89cf6f2-a8c1-4e4f-99c3-6e1a655628b4"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/inventory_levels
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=item,location |
fields[] |
Array List of comma seperated fields to include ?fields[inventory_levels]=item_id,order_id,location_id |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
item_id |
Uuid eq |
order_id |
Uuid eq |
location_id |
Uuid eq |
from |
Datetime requiredeq |
till |
Datetime requiredeq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
item
location
Invoice finalizations
Pro forma invoices are automatically generated and updated when changes
are made to an order. The InvoiceFinalizationResource resource allows
to request the finalization of the current pro forma invoice.
Further changes to the order will trigger a new pro forma invoice to be
generated with prorated changes.
Fields
Every invoice finalization has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
document_id |
Uuid The associated Document |
Relationships
Invoice finalizations have the following relationships:
| Name | Description |
|---|---|
document |
Documents Associated Document |
Finalize invoice
Finalize a pro forma invoice:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/invoice_finalizations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "invoice_finalization",
"attributes": {
"document_id": "ef575ca5-20bf-4c8a-8711-433f8e48233f"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e9e805af-6cce-58de-a57d-ce010de3d4b3",
"type": "invoice_finalizations",
"attributes": {
"document_id": "ef575ca5-20bf-4c8a-8711-433f8e48233f"
},
"relationships": {
"document": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/invoice_finalizations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=document |
fields[] |
Array List of comma seperated fields to include ?fields[invoice_finalizations]=document_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][document_id] |
Uuid The associated Document |
Includes
This request accepts the following includes:
document
Invoice revisions
Revises the last finalized invoice for an order by combining it with the current pro forma invoice and creating a new finalized invoice.
Creating a revision requires that there is a finalized invoice, and that there is a pro forma invoice (i.e. changes must have been made to the order since the last finalized invoice).
Fields
Every invoice revision has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
order_id |
Uuid The associated Order |
revised_invoice_id |
Uuid readonlyThe associated Revised invoice |
revision_invoice_id |
Uuid readonlyThe associated Revision invoice |
Relationships
Invoice revisions have the following relationships:
| Name | Description |
|---|---|
order |
Orders Associated Order |
revised_invoice |
Documents readonlyAssociated Revised invoice |
revision_invoice |
Documents readonlyAssociated Revision invoice |
Revise invoice
Revise a finalized invoice:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/invoice_revisions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "invoice_revisions",
"attributes": {
"order_id": "e8b051b2-7a20-4596-9694-faf0b08e561a"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "23a5fa67-c724-59b8-ae25-996330d68f20",
"type": "invoice_revisions",
"attributes": {
"order_id": "e8b051b2-7a20-4596-9694-faf0b08e561a",
"revised_invoice_id": "0def2426-fd77-4192-abac-2cccb1bef04d",
"revision_invoice_id": "8f50123f-1611-434d-9747-bf6013bde01b"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"revised_invoice": {
"meta": {
"included": false
}
},
"revision_invoice": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/invoice_revisions
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,revised_invoice,revision_invoice |
fields[] |
Array List of comma seperated fields to include ?fields[invoice_revisions]=order_id,revised_invoice_id,revision_invoice_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
revised_invoice
revision_invoice
Items
The Item resource gives the ability to fetch the following resources:
- Product groups
- Products
- Bundles
The description of the behavior for these resources can be found in their respective sections
Endpoints
GET /api/boomerang/items
POST api/boomerang/items/search
GET /api/boomerang/items/{id}
Fields
For this resource fields are described in the following resources:
- Product groups
- Products
- Bundles
Relationships
For this resource relationships are described in the following resources:
- Product groups
- Products
- Bundles
Listing items
How to fetch a list of items:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/items' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "551be950-ca83-43c4-8ea7-2912107e8b51",
"type": "bundles",
"attributes": {
"created_at": "2024-04-29T09:30:53+00:00",
"updated_at": "2024-04-29T09:30:53+00:00",
"archived": false,
"archived_at": null,
"type": "bundles",
"name": "iPad Bundle",
"slug": "ipad-bundle",
"product_type": "bundle",
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [
"tablets",
"apple"
],
"photo_id": null,
"tax_category_id": null
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"bundle_items": {
"links": {
"related": "api/boomerang/bundle_items?filter[bundle_id]=551be950-ca83-43c4-8ea7-2912107e8b51"
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=551be950-ca83-43c4-8ea7-2912107e8b51"
}
}
}
},
{
"id": "4494ea5f-0295-4f06-b040-f72413268cbf",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:30:54+00:00",
"updated_at": "2024-04-29T09:30:54+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad Pro",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "trackable",
"trackable": true,
"has_variations": false,
"variation": false,
"extra_information": "Charging cable and case included",
"photo_url": null,
"description": "The Apple iPad Pro (2021) 12.9 inches 128GB Space Gray is one of the most powerful and fastest tablets of this moment thanks to the new M1 chip. This chip ensures that demanding apps from Adobe or 3D games run smoothly",
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 1995,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 10000,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [
"tablets",
"apple"
],
"properties": {},
"photo_id": null,
"tax_category_id": "4ec8da00-1415-4e89-ae55-4857e33929eb",
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": true,
"shortage_limit": 3,
"variation_fields": [],
"flat_fee_price_in_cents": 1995,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/4ec8da00-1415-4e89-ae55-4857e33929eb"
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=4494ea5f-0295-4f06-b040-f72413268cbf"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=4494ea5f-0295-4f06-b040-f72413268cbf&filter[owner_type]=product_groups"
}
},
"products": {
"links": {
"related": "api/boomerang/products?filter[product_group_id]=4494ea5f-0295-4f06-b040-f72413268cbf"
}
}
}
},
{
"id": "9a1c5de9-289a-4f65-a791-9d9b6c2f866f",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:30:54+00:00",
"updated_at": "2024-04-29T09:30:54+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro",
"group_name": "iPad Pro",
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "trackable",
"trackable": true,
"has_variations": false,
"variation": false,
"extra_information": "Charging cable and case included",
"photo_url": null,
"description": "The Apple iPad Pro (2021) 12.9 inches 128GB Space Gray is one of the most powerful and fastest tablets of this moment thanks to the new M1 chip. This chip ensures that demanding apps from Adobe or 3D games run smoothly",
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 1995,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 10000,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [
"tablets",
"apple"
],
"properties": {},
"photo_id": null,
"tax_category_id": "4ec8da00-1415-4e89-ae55-4857e33929eb",
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [],
"allow_shortage": true,
"shortage_limit": 3,
"product_group_id": "4494ea5f-0295-4f06-b040-f72413268cbf"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/4ec8da00-1415-4e89-ae55-4857e33929eb"
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=9a1c5de9-289a-4f65-a791-9d9b6c2f866f"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=4494ea5f-0295-4f06-b040-f72413268cbf&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/4494ea5f-0295-4f06-b040-f72413268cbf"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=9a1c5de9-289a-4f65-a791-9d9b6c2f866f&filter[owner_type]=products"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/items
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[items]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
inventory_levels
photo
Searching items
Use advanced search to make logical filter groups with and/or operators.
How to search for items:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/items/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"items": "id"
},
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"discountable": true
},
{
"taxable": true
}
]
},
{
"operator": "and",
"attributes": [
{
"show_in_store": true
},
{
"taxable": true
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "5f325ff2-f262-4339-9744-798e79f81ce5"
},
{
"id": "6594f771-1130-4b75-b6f8-2f110c8a728e"
},
{
"id": "9962d446-6c9a-4bf0-be67-d7685bc7c466"
},
{
"id": "15572979-a467-46ea-bb33-fdea6cd13791"
},
{
"id": "bd944908-ecce-44aa-a734-b426cd988413"
}
]
}
HTTP Request
POST api/boomerang/items/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[items]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
inventory_levels
photo
Fetching an item
How to fetch an item:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/items/b6c6956a-ec14-4665-a447-c8f0243368b0' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "b6c6956a-ec14-4665-a447-c8f0243368b0",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:30:57+00:00",
"updated_at": "2024-04-29T09:30:57+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad Pro",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "trackable",
"trackable": true,
"has_variations": false,
"variation": false,
"extra_information": "Charging cable and case included",
"photo_url": null,
"description": "The Apple iPad Pro (2021) 12.9 inches 128GB Space Gray is one of the most powerful and fastest tablets of this moment thanks to the new M1 chip. This chip ensures that demanding apps from Adobe or 3D games run smoothly",
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 1995,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 10000,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [
"tablets",
"apple"
],
"properties": {},
"photo_id": null,
"tax_category_id": "6f83b0cd-5191-481e-8c64-0de95745f66a",
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": true,
"shortage_limit": 3,
"variation_fields": [],
"flat_fee_price_in_cents": 1995,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/6f83b0cd-5191-481e-8c64-0de95745f66a"
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=b6c6956a-ec14-4665-a447-c8f0243368b0"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=b6c6956a-ec14-4665-a447-c8f0243368b0&filter[owner_type]=product_groups"
}
},
"products": {
"links": {
"related": "api/boomerang/products?filter[product_group_id]=b6c6956a-ec14-4665-a447-c8f0243368b0"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[items]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
inventory_levels
photo
Item prices
Allows you to calculate pricing for an item based on parameters.
You can calculate a price in a couple ways:
- Providing a
fromandtill, charge label and length will be derived from the dates provided - Providing a
charge_length
Fields
Every item price has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
item_id |
Uuid The associated Item |
from |
Datetime Start of charge period |
till |
Datetime End of charge period |
original_charge_length |
Integer readonlyLength of charge period before charge rules are applied |
charge_length |
Integer Length of charge period in seconds |
original_charge_label |
String readonlyLabel of charge period before charge rules are applied |
charge_label |
String readonlyLabel for the charge period |
original_price_each_in_cents |
Integer readonlyPrice per item before charge rules are applied |
price_each_in_cents |
Integer readonlyFinal price per item |
price_rule_values |
Hash readonlyWhat price rules were applied |
price_structure_id |
Uuid The associated Price structure |
price_ruleset_id |
Uuid The associated Price ruleset |
price_tile_id |
Uuid readonlyThe associated Price tile |
Relationships
Item prices have the following relationships:
| Name | Description |
|---|---|
item |
Items readonlyAssociated Item |
price_structure |
Price structures readonlyAssociated Price structure |
price_ruleset |
Price rulesets readonlyAssociated Price ruleset |
price_tile |
Price tiles readonlyAssociated Price tile |
Calcuating the price of products and/or bundles
Calculating price for a period:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/item_prices?filter%5Bfrom%5D=2030-01-01+12%3A00%3A00+UTC&filter%5Bitem_id%5D%5B%5D=6dba28a6-ba69-44fc-b910-b81a35e887a7&filter%5Bitem_id%5D%5B%5D=f138abc2-be74-4791-accc-f1c5d0129404&filter%5Btill%5D=2030-01-14+12%3A00%3A00+UTC&include=item' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "318be937-8ceb-4e93-9da8-fd0ca31cab80",
"type": "item_prices",
"attributes": {
"item_id": "6dba28a6-ba69-44fc-b910-b81a35e887a7",
"from": "2030-01-01T12:00:00+00:00",
"till": "2030-01-14T12:00:00+00:00",
"original_charge_length": 1123200,
"charge_length": 1123200,
"original_charge_label": "13 days",
"charge_label": "13 days",
"original_price_each_in_cents": 0,
"price_each_in_cents": 0,
"price_rule_values": null,
"price_structure_id": null,
"price_ruleset_id": null,
"price_tile_id": null
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/6dba28a6-ba69-44fc-b910-b81a35e887a7"
},
"data": {
"type": "products",
"id": "6dba28a6-ba69-44fc-b910-b81a35e887a7"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
}
}
},
{
"id": "0e1db11a-047e-44cd-b314-03af8c810f06",
"type": "item_prices",
"attributes": {
"item_id": "f138abc2-be74-4791-accc-f1c5d0129404",
"from": "2030-01-01T12:00:00+00:00",
"till": "2030-01-14T12:00:00+00:00",
"original_charge_length": 1123200,
"charge_length": 1123200,
"original_charge_label": "13 days",
"charge_label": "13 days",
"original_price_each_in_cents": 0,
"price_each_in_cents": 0,
"price_rule_values": null,
"price_structure_id": null,
"price_ruleset_id": null,
"price_tile_id": null
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/f138abc2-be74-4791-accc-f1c5d0129404"
},
"data": {
"type": "products",
"id": "f138abc2-be74-4791-accc-f1c5d0129404"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
}
}
}
],
"included": [
{
"id": "6dba28a6-ba69-44fc-b910-b81a35e887a7",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:25:57+00:00",
"updated_at": "2024-04-29T09:25:57+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "Product 1000038",
"group_name": "Product 1000038",
"slug": "product-1000038",
"sku": "PRODUCT 1000040",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "hour",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "98a83f70-b748-4555-ba42-9100cde65879"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=6dba28a6-ba69-44fc-b910-b81a35e887a7"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=98a83f70-b748-4555-ba42-9100cde65879&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/98a83f70-b748-4555-ba42-9100cde65879"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=6dba28a6-ba69-44fc-b910-b81a35e887a7&filter[owner_type]=products"
}
}
}
},
{
"id": "f138abc2-be74-4791-accc-f1c5d0129404",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:25:57+00:00",
"updated_at": "2024-04-29T09:25:57+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "Product 1000039",
"group_name": "Product 1000039",
"slug": "product-1000039",
"sku": "PRODUCT 1000041",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "d6f570b4-2fd5-4a8f-a48e-3663b8af4ac7"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=f138abc2-be74-4791-accc-f1c5d0129404"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=d6f570b4-2fd5-4a8f-a48e-3663b8af4ac7&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/d6f570b4-2fd5-4a8f-a48e-3663b8af4ac7"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=f138abc2-be74-4791-accc-f1c5d0129404&filter[owner_type]=products"
}
}
}
}
],
"meta": {}
}
Calculating price charge length:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/item_prices?filter%5Bcharge_length%5D=36000&filter%5Bitem_id%5D=c9cb6831-90c6-4ce1-8f66-ec3f1747397f&include=item' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "5ee93e91-0a87-4f80-b3eb-186170362e63",
"type": "item_prices",
"attributes": {
"item_id": "c9cb6831-90c6-4ce1-8f66-ec3f1747397f",
"from": null,
"till": null,
"original_charge_length": 36000,
"charge_length": 36000,
"original_charge_label": "10 hours",
"charge_label": "10 hours",
"original_price_each_in_cents": null,
"price_each_in_cents": 0,
"price_rule_values": null,
"price_structure_id": null,
"price_ruleset_id": null,
"price_tile_id": null
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/c9cb6831-90c6-4ce1-8f66-ec3f1747397f"
},
"data": {
"type": "products",
"id": "c9cb6831-90c6-4ce1-8f66-ec3f1747397f"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
}
}
}
],
"included": [
{
"id": "c9cb6831-90c6-4ce1-8f66-ec3f1747397f",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:25:58+00:00",
"updated_at": "2024-04-29T09:25:58+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "Product 1000040",
"group_name": "Product 1000040",
"slug": "product-1000040",
"sku": "PRODUCT 1000042",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "hour",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "248b7620-7cbc-4083-af92-f507d2a4b263"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=c9cb6831-90c6-4ce1-8f66-ec3f1747397f"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=248b7620-7cbc-4083-af92-f507d2a4b263&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/248b7620-7cbc-4083-af92-f507d2a4b263"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=c9cb6831-90c6-4ce1-8f66-ec3f1747397f&filter[owner_type]=products"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/item_prices
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_tile,price_structure,item |
fields[] |
Array List of comma seperated fields to include ?fields[item_prices]=item_id,from,till |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
item_id |
Uuid eq |
from |
Datetime eq |
till |
Datetime eq |
original_charge_length |
Integer eq |
charge_length |
Integer eq |
price_structure_id |
Uuid eq |
price_ruleset_id |
Uuid eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
price_tile
price_structure
item
Lines
Lines make up the individual elements of an order, document, or cart. They contain information about pricing, planning, or markup. A key concept about lines is that there are two kinds:
- Custom lines Lines created through the resource that don't have a planning associated with it. Can be of one of type
charge,section. - Planning lines Lines that have a planning associated with it, these lines can't be created through the resource directly but only through a order booking). Destroying a planning line will also destroy its associated planning.
Note that lines can only be created for orders. On invoices, lines are automatically generated based on price changes of the order. For quotes and contracts, lines are generated through the Document resource.
A line can have one of the following types:
sectionBehaves as a (visual) section on orders and documents.chargeRegular charge line which contains price information.deposit_chargeA deposit charge line generated by a deposit hold action. This line is always calculated from a price including taxes.prorationWhether this line is a proration, these lines only appear on invoices and can't be updated or destroyed by the resource; they are automatically synced.refundThis line was created due to a refund.legacy_migrationProration bundled as one line. This lines appear on invoices that were made before Booqable was able to sync invoices automatically.
Nested lines contain information about individual items in a bundle; for these lines, the quantity and price information can not be updated directly but should be updated through the parent line instead.
Endpoints
GET /api/boomerang/lines/{id}
GET /api/boomerang/lines
POST /api/boomerang/lines
DELETE /api/boomerang/lines/{id}
PUT /api/boomerang/lines/{id}
Fields
Every line has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether line is archived |
archived_at |
Datetime nullable readonlyWhen the line was archived |
title |
String nullableTitle of the line |
extra_information |
String nullableExtra information about the line |
quantity |
Integer The quantity to calculate with. When updating quantity of a line with an associated planning, the planning also gets updated, which may lead to a shortage error |
original_price_each_in_cents |
Integer readonlyThe original price of the product (without price rule adjustments) |
original_charge_length |
Integer readonlyThe original charge length of the product (without price rule adjustments) |
original_charge_label |
String nullableThe original charge label of the product (without price rule adjustments) |
price_each_in_cents |
Integer Price of each line |
price_in_cents |
Integer readonlyPrice of each line x quantity |
display_price_in_cents |
Integer readonlyPrice of this line to display based on the tax setting of the company (inclusive vs. exclusive) |
position |
Integer nullableWhich position the line has |
charge_label |
String nullableCharge label |
charge_length |
Integer nullableThe charge length in seconds. It can be different than the time planned. Set to null to recalculate pricing based on order period and apply price rules. |
price_rule_values |
Hash nullable readonlyBreakdown of applied price rules |
discountable |
Boolean Whether line is discountable |
taxable |
Boolean Whether line is taxable |
line_type |
String One of section, deposit_charge, proration, charge, legacy_migration |
relevant |
Boolean readonlyWhether line is relevant. If not, line has no visible change, it's only used for reporting |
confirm_shortage |
Boolean writeonlyWhether to confirm a shortage when updating quantity on a line |
order_id |
Uuid readonlyThe associated Order |
item_id |
Uuid nullable readonlyThe associated Item |
tax_category_id |
Uuid nullableThe associated Tax category |
planning_id |
Uuid readonlyThe associated Planning |
price_structure_id |
Uuid The associated Price structure |
price_tile_id |
Uuid The associated Price tile |
parent_line_id |
Uuid readonlyThe associated Parent line |
owner_id |
Uuid ID of its owner |
owner_type |
String One of orders, documents, carts |
Relationships
Lines have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
item |
Items readonlyAssociated Item |
tax_category |
Tax categories readonlyAssociated Tax category |
planning |
Plannings readonlyAssociated Planning |
price_structure |
Price structures readonlyAssociated Price structure |
price_tile |
Price tiles readonlyAssociated Price tile |
parent_line |
Lines readonlyAssociated Parent line |
nested_lines |
Lines readonlyAssociated Nested lines |
owner |
Order Associated Owner |
Fetching a line
How to fetch a line:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/lines/e70db147-8680-415f-a042-294449fad817' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "e70db147-8680-415f-a042-294449fad817",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:24:49+00:00",
"updated_at": "2024-04-29T09:24:49+00:00",
"archived": false,
"archived_at": null,
"title": "Macbook Pro",
"extra_information": "Comes with a mouse",
"quantity": 1,
"original_price_each_in_cents": 72500,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 80250,
"price_in_cents": 80250,
"display_price_in_cents": 80250,
"position": 1,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": {
"charge": {
"from": "1980-04-02T00:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"adjustments": [
{
"name": "Pickup day"
},
{
"name": "Return day"
}
]
},
"price": [
{
"name": "High-Season",
"charge_length": 1339200,
"multiplier": "0.2",
"price_in_cents": 7750,
"adjustments": [
{
"from": "1980-04-15T12:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"charge_length": 1339200,
"charge_label": "372 hours",
"price_in_cents": 7750
}
],
"stacked": false
}
]
},
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "2c140c46-02fc-4612-a7f6-0c08572ad575",
"item_id": "18398a24-3f8f-4d1b-92e7-4e9086ef3a4f",
"tax_category_id": "0d224df6-6c36-450a-b004-c2bb09019f7f",
"planning_id": "1d3d945d-7c4d-4130-bfe5-511e9b47ba36",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "2c140c46-02fc-4612-a7f6-0c08572ad575",
"owner_type": "orders"
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/2c140c46-02fc-4612-a7f6-0c08572ad575"
}
},
"item": {
"links": {
"related": "api/boomerang/items/18398a24-3f8f-4d1b-92e7-4e9086ef3a4f"
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/0d224df6-6c36-450a-b004-c2bb09019f7f"
}
},
"planning": {
"links": {
"related": "api/boomerang/plannings/1d3d945d-7c4d-4130-bfe5-511e9b47ba36"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
},
"parent_line": {
"links": {
"related": null
}
},
"nested_lines": {
"links": {
"related": "api/boomerang/lines?filter[parent_line_id]=e70db147-8680-415f-a042-294449fad817"
}
},
"owner": {
"links": {
"related": "api/boomerang/orders/2c140c46-02fc-4612-a7f6-0c08572ad575"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/lines/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,owner,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[lines]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
order =>
tax_values
owner =>
tax_values
tax_category
parent_line
nested_lines =>
planning
planning =>
item =>
photo
Listing lines
How to fetch a list of lines:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/lines' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "c6f8666d-e0ea-4e0e-b7c7-285a4719edc9",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:24:51+00:00",
"updated_at": "2024-04-29T09:24:51+00:00",
"archived": false,
"archived_at": null,
"title": "Macbook Pro",
"extra_information": "Comes with a mouse",
"quantity": 1,
"original_price_each_in_cents": 72500,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 80250,
"price_in_cents": 80250,
"display_price_in_cents": 80250,
"position": 1,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": {
"charge": {
"from": "1980-04-02T00:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"adjustments": [
{
"name": "Pickup day"
},
{
"name": "Return day"
}
]
},
"price": [
{
"name": "High-Season",
"charge_length": 1339200,
"multiplier": "0.2",
"price_in_cents": 7750,
"adjustments": [
{
"from": "1980-04-15T12:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"charge_length": 1339200,
"charge_label": "372 hours",
"price_in_cents": 7750
}
],
"stacked": false
}
]
},
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "622ca15c-05ea-4b69-8b8b-8bd5b2f0ee4d",
"item_id": "f474a076-2fd4-4bb7-82f1-272843a8aed5",
"tax_category_id": "9d802974-8013-4b36-afbb-33b33ea91e64",
"planning_id": "e899e499-43b6-40ce-8322-515ce16e9be0",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "622ca15c-05ea-4b69-8b8b-8bd5b2f0ee4d",
"owner_type": "orders"
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/622ca15c-05ea-4b69-8b8b-8bd5b2f0ee4d"
}
},
"item": {
"links": {
"related": "api/boomerang/items/f474a076-2fd4-4bb7-82f1-272843a8aed5"
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/9d802974-8013-4b36-afbb-33b33ea91e64"
}
},
"planning": {
"links": {
"related": "api/boomerang/plannings/e899e499-43b6-40ce-8322-515ce16e9be0"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
},
"parent_line": {
"links": {
"related": null
}
},
"nested_lines": {
"links": {
"related": "api/boomerang/lines?filter[parent_line_id]=c6f8666d-e0ea-4e0e-b7c7-285a4719edc9"
}
},
"owner": {
"links": {
"related": "api/boomerang/orders/622ca15c-05ea-4b69-8b8b-8bd5b2f0ee4d"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/lines
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,owner,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[lines]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
quantity |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
line_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
relevant |
Boolean eq |
order_id |
Uuid eq, not_eq |
item_id |
Uuid eq, not_eq |
tax_category_id |
Uuid eq, not_eq |
planning_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
price_tile_id |
Uuid eq, not_eq |
parent_line_id |
Uuid eq, not_eq |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
order
owner
tax_category
planning =>
item =>
photo
Creating a line
Lines created through this endpoint, so-called custom lines, can only have the type charge or section. They enable you to add charges and organization which are not managed automatically through bookings.
Order totals are automatically re-calculated after the creation of a new line and an invoice sync will be triggered if changes are relevant.
How to create a line:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/lines' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "lines",
"attributes": {
"owner_id": "2b90c592-5b07-4dd3-81e8-368c424b137c",
"owner_type": "orders",
"price_each_in_cents": 1000
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "50a86bd4-40ed-4228-bca5-c7b259ba77bd",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:24:55+00:00",
"updated_at": "2024-04-29T09:24:55+00:00",
"archived": false,
"archived_at": null,
"title": null,
"extra_information": null,
"quantity": 1,
"original_price_each_in_cents": null,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 1000,
"price_in_cents": 1000,
"display_price_in_cents": 1000,
"position": 1,
"charge_label": null,
"charge_length": null,
"price_rule_values": null,
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "2b90c592-5b07-4dd3-81e8-368c424b137c",
"item_id": null,
"tax_category_id": null,
"planning_id": null,
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "2b90c592-5b07-4dd3-81e8-368c424b137c",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/lines
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,owner,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[lines]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][title] |
String Title of the line |
data[attributes][extra_information] |
String Extra information about the line |
data[attributes][quantity] |
Integer The quantity to calculate with. When updating quantity of a line with an associated planning, the planning also gets updated, which may lead to a shortage error |
data[attributes][original_charge_label] |
String The original charge label of the product (without price rule adjustments) |
data[attributes][price_each_in_cents] |
Integer Price of each line |
data[attributes][position] |
Integer Which position the line has |
data[attributes][charge_label] |
String Charge label |
data[attributes][charge_length] |
Integer The charge length in seconds. It can be different than the time planned. Set to null to recalculate pricing based on order period and apply price rules. |
data[attributes][discountable] |
Boolean Whether line is discountable |
data[attributes][taxable] |
Boolean Whether line is taxable |
data[attributes][line_type] |
String One of section, deposit_charge, proration, charge, legacy_migration |
data[attributes][confirm_shortage] |
Boolean Whether to confirm a shortage when updating quantity on a line |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
data[attributes][price_tile_id] |
Uuid The associated Price tile |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String One of orders, documents, carts |
Includes
This request accepts the following includes:
order =>
tax_values
owner =>
tax_values
tax_category
parent_line
nested_lines =>
planning
planning =>
item =>
photo
Archiving a line
How to delete a line:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/lines/954aca64-3b3e-46af-bcaf-6e57f8fe5ae2' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "954aca64-3b3e-46af-bcaf-6e57f8fe5ae2",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:24:57+00:00",
"updated_at": "2024-04-29T09:24:57+00:00",
"archived": false,
"archived_at": null,
"title": "Macbook Pro",
"extra_information": "Comes with a mouse",
"quantity": 1,
"original_price_each_in_cents": 72500,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 80250,
"price_in_cents": 80250,
"display_price_in_cents": 80250,
"position": 1,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": {
"charge": {
"from": "1980-04-02T00:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"adjustments": [
{
"name": "Pickup day"
},
{
"name": "Return day"
}
]
},
"price": [
{
"name": "High-Season",
"charge_length": 1339200,
"multiplier": "0.2",
"price_in_cents": 7750,
"adjustments": [
{
"from": "1980-04-15T12:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"charge_length": 1339200,
"charge_label": "372 hours",
"price_in_cents": 7750
}
],
"stacked": false
}
]
},
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "51c7b913-6b7a-4519-8544-c1581705627d",
"item_id": "f38b84dd-0198-434e-8e04-6ec50f2f0ff8",
"tax_category_id": "6785cda4-f67f-4878-aa76-eb58d8ffd15b",
"planning_id": "cf757074-ce3f-48a5-b951-d9efb0cc9db7",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "51c7b913-6b7a-4519-8544-c1581705627d",
"owner_type": "orders"
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/51c7b913-6b7a-4519-8544-c1581705627d"
}
},
"item": {
"links": {
"related": "api/boomerang/items/f38b84dd-0198-434e-8e04-6ec50f2f0ff8"
}
},
"tax_category": {
"links": {
"related": "api/boomerang/tax_categories/6785cda4-f67f-4878-aa76-eb58d8ffd15b"
}
},
"planning": {
"links": {
"related": "api/boomerang/plannings/cf757074-ce3f-48a5-b951-d9efb0cc9db7"
}
},
"price_structure": {
"links": {
"related": null
}
},
"price_tile": {
"links": {
"related": null
}
},
"parent_line": {
"links": {
"related": null
}
},
"nested_lines": {
"links": {
"related": "api/boomerang/lines?filter[parent_line_id]=954aca64-3b3e-46af-bcaf-6e57f8fe5ae2"
}
},
"owner": {
"links": {
"related": "api/boomerang/orders/51c7b913-6b7a-4519-8544-c1581705627d"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/lines/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,owner,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[lines]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
order =>
tax_values
owner =>
tax_values
tax_category
parent_line
nested_lines =>
planning
planning =>
item =>
photo
Updating a line
Change information, pricing, or increase the quantity of a line. Note that when updating the quantity of a line associated with a planning, the quantity of the planninig will also be updated, which may result in a shortage error.
Order totals are automatically re-calculated after updating a line and an invoice sync will be triggered if changes are relevant.
How to update a line:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/lines/c464edfc-f90c-4469-959a-374bd2a2894d' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "c464edfc-f90c-4469-959a-374bd2a2894d",
"type": "lines",
"attributes": {
"price_each_in_cents": 1000
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "c464edfc-f90c-4469-959a-374bd2a2894d",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:25:00+00:00",
"updated_at": "2024-04-29T09:25:01+00:00",
"archived": false,
"archived_at": null,
"title": "Macbook Pro",
"extra_information": "Comes with a mouse",
"quantity": 1,
"original_price_each_in_cents": 72500,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 1000,
"price_in_cents": 1000,
"display_price_in_cents": 1000,
"position": 1,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": null,
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "4b4e946a-27d2-4d5c-b7b1-2267be440df5",
"item_id": "0447262b-8ee9-4427-8bcc-3ee894103d2d",
"tax_category_id": "2d167cf0-42ef-4d10-afe7-f160623a7fcf",
"planning_id": "5d91430f-e3b3-4563-ac65-e81ef14a69ce",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "4b4e946a-27d2-4d5c-b7b1-2267be440df5",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/lines/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,owner,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[lines]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][title] |
String Title of the line |
data[attributes][extra_information] |
String Extra information about the line |
data[attributes][quantity] |
Integer The quantity to calculate with. When updating quantity of a line with an associated planning, the planning also gets updated, which may lead to a shortage error |
data[attributes][original_charge_label] |
String The original charge label of the product (without price rule adjustments) |
data[attributes][price_each_in_cents] |
Integer Price of each line |
data[attributes][position] |
Integer Which position the line has |
data[attributes][charge_label] |
String Charge label |
data[attributes][charge_length] |
Integer The charge length in seconds. It can be different than the time planned. Set to null to recalculate pricing based on order period and apply price rules. |
data[attributes][discountable] |
Boolean Whether line is discountable |
data[attributes][taxable] |
Boolean Whether line is taxable |
data[attributes][line_type] |
String One of section, deposit_charge, proration, charge, legacy_migration |
data[attributes][confirm_shortage] |
Boolean Whether to confirm a shortage when updating quantity on a line |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
data[attributes][price_tile_id] |
Uuid The associated Price tile |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String One of orders, documents, carts |
Includes
This request accepts the following includes:
order =>
tax_values
owner =>
tax_values
tax_category
parent_line
nested_lines =>
planning
planning =>
item =>
photo
Locations
A location is a place (like a store) where customers pick up and return orders or a warehouse that only stocks inventory.
Endpoints
PUT /api/boomerang/locations/{id}
GET /api/boomerang/locations
DELETE /api/boomerang/locations/{id}
POST /api/boomerang/locations
GET /api/boomerang/locations/{id}
Fields
Every location has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether location is archived |
archived_at |
Datetime nullable readonlyWhen the location was archived |
name |
String Name of the location |
code |
String Code used to identify the location |
location_type |
String Determines if the location can be seen in the online webshop. One of rental, internal |
address_line_1 |
String First address line |
address_line_2 |
String Second address line |
zipcode |
String Address zipcode |
city |
String Address city |
region |
String Address region |
country |
String Address country |
cluster_ids |
Array Clusters this location belongs to |
main_address_attributes |
Hash writeonlyA hash with the address fields. Use it when creating or updating a location. See address property type for more information |
main_address |
Hash A hash with the address fields. Use it when fetching a location. See address property type for more information |
Relationships
Locations have the following relationships:
| Name | Description |
|---|---|
clusters |
Clusters readonlyAssociated Clusters |
Updating a location
Note that disassociating clusters may result in a shortage error.
Disassociating cluster resulting in shortage error:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/locations/629f4380-8b9a-4c74-8f27-3b8a5bd5a7a2' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "629f4380-8b9a-4c74-8f27-3b8a5bd5a7a2",
"type": "locations",
"attributes": {
"name": "Old warehouse",
"cluster_ids": []
}
},
"include": "clusters"
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "shortage",
"status": "422",
"title": "Shortage",
"detail": "This will create shortage for running or future orders",
"meta": {
"warning": [],
"blocking": [
{
"reason": "shortage",
"shortage": 2,
"item_id": "a9711067-e041-4aa7-afe4-3702eaa5edc0",
"mutation": 0,
"order_ids": [
"b9897d46-a8fe-47d2-8a10-854c8ca9c6a5"
],
"location_id": "629f4380-8b9a-4c74-8f27-3b8a5bd5a7a2",
"available": -2,
"plannable": -2,
"stock_count": 0,
"planned": 2,
"needed": 2,
"cluster_available": -2,
"cluster_plannable": -2,
"cluster_stock_count": 0,
"cluster_planned": 2,
"cluster_needed": 2
}
]
}
}
]
}
How to update a location and assign it to multiple clusters:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/locations/3980926c-dbc7-4983-bd46-c6fd6bd2b6da' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "3980926c-dbc7-4983-bd46-c6fd6bd2b6da",
"type": "locations",
"attributes": {
"name": "Old warehouse",
"cluster_ids": [
"8f7fdad9-ad46-4cf7-8d44-0aed69940503",
"96605719-3a5b-4807-89df-7eb5dff5d701"
]
}
},
"include": "clusters"
}'
A 200 status response looks like this:
{
"data": {
"id": "3980926c-dbc7-4983-bd46-c6fd6bd2b6da",
"type": "locations",
"attributes": {
"created_at": "2024-04-29T09:30:00+00:00",
"updated_at": "2024-04-29T09:30:00+00:00",
"archived": false,
"archived_at": null,
"name": "Old warehouse",
"code": "LOC1000078",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [
"8f7fdad9-ad46-4cf7-8d44-0aed69940503",
"96605719-3a5b-4807-89df-7eb5dff5d701"
],
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuisplein 40",
"address2": "Department II",
"city": "Leeuwarden",
"region": "Friesland",
"zipcode": "8911LJ",
"country": "Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
}
},
"relationships": {
"clusters": {
"data": [
{
"type": "clusters",
"id": "8f7fdad9-ad46-4cf7-8d44-0aed69940503"
},
{
"type": "clusters",
"id": "96605719-3a5b-4807-89df-7eb5dff5d701"
}
]
}
}
},
"included": [
{
"id": "8f7fdad9-ad46-4cf7-8d44-0aed69940503",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:30:00+00:00",
"updated_at": "2024-04-29T09:30:00+00:00",
"name": "North",
"location_ids": [
"3980926c-dbc7-4983-bd46-c6fd6bd2b6da"
]
},
"relationships": {
"locations": {
"meta": {
"included": false
}
}
}
},
{
"id": "96605719-3a5b-4807-89df-7eb5dff5d701",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:30:00+00:00",
"updated_at": "2024-04-29T09:30:00+00:00",
"name": "Central",
"location_ids": [
"3980926c-dbc7-4983-bd46-c6fd6bd2b6da"
]
},
"relationships": {
"locations": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/locations/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=clusters,main_address |
fields[] |
Array List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the location |
data[attributes][code] |
String Code used to identify the location |
data[attributes][location_type] |
String Determines if the location can be seen in the online webshop. One of rental, internal |
data[attributes][address_line_1] |
String First address line |
data[attributes][address_line_2] |
String Second address line |
data[attributes][zipcode] |
String Address zipcode |
data[attributes][city] |
String Address city |
data[attributes][region] |
String Address region |
data[attributes][country] |
String Address country |
data[attributes][cluster_ids][] |
Array Clusters this location belongs to |
data[attributes][main_address_attributes] |
Hash A hash with the address fields. Use it when creating or updating a location. See address property type for more information |
data[attributes][main_address] |
Hash A hash with the address fields. Use it when fetching a location. See address property type for more information |
Includes
This request accepts the following includes:
clusters
main_address
Listing locations
How to fetch locations:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/locations' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "88b908fb-c92a-4a45-961c-a1f2ae1541dd",
"type": "locations",
"attributes": {
"created_at": "2024-04-29T09:30:01+00:00",
"updated_at": "2024-04-29T09:30:01+00:00",
"archived": false,
"archived_at": null,
"name": "Warehouse",
"code": "LOC1000079",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [],
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuisplein 40",
"address2": "Department II",
"city": "Leeuwarden",
"region": "Friesland",
"zipcode": "8911LJ",
"country": "Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
}
},
"relationships": {
"clusters": {
"links": {
"related": "api/boomerang/clusters?filter[location_id]=88b908fb-c92a-4a45-961c-a1f2ae1541dd"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/locations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=clusters |
fields[] |
Array List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
code |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
location_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
main_address |
Hash eq |
cluster_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
clusters
Archiving a location
To archive a location make sure that:
- There is no active stock at the location
- There are no running or future orders for this location
- This is not the last active location
How to archive a location:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/locations/ab7f1776-b396-4c69-8618-d48ede5abfb4' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "ab7f1776-b396-4c69-8618-d48ede5abfb4",
"type": "locations",
"attributes": {
"created_at": "2024-04-29T09:30:03+00:00",
"updated_at": "2024-04-29T09:30:04+00:00",
"archived": true,
"archived_at": "2024-04-29T09:30:04+00:00",
"name": "Warehouse",
"code": "LOC1000080",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [],
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuisplein 40",
"address2": "Department II",
"city": "Leeuwarden",
"region": "Friesland",
"zipcode": "8911LJ",
"country": "Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
}
},
"relationships": {
"clusters": {
"links": {
"related": "api/boomerang/clusters?filter[location_id]=ab7f1776-b396-4c69-8618-d48ede5abfb4"
}
}
}
},
"meta": {}
}
Failure due to active stock at location:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/locations/dedf06bd-4386-4d6c-8d98-9185e97043c1' \
--header 'content-type: application/json' \
A 422 status response looks like this:
{
"errors": [
{
"code": "location_has_stock",
"status": "422",
"title": "Location has stock",
"detail": "This location has active stock",
"meta": {
"item_ids": [
"be5b177f-013c-4e6e-9416-b926daec8154"
]
}
}
]
}
Failure due to a future order:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/locations/819e6245-d499-4b1f-a763-3cedc19dd878' \
--header 'content-type: application/json' \
--data '{}'
A 422 status response looks like this:
{
"errors": [
{
"code": "location_has_orders",
"status": "422",
"title": "Location has orders",
"detail": "This location has running or future orders",
"meta": {
"order_ids": [
"e8864260-3331-414b-930e-30a480632573"
]
}
}
]
}
HTTP Request
DELETE /api/boomerang/locations/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Creating a location
How to create a location and assign it to a cluster:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/locations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "locations",
"attributes": {
"name": "Store",
"code": "STR",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [
"a58e84bb-a789-4c87-bf3c-5dfc246b1aae"
]
}
},
"include": "clusters"
}'
A 201 status response looks like this:
{
"data": {
"id": "0e1555f7-046f-45a8-85a9-d2c70e6a367c",
"type": "locations",
"attributes": {
"created_at": "2024-04-29T09:30:07+00:00",
"updated_at": "2024-04-29T09:30:07+00:00",
"archived": false,
"archived_at": null,
"name": "Store",
"code": "STR",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [
"a58e84bb-a789-4c87-bf3c-5dfc246b1aae"
],
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuisplein 40",
"address2": "Department II",
"city": "Leeuwarden",
"region": "Friesland",
"zipcode": "8911LJ",
"country": "Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
}
},
"relationships": {
"clusters": {
"data": [
{
"type": "clusters",
"id": "a58e84bb-a789-4c87-bf3c-5dfc246b1aae"
}
]
}
}
},
"included": [
{
"id": "a58e84bb-a789-4c87-bf3c-5dfc246b1aae",
"type": "clusters",
"attributes": {
"created_at": "2024-04-29T09:30:07+00:00",
"updated_at": "2024-04-29T09:30:07+00:00",
"name": "North",
"location_ids": [
"0e1555f7-046f-45a8-85a9-d2c70e6a367c"
]
},
"relationships": {
"locations": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/locations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=clusters,main_address |
fields[] |
Array List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the location |
data[attributes][code] |
String Code used to identify the location |
data[attributes][location_type] |
String Determines if the location can be seen in the online webshop. One of rental, internal |
data[attributes][address_line_1] |
String First address line |
data[attributes][address_line_2] |
String Second address line |
data[attributes][zipcode] |
String Address zipcode |
data[attributes][city] |
String Address city |
data[attributes][region] |
String Address region |
data[attributes][country] |
String Address country |
data[attributes][cluster_ids][] |
Array Clusters this location belongs to |
data[attributes][main_address_attributes] |
Hash A hash with the address fields. Use it when creating or updating a location. See address property type for more information |
data[attributes][main_address] |
Hash A hash with the address fields. Use it when fetching a location. See address property type for more information |
Includes
This request accepts the following includes:
clusters
main_address
Fetching a location
How to fetch a single location:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/locations/7c7ea955-c508-4f66-95a2-432d818eb7ee' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "7c7ea955-c508-4f66-95a2-432d818eb7ee",
"type": "locations",
"attributes": {
"created_at": "2024-04-29T09:30:08+00:00",
"updated_at": "2024-04-29T09:30:08+00:00",
"archived": false,
"archived_at": null,
"name": "Warehouse",
"code": "LOC1000085",
"location_type": "rental",
"address_line_1": "Blokhuisplein 40",
"address_line_2": "Department II",
"zipcode": "8911LJ",
"city": "Leeuwarden",
"region": "Friesland",
"country": "Netherlands",
"cluster_ids": [],
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuisplein 40",
"address2": "Department II",
"city": "Leeuwarden",
"region": "Friesland",
"zipcode": "8911LJ",
"country": "Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
}
},
"relationships": {
"clusters": {
"links": {
"related": "api/boomerang/clusters?filter[location_id]=7c7ea955-c508-4f66-95a2-432d818eb7ee"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/locations/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=clusters,main_address |
fields[] |
Array List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
clusters
main_address
Notes
Allows you to leave notes attached to other resources.
Endpoints
POST /api/boomerang/notes
GET /api/boomerang/notes
GET /api/boomerang/notes/{id}
DELETE /api/boomerang/notes/{id}
Fields
Every note has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
body |
String The content of the note |
owner_id |
Uuid ID of the resource the note is attached to |
owner_type |
String The resource type of the owner. One of orders, documents, product_groups, bundles, products, customers, stock_items, users |
employee_id |
Uuid readonlyThe associated Employee |
Relationships
Notes have the following relationships:
| Name | Description |
|---|---|
owner |
Customer, Product, Product group, Stock item, Bundle, Order, Document Associated Owner |
employee |
Employees readonlyAssociated Employee |
Creating a note
How to create a note:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/notes' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "notes",
"attributes": {
"body": "Agreed to give this customer a 20% discount on the next order",
"owner_id": "ad34e77a-8f0c-4133-bd6c-adb8158415f5",
"owner_type": "customers"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "7984793f-6451-4d55-96c3-eb7244786275",
"type": "notes",
"attributes": {
"created_at": "2024-04-29T09:29:50+00:00",
"updated_at": "2024-04-29T09:29:50+00:00",
"body": "Agreed to give this customer a 20% discount on the next order",
"owner_id": "ad34e77a-8f0c-4133-bd6c-adb8158415f5",
"owner_type": "customers",
"employee_id": "3258f348-7a82-42e1-8537-f39fd6eac750"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
},
"employee": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/notes
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,owner |
fields[] |
Array List of comma seperated fields to include ?fields[notes]=created_at,updated_at,body |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][body] |
String The content of the note |
data[attributes][owner_id] |
Uuid ID of the resource the note is attached to |
data[attributes][owner_type] |
String The resource type of the owner. One of orders, documents, product_groups, bundles, products, customers, stock_items, users |
Includes
This request accepts the following includes:
employee
owner
Listing notes
How to fetch a list of notes:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/notes' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "a6e45491-5837-460a-a3f2-6e269be5bbfb",
"type": "notes",
"attributes": {
"created_at": "2024-04-29T09:29:51+00:00",
"updated_at": "2024-04-29T09:29:51+00:00",
"body": "Agreed to give this customer a 20% discount on the next order",
"owner_id": "0a86cc50-462d-427e-83a4-0be9164c80d7",
"owner_type": "customers",
"employee_id": "efe06596-998a-4201-b75c-91efdd181d36"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/0a86cc50-462d-427e-83a4-0be9164c80d7"
}
},
"employee": {
"links": {
"related": "api/boomerang/employees/efe06596-998a-4201-b75c-91efdd181d36"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/notes
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,owner |
fields[] |
Array List of comma seperated fields to include ?fields[notes]=created_at,updated_at,body |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
employee_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
employee
owner
Fetching a note
How to fetch a note:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/notes/06c55be2-0b0b-49e4-a533-a40839164e5b' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "06c55be2-0b0b-49e4-a533-a40839164e5b",
"type": "notes",
"attributes": {
"created_at": "2024-04-29T09:29:52+00:00",
"updated_at": "2024-04-29T09:29:52+00:00",
"body": "Agreed to give this customer a 20% discount on the next order",
"owner_id": "142fd9e0-140d-428a-9ce6-95badba1b58d",
"owner_type": "customers",
"employee_id": "c2bb3b05-18e8-4b36-9bc0-4895f1c3ae9e"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/142fd9e0-140d-428a-9ce6-95badba1b58d"
}
},
"employee": {
"links": {
"related": "api/boomerang/employees/c2bb3b05-18e8-4b36-9bc0-4895f1c3ae9e"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/notes/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,owner |
fields[] |
Array List of comma seperated fields to include ?fields[notes]=created_at,updated_at,body |
Includes
This request accepts the following includes:
employee
owner
Deleting a note
How to delete a note:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/notes/6a130d8b-4027-442a-a2a4-0d1ee7ef986e' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "6a130d8b-4027-442a-a2a4-0d1ee7ef986e",
"type": "notes",
"attributes": {
"created_at": "2024-04-29T09:29:53+00:00",
"updated_at": "2024-04-29T09:29:53+00:00",
"body": "Agreed to give this customer a 20% discount on the next order",
"owner_id": "5a5e2b19-7f22-4621-9a87-a1cc8960d375",
"owner_type": "customers",
"employee_id": "39f2bfd1-f118-4917-9401-b906510e8c8f"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/customers/5a5e2b19-7f22-4621-9a87-a1cc8960d375"
}
},
"employee": {
"links": {
"related": "api/boomerang/employees/39f2bfd1-f118-4917-9401-b906510e8c8f"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/notes/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,owner |
fields[] |
Array List of comma seperated fields to include ?fields[notes]=created_at,updated_at,body |
Includes
This request accepts the following includes:
employee
owner
Operations
Operations are long running tasks that are used to mutate data in bulk or to generate artifacts like exports or documents. Once an operation has been started it cannot be paused or cancelled. However, the status of an operation status can be requested.
An operation requires the operation_data object to be set during creation.
It contains the parameters required for initiating the operation and is validated
strictly. The structure of the object is as follows:
"operation_data": {
"type": "<operation_type>",
"data": { ... }
}
The operation type determines what kind of operation is started. The nested data object has required keys, depending on the type of the operation.
The following operation types are supported:
archivegenerate_barcodegenerate_documentupdate_categoryupdate_tagexportupdate
Archive
Only orders that have the status stopped can be archived.
Orders with any other status will be ignored.
Params
"operation_data": {
"type": "archive",
"data": {
"target_type": "customers",
"target_ids": [
"123",
"456"
]
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | archive |
Required to start this specific operation. |
data.target_type |
String | customers, orders |
The type of resource that should be archived. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should be archived. |
Artifact
No artifacts are generated when archiving.
Generate Barcode
Generates a barcode for all entities that do not have a barcode. Entities that already have a barcode are skipped.
Params
"operation_data": {
"type": "generate_barcode",
"data": {
"target_type": "customers",
"target_ids": [
"123",
"456"
],
"barcode_type": "code128"
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | generate_barcode |
Required to start this specific operation. |
data.target_type |
String | customers, product_groups |
The type of resource that barcodes should be generated for. |
data.for |
String | stock_items, products |
For product_groups only, this indicates whether to add barcodes to either products or stock_items. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should have its barcodes generated. |
data.barcode_type |
String | code39, code93, code128, ean8, ean13, qr_code |
The barcode type that should be generated for all entities. |
Artifact
No artifacts are generated when generating barcodes.
Generate Document
Generates documents in bulk, either by a list of documents or all documents for specific orders.
Params
"operation_data":{
"type": "generate_document",
"data": {
"target_type": "documents",
"target_ids": [
"123",
"456"
],
"document_type": "invoice",
"document_extension": "pdf"
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | generate_document |
Required to start this specific operation. |
data.target_type |
String | orders, documents |
The type of resource that should have its documents generated. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should have its documents generated. |
data.document_type |
String | packing_slip, invoice, quote, contract |
The document type that should be generated for all entities. Only one document type per operation is supported. |
data.document_extension |
String | "pdf" |
The filetype for the generated document. |
Artifact
A zip file with the generated documents of type
Update Category
Updates the categories associated to the entities by mutating them with the action. Other categories already associated to the entity are not modified.
Params
"operation_data": {
"type": "update_category",
"data": {
"target_type": "product_groups",
"target_ids": [
"123",
"456"
],
"action": "add_entities",
"category_ids": [
"789",
"101"
]
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | update_category |
Required to start this specific operation. |
data.target_type |
String | product_groups |
The type of resource that should have the associated categories updated. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should have the associated categories updated. |
data.action |
String | add_entities, remove_entities |
The action that should be executed on the categories of the entities. |
data.category_ids |
Array<Uuid> | [{id}, {id}] |
The primary keys of the categories that should be used with the action. |
Artifact
No artifacts are generated when updating categories.
Update Tag
Updates the tags associated to the entities by mutating them with the action.
Params
"operation_data": {
"type": "update_tag",
"data": {
"target_type": "customers",
"target_ids": [
"123",
"456"
],
"action": "replace",
"tags": [
"Tag A",
"Tag B"
]
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | update_tag |
Required to start this specific operation. |
data.target_type |
String | product_groups, customers, orders |
The type of resource that should have the associated tags updated. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should have the associated tags updated. |
data.action |
String | add, replace, remove, remove_all |
The action that should be executed on the tags of the entities. |
data.tags |
Array |
[{tag}, {tag}] |
The tags that should be used with the action. |
Artifact
No artifacts are generated when updating tags.
Export
Exports data as CSV.
Params
"operation_data": {
"type": "export",
"data": {
"target_type": "customers",
"target_ids": [
"123",
"456"
]
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | export |
Required to start this specific operation. |
data.target_type |
String | product_groups, bundles, customers, orders, documents, report_rentals, report_consumables, 'report_stock_items' |
The type of resource that should have the associated tags updated. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should have the associated tags updated. |
Artifact
A CSV file containing the exported data.
Update
Updates the attribute of all the entities with the new value(s).
Params
"operation_data": {
"type": "update",
"data": {
"target_type": "customers",
"target_ids": [
"123",
"456"
],
"attributes": {
"discount_percentage": 50,
"tax_region_id": "789"
}
}
}
| Key | Type | Possible values | Description |
|---|---|---|---|
type |
String | update |
Required to start this specific operation. |
data.target_type |
String | product_groups, customers |
The type of resource that should be updated. Only one resource per operation is supported. |
data.target_ids |
Array<Uuid> | [{id}, {id}] |
An array of primary keys for the entities that should be updated. |
data.attributes |
Object | {} |
The allowed keys for the attributes are listed below. |
Allowed attribute keys:
Product group
taxabletax_category_idlag_timelead_timeprice_typeprice_periodflat_fee_price_in_centsstructure_price_in_centsbase_price_in_centsprice_structure_idshow_in_storediscountableprice_ruleset_id
Customer
deposit_typedeposit_valuetax_region_iddiscount_percentage
Artifacts
No artifacts are generated when bullk updating resources.
Endpoints
POST /api/boomerang/operations
GET /api/boomerang/operations/{id}
GET /api/boomerang/operations
Fields
Every operation has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
status |
String readonlyOne of scheduled, in_progress, finished, failed |
status_message |
String readonlyA UI-friendly string explaining the status & progress of the operation for the user. |
finished_at |
Datetime readonlyThe moment when the operation is finished executing. |
description |
String readonlyExplains what the operation is doing in a short sentence. |
artifact |
Hash readonlyAn object that returns an optional artifact of the operation. E.g. a file if the operation generates a report. |
error_data |
Array readonlyAn array of strings with errors that happened during execution of the operation. |
error_count |
Integer readonlyThe number of errors that happened during the execution. See error_data. |
employee_id |
Uuid readonlyThe associated Employee |
operation_data |
Hash An object with the params used to initiate the operation. See the description of the operation. |
Relationships
Operations have the following relationships:
| Name | Description |
|---|---|
employee |
Employees readonlyAssociated Employee |
Creating an operation
How to create an operation:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/operations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "operations",
"attributes": {
"operation_data": {
"type": "archive",
"data": {
"target_type": "customers",
"target_ids": [
"123"
]
}
}
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "ef9d4bdd-d8bd-4e62-b428-d26ea2a3c15d",
"type": "operations",
"attributes": {
"created_at": "2024-04-29T09:25:53+00:00",
"updated_at": "2024-04-29T09:25:53+00:00",
"status": "scheduled",
"status_message": null,
"finished_at": null,
"description": "Archiving customers",
"artifact": {
"url": null
},
"error_data": [],
"error_count": 0,
"employee_id": "851a227b-9636-4917-93b6-ee9f3f055477"
},
"relationships": {
"employee": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/operations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee |
fields[] |
Array List of comma seperated fields to include ?fields[operations]=created_at,updated_at,status |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][operation_data] |
Hash An object with the params used to initiate the operation. See the description of the operation. |
Includes
This request accepts the following includes:
employee
Fetching an operation
How to fetch an operation:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/operations/1d62236a-306f-499c-9a6b-fc061e108946' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "1d62236a-306f-499c-9a6b-fc061e108946",
"type": "operations",
"attributes": {
"created_at": "2024-04-29T09:25:55+00:00",
"updated_at": "2024-04-29T09:25:55+00:00",
"status": "scheduled",
"status_message": null,
"finished_at": null,
"description": null,
"artifact": {
"url": null
},
"error_data": [],
"error_count": 0,
"employee_id": "13bc20c4-16d6-4359-92d3-ff96e7bb0ef3"
},
"relationships": {
"employee": {
"links": {
"related": "api/boomerang/employees/13bc20c4-16d6-4359-92d3-ff96e7bb0ef3"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/operations/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee |
fields[] |
Array List of comma seperated fields to include ?fields[operations]=created_at,updated_at,status |
Includes
This request accepts the following includes:
employee
Listing operations
How to fetch a list of operations:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/operations' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "3721fec0-cc0c-4bc4-a1b3-49cf61b9cdf5",
"type": "operations",
"attributes": {
"created_at": "2024-04-29T09:25:56+00:00",
"updated_at": "2024-04-29T09:25:56+00:00",
"status": "scheduled",
"status_message": null,
"finished_at": null,
"description": null,
"artifact": {
"url": null
},
"error_data": [],
"error_count": 0,
"employee_id": "05a51314-cb50-4e42-a593-c102369a2f5d"
},
"relationships": {
"employee": {
"links": {
"related": "api/boomerang/employees/05a51314-cb50-4e42-a593-c102369a2f5d"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/operations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee |
fields[] |
Array List of comma seperated fields to include ?fields[operations]=created_at,updated_at,status |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
finished_at |
Datetime eq, not_eq, gt, gte, lt, lte |
employee_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
employee
Orders
Orders are the heart of every rental operation. They hold configuration and information about:
- The customer
- Pricing and taxes
- Deposits
- Rental period and location
- Shortages
- (Payment) status
- Additional information
An order can have multiple of the following statuses:
newMeans it's in new state.conceptDoes not influence availability.reservedItems on the order will be reserved and not available for other orders.startedMeans that the rental has started. In most cases this means items are out with a customer.stoppedItems are available for other rentals again.canceledThe order is canceled. Items will be available for other rentals.archivedThe order won't show up in default search results.
To transition an Order to the next status, create an OrderStatusTransition.
The actual status of items and stock items can be found in their respective resource (Planning, StockItemPlanning).
When assigning a customer to an order the following settings will be persisted to the order:
tax_region_iddeposit_typedeposit_value
Changing one of the following values can lead to shortages:
starts_atstops_atstart_location_idstop_location_id
A shortage error can be confirmed by setting the confirm_shortage attribute to true. Only if the shortage is within the limit configured in the product group(s). See the Product group resource for more information.
Endpoints
POST /api/boomerang/orders
POST api/boomerang/orders/search
PUT api/boomerang/orders/{id}
GET api/boomerang/orders/{id}
GET api/boomerang/orders
GET api/boomerang/orders/new
Fields
Every order has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
number |
Integer readonlyThe unique order number |
status |
String readonlyOne of new, concept, reserved, started, stopped, archived, canceled |
statuses |
Array readonlyStatus(es) of planned products |
status_counts |
Hash readonlyAn object containing the status counts of planned products { "concept": 0, "reserved": 2, "started": 5, "stopped": 10 } |
starts_at |
Datetime nullableWhen the items on the order become unavailable |
stops_at |
Datetime nullableWhen the items on the order become available again |
deposit_type |
String nullableOne of none, percentage_total, percentage, fixed |
deposit_value |
Float The value to use for deposit_type |
entirely_started |
Boolean readonlyWhether all items on the order are started |
entirely_stopped |
Boolean readonlyWhether all items on the order are stopped |
location_shortage |
Boolean readonlyWhether there is a shortage on the pickup location |
shortage |
Boolean readonlyWhether there is a shortage for this order |
payment_status |
String readonlyOne of paid, partially_paid, overpaid, payment_due, process_deposit |
override_period_restrictions |
Boolean Force free period selection when there are restrictions enabled for the order period picker |
confirm_shortage |
Boolean writeonlyConfirm shortage on update |
has_signed_contract |
Boolean readonlyWhether the order has a signed contract |
tag_list |
Array Case insensitive tag list |
properties |
Hash readonlyA hash containing all basic property values (include properties if you need more detailed information about properties) |
price_in_cents |
Integer readonlySubtotal excl. taxes (excl. deposit) |
grand_total_in_cents |
Integer readonlyTotal excl. taxes (excl. deposit) |
grand_total_with_tax_in_cents |
Integer readonlyAmount incl. taxes (excl. deposit) |
tax_in_cents |
Integer readonlyTotal tax |
discount_in_cents |
Integer readonlyDiscount (incl. or excl. taxes based on tax_strategy) |
coupon_discount_in_cents |
Integer readonlyCoupon discount (incl. or excl. taxes based on tax_strategy |
total_discount_in_cents |
Integer readonlyTotal discount (incl. or excl. taxes based on tax_strategy |
deposit_in_cents |
Integer readonlyDeposit |
deposit_paid_in_cents |
Integer readonlyHow much of the deposit is paid |
deposit_refunded_in_cents |
Integer readonlyHow much of the deposit is refunded |
deposit_held_in_cents |
Integer readonlyAmount of deposit held |
deposit_to_refund_in_cents |
Integer readonlyAmount of deposit (still) to be refunded |
to_be_paid_in_cents |
Integer readonlyAmount that (still) has to be paid |
paid_in_cents |
Integer readonlyHow much was paid |
discount_value |
Float writeonlyThe value to use for discount_type |
discount_type |
String One of percentage, fixed |
discount_percentage |
Float readonlyThe discount percentage applied to this order. May update if order amount changes and type is fixed |
customer_id |
Uuid nullableThe associated Customer |
tax_region_id |
Uuid nullableThe associated Tax region |
coupon_id |
Uuid nullableThe associated Coupon |
start_location_id |
Uuid The associated Start location |
stop_location_id |
Uuid The associated Stop location |
Relationships
Orders have the following relationships:
| Name | Description |
|---|---|
customer |
Customers The associated customer |
tax_region |
Tax regions Associated Tax region |
coupon |
Coupons Associated Coupon |
barcode |
Barcodes Associated Barcode |
properties |
Properties readonlyAssociated Properties |
start_location |
Locations readonlyThe location where the customer will pick up the items. |
stop_location | Locations readonly
The location where the customer will return the items.
When the clusters feature is in use, the stop location needs
to be in the same cluster as the start location.
transfers | Transfers readonly
Associated Transfers
tax_values | Tax values readonly
Associated Tax values
lines | Lines readonly
Associated Lines
stock_item_plannings | Stock item plannings readonly
Associated Stock item plannings
Creating an order
When creating an order, and the following fields are left blank, a sensible default will be picked:
deposit_typeDefault deposit type configured in settings.deposit_valueDefault deposit value configured in settings.start_location_idFirst location in account.stop_location_idFirst location in account.
How to create an order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/orders' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "orders",
"attributes": {
"starts_at": "2024-05-02T09:28:56.462Z",
"stops_at": "2024-06-10T09:28:56.462Z"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "041394c3-8438-4a26-a561-f646bee5cf60",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:28:56+00:00",
"updated_at": "2024-04-29T09:28:56+00:00",
"number": null,
"status": "new",
"statuses": [
"new"
],
"status_counts": {
"new": 0,
"concept": 0,
"reserved": 0,
"started": 0,
"stopped": 0
},
"starts_at": "2024-05-02T09:15:00+00:00",
"stops_at": "2024-06-10T09:15:00+00:00",
"deposit_type": "percentage",
"deposit_value": 100.0,
"entirely_started": true,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "paid",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [],
"properties": {},
"price_in_cents": 0,
"grand_total_in_cents": 0,
"grand_total_with_tax_in_cents": 0,
"tax_in_cents": 0,
"discount_in_cents": 0,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 0,
"deposit_in_cents": 0,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 0.0,
"customer_id": null,
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "2a0d2b55-0358-46c6-8148-be1eaec9c3ba",
"stop_location_id": "2a0d2b55-0358-46c6-8148-be1eaec9c3ba"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/orders
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,customer,coupon |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][starts_at] |
Datetime When the items on the order become unavailable |
data[attributes][stops_at] |
Datetime When the items on the order become available again |
data[attributes][deposit_type] |
String One of none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][override_period_restrictions] |
Boolean Force free period selection when there are restrictions enabled for the order period picker |
data[attributes][confirm_shortage] |
Boolean Confirm shortage on update |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][discount_value] |
Float The value to use for discount_type |
data[attributes][discount_type] |
String One of percentage, fixed |
data[attributes][customer_id] |
Uuid The associated Customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
data[attributes][coupon_id] |
Uuid The associated Coupon |
data[attributes][start_location_id] |
Uuid The associated Start location |
data[attributes][stop_location_id] |
Uuid The associated Stop location |
Includes
This request accepts the following includes:
barcode
customer =>
merge_suggestion_customer
properties
coupon
lines
properties
start_location
stop_location
tax_region
tax_values
transfers
Searching orders
Use advanced search to make logical filter groups with and/or operators.
How to search for orders:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/orders/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"orders": "id"
},
"filter": {
"conditions": {
"operator": "and",
"attributes": [
{
"operator": "or",
"attributes": [
{
"starts_at": {
"gte": "2024-04-30T09:29:03Z",
"lte": "2024-05-03T09:29:03Z"
}
},
{
"stops_at": {
"gte": "2024-04-30T09:29:03Z",
"lte": "2024-05-03T09:29:03Z"
}
}
]
},
{
"operator": "and",
"attributes": [
{
"deposit_type": "none"
},
{
"payment_status": "paid"
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "cc9ba7e6-8ca2-49c0-8318-6e278ef16791"
},
{
"id": "831c60e2-0b78-4bec-bc7a-7dd9f4552e93"
}
]
}
HTTP Request
POST api/boomerang/orders/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,coupon,start_location |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
number |
Integer eq, not_eq, gt, gte, lt, lte |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
statuses |
Array eq, not_eq |
status_counts |
Hash eq |
starts_at |
Datetime eq, not_eq, gt, gte, lt, lte |
stops_at |
Datetime eq, not_eq, gt, gte, lt, lte |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
location_shortage |
Boolean eq |
shortage |
Boolean eq |
payment_status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
has_signed_contract |
Boolean eq |
tag_list |
String eq |
price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_with_tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
coupon_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
total_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_refunded_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_held_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_to_refund_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
to_be_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_value |
Float eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
coupon_id |
Uuid eq, not_eq |
start_location_id |
Uuid eq, not_eq |
stop_location_id |
Uuid eq, not_eq |
q |
String eq |
item_id |
Uuid eq |
stock_item_id |
Uuid eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
payment_status |
Array count |
tag_list |
Array count |
status |
Array count |
statuses |
Array count |
shortage |
Array count |
location_shortage |
Array count |
deposit_type |
Array count |
price_in_cents |
Array sum, maximum, minimum, average |
grand_total_in_cents |
Array sum, maximum, minimum, average |
grand_total_with_tax_in_cents |
Array sum, maximum, minimum, average |
tax_in_cents |
Array sum, maximum, minimum, average |
discount_in_cents |
Array sum, maximum, minimum, average |
coupon_discount_in_cents |
Array sum, maximum, minimum, average |
total_discount_in_cents |
Array sum, maximum, minimum, average |
deposit_in_cents |
Array sum, maximum, minimum, average |
deposit_paid_in_cents |
Array sum, maximum, minimum, average |
deposit_refunded_in_cents |
Array sum, maximum, minimum, average |
deposit_held_in_cents |
Array sum, maximum, minimum, average |
deposit_to_refund_in_cents |
Array sum, maximum, minimum, average |
to_be_paid_in_cents |
Array sum, maximum, minimum, average |
paid_in_cents |
Array sum, maximum, minimum, average |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
customer
coupon
start_location
stop_location
properties
Updating an order
When updating a customer on an order the following settings will be applied and prices will be calculated accordingly:
discount_percentagedeposit_typedeposit_valuetax_region_id
How to assign a (new) customer to an order:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/orders/b53b8f73-d6e1-400f-83ec-777389bda1b5' \
--header 'content-type: application/json' \
--data '{
"fields": {
"orders": "customer_id,tax_region_id,price_in_cents,grand_total_with_tax_in_cents,to_be_paid_in_cents"
},
"data": {
"id": "b53b8f73-d6e1-400f-83ec-777389bda1b5",
"type": "orders",
"attributes": {
"customer_id": "8ec0a12b-0561-4c31-adab-8b541e69f951"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b53b8f73-d6e1-400f-83ec-777389bda1b5",
"type": "orders",
"attributes": {
"price_in_cents": 80250,
"grand_total_with_tax_in_cents": 97103,
"to_be_paid_in_cents": 197103,
"customer_id": "8ec0a12b-0561-4c31-adab-8b541e69f951",
"tax_region_id": null
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
How to update the deposit_type:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/orders/0b71ba44-4d99-4cfa-adef-2f0dc8534dd1' \
--header 'content-type: application/json' \
--data '{
"fields": {
"orders": "deposit_type,deposit_in_cents,to_be_paid_in_cents,deposit_paid_in_cents"
},
"data": {
"id": "0b71ba44-4d99-4cfa-adef-2f0dc8534dd1",
"type": "orders",
"attributes": {
"deposit_type": "percentage"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "0b71ba44-4d99-4cfa-adef-2f0dc8534dd1",
"type": "orders",
"attributes": {
"deposit_type": "percentage",
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"to_be_paid_in_cents": 97392
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Updating stops_at resulting in a shortage:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/orders/73484451-694c-4bd8-87c5-6505f6601e76' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "73484451-694c-4bd8-87c5-6505f6601e76",
"type": "orders",
"attributes": {
"stops_at": "1980-05-04T12:00:00.000Z"
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "stock_item_specified",
"status": "422",
"title": "Stock item specified",
"detail": "One or more items are not available",
"meta": {
"warning": [],
"blocking": [
{
"reason": "stock_item_specified",
"item_id": "615ee72c-19fc-4e61-9623-4062c5142c83",
"unavailable": [
"d2b3008b-1eeb-4765-b40c-4ea201047211"
],
"available": [
"cf55ceb4-01f7-4993-8620-7203e7e7f4ad"
]
}
]
}
}
]
}
HTTP Request
PUT api/boomerang/orders/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,customer,coupon |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][starts_at] |
Datetime When items become unavailable, changing this value may result in shortages |
data[attributes][stops_at] |
Datetime When items become available, changing this value may result in shortages |
data[attributes][deposit_type] |
String One of none, percentage_total, percentage, fixed |
data[attributes][deposit_value] |
Float The value to use for deposit_type |
data[attributes][override_period_restrictions] |
Boolean Force free period selection when there are restrictions enabled for the order period picker |
data[attributes][confirm_shortage] |
Boolean Confirm shortage on update |
data[attributes][tag_list][] |
Array Case insensitive tag list |
data[attributes][discount_value] |
Float The value to use for discount_type |
data[attributes][discount_type] |
String One of percentage, fixed |
data[attributes][customer_id] |
Uuid The associated Customer |
data[attributes][tax_region_id] |
Uuid The associated Tax region |
data[attributes][coupon_id] |
Uuid The associated Coupon |
data[attributes][start_location_id] |
Uuid The associated Start location |
data[attributes][stop_location_id] |
Uuid The associated Stop location |
Includes
This request accepts the following includes:
barcode
customer =>
merge_suggestion_customer
properties
coupon
lines
properties
start_location
stop_location
tax_region
tax_values
transfers
Fetching an order
How to fetch an order:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/orders/c0e393a6-72a6-4d88-ba44-afa545d43bd6' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "c0e393a6-72a6-4d88-ba44-afa545d43bd6",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:29:18+00:00",
"updated_at": "2024-04-29T09:29:21+00:00",
"number": 1,
"status": "reserved",
"statuses": [
"reserved"
],
"status_counts": {
"concept": 0,
"new": 0,
"reserved": 1,
"started": 0,
"stopped": 0
},
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"deposit_type": "percentage",
"deposit_value": 10.0,
"entirely_started": false,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "payment_due",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [
"webshop"
],
"properties": {},
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"tax_in_cents": 15167,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 10.0,
"customer_id": "26236839-477c-42a0-b369-2f7bc1e6fb31",
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "873f1561-4c7b-461c-93dd-a4f38521014a",
"stop_location_id": "873f1561-4c7b-461c-93dd-a4f38521014a"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/26236839-477c-42a0-b369-2f7bc1e6fb31"
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6&filter[owner_type]=orders"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6&filter[owner_type]=orders"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/873f1561-4c7b-461c-93dd-a4f38521014a"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/873f1561-4c7b-461c-93dd-a4f38521014a"
}
},
"transfers": {
"links": {
"related": "api/boomerang/transfers?filter[order_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6&filter[owner_type]=orders"
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6&filter[owner_type]=orders"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[order_id]=c0e393a6-72a6-4d88-ba44-afa545d43bd6"
}
}
}
},
"meta": {}
}
HTTP Request
GET api/boomerang/orders/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,customer,coupon |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
Includes
This request accepts the following includes:
barcode
customer =>
merge_suggestion_customer
properties
coupon
lines
properties
start_location
stop_location
tax_region
tax_values
transfers
Listing orders
How to fetch a list of orders:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/orders' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "126e3003-e0b8-4dba-915a-66893a757c90",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:29:22+00:00",
"updated_at": "2024-04-29T09:29:24+00:00",
"number": 1,
"status": "reserved",
"statuses": [
"reserved"
],
"status_counts": {
"concept": 0,
"new": 0,
"reserved": 1,
"started": 0,
"stopped": 0
},
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"deposit_type": "percentage",
"deposit_value": 10.0,
"entirely_started": false,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "payment_due",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [
"webshop"
],
"properties": {},
"price_in_cents": 80250,
"grand_total_in_cents": 72225,
"grand_total_with_tax_in_cents": 87392,
"tax_in_cents": 15167,
"discount_in_cents": 8025,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 8025,
"deposit_in_cents": 10000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 97392,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 10.0,
"customer_id": "6c599314-d3cc-48ff-82d2-42d4d935d26a",
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "0b4b7117-2cc8-48db-b322-64e5069b0c1f",
"stop_location_id": "0b4b7117-2cc8-48db-b322-64e5069b0c1f"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/6c599314-d3cc-48ff-82d2-42d4d935d26a"
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=126e3003-e0b8-4dba-915a-66893a757c90&filter[owner_type]=orders"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=126e3003-e0b8-4dba-915a-66893a757c90&filter[owner_type]=orders"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/0b4b7117-2cc8-48db-b322-64e5069b0c1f"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/0b4b7117-2cc8-48db-b322-64e5069b0c1f"
}
},
"transfers": {
"links": {
"related": "api/boomerang/transfers?filter[order_id]=126e3003-e0b8-4dba-915a-66893a757c90"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=126e3003-e0b8-4dba-915a-66893a757c90&filter[owner_type]=orders"
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=126e3003-e0b8-4dba-915a-66893a757c90&filter[owner_type]=orders"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[order_id]=126e3003-e0b8-4dba-915a-66893a757c90"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET api/boomerang/orders
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,coupon,start_location |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
number |
Integer eq, not_eq, gt, gte, lt, lte |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
statuses |
Array eq, not_eq |
status_counts |
Hash eq |
starts_at |
Datetime eq, not_eq, gt, gte, lt, lte |
stops_at |
Datetime eq, not_eq, gt, gte, lt, lte |
deposit_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
location_shortage |
Boolean eq |
shortage |
Boolean eq |
payment_status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
has_signed_contract |
Boolean eq |
tag_list |
String eq |
price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
grand_total_with_tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
tax_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
coupon_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
total_discount_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_refunded_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_held_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
deposit_to_refund_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
to_be_paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
paid_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discount_value |
Float eq, not_eq, gt, gte, lt, lte |
discount_percentage |
Float eq, not_eq, gt, gte, lt, lte |
customer_id |
Uuid eq, not_eq |
tax_region_id |
Uuid eq, not_eq |
coupon_id |
Uuid eq, not_eq |
start_location_id |
Uuid eq, not_eq |
stop_location_id |
Uuid eq, not_eq |
q |
String eq |
item_id |
Uuid eq |
stock_item_id |
Uuid eq |
conditions |
Hash eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
payment_status |
Array count |
tag_list |
Array count |
status |
Array count |
statuses |
Array count |
shortage |
Array count |
location_shortage |
Array count |
deposit_type |
Array count |
price_in_cents |
Array sum, maximum, minimum, average |
grand_total_in_cents |
Array sum, maximum, minimum, average |
grand_total_with_tax_in_cents |
Array sum, maximum, minimum, average |
tax_in_cents |
Array sum, maximum, minimum, average |
discount_in_cents |
Array sum, maximum, minimum, average |
coupon_discount_in_cents |
Array sum, maximum, minimum, average |
total_discount_in_cents |
Array sum, maximum, minimum, average |
deposit_in_cents |
Array sum, maximum, minimum, average |
deposit_paid_in_cents |
Array sum, maximum, minimum, average |
deposit_refunded_in_cents |
Array sum, maximum, minimum, average |
deposit_held_in_cents |
Array sum, maximum, minimum, average |
deposit_to_refund_in_cents |
Array sum, maximum, minimum, average |
to_be_paid_in_cents |
Array sum, maximum, minimum, average |
paid_in_cents |
Array sum, maximum, minimum, average |
discount_percentage |
Array maximum, minimum, average |
Includes
This request accepts the following includes:
customer
coupon
start_location
stop_location
properties
New order
Returns an existing or new order for the current employee.
How to fetch a new order:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/orders/new' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "f15ebc4c-abc9-4212-9684-9f025f5b34df",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:29:29+00:00",
"updated_at": "2024-04-29T09:29:29+00:00",
"number": null,
"status": "new",
"statuses": [
"new"
],
"status_counts": {
"new": 0,
"concept": 0,
"reserved": 0,
"started": 0,
"stopped": 0
},
"starts_at": null,
"stops_at": null,
"deposit_type": "percentage",
"deposit_value": 100.0,
"entirely_started": true,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "paid",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [],
"properties": {},
"price_in_cents": 0,
"grand_total_in_cents": 0,
"grand_total_with_tax_in_cents": 0,
"tax_in_cents": 0,
"discount_in_cents": 0,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 0,
"deposit_in_cents": 0,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 0.0,
"customer_id": null,
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "e39e8f05-939a-4a56-bce2-ced30d8ff026",
"stop_location_id": "e39e8f05-939a-4a56-bce2-ced30d8ff026"
},
"relationships": {
"customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df&filter[owner_type]=orders"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df&filter[owner_type]=orders"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/e39e8f05-939a-4a56-bce2-ced30d8ff026"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/e39e8f05-939a-4a56-bce2-ced30d8ff026"
}
},
"transfers": {
"links": {
"related": "api/boomerang/transfers?filter[order_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df&filter[owner_type]=orders"
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df&filter[owner_type]=orders"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[order_id]=f15ebc4c-abc9-4212-9684-9f025f5b34df"
}
}
}
},
"meta": {}
}
HTTP Request
GET api/boomerang/orders/new
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,customer,coupon |
fields[] |
Array List of comma seperated fields to include ?fields[orders]=created_at,updated_at,number |
Includes
This request accepts the following includes:
barcode
customer =>
merge_suggestion_customer
properties
coupon
lines
properties
start_location
stop_location
tax_region
tax_values
transfers
Order bookings
Add products, bundles and specific stock items to an order.
Items can be added quantitatively or, for trackable products, specific stock items can be specified. Specifying stock items is not required on order_booking; they can also be defined when transitioning the order status to a started state.
Adding items quantitatively:
"items": [
{
"type": "products",
"id": "69a6ac18-244e-4b1e-b2e1-c88d155b51e5",
"quantity": 10
}
]
Adding specific stock items:
"items": [
{
"type": "products",
"id": "a2d96edf-7d8b-42de-9897-e5aee335f3ca",
"quantity": 3,
"stock_item_ids": [
"1456d221-029c-42ad-abcd-ad8d70c9e3f0",
"ee64a622-3ac5-4859-a582-b3467b8027e8"
]
}
]
Adding a bundle without specifying variations:
"items": [
{
"type": "bundles",
"id": "9bf34d16-2144-45a5-8461-ebae7bf0f4ca",
"quantity": 3,
"products": [] // Nothing to choose for the customer
}
]
Adding a bundle and specifying a variation (for product that has variations)
"items": [
{
"type": "bundles",
"id": "9bf34d16-2144-45a5-8461-ebae7bf0f4ca",
"products": [
{
"type": "products",
"bundle_item_id": "1456d221-029c-42ad-abcd-ad8d70c9e3f0",
"id": "ee64a622-3ac5-4859-a582-b3467b8027e8"
}
}
}
]
When an order booking is successful, the price and status information of the order will be updated, and the following resources are created:
- Plannings Quantitative data about the planning of an item.
- Stock item plannings Planning for specific stock items (when stock items are specified).
- Lines Individual elements on order, which in the case of order bookings contain price and planning information.
Note that these newly created or updated resources can be included in the response. Also, lines will automatically be synced with a proforma invoice (and prorated if there was already a finalized invoice for this order).
Adding items (and stock items) to a reserved order can result in shortage errors. There are three kinds of errors:
- Stock item specified This Means that one of the specified stock items is not available.
- Blocking shortage A blocking shortage occurs when an item is quantitively unavailable and exceeds its
shortage_limit. - Shortage warning Warns about a quantitive shortage for an item that is within limits of its
shortage_limit. The action can be retried with by settingconfirm_shortagetotrue.
Fields
Every order booking has the following fields:
| Name | Description |
|---|---|
id |
Uuid |
items |
Array writeonlyArray with details about the items (and stock item) to add to the order |
confirm_shortage |
Boolean writeonlyWhether to confirm the shortage if they are non-blocking |
order_id |
Uuid The associated Order |
Relationships
Order bookings have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
lines |
Lines readonlyAssociated Lines |
plannings |
Plannings readonlyAssociated Plannings |
stock_item_plannings |
Stock item plannings readonlyAssociated Stock item plannings |
Creating an order booking
How to add products to an order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_bookings' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_bookings",
"attributes": {
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"items": [
{
"type": "products",
"id": "3706d47c-4d0e-4a7c-a5f6-f31fe8905bc5",
"stock_item_ids": [
"a75c5906-8b2e-45c6-8835-53cd4ca23de3",
"4234021f-c1da-4021-b340-712f76bf0fc4",
"b688f481-eed6-4c22-8e87-3e7efda75171"
]
},
{
"type": "products",
"id": "1bfe4c79-949a-48c4-b219-3110c4c59370",
"quantity": 1
}
]
}
},
"include": "order,lines,plannings,stock_item_plannings"
}'
A 201 status response looks like this:
{
"data": {
"id": "b032dc87-14c2-5cfd-8972-0de35b0d20ab",
"type": "order_bookings",
"attributes": {
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99"
},
"relationships": {
"order": {
"data": {
"type": "orders",
"id": "88411be1-7e89-4d98-b76b-379434b30e99"
}
},
"lines": {
"data": [
{
"type": "lines",
"id": "60615158-1877-48c5-9333-7110c4c766d9"
},
{
"type": "lines",
"id": "2be9bb1c-7001-4f6d-bccd-4d07bfca5ac1"
}
]
},
"plannings": {
"data": [
{
"type": "plannings",
"id": "47407f0c-be9b-4dd6-85d5-300a96761a92"
},
{
"type": "plannings",
"id": "b3dc4fc1-025c-412b-ab7d-7e4e556df950"
}
]
},
"stock_item_plannings": {
"data": [
{
"type": "stock_item_plannings",
"id": "bdcc5ed2-e3a7-4017-b362-5e16959ea6bb"
},
{
"type": "stock_item_plannings",
"id": "b5491be3-d6ac-4b2f-88b7-6469f219ce55"
},
{
"type": "stock_item_plannings",
"id": "d3a5cdfe-7736-4ec3-9b57-64c364634875"
}
]
}
}
},
"included": [
{
"id": "88411be1-7e89-4d98-b76b-379434b30e99",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:30:58+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"number": 1,
"status": "reserved",
"statuses": [
"reserved"
],
"status_counts": {
"concept": 0,
"new": 0,
"reserved": 5,
"started": 0,
"stopped": 0
},
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"deposit_type": "percentage",
"deposit_value": 10.0,
"entirely_started": false,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "payment_due",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [
"webshop"
],
"properties": {},
"price_in_cents": 256800,
"grand_total_in_cents": 231120,
"grand_total_with_tax_in_cents": 279655,
"tax_in_cents": 48535,
"discount_in_cents": 25680,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 25680,
"deposit_in_cents": 35000,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 314655,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 10.0,
"customer_id": "c48767ff-a218-4152-a260-783c2c3fe4ef",
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456",
"stop_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
{
"id": "60615158-1877-48c5-9333-7110c4c766d9",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"title": "iPad Pro",
"extra_information": "Comes with a case",
"quantity": 3,
"original_price_each_in_cents": 29000,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 32100,
"price_in_cents": 96300,
"display_price_in_cents": 96300,
"position": 2,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": {
"charge": {
"from": "1980-04-02T00:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"adjustments": [
{
"name": "Pickup day"
},
{
"name": "Return day"
}
]
},
"price": [
{
"name": "High-Season",
"charge_length": 1339200,
"multiplier": "0.2",
"price_in_cents": 3100,
"adjustments": [
{
"from": "1980-04-15T12:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"charge_length": 1339200,
"charge_label": "372 hours",
"price_in_cents": 3100
}
],
"stacked": false
}
]
},
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"item_id": "3706d47c-4d0e-4a7c-a5f6-f31fe8905bc5",
"tax_category_id": "94b291a0-f07c-456d-a84d-a8746e077777",
"planning_id": "47407f0c-be9b-4dd6-85d5-300a96761a92",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
{
"id": "2be9bb1c-7001-4f6d-bccd-4d07bfca5ac1",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"title": "Macbook Pro",
"extra_information": "Comes with a mouse",
"quantity": 1,
"original_price_each_in_cents": 72500,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 80250,
"price_in_cents": 80250,
"display_price_in_cents": 80250,
"position": 3,
"charge_label": "29 days",
"charge_length": 2505600,
"price_rule_values": {
"charge": {
"from": "1980-04-02T00:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"adjustments": [
{
"name": "Pickup day"
},
{
"name": "Return day"
}
]
},
"price": [
{
"name": "High-Season",
"charge_length": 1339200,
"multiplier": "0.2",
"price_in_cents": 7750,
"adjustments": [
{
"from": "1980-04-15T12:00:00.000Z",
"till": "1980-05-01T00:00:00.000Z",
"charge_length": 1339200,
"charge_label": "372 hours",
"price_in_cents": 3100
}
],
"stacked": false
}
]
},
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"item_id": "1bfe4c79-949a-48c4-b219-3110c4c59370",
"tax_category_id": "94b291a0-f07c-456d-a84d-a8746e077777",
"planning_id": "b3dc4fc1-025c-412b-ab7d-7e4e556df950",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
{
"id": "47407f0c-be9b-4dd6-85d5-300a96761a92",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"quantity": 3,
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"reserved_from": "1980-04-01T12:00:00+00:00",
"reserved_till": "1980-05-01T12:00:00+00:00",
"reserved": true,
"started": 0,
"stopped": 0,
"location_shortage_amount": 0,
"shortage_amount": 0,
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"item_id": "3706d47c-4d0e-4a7c-a5f6-f31fe8905bc5",
"start_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456",
"stop_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456",
"parent_planning_id": null,
"price_tile_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"order_line": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"parent_planning": {
"meta": {
"included": false
}
},
"nested_plannings": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
}
}
},
{
"id": "b3dc4fc1-025c-412b-ab7d-7e4e556df950",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"quantity": 1,
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"reserved_from": "1980-04-01T12:00:00+00:00",
"reserved_till": "1980-05-01T12:00:00+00:00",
"reserved": true,
"started": 0,
"stopped": 0,
"location_shortage_amount": 0,
"shortage_amount": 0,
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99",
"item_id": "1bfe4c79-949a-48c4-b219-3110c4c59370",
"start_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456",
"stop_location_id": "a24671f2-e9f7-4c62-ae31-9af3be2df456",
"parent_planning_id": null,
"price_tile_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"order_line": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"parent_planning": {
"meta": {
"included": false
}
},
"nested_plannings": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
}
}
},
{
"id": "bdcc5ed2-e3a7-4017-b362-5e16959ea6bb",
"type": "stock_item_plannings",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"reserved": true,
"started": false,
"stopped": false,
"stock_item_id": "a75c5906-8b2e-45c6-8835-53cd4ca23de3",
"planning_id": "47407f0c-be9b-4dd6-85d5-300a96761a92",
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99"
},
"relationships": {
"stock_item": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"order": {
"meta": {
"included": false
}
}
}
},
{
"id": "b5491be3-d6ac-4b2f-88b7-6469f219ce55",
"type": "stock_item_plannings",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"reserved": true,
"started": false,
"stopped": false,
"stock_item_id": "4234021f-c1da-4021-b340-712f76bf0fc4",
"planning_id": "47407f0c-be9b-4dd6-85d5-300a96761a92",
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99"
},
"relationships": {
"stock_item": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"order": {
"meta": {
"included": false
}
}
}
},
{
"id": "d3a5cdfe-7736-4ec3-9b57-64c364634875",
"type": "stock_item_plannings",
"attributes": {
"created_at": "2024-04-29T09:31:01+00:00",
"updated_at": "2024-04-29T09:31:01+00:00",
"archived": false,
"archived_at": null,
"reserved": true,
"started": false,
"stopped": false,
"stock_item_id": "b688f481-eed6-4c22-8e87-3e7efda75171",
"planning_id": "47407f0c-be9b-4dd6-85d5-300a96761a92",
"order_id": "88411be1-7e89-4d98-b76b-379434b30e99"
},
"relationships": {
"stock_item": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"order": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
Adding products to an order resulting in a shortage:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_bookings' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_bookings",
"attributes": {
"order_id": "761b15ac-18ad-4099-a63f-9caba4745ba3",
"items": [
{
"type": "products",
"id": "ac9aa2cb-92f3-4ea9-a5b2-0880b527d098",
"quantity": 10
},
{
"type": "products",
"id": "3d0037a4-fef9-4044-954a-4d7506381547",
"stock_item_ids": [
"213e5d6b-b3cd-494d-a2ef-53b1a5475165",
"19655734-65b6-4984-93cf-1a39ff64b9f9"
]
}
]
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "fulfillment_request_invalid",
"status": "422",
"title": "Fulfillment request invalid",
"detail": "invalid request",
"meta": {
"messages": [
"stock_item_id 213e5d6b-b3cd-494d-a2ef-53b1a5475165 has already been booked on this order"
]
}
}
]
}
How to add a bundle with unspecified variation to an order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_bookings' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_bookings",
"attributes": {
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"items": [
{
"type": "bundles",
"id": "aaceed13-acb4-4cc7-88a8-004a3e4eade7",
"products": [
{
"type": "products",
"bundle_item_id": "c9adaf1c-6be8-45eb-a228-48c3647aa8d6",
"id": "f626c63a-5c4f-4394-b25c-d6bd8e6c4001"
}
]
}
]
}
},
"include": "order,lines,plannings,stock_item_plannings"
}'
A 201 status response looks like this:
{
"data": {
"id": "e593d757-4729-525a-91ad-eb990b95be08",
"type": "order_bookings",
"attributes": {
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187"
},
"relationships": {
"order": {
"data": {
"type": "orders",
"id": "75e728d3-bbc5-48e6-828f-ea0010240187"
}
},
"lines": {
"data": [
{
"type": "lines",
"id": "acf0811b-c5f9-4ebd-b62c-1453351652e3"
},
{
"type": "lines",
"id": "3d769ff1-daa6-4882-b547-17e428edbe38"
}
]
},
"plannings": {
"data": [
{
"type": "plannings",
"id": "6116fa7a-0248-4ea3-8ba8-4ffd53f94276"
},
{
"type": "plannings",
"id": "af3acbb2-924e-4418-aac0-4a76693099a6"
}
]
},
"stock_item_plannings": {
"data": []
}
}
},
"included": [
{
"id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:31:10+00:00",
"updated_at": "2024-04-29T09:31:11+00:00",
"number": null,
"status": "new",
"statuses": [
"new"
],
"status_counts": {
"concept": 0,
"new": 1,
"reserved": 0,
"started": 0,
"stopped": 0
},
"starts_at": "2024-04-27T09:30:00+00:00",
"stops_at": "2024-05-01T09:30:00+00:00",
"deposit_type": "percentage",
"deposit_value": 100.0,
"entirely_started": false,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "paid",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [],
"properties": {},
"price_in_cents": 0,
"grand_total_in_cents": 0,
"grand_total_with_tax_in_cents": 0,
"tax_in_cents": 0,
"discount_in_cents": 0,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 0,
"deposit_in_cents": 0,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 0.0,
"customer_id": null,
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f",
"stop_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
{
"id": "acf0811b-c5f9-4ebd-b62c-1453351652e3",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:31:11+00:00",
"updated_at": "2024-04-29T09:31:11+00:00",
"archived": false,
"archived_at": null,
"title": "Bundle 8",
"extra_information": null,
"quantity": 1,
"original_price_each_in_cents": null,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 0,
"price_in_cents": 0,
"display_price_in_cents": 0,
"position": 1,
"charge_label": "4 days",
"charge_length": 345600,
"price_rule_values": null,
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"item_id": "aaceed13-acb4-4cc7-88a8-004a3e4eade7",
"tax_category_id": null,
"planning_id": "6116fa7a-0248-4ea3-8ba8-4ffd53f94276",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": null,
"owner_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
{
"id": "3d769ff1-daa6-4882-b547-17e428edbe38",
"type": "lines",
"attributes": {
"created_at": "2024-04-29T09:31:11+00:00",
"updated_at": "2024-04-29T09:31:11+00:00",
"archived": false,
"archived_at": null,
"title": "Product 1000074 - red",
"extra_information": null,
"quantity": 1,
"original_price_each_in_cents": 0,
"original_charge_length": null,
"original_charge_label": null,
"price_each_in_cents": 0,
"price_in_cents": 0,
"display_price_in_cents": 0,
"position": 1,
"charge_label": "4 days",
"charge_length": 345600,
"price_rule_values": null,
"discountable": true,
"taxable": true,
"line_type": "charge",
"relevant": true,
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"item_id": "f626c63a-5c4f-4394-b25c-d6bd8e6c4001",
"tax_category_id": null,
"planning_id": "af3acbb2-924e-4418-aac0-4a76693099a6",
"price_structure_id": null,
"price_tile_id": null,
"parent_line_id": "acf0811b-c5f9-4ebd-b62c-1453351652e3",
"owner_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"owner_type": "orders"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"planning": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
},
"parent_line": {
"meta": {
"included": false
}
},
"nested_lines": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
{
"id": "6116fa7a-0248-4ea3-8ba8-4ffd53f94276",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:31:11+00:00",
"updated_at": "2024-04-29T09:31:11+00:00",
"archived": false,
"archived_at": null,
"quantity": 1,
"starts_at": "2024-04-27T09:30:00+00:00",
"stops_at": "2024-05-01T09:30:00+00:00",
"reserved_from": "2024-04-27T09:30:00+00:00",
"reserved_till": "2024-05-01T09:30:00+00:00",
"reserved": false,
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"item_id": "aaceed13-acb4-4cc7-88a8-004a3e4eade7",
"start_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f",
"stop_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f",
"price_tile_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"order_line": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"parent_planning": {
"meta": {
"included": false
}
},
"nested_plannings": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
}
}
},
{
"id": "af3acbb2-924e-4418-aac0-4a76693099a6",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:31:11+00:00",
"updated_at": "2024-04-29T09:31:11+00:00",
"archived": false,
"archived_at": null,
"quantity": 1,
"starts_at": "2024-04-27T09:30:00+00:00",
"stops_at": "2024-05-01T09:30:00+00:00",
"reserved_from": "2024-04-27T09:30:00+00:00",
"reserved_till": "2024-05-01T09:30:00+00:00",
"reserved": false,
"started": 0,
"stopped": 0,
"location_shortage_amount": 0,
"shortage_amount": 0,
"order_id": "75e728d3-bbc5-48e6-828f-ea0010240187",
"item_id": "f626c63a-5c4f-4394-b25c-d6bd8e6c4001",
"start_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f",
"stop_location_id": "5d0f7540-9a0d-476f-9fd0-ce0bd9ec3d2f",
"parent_planning_id": "6116fa7a-0248-4ea3-8ba8-4ffd53f94276",
"price_tile_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"item": {
"meta": {
"included": false
}
},
"order_line": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"parent_planning": {
"meta": {
"included": false
}
},
"nested_plannings": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
},
"price_tile": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/order_bookings
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,lines,plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_bookings]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][id] |
Uuid |
data[attributes][items][] |
Array Array with details about the items (and stock item) to add to the order |
data[attributes][confirm_shortage] |
Boolean Whether to confirm the shortage if they are non-blocking |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
lines =>
item =>
photo
plannings
stock_item_plannings
Order duplications
Duplicates an Order with a selectable subset of fields and associations.
Fields
Every order duplication has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
custom_lines |
Boolean Indicates if custom Lines should be copied from the original Order. |
customer |
Boolean Indicates if the Customer should be copied from the original Order. |
dates |
Boolean Indicates if the rental dates should be copied from the original Order. |
discount |
Boolean Indicates if discounts should be copied from the original Order. |
properties |
Boolean Indicates if properties should be copied from the original Order. |
stock_item_plannings |
Boolean Indicates if planned stock items should be copied from the original Order. |
tags |
Boolean Indicates if tags should be copied from the original Order. |
deposit |
String current copies the desposit from the original Order, default resets the deposit to the default for the company or customer, none removes the deposit. |
original_order_id |
Uuid The associated Original order |
new_order_id |
Uuid readonlyThe associated New order |
Relationships
Order duplications have the following relationships:
| Name | Description |
|---|---|
original_order |
Orders Associated Original order |
new_order |
Orders readonlyAssociated New order |
Duplicate
Duplicate an Order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_duplications' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_duplications",
"attributes": {
"original_order_id": "06e72606-e122-4f98-a125-2b417af937be",
"custom_lines": true,
"customer": true,
"dates": true,
"deposit": "current",
"discount": true,
"properties": true,
"stock_item_plannings": true,
"tags": true
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "f800cf5e-42ea-5150-a609-ca0c1d24a841",
"type": "order_duplications",
"attributes": {
"custom_lines": true,
"customer": true,
"dates": true,
"discount": true,
"properties": true,
"stock_item_plannings": true,
"tags": true,
"deposit": "current",
"original_order_id": "06e72606-e122-4f98-a125-2b417af937be",
"new_order_id": "d6a08ed7-60ef-4ee8-ac22-c5c72cbb637b"
},
"relationships": {
"original_order": {
"meta": {
"included": false
}
},
"new_order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_duplications
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=original_order,new_order |
fields[] |
Array List of comma seperated fields to include ?fields[order_duplications]=custom_lines,customer,dates |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][custom_lines] |
Boolean Indicates if custom Lines should be copied from the original Order. |
data[attributes][customer] |
Boolean Indicates if the Customer should be copied from the original Order. |
data[attributes][dates] |
Boolean Indicates if the rental dates should be copied from the original Order. |
data[attributes][discount] |
Boolean Indicates if discounts should be copied from the original Order. |
data[attributes][properties] |
Boolean Indicates if properties should be copied from the original Order. |
data[attributes][stock_item_plannings] |
Boolean Indicates if planned stock items should be copied from the original Order. |
data[attributes][tags] |
Boolean Indicates if tags should be copied from the original Order. |
data[attributes][deposit] |
String current copies the desposit from the original Order, default resets the deposit to the default for the company or customer, none removes the deposit. |
data[attributes][original_order_id] |
Uuid The associated Original order |
Includes
This request accepts the following includes:
original_order
new_order
Order fulfilments
Takes an Order through the fulfilment process.
Limitations
Not all types of actions can be combined in the same request.
Actions
Book a Bundle
Books a Bundle on an Order. For each unspecified BundleItem a Product variation needs to be selected. Specified BundleItems are automatically booked. These should not be included in the request.
{
"action": "book_bundle",
"bundle_id": "<id>",
"product_variations": [
{
"bundle_item_id": "<id>",
"product_id": "<id>"
},
{
"bundle_item_id": "<id>",
"product_id": "<id>"
}
]
}
Book a Product
Books a quantity of a Product on an Order. This can be any type of Product, including trackable Products.
{
"action": "book_product",
"product_id": "<id>",
"quantity": N,
}
Book StockItems
Books one or more StockItems of a trackable Product on an Order.
{
"action": "book_stock_items",
"product_id": "<id>",
"stock_item_ids": ["<id>"],
}
Start a Product
A quantity of a product is started. The quantity can be the same as the booked quantity, or less when a subset of items is started.
{
"action": "start_product",
"product_id": "<id>",
"planning_id": "<id>",
"quantity": N
}
Start StockItems
One or more stock items of a trackable product are started.
{
"action": "start_stock_items",
"product_id": "<id>",
"planning_id": "<id>",
"stock_item_ids": ["<id>", "<id>"]
}
Stop a Product
A quantity of a product is returned. The product needs to have started. The quantity can be the same as the started quantity, or less when a subset of items is returned.
Consumables and services can not be stopped.
{
"action": "stop_product",
"product_id": "<id>",
"planning_id": "<id>",
"quantity": N
}
Stop StockItems
One or more stock items of a trackable product are returned. Only stock items that have been started can be stopped.
{
"action": "stop_stock_items",
"product_id": "<id>",
"planning_id": "<id>",
"stock_item_ids": ["<id>", "<id>"]
}
Errors
Booking and starting items can be blocked by shortage errors and other kinds of inventory errors.
Endpoints
POST /api/boomerang/order_fulfilments
Fields
Every order fulfilment has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
actions |
Array writeonlyArray of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
confirm_shortage |
Boolean writeonlyA value of true overrides shortage warnings when booking products on a reserved or started Order. |
order_id |
Uuid The associated Order |
Relationships
Order fulfilments have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
changed_lines |
Lines readonlyAssociated Changed lines |
changed_plannings |
Plannings readonlyAssociated Changed plannings |
changed_stock_item_plannings |
Stock item plannings readonlyAssociated Changed stock item plannings |
Book
Book a Bundle:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "eeafd18b-3f35-439c-a6a8-cb578874d7e9",
"actions": [
{
"action": "book_bundle",
"bundle_id": "5b71ec92-885a-4698-b645-c0efb140c463",
"product_variations": [
{
"bundle_item_id": "a9855c58-1049-4b6a-b68e-9de5951a1751",
"product_id": "30b8a48b-8a46-45e0-9449-c58c49e133fd"
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "9dd8fe03-fe5b-5099-8ebb-beb3f346f423",
"type": "order_fulfilments",
"attributes": {
"order_id": "eeafd18b-3f35-439c-a6a8-cb578874d7e9"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Book a Product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "c292ea71-792d-4ad5-b349-bca9665102d0",
"actions": [
{
"action": "book_product",
"product_id": "80dcaa83-4ba0-45a5-8250-c861756a935f",
"quantity": 3
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "12f962a0-50d4-55c5-8817-dd859aa5aa58",
"type": "order_fulfilments",
"attributes": {
"order_id": "c292ea71-792d-4ad5-b349-bca9665102d0"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Book StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "16a885aa-c962-42bd-ba16-417debf8499f",
"actions": [
{
"action": "book_stock_items",
"product_id": "97dbc91d-bee8-455f-bcda-9c0f2cc94eca",
"stock_item_ids": [
"24711986-2a1b-4280-b1b0-daa8dea80e45",
"efc349fe-f0b8-4998-a6f6-9a96db319ac1"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "d292a5b6-71ab-53e3-908a-292a962e2669",
"type": "order_fulfilments",
"attributes": {
"order_id": "16a885aa-c962-42bd-ba16-417debf8499f"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfilments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfilments]=id,created_at,updated_at |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings
Start
Start a Product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "d39c53ce-f6bf-4dd1-a40c-737d2d62b9cf",
"actions": [
{
"action": "start_product",
"product_id": "f9789f97-0628-403d-838d-93d1533e6041",
"planning_id": "e4798f15-6433-458e-95cc-e841cd3c67b1",
"quantity": 1
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "eca2299d-a369-52e5-b5b4-1b2bd30f5f91",
"type": "order_fulfilments",
"attributes": {
"order_id": "d39c53ce-f6bf-4dd1-a40c-737d2d62b9cf"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Start StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "8c995050-d79f-48e6-810b-2cdbab5e2aeb",
"actions": [
{
"action": "start_stock_items",
"product_id": "3203d329-ed3f-48d7-bd36-570c0b4a6de8",
"planning_id": "87a1d0ec-13ac-481d-8b48-d1e64e9347a9",
"stock_item_ids": [
"a67992f9-5451-4080-b012-6b24567448ab"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "23e4756e-3f4e-5b97-af36-51669c0ad2ca",
"type": "order_fulfilments",
"attributes": {
"order_id": "8c995050-d79f-48e6-810b-2cdbab5e2aeb"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfilments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfilments]=id,created_at,updated_at |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings
Stop
Stop a Product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "b88220b0-56b6-48bd-ae0f-f37aec8f34a6",
"actions": [
{
"action": "stop_product",
"product_id": "1649d1ed-425e-4005-bb76-4c82ee82b180",
"planning_id": "65877e25-f620-49a1-8e1b-e138036d83f3",
"quantity": 1
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4d80a71d-4ee3-5e1c-b079-d84ed3f0c68b",
"type": "order_fulfilments",
"attributes": {
"order_id": "b88220b0-56b6-48bd-ae0f-f37aec8f34a6"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Stop StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfilments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfilments",
"attributes": {
"order_id": "9d72807b-0981-4823-8a62-b9209108ca39",
"actions": [
{
"action": "stop_stock_items",
"product_id": "63a4c8ad-e990-4fd3-810d-d52c380df948",
"planning_id": "bddd07bd-0916-46b8-af47-2994846a255c",
"stock_item_ids": [
"148bae85-d054-4d3a-b34e-6fd386dfad12"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "693adffc-554d-5c61-bb7d-c1ef8600c363",
"type": "order_fulfilments",
"attributes": {
"order_id": "9d72807b-0981-4823-8a62-b9209108ca39"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfilments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfilments]=id,created_at,updated_at |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings
Order fulfillments
Takes an Order through the fulfillment process.
Actions
Book a Bundle
Books a Bundle on an Order.
For each unspecified BundleItem a product variation needs to be selected. Specified BundleItems are automatically booked. These must not be included in the request. When a Bundle only contains specified BundleItems, an empty list of product variations must be provided.
The quantity attribute sets the quantity of the Bundle itself,
and multiplies the quantities of all products in the Bundle.
The confirm_shortage attribute (on the resource, not on the action),
overrides shortage warnings when booking on a reserved or started order.
{
"action": "book_bundle",
"bundle_id": "<id>",
"quantity": N,
"product_variations": [
{
"bundle_item_id": "<id>",
"product_id": "<id>"
},
{
"bundle_item_id": "<id>",
"product_id": "<id>"
}
]
}
Book a Product
Books a quantity of a Product on an Order. This can be any type of Product, including trackable Products.
This action supports 3 modes:
- create_new, a new Planning and Line are created.
- update_existing, the quantity is added to an existing Planning/Line
- infer_planning, behaves as update_existing when a Planning for
the same Product exists. Behaves as create_new when there is no
existing Planning for the Product.
The confirm_shortage attribute (on the resource, not on the action),
overrides shortage warnings when booking on a reserved or started order.
{
"action": "book_product",
"mode": "create_new",
"planning_id": "<id>", // required for `mode==update_existing`
"product_id": "<id>",
"quantity": N,
}
Book StockItems
Books one or more StockItems of a trackable Product on an Order.
This action supports 3 modes:
- create_new, a new Planning and Line are created.
- update_existing, the StockItems are booked on an existing Planning/Line.
If needed, the quantity of the Planning is increased to accomodate all
newly booked StockItems.
- infer_planning, behaves as update_existing when a Planning for
the same Product exists. Behaves as create_new when there is no
existing Planning for the Product.
The confirm_shortage attribute (on the resource, not on the action),
overrides shortage warnings when booking on a reserved or started order.
{
"action": "book_stock_items",
"stock_item_ids": ["<id>"],
"planning_id": "<id>", // required for `mode==update_existing`
"product_id": "<id>",
"mode": "infer_planning",
}
Specify StockItems
Adds or removes one or more StockItems from an existing Planning.
It is not possible to specify more StockItems than there is remaining quantity left on the Planning. StockItems that have already been started can not be removed.
{
"action": "specify_stock_items",
"product_id": "<id>",
"planning_id": "<id>",
"stock_item_ids_to_add": ["<id>", "<id>"],
"stock_item_ids_to_remove": ["<id>", "<id>"]
}
Start a Product
A quantity of a product is started. The quantity can be the same as the booked quantity, or less when a subset of items is started.
The confirm_shortage attribute (on the resource, not on the action),
overrides shortage warnings when booking on a reserved or started order.
{
"action": "start_product",
"product_id": "<id>",
"planning_id": "<id>",
"quantity": N
}
Start StockItems
One or more stock items of a trackable product are started.
The confirm_shortage attribute (on the resource, not on the action),
overrides shortage warnings when booking on a reserved or started order.
{
"action": "start_stock_items",
"product_id": "<id>",
"planning_id": "<id>",
"stock_item_ids": ["<id>", "<id>"]
}
Stop a Product
A quantity of a product is returned. The product needs to have started. The quantity can be the same as the started quantity, or less when a subset of items is returned.
Consumables and services can not be stopped.
{
"action": "stop_product",
"product_id": "<id>",
"planning_id": "<id>",
"quantity": N
}
Stop StockItems
One or more stock items of a trackable product are returned. Only stock items that have been started can be stopped.
{
"action": "stop_stock_items",
"product_id": "<id>",
"planning_id": "<id>",
"stock_item_ids": ["<id>", "<id>"]
}
Errors
Booking and starting items can be blocked by shortage errors and other kinds of inventory errors.
Endpoints
POST /api/boomerang/order_fulfillments
Fields
Every order fulfillment has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
actions |
Array writeonlyArray of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
confirm_shortage |
Boolean writeonlyA value of true overrides shortage warnings when booking products on a reserved or started Order. |
order_id |
Uuid The associated Order |
Relationships
Order fulfillments have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
changed_lines |
Lines readonlyAssociated Changed lines |
changed_plannings |
Plannings readonlyAssociated Changed plannings |
changed_stock_item_plannings |
Stock item plannings readonlyAssociated Changed stock item plannings |
Specify
Add a StockItem:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "fe318e95-be0f-4a5a-9b98-cfef4d8e3d0c",
"actions": [
{
"action": "specify_stock_items",
"product_id": "bef39bed-87dd-465f-afbe-393de95d047a",
"planning_id": "5e22fca0-e95e-48e9-9aef-a5353016b86c",
"stock_item_ids_to_add": [
"16977ce4-d507-49a0-9782-49b36c857201"
],
"stock_item_ids_to_remove": []
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "9ada8992-282d-50ed-ae8b-b0aeedc35c1d",
"type": "order_fulfillments",
"attributes": {
"order_id": "fe318e95-be0f-4a5a-9b98-cfef4d8e3d0c"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Remove a StockItem:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "fb54f2ba-5545-4e50-9f85-dbf455bba422",
"actions": [
{
"action": "specify_stock_items",
"product_id": "779d00b5-5561-4f95-8620-e3461b011234",
"planning_id": "fd061da6-0d35-41b6-8674-8fd7568b5dee",
"stock_item_ids_to_add": [],
"stock_item_ids_to_remove": [
"e82e7ee9-e652-466d-89e9-231cb1a63cf7"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "eb2fee57-4087-5b47-bda6-51f81952c4d1",
"type": "order_fulfillments",
"attributes": {
"order_id": "fb54f2ba-5545-4e50-9f85-dbf455bba422"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfillments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfillments]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order =>
tax_values
transfers
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings =>
stock_item
Start
Start StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "e618c83b-66aa-42c5-8923-458c8d11efbe",
"confirm_shortage": null,
"actions": [
{
"action": "start_stock_items",
"product_id": "a47b7990-0d78-4782-8693-65b22efc74fb",
"planning_id": "699f4d0d-a2b8-4386-9b43-3d7591f0105e",
"stock_item_ids": [
"82e77575-3692-4221-976c-2627516e20bc"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "28e9dae1-9552-50b2-ad20-591149f33e9e",
"type": "order_fulfillments",
"attributes": {
"order_id": "e618c83b-66aa-42c5-8923-458c8d11efbe"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Start a Product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "2b6df3e5-a64b-4a5b-9f67-50443bbac008",
"confirm_shortage": null,
"actions": [
{
"action": "start_product",
"product_id": "7e561327-1514-4931-bfbb-18efb3db1a60",
"planning_id": "10f9372b-3af4-4aaf-b04e-5e61f0b90f5b",
"quantity": 1
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e6e7a3cb-49e2-59d0-b3d5-168356b6a2c5",
"type": "order_fulfillments",
"attributes": {
"order_id": "2b6df3e5-a64b-4a5b-9f67-50443bbac008"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfillments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfillments]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order =>
tax_values
transfers
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings =>
stock_item
Stop
Stop a Product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "4b30f581-5af8-42d0-ac1a-f743e15c9887",
"actions": [
{
"action": "stop_product",
"product_id": "ad80cbf1-38c2-434c-9136-779208bc5cfe",
"planning_id": "2e3ed1cc-cdfd-42fa-8dec-6c6579925747",
"quantity": 1
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "0af5df5c-834b-5557-b521-888d0cbf6779",
"type": "order_fulfillments",
"attributes": {
"order_id": "4b30f581-5af8-42d0-ac1a-f743e15c9887"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Stop StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "521f9714-b493-4c04-8b3a-4b45a3ce34d4",
"actions": [
{
"action": "stop_stock_items",
"product_id": "0ee17158-674e-45f2-8493-0a631f19c23e",
"planning_id": "3a9ffa50-177e-48dd-be72-af60e79c541f",
"stock_item_ids": [
"2c53da95-15fa-48b3-bf11-de6729720706"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "c904154a-28b1-5305-996d-eb487d49c038",
"type": "order_fulfillments",
"attributes": {
"order_id": "521f9714-b493-4c04-8b3a-4b45a3ce34d4"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfillments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfillments]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order =>
tax_values
transfers
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings =>
stock_item
Book
Book a Bundle:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "ac057353-f79a-494f-919d-7f925b821f76",
"confirm_shortage": null,
"actions": [
{
"action": "book_bundle",
"bundle_id": "27ab28f2-a68a-4404-87df-fb225ee892b7",
"quantity": 1,
"product_variations": [
{
"bundle_item_id": "082bfc5e-84ec-45c9-a613-fbf27f2f9c5e",
"product_id": "d9df422e-b2d4-45ba-b7f9-2a234194c0e3"
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4393e323-5f04-5e86-942d-a65e0c26012b",
"type": "order_fulfillments",
"attributes": {
"order_id": "ac057353-f79a-494f-919d-7f925b821f76"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Book a Product (New):
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "15e787c8-ac6e-4cf6-8e74-671d1c101f9e",
"confirm_shortage": null,
"actions": [
{
"action": "book_product",
"mode": "create_new",
"product_id": "e1ae61dc-5540-4be7-888c-98c24be0a43e",
"quantity": 3
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "0c692193-d145-5766-b695-837ad7588920",
"type": "order_fulfillments",
"attributes": {
"order_id": "15e787c8-ac6e-4cf6-8e74-671d1c101f9e"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Book a Product (Update Automatically):
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "884be0d2-52d7-4214-abe9-82c8f48010e4",
"confirm_shortage": null,
"actions": [
{
"action": "book_product",
"mode": "infer_planning",
"product_id": "06f54f36-b549-4659-839e-ff1e1cd844e2",
"planning_id": null,
"quantity": 3
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "b1b608d0-8962-5f1c-84ce-33e83be150a3",
"type": "order_fulfillments",
"attributes": {
"order_id": "884be0d2-52d7-4214-abe9-82c8f48010e4"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Book StockItems:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_fulfillments' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_fulfillments",
"attributes": {
"order_id": "876533d0-7b44-4d49-8a78-ab9ca5cda106",
"confirm_shortage": null,
"actions": [
{
"action": "book_stock_items",
"mode": "infer_planning",
"product_id": "7c68b696-b2d2-4095-8773-f83157650279",
"stock_item_ids": [
"46a466b8-a255-42b8-81a2-8d30fc837616",
"27f54e33-8b6c-46b7-9c35-6ac93883f52a"
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e7fd6320-0515-52d8-b36c-5ff80853d2d6",
"type": "order_fulfillments",
"attributes": {
"order_id": "876533d0-7b44-4d49-8a78-ab9ca5cda106"
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"changed_lines": {
"meta": {
"included": false
}
},
"changed_plannings": {
"meta": {
"included": false
}
},
"changed_stock_item_plannings": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_fulfillments
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,changed_lines,changed_plannings |
fields[] |
Array List of comma seperated fields to include ?fields[order_fulfillments]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][actions][] |
Array Array of actions to be performed. The actions are executed atomically, and succeed as a whole, or fail as a whole. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings when booking products on a reserved or started Order. |
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order =>
tax_values
transfers
changed_lines =>
item =>
photo
changed_plannings
changed_stock_item_plannings =>
stock_item
Order price recalculations
When the rental period of an order is changed, the prices of individual lines and the total price of the order are not automatically recalculated to preserve any manual changes that may have been made.
The OrderPriceRecalculation resource allows to request a recalculation for the
entire order and all its lines.
To recalculate the price of an individual line, set the charge_length of the
line to null as described here.
Fields
Every order price recalculation has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
order_id |
Uuid The associated Order |
Relationships
Order price recalculations have the following relationships:
| Name | Description |
|---|---|
order |
Orders Associated Order |
Recalculate prices
Recalculate prices when rental period has changed:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_price_recalculations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_price_recalculations",
"attributes": {
"order_id": "dfd3a814-050a-477f-9566-02e8e51b4885"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4037abae-08b5-5bf4-8f0d-af71af8bcce2",
"type": "order_price_recalculations",
"attributes": {
"order_id": "dfd3a814-050a-477f-9566-02e8e51b4885"
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/order_price_recalculations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order |
fields[] |
Array List of comma seperated fields to include ?fields[order_price_recalculations]=order_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][order_id] |
Uuid The associated Order |
Includes
This request accepts the following includes:
order
Order status transitions
Transitions the status of an Order to another status.
See Order for a desciption of the different statuses.
Note that you can not transition to started or to stopped.
The Order will transition to those statuses automatically when
starting or stopping items through the Fulfillment API.
It is however possible to revert to the started or the stopped status.
Errors
When the Order can not be transitioned, and error.code is items_not_available,
then the error.meta.blocking.*.reason or error.meta.warning.*.reason
attribute contains one of the following reasons:
stock_item_specifiedOne or more of theStockItemson thisOrderhave also been planned for other current or futureOrders. The Product is specified in theerror.meta.blocking.*.item_idattribute anderror.meta.blocking.*.unavailablecontains the problematic StockItems.shortageA shortage would be created for one or more of theProductson thisOrder. When the shortages would within the shortage limits of the products, a warning is returned. Otherwise a blocking error is returned. When reserving an Order, a warning can be overriden by settingconfirm_shortagetotrue. The Product is specified in theerror.meta.warning.*.item_idorerror.meta.blocking.*.item_idattribute.
Note that is is possible to get multiple warnings and errors of different types at the same time.
Permissions
- Canceling an Order requires the
cancel_orderspermission. - Reverting an Order requires the
revert_orderspermission.
Fields
Every order status transition has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
order_id |
Uuid The associated Order |
transition_from |
String_enum The current status of the Order. One of: new, concept, reserved, started, stopped, archived, canceled. |
transition_to |
String_enum The new status of the Order. One of: concept, reserved, started, stopped, archived, canceled.It is only possible to transition to started or stopped in combination with revert: true. |
revert |
Boolean Indicates if this transition reverts the Order back to an earlier status. "Earlier status" does not require this specific Order to ever have been in that status (e.g. concept can have been skipped). "Earlier" means earlier in the conceptual progressing of statuses of Orders in general. |
confirm_shortage |
Boolean A value of true overrides shortage warnings. This is only possible when reserving an Order. |
Relationships
Order status transitions have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
Transition
Reserve a concept Order, causing a shortage warning:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "f030f68e-80a5-4943-aaa1-364d7a695ac7",
"transition_from": "concept",
"transition_to": "reserved",
"confirm_shortage": null,
"revert": null
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "items_not_available",
"status": "422",
"title": "Items not available",
"detail": "One or more items are not available",
"meta": {
"warning": [
{
"reason": "shortage",
"item_id": "fd4acd8d-382c-4ccb-9955-59c72a507740",
"stock_count": 1,
"reserved": 0,
"needed": 2,
"shortage": 1
}
],
"blocking": []
}
}
]
}
Reserve a concept Order, causing a stock item specified error:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "27b4cfcd-452d-4d86-b94f-f93291caac4d",
"transition_from": "concept",
"transition_to": "reserved",
"confirm_shortage": null,
"revert": null
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "stock_item_specified",
"status": "422",
"title": "Stock item specified",
"detail": "One or more items are not available",
"meta": {
"warning": [],
"blocking": [
{
"reason": "stock_item_specified",
"item_id": "0b752cf4-f03f-4c06-a03e-eee89f8dd439",
"unavailable": [
"be3966eb-4562-4320-a749-e97de4afb152"
],
"available": [
"60e7630a-2283-414c-831e-4bc4312466cd"
]
}
]
}
}
]
}
Archive a reserved Order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "303da131-d16a-4df8-91a5-62e14fee3ac6",
"transition_from": "reserved",
"transition_to": "archived",
"confirm_shortage": null,
"revert": null
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "wrong_status",
"status": "422",
"title": "Wrong status",
"detail": "Can't transition order from 'reserved' to 'archived'",
"meta": null
}
]
}
Revert a reserved Order to 'concept':
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "cf76c91b-f402-4579-a199-e6d0ad59e9b0",
"transition_from": "reserved",
"transition_to": "concept",
"confirm_shortage": null,
"revert": true
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "224c6e1d-c71e-5b03-805e-eea28f8aa898",
"type": "order_status_transitions",
"attributes": {
"order_id": "cf76c91b-f402-4579-a199-e6d0ad59e9b0",
"transition_from": "reserved",
"transition_to": "concept",
"revert": true,
"confirm_shortage": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Reserve a concept Order, and override the shortage warning:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "c6480158-8aed-4539-b73f-dcd7b928ca73",
"transition_from": "concept",
"transition_to": "reserved",
"confirm_shortage": true,
"revert": null
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "7fc0b414-dd11-5e7b-b36d-b12a43f5aa42",
"type": "order_status_transitions",
"attributes": {
"order_id": "c6480158-8aed-4539-b73f-dcd7b928ca73",
"transition_from": "concept",
"transition_to": "reserved",
"revert": null,
"confirm_shortage": true
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Archive a stopped Order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "ffb9582f-e66c-4feb-bd34-63f22e08704a",
"transition_from": "stopped",
"transition_to": "archived",
"confirm_shortage": null,
"revert": null
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "c23f3c48-0a55-5d6c-8b3d-04f0f0691eb6",
"type": "order_status_transitions",
"attributes": {
"order_id": "ffb9582f-e66c-4feb-bd34-63f22e08704a",
"transition_from": "stopped",
"transition_to": "archived",
"revert": null,
"confirm_shortage": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Save a new Order as concept:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "f3946895-3c50-47e3-9884-ad1cdb3fc054",
"transition_from": "new",
"transition_to": "concept",
"confirm_shortage": null,
"revert": null
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "657eb31d-8bc5-595c-809b-fa757b8cd897",
"type": "order_status_transitions",
"attributes": {
"order_id": "f3946895-3c50-47e3-9884-ad1cdb3fc054",
"transition_from": "new",
"transition_to": "concept",
"revert": null,
"confirm_shortage": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Reserve a concept Order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "3cfc06fa-47e1-4db1-a264-07fe136dcbed",
"transition_from": "concept",
"transition_to": "reserved",
"confirm_shortage": null,
"revert": null
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e87ba488-7508-501d-bd21-480b53d8eb81",
"type": "order_status_transitions",
"attributes": {
"order_id": "3cfc06fa-47e1-4db1-a264-07fe136dcbed",
"transition_from": "concept",
"transition_to": "reserved",
"revert": null,
"confirm_shortage": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Reserve a concept Order, causing a blocking shortage error:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/order_status_transitions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "order_status_transitions",
"attributes": {
"order_id": "800c1666-1003-45a5-8fbf-4a0258753fdd",
"transition_from": "concept",
"transition_to": "reserved",
"confirm_shortage": null,
"revert": null
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "items_not_available",
"status": "422",
"title": "Items not available",
"detail": "One or more items are not available",
"meta": {
"warning": [],
"blocking": [
{
"reason": "shortage",
"item_id": "5402c5fa-a387-45a6-81c6-e1a4f25645df",
"stock_count": 1,
"reserved": 0,
"needed": 2,
"shortage": 1
}
]
}
}
]
}
HTTP Request
POST /api/boomerang/order_status_transitions
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order |
fields[] |
Array List of comma seperated fields to include ?fields[order_status_transitions]=order_id,transition_from,transition_to |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][order_id] |
Uuid The associated Order |
data[attributes][transition_from] |
String_enum The current status of the Order. One of: new, concept, reserved, started, stopped, archived, canceled. |
data[attributes][transition_to] |
String_enum The new status of the Order. One of: concept, reserved, started, stopped, archived, canceled.It is only possible to transition to started or stopped in combination with revert: true. |
data[attributes][revert] |
Boolean Indicates if this transition reverts the Order back to an earlier status. "Earlier status" does not require this specific Order to ever have been in that status (e.g. concept can have been skipped). "Earlier" means earlier in the conceptual progressing of statuses of Orders in general. |
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings. This is only possible when reserving an Order. |
Includes
This request accepts the following includes:
order
Payment methods
Re-usable payment methods stored on file.
Endpoints
GET /api/boomerang/payment_methods
DELETE /api/boomerang/payment_methods/{id}
Fields
Every payment method has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
data |
Hash readonlyInformation about the payment method |
payment_method_type |
String readonlyPayment method type. One of creditcard |
customer_id |
Uuid readonlyThe associated Customer |
Relationships
Payment methods have the following relationships:
| Name | Description |
|---|---|
customer |
Customers readonlyAssociated Customer |
Listing payment methods
How to fetch a list of payment methods:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/payment_methods' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "d2a2e280-8b70-4794-99e5-88df57598cee",
"type": "payment_methods",
"attributes": {
"created_at": "2024-04-29T09:26:40+00:00",
"updated_at": "2024-04-29T09:26:40+00:00",
"data": {
"name": null,
"brand": null,
"exp_month": null,
"exp_year": null,
"last4": null
},
"payment_method_type": "creditcard",
"customer_id": "3ad4c108-a959-4eb4-a7e8-4778fbf7d6ca"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/3ad4c108-a959-4eb4-a7e8-4778fbf7d6ca"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/payment_methods
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[payment_methods]=created_at,updated_at,data |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
data |
Hash eq |
customer_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Archiving a payment method
How to archive a payment method:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/payment_methods/42d7c4a2-31d8-4809-ab4a-67c9e26af61b' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "42d7c4a2-31d8-4809-ab4a-67c9e26af61b",
"type": "payment_methods",
"attributes": {
"created_at": "2024-04-29T09:26:41+00:00",
"updated_at": "2024-04-29T09:26:41+00:00",
"data": {
"name": null,
"brand": null,
"exp_month": null,
"exp_year": null,
"last4": null
},
"payment_method_type": "creditcard",
"customer_id": "f7b87bfe-b3bf-4565-9b1b-19b6c913c745"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/f7b87bfe-b3bf-4565-9b1b-19b6c913c745"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/payment_methods/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[payment_methods]=created_at,updated_at,data |
Includes
This request does not accept any includes
Photos
Photos are displayed on documents and in the online store to let customers see how products look.
Endpoints
GET /api/boomerang/photos
GET /api/boomerang/photos/{id}
POST /api/boomerang/photos
PUT /api/boomerang/photos/{id}
DELETE /api/boomerang/photos/{id}
Fields
Every photo has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
photo_base64 |
String writeonlyBase64 encoded photo |
remote_photo_url |
String writeonlyUrl to an image on the web |
original_url |
String readonlyUrl to original stored image |
large_url |
String readonlyUrl to large stored image (max 500x500) |
xlarge_url |
String readonlyUrl to xlarge stored image (max 2000x2000) |
coordinates |
Hash Focalpoint coordinates ( { x: 10, y: 100 }). To ensure that a key part of an image stays visible, you can set the image's focal point. The focal point sets the focus of an image, giving you control over where the image is centered. |
preview |
String readonlyBase64 encoded preview |
position |
Integer Which position the photo has in the album |
photo |
Carrierwave_file An object describing the photo. |
owner_id |
Uuid ID of its owner |
owner_type |
String The resource type of the owner. One of product_groups, bundles |
Relationships
Photos have the following relationships:
| Name | Description |
|---|---|
owner |
Product group, Product, Bundle Associated Owner |
Listing photos
How to fetch a list of photos:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/photos' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "7815fa5d-8e02-4302-9628-b06bd9300410",
"type": "photos",
"attributes": {
"created_at": "2024-04-29T09:27:20+00:00",
"updated_at": "2024-04-29T09:27:20+00:00",
"original_url": "/uploads/e631770f4875d485633f148ce89e048e/photo/photo/7815fa5d-8e02-4302-9628-b06bd9300410/1714382840-654872089374085-0004-4951/upload.png",
"large_url": "/uploads/e631770f4875d485633f148ce89e048e/photo/photo/7815fa5d-8e02-4302-9628-b06bd9300410/large_1714382840-654872089374085-0004-4951/upload.jpg",
"xlarge_url": "/uploads/e631770f4875d485633f148ce89e048e/photo/photo/7815fa5d-8e02-4302-9628-b06bd9300410/xlarge_1714382840-654872089374085-0004-4951/upload.jpg",
"coordinates": {
"x": "0.00",
"y": "0.00"
},
"preview": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAMAAADzN3VRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABcVBMVEX///7+///////+//7//v///v7+/v7+/v/9/v73/f78/v7Z8v6H2/1g1/184v3P9f74+/602v5XuP01tvwvvvwoxfw80f2b6v7z/P7t8f6Zu/5VnP5Jof1Eqf0+sf03ufwvwPwtyf1x3v3h+P7k5f+Pnf9ihP5cjP5Wlf5PnP5Io/5Cq/08s/01u/wswvxY1P3S9P7k3P6Nf/JlYtxbZMxVachPb8xTgNxem/VRoP5FpP1Arf06tfwxvPxPzf3M8f7p4PmMadRgQ69YR6NSSaBQT6F1fLe7w93g6PfD2v57s/5NoP1Ep/0/r/1Uyf3Z8/76+PygechlM6RiOaJcPKFpVKutp9Lw8Pfy9v6szf5fpP5IoP1Dqf06sP13zv32/P7p3fF8OqtqKKFsNaWRcL7a0ur9/f7X5v6CtP5Rnv1Fov1NsP3a7/728fmtfsmcZ7/JsN328vn09/681f6Ctv6Ow/7v9/78+v37+fz6+/76/P7k06ScAAAAAWJLR0QCZgt8ZAAAAAd0SU1FB+gEHQkbFN0NPqUAAAGRSURBVCjPNVIHVxYxENzb7F4+sCHNLk1RQVFQ7A1EARvYKKIiKNiwUKy/3pm9j7x395JMMmU3IlIUWiiGiKRCTS2JcKlAMDAXF3ETKZMkNyPKS/hwXLEhKblLhWigwelSp01g45XALOOCePxJTigQEDikcs4k9gpNajEVSinVchbhHIcKbNcaGsOtukMwTDCHljt27tq9p4Z8iRwW7KpZm/Y2t7S2te/brwDIKhFW5cDBQ4ePHO3o7OruqZzm0BU5drz3xMlTff2nzwycPUcPtCBZdHDo/IXhi5cuX7l67fqNm7dUk9FS1tsjo3fG7t4bn5i8/+Dho5bHU5pCR6efPH32/MXMLFZz8y8XXr1+swgLzPN2afnd+5XVUK59+Pjp85c11IrI12/ff6xXYc10Y3Pr5y+VMrz9/lPSOQsCgfLvP8Ylgqge3o2xWQ/84FjQJ60KrznXG1bgrOl287TeXq4Zx6LmxfZZIJDyDB3ja8laJuzyFURP8GpgghUnJRZsH42HHalaCwQ1dDbWLfF9+H+O8CGkTfhjrQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wNC0yOVQwOToyNzoyMCswMDowMM8SySQAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDQtMjlUMDk6Mjc6MjArMDA6MDC+T3GYAAAAAElFTkSuQmCC",
"position": 1,
"photo": {
"url": "/uploads/e631770f4875d485633f148ce89e048e/photo/photo/7815fa5d-8e02-4302-9628-b06bd9300410/1714382840-654872089374085-0004-4951/upload.png"
},
"owner_id": "1a1913c3-364a-4a4f-bd55-25aa2d426a7c",
"owner_type": "product_groups"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/product_groups/1a1913c3-364a-4a4f-bd55-25aa2d426a7c"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/photos
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[photos]=created_at,updated_at,original_url |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Fetching a photo
How to fetch a photo:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/photos/3b663615-7fad-4f11-88c0-8be6661d9342' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "3b663615-7fad-4f11-88c0-8be6661d9342",
"type": "photos",
"attributes": {
"created_at": "2024-04-29T09:27:21+00:00",
"updated_at": "2024-04-29T09:27:21+00:00",
"original_url": "/uploads/fd663d8db2e55eb78222e5b3f21661bc/photo/photo/3b663615-7fad-4f11-88c0-8be6661d9342/1714382841-738368985598011-0005-2283/upload.png",
"large_url": "/uploads/fd663d8db2e55eb78222e5b3f21661bc/photo/photo/3b663615-7fad-4f11-88c0-8be6661d9342/large_1714382841-738368985598011-0005-2283/upload.jpg",
"xlarge_url": "/uploads/fd663d8db2e55eb78222e5b3f21661bc/photo/photo/3b663615-7fad-4f11-88c0-8be6661d9342/xlarge_1714382841-738368985598011-0005-2283/upload.jpg",
"coordinates": {
"x": "0.00",
"y": "0.00"
},
"preview": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAMAAADzN3VRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABcVBMVEX///7+///////+//7//v///v7+/v7+/v/9/v73/f78/v7Z8v6H2/1g1/184v3P9f74+/602v5XuP01tvwvvvwoxfw80f2b6v7z/P7t8f6Zu/5VnP5Jof1Eqf0+sf03ufwvwPwtyf1x3v3h+P7k5f+Pnf9ihP5cjP5Wlf5PnP5Io/5Cq/08s/01u/wswvxY1P3S9P7k3P6Nf/JlYtxbZMxVachPb8xTgNxem/VRoP5FpP1Arf06tfwxvPxPzf3M8f7p4PmMadRgQ69YR6NSSaBQT6F1fLe7w93g6PfD2v57s/5NoP1Ep/0/r/1Uyf3Z8/76+PygechlM6RiOaJcPKFpVKutp9Lw8Pfy9v6szf5fpP5IoP1Dqf06sP13zv32/P7p3fF8OqtqKKFsNaWRcL7a0ur9/f7X5v6CtP5Rnv1Fov1NsP3a7/728fmtfsmcZ7/JsN328vn09/681f6Ctv6Ow/7v9/78+v37+fz6+/76/P7k06ScAAAAAWJLR0QCZgt8ZAAAAAd0SU1FB+gEHQkbFaoKDjMAAAGRSURBVCjPNVIHVxYxENzb7F4+sCHNLk1RQVFQ7A1EARvYKKIiKNiwUKy/3pm9j7x395JMMmU3IlIUWiiGiKRCTS2JcKlAMDAXF3ETKZMkNyPKS/hwXLEhKblLhWigwelSp01g45XALOOCePxJTigQEDikcs4k9gpNajEVSinVchbhHIcKbNcaGsOtukMwTDCHljt27tq9p4Z8iRwW7KpZm/Y2t7S2te/brwDIKhFW5cDBQ4ePHO3o7OruqZzm0BU5drz3xMlTff2nzwycPUcPtCBZdHDo/IXhi5cuX7l67fqNm7dUk9FS1tsjo3fG7t4bn5i8/+Dho5bHU5pCR6efPH32/MXMLFZz8y8XXr1+swgLzPN2afnd+5XVUK59+Pjp85c11IrI12/ff6xXYc10Y3Pr5y+VMrz9/lPSOQsCgfLvP8Ylgqge3o2xWQ/84FjQJ60KrznXG1bgrOl287TeXq4Zx6LmxfZZIJDyDB3ja8laJuzyFURP8GpgghUnJRZsH42HHalaCwQ1dDbWLfF9+H+O8CGkTfhjrQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wNC0yOVQwOToyNzoyMSswMDowMGllwpAAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDQtMjlUMDk6Mjc6MjErMDA6MDAYOHosAAAAAElFTkSuQmCC",
"position": 1,
"photo": {
"url": "/uploads/fd663d8db2e55eb78222e5b3f21661bc/photo/photo/3b663615-7fad-4f11-88c0-8be6661d9342/1714382841-738368985598011-0005-2283/upload.png"
},
"owner_id": "860b9268-2be5-45bf-bdf1-8c8cfecd2681",
"owner_type": "product_groups"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/product_groups/860b9268-2be5-45bf-bdf1-8c8cfecd2681"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/photos/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[photos]=created_at,updated_at,original_url |
Includes
This request accepts the following includes:
owner
Creating a photo
How to create a photo:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/photos' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "photos",
"attributes": {
"owner_id": "803529fd-3797-4f51-8342-ff9d8f26b790",
"owner_type": "product_groups",
"photo_base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFwJJREFUeF7tnX+MHsV5x5+9s7mzTXxnjO/8C2N+2wcGwgW3wY1rkahNRBJRIVCSNlEihJQgJY3SSqWNhCr1HyI1ilI1IqRKFJQmVSE/SgiYmIRE/lXXmACWsR0w4J/x+cfhc2zOd7bvtnrefed9Z+ed3Z2dndmd3X3uH8zd7uzM93k+8zzPzLz7er7v+0A/pAApIFXAI0DIM0iBaAUIEOe9AwO81+hl+1/hfxsbAv8AY42WuyECpNz2o95bVoAAsSwwNV9uBRQBodhbbjNT73UVUAREt3m6r1YKVHAezQ2QCmpXK9+3M9g0XpHmWnO9zQ0QcRXG3BCoJVLAngK5AmJvGC63rDPz6dzjsgbl7VtpASEXKo/TldlWpQVEzz3KbCpxxFUai7o18x51zQBRNwRdWTMFIsgjQGrmB2rDzXueVutV6qsMnM0hQFKrTjfEK1AiuBS6SoBU1d8VjF/VoZscFwFiUs2ktshpkxRy7u+FA0I+45xPWOlQWe1cOCBWrCE0Wlbj5KGNW8/QtZTufcmjrwUgyTLQFfoKhJ0z+D9bDmur3ejREyD6nkF35qVA/ly0RkaA5GVkek4pFSBASmk2hU4XOOsq9I67xO2OEiDprElX10wBAqRmBqfhplOg1oC4HdzTGZKutqNArQGxIym1WiUFCJAqWbNSY3EjvhMgCk7lhqkUOkqXGFeAADEuKTXoigImJjYCxBVrUj8MKmACjaA7BIhBsyQ1Zc5sSU9y9e/lU4AAcdWXqF9OKECAOGEGW50o34xtSwnddgkQXeXovlooQIDUwsw4yDJHk+L6ToCkBKQ4U7GOFt+DlJKV+vLcACGzuugnEVYhY7WMlRsgLroH9YkUSFKAAElSKOvfVWZjlWuy9sP0/WXss4YGBIiGaHRLfRQgQOpjaxqphgIEiIZoxd+Sb36T79OKV5fvAQHilj0q05vyQBXfUwKkSJdM5UWpLi5yVJV6NgFSKXPSYEwrQICYVpTaq5QCAiAUxitlXRpMZgUogmSWkBpwUgFDcz0B4qR1qVOuKFAwIIYwL0RNB/vuYJeMmKbAcRUMiBH5OhspUFBLI6JmC1KgmoDoiklg6SpX2fsIkMqalgZmYr4jQMiPSIEYBQiQWPcwMQeR/5VZAScBIbcss0tVq+9OAlItiVVGQ1OCikpFXEOA5Ko6gZBabuuS0XH31DahG0gBpkCtIoj1yYj8ypIChiyn0UytALFkPWq2wgoQIBU2Lg0tuwIESHYNrbWgkRFY60tdGyZA6mp5GreSAnJAaOpSEi/rRaMXAc5OAxyY8OGE78GJCRQ++FnQ68F1PQB9XQCXdgHMn5H1aVnur69DUATJ4jcp70UgjlwE2Hrah33jAPsnAXaN+3BxBsCMi+3G8P/xZ94sr/HfoV6A63sAVvR48L5ZAFdekvLBjl5eBuwcBqQM8ql5HoKx6R2AF0d9+Om4D11TnfdNdwe/8wMmGtCIPwyYu/sAPtALsHZu82K1btBVUQrEuJrDgJTZnoHiPBjPjLbTpynO+ae72uMUIYkChUUXBOVjcz24uVdfq+pMQ/oaxN1ZGUBcM/T2UYCnjvuw/kQbDDQED4QqKLJowoyKUeUz8wA+1e8VXKekcVDXrBXd98oAksY8Nq/FqPH0YYB/OzgNM8/LgeAhwb4wUMTfq6RdLJpgnfLxuR7c02dzdPVrmwAxaHOMGj/c78O2Uz50TbfhUAVCBopO2vU3/V5lCnmD5tFqigDRki18UyNq7AN49PA0zLgQ/I05Np9WqaRXptKuhwY8WDen6OXhcn91KNouDIix1NBYQwbc124TGDV+useHLafbtYas8Ga/i4ompusTrE2wiKdoks3+FEE09TtzDuAnBwD+4+1puGSy3cjFmdyqlGSFKgkUVYDS1CcYTWpTmxiem6sLiGGheI5Y1NjOrVCx/Qu8LgoSPvWSgRKVXkUV8vL6pHPg+UcTi+JrTmi6t2UHpDpaJGrIosaLbwK8Pj4dup45twoouvWJKihRy8Jr5nlwfx9tMCYamrsgOyBpnlbia98YAfjuPh9ePuKD16TA9/zwvgamV81SJA0oeaZd5dw3Kc5xCBAF7X/7NsCTuwHeHuMK8dbRkDAk/CyP/24dHeFqE7EgZxHFJCghQIVjKwgJ7pv83YJsu/AK0pX+EgIkxoSYUv1mD8C39/jQ3Tw/hY4nPx4SDQrvrHE1SlZQZP0KQSoBRbWAr1EmHfIIAiQCEEypfvYSwJbjsqgR3KQCCl9466Rd4nOyFvJifcIK+M9fVqajKvkFJgJEovWmPQBPvOjDkfPBH6OjhhySRprVHT6DlRUU1eVf3Y1GLOAp5ep0BgKE0wRTqh+/BPD0Xh+6m5/PEB076vStSjTh65O80i4+AvGrZ7Jj9RhNVFOu/ObwYp9EgDT1ZynVSweCmT9uxk4bUcTVrihQ+P2TNIW8ybSLUq4wkAQIALCUanQsEEfF4eIgca0+0Um7KOUKfKHWgLCU6rmdfuu4yFRz+TYOFFtpF6t32ByW9diKaoEfdWwFo8nXB2u2sSgs19UWEEypNmwH2PZmUG/wTs9DwoOSV9rFg6Kbdqn0W/b5E3H/pO51iWFAyrFavns/wE82+vDmsXC+yUMSrETJ/x4FCnOu1oYfd3/W/RPVaKIaNaIAivr8yecWelDHpWDDgBS74qDy9B2/A/jx/wKMNnfFL0jeEBIHilZ9gqd6vfauusqKl4vLwne/x4MvLqnOh7FUpvPaAIL1xgvbAH62w4eeic5VKlOglKU+Ud1XESPKTbM9eHh5fY6oOA6ICuPJcePsyQl4fGsv7HwVDxoG14vpEGtFBCVr2sWeZWP/JK/6RNw/QUg+uagenzFxHJCGewX5iebPyRGARzf4cGS/vAGxNsCrTEUTPs+XPYefnfNIu1TrE5VlYTyy8veDHnx+UN82mibN9bYSAKKvx943AL6/AeDc4faxj8lZne2pRhNx6Vcs5LXqE+6FcdGHDYVj9dyhQ53zXarpVRIoF2YGkNw7v7rnuCoLCBbj658HGD3lt9IpHg2ToEStdsXN2CZ34/mUEf+tuuKV5W0rjbF1B6nqR+d58I9XVBOSBECypTf6c7/+nawYf2FDu94QHYi1LoMkqj5Jm3bx0SZuWRgTlKmItyuqpF1iGscrpwOKShQU+8UgcXaFK4MbVyqCIBxbfwOwfqPfeGmbrJ4QDwniNSajiZh2qYAi3iMWxVlAkUHSgJLbozH1+fgb51RjhYvnqTKAND7c9AzApq3hY+ZsRhUjQN6gqMzMadOuINq5VZ+snFsNSJjflBiQNue4jLv+2V7Y/ooPMycBLvREp2g8KKqQsNZ0VrwKqU+8doSIKuLF+ijrpxn59hCSLy2uxhmuEgMSuC0u4z73pA+793ZCoQqKrEaJSrvEekKWxrGeuHS+S2W1ixXevLPrFvJVgaTUgDA49u0EOB/xpTIqkIyPH2n49MTkaIuyc+dPSsPQuXNHoWtgWftvPsDM7tmt/7+kb0nr3zP6F3a0oXJamK9botIuBrVKfaJ7bCUKlKh0Ufx9FSApLSAIx4bHfXh9X9gHo0BpzPTN1Ovddw/BWTgF3ul3YHzWNEydOhp6ly5eK+5Sy6IMe7LsWvxbT38AkndpP8yeuaDxb4Qmj7Qr6G8+9UlclJnsBfjecq+0X/ZTICD6a29RcPCo8KCcHzsIZ7vPwrnzx2H83SBahFZxhFO7fDtRzi+rX6Kuneqahu6mF4nQePPbUUZlZk5byKt+mlGcFGSRSfe1RFj3fefackJSICDSDCbxlwyOA7sAcHaK+jk73oZi8o9HOmdtCRT88qrYriooUdex9hAW/mf23OWtCDM9GE7J4vZP4l7xo5J2iWlcVDSUHd3XWRbOBxL9STfKj0oFCA+HOCAGCwPjzMjLoQ9BiVGj5bAGQEkTTRr9ECBhfWGw9C5dFRqeKih4E9vdbvxbugFpNu0SnxMXBW1CEqBRRkAM9TkJDgTjxNRbcPGdZgoV8bXJYv4fBU5cNBHTEebNOqAsW3wZXLmkHxYtmAODl89pgXFwrBfO9SyDQ6M+HD8b/Jp3ePvH6gPDJe7G466j8DI9PjqJfUZInhjqyvS9iolphsELrEYQQ2wA7nP8z3/1wKHtnSMfnT4I7xza1FjF8rkZkzeSTK+8QeGhWrK0H/701iVw4zUL4OahpfAeyQFKvB43P0dOA+z5A8DeowDbjgYnBPIAxeb+ybWXl2cz0SogJkBGJ9nxI4CXn223NjnbhzMnX4N3/VMwNnmgo75wARTZe6/W3LIMbnnvQrjz/ddHQhGl2ZkJgEMjAP93GOB3b/kwMh6+Uny7vO3Pn8QV8WK0k0UUhOTrV7v/6UTnAdn+BMDm/247w/mJE3B0ai+cGQ+DIYsIqqDI7tVJvWQFOqYUCMYH110dGy3STCb4wonN+zpBUU27rNcnCWkXe/5d8z34ynXyU8Cmso80usqubQLiSnfCXdz9PMBz327/7uT4Ljhx+lWYmhGct4pMk7jhiJDEpV6qaVfDwDFLwyydWn27WTBEA2YFJaqIT6p3WD8S65Nmyhu3T/KhJR7861XufujK2QiCn+fY/S2Ak2MAfNQQnUTVqVWjSSx4wsOjILnuhgH4sw8t10qldGY8fEvLL14LahT2ylRxIjC6f4KNN30668d+EZ4vL+2Czy7XGbn9e5wEBFesNn4NYP/BAI6DxzbAxGz5KV0mUZGgsIiCYAwPLYSPfvh6uPTymE0aC3bFWu2V/cFLt+Pqk6z7J600Dt/Swo1DNZrIohOmod8acnMj0TlAcMXq59/tgZHtHmBKdXLs1Y5PBLIUS+ZnuYPiA0zPALjtjmXw4F+vhcs7j19ZwCG6Sfa2yKRCXkx72P5JER/7Reg+MMeDr6xyr2h3DhAsyl94/AT8cfpYAw7+R1wZCoHC1R2qRbeJtOuaoQG4+54hYwW4KZpY2vXiofivYQgBwb2/S2WTUZbG6dYnCMlHFkQX7Um62KqinQLk9S0jsO17C2HHjh+2NqhUDg1GRRQb0YTVKJgWfOKvbi4knUpyFvZ39g1Zz+8KNhtd3z9BSL60zK16xBlAMLV69pHjsPn5TR0nabNAkqboVokoCN1tty2FtR+/FtYML1X11UKvY1/tgNEET7nIQIl6barsjS/t1xWpfe1cmvoEjwx9Z2UXrJ5fqGSthzsDyKYfvQ1Pfm1r6/yU8rENoVjMWp/IloVZKnHFvD4Y/siVcNc9N6fe6DNr7vQJhelowhYm4k4L4zUqH9QSP82IS79R+yNmdUxuzQlAcNXqsS88A8feGmsAgiuILHNWBSW2PuF0UK1PGsZtruNjn2653XLUSO/zydaVXKESTZhj29iNx7aTIgq+lO6rN3XB3QNaQwxuMqSnE4D8/BuvwK++/1pLDfF1n0qQNKnKAooMnkWDrkSNDM4i3CpGk0Y04M6xqe7Ih+7pbk5swoe0+EI+zfmu1fM9ePiW4t+1VTggfPQQXUALFCGsBwaK3kOJiig4y930/qXwwBfWFb50aw6NcEtx0UR07KhoIsIVVZ/ofOz3H27NGEUMCFc4IGL0kI0pb1AGFlcvakT5io1owtcnSdGJ9UuWdr1voPgoUigguHL1zQd+Daf2jMH5mFf18LMZE1SWdon5bdS1ccvCK9ZWO2pEgSJGkyTHzqM+QWi+Oay4omWo5hD1KRQQ3Pf49wd/3fp+wCRITIIiQjL/ivpEDd1oIupv9HwXd16Rjyb3X9MFn11hIFfSbKJQQDC92vhYuzjHMahAogqK6v7JXX+5Ev78/uHK1hppfSMpmpiuT+IK+TV9Hnx12CtsWb0wQDD3feqhLfDKL+Vf3GEbFDRK39VzHdnXSOvC9q+X1Sam066k9tiE+Y3VimmWBVkKAwTrj8fu+xUcO3w6tMQojtE0KDMuBF+Q8+G7VlDUUHAoFk1eOhBeCcy6LKyyG4/dQ1v9y1AXrLtKobOmLuHqGScAEWcS2ThVQFFZ7Zpzw1x44MHbYdFtC62EbUu1oinTa7WjEk3i0q6GfRO+KChuR/4zK4urQ5wBhFlOPIatE1FEUFio/ti9N8Kdn16R+2c1tLzSwZtktUlSmpRmtQvbkr0NUgcQUxNVGBBTrSoa9z//dgvsXC+vQeJACaIJfyCl84EICX66Dgv1O9Ysh9X3XQPXryn4wxqKurh8Gftg1s43ADZyX21nEhSEhLWHdnxkbQ1rEBQADyg+/c9bI/0hazQZvLof1t47BO/9i0UUNQxTF5V2mQbl2ku74JE7wUo6rCJJYSkWdg6PmTz+qV80CvW4n+RoEr4bwVi1dgnc8clbaelWxQsyXMNeHPHsruCdXSy9VX0bZNK3aX3iVq+++yBoF9wL2fxoeC8kyl5JEWXR4j5Y/sFFtDqVweF1b+U/wci/WTUtKPzm41X9Hnx5GOC6vDNjF1axmCFwufepf9oBr/72gLJtRNEZGKvWLaE6Q1lFwxf6AI2X2x0L3rDCPpzFnpJ2WRiXdx/6Ey/f5V2JJIWmWKw/mGr98uHNqSGZt5JSKcNubqQ5rE8QFPYWSPZuYdX6BOG4b7iI1KpzlcoJQFA4jCQv/GAvvPH04ciaBGchjBaDq+Y1VqUW39BvsPjOeQnPiCsmNBIzpLxGizUKe7cwvohbfCURjoDVLQjGsvke3DsEhUUOURdnAOFTrj/8fgz2bh+BC+NTcO74BMwa6IWBqy6DwStnGYYiDy+lZ6AC7EXcI6cA9o0CnBDWZVYsApg7D2B4YXErVjJLuQFIXtOZs75aTwEQGvyJert9vuaS28ANQPJVgp7mogKOzhEEiIvOQn1yRgEFQBxFW1XCkndfdZh0nR0FFACx82BqlRQogwIESBmsRH0sTIFqAkJpVWEO1X5wNYxQTUAccA/qQl4K2AWRALFmR7uG0+u2i33SG0ledxEgeSlNzymlAoYBoRnKihc4Jqtj3UkteZr+xwCSppnUfaQbSIFSKGA4gpRizNRJUkBZAQJEWaoKXEhJQWojEiCpJavLDTWmyaWP3NbF3Wic5VTAkQhierYy3V7JjFvD4dsasiOAlMwBXemuLa9wZXwO9IMAkRqBPM8B33SiC/kBUrjPFd4BJwxOnUinQH6ApOsXXa2gACGvIFLGSwiQjALS7dVWwCAgNJ9V21XqOTqDgNRTQBp1tRUgQKptXxpdRgUIkIwC0u3VVoAAqbZ9aXQZFSBAMgro8u20bJLFOoF6BEgWDeneyitAgFTexDTALAoQIFnUo3srrwABUnkTmxtgHWsaAsSc/zjRUvFOXHwPwGAXCBAn3Np+Jwz6jP3OWniC7vg7AdFtycKgqElSoGgFKIIUbQF6vr4COUzmBIi+eejOiijQ5qyTODuA5EA22ianx1TEDWgYOgrYAUSnJ3QPKeCgAu4CwoUHihQOek5NuuQuIDUxAA3TbQXqCQiFJCteWUVZPX/a98GzolfJGq2ieUtmgsTuqttI/cr4h9YzgiQagi4gBQIFCBDyBFIgRoFaAhKEX1NBuFNdey2TL+etQPkAqbL3VXlseXu2oeeVDxBDA69XM0Serr0JEF3l6L5aKECA1MLMNMhkBeRRlgBJVq74KyhDKswGdgGpkWFrNNTCnLWIB9sFpIgR0TNJAYMK5AsITbMGTUdN5aFAvoDkMaLaPINmmzxMTYDkoXLaZ5DvSxSzJUp8uzUExJbQaSmg68ugQA0BccEsFYG0IsOI8whv2vf9wj8OUgGhKzAEF2YO5/pAEcQ5k0R0iAgsxFIOA0IeUYhH0ENDCjgMCFnKLQWKm7CKezJ9ojC9DxZprfS9bd5Ryk5rj9bIjU3JKIIYUZMa0VHA9ic7dfok3kOAZFGRJuYs6pXi3v8HOZ5zbDYLrEsAAAAASUVORK5CYII=\n"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "2784b85f-a533-4a31-88fc-c79754c38139",
"type": "photos",
"attributes": {
"created_at": "2024-04-29T09:27:23+00:00",
"updated_at": "2024-04-29T09:27:23+00:00",
"original_url": "/uploads/cf01f4aa23d295050bfdc71b0f9f032d/photo/photo/2784b85f-a533-4a31-88fc-c79754c38139/1714382843-96499887846804-0007-4460/upload.png",
"large_url": "/uploads/cf01f4aa23d295050bfdc71b0f9f032d/photo/photo/2784b85f-a533-4a31-88fc-c79754c38139/large_1714382843-96499887846804-0007-4460/upload.jpg",
"xlarge_url": "/uploads/cf01f4aa23d295050bfdc71b0f9f032d/photo/photo/2784b85f-a533-4a31-88fc-c79754c38139/xlarge_1714382843-96499887846804-0007-4460/upload.jpg",
"coordinates": {
"x": 0,
"y": 0
},
"preview": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAMAAADzN3VRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABcVBMVEX///7+///////+//7//v///v7+/v7+/v/9/v73/f78/v7Z8v6H2/1g1/184v3P9f74+/602v5XuP01tvwvvvwoxfw80f2b6v7z/P7t8f6Zu/5VnP5Jof1Eqf0+sf03ufwvwPwtyf1x3v3h+P7k5f+Pnf9ihP5cjP5Wlf5PnP5Io/5Cq/08s/01u/wswvxY1P3S9P7k3P6Nf/JlYtxbZMxVachPb8xTgNxem/VRoP5FpP1Arf06tfwxvPxPzf3M8f7p4PmMadRgQ69YR6NSSaBQT6F1fLe7w93g6PfD2v57s/5NoP1Ep/0/r/1Uyf3Z8/76+PygechlM6RiOaJcPKFpVKutp9Lw8Pfy9v6szf5fpP5IoP1Dqf06sP13zv32/P7p3fF8OqtqKKFsNaWRcL7a0ur9/f7X5v6CtP5Rnv1Fov1NsP3a7/728fmtfsmcZ7/JsN328vn09/681f6Ctv6Ow/7v9/78+v37+fz6+/76/P7k06ScAAAAAWJLR0QCZgt8ZAAAAAd0SU1FB+gEHQkbF0QEbx8AAAGRSURBVCjPNVIHVxYxENzb7F4+sCHNLk1RQVFQ7A1EARvYKKIiKNiwUKy/3pm9j7x395JMMmU3IlIUWiiGiKRCTS2JcKlAMDAXF3ETKZMkNyPKS/hwXLEhKblLhWigwelSp01g45XALOOCePxJTigQEDikcs4k9gpNajEVSinVchbhHIcKbNcaGsOtukMwTDCHljt27tq9p4Z8iRwW7KpZm/Y2t7S2te/brwDIKhFW5cDBQ4ePHO3o7OruqZzm0BU5drz3xMlTff2nzwycPUcPtCBZdHDo/IXhi5cuX7l67fqNm7dUk9FS1tsjo3fG7t4bn5i8/+Dho5bHU5pCR6efPH32/MXMLFZz8y8XXr1+swgLzPN2afnd+5XVUK59+Pjp85c11IrI12/ff6xXYc10Y3Pr5y+VMrz9/lPSOQsCgfLvP8Ylgqge3o2xWQ/84FjQJ60KrznXG1bgrOl287TeXq4Zx6LmxfZZIJDyDB3ja8laJuzyFURP8GpgghUnJRZsH42HHalaCwQ1dDbWLfF9+H+O8CGkTfhjrQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wNC0yOVQwOToyNzoyMyswMDowMP7607kAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDQtMjlUMDk6Mjc6MjMrMDA6MDCPp2sFAAAAAElFTkSuQmCC",
"position": 2,
"photo": {
"url": "/uploads/cf01f4aa23d295050bfdc71b0f9f032d/photo/photo/2784b85f-a533-4a31-88fc-c79754c38139/1714382843-96499887846804-0007-4460/upload.png"
},
"owner_id": "803529fd-3797-4f51-8342-ff9d8f26b790",
"owner_type": "product_groups"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/photos
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[photos]=created_at,updated_at,original_url |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][photo_base64] |
String Base64 encoded photo |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][coordinates] |
Hash Focalpoint coordinates ( { x: 10, y: 100 }). To ensure that a key part of an image stays visible, you can set the image's focal point. The focal point sets the focus of an image, giving you control over where the image is centered. |
data[attributes][position] |
Integer Which position the photo has in the album |
data[attributes][photo] |
Carrierwave_file An object describing the photo. |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of product_groups, bundles |
Includes
This request accepts the following includes:
owner
Updating a photo
How to update a photo:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/photos/5674c983-659b-4fbf-90fa-582b2eeedddf' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "5674c983-659b-4fbf-90fa-582b2eeedddf",
"type": "photos",
"attributes": {
"coordinates": {
"x": 10,
"y": 100
}
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "5674c983-659b-4fbf-90fa-582b2eeedddf",
"type": "photos",
"attributes": {
"created_at": "2024-04-29T09:27:26+00:00",
"updated_at": "2024-04-29T09:27:26+00:00",
"original_url": "/uploads/e9f95df44c8610bbf7710b982755dc98/photo/photo/5674c983-659b-4fbf-90fa-582b2eeedddf/1714382846-598580991047643-0008-3195/upload.png",
"large_url": "/uploads/e9f95df44c8610bbf7710b982755dc98/photo/photo/5674c983-659b-4fbf-90fa-582b2eeedddf/large_1714382846-598580991047643-0008-3195/upload.jpg",
"xlarge_url": "/uploads/e9f95df44c8610bbf7710b982755dc98/photo/photo/5674c983-659b-4fbf-90fa-582b2eeedddf/xlarge_1714382846-598580991047643-0008-3195/upload.jpg",
"coordinates": {
"x": 10,
"y": 100
},
"preview": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAMAAADzN3VRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABcVBMVEX///7+///////+//7//v///v7+/v7+/v/9/v73/f78/v7Z8v6H2/1g1/184v3P9f74+/602v5XuP01tvwvvvwoxfw80f2b6v7z/P7t8f6Zu/5VnP5Jof1Eqf0+sf03ufwvwPwtyf1x3v3h+P7k5f+Pnf9ihP5cjP5Wlf5PnP5Io/5Cq/08s/01u/wswvxY1P3S9P7k3P6Nf/JlYtxbZMxVachPb8xTgNxem/VRoP5FpP1Arf06tfwxvPxPzf3M8f7p4PmMadRgQ69YR6NSSaBQT6F1fLe7w93g6PfD2v57s/5NoP1Ep/0/r/1Uyf3Z8/76+PygechlM6RiOaJcPKFpVKutp9Lw8Pfy9v6szf5fpP5IoP1Dqf06sP13zv32/P7p3fF8OqtqKKFsNaWRcL7a0ur9/f7X5v6CtP5Rnv1Fov1NsP3a7/728fmtfsmcZ7/JsN328vn09/681f6Ctv6Ow/7v9/78+v37+fz6+/76/P7k06ScAAAAAWJLR0QCZgt8ZAAAAAd0SU1FB+gEHQkbGjq1E6IAAAGRSURBVCjPNVIHVxYxENzb7F4+sCHNLk1RQVFQ7A1EARvYKKIiKNiwUKy/3pm9j7x395JMMmU3IlIUWiiGiKRCTS2JcKlAMDAXF3ETKZMkNyPKS/hwXLEhKblLhWigwelSp01g45XALOOCePxJTigQEDikcs4k9gpNajEVSinVchbhHIcKbNcaGsOtukMwTDCHljt27tq9p4Z8iRwW7KpZm/Y2t7S2te/brwDIKhFW5cDBQ4ePHO3o7OruqZzm0BU5drz3xMlTff2nzwycPUcPtCBZdHDo/IXhi5cuX7l67fqNm7dUk9FS1tsjo3fG7t4bn5i8/+Dho5bHU5pCR6efPH32/MXMLFZz8y8XXr1+swgLzPN2afnd+5XVUK59+Pjp85c11IrI12/ff6xXYc10Y3Pr5y+VMrz9/lPSOQsCgfLvP8Ylgqge3o2xWQ/84FjQJ60KrznXG1bgrOl287TeXq4Zx6LmxfZZIJDyDB3ja8laJuzyFURP8GpgghUnJRZsH42HHalaCwQ1dDbWLfF9+H+O8CGkTfhjrQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wNC0yOVQwOToyNzoyNiswMDowMKzC/B4AAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDQtMjlUMDk6Mjc6MjYrMDA6MDDdn0SiAAAAAElFTkSuQmCC",
"position": 1,
"photo": {
"url": "/uploads/e9f95df44c8610bbf7710b982755dc98/photo/photo/5674c983-659b-4fbf-90fa-582b2eeedddf/1714382846-598580991047643-0008-3195/upload.png"
},
"owner_id": "189bbaaf-dff3-4728-8ed6-f81433adb207",
"owner_type": "product_groups"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/photos/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[photos]=created_at,updated_at,original_url |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][photo_base64] |
String Base64 encoded photo |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][coordinates] |
Hash Focalpoint coordinates ( { x: 10, y: 100 }). To ensure that a key part of an image stays visible, you can set the image's focal point. The focal point sets the focus of an image, giving you control over where the image is centered. |
data[attributes][position] |
Integer Which position the photo has in the album |
data[attributes][photo] |
Carrierwave_file An object describing the photo. |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of product_groups, bundles |
Includes
This request accepts the following includes:
owner
Deleting a photo
How to delete a photo:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/photos/4e2388b2-0c5e-40e5-9001-19793fa48763' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "4e2388b2-0c5e-40e5-9001-19793fa48763",
"type": "photos",
"attributes": {
"created_at": "2024-04-29T09:27:29+00:00",
"updated_at": "2024-04-29T09:27:29+00:00",
"original_url": "/uploads/c39fdff99f9050d2378ff88d7dc65a32/photo/photo/4e2388b2-0c5e-40e5-9001-19793fa48763/1714382849-16084798925240-0009-0526/upload.png",
"large_url": "/uploads/c39fdff99f9050d2378ff88d7dc65a32/photo/photo/4e2388b2-0c5e-40e5-9001-19793fa48763/large_1714382849-16084798925240-0009-0526/upload.jpg",
"xlarge_url": "/uploads/c39fdff99f9050d2378ff88d7dc65a32/photo/photo/4e2388b2-0c5e-40e5-9001-19793fa48763/xlarge_1714382849-16084798925240-0009-0526/upload.jpg",
"coordinates": {
"x": "0.00",
"y": "0.00"
},
"preview": "iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAMAAADzN3VRAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAABcVBMVEX///7+///////+//7//v///v7+/v7+/v/9/v73/f78/v7Z8v6H2/1g1/184v3P9f74+/602v5XuP01tvwvvvwoxfw80f2b6v7z/P7t8f6Zu/5VnP5Jof1Eqf0+sf03ufwvwPwtyf1x3v3h+P7k5f+Pnf9ihP5cjP5Wlf5PnP5Io/5Cq/08s/01u/wswvxY1P3S9P7k3P6Nf/JlYtxbZMxVachPb8xTgNxem/VRoP5FpP1Arf06tfwxvPxPzf3M8f7p4PmMadRgQ69YR6NSSaBQT6F1fLe7w93g6PfD2v57s/5NoP1Ep/0/r/1Uyf3Z8/76+PygechlM6RiOaJcPKFpVKutp9Lw8Pfy9v6szf5fpP5IoP1Dqf06sP13zv32/P7p3fF8OqtqKKFsNaWRcL7a0ur9/f7X5v6CtP5Rnv1Fov1NsP3a7/728fmtfsmcZ7/JsN328vn09/681f6Ctv6Ow/7v9/78+v37+fz6+/76/P7k06ScAAAAAWJLR0QCZgt8ZAAAAAd0SU1FB+gEHQkbHaTRhgEAAAGRSURBVCjPNVIHVxYxENzb7F4+sCHNLk1RQVFQ7A1EARvYKKIiKNiwUKy/3pm9j7x395JMMmU3IlIUWiiGiKRCTS2JcKlAMDAXF3ETKZMkNyPKS/hwXLEhKblLhWigwelSp01g45XALOOCePxJTigQEDikcs4k9gpNajEVSinVchbhHIcKbNcaGsOtukMwTDCHljt27tq9p4Z8iRwW7KpZm/Y2t7S2te/brwDIKhFW5cDBQ4ePHO3o7OruqZzm0BU5drz3xMlTff2nzwycPUcPtCBZdHDo/IXhi5cuX7l67fqNm7dUk9FS1tsjo3fG7t4bn5i8/+Dho5bHU5pCR6efPH32/MXMLFZz8y8XXr1+swgLzPN2afnd+5XVUK59+Pjp85c11IrI12/ff6xXYc10Y3Pr5y+VMrz9/lPSOQsCgfLvP8Ylgqge3o2xWQ/84FjQJ60KrznXG1bgrOl287TeXq4Zx6LmxfZZIJDyDB3ja8laJuzyFURP8GpgghUnJRZsH42HHalaCwQ1dDbWLfF9+H+O8CGkTfhjrQAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyNC0wNC0yOVQwOToyNzoyOSswMDowMFqKjPcAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjQtMDQtMjlUMDk6Mjc6MjkrMDA6MDAr1zRLAAAAAElFTkSuQmCC",
"position": 1,
"photo": {
"url": "/uploads/c39fdff99f9050d2378ff88d7dc65a32/photo/photo/4e2388b2-0c5e-40e5-9001-19793fa48763/1714382849-16084798925240-0009-0526/upload.png"
},
"owner_id": "e1d75e51-bb3f-4159-956f-5b24aac14741",
"owner_type": "product_groups"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/product_groups/e1d75e51-bb3f-4159-956f-5b24aac14741"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/photos/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[photos]=created_at,updated_at,original_url |
Includes
This request does not accept any includes
Plannings
Plannings contain information about the quantitative planning of an item. An item can either be a product or a bundle. Planning (in combination with Stock counts) define when an item is available during a given period. Plannings are never directly created or updated through their resource; instead, they are always managed by booking items to an order, updating or deleting its associated line, or transitioning status.
Nested plannings contain information about individual items in a bundle. Note that nested plannings can not be deleted directly, the parent should be deleted instead.
Endpoints
POST api/boomerang/plannings/search
GET /api/boomerang/plannings/{id}
GET /api/boomerang/plannings
Fields
Every planning has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether planning is archived |
archived_at |
Datetime nullable readonlyWhen the planning was archived |
quantity |
Integer readonlyTotal planned |
starts_at |
Datetime readonlyWhen the start action is planned |
stops_at |
Datetime readonlyWhen the stop action is planned |
reserved_from |
Datetime readonlyWhen the items become unavailable |
reserved_till |
Datetime readonlyWhen the items become available again |
reserved |
Boolean readonlyWheter items are reserved |
started |
Integer readonlyAmount of items started. Cannot exceed quantity. This attribute is omitted when this is a parent planning for a Bundle. |
stopped |
Integer readonlyAmount of items stopped. Cannot exceed quantity and started. This attribute is omitted when this is a parent planning for a Bundle. |
location_shortage_amount |
Integer readonlyAmount of items short. This attribute is omitted when this is a parent planning for a Bundle. |
shortage_amount |
Integer readonlyAmount of items short on location (could be there are still available on other locations in the same cluster). This attribute is omitted when this is a parent planning for a Bundle. |
order_id |
Uuid readonlyThe associated Order |
item_id |
Uuid readonlyThe associated Item |
start_location_id |
Uuid readonlyThe associated Start location |
stop_location_id |
Uuid readonlyThe associated Stop location |
parent_planning_id |
Uuid readonlyThe associated Parent planning |
price_tile_id |
Uuid The associated Price tile |
Relationships
Plannings have the following relationships:
| Name | Description |
|---|---|
order |
Orders readonlyAssociated Order |
item |
Items readonlyAssociated Item |
order_line |
Lines readonlyAssociated Order line |
start_location |
Locations readonlyAssociated Start location |
stop_location |
Locations readonlyAssociated Stop location |
parent_planning |
Plannings readonlyAssociated Parent planning |
nested_plannings |
Plannings readonlyAssociated Nested plannings |
stock_item_plannings |
Stock item plannings readonlyAssociated Stock item plannings |
price_tile |
Price tiles readonlyAssociated Price tile |
Searching plannings
Use advanced search to make logical filter groups with and/or operators.
How to search for plannings:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/plannings/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"plannings": "id"
},
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"starts_at": {
"gte": "2024-04-30T09:28:40Z"
}
},
{
"starts_at": {
"lte": "2024-05-03T09:28:40Z"
}
}
]
},
{
"operator": "and",
"attributes": [
{
"stops_at": {
"gte": "2024-04-30T09:28:40Z"
}
},
{
"stops_at": {
"lte": "2024-05-03T09:28:40Z"
}
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "09a8b0e3-e92d-4301-ad06-fcf2e62b405f"
},
{
"id": "7cc7d93a-5ae4-4787-9e51-792d21aabba5"
}
]
}
HTTP Request
POST api/boomerang/plannings/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,item,order_line |
fields[] |
Array List of comma seperated fields to include ?fields[plannings]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
quantity |
Integer eq, not_eq, gt, gte, lt, lte |
starts_at |
Datetime eq, not_eq, gt, gte, lt, lte |
stops_at |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved_from |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved_till |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved |
Boolean eq |
started |
Integer eq, not_eq, gt, gte, lt, lte |
stopped |
Integer eq, not_eq, gt, gte, lt, lte |
location_shortage_amount |
Integer eq, not_eq, gt, gte, lt, lte |
shortage_amount |
Integer eq, not_eq, gt, gte, lt, lte |
order_id |
Uuid eq, not_eq |
item_id |
Uuid eq, not_eq |
start_location_id |
Uuid eq, not_eq |
stop_location_id |
Uuid eq, not_eq |
parent_planning_id |
Uuid eq, not_eq |
price_tile_id |
Uuid eq, not_eq |
q |
String eq |
item_type |
String eq, not_eq |
product_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
order
item =>
photo
order_line
start_location
stop_location
Fetching a planning
How to fetch a planning:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/plannings/a48af31f-00bc-485b-ac58-ea171070490d' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "a48af31f-00bc-485b-ac58-ea171070490d",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:28:42+00:00",
"updated_at": "2024-04-29T09:28:43+00:00",
"archived": false,
"archived_at": null,
"quantity": 1,
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"reserved_from": "1980-04-01T12:00:00+00:00",
"reserved_till": "1980-05-01T12:00:00+00:00",
"reserved": true,
"started": 0,
"stopped": 0,
"location_shortage_amount": 0,
"shortage_amount": 0,
"order_id": "56fbb39d-db2f-4c8a-a039-191a21977b6c",
"item_id": "cb5615c0-f8af-4f04-afb9-23e514323749",
"start_location_id": "1bd7d654-3071-4171-8050-317a8d18800d",
"stop_location_id": "1bd7d654-3071-4171-8050-317a8d18800d",
"parent_planning_id": null,
"price_tile_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/56fbb39d-db2f-4c8a-a039-191a21977b6c"
}
},
"item": {
"links": {
"related": "api/boomerang/items/cb5615c0-f8af-4f04-afb9-23e514323749"
}
},
"order_line": {
"links": {
"related": "api/boomerang/lines?filter[planning_id]=a48af31f-00bc-485b-ac58-ea171070490d"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/1bd7d654-3071-4171-8050-317a8d18800d"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/1bd7d654-3071-4171-8050-317a8d18800d"
}
},
"parent_planning": {
"links": {
"related": null
}
},
"nested_plannings": {
"links": {
"related": "api/boomerang/plannings?filter[parent_planning_id]=a48af31f-00bc-485b-ac58-ea171070490d"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[planning_id]=a48af31f-00bc-485b-ac58-ea171070490d"
}
},
"price_tile": {
"links": {
"related": null
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/plannings/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,item,order_line |
fields[] |
Array List of comma seperated fields to include ?fields[plannings]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
order
item =>
photo
order_line
start_location
stop_location
parent_planning
nested_plannings
Listing plannings
How to fetch a list of plannings:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/plannings' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "8ccc00e2-f16f-48e0-af2e-a7287c9419e7",
"type": "plannings",
"attributes": {
"created_at": "2024-04-29T09:28:50+00:00",
"updated_at": "2024-04-29T09:28:51+00:00",
"archived": false,
"archived_at": null,
"quantity": 1,
"starts_at": "1980-04-01T12:00:00+00:00",
"stops_at": "1980-05-01T12:00:00+00:00",
"reserved_from": "1980-04-01T12:00:00+00:00",
"reserved_till": "1980-05-01T12:00:00+00:00",
"reserved": true,
"started": 0,
"stopped": 0,
"location_shortage_amount": 0,
"shortage_amount": 0,
"order_id": "237a217c-40c1-42f0-8224-d86076164a68",
"item_id": "80bffd01-6003-403d-9379-97d118b535c2",
"start_location_id": "89fabf34-7446-4286-92ec-e0cdd2db32e2",
"stop_location_id": "89fabf34-7446-4286-92ec-e0cdd2db32e2",
"parent_planning_id": null,
"price_tile_id": null
},
"relationships": {
"order": {
"links": {
"related": "api/boomerang/orders/237a217c-40c1-42f0-8224-d86076164a68"
}
},
"item": {
"links": {
"related": "api/boomerang/items/80bffd01-6003-403d-9379-97d118b535c2"
}
},
"order_line": {
"links": {
"related": "api/boomerang/lines?filter[planning_id]=8ccc00e2-f16f-48e0-af2e-a7287c9419e7"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/89fabf34-7446-4286-92ec-e0cdd2db32e2"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/89fabf34-7446-4286-92ec-e0cdd2db32e2"
}
},
"parent_planning": {
"links": {
"related": null
}
},
"nested_plannings": {
"links": {
"related": "api/boomerang/plannings?filter[parent_planning_id]=8ccc00e2-f16f-48e0-af2e-a7287c9419e7"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[planning_id]=8ccc00e2-f16f-48e0-af2e-a7287c9419e7"
}
},
"price_tile": {
"links": {
"related": null
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/plannings
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,item,order_line |
fields[] |
Array List of comma seperated fields to include ?fields[plannings]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
quantity |
Integer eq, not_eq, gt, gte, lt, lte |
starts_at |
Datetime eq, not_eq, gt, gte, lt, lte |
stops_at |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved_from |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved_till |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved |
Boolean eq |
started |
Integer eq, not_eq, gt, gte, lt, lte |
stopped |
Integer eq, not_eq, gt, gte, lt, lte |
location_shortage_amount |
Integer eq, not_eq, gt, gte, lt, lte |
shortage_amount |
Integer eq, not_eq, gt, gte, lt, lte |
order_id |
Uuid eq, not_eq |
item_id |
Uuid eq, not_eq |
start_location_id |
Uuid eq, not_eq |
stop_location_id |
Uuid eq, not_eq |
parent_planning_id |
Uuid eq, not_eq |
price_tile_id |
Uuid eq, not_eq |
q |
String eq |
item_type |
String eq, not_eq |
product_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
order
item =>
photo
order_line
start_location
stop_location
Price rules
A price rule contains a single pricing adjustment rule and belongs to a price ruleset.
A price rule can have one of these types:
- range_of_days: Adjust pricing for certain days of the week,
match_strategycan be one ofwithin, overlap, spanand must be used in combination withfrom_day,till_day,from_time,till_timeandvalue`. - range_of_dates: Adjust pricing for certain calendar days,
match_strategycan be one ofwithin, overlap, spanand must be used in combination withfrom,tillandvalue. - exclude_week_days: Do not charge for certain days of the week,
match_strategycan be one ofwithin, overlap, spanand must be used in combination withfrom_day,till_day,from_time,till_time`. - exclude_date_range: Do not charge for certain calendar days,
match_strategycan be one ofwithin, overlap, spanand must be used in combination withfrom,till. - pickup_day: Rule determines if entire day is charged based on pickup day time,
match_strategymust bestarts_within,chargedetermines if day is charged when beforetimeor not charged if aftertime. - return_day: Rule determines if entire day is charged based on return day time,
match_strategymust bestops_within,chargedetermines if day is charged when beforetimeor not charged if aftertime.
and these match strategies:
- starts_within: Used with
pickup_dayrules - stops_within: Used with
return_dayrules - within: Rule is applied when the rule period fits within the order period.
- overlap: Rule is applied for the part of the rule period that overlaps the order period.
- span: Rule is applied when the rule period spans over the order period.
as well as these adjustment strategies:
- charge: Applies
chargeattribute to determine rule effect, either charges or doesn't charge. Used bypickup_dayandreturn_dayrules types. - percentage: Applies
valueattribute to determine the percentage change to the pricing over the rule period. Used byrange_of_days,range_of_daterule types.
Endpoints
PUT /api/boomerang/price_rules/{id}
POST /api/boomerang/price_rules
DELETE /api/boomerang/price_rules/{id}
Fields
Every price rule has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the rule |
rule_type |
String Determines rule behaviour. One of range_of_days, range_of_dates, exclude_date_range, exclude_week_days, pickup_day, return_day |
match_strategy |
String Determines how dates are matched to the rule. One of starts_within, stops_within, overlap, span, within |
adjustment_strategy |
String Determines wether a price rule adjusts prices by percentage or exact cent ammounts. One of percentage, charge |
value |
Float Adjustment value in percent |
from |
Datetime Defines start of period, used by range_of_dates rule type |
till |
Datetime Defines end of period, used by range_of_dates rule type |
from_day |
Integer Defines start of period in weekdays, 0 is monday, used by range_of_days rule type |
till_day |
Integer Defines end of period in weekdays, 0 is monday, used by range_of_days rule type |
from_time |
String Defines start of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
till_time |
String Defines end of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
charge |
Boolean Determines effect of rules using charge attribute |
stacked |
Boolean If a ruleset consists of multiple rules that adjust the product price, determines if rule should interact with other rules |
time |
String Defines time for adjustment, used by pickup_day and return_day rule types. Format is a HH:mm string, independent of time display settings. |
min_duration |
Integer Rule will only be applied when order period is greater than min duration in seconds |
max_duration |
Integer Rule will only be applied when order period is smaller than max duration in seconds |
price_ruleset_id |
Uuid The associated Price ruleset |
Relationships
Price rules have the following relationships:
| Name | Description |
|---|---|
price_ruleset |
Price rulesets readonlyAssociated Price ruleset |
Updating a price rule
How to update a price rule:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_rules/dd297684-5b51-4dfb-96c2-e144eac59ea0' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "dd297684-5b51-4dfb-96c2-e144eac59ea0",
"type": "price_rules",
"attributes": {
"value": 10
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "dd297684-5b51-4dfb-96c2-e144eac59ea0",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:24:02+00:00",
"updated_at": "2024-04-29T09:24:02+00:00",
"name": "Holidays",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 10.0,
"from": "2030-12-01T00:00:00+00:00",
"till": "2031-01-31T00:00:00+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "39d64720-ec37-4374-8f84-8a09c7c61bbe"
},
"relationships": {
"price_ruleset": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Updating a price rule:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_rules/9a3f7ca7-59d4-4f9a-b0d2-d031379d049a' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "9a3f7ca7-59d4-4f9a-b0d2-d031379d049a",
"type": "price_rules",
"attributes": {
"id": "9a3f7ca7-59d4-4f9a-b0d2-d031379d049a",
"name": "Off season"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "9a3f7ca7-59d4-4f9a-b0d2-d031379d049a",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:24:03+00:00",
"updated_at": "2024-04-29T09:24:03+00:00",
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 5.0,
"from": "2030-12-01T00:00:00+00:00",
"till": "2031-01-31T00:00:00+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "445bdad8-cf8a-46cc-880a-6d31f1268f60"
},
"relationships": {
"price_ruleset": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/price_rules/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_ruleset |
fields[] |
Array List of comma seperated fields to include ?fields[price_rules]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the rule |
data[attributes][rule_type] |
String Determines rule behaviour. One of range_of_days, range_of_dates, exclude_date_range, exclude_week_days, pickup_day, return_day |
data[attributes][match_strategy] |
String Determines how dates are matched to the rule. One of starts_within, stops_within, overlap, span, within |
data[attributes][adjustment_strategy] |
String Determines wether a price rule adjusts prices by percentage or exact cent ammounts. One of percentage, charge |
data[attributes][value] |
Float Adjustment value in percent |
data[attributes][from] |
Datetime Defines start of period, used by range_of_dates rule type |
data[attributes][till] |
Datetime Defines end of period, used by range_of_dates rule type |
data[attributes][from_day] |
Integer Defines start of period in weekdays, 0 is monday, used by range_of_days rule type |
data[attributes][till_day] |
Integer Defines end of period in weekdays, 0 is monday, used by range_of_days rule type |
data[attributes][from_time] |
String Defines start of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
data[attributes][till_time] |
String Defines end of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
data[attributes][charge] |
Boolean Determines effect of rules using charge attribute |
data[attributes][stacked] |
Boolean If a ruleset consists of multiple rules that adjust the product price, determines if rule should interact with other rules |
data[attributes][time] |
String Defines time for adjustment, used by pickup_day and return_day rule types. Format is a HH:mm string, independent of time display settings. |
data[attributes][min_duration] |
Integer Rule will only be applied when order period is greater than min duration in seconds |
data[attributes][max_duration] |
Integer Rule will only be applied when order period is smaller than max duration in seconds |
data[attributes][price_ruleset_id] |
Uuid The associated Price ruleset |
Includes
This request accepts the following includes:
price_ruleset =>
price_rules
Creating a price rule
How to create a price rule:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/price_rules' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "price_rules",
"attributes": {
"price_ruleset_id": "967c893d-b7a6-47f5-a9eb-33fee80b0162",
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"value": 25,
"from": "2024-03-29T09:24:04.244Z",
"till": "2024-05-29T09:24:04.244Z"
}
},
"include": "price_rules"
}'
A 201 status response looks like this:
{
"data": {
"id": "a17c0374-7ba1-468a-9155-7fc68d8e928d",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:24:04+00:00",
"updated_at": "2024-04-29T09:24:04+00:00",
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 25.0,
"from": "2024-03-29T09:24:04+00:00",
"till": "2024-05-29T09:24:04+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "967c893d-b7a6-47f5-a9eb-33fee80b0162"
},
"relationships": {
"price_ruleset": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/price_rules
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_ruleset |
fields[] |
Array List of comma seperated fields to include ?fields[price_rules]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the rule |
data[attributes][rule_type] |
String Determines rule behaviour. One of range_of_days, range_of_dates, exclude_date_range, exclude_week_days, pickup_day, return_day |
data[attributes][match_strategy] |
String Determines how dates are matched to the rule. One of starts_within, stops_within, overlap, span, within |
data[attributes][adjustment_strategy] |
String Determines wether a price rule adjusts prices by percentage or exact cent ammounts. One of percentage, charge |
data[attributes][value] |
Float Adjustment value in percent |
data[attributes][from] |
Datetime Defines start of period, used by range_of_dates rule type |
data[attributes][till] |
Datetime Defines end of period, used by range_of_dates rule type |
data[attributes][from_day] |
Integer Defines start of period in weekdays, 0 is monday, used by range_of_days rule type |
data[attributes][till_day] |
Integer Defines end of period in weekdays, 0 is monday, used by range_of_days rule type |
data[attributes][from_time] |
String Defines start of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
data[attributes][till_time] |
String Defines end of period time, used by range_of_days rule type. Format is a HH:mm string, independent of time display settings. |
data[attributes][charge] |
Boolean Determines effect of rules using charge attribute |
data[attributes][stacked] |
Boolean If a ruleset consists of multiple rules that adjust the product price, determines if rule should interact with other rules |
data[attributes][time] |
String Defines time for adjustment, used by pickup_day and return_day rule types. Format is a HH:mm string, independent of time display settings. |
data[attributes][min_duration] |
Integer Rule will only be applied when order period is greater than min duration in seconds |
data[attributes][max_duration] |
Integer Rule will only be applied when order period is smaller than max duration in seconds |
data[attributes][price_ruleset_id] |
Uuid The associated Price ruleset |
Includes
This request accepts the following includes:
price_ruleset =>
price_rules
Archiving a price rule
How to archive a price ruleset:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/price_rules/38539672-f8f9-47f5-b38a-2c423deaf274' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "38539672-f8f9-47f5-b38a-2c423deaf274",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:24:04+00:00",
"updated_at": "2024-04-29T09:24:04+00:00",
"name": "Holidays",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 5.0,
"from": "2030-12-01T00:00:00+00:00",
"till": "2031-01-31T00:00:00+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "5fce0039-b1ff-414c-9897-b25abc7a53e9"
},
"relationships": {
"price_ruleset": {
"links": {
"related": "api/boomerang/price_rulesets/5fce0039-b1ff-414c-9897-b25abc7a53e9"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/price_rules/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_ruleset |
fields[] |
Array List of comma seperated fields to include ?fields[price_rules]=created_at,updated_at,name |
Includes
This request accepts the following includes:
price_ruleset =>
price_rules
Price rulesets
Price rulesets are used to create elaborate pricing adjustments using the advanced pricing feature.
Endpoints
GET /api/boomerang/price_rulesets/{id}
DELETE /api/boomerang/price_rulesets/{id}
PUT /api/boomerang/price_rulesets/{id}
POST /api/boomerang/price_rulesets
GET /api/boomerang/price_rulesets
Fields
Every price ruleset has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether price ruleset is archived |
archived_at |
Datetime readonlyWhen the price ruleset was archived |
name |
String Name of the ruleset |
description |
String Description of the ruleset |
price_rules_attributes |
Array writeonlyAllows creating and updating price rules with their ruleset |
make_name_unique |
Boolean writeonlyWhen true, a unique name will be generated when a PriceRuleset with the same name already exists. |
Relationships
Price rulesets have the following relationships:
| Name | Description |
|---|---|
price_rules |
Price rules readonlyAssociated Price rules |
Fetching a price ruleset
How to fetch a single price ruleset with related price rules:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_rulesets/d294e7f5-4179-420b-8fdd-6620d705e75b?include=price_rules' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "d294e7f5-4179-420b-8fdd-6620d705e75b",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:09+00:00",
"updated_at": "2024-04-29T09:30:09+00:00",
"archived": false,
"archived_at": null,
"name": "Ruleset",
"description": null
},
"relationships": {
"price_rules": {
"links": {
"related": "api/boomerang/price_rules?filter[price_ruleset_id]=d294e7f5-4179-420b-8fdd-6620d705e75b"
},
"data": [
{
"type": "price_rules",
"id": "5fc1292a-2d59-44d3-a565-4b1be52ed315"
}
]
}
}
},
"included": [
{
"id": "5fc1292a-2d59-44d3-a565-4b1be52ed315",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:30:09+00:00",
"updated_at": "2024-04-29T09:30:09+00:00",
"name": "Price rule",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 30.0,
"from": "2030-07-01T00:00:00+00:00",
"till": "2030-08-31T00:00:00+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "d294e7f5-4179-420b-8fdd-6620d705e75b"
},
"relationships": {
"price_ruleset": {
"links": {
"related": "api/boomerang/price_rulesets/d294e7f5-4179-420b-8fdd-6620d705e75b"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/price_rulesets/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_rules |
fields[] |
Array List of comma seperated fields to include ?fields[price_rulesets]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
price_rules
Archiving a price ruleset
How to archive a price ruleset:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/price_rulesets/45054002-e56c-4285-819a-5624d6b7afd7' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "45054002-e56c-4285-819a-5624d6b7afd7",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:09+00:00",
"updated_at": "2024-04-29T09:30:09+00:00",
"archived": true,
"archived_at": "2024-04-29T09:30:09+00:00",
"name": "Ruleset",
"description": null
},
"relationships": {
"price_rules": {
"links": {
"related": "api/boomerang/price_rules?filter[price_ruleset_id]=45054002-e56c-4285-819a-5624d6b7afd7"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/price_rulesets/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_rulesets]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Updating a price ruleset
Updating a price ruleset's price rules:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_rulesets/94de25df-9c03-4f58-b88e-819dba019bda' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "94de25df-9c03-4f58-b88e-819dba019bda",
"type": "price_rulesets",
"attributes": {
"price_rules_attributes": [
{
"id": "111e32a6-4484-494d-9c46-64d3c229d0df",
"name": "Off season"
}
]
}
},
"include": "price_rules"
}'
A 200 status response looks like this:
{
"data": {
"id": "94de25df-9c03-4f58-b88e-819dba019bda",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:10+00:00",
"updated_at": "2024-04-29T09:30:10+00:00",
"archived": false,
"archived_at": null,
"name": "Ruleset",
"description": null
},
"relationships": {
"price_rules": {
"data": [
{
"type": "price_rules",
"id": "111e32a6-4484-494d-9c46-64d3c229d0df"
}
]
}
}
},
"included": [
{
"id": "111e32a6-4484-494d-9c46-64d3c229d0df",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:30:10+00:00",
"updated_at": "2024-04-29T09:30:10+00:00",
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 30.0,
"from": "2030-07-01T00:00:00+00:00",
"till": "2030-08-31T00:00:00+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "94de25df-9c03-4f58-b88e-819dba019bda"
},
"relationships": {
"price_ruleset": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
How to update a price ruleset:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_rulesets/260dc2e8-834d-4b5a-b720-e52bab1fac05' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "260dc2e8-834d-4b5a-b720-e52bab1fac05",
"type": "price_rulesets",
"attributes": {
"name": "Seasonal ruleset (old)"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "260dc2e8-834d-4b5a-b720-e52bab1fac05",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:11+00:00",
"updated_at": "2024-04-29T09:30:11+00:00",
"archived": false,
"archived_at": null,
"name": "Seasonal ruleset (old)",
"description": null
},
"relationships": {
"price_rules": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/price_rulesets/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_rules |
fields[] |
Array List of comma seperated fields to include ?fields[price_rulesets]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the ruleset |
data[attributes][price_rules_attributes][] |
Array Allows creating and updating price rules with their ruleset |
data[attributes][make_name_unique] |
Boolean When true, a unique name will be generated when a PriceRuleset with the same name already exists. |
Includes
This request accepts the following includes:
price_rules
Creating a price ruleset
How to create a price ruleset with price rules:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/price_rulesets' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "price_rulesets",
"attributes": {
"name": "Seasonal ruleset",
"price_rules_attributes": [
{
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"value": 25,
"from": "2024-03-29T09:30:12.475Z",
"till": "2024-05-29T09:30:12.475Z"
}
]
}
},
"include": "price_rules"
}'
A 201 status response looks like this:
{
"data": {
"id": "e438bf44-8f97-4dc6-83ce-12f6adfd347b",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:12+00:00",
"updated_at": "2024-04-29T09:30:12+00:00",
"archived": false,
"archived_at": null,
"name": "Seasonal ruleset",
"description": null
},
"relationships": {
"price_rules": {
"data": [
{
"type": "price_rules",
"id": "e5f318ae-30eb-4097-81bf-27477ed0fe34"
}
]
}
}
},
"included": [
{
"id": "e5f318ae-30eb-4097-81bf-27477ed0fe34",
"type": "price_rules",
"attributes": {
"created_at": "2024-04-29T09:30:12+00:00",
"updated_at": "2024-04-29T09:30:12+00:00",
"name": "Off season",
"rule_type": "range_of_dates",
"match_strategy": "span",
"adjustment_strategy": "percentage",
"value": 25.0,
"from": "2024-03-29T09:30:12+00:00",
"till": "2024-05-29T09:30:12+00:00",
"from_day": null,
"till_day": null,
"from_time": null,
"till_time": null,
"charge": null,
"stacked": false,
"time": null,
"min_duration": null,
"max_duration": null,
"price_ruleset_id": "e438bf44-8f97-4dc6-83ce-12f6adfd347b"
},
"relationships": {
"price_ruleset": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/price_rulesets
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_rules |
fields[] |
Array List of comma seperated fields to include ?fields[price_rulesets]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the ruleset |
data[attributes][price_rules_attributes][] |
Array Allows creating and updating price rules with their ruleset |
data[attributes][make_name_unique] |
Boolean When true, a unique name will be generated when a PriceRuleset with the same name already exists. |
Includes
This request accepts the following includes:
price_rules
Listing price rulesets
How to fetch price rulesets:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_rulesets' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "92172d65-6adb-4f3c-bf00-2552a1101913",
"type": "price_rulesets",
"attributes": {
"created_at": "2024-04-29T09:30:13+00:00",
"updated_at": "2024-04-29T09:30:13+00:00",
"archived": false,
"archived_at": null,
"name": "Ruleset",
"description": null
},
"relationships": {
"price_rules": {
"links": {
"related": "api/boomerang/price_rules?filter[price_ruleset_id]=92172d65-6adb-4f3c-bf00-2552a1101913"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/price_rulesets
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_rulesets]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_rules_attributes |
Array eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Price structures
Price structures enable you to control what is being priced for a specific period. Price structures consist of tiles that represent a period. The actual charge that is being calculated will always round up to the nearest tile it can find. You can also set up a flat-fee structure after you've run out of tiles by setting one of the following values: hour, day, week, month, year.
There are two kinds of price structures:
reusable: Structures that are reusable and that can be assigned to multiple product groups.private: Structure for a specific product group. These are automatically created when a product group itsprice_typeis set toprivate_structure.
Endpoints
GET /api/boomerang/price_structures/{id}
POST /api/boomerang/price_structures
GET /api/boomerang/price_structures
DELETE /api/boomerang/price_structures/{id}
PUT /api/boomerang/price_structures/{id}
Fields
Every price structure has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether price structure is archived |
archived_at |
Datetime readonlyWhen the price structure was archived |
name |
String Name of the structure |
price_structure_type |
String readonlyOne of reusable, private |
price_tiles_attributes |
Array writeonlyThe price tiles to associate |
product_group_id |
Uuid readonlyThe associated product group for private price structure type |
hour |
Float Multiplier for every hour outside of its tiles |
day |
Float Multiplier for every day outside of its tiles |
week |
Float Multiplier for every week outside of its tiles |
month |
Float Multiplier for every month outside of its tiles |
year |
Float Multiplier for every year outside of its tiles |
Relationships
Price structures have the following relationships:
| Name | Description |
|---|---|
price_tiles |
Price tiles readonlyAssociated Price tiles |
Fetching a price structure
How to fetch a price structure with it's tiles:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_structures/3c6510ba-b6f0-4431-a9f4-59be4374fab7?include=price_tiles' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "3c6510ba-b6f0-4431-a9f4-59be4374fab7",
"type": "price_structures",
"attributes": {
"created_at": "2024-04-29T09:28:09+00:00",
"updated_at": "2024-04-29T09:28:09+00:00",
"archived": false,
"archived_at": null,
"name": "Price per hour (3 hours minimum)",
"price_structure_type": "reusable",
"product_group_id": null,
"hour": 1.0,
"day": 0.0,
"week": 0.0,
"month": 0.0,
"year": 0.0
},
"relationships": {
"price_tiles": {
"links": {
"related": "api/boomerang/price_tiles?filter[price_structure_id]=3c6510ba-b6f0-4431-a9f4-59be4374fab7"
},
"data": [
{
"type": "price_tiles",
"id": "5f5d3d5d-554e-44d1-9c52-29d1c1d93925"
}
]
}
}
},
"included": [
{
"id": "5f5d3d5d-554e-44d1-9c52-29d1c1d93925",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:28:09+00:00",
"updated_at": "2024-04-29T09:28:09+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 1.0,
"period": "hours",
"price_structure_id": "3c6510ba-b6f0-4431-a9f4-59be4374fab7"
},
"relationships": {
"price_structure": {
"links": {
"related": "api/boomerang/price_structures/3c6510ba-b6f0-4431-a9f4-59be4374fab7"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/price_structures/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_tiles |
fields[] |
Array List of comma seperated fields to include ?fields[price_structures]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
price_tiles
Creating a price structure
How to create a price structure with price tiles:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/price_structures' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "price_structures",
"attributes": {
"name": "Price per hour (3 hours minimum)",
"hour": 1,
"price_tiles_attributes": [
{
"name": "3 hours",
"quantity": 3,
"period": "hours",
"multiplier": 1
}
]
}
},
"include": "price_tiles"
}'
A 201 status response looks like this:
{
"data": {
"id": "6c680543-0c6e-4240-b69f-614abdaa26b6",
"type": "price_structures",
"attributes": {
"created_at": "2024-04-29T09:28:10+00:00",
"updated_at": "2024-04-29T09:28:10+00:00",
"archived": false,
"archived_at": null,
"name": "Price per hour (3 hours minimum)",
"price_structure_type": "reusable",
"product_group_id": null,
"hour": 1.0,
"day": 0.0,
"week": 0.0,
"month": 0.0,
"year": 0.0
},
"relationships": {
"price_tiles": {
"data": [
{
"type": "price_tiles",
"id": "f4b34233-8e72-4991-9f76-924c9fa0d5d1"
}
]
}
}
},
"included": [
{
"id": "f4b34233-8e72-4991-9f76-924c9fa0d5d1",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:28:10+00:00",
"updated_at": "2024-04-29T09:28:10+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 1.0,
"period": "hours",
"price_structure_id": "6c680543-0c6e-4240-b69f-614abdaa26b6"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/price_structures
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_tiles |
fields[] |
Array List of comma seperated fields to include ?fields[price_structures]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the structure |
data[attributes][price_tiles_attributes][] |
Array The price tiles to associate |
data[attributes][hour] |
Float Multiplier for every hour outside of its tiles |
data[attributes][day] |
Float Multiplier for every day outside of its tiles |
data[attributes][week] |
Float Multiplier for every week outside of its tiles |
data[attributes][month] |
Float Multiplier for every month outside of its tiles |
data[attributes][year] |
Float Multiplier for every year outside of its tiles |
Includes
This request accepts the following includes:
price_tiles
Listing price structures
How to fetch a list of price structures:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_structures' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "508b50f5-fe06-45e7-ab1a-6fd109eed0b7",
"type": "price_structures",
"attributes": {
"created_at": "2024-04-29T09:28:11+00:00",
"updated_at": "2024-04-29T09:28:11+00:00",
"archived": false,
"archived_at": null,
"name": "Price per hour (3 hours minimum)",
"price_structure_type": "reusable",
"product_group_id": null,
"hour": 1.0,
"day": 0.0,
"week": 0.0,
"month": 0.0,
"year": 0.0
},
"relationships": {
"price_tiles": {
"links": {
"related": "api/boomerang/price_tiles?filter[price_structure_id]=508b50f5-fe06-45e7-ab1a-6fd109eed0b7"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/price_structures
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_structures]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
price_structure_type |
String eq, not_eq |
product_group_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Deleting a price structure
How to delete a price structure with tax rates:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/price_structures/9546d804-7a7b-4298-8075-cbe24f9798d7' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "9546d804-7a7b-4298-8075-cbe24f9798d7",
"type": "price_structures",
"attributes": {
"created_at": "2024-04-29T09:28:12+00:00",
"updated_at": "2024-04-29T09:28:12+00:00",
"archived": true,
"archived_at": "2024-04-29T09:28:12+00:00",
"name": "Price per hour (3 hours minimum) (Deleted)",
"price_structure_type": "reusable",
"product_group_id": null,
"hour": 1.0,
"day": 0.0,
"week": 0.0,
"month": 0.0,
"year": 0.0
},
"relationships": {
"price_tiles": {
"links": {
"related": "api/boomerang/price_tiles?filter[price_structure_id]=9546d804-7a7b-4298-8075-cbe24f9798d7"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/price_structures/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_structures]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Updating a price structure
How to update a price structure with price tiles:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_structures/e509f6f3-f177-47f5-886b-dfafabe1fa24' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "e509f6f3-f177-47f5-886b-dfafabe1fa24",
"type": "price_structures",
"attributes": {
"name": "Charge per week (cut-rate > 3 weeks)",
"price_tiles_attributes": [
{
"id": "cd121ff8-a02a-4433-8364-66a3a7a90483",
"name": "1 semana"
},
{
"id": "cc507029-521a-492c-9934-6413a96e11a7",
"name": "2 semanas"
},
{
"id": "df60bceb-5a9a-4b46-8dd4-8141be032562",
"name": "3 semanas"
},
{
"id": "95a008ec-b4a4-4ef6-95db-63649dd2383a",
"_destroy": true
}
]
}
},
"include": "price_tiles"
}'
A 200 status response looks like this:
{
"data": {
"id": "e509f6f3-f177-47f5-886b-dfafabe1fa24",
"type": "price_structures",
"attributes": {
"created_at": "2024-04-29T09:28:13+00:00",
"updated_at": "2024-04-29T09:28:13+00:00",
"archived": false,
"archived_at": null,
"name": "Charge per week (cut-rate > 3 weeks)",
"price_structure_type": "reusable",
"product_group_id": null,
"hour": 0.0,
"day": 0.0,
"week": 0.8,
"month": 0.0,
"year": 0.0
},
"relationships": {
"price_tiles": {
"data": [
{
"type": "price_tiles",
"id": "cd121ff8-a02a-4433-8364-66a3a7a90483"
},
{
"type": "price_tiles",
"id": "cc507029-521a-492c-9934-6413a96e11a7"
},
{
"type": "price_tiles",
"id": "df60bceb-5a9a-4b46-8dd4-8141be032562"
}
]
}
}
},
"included": [
{
"id": "cd121ff8-a02a-4433-8364-66a3a7a90483",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:28:13+00:00",
"updated_at": "2024-04-29T09:28:13+00:00",
"name": "1 semana",
"quantity": 1,
"length": 604800,
"multiplier": 1.0,
"period": "weeks",
"price_structure_id": "e509f6f3-f177-47f5-886b-dfafabe1fa24"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
},
{
"id": "cc507029-521a-492c-9934-6413a96e11a7",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:28:13+00:00",
"updated_at": "2024-04-29T09:28:13+00:00",
"name": "2 semanas",
"quantity": 2,
"length": 1209600,
"multiplier": 2.0,
"period": "weeks",
"price_structure_id": "e509f6f3-f177-47f5-886b-dfafabe1fa24"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
},
{
"id": "df60bceb-5a9a-4b46-8dd4-8141be032562",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:28:13+00:00",
"updated_at": "2024-04-29T09:28:13+00:00",
"name": "3 semanas",
"quantity": 3,
"length": 1814400,
"multiplier": 3.0,
"period": "weeks",
"price_structure_id": "e509f6f3-f177-47f5-886b-dfafabe1fa24"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/price_structures/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_tiles |
fields[] |
Array List of comma seperated fields to include ?fields[price_structures]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the structure |
data[attributes][price_tiles_attributes][] |
Array The price tiles to associate |
data[attributes][hour] |
Float Multiplier for every hour outside of its tiles |
data[attributes][day] |
Float Multiplier for every day outside of its tiles |
data[attributes][week] |
Float Multiplier for every week outside of its tiles |
data[attributes][month] |
Float Multiplier for every month outside of its tiles |
data[attributes][year] |
Float Multiplier for every year outside of its tiles |
Includes
This request accepts the following includes:
price_tiles
Price tiles
Price tiles hold information on how to calculate a price for a specific period. According to the charge_length, a tile will be picked in price calculations. Note that Booqable always rounds up to the highest tile it can find. The base price of a product is multiplied by the multiplier.
Endpoints
POST /api/boomerang/price_tiles
DELETE /api/boomerang/price_tiles/{id}
GET /api/boomerang/price_tiles
PUT /api/boomerang/price_tiles/{id}
GET /api/boomerang/price_tiles/{id}
Fields
Every price tile has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the tile as it's going to be used in charge labels |
quantity |
Integer Used in combination with period (e.g. 3 with period days) |
length |
Integer readonlyLength in seconds (is computed based on quantity and period) |
multiplier |
Float The amount to multiply a product's base price with (e.g. 2.8 for three days). |
period |
String One of hours, days, weeks, months, years |
price_structure_id |
Uuid The associated Price structure |
Relationships
Price tiles have the following relationships:
| Name | Description |
|---|---|
price_structure |
Price structures readonlyAssociated Price structure |
Creating a price tile
How to create a price tile:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/price_tiles' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "price_tiles",
"attributes": {
"price_structure_id": "e290f7fc-bda2-45b7-b407-5364d3697e12",
"name": "3 hours",
"quantity": 3,
"period": "hours",
"multiplier": 3
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "3916ff6a-b0da-414f-84e0-54d13b45f51d",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:23:12+00:00",
"updated_at": "2024-04-29T09:23:12+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 3.0,
"period": "hours",
"price_structure_id": "e290f7fc-bda2-45b7-b407-5364d3697e12"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/price_tiles
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_structure |
fields[] |
Array List of comma seperated fields to include ?fields[price_tiles]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tile as it's going to be used in charge labels |
data[attributes][quantity] |
Integer Used in combination with period (e.g. 3 with period days) |
data[attributes][multiplier] |
Float The amount to multiply a product's base price with (e.g. 2.8 for three days). |
data[attributes][period] |
String One of hours, days, weeks, months, years |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
Includes
This request accepts the following includes:
price_structure
Deleting a price tile
How to delete a price tile:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/price_tiles/b97bc5ce-1442-4824-8f47-df862a13ff6c' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "b97bc5ce-1442-4824-8f47-df862a13ff6c",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:23:13+00:00",
"updated_at": "2024-04-29T09:23:13+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 3.0,
"period": "hours",
"price_structure_id": "6b1a8cdf-e0ee-4c2e-b921-d17e5dfc91eb"
},
"relationships": {
"price_structure": {
"links": {
"related": "api/boomerang/price_structures/6b1a8cdf-e0ee-4c2e-b921-d17e5dfc91eb"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/price_tiles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_tiles]=created_at,updated_at,name |
Includes
This request does not accept any includes
Listing price tiles
How to fetch a list of price tiles:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_tiles' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "738428a2-1c6c-45e1-b0e0-3689a008840e",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:23:14+00:00",
"updated_at": "2024-04-29T09:23:14+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 3.0,
"period": "hours",
"price_structure_id": "8aa86341-7f36-4f8f-b8e4-b36a91fa8f58"
},
"relationships": {
"price_structure": {
"links": {
"related": "api/boomerang/price_structures/8aa86341-7f36-4f8f-b8e4-b36a91fa8f58"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/price_tiles
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[price_tiles]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
price_structure_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Updating a price tile
How to update a price tile:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/price_tiles/f6352653-bb4e-49e8-9cab-ba75f7ba289f' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "f6352653-bb4e-49e8-9cab-ba75f7ba289f",
"type": "price_tiles",
"attributes": {
"name": "4 days",
"quantity": 4,
"period": "days",
"multiplier": 4
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "f6352653-bb4e-49e8-9cab-ba75f7ba289f",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:23:15+00:00",
"updated_at": "2024-04-29T09:23:15+00:00",
"name": "4 days",
"quantity": 4,
"length": 345600,
"multiplier": 4.0,
"period": "days",
"price_structure_id": "00529424-906a-4f4c-8eb6-fc404b5c5bf2"
},
"relationships": {
"price_structure": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/price_tiles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_structure |
fields[] |
Array List of comma seperated fields to include ?fields[price_tiles]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tile as it's going to be used in charge labels |
data[attributes][quantity] |
Integer Used in combination with period (e.g. 3 with period days) |
data[attributes][multiplier] |
Float The amount to multiply a product's base price with (e.g. 2.8 for three days). |
data[attributes][period] |
String One of hours, days, weeks, months, years |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
Includes
This request accepts the following includes:
price_structure
Fetching a price tile
How to fetch a price tile:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/price_tiles/e9b1919e-ccee-41bc-965e-60ec38fe532a?include=price_tiles' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "e9b1919e-ccee-41bc-965e-60ec38fe532a",
"type": "price_tiles",
"attributes": {
"created_at": "2024-04-29T09:23:16+00:00",
"updated_at": "2024-04-29T09:23:16+00:00",
"name": "3 hours",
"quantity": 3,
"length": 10800,
"multiplier": 3.0,
"period": "hours",
"price_structure_id": "eded19d4-cc73-4fd8-b855-289c510dc73f"
},
"relationships": {
"price_structure": {
"links": {
"related": "api/boomerang/price_structures/eded19d4-cc73-4fd8-b855-289c510dc73f"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/price_tiles/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=price_structure |
fields[] |
Array List of comma seperated fields to include ?fields[price_tiles]=created_at,updated_at,name |
Includes
This request accepts the following includes:
price_structure
Product groups
Product groups hold general information and configuration about products. A product group is always associated with at least one product. When a product group is enabled to have variations, it can have multiple products. Note that product groups are not plannable on orders.
A product group supports the following product types:
- Rental: Rental products are your main products that you rent out. Even if your main product is officially a service, in Booqable you will want to add it as a rental product.
- Consumable: Consumable products are products that you do not plan on getting back. These are meant to be small items that you plan on selling along with a rental but do not expect to be returned with the rest of the order.
- Service: Service Item or Service Products are the optional extra services (or items) your want to offer to your products. These are not trackable, therefore they do not have an instock number.
The following tracking types can be defined:
- None: Products are not tracked (only for product_type
service,consumable) - Trackable: Trackable Products tend to be the larger ticket items; the products you want to know specifically who has what stock item of what product and when. With trackable products, every stock item is has its own identifier so you can assign and track the individual products (only for product_type
rental). - Bulk: Bulk products are for those products you don't necessarily need to track each specific stock item but rather you just need to know how many you have in stock. These tend to be your smaller ticket items or items that are quicker to replace in bulk if some are lost (only for product_type
rental,consumable).
Pricing can be configured by setting one of the following price types:
- None: Products are free (applies to all product types)
- Fixed: Charge a fixed price (applies to all product types).
- Simple: Apply simple pricing (depends on
price_period, only for product_typerental,service). - Structure: Applies associated price structure (only for product_type
rental,service). - Private structure: Applies associated private price structure (only for product_type
rental,service).
Endpoints
POST api/boomerang/product_groups/search
GET /api/boomerang/product_groups
PUT /api/boomerang/product_groups/{id}
POST /api/boomerang/product_groups
DELETE /api/boomerang/product_groups/{id}
GET /api/boomerang/product_groups/{id}
Fields
Every product group has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether item is archived |
archived_at |
Datetime nullable readonlyWhen the item was archived |
type |
String readonlyOne of product_groups, products, bundles |
name |
String Name of the item |
group_name |
String readonlyThe name of the ProductGroup, if this is a Product that is one of the variations in the group. |
slug |
String readonlySlug of the item |
sku |
String Stock keeping unit |
lead_time |
Integer The amount of seconds the item should be unavailable before a reservation |
lag_time |
Integer The amount of seconds the item should be unavailable after a reservation |
product_type |
String One of rental, consumable, service |
tracking_type |
String Tracking type (One of none, bulk, trackable, can only be set on creating ProductGroups) |
trackable |
Boolean Whether stock items are tracked |
has_variations |
Boolean Whether variations are enabled. Not applicable for product_type service |
variation |
Boolean Whether this Item is a variation in a ProductGroup. |
extra_information |
String nullableExtra information about the item, shown on orders and documents |
photo_url |
String readonlyMain photo url |
description |
String nullableDescription used in the online store |
show_in_store |
Boolean Whether to show this item in the online |
sorting_weight |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
base_price_in_cents |
Integer readonlyThe value that is being calculated with (based on the current price_type) |
price_type |
String One of structure, private_structure, fixed, simple, none |
price_period |
String One of hour, day, week, month (Only used for price type simple) |
deposit_in_cents |
Integer The value to use for deposit calculations |
discountable |
Boolean Whether discounts should be applied to this item (note that price rules will still apply) |
taxable |
Boolean Whether item is taxable |
seo_title |
String SEO title tag |
seo_description |
String SEO meta description tag |
tag_list |
Array List of tags |
properties |
Hash readonlyKey value pairs of associated properties |
photo_id |
Uuid readonlyThe associated Photo |
tax_category_id |
Uuid The associated Tax category |
price_ruleset_id |
Uuid The associated Price ruleset |
price_structure_id |
Uuid The associated Price structure |
allow_shortage |
Boolean Whether shortages are allowed |
shortage_limit |
Integer The maximum allowed shortage for any date range |
variation_fields |
Array Array of fields that distinguish variations (e.g. color or size) |
flat_fee_price_in_cents |
Integer Use this value when price type is simple |
structure_price_in_cents |
Integer Use this value when price type is structure or private_structure |
properties_attributes |
Array writeonlyCreate or update multiple properties associated with this product group |
stock_item_properties |
Array Available properties for stock items |
confirm_shortage |
Boolean writeonlyWhether to confirm the shortage (over limit by changing shortage_limit) |
remote_photo_url |
String writeonlyUrl to an image on the web |
photo_base64 |
String writeonlyBase64 encoded photo, use this field to store a main photo |
Relationships
Product groups have the following relationships:
| Name | Description |
|---|---|
photo |
Photos readonlyAssociated Photo |
tax_category |
Tax categories readonlyAssociated Tax category |
price_ruleset |
Price rulesets readonlyAssociated Price ruleset |
price_structure |
Price structures readonlyAssociated Price structure |
inventory_levels |
Inventory levels readonlyAssociated Inventory levels |
properties |
Properties readonlyAssociated Properties |
products |
Products readonlyAssociated Products |
Searching product groups
Use advanced search to make logical filter groups with and/or operators.
How to search for product groups:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/product_groups/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"product_groups": "id"
},
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"discountable": true
},
{
"taxable": true
}
]
},
{
"operator": "and",
"attributes": [
{
"show_in_store": true
},
{
"taxable": true
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "e704b98d-ebff-422a-8748-50addeca301c"
},
{
"id": "c3962399-6b52-4bf5-81a4-73582f572a90"
},
{
"id": "12c9d4c8-f77f-4996-9a28-bc42aa27fdc2"
}
]
}
HTTP Request
POST api/boomerang/product_groups/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,properties |
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq |
allow_shortage |
Boolean eq |
shortage_limit |
Integer eq, not_eq, gt, gte, lt, lte |
flat_fee_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
structure_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
photo_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
photo
properties
Listing product groups
How to fetch a list of product groups:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/product_groups' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "367e6d85-41c0-43a9-b683-78847b94e7e1",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:23:54+00:00",
"updated_at": "2024-04-29T09:23:54+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad Pro",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": false,
"shortage_limit": 0,
"variation_fields": [],
"flat_fee_price_in_cents": 0,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=367e6d85-41c0-43a9-b683-78847b94e7e1"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=367e6d85-41c0-43a9-b683-78847b94e7e1&filter[owner_type]=product_groups"
}
},
"products": {
"links": {
"related": "api/boomerang/products?filter[product_group_id]=367e6d85-41c0-43a9-b683-78847b94e7e1"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/product_groups
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,properties |
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
String eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq |
allow_shortage |
Boolean eq |
shortage_limit |
Integer eq, not_eq, gt, gte, lt, lte |
flat_fee_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
structure_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
photo_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
photo
properties
Updating a product group
How to update a product group:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/product_groups/4bcf0b5a-c60f-4918-9e68-abf31fe0bb13' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "4bcf0b5a-c60f-4918-9e68-abf31fe0bb13",
"type": "product_groups",
"attributes": {
"name": "iPad mini"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4bcf0b5a-c60f-4918-9e68-abf31fe0bb13",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:23:55+00:00",
"updated_at": "2024-04-29T09:23:55+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad mini",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": false,
"shortage_limit": 0,
"variation_fields": [],
"flat_fee_price_in_cents": 0,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"products": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/product_groups/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,properties,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the item |
data[attributes][sku] |
String Stock keeping unit |
data[attributes][lead_time] |
Integer The amount of seconds the item should be unavailable before a reservation |
data[attributes][lag_time] |
Integer The amount of seconds the item should be unavailable after a reservation |
data[attributes][product_type] |
String One of rental, consumable, service |
data[attributes][tracking_type] |
String Tracking type (One of none, bulk, trackable, can only be set on creating ProductGroups) |
data[attributes][trackable] |
Boolean Whether stock items are tracked |
data[attributes][has_variations] |
Boolean Whether variations are enabled. Not applicable for product_type service |
data[attributes][variation] |
Boolean Whether this Item is a variation in a ProductGroup. |
data[attributes][extra_information] |
String Extra information about the item, shown on orders and documents |
data[attributes][show_in_store] |
Boolean Whether to show this item in the online |
data[attributes][sorting_weight] |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
data[attributes][price_type] |
String One of structure, private_structure, fixed, simple, none |
data[attributes][price_period] |
String One of hour, day, week, month (Only used for price type simple) |
data[attributes][deposit_in_cents] |
Integer The value to use for deposit calculations |
data[attributes][discountable] |
Boolean Whether discounts should be applied to this item (note that price rules will still apply) |
data[attributes][taxable] |
Boolean Whether item is taxable |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][tag_list][] |
Array List of tags |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
data[attributes][price_ruleset_id] |
Uuid The associated Price ruleset |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
data[attributes][allow_shortage] |
Boolean Whether shortages are allowed |
data[attributes][shortage_limit] |
Integer The maximum allowed shortage for any date range |
data[attributes][variation_fields][] |
Array Array of fields that distinguish variations (e.g. color or size) |
data[attributes][flat_fee_price_in_cents] |
Integer Use this value when price type is simple |
data[attributes][structure_price_in_cents] |
Integer Use this value when price type is structure or private_structure |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this product group |
data[attributes][stock_item_properties][] |
Array Available properties for stock items |
data[attributes][confirm_shortage] |
Boolean Whether to confirm the shortage (over limit by changing shortage_limit) |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][photo_base64] |
String Base64 encoded photo, use this field to store a main photo |
Includes
This request accepts the following includes:
photo
properties
tax_category
barcode
price_structure =>
price_tiles
Creating a product group
How to create a product group:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/product_groups' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "product_groups",
"attributes": {
"name": "iPad mini",
"tracking_type": "trackable",
"trackable": true,
"price_type": "simple",
"price_period": "day",
"tag_list": [
"tablets",
"apple"
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "d7c2b92d-57b9-422d-8c26-8b0845c2fff0",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:23:56+00:00",
"updated_at": "2024-04-29T09:23:56+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad mini",
"group_name": null,
"slug": "ipad-mini",
"sku": "IPAD_MINI",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "trackable",
"trackable": true,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [
"tablets",
"apple"
],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": false,
"shortage_limit": 0,
"variation_fields": [],
"flat_fee_price_in_cents": 0,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"products": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/product_groups
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,properties,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the item |
data[attributes][sku] |
String Stock keeping unit |
data[attributes][lead_time] |
Integer The amount of seconds the item should be unavailable before a reservation |
data[attributes][lag_time] |
Integer The amount of seconds the item should be unavailable after a reservation |
data[attributes][product_type] |
String One of rental, consumable, service |
data[attributes][tracking_type] |
String Tracking type (One of none, bulk, trackable, can only be set on creating ProductGroups) |
data[attributes][trackable] |
Boolean Whether stock items are tracked |
data[attributes][has_variations] |
Boolean Whether variations are enabled. Not applicable for product_type service |
data[attributes][variation] |
Boolean Whether this Item is a variation in a ProductGroup. |
data[attributes][extra_information] |
String Extra information about the item, shown on orders and documents |
data[attributes][show_in_store] |
Boolean Whether to show this item in the online |
data[attributes][sorting_weight] |
Integer Defines sort order in the online store, the lower the weight - the higher it shows up in lists |
data[attributes][price_type] |
String One of structure, private_structure, fixed, simple, none |
data[attributes][price_period] |
String One of hour, day, week, month (Only used for price type simple) |
data[attributes][deposit_in_cents] |
Integer The value to use for deposit calculations |
data[attributes][discountable] |
Boolean Whether discounts should be applied to this item (note that price rules will still apply) |
data[attributes][taxable] |
Boolean Whether item is taxable |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][tag_list][] |
Array List of tags |
data[attributes][tax_category_id] |
Uuid The associated Tax category |
data[attributes][price_ruleset_id] |
Uuid The associated Price ruleset |
data[attributes][price_structure_id] |
Uuid The associated Price structure |
data[attributes][allow_shortage] |
Boolean Whether shortages are allowed |
data[attributes][shortage_limit] |
Integer The maximum allowed shortage for any date range |
data[attributes][variation_fields][] |
Array Array of fields that distinguish variations (e.g. color or size) |
data[attributes][flat_fee_price_in_cents] |
Integer Use this value when price type is simple |
data[attributes][structure_price_in_cents] |
Integer Use this value when price type is structure or private_structure |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this product group |
data[attributes][stock_item_properties][] |
Array Available properties for stock items |
data[attributes][confirm_shortage] |
Boolean Whether to confirm the shortage (over limit by changing shortage_limit) |
data[attributes][remote_photo_url] |
String Url to an image on the web |
data[attributes][photo_base64] |
String Base64 encoded photo, use this field to store a main photo |
Includes
This request accepts the following includes:
photo
properties
tax_category
barcode
price_structure =>
price_tiles
Archiving a product group
How to delete a product group:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/product_groups/5e8aa06d-5b48-4d25-b440-ce1447c7a4f0' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "5e8aa06d-5b48-4d25-b440-ce1447c7a4f0",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:23:57+00:00",
"updated_at": "2024-04-29T09:23:57+00:00",
"archived": true,
"archived_at": "2024-04-29T09:23:57+00:00",
"type": "product_groups",
"name": "iPad Pro",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": false,
"shortage_limit": 0,
"variation_fields": [],
"flat_fee_price_in_cents": 0,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"products": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/product_groups/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Fetching a product group
How to fetch a product group:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/product_groups/9e7d54f6-f9c1-406f-aa95-4a174f8d271a' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "9e7d54f6-f9c1-406f-aa95-4a174f8d271a",
"type": "product_groups",
"attributes": {
"created_at": "2024-04-29T09:23:58+00:00",
"updated_at": "2024-04-29T09:23:58+00:00",
"archived": false,
"archived_at": null,
"type": "product_groups",
"name": "iPad Pro",
"group_name": null,
"slug": "ipad-pro",
"sku": "SKU",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": false,
"variation": false,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 0,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"allow_shortage": false,
"shortage_limit": 0,
"variation_fields": [],
"flat_fee_price_in_cents": 0,
"structure_price_in_cents": 0,
"stock_item_properties": []
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=9e7d54f6-f9c1-406f-aa95-4a174f8d271a"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=9e7d54f6-f9c1-406f-aa95-4a174f8d271a&filter[owner_type]=product_groups"
}
},
"products": {
"links": {
"related": "api/boomerang/products?filter[product_group_id]=9e7d54f6-f9c1-406f-aa95-4a174f8d271a"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/product_groups/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=photo,properties,tax_category |
fields[] |
Array List of comma seperated fields to include ?fields[product_groups]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
photo
properties
tax_category
barcode
products
price_structure =>
price_tiles
Products
Products are items that are plannable on orders. They always belong to a product group and can only be created separately if the group has variations enabled.
Most of the settings are inherited from the associated product group. When the group has variations enabled, the base_price_in_cents field is not inherited from the group anymore but can be set individually.
Endpoints
POST /api/boomerang/products
GET /api/boomerang/products
GET /api/boomerang/products/{id}
PUT /api/boomerang/products/{id}
DELETE /api/boomerang/products/{id}
POST api/boomerang/products/search
Fields
Every product has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether item is archived |
archived_at |
Datetime nullable readonlyWhen the item was archived |
type |
String readonlyOne of product_groups, products, bundles |
name |
String readonlyName of the item (based on product group and variations_values) |
group_name |
String readonlyThe name of the ProductGroup, if this is a Product that is one of the variations in the group. |
slug |
String readonlySlug of the item |
sku |
String Stock keeping unit |
lead_time |
Integer readonlyInherited from product group: The amount of seconds the item should be unavailable before a reservation |
lag_time |
Integer readonlyInherited from product group: The amount of seconds the item should be unavailable after a reservation |
product_type |
String readonlyInherited from product group: One of rental, consumable, service |
tracking_type |
String readonlyInherited from product group: Tracking type (One of none, bulk, trackable, can only be set on creating ProductGroups) |
trackable |
Boolean readonlyInherited from product group: Whether stock items are tracked |
has_variations |
Boolean Whether variations are enabled. Not applicable for product_type service |
variation |
Boolean readonlyWhether this Item is a variation in a ProductGroup. |
extra_information |
String readonlyInherited from product group: Extra information about the item, shown on orders and documents |
photo_url |
String readonlyMain photo url |
description |
String readonlyInherited from product group: Description used in the online store |
show_in_store |
Boolean readonlyInherited from product group: Whether to show this item in the online |
sorting_weight |
Integer Defines sorting weight within its associated product group, the lower the weight - the higher it shows up in lists |
base_price_in_cents |
Integer The value that is being calculated with. This value is writable if group has variations enabled, otherwise it's inherited from the group |
price_type |
String readonlyInherited from product group: One of structure, private_structure, fixed, simple, none |
price_period |
String readonlyInherited from product group: One of hour, day, week, month (Only used for price type simple) |
deposit_in_cents |
Integer The value to use for deposit calculations |
discountable |
Boolean readonlyInherited from product group: Whether discounts should be applied to this item (note that price rules will still apply) |
taxable |
Boolean readonlyInherited from product group: Whether item is taxable |
seo_title |
String SEO title tag |
seo_description |
String SEO meta description tag |
tag_list |
Array readonlyInherited from product group: List of tags |
properties |
Hash readonlyInherited from product group: Key value pairs of associated properties |
photo_id |
Uuid The associated Photo |
tax_category_id |
Uuid readonlyThe associated Tax category |
price_ruleset_id |
Uuid readonlyThe associated Price ruleset |
price_structure_id |
Uuid readonlyThe associated Price structure |
product_group_id |
Uuid The associated Product group |
variation_values |
Array List of values for product_group.variation_fields (Should be in the same order) |
allow_shortage |
Boolean readonlyInherited from product group: Whether shortages are allowed |
shortage_limit |
Integer readonlyInherited from product group: The maximum allowed shortage for any date range |
confirm_shortage |
Boolean writeonlyWhether to confirm the shortage (over limit by changing shortage_limit) |
Relationships
Products have the following relationships:
| Name | Description |
|---|---|
photo |
Photos readonlyAssociated Photo |
tax_category |
Tax categories readonlyAssociated Tax category |
price_ruleset |
Price rulesets readonlyAssociated Price ruleset |
price_structure |
Price structures readonlyAssociated Price structure |
inventory_levels |
Inventory levels readonlyAssociated Inventory levels |
properties |
Properties readonlyAssociated Properties |
product_group |
Product groups readonlyAssociated Product group |
barcode |
Barcodes Associated Barcode |
Creating a product
How to create a product:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/products' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "products",
"attributes": {
"product_group_id": "61d0145c-57c0-4c33-91ee-dc8ba2a1b4ec",
"variation_values": [
"red"
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "6be626ee-82ad-4254-b79e-def338a60d83",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:46+00:00",
"updated_at": "2024-04-29T09:26:46+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro - red",
"group_name": "iPad Pro",
"slug": "ipad-pro-red",
"sku": null,
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 3,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"red"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "61d0145c-57c0-4c33-91ee-dc8ba2a1b4ec"
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/products
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][sku] |
String Stock keeping unit |
data[attributes][has_variations] |
Boolean Whether variations are enabled. Not applicable for product_type service |
data[attributes][sorting_weight] |
Integer Defines sorting weight within its associated product group, the lower the weight - the higher it shows up in lists |
data[attributes][base_price_in_cents] |
Integer The value that is being calculated with. This value is writable if group has variations enabled, otherwise it's inherited from the group |
data[attributes][deposit_in_cents] |
Integer The value to use for deposit calculations |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][photo_id] |
Uuid The associated Photo |
data[attributes][product_group_id] |
Uuid The associated Product group |
data[attributes][variation_values][] |
Array List of values for product_group.variation_fields (Should be in the same order) |
data[attributes][confirm_shortage] |
Boolean Whether to confirm the shortage (over limit by changing shortage_limit) |
Includes
This request accepts the following includes:
barcode
inventory_levels
photo
price_structure =>
price_tiles
product_group
properties
tax_category
Listing products
How to fetch a list of products:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/products' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "be366c4c-1211-4c69-8e65-6963db638cdc",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:47+00:00",
"updated_at": "2024-04-29T09:26:48+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro",
"group_name": "iPad Pro",
"slug": "ipad-pro",
"sku": null,
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"green"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "e92b8a37-710b-4baf-944c-e12795008653"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=be366c4c-1211-4c69-8e65-6963db638cdc"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=e92b8a37-710b-4baf-944c-e12795008653&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/e92b8a37-710b-4baf-944c-e12795008653"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=be366c4c-1211-4c69-8e65-6963db638cdc&filter[owner_type]=products"
}
}
}
},
{
"id": "251eb402-141c-4c4e-a8d5-7fde485e5d19",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:48+00:00",
"updated_at": "2024-04-29T09:26:48+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro - blue",
"group_name": "iPad Pro",
"slug": "ipad-pro-blue",
"sku": "PRODUCT 1000046",
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 2,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"blue"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "e92b8a37-710b-4baf-944c-e12795008653"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=251eb402-141c-4c4e-a8d5-7fde485e5d19"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=e92b8a37-710b-4baf-944c-e12795008653&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/e92b8a37-710b-4baf-944c-e12795008653"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=251eb402-141c-4c4e-a8d5-7fde485e5d19&filter[owner_type]=products"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/products
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
Array eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq, not_eq |
allow_shortage |
Boolean eq |
shortage_limit |
Integer eq, not_eq, gt, gte, lt, lte |
photo_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
barcode
inventory_levels
photo
price_structure =>
price_tiles
product_group
properties
tax_category
Fetching a product
How to fetch a product:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/products/07c4e3a8-7dcf-4d95-87aa-abfcc537a576' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "07c4e3a8-7dcf-4d95-87aa-abfcc537a576",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:48+00:00",
"updated_at": "2024-04-29T09:26:49+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro",
"group_name": "iPad Pro",
"slug": "ipad-pro",
"sku": null,
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"green"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "62376b34-cb72-4324-839d-a9d3d308a876"
},
"relationships": {
"photo": {
"links": {
"related": null
}
},
"tax_category": {
"links": {
"related": null
}
},
"price_ruleset": {
"links": {
"related": null
}
},
"price_structure": {
"links": {
"related": null
}
},
"inventory_levels": {
"links": {
"related": "api/boomerang/inventory_levels?filter[item_id]=07c4e3a8-7dcf-4d95-87aa-abfcc537a576"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=62376b34-cb72-4324-839d-a9d3d308a876&filter[owner_type]=products"
}
},
"product_group": {
"links": {
"related": "api/boomerang/product_groups/62376b34-cb72-4324-839d-a9d3d308a876"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=07c4e3a8-7dcf-4d95-87aa-abfcc537a576&filter[owner_type]=products"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/products/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
barcode
inventory_levels
photo
price_structure =>
price_tiles
product_group
properties
tax_category
Updating a product
How to update a product:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/products/e29dd8f6-2747-447b-816b-9af1c3608193' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "e29dd8f6-2747-447b-816b-9af1c3608193",
"type": "products",
"attributes": {
"variation_values": [
"red"
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e29dd8f6-2747-447b-816b-9af1c3608193",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:50+00:00",
"updated_at": "2024-04-29T09:26:50+00:00",
"archived": false,
"archived_at": null,
"type": "products",
"name": "iPad Pro - red",
"group_name": "iPad Pro",
"slug": "ipad-pro",
"sku": null,
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"red"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "bfd35208-f2a3-4292-b604-c393b73eab81"
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/products/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][sku] |
String Stock keeping unit |
data[attributes][has_variations] |
Boolean Whether variations are enabled. Not applicable for product_type service |
data[attributes][sorting_weight] |
Integer Defines sorting weight within its associated product group, the lower the weight - the higher it shows up in lists |
data[attributes][base_price_in_cents] |
Integer The value that is being calculated with. This value is writable if group has variations enabled, otherwise it's inherited from the group |
data[attributes][deposit_in_cents] |
Integer The value to use for deposit calculations |
data[attributes][seo_title] |
String SEO title tag |
data[attributes][seo_description] |
String SEO meta description tag |
data[attributes][photo_id] |
Uuid The associated Photo |
data[attributes][product_group_id] |
Uuid The associated Product group |
data[attributes][variation_values][] |
Array List of values for product_group.variation_fields (Should be in the same order) |
data[attributes][confirm_shortage] |
Boolean Whether to confirm the shortage (over limit by changing shortage_limit) |
Includes
This request accepts the following includes:
barcode
inventory_levels
photo
price_structure =>
price_tiles
product_group
properties
tax_category
Archiving a product
How to delete a product:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/products/6d8899bc-ce5d-4759-a9af-31e4cc084d25' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "6d8899bc-ce5d-4759-a9af-31e4cc084d25",
"type": "products",
"attributes": {
"created_at": "2024-04-29T09:26:51+00:00",
"updated_at": "2024-04-29T09:26:52+00:00",
"archived": true,
"archived_at": "2024-04-29T09:26:52+00:00",
"type": "products",
"name": "iPad Pro",
"group_name": "iPad Pro",
"slug": "ipad-pro",
"sku": null,
"lead_time": 0,
"lag_time": 0,
"product_type": "rental",
"tracking_type": "bulk",
"trackable": false,
"has_variations": true,
"variation": true,
"extra_information": null,
"photo_url": null,
"description": null,
"show_in_store": true,
"sorting_weight": 1,
"base_price_in_cents": 0,
"price_type": "simple",
"price_period": "day",
"deposit_in_cents": 0,
"discountable": true,
"taxable": true,
"seo_title": null,
"seo_description": null,
"tag_list": [],
"properties": {},
"photo_id": null,
"tax_category_id": null,
"price_ruleset_id": null,
"price_structure_id": null,
"variation_values": [
"green"
],
"allow_shortage": false,
"shortage_limit": 0,
"product_group_id": "ac2b874b-1322-48c1-920d-8b471829e38d"
},
"relationships": {
"photo": {
"meta": {
"included": false
}
},
"tax_category": {
"meta": {
"included": false
}
},
"price_ruleset": {
"meta": {
"included": false
}
},
"price_structure": {
"meta": {
"included": false
}
},
"inventory_levels": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"product_group": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/products/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Searching products
Use advanced search to make logical filter groups with and/or operators.
How to search for products:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/products/search' \
--header 'content-type: application/json' \
--data '{
"fields": {
"products": "id"
},
"filter": {
"conditions": {
"operator": "or",
"attributes": [
{
"operator": "and",
"attributes": [
{
"discountable": true
},
{
"taxable": true
}
]
},
{
"operator": "and",
"attributes": [
{
"show_in_store": true
},
{
"taxable": true
}
]
}
]
}
}
}'
A 200 status response looks like this:
{
"data": [
{
"id": "34fe18a6-50ed-4b85-8ec7-8c478100ae3e"
},
{
"id": "1b56b146-0081-4324-bec8-3cee51be15a3"
},
{
"id": "ee9b253f-a66c-4579-9c61-40c60db0d05f"
},
{
"id": "52cc556a-41eb-41a5-92a2-32313e7ce1f3"
}
]
}
HTTP Request
POST api/boomerang/products/search
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,inventory_levels,photo |
fields[] |
Array List of comma seperated fields to include ?fields[products]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
type |
String eq, not_eq |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
group_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
slug |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
sku |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
lead_time |
Integer eq, not_eq, gt, gte, lt, lte |
lag_time |
Integer eq, not_eq, gt, gte, lt, lte |
product_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tracking_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
trackable |
Boolean eq |
has_variations |
Boolean eq |
variation |
Boolean eq |
extra_information |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
show_in_store |
Boolean eq |
sorting_weight |
Integer eq, not_eq, gt, gte, lt, lte |
base_price_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
price_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
price_period |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
deposit_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
discountable |
Boolean eq |
taxable |
Boolean eq |
seo_title |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
seo_description |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
tag_list |
Array eq |
tax_category_id |
Uuid eq, not_eq |
price_ruleset_id |
Uuid eq, not_eq |
price_structure_id |
Uuid eq, not_eq |
q |
String eq |
collection_id |
Uuid eq, not_eq |
product_group_id |
Uuid eq, not_eq |
allow_shortage |
Boolean eq |
shortage_limit |
Integer eq, not_eq, gt, gte, lt, lte |
photo_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
archived |
Array count |
tag_list |
Array count |
taxable |
Array count |
discountable |
Array count |
product_type |
Array count |
tracking_type |
Array count |
show_in_store |
Array count |
price_type |
Array count |
price_period |
Array count |
tax_category_id |
Array count |
deposit_in_cents |
Array sum, maximum, minimum, average |
base_price_in_cents |
Array sum, maximum, minimum, average |
Includes
This request accepts the following includes:
barcode
inventory_levels
photo
price_structure =>
price_tiles
product_group
properties
tax_category
Properties
While Booqable comes with standard fields, like a customer's name and a product's SKU, you can add custom properties to capture additional information that's important for you or your customers.
Types
Properties can have different types and behave differently. These are the values you can supply for each type:
| text_field | Renders a text field |
|---|---|
value |
String |
| text_area | Renders a text area |
|---|---|
value |
String |
| phone | Renders a phone field |
|---|---|
value |
String |
| Renders an email field | |
|---|---|
value |
String |
| date | Renders a date picker |
|---|---|
value |
String |
| select | Renders a dropdown select |
|---|---|
value |
String |
| address | Renders multiple fields |
|---|---|
first_name |
String |
last_name |
String |
address1 |
String |
address2 |
String |
city |
String |
region |
String |
zipcode |
String |
country |
String |
country_id |
UUID |
province_id |
UUID |
Properties inherit their configuration fields from a default property when they are connected. When creating properties, they are mapped with their default when one of the following fields correspond:
nameidentifierdefault_property_id
Endpoints
POST /api/boomerang/properties
GET /api/boomerang/properties/{id}
DELETE /api/boomerang/properties/{id}
PUT /api/boomerang/properties/{id}
GET /api/boomerang/properties
Fields
Every property has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String Name of the property (used as label and to compute identifier if left blank) |
identifier |
String Key that will be used in exports, responses and custom field variables in templates |
position |
Integer Which position the property has |
property_type |
String One of address, date_field, email, phone, select, text_area, text_field |
show_on |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
validation_required |
Boolean Whether this property has to be validated |
meets_validation_requirements |
Boolean Whether this property meets the validation requirements |
first_name |
String For type address |
last_name |
String For type address |
address1 |
String For type address |
address2 |
String For type address |
city |
String For type address |
region |
String For type address |
zipcode |
String For type address |
country |
String For type address |
country_id |
String For type address |
province_id |
String For type address |
value |
String For type text_field, text_area, phone, email, date_field, select |
default_property_id |
Uuid The associated Default property |
owner_id |
Uuid ID of its owner |
owner_type |
String The resource type of the owner. One of companies, customers, locations, orders, product_groups, stock_items, users |
Relationships
Properties have the following relationships:
| Name | Description |
|---|---|
default_property |
Default properties readonlyAssociated Default property |
owner |
Customer, Order, Product group, Stock item Associated Owner |
Creating a property
How to create a property and assign it to an owner:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/properties' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "properties",
"attributes": {
"name": "Phone",
"property_type": "phone",
"value": "+316000000",
"owner_id": "04c4a8f8-1267-45e8-87e8-031306f0a8da",
"owner_type": "customers"
}
},
"include": "owner"
}'
A 201 status response looks like this:
{
"data": {
"id": "3d4dfc89-c9f6-4139-9e16-24c51522b551",
"type": "properties",
"attributes": {
"created_at": "2024-04-29T09:29:35+00:00",
"updated_at": "2024-04-29T09:29:35+00:00",
"name": "Phone",
"identifier": "phone",
"position": 0,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"meets_validation_requirements": true,
"value": "+316000000",
"default_property_id": null,
"owner_id": "04c4a8f8-1267-45e8-87e8-031306f0a8da",
"owner_type": "customers"
},
"relationships": {
"default_property": {
"meta": {
"included": false
}
},
"owner": {
"data": {
"type": "customers",
"id": "04c4a8f8-1267-45e8-87e8-031306f0a8da"
}
}
}
},
"included": [
{
"id": "04c4a8f8-1267-45e8-87e8-031306f0a8da",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:35+00:00",
"updated_at": "2024-04-29T09:29:35+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "Jane Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"phone": "+316000000"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/properties
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[properties]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the property (used as label and to compute identifier if left blank) |
data[attributes][identifier] |
String Key that will be used in exports, responses and custom field variables in templates |
data[attributes][position] |
Integer Which position the property has |
data[attributes][property_type] |
String One of address, date_field, email, phone, select, text_area, text_field |
data[attributes][show_on][] |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
data[attributes][validation_required] |
Boolean Whether this property has to be validated |
data[attributes][meets_validation_requirements] |
Boolean Whether this property meets the validation requirements |
data[attributes][first_name] |
String For type address |
data[attributes][last_name] |
String For type address |
data[attributes][address1] |
String For type address |
data[attributes][address2] |
String For type address |
data[attributes][city] |
String For type address |
data[attributes][region] |
String For type address |
data[attributes][zipcode] |
String For type address |
data[attributes][country] |
String For type address |
data[attributes][country_id] |
String For type address |
data[attributes][province_id] |
String For type address |
data[attributes][value] |
String For type text_field, text_area, phone, email, date_field, select |
data[attributes][default_property_id] |
Uuid The associated Default property |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of companies, customers, locations, orders, product_groups, stock_items, users |
Includes
This request accepts the following includes:
owner
Fetching a property
How to fetch a properties:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/properties/a43f3dd7-98f7-4b34-8bdd-a794fd930832?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "a43f3dd7-98f7-4b34-8bdd-a794fd930832",
"type": "properties",
"attributes": {
"created_at": "2024-04-29T09:29:36+00:00",
"updated_at": "2024-04-29T09:29:36+00:00",
"name": "Phone",
"identifier": "property_2",
"position": 0,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"meets_validation_requirements": true,
"value": "+316000000",
"default_property_id": null,
"owner_id": "255d7236-99b9-4917-a8c8-7bd0da158114",
"owner_type": "customers"
},
"relationships": {
"default_property": {
"links": {
"related": null
}
},
"owner": {
"links": {
"related": "api/boomerang/customers/255d7236-99b9-4917-a8c8-7bd0da158114"
},
"data": {
"type": "customers",
"id": "255d7236-99b9-4917-a8c8-7bd0da158114"
}
}
}
},
"included": [
{
"id": "255d7236-99b9-4917-a8c8-7bd0da158114",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:36+00:00",
"updated_at": "2024-04-29T09:29:36+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"property_2": "+316000000"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=255d7236-99b9-4917-a8c8-7bd0da158114&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=255d7236-99b9-4917-a8c8-7bd0da158114&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=255d7236-99b9-4917-a8c8-7bd0da158114&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[properties]=created_at,updated_at,name |
Includes
This request accepts the following includes:
owner
Deleting a property
How to delete a property:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/properties/cb8863d1-f757-4d62-b2f7-d584c6b95c8f' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "cb8863d1-f757-4d62-b2f7-d584c6b95c8f",
"type": "properties",
"attributes": {
"created_at": "2024-04-29T09:29:37+00:00",
"updated_at": "2024-04-29T09:29:37+00:00",
"name": "Phone",
"identifier": "property_3",
"position": 0,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"meets_validation_requirements": null,
"value": "+316000000",
"default_property_id": null,
"owner_id": "7dab982a-0bbc-480f-857d-a9ac92b7718c",
"owner_type": "customers"
},
"relationships": {
"default_property": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[properties]=created_at,updated_at,name |
Includes
This request accepts the following includes:
owner
Updating a property
How to update a property:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/properties/3b7361e3-ed6b-4215-a0b7-99ec0e1cf6c8' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "3b7361e3-ed6b-4215-a0b7-99ec0e1cf6c8",
"type": "properties",
"attributes": {
"value": "+316000001"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "3b7361e3-ed6b-4215-a0b7-99ec0e1cf6c8",
"type": "properties",
"attributes": {
"created_at": "2024-04-29T09:29:38+00:00",
"updated_at": "2024-04-29T09:29:38+00:00",
"name": "Phone",
"identifier": "property_4",
"position": 0,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"meets_validation_requirements": true,
"value": "+316000001",
"default_property_id": null,
"owner_id": "fd8c8e1e-5a6d-4b96-84f3-a40870bc135b",
"owner_type": "customers"
},
"relationships": {
"default_property": {
"meta": {
"included": false
}
},
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/properties/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[properties]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the property (used as label and to compute identifier if left blank) |
data[attributes][identifier] |
String Key that will be used in exports, responses and custom field variables in templates |
data[attributes][position] |
Integer Which position the property has |
data[attributes][property_type] |
String One of address, date_field, email, phone, select, text_area, text_field |
data[attributes][show_on][] |
Array Array of items to show this custom field on. Any of contract, invoice, packing, quote |
data[attributes][validation_required] |
Boolean Whether this property has to be validated |
data[attributes][meets_validation_requirements] |
Boolean Whether this property meets the validation requirements |
data[attributes][first_name] |
String For type address |
data[attributes][last_name] |
String For type address |
data[attributes][address1] |
String For type address |
data[attributes][address2] |
String For type address |
data[attributes][city] |
String For type address |
data[attributes][region] |
String For type address |
data[attributes][zipcode] |
String For type address |
data[attributes][country] |
String For type address |
data[attributes][country_id] |
String For type address |
data[attributes][province_id] |
String For type address |
data[attributes][value] |
String For type text_field, text_area, phone, email, date_field, select |
data[attributes][default_property_id] |
Uuid The associated Default property |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of companies, customers, locations, orders, product_groups, stock_items, users |
Includes
This request accepts the following includes:
owner
Listing properties
How to fetch a list of properties:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/properties?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "435a0c52-701d-470e-9536-b632bae683f9",
"type": "properties",
"attributes": {
"created_at": "2024-04-29T09:29:39+00:00",
"updated_at": "2024-04-29T09:29:39+00:00",
"name": "Phone",
"identifier": "property_5",
"position": 0,
"property_type": "phone",
"show_on": [],
"validation_required": false,
"meets_validation_requirements": true,
"value": "+316000000",
"default_property_id": null,
"owner_id": "20b3fca7-fa57-4e30-b734-32750b6e2ee0",
"owner_type": "customers"
},
"relationships": {
"default_property": {
"links": {
"related": null
}
},
"owner": {
"links": {
"related": "api/boomerang/customers/20b3fca7-fa57-4e30-b734-32750b6e2ee0"
},
"data": {
"type": "customers",
"id": "20b3fca7-fa57-4e30-b734-32750b6e2ee0"
}
}
}
}
],
"included": [
{
"id": "20b3fca7-fa57-4e30-b734-32750b6e2ee0",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:39+00:00",
"updated_at": "2024-04-29T09:29:39+00:00",
"archived": false,
"archived_at": null,
"number": 1,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"property_5": "+316000000"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=20b3fca7-fa57-4e30-b734-32750b6e2ee0&filter[owner_type]=customers"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=20b3fca7-fa57-4e30-b734-32750b6e2ee0&filter[owner_type]=customers"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=20b3fca7-fa57-4e30-b734-32750b6e2ee0&filter[owner_type]=customers"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/properties
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[properties]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
identifier |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
default_property_id |
Uuid eq, not_eq |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
owner
Managing multiple properties on a resource
On the following resources you can manage multiple properties at once:
- Customers
- Product groups
- Orders
- Stock items
Creating one-off properties (no corresponding default property):
curl --request \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "customers",
"attributes": {
"name": "John Doe",
"properties_attributes": [
{
"name": "Phone",
"value": "+316000000",
"property_type": "phone"
}
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "c144d26a-d2c1-4152-be9a-cb15da45e63a",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:40+00:00",
"updated_at": "2024-04-29T09:29:40+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "John Doe",
"email": null,
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"phone": "+316000000"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Creating properties that correspond with an existing default property (we've already created a default phone property for a customer):
curl --request \
--url 'https://example.booqable.com/api/boomerang/customers' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "customers",
"attributes": {
"name": "John Doe",
"properties_attributes": [
{
"identifier": "phone",
"value": "+316000000"
}
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "2ec61ad3-4d8d-42ce-970e-db8c045e5eb0",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:42+00:00",
"updated_at": "2024-04-29T09:29:42+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "John Doe",
"email": null,
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"phone": "+316000000"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Deleting a property while updating another one:
curl --request \
--url 'https://example.booqable.com/api/boomerang/customers/4d13287e-e87c-4e11-b5e3-4e33edf10a8d' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "customers",
"id": "4d13287e-e87c-4e11-b5e3-4e33edf10a8d",
"attributes": {
"name": "John Doe",
"properties_attributes": [
{
"identifier": "phone",
"_destroy": true
},
{
"identifier": "birthday",
"value": "01-01-1970"
}
]
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4d13287e-e87c-4e11-b5e3-4e33edf10a8d",
"type": "customers",
"attributes": {
"created_at": "2024-04-29T09:29:43+00:00",
"updated_at": "2024-04-29T09:29:43+00:00",
"archived": false,
"archived_at": null,
"number": 2,
"name": "John Doe",
"email": "[email protected]",
"deposit_type": "default",
"deposit_value": 0.0,
"discount_percentage": 0.0,
"legal_type": "person",
"properties": {
"birthday": "01-01-1970"
},
"tag_list": [],
"merge_suggestion_customer_id": null,
"tax_region_id": null
},
"relationships": {
"merge_suggestion_customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
Includes
All includes are allowed on this request
Provinces
The Province resource describes provinces/states etc. in a country.
Fields
Every province has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String readonlyThe name of the province/state. |
code |
String readonlyThe code of the province/state. |
position |
Integer readonlyThe position of the province/state in the list. |
country_id |
Uuid readonlyThe ID of the country the province/state belongs to. |
Listing provinces
How to fetch a list of provinces.:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/provinces' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "d967fc78-581b-47dd-b0d8-f6d2c6fbdc7f",
"type": "provinces",
"attributes": {
"created_at": "2024-04-29T09:30:39+00:00",
"updated_at": "2024-04-29T09:30:39+00:00",
"name": "Friesland",
"code": "FR",
"position": 0,
"country_id": "cf220eca-a5ff-4666-9b19-933be17385f5"
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/provinces
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[provinces]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
country_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Sessions
The session tells you whether settings are changed since the last time they were being requested. Every response includes a Session-Id header which contains a session ID. If that ID does not match with the ID of the last session that was fetched, this indicates that the following information may have been changed:
- Employee's permissions
- Company's subscription
- Settings
- Default properties
- Clusters and Locations
- Employee's notification subscriptions
When there's an ID mismatch, it's advised to fetch the session again and include employee, company, and settings. Default properties, clusters, and locations should be requested separately as they can be paginated.
Endpoints
GET /api/boomerang/sessions/current
GET /api/boomerang/sessions/{id}
Fields
Every session has the following fields:
| Name | Description |
|---|---|
id |
Uuid |
company_id |
Uuid The associated Company |
employee_id |
Uuid The associated Employee |
locations_updated_at |
Datetime When locations were last updated |
clusters_updated_at |
Datetime When the clusters were last updated |
default_properties_updated_at |
Datetime When the default properties were last updated |
notification_subscriptions_updated_at |
Datetime When the employee last made a change to their notification subscriptions |
countries_updated_at |
Datetime When the countries were last updated |
Relationships
Sessions have the following relationships:
| Name | Description |
|---|---|
company |
Companies readonlyAssociated Company |
employee |
Employees readonlyAssociated Employee |
settings |
Settings readonlyAssociated Settings |
Fetching the session
How to fetch the session:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/sessions/current?extra_fields%5Bcompanies%5D=subscription&include=company%2Cemployee%2Csettings' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "bc5ad98b-dcb3-5dab-9e90-94880a692852",
"type": "sessions",
"attributes": {
"updated_at": "2024-04-29T09:24:45+00:00",
"company_id": "f4e55a1b-3918-43d0-8e47-1712c6d38fca",
"employee_id": "2c0a2814-6055-46df-b7df-b54a2a7e7ff2",
"locations_updated_at": null,
"clusters_updated_at": null,
"default_properties_updated_at": null,
"notification_subscriptions_updated_at": "2024-04-29T09:24:45+00:00",
"countries_updated_at": null
},
"relationships": {
"company": {
"links": {
"related": "/api/boomerang/companies/current"
},
"data": {
"type": "companies",
"id": "f4e55a1b-3918-43d0-8e47-1712c6d38fca"
}
},
"employee": {
"links": {
"related": "/api/boomerang/employees/current"
},
"data": {
"type": "employees",
"id": "2c0a2814-6055-46df-b7df-b54a2a7e7ff2"
}
},
"settings": {
"links": {
"related": "/api/boomerang/settings/current"
},
"data": {
"type": "settings",
"id": "4ebd0208-8328-5d69-8c44-ec50939c0967"
}
}
}
},
"included": [
{
"id": "f4e55a1b-3918-43d0-8e47-1712c6d38fca",
"type": "companies",
"attributes": {
"created_at": "2024-04-29T09:24:45+00:00",
"updated_at": "2024-04-29T09:24:45+00:00",
"name": "Company name 90",
"slug": "company-name-90",
"email": "[email protected]",
"billing_email": null,
"phone": "0581234567",
"website": "www.booqable.com",
"address_line_1": "Blokhuispoort",
"address_line_2": "Leeuwarden",
"zipcode": "8900AB",
"city": "Leeuwarden",
"region": null,
"country": "the Netherlands",
"market": "AV / Camera",
"use_billing_address": false,
"billing_company": null,
"billing_address_line_1": null,
"billing_address_line_2": null,
"billing_address_zipcode": null,
"billing_address_city": null,
"billing_address_region": null,
"billing_address_country": null,
"logo_url": null,
"favicon_url": null,
"default_timezone": "UTC",
"currency": "usd",
"financial_line_1": "Blokhuispoort",
"financial_line_2": "Leeuwarden",
"vat_number": null,
"custom_domain": null,
"development": false,
"shop_theme_id": null,
"installed_online_store": false,
"years_active": null,
"source": null,
"medium": null,
"tenant_token": "1356de22ee8ef1b6edd35d995992c378",
"pending_subscription": false,
"address": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands",
"main_address": {
"meets_validation_requirements": false,
"first_name": null,
"last_name": null,
"address1": "Blokhuispoort",
"address2": "Leeuwarden",
"city": "Leeuwarden",
"region": null,
"zipcode": "8900AB",
"country": "the Netherlands",
"country_id": null,
"province_id": null,
"value": "Blokhuispoort\nLeeuwarden\n8900AB Leeuwarden\nthe Netherlands"
},
"billing_address": null,
"subscription": {
"trial_ends_at": "2024-05-13T09:24:45.782Z",
"activated": false,
"active_subscription": false,
"suspended": false,
"canceled": false,
"canceled_at": null,
"on_hold": false,
"needs_activation": false,
"product": "Premium",
"plan_id": "premium_monthly",
"interval": "month",
"current_period_end": null,
"extra_employees": 0,
"extra_locations": 0,
"amount_in_cents": 29900,
"discount_in_cents": 0,
"balance_in_cents": 0,
"coupon": null,
"coupon_percent_off": null,
"coupon_duration": null,
"coupon_duration_in_months": null,
"strategy": "charge_automatically",
"source": null,
"enabled_features": [],
"allowed_features": [
"bundles",
"multiple_locations",
"advanced_pricing",
"api",
"custom_fields",
"overbookings",
"categories",
"customer_auth",
"custom_domain",
"barcodes",
"reports",
"permissions",
"exports",
"coupons",
"shop_tracking",
"sso",
"iprestrictions",
"2fa_enforcing",
"remove_powered_by"
],
"restrictions": {
"employees": 15,
"email_max_recipients": 1000,
"rate_limit_max": 250,
"rate_limit_period": 60,
"locations": 3
},
"can_try_plan": true
}
}
},
{
"id": "2c0a2814-6055-46df-b7df-b54a2a7e7ff2",
"type": "employees",
"attributes": {
"created_at": "2024-04-29T09:24:45+00:00",
"updated_at": "2024-04-29T09:24:45+00:00",
"name": "John Doe",
"firstname": "John",
"lastname": "Doe",
"locale": null,
"email": "[email protected]",
"unconfirmed_email": null,
"active": true,
"owner": true,
"confirmed": true,
"time_to_confirm": 0,
"permissions": [
"reports",
"products",
"settings",
"security_settings",
"account",
"exports",
"cancel_orders",
"revert_orders",
"delete_invoices",
"make_invoice_revisions",
"override_rental_period"
],
"has_two_factor_autentication": false,
"avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=404",
"large_avatar_url": "https://gravatar.com/avatar/6a6c19fea4a3676970167ce51f39e6ee.png?d=mm&size=200"
}
},
{
"id": "4ebd0208-8328-5d69-8c44-ec50939c0967",
"type": "settings",
"attributes": {
"currency": {
"name": "USD",
"decimal": ".",
"thousand": ",",
"symbol": "$",
"precision": 2,
"format": "%s%v"
},
"defaults": {
"timezone": "UTC",
"timezone_offset": 0,
"tax_category_id": null,
"tax_region_id": null,
"shop_start_location_id": null,
"shop_stop_location_id": null
},
"pricing": {
"enabled": true,
"tax_strategy": "exclusive",
"deposit_type": "percentage",
"deposit_value": 100,
"currency_format": "symbol",
"currency_position": "left"
},
"dates": {
"format": "DD-MM-YYYY",
"use_am_pm": false,
"first_day_of_week": 0
},
"orders": {
"use_times": true,
"start_type": "fixed",
"start_relative_offset": 0,
"start_fixed_at": "09:00",
"stop_type": "fixed",
"stop_relative_offset": 48,
"stop_fixed_at": "15:00"
},
"security": {
"sso_forced": false,
"2fa_forced": false,
"iprestrictions_enabled": false
},
"address": {
"fields_order": [
"zipcode",
"city",
"region"
]
},
"store": {
"enabled": true,
"public": true,
"send_order_confirmation": true,
"brand_color": "#136DEB",
"use_availability": true,
"use_prices": true,
"display_price": "period",
"show_powered_by": true,
"use_order_lag_time": false,
"order_lag_time_value": null,
"order_lag_time_interval": null,
"behaviors.add_button": "show_cart",
"behaviors.location_picker": "start_stop",
"payment_strategy": "none",
"payment_strategy_value": 30,
"payment_deposit": false,
"payment_methods": [],
"use_toc": false,
"toc_label": "",
"toc_content": "",
"use_business_hours": false,
"use_away_mode": false,
"period_type": "freely",
"use_times": true,
"use_coupons_in_checkout": true,
"time_increment": 60,
"show_product_availability": true,
"hide_product_availability_quantities": false,
"show_cart_availability": true,
"website": null,
"custom_scripts": "",
"google_analytics_id": null,
"google_anlaytics_options": "{}",
"facebook_pixel_id": null,
"facebook_domain_verification": null
},
"user": {
"auth_enabled": false,
"allow_signup": true,
"allow_guest_checkout": true,
"require_verification": true
},
"documents": {
"show_tax_column": true,
"css": "",
"scss": "",
"scope_numbering_to_prefix": false,
"page_size": "a4"
},
"invoices": {
"footer": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": null,
"default_due_period": null
},
"quotes": {
"footer": "",
"body": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": null
},
"contracts": {
"footer": "",
"body": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": null
},
"labels": {
"customer": "customer",
"order": "order",
"quote": "quote",
"contract": "contract",
"packing_slip": "packing_slip",
"start": "pick_up",
"stop": "return"
},
"emails": {}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/sessions/current
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,company,settings |
fields[] |
Array List of comma seperated fields to include ?fields[sessions]=company_id,employee_id,locations_updated_at |
Includes
This request accepts the following includes:
employee
company
settings
Retreiving the session
How to retreive the session:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/sessions/current' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "2960f246-2149-526f-9dc6-165562fd602d",
"type": "sessions",
"attributes": {
"updated_at": "2024-04-29T09:26:39+00:00",
"company_id": "ae8fca0e-e557-4b3d-bc20-3fbc4711eda3",
"employee_id": "ae5ea371-d3b1-4d9d-9cc1-e6147cc0273d",
"locations_updated_at": "2024-04-29T09:26:39+00:00",
"clusters_updated_at": "2024-04-29T09:26:39+00:00",
"default_properties_updated_at": "2024-04-29T09:26:39+00:00",
"notification_subscriptions_updated_at": "2024-04-29T09:26:39+00:00",
"countries_updated_at": null
},
"relationships": {
"company": {
"links": {
"related": "/api/boomerang/companies/current"
}
},
"employee": {
"links": {
"related": "/api/boomerang/employees/current"
}
},
"settings": {
"links": {
"related": "/api/boomerang/settings/current"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/sessions/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=employee,company,settings |
fields[] |
Array List of comma seperated fields to include ?fields[sessions]=company_id,employee_id,locations_updated_at |
Includes
This request accepts the following includes:
employee
company
settings
Settings
Settings are configured globally for a company account. They are divided in the following sections:
Currency
Information on how to display and handle the currency.
| Name | Description |
|---|---|
name |
String readonlyCurrency code |
decimal |
String readonlyDecimal seperator |
thousand |
String readonlyThousand seperator |
symbol |
String readonlyCurrency symbol |
precision |
String readonlyPrecision |
format |
String readonlyThe format |
Defaults
Defaults derived from other resources.
| Name | Description |
|---|---|
timezone |
String readonlyThe default timezone (managed on the company resource) |
timezone_offset |
Integer readonlyThe UTC offset of the default timezone, in minutes |
tax_category_id |
Uuid readonlyID the default tax category |
tax_region_id |
Uuid readonlyID the default tax region |
Pricing
Configuration on how to handle and display pricing
| Name | Description |
|---|---|
enabled |
Boolean Whether pricing is enabled |
tax_strategy |
Uuid How taxes should be calculated, one of exclusive, inclusive |
deposit_type |
String Default deposit type (applied to orders if customer deposit type is default, one of none, percentage_total, percentage, fixed) |
deposit_value |
Integer Default deposit value (applied to orders if customer deposit type is default) |
currency_format |
String Currency format |
currency_position |
String Where to place the currency symbol, one of left, right |
Dates
Information on how to display dates. The settings below should be used (and combined) to select the format string for the date library being used.
| Name | Description |
|---|---|
format |
String How dates should be formatted. Supported formats are DD-MM-YYYY, MM-DD-YYYY and YYYY-MM-DD. |
use_am_pm |
Boolean Whether to use 24h clock or AM/PM |
first_day_of_week |
Integer Which day to display as first day of the week ( 0 for Sunday) |
Orders
Configuration for orders (these settings also apply to the online store)
| Name | Description |
|---|---|
use_times |
Boolean Whether time selection is enabled, if not, full days are always planned and calculated |
start_type |
String Behavior of default start time, one of fixed, relative |
start_relative_offset |
Integer Offset in seconds from now, used when start_type is relative |
start_fixed_at |
String Fixed time of day, e.g. 14:00, used when start_type is fixed |
stop_type |
String Behavior of default stop time, one of fixed, relative |
stop_relative_offset |
Integer Offset in seconds from now, used when stop_type is relative |
stop_fixed_at |
String Fixed time of day, e.g. 14:00, used when stop_type is fixed |
Security
Global security settings
| Name | Description |
|---|---|
sso_forced |
Boolean Whether to force SSO |
iprestrictions_enabled |
Boolean Whether IP restrictions are enabled |
Address
Settings on how to display addresses
| Name | Description |
|---|---|
fields_order |
Array Order of how the fields are displayed, e.g. ["zipcode", "city", "region"] |
Store
Settings for the online store
| Name | Description |
|---|---|
enabled |
Boolean Whether to accept online reservations |
public |
Boolean Whether to hosted online store is public |
send_order_confirmation |
Boolean Whether to send order confirmations automatically after checkout |
brand_color |
String Brand color as HEX code |
use_availability |
Boolean Whether to show availability and block checkouts when items are unavailable |
use_prices |
Boolean Whether to show prices |
display_price |
String One of period (label will be populated with actual period), charge (label will be populated with the name of the price tile), cheapest (show "starting from" as label) |
show_powered_by |
Boolean Whether to display "Powered by" in the cart |
use_order_lag_time |
Boolean Whether to prevent last-minute reservations |
order_lag_time_interval |
String One of minutes, hours, days, weeks, months |
order_lag_time_value |
Integer The value applied for order_lag_time_interval |
payment_strategy |
String One of none (no payment required at checkout), full (full payment required at checkout), partial (partial payment required at checkout) |
payment_strategy_value |
Integer Percentage to be paid at checkout (for payment_strategy partial) |
payment_deposit |
Boolean Whether deposit should be paid during checkout |
payment_methods |
Array List of enabled payment methods, any of ideal, giropay, bancontact, eps, alipay, p24, creditcard, paypal |
use_toc |
Boolean Wheter the agreement should be accepted during checkout |
toc_label |
String The label of the agreement checkbox |
toc_content |
String The contents of the actual agreement |
use_business_hours |
Boolean Whether to take opening hours into account while selecting a period (see operating rules for more information) |
use_away_mode |
Boolean Whether away mode is enabled (see operating rules for more information) |
period_type |
String How the period picker is setup, one of freely (free selection), timeslot_duration (select a day, time and duration), timeslot_fixed (fixed timeslots for days). See operating rules for more information |
use_times |
Boolean Whether to use time selection in the online store |
use_coupons_in_checkout |
Boolean Whether supplying coupons during checkout is enabled |
time_increment |
Integer Time increments for time selection (e.g. 15, 30, 60) |
show_product_availability |
Boolean Whether to show detailed product availability for products |
hide_product_availability_quantities |
Boolean Whether hide quantities in the product availability calendar |
show_cart_availability |
Boolean Whether to show on which dates the products in a cart are available during the period selection |
website |
String Website to use to redirect back to from the checkout |
custom_scripts |
String Custom scripts to execute during checkout |
google_analytics_id |
String Google analytics ID to use for tracking |
facebook_pixel_id |
String Facebook pixel ID to use for tracking |
facebook_domain_verification |
String Content for the facebook-domain-verification meta tag |
User
Settings that apply to user accounts
| Name | Description |
|---|---|
auth_enabled |
Boolean Whether user accounts are enabled |
allow_signup |
Boolean Whether signup during checkout is allowed |
allow_guest_checkout |
Boolean Whether to allow guest checkouts |
require_verification |
Boolean Whether e-mail addresses need to be verified |
Documents
Settings that apply to all document types
| Name | Description |
|---|---|
show_tax_column |
Boolean Whether to show the tax column on lines |
css |
String Custom css used for documents |
scss |
String Custom scss used for documents |
scope_numbering_to_prefix |
Boolean Whether to scope numbering to prefix, e.g. 1980-1, 1980-2, 1981-1 or 1980-1, 1980-2, 1981-3 |
page_size |
String The page size to use for pdf downloads, one of a4, letter |
Invoices
Settings that apply to invoices
| Name | Description |
|---|---|
footer |
String HTML formatted footer to display on invoices |
show_product_photos |
Boolean Whether to show product photos |
show_stock_identifiers |
Boolean Whether to show identifiers of the stock items that are booked |
show_free_lines |
Boolean Whether to display lines that don't have price |
hide_section_lines |
Boolean Whether to hide lines within a section, if enabled to total price of all lines in a section is summed and displayed next to the section |
prefix |
String Prefix to use for document numbering, e.g. {{year}} or {{customer_number}}, combinations are also possible {{year}}-{{order_number}} |
default_due_period |
Integer A period of time during which invoices can await payment, in seconds |
Quotes
Settings that apply to quotes
| Name | Description |
|---|---|
footer |
String HTML formatted footer to display on quotes |
body |
String HTML formatted body to display on quotes |
show_product_photos |
Boolean Whether to show product photos |
show_stock_identifiers |
Boolean Whether to show identifiers of the stock items that are booked |
show_free_lines |
Boolean Whether to display lines that don't have price |
hide_section_lines |
Boolean Whether to hide lines within a section, if enabled to total price of all lines in a section is summed and displayed next to the section |
prefix |
String Prefix to use for document numbering, e.g. {{year}} or {{customer_number}}, combinations are also possible {{year}}-{{order_number}} |
Contracts
Settings that apply to contracts
| Name | Description |
|---|---|
footer |
String HTML formatted footer to display on contracts |
body |
String HTML formatted body to display on contracts |
show_product_photos |
Boolean Whether to show product photos |
show_stock_identifiers |
Boolean Whether to show identifiers of the stock items that are booked |
show_free_lines |
Boolean Whether to display lines that don't have price |
hide_section_lines |
Boolean Whether to hide lines within a section, if enabled to total price of all lines in a section is summed and displayed next to the section |
prefix |
String Prefix to use for document numbering, e.g. {{year}} or {{customer_number}}, combinations are also possible {{year}}-{{order_number}} |
Labels
Customization settings for labels
| Name | Description |
|---|---|
customer |
String What to call a customer (one of customer, client, student`) |
order |
String What to call an order (one of order, booking, project`) |
quote |
String What to call a quote (one of quote, proposal) |
contract |
String What to call a contract (one of contract, waiver) |
packing_slip |
String What to call a packing slip (one of packing_slip, pull_sheet) |
Labels
Settings for emails
| Name | Description |
|---|---|
bcc |
String BCC addresses to use for all emails |
Fields
Every setting has the following fields:
| Name | Description |
|---|---|
id |
Uuid |
currency |
Hash readonlyInformation on how to display and handle the currency (managed on Company resource) |
defaults |
Hash readonlyDefaults derived from other resources |
pricing |
Hash Configuration on how to handle and display pricing |
dates |
Hash Information on how to display dates |
orders |
Hash Configuration for orders (these settings also apply to the online store) |
security |
Hash Global security settings |
address |
Hash Settings on how to display addresses |
store |
Hash Settings for the online store |
user |
Hash Settings that apply to user accounts |
documents |
Hash Settings that apply to all document types |
invoices |
Hash Settings that apply to invoices |
quotes |
Hash Settings that apply to quotes |
contracts |
Hash Settings that apply to contracts |
labels |
Hash Customization settings for labels |
emails |
Hash Settings for emails |
dashboard |
Hash Dashboard settings (Used internally by Booqable) |
setup_checklist |
Hash Setup checklist settings (Used internally by Booqable) |
onboarding |
Hash Onboarding settings (Used internally by Booqable) |
instructions |
Hash Settings for in app instructions (Used internally by Booqable) |
tracking |
Hash Tracking settings (Used internally by Booqable) |
Fetching settings
How to fetch settings:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/settings/current' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "d9e03e74-ba3c-57ac-ab21-f18cc76326af",
"type": "settings",
"attributes": {
"updated_at": "2024-04-29T09:23:50+00:00",
"currency": {
"name": "USD",
"decimal": ".",
"thousand": ",",
"symbol": "$",
"precision": 2,
"format": "%s%v"
},
"defaults": {
"timezone": "UTC",
"timezone_offset": 0,
"tax_category_id": "8af2cbfb-b083-4d20-9470-49b70eb63e65",
"tax_region_id": "98061a47-791e-426a-bb56-1850a71fe034",
"shop_start_location_id": null,
"shop_stop_location_id": null
},
"pricing": {
"enabled": true,
"tax_strategy": "exclusive",
"deposit_type": "percentage",
"deposit_value": 100,
"currency_format": "symbol",
"currency_position": "left"
},
"dates": {
"format": "DD-MM-YYYY",
"use_am_pm": false,
"first_day_of_week": 0
},
"orders": {
"use_times": true,
"start_type": "fixed",
"start_relative_offset": 0,
"start_fixed_at": "09:00",
"stop_type": "fixed",
"stop_relative_offset": 48,
"stop_fixed_at": "15:00"
},
"security": {
"sso_forced": false,
"2fa_forced": false,
"iprestrictions_enabled": false
},
"address": {
"fields_order": [
"zipcode",
"city",
"region"
]
},
"store": {
"enabled": true,
"public": true,
"send_order_confirmation": true,
"brand_color": "#136DEB",
"use_availability": true,
"use_prices": true,
"display_price": "period",
"show_powered_by": true,
"use_order_lag_time": false,
"order_lag_time_value": null,
"order_lag_time_interval": null,
"behaviors.add_button": "show_cart",
"behaviors.location_picker": "start_stop",
"payment_strategy": "none",
"payment_strategy_value": 30,
"payment_deposit": false,
"payment_methods": [],
"use_toc": false,
"toc_label": "",
"toc_content": "",
"use_business_hours": false,
"use_away_mode": false,
"period_type": "freely",
"use_times": true,
"use_coupons_in_checkout": true,
"time_increment": 60,
"show_product_availability": true,
"hide_product_availability_quantities": false,
"show_cart_availability": true,
"website": null,
"custom_scripts": "",
"google_analytics_id": null,
"google_anlaytics_options": "{}",
"facebook_pixel_id": null,
"facebook_domain_verification": null
},
"user": {
"auth_enabled": false,
"allow_signup": true,
"allow_guest_checkout": true,
"require_verification": true
},
"documents": {
"show_tax_column": true,
"css": "",
"scss": "",
"scope_numbering_to_prefix": false,
"page_size": "a4"
},
"invoices": {
"footer": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": "{{year}}-{{order_number}}",
"default_due_period": null
},
"quotes": {
"footer": "",
"body": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": "{{year}}-{{customer_number}}"
},
"contracts": {
"footer": "",
"body": "",
"show_product_photos": true,
"show_stock_identifiers": false,
"show_free_lines": true,
"hide_section_lines": false,
"prefix": null
},
"labels": {
"customer": "customer",
"order": "order",
"quote": "quote",
"contract": "contract",
"packing_slip": "packing_slip",
"start": "pick_up",
"stop": "return"
},
"emails": {}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/settings/current
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[settings]=currency,defaults,pricing |
Includes
This request does not accept any includes
Signatures
Signatures are used to confirm and store a signature for contracts and quotes.
This resource can also be used to update the signature of a document or add one later.
When a contract is confirmed and a signature is supplied the has_signed_contract flag will
be set accordingly on the associated order.
Fields
Every signature has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
signature_base64 |
String required writeonlyBase64 encoded signature, use this field to store a signature |
document_id |
Uuid The associated Document |
order_id |
Uuid readonlyThe associated Order |
customer_id |
Uuid readonlyThe associated Customer |
Relationships
Signatures have the following relationships:
| Name | Description |
|---|---|
document |
Documents readonlyAssociated Document |
order |
Orders readonlyAssociated Order |
customer |
Customers readonlyAssociated Customer |
Confirm a contract
Confirm and add a signature to a contract:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/signatures' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "signatures",
"attributes": {
"document_id": "f61cea73-3f00-4ea3-8c3c-fdd3c3b3ae21",
"signature_base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAAAXNSR0IArs4c6QAAFwJJREFUeF7tnX+MHsV5x5+9s7mzTXxnjO/8C2N+2wcGwgW3wY1rkahNRBJRIVCSNlEihJQgJY3SSqWNhCr1HyI1ilI1IqRKFJQmVSE/SgiYmIRE/lXXmACWsR0w4J/x+cfhc2zOd7bvtnrefed9Z+ed3Z2dndmd3X3uH8zd7uzM93k+8zzPzLz7er7v+0A/pAApIFXAI0DIM0iBaAUIEOe9AwO81+hl+1/hfxsbAv8AY42WuyECpNz2o95bVoAAsSwwNV9uBRQBodhbbjNT73UVUAREt3m6r1YKVHAezQ2QCmpXK9+3M9g0XpHmWnO9zQ0QcRXG3BCoJVLAngK5AmJvGC63rDPz6dzjsgbl7VtpASEXKo/TldlWpQVEzz3KbCpxxFUai7o18x51zQBRNwRdWTMFIsgjQGrmB2rDzXueVutV6qsMnM0hQFKrTjfEK1AiuBS6SoBU1d8VjF/VoZscFwFiUs2ktshpkxRy7u+FA0I+45xPWOlQWe1cOCBWrCE0Wlbj5KGNW8/QtZTufcmjrwUgyTLQFfoKhJ0z+D9bDmur3ejREyD6nkF35qVA/ly0RkaA5GVkek4pFSBASmk2hU4XOOsq9I67xO2OEiDprElX10wBAqRmBqfhplOg1oC4HdzTGZKutqNArQGxIym1WiUFCJAqWbNSY3EjvhMgCk7lhqkUOkqXGFeAADEuKTXoigImJjYCxBVrUj8MKmACjaA7BIhBsyQ1Zc5sSU9y9e/lU4AAcdWXqF9OKECAOGEGW50o34xtSwnddgkQXeXovlooQIDUwsw4yDJHk+L6ToCkBKQ4U7GOFt+DlJKV+vLcACGzuugnEVYhY7WMlRsgLroH9YkUSFKAAElSKOvfVWZjlWuy9sP0/WXss4YGBIiGaHRLfRQgQOpjaxqphgIEiIZoxd+Sb36T79OKV5fvAQHilj0q05vyQBXfUwKkSJdM5UWpLi5yVJV6NgFSKXPSYEwrQICYVpTaq5QCAiAUxitlXRpMZgUogmSWkBpwUgFDcz0B4qR1qVOuKFAwIIYwL0RNB/vuYJeMmKbAcRUMiBH5OhspUFBLI6JmC1KgmoDoiklg6SpX2fsIkMqalgZmYr4jQMiPSIEYBQiQWPcwMQeR/5VZAScBIbcss0tVq+9OAlItiVVGQ1OCikpFXEOA5Ko6gZBabuuS0XH31DahG0gBpkCtIoj1yYj8ypIChiyn0UytALFkPWq2wgoQIBU2Lg0tuwIESHYNrbWgkRFY60tdGyZA6mp5GreSAnJAaOpSEi/rRaMXAc5OAxyY8OGE78GJCRQ++FnQ68F1PQB9XQCXdgHMn5H1aVnur69DUATJ4jcp70UgjlwE2Hrah33jAPsnAXaN+3BxBsCMi+3G8P/xZ94sr/HfoV6A63sAVvR48L5ZAFdekvLBjl5eBuwcBqQM8ql5HoKx6R2AF0d9+Om4D11TnfdNdwe/8wMmGtCIPwyYu/sAPtALsHZu82K1btBVUQrEuJrDgJTZnoHiPBjPjLbTpynO+ae72uMUIYkChUUXBOVjcz24uVdfq+pMQ/oaxN1ZGUBcM/T2UYCnjvuw/kQbDDQED4QqKLJowoyKUeUz8wA+1e8VXKekcVDXrBXd98oAksY8Nq/FqPH0YYB/OzgNM8/LgeAhwb4wUMTfq6RdLJpgnfLxuR7c02dzdPVrmwAxaHOMGj/c78O2Uz50TbfhUAVCBopO2vU3/V5lCnmD5tFqigDRki18UyNq7AN49PA0zLgQ/I05Np9WqaRXptKuhwY8WDen6OXhcn91KNouDIix1NBYQwbc124TGDV+useHLafbtYas8Ga/i4ompusTrE2wiKdoks3+FEE09TtzDuAnBwD+4+1puGSy3cjFmdyqlGSFKgkUVYDS1CcYTWpTmxiem6sLiGGheI5Y1NjOrVCx/Qu8LgoSPvWSgRKVXkUV8vL6pHPg+UcTi+JrTmi6t2UHpDpaJGrIosaLbwK8Pj4dup45twoouvWJKihRy8Jr5nlwfx9tMCYamrsgOyBpnlbia98YAfjuPh9ePuKD16TA9/zwvgamV81SJA0oeaZd5dw3Kc5xCBAF7X/7NsCTuwHeHuMK8dbRkDAk/CyP/24dHeFqE7EgZxHFJCghQIVjKwgJ7pv83YJsu/AK0pX+EgIkxoSYUv1mD8C39/jQ3Tw/hY4nPx4SDQrvrHE1SlZQZP0KQSoBRbWAr1EmHfIIAiQCEEypfvYSwJbjsqgR3KQCCl9466Rd4nOyFvJifcIK+M9fVqajKvkFJgJEovWmPQBPvOjDkfPBH6OjhhySRprVHT6DlRUU1eVf3Y1GLOAp5ep0BgKE0wRTqh+/BPD0Xh+6m5/PEB076vStSjTh65O80i4+AvGrZ7Jj9RhNVFOu/ObwYp9EgDT1ZynVSweCmT9uxk4bUcTVrihQ+P2TNIW8ybSLUq4wkAQIALCUanQsEEfF4eIgca0+0Um7KOUKfKHWgLCU6rmdfuu4yFRz+TYOFFtpF6t32ByW9diKaoEfdWwFo8nXB2u2sSgs19UWEEypNmwH2PZmUG/wTs9DwoOSV9rFg6Kbdqn0W/b5E3H/pO51iWFAyrFavns/wE82+vDmsXC+yUMSrETJ/x4FCnOu1oYfd3/W/RPVaKIaNaIAivr8yecWelDHpWDDgBS74qDy9B2/A/jx/wKMNnfFL0jeEBIHilZ9gqd6vfauusqKl4vLwne/x4MvLqnOh7FUpvPaAIL1xgvbAH62w4eeic5VKlOglKU+Ud1XESPKTbM9eHh5fY6oOA6ICuPJcePsyQl4fGsv7HwVDxoG14vpEGtFBCVr2sWeZWP/JK/6RNw/QUg+uagenzFxHJCGewX5iebPyRGARzf4cGS/vAGxNsCrTEUTPs+XPYefnfNIu1TrE5VlYTyy8veDHnx+UN82mibN9bYSAKKvx943AL6/AeDc4faxj8lZne2pRhNx6Vcs5LXqE+6FcdGHDYVj9dyhQ53zXarpVRIoF2YGkNw7v7rnuCoLCBbj658HGD3lt9IpHg2ToEStdsXN2CZ34/mUEf+tuuKV5W0rjbF1B6nqR+d58I9XVBOSBECypTf6c7/+nawYf2FDu94QHYi1LoMkqj5Jm3bx0SZuWRgTlKmItyuqpF1iGscrpwOKShQU+8UgcXaFK4MbVyqCIBxbfwOwfqPfeGmbrJ4QDwniNSajiZh2qYAi3iMWxVlAkUHSgJLbozH1+fgb51RjhYvnqTKAND7c9AzApq3hY+ZsRhUjQN6gqMzMadOuINq5VZ+snFsNSJjflBiQNue4jLv+2V7Y/ooPMycBLvREp2g8KKqQsNZ0VrwKqU+8doSIKuLF+ijrpxn59hCSLy2uxhmuEgMSuC0u4z73pA+793ZCoQqKrEaJSrvEekKWxrGeuHS+S2W1ixXevLPrFvJVgaTUgDA49u0EOB/xpTIqkIyPH2n49MTkaIuyc+dPSsPQuXNHoWtgWftvPsDM7tmt/7+kb0nr3zP6F3a0oXJamK9botIuBrVKfaJ7bCUKlKh0Ufx9FSApLSAIx4bHfXh9X9gHo0BpzPTN1Ovddw/BWTgF3ul3YHzWNEydOhp6ly5eK+5Sy6IMe7LsWvxbT38AkndpP8yeuaDxb4Qmj7Qr6G8+9UlclJnsBfjecq+0X/ZTICD6a29RcPCo8KCcHzsIZ7vPwrnzx2H83SBahFZxhFO7fDtRzi+rX6Kuneqahu6mF4nQePPbUUZlZk5byKt+mlGcFGSRSfe1RFj3fefackJSICDSDCbxlwyOA7sAcHaK+jk73oZi8o9HOmdtCRT88qrYriooUdex9hAW/mf23OWtCDM9GE7J4vZP4l7xo5J2iWlcVDSUHd3XWRbOBxL9STfKj0oFCA+HOCAGCwPjzMjLoQ9BiVGj5bAGQEkTTRr9ECBhfWGw9C5dFRqeKih4E9vdbvxbugFpNu0SnxMXBW1CEqBRRkAM9TkJDgTjxNRbcPGdZgoV8bXJYv4fBU5cNBHTEebNOqAsW3wZXLmkHxYtmAODl89pgXFwrBfO9SyDQ6M+HD8b/Jp3ePvH6gPDJe7G466j8DI9PjqJfUZInhjqyvS9iolphsELrEYQQ2wA7nP8z3/1wKHtnSMfnT4I7xza1FjF8rkZkzeSTK+8QeGhWrK0H/701iVw4zUL4OahpfAeyQFKvB43P0dOA+z5A8DeowDbjgYnBPIAxeb+ybWXl2cz0SogJkBGJ9nxI4CXn223NjnbhzMnX4N3/VMwNnmgo75wARTZe6/W3LIMbnnvQrjz/ddHQhGl2ZkJgEMjAP93GOB3b/kwMh6+Uny7vO3Pn8QV8WK0k0UUhOTrV7v/6UTnAdn+BMDm/247w/mJE3B0ai+cGQ+DIYsIqqDI7tVJvWQFOqYUCMYH110dGy3STCb4wonN+zpBUU27rNcnCWkXe/5d8z34ynXyU8Cmso80usqubQLiSnfCXdz9PMBz327/7uT4Ljhx+lWYmhGct4pMk7jhiJDEpV6qaVfDwDFLwyydWn27WTBEA2YFJaqIT6p3WD8S65Nmyhu3T/KhJR7861XufujK2QiCn+fY/S2Ak2MAfNQQnUTVqVWjSSx4wsOjILnuhgH4sw8t10qldGY8fEvLL14LahT2ylRxIjC6f4KNN30668d+EZ4vL+2Czy7XGbn9e5wEBFesNn4NYP/BAI6DxzbAxGz5KV0mUZGgsIiCYAwPLYSPfvh6uPTymE0aC3bFWu2V/cFLt+Pqk6z7J600Dt/Swo1DNZrIohOmod8acnMj0TlAcMXq59/tgZHtHmBKdXLs1Y5PBLIUS+ZnuYPiA0zPALjtjmXw4F+vhcs7j19ZwCG6Sfa2yKRCXkx72P5JER/7Reg+MMeDr6xyr2h3DhAsyl94/AT8cfpYAw7+R1wZCoHC1R2qRbeJtOuaoQG4+54hYwW4KZpY2vXiofivYQgBwb2/S2WTUZbG6dYnCMlHFkQX7Um62KqinQLk9S0jsO17C2HHjh+2NqhUDg1GRRQb0YTVKJgWfOKvbi4knUpyFvZ39g1Zz+8KNhtd3z9BSL60zK16xBlAMLV69pHjsPn5TR0nabNAkqboVokoCN1tty2FtR+/FtYML1X11UKvY1/tgNEET7nIQIl6barsjS/t1xWpfe1cmvoEjwx9Z2UXrJ5fqGSthzsDyKYfvQ1Pfm1r6/yU8rENoVjMWp/IloVZKnHFvD4Y/siVcNc9N6fe6DNr7vQJhelowhYm4k4L4zUqH9QSP82IS79R+yNmdUxuzQlAcNXqsS88A8feGmsAgiuILHNWBSW2PuF0UK1PGsZtruNjn2653XLUSO/zydaVXKESTZhj29iNx7aTIgq+lO6rN3XB3QNaQwxuMqSnE4D8/BuvwK++/1pLDfF1n0qQNKnKAooMnkWDrkSNDM4i3CpGk0Y04M6xqe7Ih+7pbk5swoe0+EI+zfmu1fM9ePiW4t+1VTggfPQQXUALFCGsBwaK3kOJiig4y930/qXwwBfWFb50aw6NcEtx0UR07KhoIsIVVZ/ofOz3H27NGEUMCFc4IGL0kI0pb1AGFlcvakT5io1owtcnSdGJ9UuWdr1voPgoUigguHL1zQd+Daf2jMH5mFf18LMZE1SWdon5bdS1ccvCK9ZWO2pEgSJGkyTHzqM+QWi+Oay4omWo5hD1KRQQ3Pf49wd/3fp+wCRITIIiQjL/ivpEDd1oIupv9HwXd16Rjyb3X9MFn11hIFfSbKJQQDC92vhYuzjHMahAogqK6v7JXX+5Ev78/uHK1hppfSMpmpiuT+IK+TV9Hnx12CtsWb0wQDD3feqhLfDKL+Vf3GEbFDRK39VzHdnXSOvC9q+X1Sam066k9tiE+Y3VimmWBVkKAwTrj8fu+xUcO3w6tMQojtE0KDMuBF+Q8+G7VlDUUHAoFk1eOhBeCcy6LKyyG4/dQ1v9y1AXrLtKobOmLuHqGScAEWcS2ThVQFFZ7Zpzw1x44MHbYdFtC62EbUu1oinTa7WjEk3i0q6GfRO+KChuR/4zK4urQ5wBhFlOPIatE1FEUFio/ti9N8Kdn16R+2c1tLzSwZtktUlSmpRmtQvbkr0NUgcQUxNVGBBTrSoa9z//dgvsXC+vQeJACaIJfyCl84EICX66Dgv1O9Ysh9X3XQPXryn4wxqKurh8Gftg1s43ADZyX21nEhSEhLWHdnxkbQ1rEBQADyg+/c9bI/0hazQZvLof1t47BO/9i0UUNQxTF5V2mQbl2ku74JE7wUo6rCJJYSkWdg6PmTz+qV80CvW4n+RoEr4bwVi1dgnc8clbaelWxQsyXMNeHPHsruCdXSy9VX0bZNK3aX3iVq+++yBoF9wL2fxoeC8kyl5JEWXR4j5Y/sFFtDqVweF1b+U/wci/WTUtKPzm41X9Hnx5GOC6vDNjF1axmCFwufepf9oBr/72gLJtRNEZGKvWLaE6Q1lFwxf6AI2X2x0L3rDCPpzFnpJ2WRiXdx/6Ey/f5V2JJIWmWKw/mGr98uHNqSGZt5JSKcNubqQ5rE8QFPYWSPZuYdX6BOG4b7iI1KpzlcoJQFA4jCQv/GAvvPH04ciaBGchjBaDq+Y1VqUW39BvsPjOeQnPiCsmNBIzpLxGizUKe7cwvohbfCURjoDVLQjGsvke3DsEhUUOURdnAOFTrj/8fgz2bh+BC+NTcO74BMwa6IWBqy6DwStnGYYiDy+lZ6AC7EXcI6cA9o0CnBDWZVYsApg7D2B4YXErVjJLuQFIXtOZs75aTwEQGvyJert9vuaS28ANQPJVgp7mogKOzhEEiIvOQn1yRgEFQBxFW1XCkndfdZh0nR0FFACx82BqlRQogwIESBmsRH0sTIFqAkJpVWEO1X5wNYxQTUAccA/qQl4K2AWRALFmR7uG0+u2i33SG0ledxEgeSlNzymlAoYBoRnKihc4Jqtj3UkteZr+xwCSppnUfaQbSIFSKGA4gpRizNRJUkBZAQJEWaoKXEhJQWojEiCpJavLDTWmyaWP3NbF3Wic5VTAkQhierYy3V7JjFvD4dsasiOAlMwBXemuLa9wZXwO9IMAkRqBPM8B33SiC/kBUrjPFd4BJwxOnUinQH6ApOsXXa2gACGvIFLGSwiQjALS7dVWwCAgNJ9V21XqOTqDgNRTQBp1tRUgQKptXxpdRgUIkIwC0u3VVoAAqbZ9aXQZFSBAMgro8u20bJLFOoF6BEgWDeneyitAgFTexDTALAoQIFnUo3srrwABUnkTmxtgHWsaAsSc/zjRUvFOXHwPwGAXCBAn3Np+Jwz6jP3OWniC7vg7AdFtycKgqElSoGgFKIIUbQF6vr4COUzmBIi+eejOiijQ5qyTODuA5EA22ianx1TEDWgYOgrYAUSnJ3QPKeCgAu4CwoUHihQOek5NuuQuIDUxAA3TbQXqCQiFJCteWUVZPX/a98GzolfJGq2ieUtmgsTuqttI/cr4h9YzgiQagi4gBQIFCBDyBFIgRoFaAhKEX1NBuFNdey2TL+etQPkAqbL3VXlseXu2oeeVDxBDA69XM0Serr0JEF3l6L5aKECA1MLMNMhkBeRRlgBJVq74KyhDKswGdgGpkWFrNNTCnLWIB9sFpIgR0TNJAYMK5AsITbMGTUdN5aFAvoDkMaLaPINmmzxMTYDkoXLaZ5DvSxSzJUp8uzUExJbQaSmg68ugQA0BccEsFYG0IsOI8whv2vf9wj8OUgGhKzAEF2YO5/pAEcQ5k0R0iAgsxFIOA0IeUYhH0ENDCjgMCFnKLQWKm7CKezJ9ojC9DxZprfS9bd5Ryk5rj9bIjU3JKIIYUZMa0VHA9ic7dfok3kOAZFGRJuYs6pXi3v8HOZ5zbDYLrEsAAAAASUVORK5CYII=\n"
}
},
"include": "document,order",
"fields": {
"orders": "has_signed_contract"
}
}'
A 200 status response looks like this:
{
"data": {
"id": "3f6a87d1-0b7c-51ac-9faa-34f7e5ede54e",
"type": "signatures",
"attributes": {
"document_id": "f61cea73-3f00-4ea3-8c3c-fdd3c3b3ae21",
"order_id": "0de07ba9-6e54-4fbb-bac5-dab0a5b5414b",
"customer_id": "0ed3f7f0-3a62-42cc-a63b-759ead093e64"
},
"relationships": {
"document": {
"data": {
"type": "documents",
"id": "f61cea73-3f00-4ea3-8c3c-fdd3c3b3ae21"
}
},
"order": {
"data": {
"type": "orders",
"id": "0de07ba9-6e54-4fbb-bac5-dab0a5b5414b"
}
},
"customer": {
"meta": {
"included": false
}
}
}
},
"included": [
{
"id": "f61cea73-3f00-4ea3-8c3c-fdd3c3b3ae21",
"type": "documents",
"attributes": {
"created_at": "2024-04-29T09:24:10+00:00",
"updated_at": "2024-04-29T09:24:10+00:00",
"archived": false,
"archived_at": null,
"document_type": "contract",
"number": 1,
"prefix": null,
"prefix_with_number": "1",
"date": "2024-04-29",
"due_date": null,
"name": "John Doe",
"address": null,
"reference": null,
"revised": false,
"finalized": true,
"sent": false,
"confirmed": true,
"status": "confirmed",
"signature_url": "/uploads/747e264e7504a6cf84eab60218e8df09/document/contract/signature/f61cea73-3f00-4ea3-8c3c-fdd3c3b3ae21/b6bf0525-d2bb-480d-ab68-26360a017be8.png",
"deposit_type": "none",
"deposit_value": 0.0,
"tag_list": [],
"price_in_cents": 0,
"grand_total_in_cents": 0,
"grand_total_with_tax_in_cents": 0,
"discount_in_cents": 0,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 0,
"deposit_in_cents": 0,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"tax_in_cents": 0,
"discount_percentage": 0.0,
"order_id": "0de07ba9-6e54-4fbb-bac5-dab0a5b5414b",
"customer_id": "0ed3f7f0-3a62-42cc-a63b-759ead093e64",
"tax_region_id": null,
"coupon_id": null
},
"relationships": {
"order": {
"meta": {
"included": false
}
},
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
}
}
},
{
"id": "0de07ba9-6e54-4fbb-bac5-dab0a5b5414b",
"type": "orders",
"attributes": {
"has_signed_contract": true
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"tax_region": {
"meta": {
"included": false
}
},
"coupon": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
},
"start_location": {
"meta": {
"included": false
}
},
"stop_location": {
"meta": {
"included": false
}
},
"transfers": {
"meta": {
"included": false
}
},
"tax_values": {
"meta": {
"included": false
}
},
"lines": {
"meta": {
"included": false
}
},
"stock_item_plannings": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/signatures
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=document,order,customer |
fields[] |
Array List of comma seperated fields to include ?fields[signatures]=document_id,order_id,customer_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][signature_base64] |
String Base64 encoded signature, use this field to store a signature |
data[attributes][document_id] |
Uuid The associated Document |
Includes
This request accepts the following includes:
document
order
customer
Sortings
A convienient way to bulk update positions for supported models.
Fields
Every sorting has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
type |
String_enum writeonlyType of model to update. Any of checkout_fields, bundle_items, default_properties, lines, photos, properties, tax_rates, collection_items, products |
ids |
Array_of_strings writeonlyArray of ids, positions are determined by the order of the array |
Sorting a resource
How to update positions:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/sortings' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "sorting",
"attributes": {
"type": "default_properties",
"ids": [
"29b92c98-8432-4258-b4c6-62f723bb51dc",
"bf3ab322-37f0-42c1-a429-bf7deeae7eb8",
"13d712e6-43fc-453b-82e9-2a8fb5afb552",
"d0b3df50-101a-4110-b6a1-ab2995083fa3",
"12f41202-3f83-4ccb-96e1-7d5cd2b28af2"
]
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "9a93e421-51b3-5bab-822c-d5118de8bc5f",
"type": "sortings"
},
"meta": {}
}
HTTP Request
POST /api/boomerang/sortings
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][type] |
String_enum Type of model to update. Any of checkout_fields, bundle_items, default_properties, lines, photos, properties, tax_rates, collection_items, products |
data[attributes][ids] |
Array_of_strings Array of ids, positions are determined by the order of the array |
Includes
This request does not accept any includes
Stock item plannings
Stock item plannings hold information about the planning of individual stock items (for trackable products). They make it possible to know precisely which stock items have been where and define when an item is available during a given period.
Stock item plannings are never directly created or updated through their resource; instead, they are always managed by booking items to an order or transitioning status.
Endpoints
GET /api/boomerang/stock_item_plannings
DELETE /api/boomerang/stock_item_plannings/{id}
Fields
Every stock item planning has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether stock item planning is archived |
archived_at |
Datetime nullable readonlyWhen the stock item planning was archived |
reserved |
Boolean readonlyWheter stock item is reserved, meaning it's unavailable for other orders |
started |
Boolean readonlyWheter stock item is started |
stopped |
Boolean readonlyWheter stock item is stopped. Meaning it's available again |
stock_item_id |
Uuid readonlyThe associated Stock item |
planning_id |
Uuid readonlyThe associated Planning |
order_id |
Uuid readonlyThe associated Order |
Relationships
Stock item plannings have the following relationships:
| Name | Description |
|---|---|
stock_item |
Stock items readonlyAssociated Stock item |
planning |
Plannings readonlyAssociated Planning |
order |
Orders readonlyAssociated Order |
Listing stock item plannings
How to fetch a list of stock item plannings:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/stock_item_plannings' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "8bbdcf72-becb-4b54-8817-63198f52a115",
"type": "stock_item_plannings",
"attributes": {
"created_at": "2024-04-29T09:24:11+00:00",
"updated_at": "2024-04-29T09:24:11+00:00",
"archived": false,
"archived_at": null,
"reserved": false,
"started": false,
"stopped": false,
"stock_item_id": "888aac61-a494-4bb6-8154-eea69bc58320",
"planning_id": "4cb59ba5-7ca4-4236-899a-29bbb6eeca0a",
"order_id": "a732aa44-8be7-43e8-a679-f98446f11782"
},
"relationships": {
"stock_item": {
"links": {
"related": "api/boomerang/stock_items/888aac61-a494-4bb6-8154-eea69bc58320"
}
},
"planning": {
"links": {
"related": "api/boomerang/plannings/4cb59ba5-7ca4-4236-899a-29bbb6eeca0a"
}
},
"order": {
"links": {
"related": "api/boomerang/orders/a732aa44-8be7-43e8-a679-f98446f11782"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/stock_item_plannings
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=stock_item,planning,order |
fields[] |
Array List of comma seperated fields to include ?fields[stock_item_plannings]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
reserved |
Boolean eq |
started |
Boolean eq |
stopped |
Boolean eq |
stock_item_id |
Uuid eq, not_eq |
planning_id |
Uuid eq, not_eq |
order_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
stock_item =>
product =>
photo
planning
order
Archiving a stock_item planning
How to archive a stock item planning:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/stock_item_plannings/39c814c5-34dd-4f9a-b789-f3b0ee90b06b' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "39c814c5-34dd-4f9a-b789-f3b0ee90b06b",
"type": "stock_item_plannings",
"attributes": {
"created_at": "2024-04-29T09:24:12+00:00",
"updated_at": "2024-04-29T09:24:12+00:00",
"archived": false,
"archived_at": null,
"reserved": false,
"started": false,
"stopped": false,
"stock_item_id": "0ba9e2a9-22d3-48e0-adc2-a12071e6e9ae",
"planning_id": "02a1a672-f65d-403c-9cae-9c598106513c",
"order_id": "c8f9fbd5-a993-4421-8d50-5de1b2a5d1a9"
},
"relationships": {
"stock_item": {
"links": {
"related": "api/boomerang/stock_items/0ba9e2a9-22d3-48e0-adc2-a12071e6e9ae"
}
},
"planning": {
"links": {
"related": "api/boomerang/plannings/02a1a672-f65d-403c-9cae-9c598106513c"
}
},
"order": {
"links": {
"related": "api/boomerang/orders/c8f9fbd5-a993-4421-8d50-5de1b2a5d1a9"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/stock_item_plannings/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[stock_item_plannings]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Stock items
For trackable products, each stock item is tracked and managed individually. Each stock item has a unique identifier that helps to keep track of it throughout Booqable.
A stock item can have one of the following types:
- Regular: Regular stock item (
fromandtilldates are not set). - Expected: Items will become part of your regular inventory once they surpass the available from date, used for "coming soon" products and purchase orders (only
fromdate is set). - Temporary: Temporary items will automatically become unavailable once they exceed the available till date, typically a sub-rental (
fromandtillare set).
Endpoints
PUT /api/boomerang/stock_items/{id}
POST /api/boomerang/stock_items
GET /api/boomerang/stock_items/{id}
GET /api/boomerang/stock_items
Fields
Every stock item has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether item is archived |
archived_at |
Datetime nullable readonlyWhen the item was archived |
identifier |
String Unique identifier (like serial number) |
status |
String readonlyWhether item is out with a customer or in-store/warehouse. One of archived, expected, in_stock, started, overdue, expired |
from |
Datetime nullableWhen the stock item will be available in stock (temporary items or expected arrival date) |
till |
Datetime nullableWhen item will be out of stock (temporary items) |
stock_item_type |
String readonlyBased on the values of from and till. One of regular, temporary |
product_group_id |
String readonlyUnique identifier of the product group this stock item belongs to |
properties |
Hash readonlyA hash containing all basic property values (include properties if you need more detailed information about properties) |
properties_attributes |
Array writeonlyCreate or update multiple properties associated with this item |
confirm_shortage |
Boolean writeonlyWhether to confirm a shortage when updating from, till or location of a stock item |
product_id |
Uuid The associated Product |
location_id |
Uuid The associated Location |
Relationships
Stock items have the following relationships:
| Name | Description |
|---|---|
product |
Products Associated Product |
location |
Locations readonlyAssociated Location |
barcode |
Barcodes Associated Barcode |
properties |
Properties readonlyAssociated Properties |
Updating a stock_item
How to update a stock item:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/stock_items/5cd68e6a-a92d-4955-af8e-ceab7fff61ca' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "5cd68e6a-a92d-4955-af8e-ceab7fff61ca",
"type": "stock_items",
"attributes": {
"identifier": "12346"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "5cd68e6a-a92d-4955-af8e-ceab7fff61ca",
"type": "stock_items",
"attributes": {
"created_at": "2024-04-29T09:31:13+00:00",
"updated_at": "2024-04-29T09:31:13+00:00",
"archived": false,
"archived_at": null,
"identifier": "12346",
"status": "in_stock",
"from": null,
"till": null,
"stock_item_type": "regular",
"product_group_id": "60d3b8a2-548b-4101-922e-2a054d66dca8",
"properties": {},
"product_id": "88aad358-a91a-4cb9-9363-f97aaf096fc3",
"location_id": "1c0c8061-82e0-4d4f-b7de-f9b30f8a0d3b"
},
"relationships": {
"product": {
"meta": {
"included": false
}
},
"location": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/stock_items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,location,properties |
fields[] |
Array List of comma seperated fields to include ?fields[stock_items]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][identifier] |
String Unique identifier (like serial number) |
data[attributes][from] |
Datetime When the stock item will be available in stock (temporary items or expected arrival date) |
data[attributes][till] |
Datetime When item will be out of stock (temporary items) |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this item |
data[attributes][confirm_shortage] |
Boolean Whether to confirm a shortage when updating from, till or location of a stock item |
data[attributes][product_id] |
Uuid The associated Product |
data[attributes][location_id] |
Uuid The associated Location |
Includes
This request accepts the following includes:
barcode
location
properties
product =>
product_group
Creating a stock_item
How to create a stock item:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_items' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_items",
"attributes": {
"identifier": "12345",
"product_id": "51330435-e166-4423-af3e-f9a4f7e5bfd5"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "765a380e-624d-458b-b1ba-685d11c5838b",
"type": "stock_items",
"attributes": {
"created_at": "2024-04-29T09:31:14+00:00",
"updated_at": "2024-04-29T09:31:14+00:00",
"archived": false,
"archived_at": null,
"identifier": "12345",
"status": "in_stock",
"from": null,
"till": null,
"stock_item_type": "regular",
"product_group_id": "1ac9414f-1a5f-4e82-b5c3-a7985110a52d",
"properties": {},
"product_id": "51330435-e166-4423-af3e-f9a4f7e5bfd5",
"location_id": "e361fe51-df72-4d38-9f9f-c3470ee393c0"
},
"relationships": {
"product": {
"meta": {
"included": false
}
},
"location": {
"meta": {
"included": false
}
},
"barcode": {
"meta": {
"included": false
}
},
"properties": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/stock_items
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,location,properties |
fields[] |
Array List of comma seperated fields to include ?fields[stock_items]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][identifier] |
String Unique identifier (like serial number) |
data[attributes][from] |
Datetime When the stock item will be available in stock (temporary items or expected arrival date) |
data[attributes][till] |
Datetime When item will be out of stock (temporary items) |
data[attributes][properties_attributes][] |
Array Create or update multiple properties associated with this item |
data[attributes][confirm_shortage] |
Boolean Whether to confirm a shortage when updating from, till or location of a stock item |
data[attributes][product_id] |
Uuid The associated Product |
data[attributes][location_id] |
Uuid The associated Location |
Includes
This request accepts the following includes:
barcode
location
properties
product =>
product_group
Fetching a stock_item
How to fetch a stock item:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/stock_items/4187e058-eb13-4596-94a0-4dad94f0bc69' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "4187e058-eb13-4596-94a0-4dad94f0bc69",
"type": "stock_items",
"attributes": {
"created_at": "2024-04-29T09:31:15+00:00",
"updated_at": "2024-04-29T09:31:15+00:00",
"archived": false,
"archived_at": null,
"identifier": "id1000202",
"status": "in_stock",
"from": null,
"till": null,
"stock_item_type": "regular",
"product_group_id": "ed8887bd-f968-4999-a535-bbaca664fbe3",
"properties": {},
"product_id": "82906793-32aa-46c3-ab0f-a1083dffa56c",
"location_id": "5fd28823-7b51-4009-bdef-b80f20d996b6"
},
"relationships": {
"product": {
"links": {
"related": "api/boomerang/products/82906793-32aa-46c3-ab0f-a1083dffa56c"
}
},
"location": {
"links": {
"related": "api/boomerang/locations/5fd28823-7b51-4009-bdef-b80f20d996b6"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=4187e058-eb13-4596-94a0-4dad94f0bc69&filter[owner_type]=stock_items"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=4187e058-eb13-4596-94a0-4dad94f0bc69&filter[owner_type]=stock_items"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/stock_items/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=barcode,location,properties |
fields[] |
Array List of comma seperated fields to include ?fields[stock_items]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
barcode
location
properties
product =>
product_group
Listing stock_items
How to fetch a list of stock items:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/stock_items' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "34b5148a-75f8-43b7-9581-f53db133bb77",
"type": "stock_items",
"attributes": {
"created_at": "2024-04-29T09:31:16+00:00",
"updated_at": "2024-04-29T09:31:16+00:00",
"archived": false,
"archived_at": null,
"identifier": "id1000203",
"status": "in_stock",
"from": null,
"till": null,
"stock_item_type": "regular",
"product_group_id": "0069ef2e-1e54-4d74-89bd-f23e95d20a1f",
"properties": {},
"product_id": "31ffb8ff-f51c-4750-bd89-c8c11946594f",
"location_id": "bb3e3697-757f-4207-bf0a-d1fe0ae2046d"
},
"relationships": {
"product": {
"links": {
"related": "api/boomerang/products/31ffb8ff-f51c-4750-bd89-c8c11946594f"
}
},
"location": {
"links": {
"related": "api/boomerang/locations/bb3e3697-757f-4207-bf0a-d1fe0ae2046d"
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=34b5148a-75f8-43b7-9581-f53db133bb77&filter[owner_type]=stock_items"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=34b5148a-75f8-43b7-9581-f53db133bb77&filter[owner_type]=stock_items"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/stock_items
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=product,barcode,location |
fields[] |
Array List of comma seperated fields to include ?fields[stock_items]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
identifier |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
from |
Datetime eq, not_eq, gt, gte, lt, lte |
till |
Datetime eq, not_eq, gt, gte, lt, lte |
stock_item_type |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
product_group_id |
Uuid eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
product_id |
Uuid eq, not_eq |
location_id |
Uuid eq, not_eq |
q |
String eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
stock_item_type |
Array count |
status |
Array count |
Includes
This request accepts the following includes:
product
barcode
location
properties
Stock item archivations
Archives a stock item.
Archivation is final and can not be undone.
When the request fails, the error.code attribute can have the
following values:
stock_item_archivedThe stock item was already archived before.stock_item_specifiedThe stock item has not been archived because this specific stock item has been planned for current or future orders. The orders to which this stock item has been planned are specified in themeta.blocking[0].order_idsfield.shortageThe stock item has not been archived because this would lead to an (un)acceptable shortage of the product for current or future orders. When the shortage is within the shortage limit of the product, a warning is returned. Otherwise a blocking error is returned. A warning can be overriden by settingconfirm_shortagetotrue. The orders that would be affected by the shortage can be found in eithermeta.blocking[0].order_idsormeta.warning[0].order_ids.
Fields
Every stock item archivation has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
confirm_shortage |
Boolean writeonlyA value of true overrides shortage warnings. |
stock_item_id |
Uuid The associated Stock item |
Relationships
Stock item archivations have the following relationships:
| Name | Description |
|---|---|
stock_item |
Stock items Associated Stock item |
Archive
When archival would create unallowed shortage:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "c5d8f745-aaff-44e3-b5ff-a904c3334f16"
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "shortage",
"status": "422",
"title": "Shortage",
"detail": "This will create shortage for running or future orders",
"meta": {
"warning": [],
"blocking": [
{
"reason": "shortage",
"shortage": 1,
"item_id": "45c4efb5-465b-478e-a089-dafa9e3aa610",
"mutation": -1,
"order_ids": [
"eeb3a67e-8cb8-4458-bf0a-6f61bd3b1431"
],
"location_id": "cd5cc4d4-9ac7-4068-962a-1df8439ade1b",
"available": 0,
"plannable": 0,
"stock_count": 1,
"planned": 1,
"needed": 1,
"cluster_available": 0,
"cluster_plannable": 0,
"cluster_stock_count": 1,
"cluster_planned": 1,
"cluster_needed": 1
}
]
}
}
]
}
When the StockItem is specified on a reserved Order:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "0372c47c-e320-41ca-9290-e40a19cba54f"
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "stock_item_specified",
"status": "422",
"title": "Stock item specified",
"detail": "This stock item is specified on a current or future order",
"meta": {
"blocking": [
{
"order_ids": [
"82148808-e144-4784-a11a-5e6ab2c0f7cc"
]
}
]
}
}
]
}
When the StockItem is not used, it can be archived:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "096040bb-6422-4067-8f37-fb3d52caa1d2"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "74c7db49-feca-5d89-939a-6d1dd3596a9e",
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "096040bb-6422-4067-8f37-fb3d52caa1d2"
},
"relationships": {
"stock_item": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
When archival would create allowed shortage, and confirm_shortage is true:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "c379d4ef-513b-4d43-bd6f-b72a94b23bd5",
"confirm_shortage": true
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "4354b3bb-8779-5a41-88a3-6b0243ecb428",
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "c379d4ef-513b-4d43-bd6f-b72a94b23bd5"
},
"relationships": {
"stock_item": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
When archival would create allowed shortage, but confirm_shortage is unspecified:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "3d1dd3e1-48ef-40e7-957d-b88017eebc20"
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "shortage",
"status": "422",
"title": "Shortage",
"detail": "This will create shortage for running or future orders",
"meta": {
"warning": [
{
"reason": "shortage",
"shortage": 1,
"item_id": "41b263b4-daa9-46f8-9349-37dfc74ee707",
"mutation": -1,
"order_ids": [
"7ebcbe7e-bb1d-492f-9d0b-3f99a5421752"
],
"location_id": "d1987823-379f-4c30-8bf9-196f5baf759f",
"available": 0,
"plannable": 1,
"stock_count": 1,
"planned": 1,
"needed": 1,
"cluster_available": 0,
"cluster_plannable": 1,
"cluster_stock_count": 1,
"cluster_planned": 1,
"cluster_needed": 1
}
],
"blocking": []
}
}
]
}
When the StockItem was already archived:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/stock_item_archivations' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "stock_item_archivations",
"attributes": {
"stock_item_id": "30f5ad4d-7568-4c6f-901d-a381d3beb1f2"
}
}
}'
A 422 status response looks like this:
{
"errors": [
{
"code": "stock_item_archived",
"status": "422",
"title": "Stock item archived",
"detail": "Stock item is already archived",
"meta": null
}
]
}
HTTP Request
POST /api/boomerang/stock_item_archivations
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=stock_item |
fields[] |
Array List of comma seperated fields to include ?fields[stock_item_archivations]=stock_item_id |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][confirm_shortage] |
Boolean A value of true overrides shortage warnings. |
data[attributes][stock_item_id] |
Uuid The associated Stock item |
Includes
This request accepts the following includes:
stock_item
Stock item suggestions
Use stock item suggestions to figure out which stock item can be booked, started, or stopped.
The suggestions are sorted: 1. Temporary stock items are sorted before permanent stock items. 2. Available stock items are sorted before overdue, unavailable and already_booked stock items. 3. Equally relevant stock items are sorted by the identifier.
Fields
Every stock item suggestion has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
stock_item_id |
Uuid The associated Stock item |
item_id |
Uuid readonlyID of the Product the suggested stock item belongs to. |
status |
String_enum readonlyStatus of the suggested stock item. One of available_in_location, available_in_cluster, overdue, unavailable, already_booked |
Relationships
Stock item suggestions have the following relationships:
| Name | Description |
|---|---|
stock_item |
Stock items readonlyAssociated Stock item |
Listing stock item suggestions
Retrieve stock item suggestions for booking:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/stock_item_suggestions?filter%5Baction%5D=book&filter%5Bitem_id%5D=01b4c5fd-9703-4d8e-b7eb-d2c3b8cbb424&filter%5Border_id%5D=65bfa307-ec56-4214-8404-b3648389d3fc' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "984d473f-6722-51f8-bb79-ff02f96a4e5f",
"type": "stock_item_suggestions",
"attributes": {
"stock_item_id": "ca85b079-09b6-4bc3-a3f1-6b2b3f97d402",
"item_id": "01b4c5fd-9703-4d8e-b7eb-d2c3b8cbb424",
"status": "available_in_location"
},
"relationships": {
"stock_item": {
"links": {
"related": "api/boomerang/stock_items/ca85b079-09b6-4bc3-a3f1-6b2b3f97d402"
}
}
}
},
{
"id": "46049036-0f5c-5483-a2b3-d34cbc36e86e",
"type": "stock_item_suggestions",
"attributes": {
"stock_item_id": "be4f1139-ef1b-469b-8397-fff1154f9174",
"item_id": "01b4c5fd-9703-4d8e-b7eb-d2c3b8cbb424",
"status": "already_booked"
},
"relationships": {
"stock_item": {
"links": {
"related": "api/boomerang/stock_items/be4f1139-ef1b-469b-8397-fff1154f9174"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/stock_item_suggestions
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=stock_item |
fields[] |
Array List of comma seperated fields to include ?fields[stock_item_suggestions]=stock_item_id,item_id,status |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
item_id |
Uuid requiredeq |
status |
String_enum eq |
order_id |
Uuid requiredeq |
action |
String_enum requiredeq |
q |
String eq |
location_id |
Uuid eq |
from |
Datetime eq |
till |
Datetime eq |
stock_item_id |
Uuid eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
stock_item
Tags
Tags are designed to find specific resources faster. They can be added to the following resources by supplying a tag_list.
Fields
Every tag has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonly |
for |
String writeonlyThe resource to show the tag counts for. One of Order, Customer, ProductGroup, Bundle, Document |
name |
String Name of the tag |
count |
Integer Total count |
Listing tags
How to fetch a list of tags with their counts:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tags?filter%5Bfor%5D=Order' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "f4f3af75-40f7-412b-b3fb-3c405902ee5e",
"type": "tags",
"attributes": {
"name": "vip",
"count": 1
}
},
{
"id": "cb5ca5c6-f223-4278-913e-07e4d7ebe513",
"type": "tags",
"attributes": {
"name": "webshop",
"count": 3
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/tags
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[tags]=name,count |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
for |
String eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Tax categories
You can create different tax categories and assign them according to the tax requirements of a product. The tax rates in the category are charged over a product when it's added to an order. An order's total tax rate is the sum of all product taxes on that order.
Endpoints
GET /api/boomerang/tax_categories
DELETE /api/boomerang/tax_categories/{id}
PUT /api/boomerang/tax_categories/{id}
GET /api/boomerang/tax_categories/{id}
POST /api/boomerang/tax_categories
Fields
Every tax category has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether tax category is archived |
archived_at |
Datetime nullable readonlyWhen the tax category was archived |
name |
String Name of the tax category |
default |
Boolean Whether this is the default tax category. Setting this value to true will set other tax categories to false |
tax_rates_attributes |
Array writeonlyThe tax rates to associate |
Relationships
Tax categories have the following relationships:
| Name | Description |
|---|---|
tax_rates |
Tax rates readonlyAssociated Tax rates |
Listing tax categories
How to fetch a list of tax categories:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_categories' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "52af2045-5f89-4b35-9275-d7d3dd676a21",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:24:40+00:00",
"updated_at": "2024-04-29T09:24:40+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"default": false
},
"relationships": {
"tax_rates": {
"links": {
"related": "api/boomerang/tax_rates?filter[owner_id]=52af2045-5f89-4b35-9275-d7d3dd676a21&filter[owner_type]=tax_categories"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/tax_categories
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_categories]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
default |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
tax_rates
Deleting a tax category
How to delete a tax category with tax rates:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/tax_categories/1bceb56f-92fb-437b-bc93-780bd9e85d11' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "1bceb56f-92fb-437b-bc93-780bd9e85d11",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:24:42+00:00",
"updated_at": "2024-04-29T09:24:42+00:00",
"archived": true,
"archived_at": "2024-04-29T09:24:42+00:00",
"name": "Sales Tax (Deleted)",
"default": false
},
"relationships": {
"tax_rates": {
"links": {
"related": "api/boomerang/tax_rates?filter[owner_id]=1bceb56f-92fb-437b-bc93-780bd9e85d11&filter[owner_type]=tax_categories"
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/tax_categories/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[tax_categories]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Updating a tax category
How to update a tax category with tax rates:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/tax_categories/d0b8967b-7546-4c91-8362-635e02c38cdd' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "d0b8967b-7546-4c91-8362-635e02c38cdd",
"type": "tax_categories",
"attributes": {
"name": "State Tax",
"tax_rates_attributes": [
{
"name": "VAT",
"value": 9
},
{
"id": "caebd20a-9801-4b55-a70c-17417375ebcf",
"_destroy": true
}
]
}
},
"include": "tax_rates"
}'
A 200 status response looks like this:
{
"data": {
"id": "d0b8967b-7546-4c91-8362-635e02c38cdd",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:24:43+00:00",
"updated_at": "2024-04-29T09:24:43+00:00",
"archived": false,
"archived_at": null,
"name": "State Tax",
"default": false
},
"relationships": {
"tax_rates": {
"data": [
{
"type": "tax_rates",
"id": "e16d3b22-2dc3-4992-9771-5a5d309292d9"
}
]
}
}
},
"included": [
{
"id": "e16d3b22-2dc3-4992-9771-5a5d309292d9",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:24:43+00:00",
"updated_at": "2024-04-29T09:24:43+00:00",
"name": "VAT",
"value": 9.0,
"position": 2,
"owner_id": "d0b8967b-7546-4c91-8362-635e02c38cdd",
"owner_type": "tax_categories"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/tax_categories/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_categories]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tax category |
data[attributes][default] |
Boolean Whether this is the default tax category. Setting this value to true will set other tax categories to false |
data[attributes][tax_rates_attributes][] |
Array The tax rates to associate |
Includes
This request accepts the following includes:
tax_rates
Fetching a tax category
How to fetch a tax categories with it's tax rates:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_categories/9147937a-a69b-4631-bbfc-beea768eccc6?include=tax_rates' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "9147937a-a69b-4631-bbfc-beea768eccc6",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:24:44+00:00",
"updated_at": "2024-04-29T09:24:44+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"default": false
},
"relationships": {
"tax_rates": {
"links": {
"related": "api/boomerang/tax_rates?filter[owner_id]=9147937a-a69b-4631-bbfc-beea768eccc6&filter[owner_type]=tax_categories"
},
"data": [
{
"type": "tax_rates",
"id": "6b0a8fc1-b04a-45f8-afc7-1df00dbea1a5"
}
]
}
}
},
"included": [
{
"id": "6b0a8fc1-b04a-45f8-afc7-1df00dbea1a5",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:24:44+00:00",
"updated_at": "2024-04-29T09:24:44+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "9147937a-a69b-4631-bbfc-beea768eccc6",
"owner_type": "tax_categories"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/tax_categories/9147937a-a69b-4631-bbfc-beea768eccc6"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/tax_categories/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_categories]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
tax_rates
Creating a tax category
How to create a tax category with tax rates:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/tax_categories' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "tax_categories",
"attributes": {
"name": "Sales Tax",
"tax_rates_attributes": [
{
"name": "VAT",
"value": 21
}
]
}
},
"include": "tax_rates"
}'
A 201 status response looks like this:
{
"data": {
"id": "a3d0f3e0-37fe-41b3-a25b-0e46a32f42de",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:24:45+00:00",
"updated_at": "2024-04-29T09:24:45+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"default": false
},
"relationships": {
"tax_rates": {
"data": [
{
"type": "tax_rates",
"id": "2793ba3f-5774-4e41-bd33-6c43cb874bef"
}
]
}
}
},
"included": [
{
"id": "2793ba3f-5774-4e41-bd33-6c43cb874bef",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:24:45+00:00",
"updated_at": "2024-04-29T09:24:45+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "a3d0f3e0-37fe-41b3-a25b-0e46a32f42de",
"owner_type": "tax_categories"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/tax_categories
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_categories]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tax category |
data[attributes][default] |
Boolean Whether this is the default tax category. Setting this value to true will set other tax categories to false |
data[attributes][tax_rates_attributes][] |
Array The tax rates to associate |
Includes
This request accepts the following includes:
tax_rates
Tax rates
Tax rates are always assigned to either a TaxRegion or TaxCategory. Tax rates define the individual rates that will be taxed.
Endpoints
GET /api/boomerang/tax_rates/{id}
GET api/boomerang/tax_rates
PUT /api/boomerang/tax_rates/{id}
DELETE /api/boomerang/tax_rates/{id}
POST /api/boomerang/tax_rates
Fields
Every tax rate has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String The name of the tax rate |
value |
Float The percentage value of the rate |
position |
Integer readonlyPosition of the tax rate |
owner_id |
Uuid ID of its owner |
owner_type |
String The resource type of the owner. One of tax_regions, tax_categories |
Relationships
Tax rates have the following relationships:
| Name | Description |
|---|---|
owner |
Tax category, Tax region Associated Owner |
Fetching a tax rate
How to fetch a tax rate:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_rates/5bf82591-5c8a-4503-b65a-29469b860f4d?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "5bf82591-5c8a-4503-b65a-29469b860f4d",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:26:56+00:00",
"updated_at": "2024-04-29T09:26:56+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "d80b878e-6889-46d9-acc8-980e36395497",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/tax_regions/d80b878e-6889-46d9-acc8-980e36395497"
},
"data": {
"type": "tax_regions",
"id": "d80b878e-6889-46d9-acc8-980e36395497"
}
}
}
},
"included": [
{
"id": "d80b878e-6889-46d9-acc8-980e36395497",
"type": "tax_regions",
"attributes": {
"created_at": "2024-04-29T09:26:56+00:00",
"updated_at": "2024-04-29T09:26:56+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"strategy": "add_to",
"default": false
},
"relationships": {
"tax_rates": {
"links": {
"related": "api/boomerang/tax_rates?filter[owner_id]=d80b878e-6889-46d9-acc8-980e36395497&filter[owner_type]=tax_regions"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/tax_rates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[tax_rates]=created_at,updated_at,name |
Includes
This request accepts the following includes:
owner
Listing tax rates
How to fetch a list of tax rates:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_rates' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "d9116e2f-0d50-44c0-985b-bfaec06b784b",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:26:57+00:00",
"updated_at": "2024-04-29T09:26:57+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "d2079099-7c5e-4d20-89ec-ab001f7c3740",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"links": {
"related": "api/boomerang/tax_regions/d2079099-7c5e-4d20-89ec-ab001f7c3740"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET api/boomerang/tax_rates
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[tax_rates]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
owner
Updating a tax rate
How to update a tax rate:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/tax_rates/c5754227-4b77-4db4-acca-7ddaa0714a71' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "c5754227-4b77-4db4-acca-7ddaa0714a71",
"type": "tax_rates",
"attributes": {
"value": 9
}
},
"include": "owner"
}'
A 200 status response looks like this:
{
"data": {
"id": "c5754227-4b77-4db4-acca-7ddaa0714a71",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:26:58+00:00",
"updated_at": "2024-04-29T09:26:58+00:00",
"name": "Vat",
"value": 9.0,
"position": 1,
"owner_id": "63ca9027-b9c4-4a7e-a6ec-d7e4aac9f80b",
"owner_type": "tax_categories"
},
"relationships": {
"owner": {
"data": {
"type": "tax_categories",
"id": "63ca9027-b9c4-4a7e-a6ec-d7e4aac9f80b"
}
}
}
},
"included": [
{
"id": "63ca9027-b9c4-4a7e-a6ec-d7e4aac9f80b",
"type": "tax_categories",
"attributes": {
"created_at": "2024-04-29T09:26:58+00:00",
"updated_at": "2024-04-29T09:26:58+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"default": false
},
"relationships": {
"tax_rates": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/tax_rates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[tax_rates]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String The name of the tax rate |
data[attributes][value] |
Float The percentage value of the rate |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of tax_regions, tax_categories |
Includes
This request accepts the following includes:
owner
Deleting a tax rate
How to delete a tax rate:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/tax_rates/812605be-d025-4b3f-a858-276505cbad53' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "812605be-d025-4b3f-a858-276505cbad53",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:26:58+00:00",
"updated_at": "2024-04-29T09:26:58+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "4a1abb5d-4f46-491d-bcf5-389ca00fe733",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/tax_rates/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[tax_rates]=created_at,updated_at,name |
Includes
This request does not accept any includes
Creating a tax rate
How to create a tax rate and associate it with an owner:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/tax_rates' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "tax_rates",
"attributes": {
"name": "VAT",
"value": 21,
"owner_id": "b99fd6fb-d8d5-48d4-9b02-d97ae6c14f2c",
"owner_type": "tax_regions"
}
},
"include": "owner"
}'
A 201 status response looks like this:
{
"data": {
"id": "862db6a3-90af-42c4-aeeb-4db80499b636",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:26:59+00:00",
"updated_at": "2024-04-29T09:26:59+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "b99fd6fb-d8d5-48d4-9b02-d97ae6c14f2c",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"data": {
"type": "tax_regions",
"id": "b99fd6fb-d8d5-48d4-9b02-d97ae6c14f2c"
}
}
}
},
"included": [
{
"id": "b99fd6fb-d8d5-48d4-9b02-d97ae6c14f2c",
"type": "tax_regions",
"attributes": {
"created_at": "2024-04-29T09:26:59+00:00",
"updated_at": "2024-04-29T09:26:59+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"strategy": "add_to",
"default": false
},
"relationships": {
"tax_rates": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/tax_rates
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[tax_rates]=created_at,updated_at,name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String The name of the tax rate |
data[attributes][value] |
Float The percentage value of the rate |
data[attributes][owner_id] |
Uuid ID of its owner |
data[attributes][owner_type] |
String The resource type of the owner. One of tax_regions, tax_categories |
Includes
This request accepts the following includes:
owner
Tax regions
You can create tax regions for specific customers. Booqable's tax system supports adding, replacing and compounding rates. A tax region can have one of the following strategies:
- Add to: Each tax rate is calculated over the order total and individually added or substracted to/from the order total.
- Compound: The tax is calculated over the order total, including product taxes (tax over tax). This method is used in some countries like Canada.
- Replace: Removes product taxes and calculates tax over the order total.
Endpoints
GET /api/boomerang/tax_regions/{id}
GET /api/boomerang/tax_regions
DELETE /api/boomerang/tax_regions/{id}
POST /api/boomerang/tax_regions
PUT /api/boomerang/tax_regions/{id}
Fields
Every tax region has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
archived |
Boolean readonlyWhether tax region is archived |
archived_at |
Datetime nullable readonlyWhen the tax region was archived |
name |
String Name of the tax region |
strategy |
String The strategy to apply. One of add_to, replace, compound |
default |
Boolean Whether this is the default tax region. Setting this value to true will set other tax regions to false |
tax_rates_attributes |
Array writeonlyThe tax rates to associate |
Relationships
Tax regions have the following relationships:
| Name | Description |
|---|---|
tax_rates |
Tax rates readonlyAssociated Tax rates |
Fetching a tax region
How to fetch a tax regions with it's tax rates:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_regions/0854c2a5-59f1-4d1f-b7b4-26ff52c43e37?include=tax_rates' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "0854c2a5-59f1-4d1f-b7b4-26ff52c43e37",
"created_at": "2024-04-29T09:30:16+00:00",
"updated_at": "2024-04-29T09:30:16+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"strategy": "add_to",
"default": false,
"tax_rates": [
{
"id": "7071eada-1d79-4899-a0c0-cf479600a9d3",
"created_at": "2024-04-29T09:30:16+00:00",
"updated_at": "2024-04-29T09:30:16+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "0854c2a5-59f1-4d1f-b7b4-26ff52c43e37",
"owner_type": "tax_regions"
}
]
}
}
HTTP Request
GET /api/boomerang/tax_regions/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_regions]=created_at,updated_at,archived |
Includes
This request accepts the following includes:
tax_rates
Listing tax regions
How to fetch a list of tax regions:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_regions' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "03f4a5e8-bf1b-418e-95ec-8ec189161377",
"created_at": "2024-04-29T09:30:16+00:00",
"updated_at": "2024-04-29T09:30:16+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"strategy": "add_to",
"default": false
}
]
}
HTTP Request
GET /api/boomerang/tax_regions
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_regions]=created_at,updated_at,archived |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
archived |
Boolean eq |
archived_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
strategy |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
default |
Boolean eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
tax_rates
Deleting a tax region
How to delete a tax region with tax rates:
curl --request DELETE \
--url 'https://example.booqable.com/api/boomerang/tax_regions/5686b3da-e7bb-4dcb-8e64-93bc2479896b' \
--header 'content-type: application/json' \
--data '{}'
A 200 status response looks like this:
{
"data": {
"id": "5686b3da-e7bb-4dcb-8e64-93bc2479896b",
"type": "tax_regions",
"attributes": {
"created_at": "2024-04-29T09:30:17+00:00",
"updated_at": "2024-04-29T09:30:17+00:00",
"archived": true,
"archived_at": "2024-04-29T09:30:17+00:00",
"name": "Sales Tax (Deleted)",
"strategy": "add_to",
"default": false
},
"relationships": {
"tax_rates": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
DELETE /api/boomerang/tax_regions/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[tax_regions]=created_at,updated_at,archived |
Includes
This request does not accept any includes
Creating a tax region
How to create a tax region with tax rates:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/tax_regions' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "tax_regions",
"attributes": {
"name": "Sales Tax",
"strategy": "compound",
"tax_rates_attributes": [
{
"name": "VAT",
"value": 21
}
]
}
},
"include": "tax_rates"
}'
A 201 status response looks like this:
{
"data": {
"id": "c64dfc74-c602-4147-a4c4-5565ea7c52b9",
"type": "tax_regions",
"attributes": {
"created_at": "2024-04-29T09:30:18+00:00",
"updated_at": "2024-04-29T09:30:18+00:00",
"archived": false,
"archived_at": null,
"name": "Sales Tax",
"strategy": "compound",
"default": false
},
"relationships": {
"tax_rates": {
"data": [
{
"type": "tax_rates",
"id": "7061b154-818d-4d1f-adef-b64398e010bc"
}
]
}
}
},
"included": [
{
"id": "7061b154-818d-4d1f-adef-b64398e010bc",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:30:18+00:00",
"updated_at": "2024-04-29T09:30:18+00:00",
"name": "VAT",
"value": 21.0,
"position": 1,
"owner_id": "c64dfc74-c602-4147-a4c4-5565ea7c52b9",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
POST /api/boomerang/tax_regions
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_regions]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tax region |
data[attributes][strategy] |
String The strategy to apply. One of add_to, replace, compound |
data[attributes][default] |
Boolean Whether this is the default tax region. Setting this value to true will set other tax regions to false |
data[attributes][tax_rates_attributes][] |
Array The tax rates to associate |
Includes
This request accepts the following includes:
tax_rates
Updating a tax region
How to update a tax region with tax rates:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/tax_regions/33031acd-2dff-47fb-a2a5-409795040f97' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "33031acd-2dff-47fb-a2a5-409795040f97",
"type": "tax_regions",
"attributes": {
"name": "State Tax",
"tax_rates_attributes": [
{
"name": "VAT",
"value": 9
},
{
"id": "94de284f-cce7-4904-8eaf-4fb90b6f9053",
"_destroy": true
}
]
}
},
"include": "tax_rates"
}'
A 200 status response looks like this:
{
"data": {
"id": "33031acd-2dff-47fb-a2a5-409795040f97",
"type": "tax_regions",
"attributes": {
"created_at": "2024-04-29T09:30:19+00:00",
"updated_at": "2024-04-29T09:30:19+00:00",
"archived": false,
"archived_at": null,
"name": "State Tax",
"strategy": "add_to",
"default": false
},
"relationships": {
"tax_rates": {
"data": [
{
"type": "tax_rates",
"id": "18437556-51b4-4e35-9747-0f227f28653c"
}
]
}
}
},
"included": [
{
"id": "18437556-51b4-4e35-9747-0f227f28653c",
"type": "tax_rates",
"attributes": {
"created_at": "2024-04-29T09:30:19+00:00",
"updated_at": "2024-04-29T09:30:19+00:00",
"name": "VAT",
"value": 9.0,
"position": 2,
"owner_id": "33031acd-2dff-47fb-a2a5-409795040f97",
"owner_type": "tax_regions"
},
"relationships": {
"owner": {
"meta": {
"included": false
}
}
}
}
],
"meta": {}
}
HTTP Request
PUT /api/boomerang/tax_regions/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=tax_rates |
fields[] |
Array List of comma seperated fields to include ?fields[tax_regions]=created_at,updated_at,archived |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][name] |
String Name of the tax region |
data[attributes][strategy] |
String The strategy to apply. One of add_to, replace, compound |
data[attributes][default] |
Boolean Whether this is the default tax region. Setting this value to true will set other tax regions to false |
data[attributes][tax_rates_attributes][] |
Array The tax rates to associate |
Includes
This request accepts the following includes:
tax_rates
Tax values
Tax values are always generated automatically by price calculations for orders and carts. They hold information about the amount taxed for a specific rate.
Endpoints
GET api/boomerang/tax_values
GET /api/boomerang/tax_values/{id}
Fields
Every tax value has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
name |
String readonlyName of the tax rate |
percentage |
Float readonlyThe percentage taxed |
value_in_cents |
Integer readonlyAmount of tax in cents |
tax_rate_id |
Uuid readonlyThe associated Tax rate |
owner_id |
Uuid readonlyID of its owner |
owner_type |
String readonlyThe resource type of the owner. One of orders, documents, carts, lines |
Relationships
Tax values have the following relationships:
| Name | Description |
|---|---|
tax_rate |
Tax rates readonlyAssociated Tax rate |
owner |
Order Associated Owner |
Listing tax values
How to fetch a list of tax values:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_values' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "89f2e6f4-4b90-43a7-b8ec-7f0d374266e0",
"type": "tax_values",
"attributes": {
"created_at": "2024-04-29T09:23:09+00:00",
"updated_at": "2024-04-29T09:23:09+00:00",
"name": "VAT 19%",
"percentage": 19.0,
"value_in_cents": 13800,
"tax_rate_id": "97819e0c-96ee-4328-b04c-5e13a0853ec5",
"owner_id": "7314a6ec-9899-439a-bfe8-4c4fe49c4973",
"owner_type": "orders"
},
"relationships": {
"tax_rate": {
"links": {
"related": "api/boomerang/tax_rates/97819e0c-96ee-4328-b04c-5e13a0853ec5"
}
},
"owner": {
"links": {
"related": "api/boomerang/orders/7314a6ec-9899-439a-bfe8-4c4fe49c4973"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET api/boomerang/tax_values
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[tax_values]=created_at,updated_at,name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
percentage |
Float eq, not_eq, gt, gte, lt, lte |
value_in_cents |
Integer eq, not_eq, gt, gte, lt, lte |
tax_rate_id |
Uuid eq, not_eq |
owner_id |
Uuid eq, not_eq |
owner_type |
String eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
value_in_cents |
Array sum, maximum, minimum, average |
Includes
This request does not accept any includes
Fetching a tax value
How to fetch a tax value:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/tax_values/dbf456ab-81f8-4009-a056-3715d4e01aac?include=owner' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "dbf456ab-81f8-4009-a056-3715d4e01aac",
"type": "tax_values",
"attributes": {
"created_at": "2024-04-29T09:23:09+00:00",
"updated_at": "2024-04-29T09:23:09+00:00",
"name": "VAT 19%",
"percentage": 19.0,
"value_in_cents": 13800,
"tax_rate_id": "505405a1-beb4-49b9-91a9-a39ebad4cb15",
"owner_id": "5921a96b-e44a-48aa-81a2-c8ea94ebe0ca",
"owner_type": "orders"
},
"relationships": {
"tax_rate": {
"links": {
"related": "api/boomerang/tax_rates/505405a1-beb4-49b9-91a9-a39ebad4cb15"
}
},
"owner": {
"links": {
"related": "api/boomerang/orders/5921a96b-e44a-48aa-81a2-c8ea94ebe0ca"
},
"data": {
"type": "orders",
"id": "5921a96b-e44a-48aa-81a2-c8ea94ebe0ca"
}
}
}
},
"included": [
{
"id": "5921a96b-e44a-48aa-81a2-c8ea94ebe0ca",
"type": "orders",
"attributes": {
"created_at": "2024-04-29T09:23:09+00:00",
"updated_at": "2024-04-29T09:23:09+00:00",
"number": null,
"status": "new",
"statuses": [
"new"
],
"status_counts": {
"new": 0,
"concept": 0,
"reserved": 0,
"started": 0,
"stopped": 0
},
"starts_at": "2024-04-27T09:15:00+00:00",
"stops_at": "2024-05-01T09:15:00+00:00",
"deposit_type": "percentage",
"deposit_value": 100.0,
"entirely_started": true,
"entirely_stopped": false,
"location_shortage": false,
"shortage": false,
"payment_status": "paid",
"override_period_restrictions": false,
"has_signed_contract": false,
"tag_list": [],
"properties": {},
"price_in_cents": 0,
"grand_total_in_cents": 0,
"grand_total_with_tax_in_cents": 0,
"tax_in_cents": 0,
"discount_in_cents": 0,
"coupon_discount_in_cents": 0,
"total_discount_in_cents": 0,
"deposit_in_cents": 0,
"deposit_paid_in_cents": 0,
"deposit_refunded_in_cents": 0,
"deposit_held_in_cents": 0,
"deposit_to_refund_in_cents": 0,
"to_be_paid_in_cents": 0,
"paid_in_cents": 0,
"discount_type": "percentage",
"discount_percentage": 0.0,
"customer_id": null,
"tax_region_id": null,
"coupon_id": null,
"start_location_id": "7c5b5db4-0b83-4324-97d3-b2ee9e54ecce",
"stop_location_id": "7c5b5db4-0b83-4324-97d3-b2ee9e54ecce"
},
"relationships": {
"customer": {
"links": {
"related": null
}
},
"tax_region": {
"links": {
"related": null
}
},
"coupon": {
"links": {
"related": null
}
},
"barcode": {
"links": {
"related": "api/boomerang/barcodes?filter[owner_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca&filter[owner_type]=orders"
}
},
"properties": {
"links": {
"related": "api/boomerang/properties?filter[owner_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca&filter[owner_type]=orders"
}
},
"start_location": {
"links": {
"related": "api/boomerang/locations/7c5b5db4-0b83-4324-97d3-b2ee9e54ecce"
}
},
"stop_location": {
"links": {
"related": "api/boomerang/locations/7c5b5db4-0b83-4324-97d3-b2ee9e54ecce"
}
},
"transfers": {
"links": {
"related": "api/boomerang/transfers?filter[order_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca"
}
},
"tax_values": {
"links": {
"related": "api/boomerang/tax_values?filter[owner_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca&filter[owner_type]=orders"
}
},
"lines": {
"links": {
"related": "api/boomerang/lines?filter[owner_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca&filter[owner_type]=orders"
}
},
"stock_item_plannings": {
"links": {
"related": "api/boomerang/stock_item_plannings?filter[order_id]=5921a96b-e44a-48aa-81a2-c8ea94ebe0ca"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/tax_values/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=owner |
fields[] |
Array List of comma seperated fields to include ?fields[tax_values]=created_at,updated_at,name |
Includes
This request accepts the following includes:
owner
Transfers
When an order causes a shortage for a location and that shortage can be solved by the inventory in the cluster, one or multiple transfers are created.
Fields
Every transfer has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
quantity |
Integer readonlyQuantity of items being transfered |
available_at |
Datetime readonlyDate when item should be available at destination location |
finalized |
Boolean readonlyWhether or not the transfer has completed |
item_id |
Uuid readonlyThe associated Item |
order_id |
Uuid readonlyThe associated Order |
source_location_id |
Uuid readonlyThe associated Source location |
destination_location_id |
Uuid readonlyThe associated Destination location |
Relationships
Transfers have the following relationships:
| Name | Description |
|---|---|
item |
Items readonlyAssociated Item |
order |
Orders readonlyAssociated Order |
source_location |
Locations readonlyAssociated Source location |
destination_location |
Locations readonlyAssociated Destination location |
Listing transfers
How to fetch a list of transfers:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/transfers' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "34cd468a-3c8d-402a-a063-146fe2ff4995",
"type": "transfers",
"attributes": {
"created_at": "2024-04-29T09:26:37+00:00",
"updated_at": "2024-04-29T09:26:37+00:00",
"quantity": 1,
"available_at": "2024-04-27T09:15:00+00:00",
"finalized": false,
"item_id": "2587aef3-c5db-473f-8647-46f63a76f2cd",
"order_id": "5b06651a-5093-4d5c-b54d-d8854cdf89ec",
"source_location_id": "ab10809a-81a5-453e-97bc-50bcbce8914c",
"destination_location_id": "ab10809a-81a5-453e-97bc-50bcbce8914c"
},
"relationships": {
"item": {
"links": {
"related": "api/boomerang/items/2587aef3-c5db-473f-8647-46f63a76f2cd"
}
},
"order": {
"links": {
"related": "api/boomerang/orders/5b06651a-5093-4d5c-b54d-d8854cdf89ec"
}
},
"source_location": {
"links": {
"related": "api/boomerang/locations/ab10809a-81a5-453e-97bc-50bcbce8914c"
}
},
"destination_location": {
"links": {
"related": "api/boomerang/locations/ab10809a-81a5-453e-97bc-50bcbce8914c"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/transfers
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=order,item,source_location |
fields[] |
Array List of comma seperated fields to include ?fields[transfers]=created_at,updated_at,quantity |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
q |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
quantity |
Integer eq, not_eq, gt, gte, lt, lte |
available_at |
Datetime eq, not_eq, gt, gte, lt, lte |
finalized |
Boolean eq |
item_id |
Uuid eq, not_eq |
order_id |
Uuid eq, not_eq |
source_location_id |
Uuid eq, not_eq |
destination_location_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request accepts the following includes:
order
item =>
photo
source_location
destination_location
Users
Users can be used to log into the web shop. They are useful for exposing your shop to a limited audience or verifiying that a customers can actually be reached via an email.
A user always belongs to a Customer. A customer can have multiple users. This is relevant for companies where multiple people are allowed to book orders in the name of that company. Because of this, a user should always be an actual person, not a legal person.
Depending on the setting in your Booqable account, creating a user can actually mean that you're inviting the user. In that case, the user still needs to confirm their email and set a password before the account is active. (See status)
Endpoints
GET /api/boomerang/users
PUT /api/boomerang/users/{id}
GET /api/boomerang/users/{id}
POST /api/boomerang/users
Fields
Every user has the following fields:
| Name | Description |
|---|---|
id |
Uuid readonlyPrimary key |
created_at |
Datetime readonlyWhen the resource was created |
updated_at |
Datetime readonlyWhen the resource was last updated |
first_name |
String The first name of the user |
last_name |
String The last name of the user |
name |
String The full name of the user (first_name + last_name) |
email |
String The email of the user |
status |
String readonlyOne of disabled, active, invited, unconfirmed |
disabled |
Boolean writeonlyWhen a user is disabled they cannot log into their account or create orders |
customer_id |
Uuid The associated Customer |
Relationships
Users have the following relationships:
| Name | Description |
|---|---|
customer |
Customers Associated Customer |
notes |
Notes readonlyAssociated Notes |
Listing users
How to find users belonging to a customer:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/users?filter%5Bcustomer_id%5D=5f287c69-49f5-445c-adb2-47a80efde147&include=customer' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "3402406a-29f7-4980-8b9b-ae69be4b047b",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:28+00:00",
"updated_at": "2024-04-29T09:26:28+00:00",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"status": "active",
"customer_id": "5f287c69-49f5-445c-adb2-47a80efde147"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/5f287c69-49f5-445c-adb2-47a80efde147"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=3402406a-29f7-4980-8b9b-ae69be4b047b&filter[owner_type]=users"
}
}
}
}
],
"meta": {}
}
How to fetch a list of users:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/users' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": [
{
"id": "7cf304c1-f6cf-41b3-aea6-be46e4ceffa8",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:29+00:00",
"updated_at": "2024-04-29T09:26:29+00:00",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"status": "active",
"customer_id": "4f2785a5-59a7-438d-92ba-c710ece3be70"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/4f2785a5-59a7-438d-92ba-c710ece3be70"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=7cf304c1-f6cf-41b3-aea6-be46e4ceffa8&filter[owner_type]=users"
}
}
}
}
],
"meta": {}
}
HTTP Request
GET /api/boomerang/users
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
filter |
Hash The filters to apply ?filter[attribute][eq]=value |
sort |
String How to sort the data ?sort=attribute1,-attribute2 |
meta |
Hash Metadata to send along ?meta[total][]=count |
page[number] |
String The page to request |
page[size] |
String The amount of items per page (max 100) |
Filters
This request can be filtered on:
| Name | Description |
|---|---|
id |
Uuid eq, not_eq |
created_at |
Datetime eq, not_eq, gt, gte, lt, lte |
updated_at |
Datetime eq, not_eq, gt, gte, lt, lte |
first_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
last_name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
name |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
email |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
status |
String eq, not_eq, eql, not_eql, prefix, not_prefix, suffix, not_suffix, match, not_match |
customer_id |
Uuid eq, not_eq |
Meta
Results can be aggregated on:
| Name | Description |
|---|---|
total |
Array count |
Includes
This request does not accept any includes
Enabling a user
How to enable a user:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/users/f390847c-7847-4748-b2fc-21a627a31326' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "f390847c-7847-4748-b2fc-21a627a31326",
"type": "users",
"attributes": {
"disabled": false
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "f390847c-7847-4748-b2fc-21a627a31326",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:30+00:00",
"updated_at": "2024-04-29T09:26:30+00:00",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"status": "active",
"customer_id": "4c3266a0-3b73-4cbc-9715-5dd545f3e6e0"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/users/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,disabled_by,notes |
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][first_name] |
String The first name of the user |
data[attributes][last_name] |
String The last name of the user |
data[attributes][name] |
String The full name of the user (first_name + last_name) |
data[attributes][email] |
String The email of the user |
data[attributes][disabled] |
Boolean When a user is disabled they cannot log into their account or create orders |
data[attributes][customer_id] |
Uuid The associated Customer |
Includes
This request accepts the following includes:
customer
disabled_by
notes
Disabling a user
How to disable a user:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/users/450ed53c-4ccf-42b2-9c20-bd59da25a154' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "450ed53c-4ccf-42b2-9c20-bd59da25a154",
"type": "users",
"attributes": {
"disabled": true
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "450ed53c-4ccf-42b2-9c20-bd59da25a154",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:31+00:00",
"updated_at": "2024-04-29T09:26:31+00:00",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"status": "disabled",
"customer_id": "8681a141-a500-4cdb-9d56-ca371099190a"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/users/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,disabled_by,notes |
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][first_name] |
String The first name of the user |
data[attributes][last_name] |
String The last name of the user |
data[attributes][name] |
String The full name of the user (first_name + last_name) |
data[attributes][email] |
String The email of the user |
data[attributes][disabled] |
Boolean When a user is disabled they cannot log into their account or create orders |
data[attributes][customer_id] |
Uuid The associated Customer |
Includes
This request accepts the following includes:
customer
disabled_by
notes
Fetching a user
How to fetch a user:
curl --request GET \
--url 'https://example.booqable.com/api/boomerang/users/1019fbe4-3975-4b7b-823e-e338dcf1176c' \
--header 'content-type: application/json' \
A 200 status response looks like this:
{
"data": {
"id": "1019fbe4-3975-4b7b-823e-e338dcf1176c",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:32+00:00",
"updated_at": "2024-04-29T09:26:32+00:00",
"first_name": "John",
"last_name": "Doe",
"name": "John Doe",
"email": "[email protected]",
"status": "active",
"customer_id": "bb13b812-d98a-4ae3-a338-f1bc33869212"
},
"relationships": {
"customer": {
"links": {
"related": "api/boomerang/customers/bb13b812-d98a-4ae3-a338-f1bc33869212"
}
},
"notes": {
"links": {
"related": "api/boomerang/notes?filter[owner_id]=1019fbe4-3975-4b7b-823e-e338dcf1176c&filter[owner_type]=users"
}
}
}
},
"meta": {}
}
HTTP Request
GET /api/boomerang/users/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,disabled_by,notes |
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
Includes
This request accepts the following includes:
customer
disabled_by
notes
Inviting a user
How to invite a user:
curl --request POST \
--url 'https://example.booqable.com/api/boomerang/users' \
--header 'content-type: application/json' \
--data '{
"data": {
"type": "users",
"attributes": {
"first_name": "Bob",
"last_name": "Bobsen",
"email": "[email protected]",
"customer_id": "d6aedf09-02ce-4886-ae0d-27a985c01621"
}
}
}'
A 201 status response looks like this:
{
"data": {
"id": "bacbdb58-09cb-4541-83f2-5cffc63e78b7",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:33+00:00",
"updated_at": "2024-04-29T09:26:33+00:00",
"first_name": "Bob",
"last_name": "Bobsen",
"name": "Bob Bobsen",
"email": "[email protected]",
"status": "invited",
"customer_id": "d6aedf09-02ce-4886-ae0d-27a985c01621"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
POST /api/boomerang/users
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,disabled_by,notes |
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][first_name] |
String The first name of the user |
data[attributes][last_name] |
String The last name of the user |
data[attributes][name] |
String The full name of the user (first_name + last_name) |
data[attributes][email] |
String The email of the user |
data[attributes][disabled] |
Boolean When a user is disabled they cannot log into their account or create orders |
data[attributes][customer_id] |
Uuid The associated Customer |
Includes
This request accepts the following includes:
customer
disabled_by
notes
Updating a user
How to update a user:
curl --request PUT \
--url 'https://example.booqable.com/api/boomerang/users/e0d08fca-b577-46b6-a204-cad4ee9abb5f' \
--header 'content-type: application/json' \
--data '{
"data": {
"id": "e0d08fca-b577-46b6-a204-cad4ee9abb5f",
"type": "users",
"attributes": {
"first_name": "Bobba"
}
}
}'
A 200 status response looks like this:
{
"data": {
"id": "e0d08fca-b577-46b6-a204-cad4ee9abb5f",
"type": "users",
"attributes": {
"created_at": "2024-04-29T09:26:34+00:00",
"updated_at": "2024-04-29T09:26:34+00:00",
"first_name": "Bobba",
"last_name": "Doe",
"name": "Bobba Doe",
"email": "[email protected]",
"status": "active",
"customer_id": "6240ed7e-674c-4fd9-b638-540f8a085d49"
},
"relationships": {
"customer": {
"meta": {
"included": false
}
},
"notes": {
"meta": {
"included": false
}
}
}
},
"meta": {}
}
HTTP Request
PUT /api/boomerang/users/{id}
Request params
This request accepts the following parameters:
| Name | Description |
|---|---|
include |
String List of comma seperated relationships ?include=customer,disabled_by,notes |
fields[] |
Array List of comma seperated fields to include ?fields[users]=created_at,updated_at,first_name |
Request body
This request accepts the following body:
| Name | Description |
|---|---|
data[attributes][first_name] |
String The first name of the user |
data[attributes][last_name] |
String The last name of the user |
data[attributes][name] |
String The full name of the user (first_name + last_name) |
data[attributes][email] |
String The email of the user |
data[attributes][disabled] |
Boolean When a user is disabled they cannot log into their account or create orders |
data[attributes][customer_id] |
Uuid The associated Customer |
Includes
This request accepts the following includes:
customer
disabled_by
notes