NAV

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:

When side posting is supported, it will be mentioned in the resource-specific documentation.

The following resources support advanced searching with POST requests:

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

  1. Go to your account settings page {company-name-here}.booqable.com/employees/current
  2. Name your new token
  3. 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:

  1. Go to your account settings page {company-name-here}.booqable.com/employees/current
  2. Name your new authentication method
  3. Insert your public key (for ES256 and RS256 only)
  4. 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:

Note that when using URLs as numbers, it's advised to base64 encode the number before filtering.

Endpoints

GET /api/boomerang/barcodes

GET /api/boomerang/barcodes/{id}

POST /api/boomerang/barcodes

PUT /api/boomerang/barcodes/{id}

DELETE /api/boomerang/barcodes/{id}

Fields

Every barcode has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When 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 readonly
The 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": "a93d4b2f-7a38-4612-aabc-ddb48c8cda05",
      "type": "barcodes",
      "attributes": {
        "created_at": "2024-07-08T09:24:25.913183+00:00",
        "updated_at": "2024-07-08T09:24:25.913183+00:00",
        "number": "http://bqbl.it/a93d4b2f-7a38-4612-aabc-ddb48c8cda05",
        "barcode_type": "qr_code",
        "image_url": "http://company-name-82.lvh.me:/barcodes/a93d4b2f-7a38-4612-aabc-ddb48c8cda05/image",
        "owner_id": "ead77beb-f651-419c-856a-cd1fdc7f2414",
        "owner_type": "customers"
      },
      "relationships": {}
    }
  ],
  "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%2F9d4dd99b-8c60-4f4f-b97e-37051f2e0add&include=owner' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "9d4dd99b-8c60-4f4f-b97e-37051f2e0add",
      "type": "barcodes",
      "attributes": {
        "created_at": "2024-07-08T09:24:25.213660+00:00",
        "updated_at": "2024-07-08T09:24:25.213660+00:00",
        "number": "http://bqbl.it/9d4dd99b-8c60-4f4f-b97e-37051f2e0add",
        "barcode_type": "qr_code",
        "image_url": "http://company-name-81.lvh.me:/barcodes/9d4dd99b-8c60-4f4f-b97e-37051f2e0add/image",
        "owner_id": "4f91beb0-7a56-4bd0-b941-537a1195f83b",
        "owner_type": "customers"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "customers",
            "id": "4f91beb0-7a56-4bd0-b941-537a1195f83b"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "4f91beb0-7a56-4bd0-b941-537a1195f83b",
      "type": "customers",
      "attributes": {
        "created_at": "2024-07-08T09:24:25.147689+00:00",
        "updated_at": "2024-07-08T09:24:25.218130+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": {}
    }
  ],
  "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=aHR0cDovL2JxYmwuaXQvYzkwZThkNjMtOTA4Yi00MDZhLThjY2MtNzQ5Y2Q2NmUyODc3&include=owner' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "c90e8d63-908b-406a-8ccc-749cd66e2877",
      "type": "barcodes",
      "attributes": {
        "created_at": "2024-07-08T09:24:27.068621+00:00",
        "updated_at": "2024-07-08T09:24:27.068621+00:00",
        "number": "http://bqbl.it/c90e8d63-908b-406a-8ccc-749cd66e2877",
        "barcode_type": "qr_code",
        "image_url": "http://company-name-83.lvh.me:/barcodes/c90e8d63-908b-406a-8ccc-749cd66e2877/image",
        "owner_id": "a4b60783-9569-489c-9669-2aea7de66975",
        "owner_type": "customers"
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "customers",
            "id": "a4b60783-9569-489c-9669-2aea7de66975"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "a4b60783-9569-489c-9669-2aea7de66975",
      "type": "customers",
      "attributes": {
        "created_at": "2024-07-08T09:24:26.992708+00:00",
        "updated_at": "2024-07-08T09:24:27.072612+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": {}
    }
  ],
  "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 => photo

product => photo

Fetching a barcode

How to fetch a barcode:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/barcodes/6a0b6368-545b-4f0e-9e7e-818df06c3ac4?include=owner' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "6a0b6368-545b-4f0e-9e7e-818df06c3ac4",
    "type": "barcodes",
    "attributes": {
      "created_at": "2024-07-08T09:24:24.533933+00:00",
      "updated_at": "2024-07-08T09:24:24.533933+00:00",
      "number": "http://bqbl.it/6a0b6368-545b-4f0e-9e7e-818df06c3ac4",
      "barcode_type": "qr_code",
      "image_url": "http://company-name-80.lvh.me:/barcodes/6a0b6368-545b-4f0e-9e7e-818df06c3ac4/image",
      "owner_id": "592a7e5b-33fa-4621-b8f8-4dfa3b9ddce9",
      "owner_type": "customers"
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "customers",
          "id": "592a7e5b-33fa-4621-b8f8-4dfa3b9ddce9"
        }
      }
    }
  },
  "included": [
    {
      "id": "592a7e5b-33fa-4621-b8f8-4dfa3b9ddce9",
      "type": "customers",
      "attributes": {
        "created_at": "2024-07-08T09:24:24.480210+00:00",
        "updated_at": "2024-07-08T09:24:24.536848+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": {}
    }
  ],
  "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 => photo

product => photo

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": "ca812d7e-2677-41b9-a11f-46166d359391",
          "owner_type": "customers"
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "c5f5279b-beb3-43c9-9342-482260a733c3",
    "type": "barcodes",
    "attributes": {
      "created_at": "2024-07-08T09:24:27.946551+00:00",
      "updated_at": "2024-07-08T09:24:27.946551+00:00",
      "number": "http://bqbl.it/c5f5279b-beb3-43c9-9342-482260a733c3",
      "barcode_type": "qr_code",
      "image_url": "http://company-name-84.lvh.me:/barcodes/c5f5279b-beb3-43c9-9342-482260a733c3/image",
      "owner_id": "ca812d7e-2677-41b9-a11f-46166d359391",
      "owner_type": "customers"
    },
    "relationships": {}
  },
  "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 => photo

product => photo

Updating a barcode

How to update a barcode:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/barcodes/09b867d0-b019-442c-b88b-499fb46c7725' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "09b867d0-b019-442c-b88b-499fb46c7725",
        "type": "barcodes",
        "attributes": {
          "number": "https://myfancysite.com"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "09b867d0-b019-442c-b88b-499fb46c7725",
    "type": "barcodes",
    "attributes": {
      "created_at": "2024-07-08T09:24:28.872398+00:00",
      "updated_at": "2024-07-08T09:24:29.050137+00:00",
      "number": "https://myfancysite.com",
      "barcode_type": "qr_code",
      "image_url": "http://company-name-85.lvh.me:/barcodes/09b867d0-b019-442c-b88b-499fb46c7725/image",
      "owner_id": "5c10a939-872f-4ca3-b0af-6148a61d656f",
      "owner_type": "customers"
    },
    "relationships": {}
  },
  "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 => photo

product => photo

Destroying a barcode

How to delete a barcode:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/barcodes/fd9b2d81-b9a4-4e8e-92af-46ef998a2344' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "fd9b2d81-b9a4-4e8e-92af-46ef998a2344",
    "type": "barcodes",
    "attributes": {
      "created_at": "2024-07-08T09:24:29.863571+00:00",
      "updated_at": "2024-07-08T09:24:29.863571+00:00",
      "number": "http://bqbl.it/fd9b2d81-b9a4-4e8e-92af-46ef998a2344",
      "barcode_type": "qr_code",
      "image_url": "http://company-name-86.lvh.me:/barcodes/fd9b2d81-b9a4-4e8e-92af-46ef998a2344/image",
      "owner_id": "89ac8ca0-2661-4af6-9dec-b6b6f287e0d1",
      "owner_type": "customers"
    },
    "relationships": {}
  },
  "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 => photo

product => photo

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 the book_bundle action under OrderFulfilments.

Endpoints

GET /api/boomerang/bundle_items

GET /api/boomerang/bundle_items/{id}

POST /api/boomerang/bundle_items

PUT /api/boomerang/bundle_items/{id}

DELETE /api/boomerang/bundle_items/{id}

Fields

Every bundle item has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When 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 nullable
The associated Product

Relationships

Bundle items have the following relationships:

Name Description
bundle Bundles readonly
Associated Bundle
product_group Product groups
Associated Product group
product Products readonly
Associated Product

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=728ea6b2-b5dd-46c8-968e-a994fce7c56e' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "866b1066-33fc-4ba3-b4f9-57ba244d899d",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:27:29.027219+00:00",
        "updated_at": "2024-07-08T09:27:29.027219+00:00",
        "quantity": 2,
        "discount_percentage": 15.0,
        "position": 1,
        "bundle_id": "728ea6b2-b5dd-46c8-968e-a994fce7c56e",
        "product_group_id": "70fc9cf3-f1c4-4c88-87e2-6669b16b6879",
        "product_id": "58a50d1c-d004-44be-8505-d391a124e5c7"
      },
      "relationships": {}
    }
  ],
  "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/32b17a0c-5154-49f8-97d8-3db18c226964' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "32b17a0c-5154-49f8-97d8-3db18c226964",
    "type": "bundle_items",
    "attributes": {
      "created_at": "2024-07-08T09:27:27.875211+00:00",
      "updated_at": "2024-07-08T09:27:27.875211+00:00",
      "quantity": 2,
      "discount_percentage": 15.0,
      "position": 1,
      "bundle_id": "9f056ef8-351a-47fa-bdd5-ff248e0904a3",
      "product_group_id": "257a0d6d-f0e0-4e12-91b3-f08c7472d432",
      "product_id": "13b375da-362b-4b2e-9875-8a732bdc051f"
    },
    "relationships": {}
  },
  "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

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": "0fe926a5-4d50-42b8-a27b-c757c7920d1f",
          "product_group_id": "0ed323d7-9cb9-4c53-b080-e34afb109940",
          "product_id": "999a8968-8fe2-4997-9eda-6b97cc2363e4",
          "quantity": 2,
          "discount_percentage": 15
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "6e940d07-9b14-4f73-af68-1e0817747295",
    "type": "bundle_items",
    "attributes": {
      "created_at": "2024-07-08T09:27:25.240161+00:00",
      "updated_at": "2024-07-08T09:27:25.240161+00:00",
      "quantity": 2,
      "discount_percentage": 15.0,
      "position": 2,
      "bundle_id": "0fe926a5-4d50-42b8-a27b-c757c7920d1f",
      "product_group_id": "0ed323d7-9cb9-4c53-b080-e34afb109940",
      "product_id": "999a8968-8fe2-4997-9eda-6b97cc2363e4"
    },
    "relationships": {}
  },
  "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

Updating a bundle item

How to update a bundle item:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/bundle_items/dbc5abd9-9d1d-405f-b0b8-a12a6c805167' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "dbc5abd9-9d1d-405f-b0b8-a12a6c805167",
        "type": "bundle_items",
        "attributes": {
          "quantity": 3,
          "discount_percentage": 20
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "dbc5abd9-9d1d-405f-b0b8-a12a6c805167",
    "type": "bundle_items",
    "attributes": {
      "created_at": "2024-07-08T09:27:30.656375+00:00",
      "updated_at": "2024-07-08T09:27:30.859766+00:00",
      "quantity": 3,
      "discount_percentage": 20.0,
      "position": 1,
      "bundle_id": "3d2484fb-0ed6-40ee-ae14-7ad43a21040c",
      "product_group_id": "47193d6a-1294-497c-bebb-15976251356e",
      "product_id": "e167409f-af69-40b0-937a-b9cd84dd27fe"
    },
    "relationships": {}
  },
  "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

Deleting a bundle item

How to delete a bundle item:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/bundle_items/45b86719-27ff-46f6-9434-5488271f98bb' \
    --header 'content-type: application/json' \
    --data '{}'

A 200 status response looks like this:

  {
  "data": {
    "id": "45b86719-27ff-46f6-9434-5488271f98bb",
    "type": "bundle_items",
    "attributes": {
      "created_at": "2024-07-08T09:27:26.581400+00:00",
      "updated_at": "2024-07-08T09:27:26.581400+00:00",
      "quantity": 2,
      "discount_percentage": 15.0,
      "position": 1,
      "bundle_id": "26b3195e-39bd-4056-998c-ed02aea74d5a",
      "product_group_id": "65ffa74d-5bc8-447a-895e-617ed23ef4ac",
      "product_id": "b6238370-2b47-476f-a56b-6067864f3fea"
    },
    "relationships": {}
  },
  "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

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

GET /api/boomerang/bundles

POST api/boomerang/bundles/search

GET /api/boomerang/bundles/{id}

POST /api/boomerang/bundles

PUT /api/boomerang/bundles/{id}

DELETE /api/boomerang/bundles/{id}

Fields

Every bundle has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether item is archived
archived_at Datetime nullable readonly
When the item was archived
type String readonly
One of product_groups, products, bundles
name String
Name of the item
slug String readonly
Slug of the item
product_type String readonly
One of rental, consumable, service
extra_information String nullable
Extra information about the item, shown on orders and documents
photo_url String readonly
Main photo url
remote_photo_url String writeonly
Url to an image on the web
photo_base64 String writeonly
Base64 encoded photo, use this field to store a main photo
description String nullable
Description 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 writeonly
The 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 readonly
Associated Photo
tax_category Tax categories readonly
Associated Tax category
bundle_items Bundle items readonly
Associated Bundle items
inventory_levels Inventory levels readonly
Associated Inventory levels

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": "8b128bed-4160-446a-b79b-c7ca4febfc56",
      "type": "bundles",
      "attributes": {
        "created_at": "2024-07-08T09:30:35.892060+00:00",
        "updated_at": "2024-07-08T09:30:35.892060+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": {}
    }
  ],
  "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

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": "be7c13f4-e3aa-47f0-9020-527c7eddef71"
    },
    {
      "id": "7120f017-67c7-48be-9539-83a15fe0bb01"
    },
    {
      "id": "d338871a-04c0-4d69-882c-59495d49d2bd"
    }
  ]
}

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

Fetching a bundle

How to fetch a bundle:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/bundles/5dec3190-650f-4f35-9679-cbba7b97af51' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "5dec3190-650f-4f35-9679-cbba7b97af51",
    "type": "bundles",
    "attributes": {
      "created_at": "2024-07-08T09:30:31.721040+00:00",
      "updated_at": "2024-07-08T09:30:31.721040+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": {}
  },
  "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": "6a7823d0-6bd2-436c-ba4a-52935c80071f",
              "product_id": "4d8a440e-7389-41a8-97f3-9e7aace65fc6"
            },
            {
              "quantity": 2,
              "discount_percentage": 15,
              "product_group_id": "67cb6fdc-005c-4171-9520-37de69a330ec",
              "product_id": "682a7d3b-ed38-477a-b3d9-b1cee2c68b3f"
            }
          ]
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "9524dc42-8110-472e-8b78-af035508cf8f",
    "type": "bundles",
    "attributes": {
      "created_at": "2024-07-08T09:30:28.946305+00:00",
      "updated_at": "2024-07-08T09:30:29.457393+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": {
      "bundle_items": {
        "data": [
          {
            "type": "bundle_items",
            "id": "c8dc2970-0e5a-43e0-b298-aa9f482c6e36"
          },
          {
            "type": "bundle_items",
            "id": "29a63654-6626-45b9-a343-9c7b30ef9cb5"
          },
          {
            "type": "bundle_items",
            "id": "86d849eb-460f-4409-b0ce-ae25c4206026"
          },
          {
            "type": "bundle_items",
            "id": "d4884c05-27a8-4c88-b0c2-f684d697f586"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "c8dc2970-0e5a-43e0-b298-aa9f482c6e36",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:28.952406+00:00",
        "updated_at": "2024-07-08T09:30:28.952406+00:00",
        "quantity": 2,
        "discount_percentage": 10.0,
        "position": 1,
        "bundle_id": "9524dc42-8110-472e-8b78-af035508cf8f",
        "product_group_id": "6a7823d0-6bd2-436c-ba4a-52935c80071f",
        "product_id": "4d8a440e-7389-41a8-97f3-9e7aace65fc6"
      },
      "relationships": {}
    },
    {
      "id": "29a63654-6626-45b9-a343-9c7b30ef9cb5",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:28.957029+00:00",
        "updated_at": "2024-07-08T09:30:28.957029+00:00",
        "quantity": 2,
        "discount_percentage": 15.0,
        "position": 2,
        "bundle_id": "9524dc42-8110-472e-8b78-af035508cf8f",
        "product_group_id": "67cb6fdc-005c-4171-9520-37de69a330ec",
        "product_id": "682a7d3b-ed38-477a-b3d9-b1cee2c68b3f"
      },
      "relationships": {}
    },
    {
      "id": "86d849eb-460f-4409-b0ce-ae25c4206026",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:28.961972+00:00",
        "updated_at": "2024-07-08T09:30:28.961972+00:00",
        "quantity": 2,
        "discount_percentage": 10.0,
        "position": 3,
        "bundle_id": "9524dc42-8110-472e-8b78-af035508cf8f",
        "product_group_id": "6a7823d0-6bd2-436c-ba4a-52935c80071f",
        "product_id": "4d8a440e-7389-41a8-97f3-9e7aace65fc6"
      },
      "relationships": {}
    },
    {
      "id": "d4884c05-27a8-4c88-b0c2-f684d697f586",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:28.966981+00:00",
        "updated_at": "2024-07-08T09:30:28.966981+00:00",
        "quantity": 2,
        "discount_percentage": 15.0,
        "position": 4,
        "bundle_id": "9524dc42-8110-472e-8b78-af035508cf8f",
        "product_group_id": "67cb6fdc-005c-4171-9520-37de69a330ec",
        "product_id": "682a7d3b-ed38-477a-b3d9-b1cee2c68b3f"
      },
      "relationships": {}
    }
  ],
  "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/53243ce2-8b60-493f-8ccd-1daa3007ddf1' \
    --header 'content-type: application/json' \
    --data '{
      "include": "bundle_items",
      "data": {
        "id": "53243ce2-8b60-493f-8ccd-1daa3007ddf1",
        "type": "bundles",
        "attributes": {
          "name": "iPad Pro Bundle",
          "bundle_items_attributes": [
            {
              "id": "d7131fa9-8963-4bf5-aa7b-905d1df88b4b",
              "_destroy": true
            },
            {
              "quantity": 2,
              "discount_percentage": 15,
              "product_group_id": "a45878bd-af29-4711-8a23-c1f116f0988d",
              "product_id": "a4bed1bb-9e8b-4654-89b4-7e6112fc981a"
            }
          ]
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "53243ce2-8b60-493f-8ccd-1daa3007ddf1",
    "type": "bundles",
    "attributes": {
      "created_at": "2024-07-08T09:30:32.390208+00:00",
      "updated_at": "2024-07-08T09:30:33.956431+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": {
      "bundle_items": {
        "data": [
          {
            "type": "bundle_items",
            "id": "cdbd3355-271a-4faa-bc99-2e68102c0f4c"
          },
          {
            "type": "bundle_items",
            "id": "86e8f6b2-4a41-4cf6-b031-fc6647f403c3"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "cdbd3355-271a-4faa-bc99-2e68102c0f4c",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:33.625207+00:00",
        "updated_at": "2024-07-08T09:30:33.625207+00:00",
        "quantity": 2,
        "discount_percentage": 15.0,
        "position": 2,
        "bundle_id": "53243ce2-8b60-493f-8ccd-1daa3007ddf1",
        "product_group_id": "a45878bd-af29-4711-8a23-c1f116f0988d",
        "product_id": "a4bed1bb-9e8b-4654-89b4-7e6112fc981a"
      },
      "relationships": {}
    },
    {
      "id": "86e8f6b2-4a41-4cf6-b031-fc6647f403c3",
      "type": "bundle_items",
      "attributes": {
        "created_at": "2024-07-08T09:30:33.629112+00:00",
        "updated_at": "2024-07-08T09:30:33.629112+00:00",
        "quantity": 2,
        "discount_percentage": 15.0,
        "position": 3,
        "bundle_id": "53243ce2-8b60-493f-8ccd-1daa3007ddf1",
        "product_group_id": "a45878bd-af29-4711-8a23-c1f116f0988d",
        "product_id": "a4bed1bb-9e8b-4654-89b4-7e6112fc981a"
      },
      "relationships": {}
    }
  ],
  "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

Archiving a bundle

How to delete a bundle:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/bundles/51327eeb-12ee-450b-9968-5ac444c5611d' \
    --header 'content-type: application/json' \
    --data '{}'

A 200 status response looks like this:

  {
  "data": {
    "id": "51327eeb-12ee-450b-9968-5ac444c5611d",
    "type": "bundles",
    "attributes": {
      "created_at": "2024-07-08T09:30:34.917882+00:00",
      "updated_at": "2024-07-08T09:30:35.085725+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:30:35.085725+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": {}
  },
  "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

Companies

Every action performed in a Booqable account is scoped to a company; A company holds information and configuration about an account.

Endpoints

GET /api/boomerang/companies/current

PUT /api/boomerang/companies/current

Fields

Every company has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
name String
Name of the company
slug String readonly
Company'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 readonly
Url of the uploaded logo
logo_base64 String writeonly
To update a logo send it as base64 encoded string
remove_logo Boolean writeonly
Remove current logo
favicon_url String readonly
Company favicon url
favicon_base64 String writeonly
To upload a favicon send it as a base64 encoded string
remove_favicon Boolean writeonly
Remove 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 readonly
Whether this is a development account
shop_theme_id Uuid
ID of installed shop theme
installed_online_store Boolean readonly
If the online store is installed, this boolean will return true
source String readonly
UTM source present during signup
medium String readonly
UTM medium present during signup
tenant_token String readonly
Token
pending_subscription Boolean readonly
Whether the company has a pending subscription
address String readonly
The full address
main_address_attributes Hash writeonly
A 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 readonly
A hash with the company main address fields. Use it when fetching the company. See address property type for more information
billing_address_attributes Hash writeonly
A 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 readonly
A hash with the company billing address fields. Use it when fetching the company. See address property type for more information
in_europe Boolean readonly
Whether company is situated in europe
continent String readonly
Continent the company is situated
subscription Hash readonly
Details about the subscription
third_party_id String readonly
ID used for third party tools

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": "b1a650ee-0ade-4437-86d2-428a3bb185bc",
    "type": "companies",
    "attributes": {
      "created_at": "2024-07-08T09:25:04.362698+00:00",
      "updated_at": "2024-07-08T09:25:04.381899+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,
      "source": null,
      "medium": null,
      "tenant_token": "418453b32eff0eaf0c00d0f4fa7cc926",
      "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,
        "latitude": null,
        "longitude": 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

Fetching subscription details

The subscription has the following fields:

Name Description
trial_ends_at Datetime readonly
When the trial ends
activated Boolean readonly
Whether subscription is active
suspended Boolean readonly
Whether account is suspended
canceled Boolean readonly
Whether subscription is canceled
canceled_at Datetime readonly
When the subscription is canceled (can also be in the future)
on_hold Boolean readonly
Whether account is on-hold
needs_activation Boolean readonly
Whether account needs to activate a subscription
legacy Datetime readonly
Whether it's a legacy subscription
product String readonly
Which product is active, one of Essential, Pro, Premium, Legacy
plan_id String readonly
ID of the product (used internally by Booqable)
interval String readonly
Billing interval, one of month, year
current_period_end Datetime readonly
When the current billing period ends
quantity Integer readonly
Quantity of the subscription (used for legacy subscriptions to buy seats)
extra_employees Integer readonly
Extra employees billed for
extra_locations Integer readonly
Extra locations billed for
amount_in_cents Integer readonly
Amount in cents
discount_in_cents Integer readonly
Discount in cents
balance_in_cents Integer readonly
Balance in cents, will be deducted from the next invoice(s)
coupon String readonly
Coupon 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 readonly
Billing strategy, one of send_invoice, charge_automatically
source Hash readonly
Information about the payment source
enabled_features Hash readonly
Beta features that are currently enabled
allowed_features Hash readonly
List of allowed features for plan
restrictions Hash readonly
Restrictions 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": "20e46c40-f766-4df3-8ade-753c0ebac53f",
    "type": "companies",
    "attributes": {
      "subscription": {
        "trial_ends_at": "2024-07-22T09:25:03.734Z",
        "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": 2000,
          "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

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": "00d87e6b-c406-4f7c-bcb7-1747a5f4a469",
        "type": "companies",
        "attributes": {
          "name": "iRent LLC"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "00d87e6b-c406-4f7c-bcb7-1747a5f4a469",
    "type": "companies",
    "attributes": {
      "created_at": "2024-07-08T09:25:05.002521+00:00",
      "updated_at": "2024-07-08T09:25:05.105388+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,
      "source": null,
      "medium": null,
      "tenant_token": "2e3f613e08a690402d8867d080c5cf3a",
      "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,
        "latitude": null,
        "longitude": 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

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 readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
name String readonly
Name of the country
alpha2 String readonly
ISO 3166-1 alpha-2 code
province_required Boolean readonly
Whether a province is required for addresses in this country
province_type String readonly
The province type of this country. One of county, emirate, governorate, prefecture, province, region, state, state_and_territory
form_layout String readonly
The layout of the address form
show_layout String readonly
The layout of the address when shown
zipcode_required Boolean readonly
Whether a zipcode is required for addresses in this country
zipcode_autofill String readonly
The value to use for the zipcode when autofilling
zipcode_format String readonly
The format of the zipcode, as a regular expression
zipcode_placeholder String readonly
The placeholder to use for the zipcode
zipcode_type String readonly
The zipcode type of this country. One of eircode, pincode, postal_code, postal_index, postcode, zipcode
city_autofill String readonly
The 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": "17e80d7c-4921-46f7-9f2b-1a7ecd0e2e3b",
      "type": "countries",
      "attributes": {
        "created_at": "2024-07-08T09:27:38.472395+00:00",
        "updated_at": "2024-07-08T09:27:38.472395+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

GET /api/boomerang/coupons

GET /api/boomerang/coupons/{id}

POST /api/boomerang/coupons

PUT /api/boomerang/coupons/{id}

DELETE /api/boomerang/coupons/{id}

Fields

Every coupon has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether coupon is archived
archived_at Datetime nullable readonly
When 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

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": "ebb138c5-1620-45f9-b6fa-cb723fe674d1",
      "type": "coupons",
      "attributes": {
        "created_at": "2024-07-08T09:27:32.273823+00:00",
        "updated_at": "2024-07-08T09:27:32.273823+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

Fetching a coupon

How to fetch a coupon:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/coupons/9253cce4-9306-450e-995a-20c7073efbe2' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "9253cce4-9306-450e-995a-20c7073efbe2",
    "type": "coupons",
    "attributes": {
      "created_at": "2024-07-08T09:27:32.825164+00:00",
      "updated_at": "2024-07-08T09:27:32.825164+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": "81b7126e-c7ef-4a52-8b77-b9d13c60a80e",
    "type": "coupons",
    "attributes": {
      "created_at": "2024-07-08T09:27:34.759937+00:00",
      "updated_at": "2024-07-08T09:27:34.759937+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

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/55e6c088-8e7a-443c-9d86-bb6b6f84b790' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "55e6c088-8e7a-443c-9d86-bb6b6f84b790",
        "type": "coupons",
        "attributes": {
          "identifier": "SUMMER30OFF",
          "coupon_type": "percentage",
          "value": 30
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "c9310ba2-cc9f-43e2-a042-6c89b3e49ba6",
    "type": "coupons",
    "attributes": {
      "created_at": "2024-07-08T09:27:34.240052+00:00",
      "updated_at": "2024-07-08T09:27:34.290330+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/ccb1af24-01c6-4d41-ad5a-e8d54dd3a7d1' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "ccb1af24-01c6-4d41-ad5a-e8d54dd3a7d1",
        "type": "coupons",
        "attributes": {
          "active": false
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "f0752de9-c89a-4379-a179-e44c43b6bcb0",
    "type": "coupons",
    "attributes": {
      "created_at": "2024-07-08T09:27:33.593041+00:00",
      "updated_at": "2024-07-08T09:27:33.639773+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

Archiving a coupon

How to archive a coupon:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/coupons/94cf07f1-75ad-48f9-b34d-21923ebd0485' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "94cf07f1-75ad-48f9-b34d-21923ebd0485",
    "type": "coupons",
    "attributes": {
      "created_at": "2024-07-08T09:27:31.715912+00:00",
      "updated_at": "2024-07-08T09:27:31.748966+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:27:31.748966+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

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

POST api/boomerang/customers/search

GET /api/boomerang/customers/{id}

POST /api/boomerang/customers

PUT /api/boomerang/customers/{id}

DELETE /api/boomerang/customers/{id}

Fields

Every customer has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether customer is archived
archived_at Datetime nullable readonly
When the customer was archived
number Integer readonly
The assigned number
name String
Person or Company name
email String nullable
E-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 readonly
A hash containing all basic property values (include properties if you need more detailed information about properties)
properties_attributes Array writeonly
Create 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 nullable
The associated Tax region

Relationships

Customers have the following relationships:

Name Description
merge_suggestion_customer Customers readonly
Associated Merge suggestion customer
tax_region Tax regions readonly
Associated Tax region
properties Properties readonly
Associated Properties
barcode Barcodes
Associated Barcode
notes Notes readonly
Associated Notes

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": "b450a4b4-b2f7-4090-884b-d55fab814776",
      "type": "customers",
      "attributes": {
        "created_at": "2024-07-08T09:24:20.787545+00:00",
        "updated_at": "2024-07-08T09:24:20.787545+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": {}
    }
  ],
  "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, gt
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": "7a11defe-ec82-4eba-9331-1ead1c35f95e"
    },
    {
      "id": "9d95ff4b-bdc2-4d35-b676-cad85b838ea1"
    }
  ]
}

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, gt
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

Fetching a customer

How to fetch a customers:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/customers/90c9f8c8-cde9-4f14-b330-2f0fdbe792a1?include=barcode%2Cproperties' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "90c9f8c8-cde9-4f14-b330-2f0fdbe792a1",
    "type": "customers",
    "attributes": {
      "created_at": "2024-07-08T09:24:19.370752+00:00",
      "updated_at": "2024-07-08T09:24:19.370752+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": {
      "properties": {
        "data": []
      },
      "barcode": {
        "data": null
      }
    }
  },
  "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

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": "94b473d0-6a4e-429a-b1b0-6570bf49d2ce",
    "type": "customers",
    "attributes": {
      "created_at": "2024-07-08T09:24:22.037511+00:00",
      "updated_at": "2024-07-08T09:24:22.037511+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": {}
  },
  "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

Updating a customer

How to update a customer:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/customers/98a6fe65-0a67-4896-84ac-17cdf65deeed' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "98a6fe65-0a67-4896-84ac-17cdf65deeed",
        "type": "customers",
        "attributes": {
          "name": "Jane Doe"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "98a6fe65-0a67-4896-84ac-17cdf65deeed",
    "type": "customers",
    "attributes": {
      "created_at": "2024-07-08T09:24:17.471096+00:00",
      "updated_at": "2024-07-08T09:24:17.618288+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": {}
  },
  "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

Archiving a customer

How to archive a customer:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/customers/787ddcd1-e70a-4e51-b322-b7153f71288c' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "787ddcd1-e70a-4e51-b322-b7153f71288c",
    "type": "customers",
    "attributes": {
      "created_at": "2024-07-08T09:24:23.569153+00:00",
      "updated_at": "2024-07-08T09:24:23.825960+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:24:23.825960+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": {}
  },
  "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

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:

Endpoints

GET /api/boomerang/default_properties

GET /api/boomerang/default_properties/{id}

POST /api/boomerang/default_properties

PUT /api/boomerang/default_properties/{id}

DELETE /api/boomerang/default_properties/{id}

Fields

Every default property has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When 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 readonly
Whether this property is editable

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": "8d9044a5-7437-494a-ae30-fbfaf71101af",
      "type": "default_properties",
      "attributes": {
        "created_at": "2024-07-08T09:22:38.352649+00:00",
        "updated_at": "2024-07-08T09:22:38.352649+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

Fetching a default property

How to fetch a default properties:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/default_properties/cbe497fe-8370-44fa-89c9-96dd4d2b0731?include=owner' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "cbe497fe-8370-44fa-89c9-96dd4d2b0731",
    "type": "default_properties",
    "attributes": {
      "created_at": "2024-07-08T09:22:37.655491+00:00",
      "updated_at": "2024-07-08T09:22:37.655491+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

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": "50391ac4-a738-431c-9112-93105f759cb1",
    "type": "default_properties",
    "attributes": {
      "created_at": "2024-07-08T09:22:36.871802+00:00",
      "updated_at": "2024-07-08T09:22:36.871802+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

Updating a default property

How to update a default property:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/default_properties/d79b5fc9-9e88-4e7d-9cbf-9409ac1ce555' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "d79b5fc9-9e88-4e7d-9cbf-9409ac1ce555",
        "type": "default_properties",
        "attributes": {
          "property_type": "text_field"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "d79b5fc9-9e88-4e7d-9cbf-9409ac1ce555",
    "type": "default_properties",
    "attributes": {
      "created_at": "2024-07-08T09:22:35.932580+00:00",
      "updated_at": "2024-07-08T09:22:36.000533+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

Deleting a default property

How to delete a default property:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/default_properties/5c73382e-9614-47b7-a7ab-ad11213dbc8c' \
    --header 'content-type: application/json' \
    --data '{}'

A 200 status response looks like this:

  {
  "data": {
    "id": "5c73382e-9614-47b7-a7ab-ad11213dbc8c",
    "type": "default_properties",
    "attributes": {
      "created_at": "2024-07-08T09:22:39.006645+00:00",
      "updated_at": "2024-07-08T09:22:39.006645+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

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:

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

POST api/boomerang/documents/search

GET /api/boomerang/documents/{id}

POST /api/boomerang/documents

PUT /api/boomerang/documents/{id}

DELETE /api/boomerang/documents/{id}

Fields

Every document has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether document is archived
archived_at Datetime nullable readonly
When 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 readonly
Rendered 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 readonly
Url where the signature is stored
deposit_type String nullable
One 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 readonly
Subtotal excl. taxes (excl. deposit)
grand_total_in_cents Integer readonly
Total excl. taxes (excl. deposit)
grand_total_with_tax_in_cents Integer readonly
Amount incl. taxes (excl. deposit)
discount_in_cents Integer readonly
Discount (incl. or excl. taxes based on tax_strategy
coupon_discount_in_cents Integer readonly
Coupon discount (incl. or excl. taxes based on tax_strategy
total_discount_in_cents Integer readonly
Total discount (incl. or excl. taxes based on tax_strategy
deposit_in_cents Integer readonly
Deposit
deposit_paid_in_cents Integer readonly
How much of the deposit is paid
deposit_refunded_in_cents Integer readonly
How much of the deposit is refunded
deposit_held_in_cents Integer readonly
Amount of deposit held
deposit_to_refund_in_cents Integer readonly
Amount of deposit (still) to be refunded
to_be_paid_in_cents Integer readonly
Amount that (still) has to be paid
paid_in_cents Integer readonly
How much was paid
tax_in_cents Integer readonly
Total tax
discount_percentage Float
The discount percentage applied to this order
order_id Uuid
The associated Order
customer_id Uuid nullable
The associated Customer
tax_region_id Uuid nullable
The associated Tax region
coupon_id Uuid nullable
The associated Coupon
body String readonly
Custom 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 readonly
The 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 readonly
Associated Lines
tax_values Tax values readonly
Associated 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": "00429d17-f2ed-42f2-af42-0ca578d3e49f",
      "type": "documents",
      "attributes": {
        "created_at": "2024-07-08T09:25:29.576445+00:00",
        "updated_at": "2024-07-08T09:25:29.691256+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": "957591d0-272b-47b6-b585-0b2dadcc3ff6",
        "customer_id": "fb42d4bc-8c05-4797-be3b-06772331719a",
        "tax_region_id": null,
        "coupon_id": null
      },
      "relationships": {}
    }
  ],
  "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, gt
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
date_or_created_at Datetime
eq, not_eq, gt, gte, lt, lte, between
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

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-07-05T09:25:19.125Z"
                  }
                },
                {
                  "date": {
                    "lte": "2024-07-11T09:25:19.125Z"
                  }
                }
              ]
            }
          ]
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "5987d8b7-2e76-400a-91b3-22763f0ce838"
    },
    {
      "id": "f55cb0a5-7d6f-4654-a75e-e07266392fb8"
    }
  ]
}

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, gt
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
date_or_created_at Datetime
eq, not_eq, gt, gte, lt, lte, between
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

Fetching a document

How to fetch a documents:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/documents/dfa8b9a5-7db6-40bb-acf2-9cf6512ef1ec' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "dfa8b9a5-7db6-40bb-acf2-9cf6512ef1ec",
    "type": "documents",
    "attributes": {
      "created_at": "2024-07-08T09:25:12.820381+00:00",
      "updated_at": "2024-07-08T09:25:12.903312+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": "91a7ac80-12e3-431f-b3de-9ab400fa2883",
      "customer_id": "adc849f3-abaf-49d3-a709-e4654e238288",
      "tax_region_id": null,
      "coupon_id": null
    },
    "relationships": {}
  },
  "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

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": "1ff9778d-77f4-4bce-9a51-cf8c34e84490"
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "b474549c-09ff-4d2d-8e7d-970ea509b52e",
    "type": "documents",
    "attributes": {
      "created_at": "2024-07-08T09:25:10.164966+00:00",
      "updated_at": "2024-07-08T09:25:10.193797+00:00",
      "archived": false,
      "archived_at": null,
      "document_type": "contract",
      "number": 1,
      "prefix": null,
      "prefix_with_number": "1",
      "date": "2024-07-08",
      "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": "1ff9778d-77f4-4bce-9a51-cf8c34e84490",
      "customer_id": "f09620c9-9f87-4609-a620-59c7cf311314",
      "tax_region_id": null,
      "coupon_id": null
    },
    "relationships": {}
  },
  "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

Updating a document

How to update a document:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/documents/de53384a-494f-43cf-bbf1-8dc891495fb7' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "de53384a-494f-43cf-bbf1-8dc891495fb7",
        "type": "documents",
        "attributes": {
          "name": "Jane Doe"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "de53384a-494f-43cf-bbf1-8dc891495fb7",
    "type": "documents",
    "attributes": {
      "created_at": "2024-07-08T09:25:21.528490+00:00",
      "updated_at": "2024-07-08T09:25:22.729886+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": "336ce4d4-7318-4ad9-b7da-57dd714373d1",
      "customer_id": "7a434b3b-078d-4cdf-ac62-05eaf18f93fe",
      "tax_region_id": null,
      "coupon_id": null
    },
    "relationships": {}
  },
  "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

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/8b3d79af-087e-4d37-b34a-46150b62d5c0' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "8b3d79af-087e-4d37-b34a-46150b62d5c0",
    "type": "documents",
    "attributes": {
      "created_at": "2024-07-08T09:25:25.341017+00:00",
      "updated_at": "2024-07-08T09:25:26.544784+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:25:26.544784+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": "dc62ff0a-60d0-4085-87c9-9a63a411c507",
      "customer_id": "a055bbb9-5002-4bdb-b646-1c2c1d143e85",
      "tax_region_id": null,
      "coupon_id": null
    },
    "relationships": {}
  },
  "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

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

GET /api/boomerang/email_templates

GET /api/boomerang/email_templates/{id}

POST /api/boomerang/email_templates

PUT /api/boomerang/email_templates/{id}

DELETE /api/boomerang/email_templates/{id}

Fields

Every email template has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
name String
Name of the template
identifier String readonly
A 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 readonly
Whether this is a system default template
automated Boolean readonly
When true, this template is used by built-in features and can not be deleted. Updating is possible.

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": "34a8e9e9-1984-4282-8d54-5952f3153133",
      "type": "email_templates",
      "attributes": {
        "created_at": "2024-07-08T09:30:23.747664+00:00",
        "updated_at": "2024-07-08T09:30:23.747664+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

Fetching an email template

How to fetch an email templates:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/email_templates/93c0ef41-6c90-4b3c-b953-39749063a564' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "93c0ef41-6c90-4b3c-b953-39749063a564",
    "type": "email_templates",
    "attributes": {
      "created_at": "2024-07-08T09:30:23.245174+00:00",
      "updated_at": "2024-07-08T09:30:23.245174+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

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": "02de182f-9968-40c0-99f5-dc22696d589b",
    "type": "email_templates",
    "attributes": {
      "created_at": "2024-07-08T09:30:22.740162+00:00",
      "updated_at": "2024-07-08T09:30:22.740162+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

Updating an email template

How to update an email template:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/email_templates/fb764bf0-3960-4c17-8cac-c9d95966cb0f' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "fb764bf0-3960-4c17-8cac-c9d95966cb0f",
        "type": "email_templates",
        "attributes": {
          "name": "Order confirmation"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "fb764bf0-3960-4c17-8cac-c9d95966cb0f",
    "type": "email_templates",
    "attributes": {
      "created_at": "2024-07-08T09:30:21.557107+00:00",
      "updated_at": "2024-07-08T09:30:21.596405+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": {}
}

How to update a default email template:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/email_templates/255ee9f3-4684-4023-aeaf-06d7c7c80dca' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "255ee9f3-4684-4023-aeaf-06d7c7c80dca",
        "type": "email_templates",
        "attributes": {
          "name": "Order confirmation"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "255ee9f3-4684-4023-aeaf-06d7c7c80dca",
    "type": "email_templates",
    "attributes": {
      "created_at": "2024-07-08T09:30:22.121413+00:00",
      "updated_at": "2024-07-08T09:30:22.179934+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": {}
}

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

Deleting an email template

How to delete a email template:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/email_templates/33878c91-44fb-486c-9e30-348f2fd6cbe8' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "33878c91-44fb-486c-9e30-348f2fd6cbe8",
    "type": "email_templates",
    "attributes": {
      "created_at": "2024-07-08T09:30:24.258857+00:00",
      "updated_at": "2024-07-08T09:30:24.258857+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

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 readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When 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.
has_error Boolean readonly
Whether any errors occur when sending this email
sent Boolean readonly
Whether the email was sent successfully
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 readonly
The associated Employee

Relationships

Emails have the following relationships:

Name Description
order Orders readonly
Associated Order
customer Customers readonly
Associated Customer
email_template Email templates readonly
Associated Email template
employee Employees readonly
Associated Employee

Listing emails

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": "aaee913d-684f-4641-a70b-38b99af9a58a",
      "type": "emails",
      "attributes": {
        "created_at": "2024-07-08T09:26:37.343267+00:00",
        "updated_at": "2024-07-08T09:26:37.343267+00:00",
        "subject": "Order confirmation",
        "body": "We hereby confirm your order with number #123",
        "recipients": "[email protected]",
        "has_error": false,
        "sent": false,
        "document_ids": [],
        "order_id": null,
        "customer_id": "1ff398e3-709a-4f88-bd4f-3e18bb39aa18",
        "email_template_id": null,
        "employee_id": null
      },
      "relationships": {}
    }
  ],
  "meta": {}
}

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=d90521f5-fc89-4e15-a359-e182d5946748' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "121a06b1-31b9-4781-817d-cfa1dabc7cd6",
      "type": "emails",
      "attributes": {
        "created_at": "2024-07-08T09:26:36.626420+00:00",
        "updated_at": "2024-07-08T09:26:36.681518+00:00",
        "subject": "Order confirmation",
        "body": "We hereby confirm your order with number #123",
        "recipients": "[email protected]",
        "has_error": false,
        "sent": false,
        "document_ids": [],
        "order_id": "d90521f5-fc89-4e15-a359-e182d5946748",
        "customer_id": "02e9e85d-b18d-4929-a058-8748851edd17",
        "email_template_id": null,
        "employee_id": null
      },
      "relationships": {}
    }
  ],
  "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
has_error Boolean
eq
sent Boolean
eq
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": "df8619bd-fa97-4055-8bae-716ed680bafd",
          "order_id": "eec9df86-ebec-41b9-abe4-0799f0891923",
          "customer_id": "ed0ca48d-a167-4aee-ab87-6262283d4e4a",
          "document_ids": [
            "ffb4bfca-6572-4437-9b46-20610fa92d86"
          ]
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "b438c760-6340-488c-a025-79c219d310d5",
    "type": "emails",
    "attributes": {
      "created_at": "2024-07-08T09:25:51.120731+00:00",
      "updated_at": "2024-07-08T09:25:51.120731+00:00",
      "subject": "Order confirmation",
      "body": "Hi {{customer.name}}",
      "recipients": "[email protected],[email protected]",
      "has_error": false,
      "sent": false,
      "document_ids": [
        "ffb4bfca-6572-4437-9b46-20610fa92d86"
      ],
      "order_id": "eec9df86-ebec-41b9-abe4-0799f0891923",
      "customer_id": "ed0ca48d-a167-4aee-ab87-6262283d4e4a",
      "email_template_id": "df8619bd-fa97-4055-8bae-716ed680bafd",
      "employee_id": "08945fc9-d0ed-4bb1-a822-055339e5daa8"
    },
    "relationships": {}
  },
  "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

GET /api/boomerang/employees/{id}

PUT /api/boomerang/employees/{id}

Fields

Every employee has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
name String readonly
Full 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 readonly
Unconfirmed e-mail address if present
current_password String writeonly
Current password, needed to update password or email address
password String writeonly
Set a new password
password_confirmation String writeonly
Confirm new password
active Boolean
Whether this employee is active (counts towards billing)
deactivated_at Datetime writeonly
Employee deactivation date
owner Boolean readonly
Whether this employee is the account owner
confirmed Boolean readonly
Wheter this employee confirmed it's email address
time_to_confirm Integer readonly
Time 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 writeonly
Base64 encoded avatar
remove_avatar Boolean writeonly
Remove current avatar
has_two_factor_autentication Boolean readonly
Wheter two factor authentication is enabled
avatar_url String readonly
Url to avatar
large_avatar_url String readonly
Url to avatar (Large)
third_party_id String readonly
ID 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": "3781cf53-7109-44c6-bcc4-fb059863c4d5",
      "type": "employees",
      "attributes": {
        "created_at": "2024-07-08T09:29:35.022792+00:00",
        "updated_at": "2024-07-08T09:29:35.029453+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

Fetching an employee

How to fetch a employee:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/employees/c2393606-8245-46cf-8e15-8527d30f6310' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "c2393606-8245-46cf-8e15-8527d30f6310",
    "type": "employees",
    "attributes": {
      "created_at": "2024-07-08T09:29:34.307551+00:00",
      "updated_at": "2024-07-08T09:29:34.307551+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

Updating an employee

How to update an employee:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/employees/2717b2ca-e00d-4629-bec5-ddfec3fbfa53' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "2717b2ca-e00d-4629-bec5-ddfec3fbfa53",
        "type": "employees",
        "attributes": {
          "firstname": "Jane"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "2717b2ca-e00d-4629-bec5-ddfec3fbfa53",
    "type": "employees",
    "attributes": {
      "created_at": "2024-07-08T09:29:29.202038+00:00",
      "updated_at": "2024-07-08T09:29:29.257657+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/e65767bc-ab13-4a10-b192-ad6f39a892b2' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "e65767bc-ab13-4a10-b192-ad6f39a892b2",
        "type": "employees",
        "attributes": {
          "active": false
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "e65767bc-ab13-4a10-b192-ad6f39a892b2",
    "type": "employees",
    "attributes": {
      "created_at": "2024-07-08T09:29:30.030810+00:00",
      "updated_at": "2024-07-08T09:29:30.086151+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/0656b687-18f7-47e5-b7d2-8530cf16ea74' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "0656b687-18f7-47e5-b7d2-8530cf16ea74",
        "type": "employees",
        "attributes": {
          "permissions": [
            "reports",
            "settings"
          ]
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "0656b687-18f7-47e5-b7d2-8530cf16ea74",
    "type": "employees",
    "attributes": {
      "created_at": "2024-07-08T09:29:32.767107+00:00",
      "updated_at": "2024-07-08T09:29:32.828389+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

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 readonly
Return data for all items on an order
location_id Uuid
The associated Location
location_available Integer readonly
The available quantity for the given location
location_stock_count Integer readonly
The quantity of stock present for the given the location
location_plannable Integer readonly
The number of products that can be planned for the given location
location_planned Integer readonly
The planned quantity for the given location
location_needed Integer readonly
The needed quantity for the given location. This quantity does not contain what has already been returned for an order (planned - stopped)
cluster_available Integer readonly
The available quantity for the cluster the given location is part of
cluster_stock_count Integer readonly
The stock count for the cluster the given location is part of
cluster_plannable Integer readonly
The planned quantity for the cluster the given location is part of
cluster_planned Integer readonly
The planned quantity for the cluster the given location is part of
cluster_needed Integer readonly
The 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 readonly
Associated Item
location Locations readonly
Associated 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=b91ee404-024a-415d-8632-6b71ee56031e&filter%5Btill%5D=2022-01-02+09%3A00%3A00' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "0e15d873-fbca-53d8-9001-0b35605afe4d",
      "type": "inventory_levels",
      "attributes": {
        "item_id": "b91ee404-024a-415d-8632-6b71ee56031e",
        "order_id": null,
        "location_id": "02662e7c-f1ea-43cf-8b95-98bb682eb458",
        "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": {}
    }
  ],
  "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 required
eq
till Datetime required
eq

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=801b35c3-a33f-40bb-8e0c-e18db5b5425a&filter%5Blocation_id%5D=3f1de849-2c75-4e1a-8aaf-5b7cd75db0d3&filter%5Btill%5D=2022-01-02+09%3A00%3A00' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "8c466f3a-e4ec-549b-b9e0-fe0d52033639",
      "type": "inventory_levels",
      "attributes": {
        "item_id": "801b35c3-a33f-40bb-8e0c-e18db5b5425a",
        "order_id": null,
        "location_id": "3f1de849-2c75-4e1a-8aaf-5b7cd75db0d3",
        "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": {}
    }
  ],
  "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 required
eq
till Datetime required
eq

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": "da88ab24-362d-4b7f-a4ce-2f6d2d707202"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "1c1c7030-0c45-59ac-a746-dc521c731964",
    "type": "invoice_finalizations",
    "attributes": {
      "document_id": "da88ab24-362d-4b7f-a4ce-2f6d2d707202"
    },
    "relationships": {}
  },
  "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 => order => documents

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 readonly
The associated Revised invoice
revision_invoice_id Uuid readonly
The associated Revision invoice

Relationships

Invoice revisions have the following relationships:

Name Description
order Orders
Associated Order
revised_invoice Documents readonly
Associated Revised invoice
revision_invoice Documents readonly
Associated 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": "777c64ba-855c-4cda-926b-16fb62709098"
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "c7394394-f7b9-5e13-90a9-8de3dd313681",
    "type": "invoice_revisions",
    "attributes": {
      "order_id": "777c64ba-855c-4cda-926b-16fb62709098",
      "revised_invoice_id": "b2b6d45b-5d82-44f5-aa35-e37fb4cf905a",
      "revision_invoice_id": "23f2e3c7-5c77-4e6b-8fa9-672607a3da6a"
    },
    "relationships": {}
  },
  "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:

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:

Relationships

For this resource relationships are described in the following resources:

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": "efcef050-6544-4e95-9397-b210567b6096",
      "type": "bundles",
      "attributes": {
        "created_at": "2024-07-08T09:23:22.416974+00:00",
        "updated_at": "2024-07-08T09:23:22.416974+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": {}
    },
    {
      "id": "dc85a2cb-fa54-47d5-98e2-0cacd1b260b8",
      "type": "product_groups",
      "attributes": {
        "created_at": "2024-07-08T09:23:22.537176+00:00",
        "updated_at": "2024-07-08T09:23:22.537176+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": "d1430cf6-a539-4fd3-ac57-ee8d2808c67e",
        "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": {}
    },
    {
      "id": "17caf78d-c201-42c7-9ea9-d87791f8937a",
      "type": "products",
      "attributes": {
        "created_at": "2024-07-08T09:23:22.544943+00:00",
        "updated_at": "2024-07-08T09:23:22.544943+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": "d1430cf6-a539-4fd3-ac57-ee8d2808c67e",
        "price_ruleset_id": null,
        "price_structure_id": null,
        "variation_values": [],
        "allow_shortage": true,
        "shortage_limit": 3,
        "product_group_id": "dc85a2cb-fa54-47d5-98e2-0cacd1b260b8"
      },
      "relationships": {}
    }
  ],
  "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, gt
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": "2c06b21e-fec1-4e0b-b4f1-8f3cb4d18ed8"
    },
    {
      "id": "5cbc2c23-75f9-4880-b19d-fae645105727"
    },
    {
      "id": "44eb34f2-f66d-4b33-a8cf-ff8f2ee9aa63"
    },
    {
      "id": "171d94ef-5452-4b94-9f5b-06b561f1f428"
    },
    {
      "id": "5458fd07-72c1-49b7-bcd5-132b4519edf6"
    }
  ]
}

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, gt
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/690c3b31-ff32-4961-b0b7-38974e615a7a' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "690c3b31-ff32-4961-b0b7-38974e615a7a",
    "type": "product_groups",
    "attributes": {
      "created_at": "2024-07-08T09:23:21.362082+00:00",
      "updated_at": "2024-07-08T09:23:21.362082+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": "fa5f35f2-5d7b-4819-82c5-97556f51bd67",
      "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": {}
  },
  "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:

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 readonly
Length of charge period before charge rules are applied
charge_length Integer
Length of charge period in seconds
original_charge_label String readonly
Label of charge period before charge rules are applied
charge_label String readonly
Label for the charge period
original_price_each_in_cents Integer readonly
Price per item before charge rules are applied
price_each_in_cents Integer readonly
Final price per item
price_rule_values Hash readonly
What price rules were applied
price_structure_id Uuid
The associated Price structure
price_ruleset_id Uuid
The associated Price ruleset
price_tile_id Uuid readonly
The associated Price tile

Relationships

Item prices have the following relationships:

Name Description
item Items readonly
Associated Item
price_structure Price structures readonly
Associated Price structure
price_ruleset Price rulesets readonly
Associated Price ruleset
price_tile Price tiles readonly
Associated 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=2daa0e94-51f5-48df-828d-b72ec9de13ae&filter%5Bitem_id%5D%5B%5D=6a030120-e76b-4abf-904a-3bb70883494a&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": "ded72fd3-d84b-44d7-bf16-fd5dab75cc8a",
      "type": "item_prices",
      "attributes": {
        "item_id": "2daa0e94-51f5-48df-828d-b72ec9de13ae",
        "from": "2030-01-01T12:00:00.000000+00:00",
        "till": "2030-01-14T12:00:00.000000+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": {
          "data": {
            "type": "products",
            "id": "2daa0e94-51f5-48df-828d-b72ec9de13ae"
          }
        }
      }
    },
    {
      "id": "92bb3ee3-6a2a-42ea-ad90-15ade0e06cc7",
      "type": "item_prices",
      "attributes": {
        "item_id": "6a030120-e76b-4abf-904a-3bb70883494a",
        "from": "2030-01-01T12:00:00.000000+00:00",
        "till": "2030-01-14T12:00:00.000000+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": {
          "data": {
            "type": "products",
            "id": "6a030120-e76b-4abf-904a-3bb70883494a"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "2daa0e94-51f5-48df-828d-b72ec9de13ae",
      "type": "products",
      "attributes": {
        "created_at": "2024-07-08T09:23:45.941096+00:00",
        "updated_at": "2024-07-08T09:23:45.941096+00:00",
        "archived": false,
        "archived_at": null,
        "type": "products",
        "name": "Product 1000012",
        "group_name": "Product 1000012",
        "slug": "product-1000012",
        "sku": "PRODUCT 1000014",
        "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": "fe8ba4a0-ead9-455b-8bb1-8dbb34dc0bbc"
      },
      "relationships": {}
    },
    {
      "id": "6a030120-e76b-4abf-904a-3bb70883494a",
      "type": "products",
      "attributes": {
        "created_at": "2024-07-08T09:23:46.413722+00:00",
        "updated_at": "2024-07-08T09:23:46.413722+00:00",
        "archived": false,
        "archived_at": null,
        "type": "products",
        "name": "Product 1000013",
        "group_name": "Product 1000013",
        "slug": "product-1000013",
        "sku": "PRODUCT 1000015",
        "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": "fe83bc19-c598-475b-a5be-9be177345414"
      },
      "relationships": {}
    }
  ],
  "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=f0998276-e46c-48f7-99bb-b0f836f6edac&include=item' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "dd52f2c1-ae78-496c-9539-7f30c0dcb89b",
      "type": "item_prices",
      "attributes": {
        "item_id": "f0998276-e46c-48f7-99bb-b0f836f6edac",
        "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": {
          "data": {
            "type": "products",
            "id": "f0998276-e46c-48f7-99bb-b0f836f6edac"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "f0998276-e46c-48f7-99bb-b0f836f6edac",
      "type": "products",
      "attributes": {
        "created_at": "2024-07-08T09:23:44.450645+00:00",
        "updated_at": "2024-07-08T09:23:44.450645+00:00",
        "archived": false,
        "archived_at": null,
        "type": "products",
        "name": "Product 1000010",
        "group_name": "Product 1000010",
        "slug": "product-1000010",
        "sku": "PRODUCT 1000012",
        "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": "a6ed89ad-2a96-4ae9-9e8b-b0e31566764e"
      },
      "relationships": {}
    }
  ],
  "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:

  1. Custom lines Lines created through the resource that don't have a planning associated with it. Can be of one of type charge, section.

  2. Planning lines Lines that have a planning associated with it, these lines can not be created through the Line resource but are created by submitting a book_* action to OrderFulfilments. Updating or destroying a line linked to a planning will also destroy the 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:

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

GET /api/boomerang/lines/{id}

POST /api/boomerang/lines

PUT /api/boomerang/lines/{id}

DELETE /api/boomerang/lines/{id}

Fields

Every line has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether line is archived
archived_at Datetime nullable readonly
When the line was archived
title String nullable
Title of the line
extra_information String nullable
Extra 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 readonly
The original price of the product (without price rule adjustments)
original_charge_length Integer readonly
The original charge length of the product (without price rule adjustments)
original_charge_label String nullable
The original charge label of the product (without price rule adjustments)
price_each_in_cents Integer
Price of each line
price_in_cents Integer readonly
Price of each line x quantity
display_price_in_cents Integer readonly
Price of this line to display based on the tax setting of the company (inclusive vs. exclusive)
position Integer nullable
Which position the line has
charge_label String nullable
Charge label
charge_length Integer nullable
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.
price_rule_values Hash nullable readonly
Breakdown 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 readonly
Whether line is relevant. If not, line has no visible change, it's only used for reporting
confirm_shortage Boolean writeonly
Whether to confirm a shortage when updating quantity on a line
order_id Uuid readonly
The associated Order
item_id Uuid nullable readonly
The associated Item
tax_category_id Uuid nullable
The associated Tax category
planning_id Uuid readonly
The associated Planning
price_structure_id Uuid
The associated Price structure
price_tile_id Uuid
The associated Price tile
parent_line_id Uuid readonly
The 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 readonly
Associated Order
item Items readonly
Associated Item
tax_category Tax categories readonly
Associated Tax category
planning Plannings readonly
Associated Planning
price_structure Price structures readonly
Associated Price structure
price_tile Price tiles readonly
Associated Price tile
parent_line Lines readonly
Associated Parent line
nested_lines Lines readonly
Associated Nested lines
owner Order
Associated Owner

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": "e549d45b-d2f8-428d-83c1-0af585906b11",
      "type": "lines",
      "attributes": {
        "created_at": "2024-07-08T09:28:35.774996+00:00",
        "updated_at": "2024-07-08T09:28:35.833280+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": "9bc797b3-baba-4a0e-b5bc-23dc7b67f535",
        "item_id": "f423d940-f658-4444-a03e-90036d9ae04a",
        "tax_category_id": "c44965ee-671a-4b43-a070-c77a2eb5574e",
        "planning_id": "06ca7d78-b233-449b-846c-fd33919c9435",
        "price_structure_id": null,
        "price_tile_id": null,
        "parent_line_id": null,
        "owner_id": "9bc797b3-baba-4a0e-b5bc-23dc7b67f535",
        "owner_type": "orders"
      },
      "relationships": {}
    }
  ],
  "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

Fetching a line

How to fetch a line:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/lines/116d393b-4f97-4c0f-b44f-5b767c462456' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "116d393b-4f97-4c0f-b44f-5b767c462456",
    "type": "lines",
    "attributes": {
      "created_at": "2024-07-08T09:28:24.835125+00:00",
      "updated_at": "2024-07-08T09:28:24.893958+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": "820b0729-becf-4c71-a26c-7cfad62c9165",
      "item_id": "83f1b5d8-2518-4505-aeca-2c85e42d3d3c",
      "tax_category_id": "357eae59-20e0-446a-b195-4968f25cc001",
      "planning_id": "29dc00fa-dca9-4b0c-879e-827a6bbf12b4",
      "price_structure_id": null,
      "price_tile_id": null,
      "parent_line_id": null,
      "owner_id": "820b0729-becf-4c71-a26c-7cfad62c9165",
      "owner_type": "orders"
    },
    "relationships": {}
  },
  "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

Creating a line

Lines created through this endpoint, so-called custom lines, can only have the type charge or section. Custom charge lines enable you to add charges not (directly) connected to a product to an order. Sections allow to add some organization to orders.

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": "8cbdf527-bf9c-4df1-b9ce-43b2298655d9",
          "owner_type": "orders",
          "price_each_in_cents": 1000
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "b18a8c21-89b8-4adb-ad7e-ca096f7cffe4",
    "type": "lines",
    "attributes": {
      "created_at": "2024-07-08T09:28:33.401351+00:00",
      "updated_at": "2024-07-08T09:28:33.416897+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": "8cbdf527-bf9c-4df1-b9ce-43b2298655d9",
      "item_id": null,
      "tax_category_id": null,
      "planning_id": null,
      "price_structure_id": null,
      "price_tile_id": null,
      "parent_line_id": null,
      "owner_id": "8cbdf527-bf9c-4df1-b9ce-43b2298655d9",
      "owner_type": "orders"
    },
    "relationships": {}
  },
  "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

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/b532e0d1-622a-431b-8193-4281e8934661' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "b532e0d1-622a-431b-8193-4281e8934661",
        "type": "lines",
        "attributes": {
          "price_each_in_cents": 1000
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "b532e0d1-622a-431b-8193-4281e8934661",
    "type": "lines",
    "attributes": {
      "created_at": "2024-07-08T09:28:39.222369+00:00",
      "updated_at": "2024-07-08T09:28:40.590288+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": "670444d2-042d-41ba-a87c-2fbfeb61e6c1",
      "item_id": "393c01ac-b6a4-4733-a866-39ddef96224b",
      "tax_category_id": "312c951b-091c-47c3-ba35-8ae3afbb2c10",
      "planning_id": "6e935583-4a69-46df-8325-c06717f5098c",
      "price_structure_id": null,
      "price_tile_id": null,
      "parent_line_id": null,
      "owner_id": "670444d2-042d-41ba-a87c-2fbfeb61e6c1",
      "owner_type": "orders"
    },
    "relationships": {}
  },
  "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

Archiving a line

How to delete a line:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/lines/2bac84a6-52c3-41f9-afa8-04cc4fd10e82' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "2bac84a6-52c3-41f9-afa8-04cc4fd10e82",
    "type": "lines",
    "attributes": {
      "created_at": "2024-07-08T09:28:28.274294+00:00",
      "updated_at": "2024-07-08T09:28:29.593044+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:28:29.593044+00:00",
      "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": "2ec26e02-ab98-402a-8763-949237f2b143",
      "item_id": "8fe7c159-81d0-442c-9e83-2cfce30bf627",
      "tax_category_id": "3bf01d57-ea79-489b-87b5-60381d558bd5",
      "planning_id": "604ae268-2f8d-467e-940e-5acb7690df58",
      "price_structure_id": null,
      "price_tile_id": null,
      "parent_line_id": null,
      "owner_id": "2ec26e02-ab98-402a-8763-949237f2b143",
      "owner_type": "orders"
    },
    "relationships": {}
  },
  "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

Locations

A location is a place (like a store) where customers pick up and return orders or a warehouse that only stocks inventory.

Endpoints

GET /api/boomerang/locations

GET /api/boomerang/locations/{id}

POST /api/boomerang/locations

PUT /api/boomerang/locations/{id}

DELETE /api/boomerang/locations/{id}

Fields

Every location has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
archived Boolean readonly
Whether location is archived
archived_at Datetime nullable readonly
When 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 writeonly
A hash with the address fields. Use it when creating or updating a location. See address property type for more information
carrier_ids Array
Delivery carriers this location supports
pickup_enabled Boolean
Whether the location supports pickup
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 readonly
Associated Clusters
carriers Carriers readonly
Associated Carriers

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": "e9d5099a-0866-4065-a3c3-20b87aa16b22",
      "type": "locations",
      "attributes": {
        "created_at": "2024-07-08T09:26:42.053606+00:00",
        "updated_at": "2024-07-08T09:26:42.060451+00:00",
        "archived": false,
        "archived_at": null,
        "name": "Warehouse",
        "code": "LOC1000043",
        "location_type": "rental",
        "address_line_1": "Blokhuisplein 40",
        "address_line_2": "Department II",
        "zipcode": "8911LJ",
        "city": "Leeuwarden",
        "region": "Friesland",
        "country": "Netherlands",
        "cluster_ids": [],
        "carrier_ids": [],
        "pickup_enabled": true,
        "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,
          "latitude": null,
          "longitude": null,
          "value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
        }
      },
      "relationships": {}
    }
  ],
  "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=main_address,clusters,carriers
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:

main_address

clusters

carriers

Fetching a location

How to fetch a single location:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/locations/b5abec37-4e5c-484d-832c-ffed937ae630' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "b5abec37-4e5c-484d-832c-ffed937ae630",
    "type": "locations",
    "attributes": {
      "created_at": "2024-07-08T09:26:37.896697+00:00",
      "updated_at": "2024-07-08T09:26:37.902892+00:00",
      "archived": false,
      "archived_at": null,
      "name": "Warehouse",
      "code": "LOC1000037",
      "location_type": "rental",
      "address_line_1": "Blokhuisplein 40",
      "address_line_2": "Department II",
      "zipcode": "8911LJ",
      "city": "Leeuwarden",
      "region": "Friesland",
      "country": "Netherlands",
      "cluster_ids": [],
      "carrier_ids": [],
      "pickup_enabled": true,
      "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,
        "latitude": null,
        "longitude": null,
        "value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
      }
    },
    "relationships": {}
  },
  "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=main_address,clusters,carriers
fields[] Array
List of comma seperated fields to include ?fields[locations]=created_at,updated_at,archived

Includes

This request accepts the following includes:

main_address

clusters

carriers

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": [
            "3835b628-23b2-46f8-b570-df6fdbddcb0f"
          ],
          "carrier_ids": [
            "342687ff-be2d-4578-8d8e-6697b7d1cdbe"
          ]
        }
      },
      "include": "clusters,carriers"
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "b2e37575-711c-443d-ba9b-39d8630bcbb5",
    "type": "locations",
    "attributes": {
      "created_at": "2024-07-08T09:26:38.684292+00:00",
      "updated_at": "2024-07-08T09:26:38.701700+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": [
        "3835b628-23b2-46f8-b570-df6fdbddcb0f"
      ],
      "carrier_ids": [
        "342687ff-be2d-4578-8d8e-6697b7d1cdbe"
      ],
      "pickup_enabled": true,
      "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,
        "latitude": null,
        "longitude": null,
        "value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
      }
    },
    "relationships": {
      "clusters": {
        "data": [
          {
            "type": "clusters",
            "id": "3835b628-23b2-46f8-b570-df6fdbddcb0f"
          }
        ]
      },
      "carriers": {
        "data": [
          {
            "type": "carriers",
            "id": "342687ff-be2d-4578-8d8e-6697b7d1cdbe"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "3835b628-23b2-46f8-b570-df6fdbddcb0f",
      "type": "clusters",
      "attributes": {
        "created_at": "2024-07-08T09:26:38.487750+00:00",
        "updated_at": "2024-07-08T09:26:38.487750+00:00",
        "name": "North",
        "location_ids": [
          "b2e37575-711c-443d-ba9b-39d8630bcbb5"
        ]
      },
      "relationships": {}
    },
    {
      "id": "342687ff-be2d-4578-8d8e-6697b7d1cdbe",
      "type": "carriers",
      "attributes": {
        "created_at": "2024-07-08T09:26:38.600870+00:00",
        "updated_at": "2024-07-08T09:26:38.600870+00:00",
        "identifier": "FedEx",
        "rates_url": "https://www.example.com",
        "tax_category_id": "a79c71e4-6671-46e2-b2fa-b361135d7c23",
        "app_subscription_id": "e7fdeaaa-7778-4b97-bc5f-f2f39c3a1e41"
      },
      "relationships": {}
    }
  ],
  "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=main_address,clusters,carriers
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][carrier_ids][] Array
Delivery carriers this location supports
data[attributes][pickup_enabled] Boolean
Whether the location supports pickup
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:

main_address

clusters

carriers

Updating a location

Note that disassociating clusters may result in a shortage error.

How to update a location and assign it to multiple clusters:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/locations/6cbf3d5d-2b50-4099-bfce-0bd8bbe0cd45' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "6cbf3d5d-2b50-4099-bfce-0bd8bbe0cd45",
        "type": "locations",
        "attributes": {
          "name": "Old warehouse",
          "cluster_ids": [
            "780187b4-4964-44ef-95b0-5181a55eb04a",
            "694f6a9e-f880-4f9f-9de0-71ead6771651"
          ],
          "carrier_ids": [
            "96f1570e-ea9f-4589-a76b-858c0cb319ef"
          ]
        }
      },
      "include": "clusters,carriers"
    }'

A 200 status response looks like this:

  {
  "data": {
    "id": "6cbf3d5d-2b50-4099-bfce-0bd8bbe0cd45",
    "type": "locations",
    "attributes": {
      "created_at": "2024-07-08T09:26:42.674595+00:00",
      "updated_at": "2024-07-08T09:26:42.960445+00:00",
      "archived": false,
      "archived_at": null,
      "name": "Old warehouse",
      "code": "LOC1000044",
      "location_type": "rental",
      "address_line_1": "Blokhuisplein 40",
      "address_line_2": "Department II",
      "zipcode": "8911LJ",
      "city": "Leeuwarden",
      "region": "Friesland",
      "country": "Netherlands",
      "cluster_ids": [
        "780187b4-4964-44ef-95b0-5181a55eb04a",
        "694f6a9e-f880-4f9f-9de0-71ead6771651"
      ],
      "carrier_ids": [
        "96f1570e-ea9f-4589-a76b-858c0cb319ef"
      ],
      "pickup_enabled": true,
      "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,
        "latitude": null,
        "longitude": null,
        "value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
      }
    },
    "relationships": {
      "clusters": {
        "data": [
          {
            "type": "clusters",
            "id": "780187b4-4964-44ef-95b0-5181a55eb04a"
          },
          {
            "type": "clusters",
            "id": "694f6a9e-f880-4f9f-9de0-71ead6771651"
          }
        ]
      },
      "carriers": {
        "data": [
          {
            "type": "carriers",
            "id": "96f1570e-ea9f-4589-a76b-858c0cb319ef"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "780187b4-4964-44ef-95b0-5181a55eb04a",
      "type": "clusters",
      "attributes": {
        "created_at": "2024-07-08T09:26:42.691245+00:00",
        "updated_at": "2024-07-08T09:26:42.691245+00:00",
        "name": "North",
        "location_ids": [
          "6cbf3d5d-2b50-4099-bfce-0bd8bbe0cd45"
        ]
      },
      "relationships": {}
    },
    {
      "id": "694f6a9e-f880-4f9f-9de0-71ead6771651",
      "type": "clusters",
      "attributes": {
        "created_at": "2024-07-08T09:26:42.702137+00:00",
        "updated_at": "2024-07-08T09:26:42.702137+00:00",
        "name": "Central",
        "location_ids": [
          "6cbf3d5d-2b50-4099-bfce-0bd8bbe0cd45"
        ]
      },
      "relationships": {}
    },
    {
      "id": "96f1570e-ea9f-4589-a76b-858c0cb319ef",
      "type": "carriers",
      "attributes": {
        "created_at": "2024-07-08T09:26:42.793327+00:00",
        "updated_at": "2024-07-08T09:26:42.793327+00:00",
        "identifier": "FedEx",
        "rates_url": "https://www.example.com",
        "tax_category_id": "2b1043a8-c02a-429f-a678-99178a31d9d3",
        "app_subscription_id": "304186bf-d261-495d-97cb-d3dd115d725f"
      },
      "relationships": {}
    }
  ],
  "meta": {}
}

Disassociating cluster resulting in shortage error:

  curl --request PUT \
    --url 'https://example.booqable.com/api/boomerang/locations/6945fe8e-0482-4f0b-af22-f8a6d51087c7' \
    --header 'content-type: application/json' \
    --data '{
      "data": {
        "id": "6945fe8e-0482-4f0b-af22-f8a6d51087c7",
        "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": "b701633e-9ec2-4a6f-95b6-1753d898c200",
            "mutation": 0,
            "order_ids": [
              "e809a716-2d12-41c3-93b4-61694c4b3438"
            ],
            "location_id": "6945fe8e-0482-4f0b-af22-f8a6d51087c7",
            "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
          }
        ]
      }
    }
  ]
}

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=main_address,clusters,carriers
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][carrier_ids][] Array
Delivery carriers this location supports
data[attributes][pickup_enabled] Boolean
Whether the location supports pickup
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:

main_address

clusters

carriers

Archiving a location

To archive a location make sure that:

How to archive a location:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/locations/6c5aae0b-19b3-4d33-9ce8-0cd45a363c0a' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "6c5aae0b-19b3-4d33-9ce8-0cd45a363c0a",
    "type": "locations",
    "attributes": {
      "created_at": "2024-07-08T09:26:41.272809+00:00",
      "updated_at": "2024-07-08T09:26:41.333092+00:00",
      "archived": true,
      "archived_at": "2024-07-08T09:26:41.333092+00:00",
      "name": "Warehouse",
      "code": "LOC1000041",
      "location_type": "rental",
      "address_line_1": "Blokhuisplein 40",
      "address_line_2": "Department II",
      "zipcode": "8911LJ",
      "city": "Leeuwarden",
      "region": "Friesland",
      "country": "Netherlands",
      "cluster_ids": [],
      "carrier_ids": [],
      "pickup_enabled": true,
      "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,
        "latitude": null,
        "longitude": null,
        "value": "Blokhuisplein 40\nDepartment II\n8911LJ Leeuwarden Friesland\nNetherlands"
      }
    },
    "relationships": {}
  },
  "meta": {}
}

Failure due to a future order:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/locations/5dd351cc-cc88-4e21-b881-41f7c48bd636' \
    --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": [
          "f26172e0-ff32-4c10-95a4-9d45bc197f94"
        ]
      }
    }
  ]
}

Failure due to active stock at location:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/locations/c1666c17-363b-463c-bcaf-88fef6b463d2' \
    --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": [
          "92df131e-e04e-43a9-b93c-c4f658330cbd"
        ]
      }
    }
  ]
}

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

Notes

Allows you to leave notes attached to other resources.

Endpoints

GET /api/boomerang/notes

GET /api/boomerang/notes/{id}

POST /api/boomerang/notes

DELETE /api/boomerang/notes/{id}

Fields

Every note has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When 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 readonly
The associated Employee

Relationships

Notes have the following relationships:

Name Description
owner Customer, Product, Product group, Stock item, Bundle, Order, Document
Associated Owner
employee Employees readonly
Associated Employee

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": "352014c7-119b-4a13-ba6c-50331e9528fc",
      "type": "notes",
      "attributes": {
        "created_at": "2024-07-08T09:30:18.879824+00:00",
        "updated_at": "2024-07-08T09:30:18.879824+00:00",
        "body": "Agreed to give this customer a 20% discount on the next order",
        "owner_id": "42b56ee6-df82-4dcb-a8d6-b88199e8f7b6",
        "owner_type": "customers",
        "employee_id": "48c269ab-bff3-4cf1-b3ff-4573f2dbcfdf"
      },
      "relationships": {}
    }
  ],
  "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/7cb3d1cc-8aa7-4402-91b0-d1ffa273a1e0' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "7cb3d1cc-8aa7-4402-91b0-d1ffa273a1e0",
    "type": "notes",
    "attributes": {
      "created_at": "2024-07-08T09:30:19.597916+00:00",
      "updated_at": "2024-07-08T09:30:19.597916+00:00",
      "body": "Agreed to give this customer a 20% discount on the next order",
      "owner_id": "fdd532ae-61c6-4e70-8d3a-23afed1acf35",
      "owner_type": "customers",
      "employee_id": "80600a6e-497b-4fd5-b53a-af91881a3eff"
    },
    "relationships": {}
  },
  "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

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": "a3897569-9bb8-4d75-9950-c8b11e6f9723",
          "owner_type": "customers"
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "e2000848-c7c5-4240-a20c-b87257f1e935",
    "type": "notes",
    "attributes": {
      "created_at": "2024-07-08T09:30:20.975437+00:00",
      "updated_at": "2024-07-08T09:30:20.975437+00:00",
      "body": "Agreed to give this customer a 20% discount on the next order",
      "owner_id": "a3897569-9bb8-4d75-9950-c8b11e6f9723",
      "owner_type": "customers",
      "employee_id": "26b1d02c-c815-4abe-a5e1-73d88096211f"
    },
    "relationships": {}
  },
  "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

Deleting a note

How to delete a note:

  curl --request DELETE \
    --url 'https://example.booqable.com/api/boomerang/notes/621d3fe7-3a23-42a0-a3e3-6ba5bf1ef561' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "621d3fe7-3a23-42a0-a3e3-6ba5bf1ef561",
    "type": "notes",
    "attributes": {
      "created_at": "2024-07-08T09:30:20.262771+00:00",
      "updated_at": "2024-07-08T09:30:20.262771+00:00",
      "body": "Agreed to give this customer a 20% discount on the next order",
      "owner_id": "d1f7f865-2d58-4ebc-9a9c-ee75ca62250f",
      "owner_type": "customers",
      "employee_id": "daefbbbc-3e76-4312-b153-7e1f1d7cb645"
    },
    "relationships": {}
  },
  "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:

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

Customer

Artifacts

No artifacts are generated when bullk updating resources.

Endpoints

GET /api/boomerang/operations

GET /api/boomerang/operations/{id}

POST /api/boomerang/operations

Fields

Every operation has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
status String readonly
One of scheduled, in_progress, finished, failed
status_message String readonly
A UI-friendly string explaining the status & progress of the operation for the user.
finished_at Datetime readonly
The moment when the operation is finished executing.
description String readonly
Explains what the operation is doing in a short sentence.
artifact Hash readonly
An object that returns an optional artifact of the operation. E.g. a file if the operation generates a report.
error_data Array readonly
An array of strings with errors that happened during execution of the operation.
error_count Integer readonly
The number of errors that happened during the execution. See error_data.
employee_id Uuid readonly
The 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 readonly
Associated 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": "94eda9f1-fc38-4e15-acae-824cbde8dbf0",
      "type": "operations",
      "attributes": {
        "created_at": "2024-07-08T09:30:57.930591+00:00",
        "updated_at": "2024-07-08T09:30:57.930591+00:00",
        "status": "scheduled",
        "status_message": null,
        "finished_at": null,
        "description": null,
        "artifact": {
          "url": null
        },
        "error_data": [],
        "error_count": 0,
        "employee_id": "20bb6eb4-b13f-474b-82be-b2017d11613e"
      },
      "relationships": {}
    }
  ],
  "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

Fetching an operation

How to fetch an operation:

  curl --request GET \
    --url 'https://example.booqable.com/api/boomerang/operations/19e8c4da-3f7c-4231-bded-76839e561d0a' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "19e8c4da-3f7c-4231-bded-76839e561d0a",
    "type": "operations",
    "attributes": {
      "created_at": "2024-07-08T09:30:58.654126+00:00",
      "updated_at": "2024-07-08T09:30:58.654126+00:00",
      "status": "scheduled",
      "status_message": null,
      "finished_at": null,
      "description": null,
      "artifact": {
        "url": null
      },
      "error_data": [],
      "error_count": 0,
      "employee_id": "e2620bd5-f027-43c0-92d1-574f7649d00b"
    },
    "relationships": {}
  },
  "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

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": "7e9e9151-8eb0-4b2b-8b03-284d7a408145",
    "type": "operations",
    "attributes": {
      "created_at": "2024-07-08T09:30:57.136199+00:00",
      "updated_at": "2024-07-08T09:30:57.136199+00:00",
      "status": "scheduled",
      "status_message": null,
      "finished_at": null,
      "description": "Archiving customers",
      "artifact": {
        "url": null
      },
      "error_data": [],
      "error_count": 0,
      "employee_id": "0081ae8a-337f-42d3-bff2-e167267b60f2"
    },
    "relationships": {}
  },
  "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

Orders

Orders are the heart of every rental operation. They hold configuration and information about:

An order can have multiple of the following statuses:

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:

Changing one of the following values can lead to shortages:

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

GET api/boomerang/orders

POST api/boomerang/orders/search

GET api/boomerang/orders/new

GET api/boomerang/orders/{id}

POST /api/boomerang/orders

PUT api/boomerang/orders/{id}

Fields

Every order has the following fields:

Name Description
id Uuid readonly
Primary key
created_at Datetime readonly
When the resource was created
updated_at Datetime readonly
When the resource was last updated
number Integer readonly
The unique order number
status String readonly
One of new, concept, reserved, started, stopped, archived, canceled
statuses Array readonly
Status(es) of planned products
status_counts Hash readonly
An object containing the status counts of planned products { "concept": 0, "reserved": 2, "started": 5, "stopped": 10 }
starts_at Datetime nullable
When the items on the order become unavailable
stops_at Datetime nullable
When the items on the order become available again
deposit_type String nullable
One of none, percentage_total, percentage, fixed
deposit_value Float
The value to use for deposit_type
entirely_started Boolean readonly
Whether all items on the order are started
entirely_stopped Boolean readonly
Whether all items on the order are stopped
location_shortage Boolean readonly
Whether there is a shortage on the pickup location
shortage Boolean readonly
Whether there is a shortage for this order
payment_status String readonly
One 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 writeonly
Confirm shortage on update
has_signed_contract Boolean readonly
Whether the order has a signed contract
tag_list Array
Case insensitive tag list
properties Hash readonly
A hash containing all basic property values (include properties if you need more detailed information about properties)
price_in_cents Integer readonly
Subtotal excl. taxes (excl. deposit)
grand_total_in_cents Integer readonly
Total excl. taxes (excl. deposit)
grand_total_with_tax_in_cents Integer readonly
Amount incl. taxes (excl. deposit)
tax_in_cents Integer readonly
Total tax
discount_in_cents Integer readonly
Discount (incl. or excl. taxes based on tax_strategy)
coupon_discount_in_cents Integer readonly
Coupon discount (incl. or excl. taxes based on tax_strategy
total_discount_in_cents Integer readonly
Total discount (incl. or excl. taxes based on tax_strategy
deposit_in_cents Integer readonly
Deposit
deposit_paid_in_cents Integer readonly
How much of the deposit is paid
deposit_refunded_in_cents Integer readonly
How much of the deposit is refunded
deposit_held_in_cents Integer readonly
Amount of deposit held
deposit_to_refund_in_cents Integer readonly
Amount of deposit (still) to be refunded
to_be_paid_in_cents Integer readonly
Amount that (still) has to be paid
paid_in_cents Integer readonly
How much was paid
discount_value Float writeonly
The value to use for discount_type
discount_type String
One of percentage, fixed
discount_percentage Float readonly
The discount percentage applied to this order. May update if order amount changes and type is fixed
customer_id Uuid nullable
The associated Customer
tax_region_id Uuid nullable
The associated Tax region
coupon_id Uuid nullable
The 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 readonly
Associated Properties
start_location Locations readonly
The 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.

documents | Documents readonly
Associated Documents 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

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": "07721226-88ee-4e81-a668-f892a109008f",
      "type": "orders",
      "attributes": {
        "created_at": "2024-07-08T09:24:31.960708+00:00",
        "updated_at": "2024-07-08T09:24:34.489413+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.000000+00:00",
        "stops_at": "1980-05-01T12:00:00.000000+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": "a8b1d74d-4d53-4c7e-9b3a-be656c846492",
        "tax_region_id": null,
        "coupon_id": null,
        "start_location_id": "16e4fee5-3106-44b4-a65c-729afe099a41",
        "stop_location_id": "16e4fee5-3106-44b4-a65c-729afe099a41"
      },
      "relationships": {}
    }
  ],
  "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, gt
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
start_or_stop_time Datetime
eq, not_eq, gt, gte, lt, lte, between
any_shortage Boolean
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

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-07-09T09:24:59Z",
                    "lte": "2024-07-12T09:24:59Z"
                  }
                },
                {
                  "stops_at": {
                    "gte": "2024-07-09T09:24:59Z",
                    "lte": "2024-07-12T09:24:59Z"
                  }
                }
              ]
            },
            {
              "operator": "and",
              "attributes": [
                {
                  "deposit_type": "none"
                },
                {
                  "payment_status": "paid"
                }
              ]
            }
          ]
        }
      }
    }'

A 200 status response looks like this:

  {
  "data": [
    {
      "id": "a92e4012-80ab-491e-9a7f-e6756a741b30"
    },
    {
      "id": "c412967c-74cd-47c2-8cb5-bfeb69aa6690"
    }
  ]
}

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, gt
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
start_or_stop_time Datetime
eq, not_eq, gt, gte, lt, lte, between
any_shortage Boolean
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": "7bac33b1-2ec2-4d6d-99b0-a35dbe789494",
    "type": "orders",
    "attributes": {
      "created_at": "2024-07-08T09:24:51.454065+00:00",
      "updated_at": "2024-07-08T09:24:51.479973+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": "e188a014-3c8e-4da8-8611-3e82d38d5142",
      "stop_location_id": "e188a014-3c8e-4da8-8611-3e82d38d5142"
    },
    "relationships": {}
  },
  "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 => item => photo

planning => stock_item_plannings => stock_item

tax_category

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/c0356cb6-0386-4cc9-bf33-141f931af7d5' \
    --header 'content-type: application/json' \

A 200 status response looks like this:

  {
  "data": {
    "id": "c0356cb6-0386-4cc9-bf33-141f931af7d5",
    "type": "orders",
    "attributes": {
      "created_at": "2024-07-08T09:24:52.249390+00:00",
      "updated_at": "2024-07-08T09:24:54.431649+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.000000+00:00",
      "stops_at": "1980-05-01T12:00:00.000000+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": "b5628576-b741-4a98-b79d-efa9710c253f",
      "tax_region_id": null,
      "coupon_id": null,
      "start_location_id": "5f87dac3-839e-4fbc-a3fa-75ce976681d3",
      "stop_location_id": "5f87dac3-839e-4fbc-a3fa-75ce976681d3"
    },
    "relationships": {}
  },
  "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 => item => photo

planning => stock_item_plannings => stock_item

tax_category

properties

start_location

stop_location

tax_region

tax_values

transfers

Creating an order

When creating an order, and the following fields are left blank, a sensible default will be picked:

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-07-11T09:25:03.083Z",
          "stops_at": "2024-08-19T09:25:03.083Z"
        }
      }
    }'

A 201 status response looks like this:

  {
  "data": {
    "id": "79be56e5-3944-4bec-a4bc-eabd3071f86b",
    "type": "orders",
    "attributes": {
      "created_at": "2024-07-08T09:25:03.138390+00:00",
      "updated_at": "2024-07-08T09:25:03.173069+00:00",
      "number": null,
      "status": "new",
      "statuses": [
        "new"
      ],
      "status_counts": {
        "new": 0,
        "concept": 0,
        "reserved": 0,
        "started": 0,
        "stopped": 0
      },
      "starts_at": "2024-07-11T09:15:00.000000+00:00",
      "stops_at": "2024-08-19T09:15:00.000000+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