API docs by Redocly

Webshop API (v2) (4.32.0)

Download OpenAPI specification:

E-mail: info@organi.be

INFO

  • Using the download button at the top you can import this collection of endpoints in Postman

AUTHENTICATION

Pass your token via an Authorization header like this: Authorization: Bearer {token}.

OAuth2

This API uses OAuth 2 with the 'password' grant flow.

Security Scheme Type: OAuth2
Flow type: password
Token URL: /token
Refresh URL: /token

abandoned-carts

abandoned-carts

/abandoned-carts

Get all abandoned-carts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "user" "user_customer" "customer_representative"
Example: include=units

Relations to include

append
string
Enum: "item_count" "total_price_after_taxes" "transport_costs" "total_price"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=a98a7274-f810-42e3-9153-ffa1fae59f3d

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

alerts

alerts

/alerts

Get all alerts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "link" "text" "hosts" "collections" "pages"
Example: include=units

Relations to include

append
string
Value: "type_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=ffedaf2a-ac4f-4f5f-b37f-fc98afe96e52

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/alerts

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "link" "text" "hosts" "collections" "pages"
Example: include=units

Relations to include

append
string
Value: "type_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/alerts/{alert-uuid}

Get a single item

path Parameters
alert-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "link" "text" "hosts" "collections" "pages"
Example: include=units

Relations to include

append
string
Value: "type_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/alerts/{alert-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
alert-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "link" "text" "hosts" "collections" "pages"
Example: include=units

Relations to include

append
string
Value: "type_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/alerts/{alert-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
alert-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

base-prices

base-prices

/base-prices

Get all base-prices

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "product"
Example: include=units

Relations to include

object
Example: uuid=06396a18-cdd4-4178-96c1-063b39949bc2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/base-prices

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "product"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/base-prices/{base-price-uuid}

Get a single item

path Parameters
base-price-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/base-prices/{base-price-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
base-price-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/base-prices/{base-price-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
base-price-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

brands

brands

/brands

Get all brands

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "link" "media" "pages"
Example: include=units

Relations to include

object
Example: uuid=46b5d2cf-b81e-4068-b663-40e60b4fe77f

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/brands

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "link" "media" "pages"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/brands/{brand-uuid}

Get a single item

path Parameters
brand-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "link" "media" "pages"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/brands/{brand-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
brand-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "link" "media" "pages"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/brands/{brand-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
brand-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

business-contexts

business-contexts

/business-contexts

Get all business-contexts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=a5ab7160-f65d-4192-ba9b-19497ced2f8d

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/business-contexts

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/business-contexts/{business-context-uuid}

Get a single item

path Parameters
business-context-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/business-contexts/{business-context-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
business-context-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/business-contexts/{business-context-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
business-context-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

callbacks

callbacks

/callbacks

Get all callbacks

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=0f7305e2-04f4-41bd-9ba7-bc46bee7a63e

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/callbacks

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/callbacks/{callback-uuid}

Get a single item

path Parameters
callback-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/callbacks/{callback-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
callback-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/callbacks/{callback-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
callback-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

carts

carts

/carts

Get all carts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "items"
Example: include=units

Relations to include

append
string
Enum: "item_count" "total_price_after_taxes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=f78f01d1-1605-4704-abd0-537662d856c6

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/carts/{cart-uuid}

Get a single item

path Parameters
cart-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "items"
Example: include=units

Relations to include

append
string
Enum: "item_count" "total_price_after_taxes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/carts/{cart-uuid}/items

Get all carts.items

path Parameters
cart-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "items"
Example: include=units

Relations to include

append
string
Enum: "item_count" "total_price_after_taxes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=0b61e4c1-94e0-4d35-8933-74216ccbc7da

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/carts/{cart-uuid}/items/{item-uuid}

Get a single item

path Parameters
cart-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
item-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "items"
Example: include=units

Relations to include

append
string
Enum: "item_count" "total_price_after_taxes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

catalogs

catalogs

/catalogs

Get all catalogs

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=bc106211-5b68-436b-8cea-11f247acc902

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/catalogs

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/catalogs/{catalog-uuid}

Get a single item

path Parameters
catalog-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/catalogs/{catalog-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
catalog-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/catalogs/{catalog-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
catalog-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

collections

collections

/collections

Get all collections

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "media" "parent" "children" "redirect" "catalogues" "pages"
Example: include=units

Relations to include

append
string
Value: "href"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=247dcd9f-c2c5-43e9-9379-f62e9e220435&code=impedit&catalog_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/collections

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "media" "parent" "children" "redirect" "catalogues" "pages"
Example: include=units

Relations to include

append
string
Value: "href"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/collections/{collection-uuid}

Get a single item

path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "media" "parent" "children" "redirect" "catalogues" "pages"
Example: include=units

Relations to include

append
string
Value: "href"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/collections/{collection-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "media" "parent" "children" "redirect" "catalogues" "pages"
Example: include=units

Relations to include

append
string
Value: "href"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/collections/{collection-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

/collections/{collection-uuid}/children

Get all collections.children

path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=b5883223-7fec-4af8-9e53-ed3383afe10b&code=rerum&catalog_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/collections/{collection-uuid}/parent

Get all collections.parent

path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=b4864f52-f2f6-4fa3-bfe0-b62938af668f&code=veniam&catalog_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/collections/{collection-uuid}/products

Get all collections.products

path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=7ae2fdd9-255a-41c8-961e-dd3fe5328760&code=rerum&catalog_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/collections/{collection-uuid}/products/{product-uuid}

Get a single item

path Parameters
collection-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

component-types

component-types

/component-types

Get all component-types

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example:

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/component-types

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/component-types/{component-type-uuid}

Get a single item

path Parameters
component-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/component-types/{component-type-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
component-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/component-types/{component-type-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
component-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

countries

countries

/countries

Get all countries

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=661ffe64-9614-40bb-9238-98330632e569

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/countries

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/countries/{country-uuid}

Get a single item

path Parameters
country-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/countries/{country-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
country-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/countries/{country-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
country-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

delivery-type-rules

delivery-type-rules

/delivery-type-rules

Get all delivery-type-rules

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "delivery_type" "postal_codes" "quantity_discounts"
Example: include=units

Relations to include

object
Example: uuid=66b068e2-a794-41b7-b521-a8a077d66fce

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/delivery-type-rules

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "delivery_type" "postal_codes" "quantity_discounts"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-type-rules/{delivery-type-rule-uuid}

Get a single item

path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "delivery_type" "postal_codes" "quantity_discounts"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-type-rules/{delivery-type-rule-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "delivery_type" "postal_codes" "quantity_discounts"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-type-rules/{delivery-type-rule-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

/delivery-type-rules/{delivery-type-rule-uuid}/relationships/postal-codes

Get all objects in the relation

path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/delivery-type-rules/{delivery-type-rule-uuid}/relationships/postal-codes

Add an item to the relation

Authorizations:
OAuth2
path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/delivery-type-rules/{delivery-type-rule-uuid}/relationships/postal-codes

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/delivery-type-rules/{delivery-type-rule-uuid}/relationships/postal-codes

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
delivery-type-rule-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

delivery-types

delivery-types

/delivery-types

Get all delivery-types

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

append
string
Value: "is-pickup"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=8779380a-206a-4e3f-92a8-9dd2bb42bd9c

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/delivery-types

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
append
string
Value: "is-pickup"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-types/{delivery-type-uuid}

Get a single item

path Parameters
delivery-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Value: "is-pickup"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-types/{delivery-type-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
delivery-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Value: "is-pickup"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/delivery-types/{delivery-type-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
delivery-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

eyecatchers

eyecatchers

/eyecatchers

Get all eyecatchers

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "media"
Example: include=units

Relations to include

object
Example: uuid=ea349671-fc7d-435b-9c95-609de5dc4d20

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/eyecatchers

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "media"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/eyecatchers/{eyecatcher-uuid}

Get a single item

path Parameters
eyecatcher-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/eyecatchers/{eyecatcher-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
eyecatcher-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/eyecatchers/{eyecatcher-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
eyecatcher-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

filter-presets

filter-presets

/filter-presets

Get all filter-presets

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "meta_data_1" "meta_data_2" "brand" "page" "publication"
Example: include=units

Relations to include

object
Example: uuid=ccc6787f-39a3-4998-b3f3-8d21053d1b9d

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/filter-presets

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "meta_data_1" "meta_data_2" "brand" "page" "publication"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/filter-presets/{filter-preset-uuid}

Get a single item

path Parameters
filter-preset-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "meta_data_1" "meta_data_2" "brand" "page" "publication"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/filter-presets/{filter-preset-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
filter-preset-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "meta_data_1" "meta_data_2" "brand" "page" "publication"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/filter-presets/{filter-preset-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
filter-preset-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

form-field-options

form-field-options

/form-field-options

Get all form-field-options

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "field"
Example: include=units

Relations to include

object
Example: uuid=f20552a8-cc3e-4b4a-8ac0-47d3725b44b1

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/form-field-options

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "field"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-field-options/{form-field-option-uuid}

Get a single item

path Parameters
form-field-option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "field"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-field-options/{form-field-option-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
form-field-option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "field"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-field-options/{form-field-option-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
form-field-option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

form-fields

form-fields

/form-fields

Get all form-fields

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "variables" "step" "options"
Example: include=units

Relations to include

object
Example: uuid=0be9df42-b743-4896-8169-632d50c23796

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/form-fields

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "variables" "step" "options"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-fields/{form-field-uuid}

Get a single item

path Parameters
form-field-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "variables" "step" "options"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-fields/{form-field-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
form-field-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "variables" "step" "options"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-fields/{form-field-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
form-field-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

form-steps

form-steps

/form-steps

Get all form-steps

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "fields" "form"
Example: include=units

Relations to include

object
Example: uuid=fdbeeb53-bacc-4b99-a27b-95c68908b049

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/form-steps

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "fields" "form"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-steps/{form-step-uuid}

Get a single item

path Parameters
form-step-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "fields" "form"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-steps/{form-step-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
form-step-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "fields" "form"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/form-steps/{form-step-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
form-step-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

forms

forms

/forms

Get all forms

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "active_version" "versions" "owner_mail" "visitor_mail" "redirect_page"
Example: include=units

Relations to include

append
string
Value: "form_entries_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=811e3525-a1cd-42ff-946b-5d8fa88e0d49

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/forms

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "active_version" "versions" "owner_mail" "visitor_mail" "redirect_page"
Example: include=units

Relations to include

append
string
Value: "form_entries_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/forms/{form-uuid}

Get a single item

path Parameters
form-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "active_version" "versions" "owner_mail" "visitor_mail" "redirect_page"
Example: include=units

Relations to include

append
string
Value: "form_entries_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/forms/{form-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
form-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "active_version" "versions" "owner_mail" "visitor_mail" "redirect_page"
Example: include=units

Relations to include

append
string
Value: "form_entries_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/forms/{form-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
form-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

formulas

formulas

/formulas

Get all formulas

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=24c1abe0-5c3f-4d43-99ec-c2716a605062

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/formulas

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/formulas/{formula-uuid}

Get a single item

path Parameters
formula-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/formulas/{formula-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
formula-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/formulas/{formula-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
formula-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

highlight-statuses

highlight-statuses

/highlight-statuses

Get all highlight-statuses

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "products"
Example: include=units

Relations to include

object
Example: uuid=4354452c-0d33-46f0-94a8-598c1f795f6f

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/highlight-statuses

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "products"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/highlight-statuses/{highlight-status-uuid}

Get a single item

path Parameters
highlight-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "products"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/highlight-statuses/{highlight-status-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
highlight-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "products"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/highlight-statuses/{highlight-status-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
highlight-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

host-filters

host-filters

/host-filters

Get all host-filters

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "host" "field" "sign"
Example: include=units

Relations to include

object
Example: uuid=763f0e35-7a97-4430-9fea-383a048400cc

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/host-filters

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "host" "field" "sign"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/host-filters/{host-filter-uuid}

Get a single item

path Parameters
host-filter-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "host" "field" "sign"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/host-filters/{host-filter-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
host-filter-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "host" "field" "sign"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/host-filters/{host-filter-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
host-filter-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

hosts

hosts

/hosts

Get all hosts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "business_context"
Example: include=units

Relations to include

object
Example: uuid=a40e9b95-902b-471c-b7f6-e501bb9b6140

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/hosts

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "business_context"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/hosts/{host-uuid}

Get a single item

path Parameters
host-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "business_context"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/hosts/{host-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
host-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "business_context"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/hosts/{host-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
host-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

html

html

/html

Get all html

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=4f85cffa-7689-49c0-8b5f-3c060f312359

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/html

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/html/{html-uuid}

Get a single item

path Parameters
html-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/html/{html-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
html-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/html/{html-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
html-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

mails

mails

/mails

Get all mails

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "sendgrid_template" "from" "to" "cc" "bcc" "visitor_forms" "owner_forms"
Example: include=units

Relations to include

object
Example: uuid=88b649a5-2692-43e1-86ae-3b2ade2562d2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/mails

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "sendgrid_template" "from" "to" "cc" "bcc" "visitor_forms" "owner_forms"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/mails/{mail-uuid}

Get a single item

path Parameters
mail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "sendgrid_template" "from" "to" "cc" "bcc" "visitor_forms" "owner_forms"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/mails/{mail-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
mail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "sendgrid_template" "from" "to" "cc" "bcc" "visitor_forms" "owner_forms"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/mails/{mail-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
mail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

media

media

/media

Get all media

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

append
string
Enum: "full_url" "thumb" "attributes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example:

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/media

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

append
string
Enum: "full_url" "thumb" "attributes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/x-www-form-urlencoded
uuid
required
string
type
required
string
collection
string
url
string
file
string

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/media/{medium-uuid}

Get a single item

path Parameters
medium-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Enum: "full_url" "thumb" "attributes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/media/{medium-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
medium-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Enum: "full_url" "thumb" "attributes"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/media/{medium-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
medium-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

menus

menus

/menus

Get all menus

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "parent" "page" "children"
Example: include=units

Relations to include

append
string
Enum: "recursive_count" "items" "href" "is_visible"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=b3981708-f9b6-4ef0-814d-5bf04e150943&parent_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/menus

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "parent" "page" "children"
Example: include=units

Relations to include

append
string
Enum: "recursive_count" "items" "href" "is_visible"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/menus/{menu-uuid}

Get a single item

path Parameters
menu-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "parent" "page" "children"
Example: include=units

Relations to include

append
string
Enum: "recursive_count" "items" "href" "is_visible"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/menus/{menu-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
menu-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "parent" "page" "children"
Example: include=units

Relations to include

append
string
Enum: "recursive_count" "items" "href" "is_visible"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/menus/{menu-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
menu-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

meta-data

meta-data

/meta-data

Get all meta-data

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "parent" "collections"
Example: include=units

Relations to include

object
Example: uuid=4ad20251-5e41-469b-aa93-7174ec948944

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/meta-data

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "parent" "collections"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/meta-data/{meta-datum-uuid}

Get a single item

path Parameters
meta-datum-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "parent" "collections"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/meta-data/{meta-datum-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
meta-datum-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "parent" "collections"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/meta-data/{meta-datum-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
meta-datum-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

options

options

/options

Get all options

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=4f827937-6603-4652-b9f9-ab5f97465b71

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/options

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/options/{option-uuid}

Get a single item

path Parameters
option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/options/{option-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/options/{option-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
option-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

order-types

order-types

/order-types

Get all order-types

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=304c4a1e-2df8-4f1a-8e6a-d59fdd6d68a8

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/order-types

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/order-types/{order-type-uuid}

Get a single item

path Parameters
order-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/order-types/{order-type-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
order-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/order-types/{order-type-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
order-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

orders

orders

/orders

Get all orders

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "customer" "payment_type" "delivery_type" "customer_is_picking_up_at_store" "order_type" "cart"
Example: include=units

Relations to include

append
string
Enum: "full_name" "payment" "order_status" "invoice_name"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=0db28f9d-f077-4081-b29a-775e57f5b243&payment_type_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a&order_type_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a&delivery_type_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/orders

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "customer" "payment_type" "delivery_type" "customer_is_picking_up_at_store" "order_type" "cart"
Example: include=units

Relations to include

append
string
Enum: "full_name" "payment" "order_status" "invoice_name"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/orders/{order-uuid}

Get a single item

path Parameters
order-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "customer" "payment_type" "delivery_type" "customer_is_picking_up_at_store" "order_type" "cart"
Example: include=units

Relations to include

append
string
Enum: "full_name" "payment" "order_status" "invoice_name"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/orders/{order-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
order-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "customer" "payment_type" "delivery_type" "customer_is_picking_up_at_store" "order_type" "cart"
Example: include=units

Relations to include

append
string
Enum: "full_name" "payment" "order_status" "invoice_name"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

page-versions

page-versions

/page-versions

Get all page-versions

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "areas" "components"
Example: include=units

Relations to include

append
string
Enum: "preview_url" "hash"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=f77160c0-eb70-4a2b-98c3-1c0fa9ce1bee

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/page-versions

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "areas" "components"
Example: include=units

Relations to include

append
string
Enum: "preview_url" "hash"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/page-versions/{page-version-uuid}

Get a single item

path Parameters
page-version-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "areas" "components"
Example: include=units

Relations to include

append
string
Enum: "preview_url" "hash"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/page-versions/{page-version-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
page-version-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "areas" "components"
Example: include=units

Relations to include

append
string
Enum: "preview_url" "hash"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/page-versions/{page-version-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
page-version-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

pages

pages

/pages

Get all pages

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "segment" "popup_page" "versions" "publications" "pages" "active_version"
Example: include=units

Relations to include

object
Example: uuid=b61da504-4255-407c-8db6-9d4e0249d65f

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/pages

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "segment" "popup_page" "versions" "publications" "pages" "active_version"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/pages/{page-uuid}

Get a single item

path Parameters
page-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "segment" "popup_page" "versions" "publications" "pages" "active_version"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/pages/{page-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
page-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "segment" "popup_page" "versions" "publications" "pages" "active_version"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/pages/{page-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
page-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

payment-gateways

payment-gateways

/payment-gateways

Get all payment-gateways

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "payment_types"
Example: include=units

Relations to include

object
Example: uuid=ccb72b39-316c-4813-bd7d-639c2be598cb

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/payment-gateways

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "payment_types"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-gateways/{payment-gateway-uuid}

Get a single item

path Parameters
payment-gateway-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "payment_types"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-gateways/{payment-gateway-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
payment-gateway-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "payment_types"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-gateways/{payment-gateway-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
payment-gateway-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

payment-types

payment-types

/payment-types

Get all payment-types

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "gateway" "thank_you_page" "media"
Example: include=units

Relations to include

object
Example: uuid=0c12cf40-afa0-4d7a-90c6-31351a052c54

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/payment-types

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "gateway" "thank_you_page" "media"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-types/{payment-type-uuid}

Get a single item

path Parameters
payment-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "gateway" "thank_you_page" "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-types/{payment-type-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
payment-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "gateway" "thank_you_page" "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/payment-types/{payment-type-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
payment-type-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

postal-codes

postal-codes

/postal-codes

Get all postal-codes

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "parent"
Example: include=units

Relations to include

object
Example:

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/postal-codes/{postal-code-uuid}

Get a single item

path Parameters
postal-code-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "parent"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

product-deposits

product-deposits

/product-deposits

Get all product-deposits

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "product"
Example: include=units

Relations to include

object
Example: uuid=04475ff0-5ecc-43b5-b49e-586911f13d37

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/product-deposits

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "product"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-deposits/{product-deposit-uuid}

Get a single item

path Parameters
product-deposit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-deposits/{product-deposit-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
product-deposit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-deposits/{product-deposit-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
product-deposit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

product-units

product-units

/product-units

Get all product-units

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "product"
Example: include=units

Relations to include

object
Example: uuid=c025950e-8ba1-4912-a3ae-0245266c4112

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/product-units

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "product"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-units/{product-unit-uuid}

Get a single item

path Parameters
product-unit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-units/{product-unit-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
product-unit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "product"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/product-units/{product-unit-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
product-unit-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

products

products

/products

Get all products

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: code=74464524&uuid=ca565740-5bd8-44d9-bdf5-2b62b74b2514&collection_uuid=9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/products/{product-uuid}

Get a single item

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/products/{product-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Enum: "media" "units" "prices" "meta_data" "brand" "seo" "highlight_statuses" "related_products" "deposits" "clone_of" "group_with" "files" "links" "videos" "stock_status" "collections" "extras" "pages"
Example: include=units

Relations to include

append
string
Enum: "href" "api_id" "hash_id" "promo_price" "promo_percentage" "is_available" "price" "deposit" "catalog_product_price" "uri_added_to_cart" "rating" "rating_count"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/products/{product-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

/products/{product-uuid}/relationships/collections

Get all objects in the relation

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products/{product-uuid}/relationships/collections

Add an item to the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/collections

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/collections

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/meta-data

Get all objects in the relation

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products/{product-uuid}/relationships/meta-data

Add an item to the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/meta-data

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/meta-data

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/files

Get all objects in the relation

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products/{product-uuid}/relationships/files

Add an item to the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/files

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/files

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/videos

Get all objects in the relation

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products/{product-uuid}/relationships/videos

Add an item to the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/videos

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/videos

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/related

Get all objects in the relation

path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/products/{product-uuid}/relationships/related

Add an item to the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/related

Replace all items in a relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/products/{product-uuid}/relationships/related

Remove an item from the relation

Authorizations:
OAuth2
path Parameters
product-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
Request Body schema: application/vnd.api+json
Array of objects

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

quantity-discounts

quantity-discounts

/quantity-discounts

Get all quantity-discounts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "object"
Example: include=units

Relations to include

object
Example: uuid=9760c745-2e0a-456c-8748-ae4d6b49d0c3

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/quantity-discounts

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "object"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/quantity-discounts/{quantity-discount-uuid}

Get a single item

path Parameters
quantity-discount-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "object"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/quantity-discounts/{quantity-discount-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
quantity-discount-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "object"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/quantity-discounts/{quantity-discount-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
quantity-discount-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

recipients

recipients

/recipients

Get all recipients

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "mail"
Example: include=units

Relations to include

object
Example: uuid=e58f7e95-dca7-438c-8b65-2908d11efd39

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/recipients

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "mail"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/recipients/{recipient-uuid}

Get a single item

path Parameters
recipient-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "mail"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/recipients/{recipient-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
recipient-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "mail"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/recipients/{recipient-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
recipient-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

redirects

redirects

/redirects

Get all redirects

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=ea9b502e-ba5f-4b4a-a7d5-09821da12cdc

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/redirects

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/redirects/{redirect-uuid}

Get a single item

path Parameters
redirect-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/redirects/{redirect-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
redirect-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/redirects/{redirect-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
redirect-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

services

services

/services

Get all services

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=4047c62b-1641-498e-88f6-1d44efb48796

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/services

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/services/{service-uuid}

Get a single item

path Parameters
service-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/services/{service-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
service-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/services/{service-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
service-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

stock-statuses

stock-statuses

/stock-statuses

Get all stock-statuses

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

append
string
Value: "code_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

object
Example: uuid=a7394715-bf0e-485c-a3b3-2a5554beea19

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/stock-statuses

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
append
string
Value: "code_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stock-statuses/{stock-status-uuid}

Get a single item

path Parameters
stock-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Value: "code_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stock-statuses/{stock-status-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
stock-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
append
string
Value: "code_description"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stock-statuses/{stock-status-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
stock-status-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

stores

stores

/stores

Get all stores

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "opening_hours"
Example: include=units

Relations to include

object
Example: uuid=7e57e29f-fbdb-4c37-99df-de3173b45972

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/stores

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "opening_hours"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stores/{store-uuid}

Get a single item

path Parameters
store-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "opening_hours"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stores/{store-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
store-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "opening_hours"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/stores/{store-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
store-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

synonyms

synonyms

/synonyms

Get all synonyms

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=efe553cb-f32b-4af2-9dee-b43979524528

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/synonyms

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/synonyms/{synonym-uuid}

Get a single item

path Parameters
synonym-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/synonyms/{synonym-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
synonym-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/synonyms/{synonym-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
synonym-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

texts

texts

/texts

Get all texts

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

include
string
Value: "media"
Example: include=units

Relations to include

object
Example: uuid=78cb67de-e09c-4c7d-86eb-d16826ab04c8

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/texts

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
include
string
Value: "media"
Example: include=units

Relations to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/texts/{text-uuid}

Get a single item

path Parameters
text-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/texts/{text-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
text-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
include
string
Value: "media"
Example: include=units

Relations to include

locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/texts/{text-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
text-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

thumbnails

thumbnails

/thumbnails

Get all thumbnails

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=da68a091-e3d9-4cd7-8227-386ac9e8645e

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/thumbnails

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/thumbnails/{thumbnail-uuid}

Get a single item

path Parameters
thumbnail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/thumbnails/{thumbnail-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
thumbnail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/thumbnails/{thumbnail-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
thumbnail-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

unit-mappings

unit-mappings

/unit-mappings

Get all unit-mappings

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=c787a98c-a449-4bb1-904a-fc1594effca3

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/unit-mappings

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/unit-mappings/{unit-mapping-uuid}

Get a single item

path Parameters
unit-mapping-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/unit-mappings/{unit-mapping-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
unit-mapping-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/unit-mappings/{unit-mapping-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
unit-mapping-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

videos

videos

/videos

Get all videos

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

object
Example: uuid=bdfe06f7-9e77-4143-8bfe-f4fb43866c29

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/videos

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/videos/{video-uuid}

Get a single item

path Parameters
video-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/videos/{video-uuid}

Update an item

Authorizations:
OAuth2
path Parameters
video-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/videos/{video-uuid}

Delete an item

Authorizations:
OAuth2
path Parameters
video-uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

Responses

images

/images

Get all images

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

append
string
Enum: "url" "thumbnails"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/images

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
append
string
Enum: "url" "thumbnails"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/images/{uuid}

Update an item

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
append
string
Enum: "url" "thumbnails"
Examples:
  • append=deposit - Single value
  • append=desposit,price,image - Multiple values

Calculated properties to include

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

files

/files

Get all files

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
sort
string
Enum: "created_at" "-created_at" "updated_at" "-updated_at"
Examples:
  • sort=created_at - Sort by `created_at` ascending
  • sort=-created_at - Sort by `created_at` descending

Field to sort by. May be prepended with - to sort descending.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

/files

Create an item

Authorizations:
OAuth2
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/files/{uuid}

Update an item

Authorizations:
OAuth2
path Parameters
uuid
required
string <uuid>
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a
query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

page
number
Example: page=1
limit
number [ 1 .. 1000 ]
Example: limit=15
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

live

/live/products/{uuid}/prices

Get the calculated price for a specific customer

Authorizations:
OAuth2
path Parameters
uuid
required
string
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

The uuid of the product

query Parameters
unit
required
string
Example: unit=STK
quantity
required
number
Example: quantity=1

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/live/products/{uuid}/units

Authorizations:
OAuth2
path Parameters
uuid
required
string
Example: 9308e166-6362-4cc0-be46-9dc63c6eac4a

The uuid of the product

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/push-order

Authorizations:
OAuth2
Request Body schema: application/vnd.api+json
Array
product-uuid
string <uuid>
quantity
integer
unit
string

Responses

Request samples

Content type
application/vnd.api+json
[
  • {
    },
  • {
    }
]

/purchase-history

Authorizations:
OAuth2

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/collection-tree

Get the collection tree.

query Parameters
locale
string
Example: locale=nl

Passing a locale as query parameter will make the api return translated strings instead of translatable objects

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

token

/token

Request/Refresh an access token for use in requests. Either the client_secret or refresh_token is required depening on the grant_type.

Request Body schema: application/vnd.api+json
client_id
required
string <uuid>

Provided by Organi to the customer.

client_secret
required
string

Provided by Organi to the customer.

username
string
password
string
refresh_token
string

The refresh token, provided by the last token request.

grant_type
required
string
Enum: "password" "refresh_token" "client_credentials"

Responses

Request samples

Content type
application/vnd.api+json
{
  • "client_id": "9308e166-6362-4cc0-be46-9dc63c6eac4a",
  • "client_secret": "RilKdWdxxxx4sQg4cbD8JIVJas5AvoYGLiAIX4uZ",
  • "username": "info@organi.be",
  • "password": "secure_password_123",
  • "refresh_token": "def50200e2910c7ea0033c43723d380508ee4dc3ed7c6ababc958e56fbd6a98e011f6d8c9cf04d3a33e82b8ebf15a55b2fc61321fd5061ccfbe7f91fb0f2818ea5986da1c7cf8c6cc4abd8f6f658ab4a6dc56fc3020cbf53784e01285789222f00faa86d4c501ff1c8d464fc41f0eab30f483e6a7625f8d0029d3d4710d497726f87d5eedece2f6ef1a2a7d32f150b140d7d6a335bc3636459bda28956e8eb7723a9df8030f307e2252eb5864c8c3e6de54130901a5053703622b7d4917de1ef1e1b022ae96273b3e20defa1c4b3a2758c7e5f13ac4ac9780aebf8125bba6f87136a973092fcfae8af4cc45693f8c584b8c0fb9a59c2036c6438f870ef31d2f8dd037b6c36f88510babb4d6c03e30f7c4c1dc285d7f85c353a931bcc653231838f17ed3f754051ea8202a04cd4ca8d9cb5153e85c6a2a6e5687b269259baf9ce0f00fcec6faaa03574d2c15dc1023ae0641891b15badad0f19c2729fb73c344aca34fb6e0b5b25a27eba9cc672a4",
  • "grant_type": "password"
}

Response samples

Content type
application/vnd.api+json
{
  • "token_type": "Bearer",
  • "expires_in": 86400,
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjhmNWE3NjU3ZDFhZjhjNGI0YzYzYzEwNDU0ZTE5NzBkMTllYjRhYWEwMGU5YjVmYmFkNjk0MjZkNjkxMTE4ZjVkYWNmN2E5YWFiNWFkYTUzIn0.eyJhdWQiOiI0IiwianRpIjoiOGY1YTc2NTdkMWFmOGM0YjRjNjNjMTA0NTRlMTk3MGQxOWViNGFhYTAwZTliNWZiYWQ2OTQyNmQ2OTExMThmNWRhY2Y3YTlhYWI1YWRhNTMiLCJpYXQiOjE1ODA3MzY2NTMsIm5iZiI6MTU4MDczNjY1MywiZXhwIjoxNTgwODIzMDUzLCJzdWIiOiIxMDAwNTgzNzExMDAwMSIsInNjb3BlcyI6W119.JZtMZonqaYIXMbMjTs1LqXLbYxynmWWZaljh3WBC3kVHxJiS9fTiBmjKF5MYaIZnG3AHc8cUTzBJIYW0MQiKOTAIkivYyjIuOAHd1kfgDLSPi68xxjWqhgzuApmXRIP8fZt4v8ul3jvE2PUesYZPi9GsAv5k-KLanpFiu27OjXU-suo55Ysxr4a7hx9-OZey_AQbYkGkZbj4i_ddOrFV0Npjyt-U8cptAHui5IiUblBsJLY9cQxgirOP2zZK3eRk22lEBR9sYTlQKAW3iGhXywxPzzUk-ggSBAOgXa4DoT4QQx7DmVyGpCoE1vMzxx6AUXNmo4G4wmynbSuv4jPjDzUJYyDCp3PPRWJpPPvkrfVoaT_QQmPm2BIGTvl7JnchSD_N641wX8ZfiGlEgR07ZaNbV7AIwpezELt3Qv0ZlJXTYYI5fJ-MUv6yrLDrO-hmCuPYbhDr_5NJuhH75xMldHmvy-l4JWJLM3cGX_g1qcSHHFAjR8rEIsYeidFe8QxTRcDTIlrDonH7ngzXby3B63_YVWuLm3y2e9vB1JDLhL1CV44DBFd6km78yU6q6xsvf3EqT7KrK_PucQcHUiXh92b-HRGSob5Y66Kne1B2noR7i5I_anXXXVhM6zcYjxcXPrdqnYvfTQzR_qSym-vhsvwV4rjMX3UMAiYPybjI60Ije0",
  • "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjhmNWE3NjU3ZDFhZjhjNGI0YzYzYzEwNDU0ZTE5NzBkMTllYjRhYWEwMGU5YjVmYmFkNjk0MjZkNjkxMTE4ZjVkYWNmN2E5YWFiNWFkYTUzIn0.eyJhdWQiOiI0IiwianRpIjoiOGY1YTc2NTdkMWFmOGM0YjRjNjNjMTA0NTRlMTk3MGQxOWViNGFhYTAwZTliNWZiYWQ2OTQyNmQ2OTExMThmNWRhY2Y3YTlhYWI1YWRhNTMiLCJpYXQiOjE1ODA3MzY2NTMsIm5iZiI6MTU4MDczNjY1MywiZXhwIjoxNTgwODIzMDUzLCJzdWIiOiIxMDAwNTgzNzExMDAwMSIsInNjb3BlcyI6W119.JZtMZonqaYIXMbMjTs1LqXLbYxynmWWZaljh3WBC3kVHxJiS9fTiBmjKF5MYaIZnG3AHc8cUTzBJIYW0MQiKOTAIkivYyjIuOAHd1kfgDLSPi68xxjWqhgzuApmXRIP8fZt4v8ul3jvE2PUesYZPi9GsAv5k-KLanpFiu27OjXU-suo55Ysxr4a7hx9-OZey_AQbYkGkZbj4i_ddOrFV0Npjyt-U8cptAHui5IiUblBsJLY9cQxgirOP2zZK3eRk22lEBR9sYTlQKAW3iGhXywxPzzUk-ggSBAOgXa4DoT4QQx7DmVyGpCoE1vMzxx6AUXNmo4G4wmynbSuv4jPjDzUJYyDCp3PPRWJpPPvkrfVoaT_QQmPm2BIGTvl7JnchSD_N641wX8ZfiGlEgR07ZaNbV7AIwpezELt3Qv0ZlJXTYYI5fJ-MUv6yrLDrO-hmCuPYbhDr_5NJuhH75xMldHmvy-l4JWJLM3cGX_g1qcSHHFAjR8rEIsYeidFe8QxTRcDTIlrDonH7ngzXby3B63_YVWuLm3y2e9vB1JDLhL1CV44DBFd6km78yU6q6xsvf3EqT7KrK_PucQcHUiXh92b-HRGwwwwwSob5Y66Kne1B2noR7i5I_anVhM6zcYjxcXPrdqnYvfTQzR_qSym-vhsvwV4rjMX3UMAiYPybjI60Ije0"
}

Search

/search/{type}

Search in type

path Parameters
type
required
string (searchable-type)
Value: "page"
Example: page
query Parameters
q
required
string

query that has to be searched

cat
string

category that has to be searched

language
required
string (language)
Enum: "nl" "fr" "en"
Example: language=nl

language that has to be returnend

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ]
}

/search/{type}

Add an item to the search index

path Parameters
type
required
string (searchable-type)
Value: "page"
Example: page
Request Body schema: application/vnd.api+json
required
object or string (translatable)
required
object or string (translatable)
object or string (translatable)

Responses

Request samples

Content type
application/vnd.api+json
{
  • "title": {
    },
  • "path": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "success": true,
  • "data": {
    }
}

/search/{type}/{uuid}

Update an item in the search index

path Parameters
type
required
string (searchable-type)
Value: "page"
Example: page
uuid
required
string <Searchable ID>
Example: 6dpyd

Responses

Response samples

Content type
application/vnd.api+json
{
  • "success": true
}

/search/{type}/{uuid}

Delete an item in the search index

path Parameters
type
required
string (searchable-type)
Value: "page"
Example: page
uuid
required
string <Searchable ID>
Example: 6dpyd

Responses

Response samples

Content type
application/vnd.api+json
{
  • "success": true
}