visible, hidden, or force_visible.'
example: force_visible
/api/customer-organizations:
get:
summary: ''
operationId: getApiCustomerOrganizations
description: ''
parameters:
-
in: query
name: page
description: 'The page number'
example: 1
required: true
schema:
type: string
description: 'The page number'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1205
name: 'Pizzahuis BV'
external_id: ddba52d8-cd20-3839-8ab0-ac935f91ecf2
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 1206
name: 'Kapperszaak Huisman CV'
external_id: 9a938235-256d-3c8d-af54-d277cfbf4b96
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: array
example:
-
id: 1205
name: 'Pizzahuis BV'
external_id: ddba52d8-cd20-3839-8ab0-ac935f91ecf2
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 1206
name: 'Kapperszaak Huisman CV'
external_id: 9a938235-256d-3c8d-af54-d277cfbf4b96
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1205
name:
type: string
example: 'Pizzahuis BV'
external_id:
type: string
example: ddba52d8-cd20-3839-8ab0-ac935f91ecf2
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
post:
summary: ''
operationId: postApiCustomerOrganizations
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1207
name: 'Keukendump CSL'
external_id: fd3f3557-84d8-32ab-9d8b-e5df797f6406
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1207
name:
type: string
example: 'Keukendump CSL'
external_id:
type: string
example: fd3f3557-84d8-32ab-9d8b-e5df797f6406
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: wtrpqbuwlrxu
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: azsjxnordblo
required:
- name
- external_id
'/api/customer-organizations/{id}':
get:
summary: ''
operationId: getApiCustomerOrganizationsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1208
name: 'Meubelhuis EESV'
external_id: eece64cf-634f-3d2e-83b1-44c91c67f1cd
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1208
name:
type: string
example: 'Meubelhuis EESV'
external_id:
type: string
example: eece64cf-634f-3d2e-83b1-44c91c67f1cd
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
put:
summary: ''
operationId: putApiCustomerOrganizationsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1209
name: 'Bierbrouwer Keijser CSL'
external_id: 735735e7-2170-3154-8ba2-2fce882cd32a
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1209
name:
type: string
example: 'Bierbrouwer Keijser CSL'
external_id:
type: string
example: 735735e7-2170-3154-8ba2-2fce882cd32a
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: fiutziduguxtxgpuusxs
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: gjseatdfrrkhbivmmdlrs
required:
- name
- external_id
delete:
summary: ''
operationId: deleteApiCustomerOrganizationsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Customers
parameters:
-
in: path
name: id
description: 'The ID of the customer organization.'
example: 1
required: true
schema:
type: integer
/api/customers:
get:
summary: ''
operationId: getApiCustomers
description: ''
parameters:
-
in: query
name: page
description: 'The page number to load'
example: 6
required: true
schema:
type: integer
description: 'The page number to load'
example: 6
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 3323
customer_organization_id: 1210
debtor_number: 7871
customer_number: 64006372-a5cc-3470-9fcf-9042a9ac0791
name: 'Smederij Lopes'
city: Naarden
address: null
postal_code: 5403NJ
phone_number: null
mobile_number: null
price_code: 1
sector: horeca
free_market: true
stock_information_allowed: true
assortment_number: 1
delivery_day: null
actions: true
invoice_name: 'Aiden van der Lede'
invoice_city: null
invoice_address: 'Noordijkdreef 94-27'
invoice_postal_code: 2261BH
invoice_email: renske.janssens@example.org
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
-
id: 3324
customer_organization_id: 1211
debtor_number: 4479
customer_number: caf5a95f-d7ac-3fb0-85ee-4fe094245abb
name: Witgoedfabriek
city: Westdorpe
address: null
postal_code: 8226HJ
phone_number: '+224750883298'
mobile_number: null
price_code: 2
sector: slijterij
free_market: true
stock_information_allowed: true
assortment_number: 2
delivery_day: 3
actions: false
invoice_name: 'Dave Lamore'
invoice_city: Rumpt
invoice_address: null
invoice_postal_code: null
invoice_email: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
properties:
data:
type: array
example:
-
id: 3323
customer_organization_id: 1210
debtor_number: 7871
customer_number: 64006372-a5cc-3470-9fcf-9042a9ac0791
name: 'Smederij Lopes'
city: Naarden
address: null
postal_code: 5403NJ
phone_number: null
mobile_number: null
price_code: 1
sector: horeca
free_market: true
stock_information_allowed: true
assortment_number: 1
delivery_day: null
actions: true
invoice_name: 'Aiden van der Lede'
invoice_city: null
invoice_address: 'Noordijkdreef 94-27'
invoice_postal_code: 2261BH
invoice_email: renske.janssens@example.org
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
-
id: 3324
customer_organization_id: 1211
debtor_number: 4479
customer_number: caf5a95f-d7ac-3fb0-85ee-4fe094245abb
name: Witgoedfabriek
city: Westdorpe
address: null
postal_code: 8226HJ
phone_number: '+224750883298'
mobile_number: null
price_code: 2
sector: slijterij
free_market: true
stock_information_allowed: true
assortment_number: 2
delivery_day: 3
actions: false
invoice_name: 'Dave Lamore'
invoice_city: Rumpt
invoice_address: null
invoice_postal_code: null
invoice_email: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
items:
type: object
properties:
id:
type: integer
example: 3323
customer_organization_id:
type: integer
example: 1210
debtor_number:
type: integer
example: 7871
customer_number:
type: string
example: 64006372-a5cc-3470-9fcf-9042a9ac0791
name:
type: string
example: 'Smederij Lopes'
city:
type: string
example: Naarden
address:
type: string
example: null
postal_code:
type: string
example: 5403NJ
phone_number:
type: string
example: null
mobile_number:
type: string
example: null
price_code:
type: integer
example: 1
sector:
type: string
example: horeca
free_market:
type: boolean
example: true
stock_information_allowed:
type: boolean
example: true
assortment_number:
type: integer
example: 1
delivery_day:
type: string
example: null
actions:
type: boolean
example: true
invoice_name:
type: string
example: 'Aiden van der Lede'
invoice_city:
type: string
example: null
invoice_address:
type: string
example: 'Noordijkdreef 94-27'
invoice_postal_code:
type: string
example: 2261BH
invoice_email:
type: string
example: renske.janssens@example.org
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
tags:
- Customers
post:
summary: ''
operationId: postApiCustomers
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 3325
customer_organization_id: 1212
debtor_number: 2623
customer_number: a18f59de-0b4f-365d-9d0e-9c20880c6e4c
name: 'Aquaria Boulevard'
city: null
address: 'van der Laanstraat 95g'
postal_code: 7557VC
phone_number: null
mobile_number: '+591702557008'
price_code: 1
sector: horeca
free_market: true
stock_information_allowed: true
assortment_number: 1
delivery_day: 3
actions: false
invoice_name: 'Yinthe van Doorn'
invoice_city: Boven-Leeuwen
invoice_address: 'Hulsdreef 8-4'
invoice_postal_code: null
invoice_email: femke.kramer@example.org
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
properties:
data:
type: object
properties:
id:
type: integer
example: 3325
customer_organization_id:
type: integer
example: 1212
debtor_number:
type: integer
example: 2623
customer_number:
type: string
example: a18f59de-0b4f-365d-9d0e-9c20880c6e4c
name:
type: string
example: 'Aquaria Boulevard'
city:
type: string
example: null
address:
type: string
example: 'van der Laanstraat 95g'
postal_code:
type: string
example: 7557VC
phone_number:
type: string
example: null
mobile_number:
type: string
example: '+591702557008'
price_code:
type: integer
example: 1
sector:
type: string
example: horeca
free_market:
type: boolean
example: true
stock_information_allowed:
type: boolean
example: true
assortment_number:
type: integer
example: 1
delivery_day:
type: integer
example: 3
actions:
type: boolean
example: false
invoice_name:
type: string
example: 'Yinthe van Doorn'
invoice_city:
type: string
example: Boven-Leeuwen
invoice_address:
type: string
example: 'Hulsdreef 8-4'
invoice_postal_code:
type: string
example: null
invoice_email:
type: string
example: femke.kramer@example.org
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_organization_id:
type: string
description: ''
example: null
customer_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: zblldnivsmdsbfojeyqem
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: iqwiktcbsoufequ
debtor_number:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 5
city:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: etgg
address:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: czqgoxehrjuy
postal_code:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: kwvsidknzjckv
phone_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: zjhkfjbsprqmaswtwi
mobile_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: meccpscngba
price_code:
type: integer
description: 'Must be one of 0, 1, or 2.'
example: 0
free_market:
type: boolean
description: ''
example: true
stock_information_allowed:
type: boolean
description: ''
example: false
assortment_number:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 61
sector:
type: string
description: 'Must be one of horeca or slijterij.'
example: slijterij
delivery_day:
type: integer
description: ':Attribute moet minimaal 0 zijn. :Attribute mag niet hoger dan 6 zijn.'
example: 3
actions:
type: boolean
description: ''
example: false
invoice_email:
type: string
description: ''
example: null
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: simeon72@example.net
invoice_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: miljcuhgqsdxbmbmkuth
invoice_city:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: ohcnhtllpehswejjjzjizfk
invoice_address:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: lknzmyqnivcnkvgmduszrgjg
invoice_postal_code:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: zwweuhexzcu
required:
- customer_number
- name
- debtor_number
- price_code
- free_market
- stock_information_allowed
- assortment_number
- sector
- actions
- email
'/api/customers/{id}':
get:
summary: ''
operationId: getApiCustomersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 3326
customer_organization_id: 1213
debtor_number: 9847
customer_number: 0039334f-ebc5-3e01-8171-d3b6d7043d07
name: 'Video Fabriek'
city: null
address: null
postal_code: null
phone_number: '+6839500297'
mobile_number: '+981372027898'
price_code: 2
sector: slijterij
free_market: true
stock_information_allowed: true
assortment_number: 1
delivery_day: 2
actions: false
invoice_name: null
invoice_city: null
invoice_address: null
invoice_postal_code: null
invoice_email: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
properties:
data:
type: object
properties:
id:
type: integer
example: 3326
customer_organization_id:
type: integer
example: 1213
debtor_number:
type: integer
example: 9847
customer_number:
type: string
example: 0039334f-ebc5-3e01-8171-d3b6d7043d07
name:
type: string
example: 'Video Fabriek'
city:
type: string
example: null
address:
type: string
example: null
postal_code:
type: string
example: null
phone_number:
type: string
example: '+6839500297'
mobile_number:
type: string
example: '+981372027898'
price_code:
type: integer
example: 2
sector:
type: string
example: slijterij
free_market:
type: boolean
example: true
stock_information_allowed:
type: boolean
example: true
assortment_number:
type: integer
example: 1
delivery_day:
type: integer
example: 2
actions:
type: boolean
example: false
invoice_name:
type: string
example: null
invoice_city:
type: string
example: null
invoice_address:
type: string
example: null
invoice_postal_code:
type: string
example: null
invoice_email:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
tags:
- Customers
put:
summary: ''
operationId: putApiCustomersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 3327
customer_organization_id: 1214
debtor_number: 7900
customer_number: bd7b38cf-2080-3cf5-b45d-e83bed22fcff
name: 'Keuken Expert SE'
city: Aalsmeerderbrug
address: 'Eerdenring 7'
postal_code: null
phone_number: '+22262104353'
mobile_number: '+80096457917'
price_code: 2
sector: horeca
free_market: true
stock_information_allowed: true
assortment_number: 1
delivery_day: null
actions: false
invoice_name: null
invoice_city: null
invoice_address: 'de Graafbaan 2'
invoice_postal_code: 6534XT
invoice_email: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
properties:
data:
type: object
properties:
id:
type: integer
example: 3327
customer_organization_id:
type: integer
example: 1214
debtor_number:
type: integer
example: 7900
customer_number:
type: string
example: bd7b38cf-2080-3cf5-b45d-e83bed22fcff
name:
type: string
example: 'Keuken Expert SE'
city:
type: string
example: Aalsmeerderbrug
address:
type: string
example: 'Eerdenring 7'
postal_code:
type: string
example: null
phone_number:
type: string
example: '+22262104353'
mobile_number:
type: string
example: '+80096457917'
price_code:
type: integer
example: 2
sector:
type: string
example: horeca
free_market:
type: boolean
example: true
stock_information_allowed:
type: boolean
example: true
assortment_number:
type: integer
example: 1
delivery_day:
type: string
example: null
actions:
type: boolean
example: false
invoice_name:
type: string
example: null
invoice_city:
type: string
example: null
invoice_address:
type: string
example: 'de Graafbaan 2'
invoice_postal_code:
type: string
example: 6534XT
invoice_email:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_organization_id:
type: string
description: ''
example: null
customer_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: pdhpsnjiutlrxlxbgnw
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: hfpkrahwm
debtor_number:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 33
city:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: dksbbd
address:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: sjgjtkckqz
postal_code:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: eithosyvaaieyssbrparqblov
phone_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: atpmfjqtbmushdnujexjm
mobile_number:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: bacwbonhntbkaq
price_code:
type: integer
description: 'Must be one of 0, 1, or 2.'
example: 0
free_market:
type: boolean
description: ''
example: false
stock_information_allowed:
type: boolean
description: ''
example: true
assortment_number:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 1
sector:
type: string
description: 'Must be one of horeca or slijterij.'
example: slijterij
delivery_day:
type: integer
description: ':Attribute moet minimaal 0 zijn. :Attribute mag niet hoger dan 6 zijn.'
example: 6
actions:
type: boolean
description: ''
example: false
invoice_email:
type: string
description: ''
example: null
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: robin.gottlieb@example.com
invoice_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: pgmkyjigwtu
invoice_city:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: obqrc
invoice_address:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: oupthvodmiwupphryg
invoice_postal_code:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: qvvff
required:
- customer_number
- name
- debtor_number
- price_code
- free_market
- stock_information_allowed
- assortment_number
- sector
- actions
- email
delete:
summary: ''
operationId: deleteApiCustomersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Customers
parameters:
-
in: path
name: id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
'/api/customers/{customer_id}/products':
get:
summary: ''
operationId: getApiCustomersCustomer_idProducts
description: ''
parameters:
-
in: query
name: page
description: 'The page number to load'
example: 1
required: true
schema:
type: integer
description: 'The page number to load'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 13082
supplier_id: 1386
product_group_id: 2029
customer_organization_id: null
external_id: 15398b78-527e-3e76-bf9b-1bfb587d40c8
name: et
courant_price: null
advice_price: 42.77
vat_type: 0
stock_code: O
tlo: true
restocked_at: null
box_content: 24
content: 16410598.2
free_market: true
package_deposit: 0.97
price_list_description: 'Voluptate ipsam id quia similique dolores.'
alcohol: 17.9
unit: null
ean_1: '1464680830774'
ean_2: '2072733375296'
ean_3: '1388560128839'
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/15398b78-527e-3e76-bf9b-1bfb587d40c8.png'
-
id: 13083
supplier_id: 1387
product_group_id: 2031
customer_organization_id: null
external_id: c550390c-8d83-386d-bb5f-3545fa96724d
name: voluptates
courant_price: null
advice_price: 79.79
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2023-09-09T13:52:00.000000Z'
box_content: 11
content: 182870051.5
free_market: false
package_deposit: 1.26
price_list_description: 'Qui voluptatum quis iste omnis aliquam repudiandae enim.'
alcohol: 44.02
unit: null
ean_1: '3245940145771'
ean_2: '8909128167492'
ean_3: null
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/c550390c-8d83-386d-bb5f-3545fa96724d.png'
properties:
data:
type: array
example:
-
id: 13082
supplier_id: 1386
product_group_id: 2029
customer_organization_id: null
external_id: 15398b78-527e-3e76-bf9b-1bfb587d40c8
name: et
courant_price: null
advice_price: 42.77
vat_type: 0
stock_code: O
tlo: true
restocked_at: null
box_content: 24
content: 16410598.2
free_market: true
package_deposit: 0.97
price_list_description: 'Voluptate ipsam id quia similique dolores.'
alcohol: 17.9
unit: null
ean_1: '1464680830774'
ean_2: '2072733375296'
ean_3: '1388560128839'
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/15398b78-527e-3e76-bf9b-1bfb587d40c8.png'
-
id: 13083
supplier_id: 1387
product_group_id: 2031
customer_organization_id: null
external_id: c550390c-8d83-386d-bb5f-3545fa96724d
name: voluptates
courant_price: null
advice_price: 79.79
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2023-09-09T13:52:00.000000Z'
box_content: 11
content: 182870051.5
free_market: false
package_deposit: 1.26
price_list_description: 'Qui voluptatum quis iste omnis aliquam repudiandae enim.'
alcohol: 44.02
unit: null
ean_1: '3245940145771'
ean_2: '8909128167492'
ean_3: null
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/c550390c-8d83-386d-bb5f-3545fa96724d.png'
items:
type: object
properties:
id:
type: integer
example: 13082
supplier_id:
type: integer
example: 1386
product_group_id:
type: integer
example: 2029
customer_organization_id:
type: string
example: null
external_id:
type: string
example: 15398b78-527e-3e76-bf9b-1bfb587d40c8
name:
type: string
example: et
courant_price:
type: string
example: null
advice_price:
type: number
example: 42.77
vat_type:
type: integer
example: 0
stock_code:
type: string
example: O
tlo:
type: boolean
example: true
restocked_at:
type: string
example: null
box_content:
type: integer
example: 24
content:
type: number
example: 16410598.2
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 0.97
price_list_description:
type: string
example: 'Voluptate ipsam id quia similique dolores.'
alcohol:
type: number
example: 17.9
unit:
type: string
example: null
ean_1:
type: string
example: '1464680830774'
ean_2:
type: string
example: '2072733375296'
ean_3:
type: string
example: '1388560128839'
discount:
type: boolean
example: false
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/15398b78-527e-3e76-bf9b-1bfb587d40c8.png'
tags:
- Customers
post:
summary: ''
operationId: postApiCustomersCustomer_idProducts
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 13084
supplier_id: 1388
product_group_id: 2033
customer_organization_id: null
external_id: be0a6b6d-51d8-35e6-9e2c-f547cfb5726f
name: beatae
courant_price: null
advice_price: 49.27
vat_type: 2
stock_code: O
tlo: true
restocked_at: '2024-03-13T05:23:36.000000Z'
box_content: 17
content: 35.7
free_market: false
package_deposit: 8.01
price_list_description: null
alcohol: 75.19
unit: ZAKF
ean_1: '4941886503864'
ean_2: null
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/be0a6b6d-51d8-35e6-9e2c-f547cfb5726f.png'
properties:
data:
type: object
properties:
id:
type: integer
example: 13084
supplier_id:
type: integer
example: 1388
product_group_id:
type: integer
example: 2033
customer_organization_id:
type: string
example: null
external_id:
type: string
example: be0a6b6d-51d8-35e6-9e2c-f547cfb5726f
name:
type: string
example: beatae
courant_price:
type: string
example: null
advice_price:
type: number
example: 49.27
vat_type:
type: integer
example: 2
stock_code:
type: string
example: O
tlo:
type: boolean
example: true
restocked_at:
type: string
example: '2024-03-13T05:23:36.000000Z'
box_content:
type: integer
example: 17
content:
type: number
example: 35.7
free_market:
type: boolean
example: false
package_deposit:
type: number
example: 8.01
price_list_description:
type: string
example: null
alcohol:
type: number
example: 75.19
unit:
type: string
example: ZAKF
ean_1:
type: string
example: '4941886503864'
ean_2:
type: string
example: null
ean_3:
type: string
example: null
discount:
type: boolean
example: true
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/be0a6b6d-51d8-35e6-9e2c-f547cfb5726f.png'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: ''
example: neque
visibility:
type: string
description: 'Must be one of visible, hidden, or force_visible.'
example: force_visible
required:
- product_id
- visibility
parameters:
-
in: path
name: customer_id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
'/api/customers/{customer_id}/products/{id}':
delete:
summary: ''
operationId: deleteApiCustomersCustomer_idProductsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Customers
parameters:
-
in: path
name: customer_id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
'/api/customers/{customer_id}/order-lists':
get:
summary: ''
operationId: getApiCustomersCustomer_idOrderLists
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 647260
customer_id: 3328
product_id: 13085
rank: 'n'
is_favourite: false
is_external: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 647261
customer_id: 3329
product_id: 13086
rank: zf
is_favourite: true
is_external: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: array
example:
-
id: 647260
customer_id: 3328
product_id: 13085
rank: 'n'
is_favourite: false
is_external: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 647261
customer_id: 3329
product_id: 13086
rank: zf
is_favourite: true
is_external: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
items:
type: object
properties:
id:
type: integer
example: 647260
customer_id:
type: integer
example: 3328
product_id:
type: integer
example: 13085
rank:
type: string
example: 'n'
is_favourite:
type: boolean
example: false
is_external:
type: boolean
example: true
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
post:
summary: ''
operationId: postApiCustomersCustomer_idOrderLists
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 647262
customer_id: 3330
product_id: 13087
rank: u
is_favourite: true
is_external: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 647262
customer_id:
type: integer
example: 3330
product_id:
type: integer
example: 13087
rank:
type: string
example: u
is_favourite:
type: boolean
example: true
is_external:
type: boolean
example: true
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: ''
example: in
rank:
type: string
description: ''
example: ratione
is_favourite:
type: boolean
description: ''
example: true
is_external:
type: boolean
description: ''
example: false
required:
- product_id
- is_favourite
- is_external
parameters:
-
in: path
name: customer_id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
'/api/customers/{customer_id}/order-lists/{id}':
get:
summary: ''
operationId: getApiCustomersCustomer_idOrderListsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 647263
customer_id: 3331
product_id: 13088
rank: b
is_favourite: true
is_external: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 647263
customer_id:
type: integer
example: 3331
product_id:
type: integer
example: 13088
rank:
type: string
example: b
is_favourite:
type: boolean
example: true
is_external:
type: boolean
example: true
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
put:
summary: ''
operationId: putApiCustomersCustomer_idOrderListsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 647264
customer_id: 3332
product_id: 13089
rank: dv
is_favourite: false
is_external: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 647264
customer_id:
type: integer
example: 3332
product_id:
type: integer
example: 13089
rank:
type: string
example: dv
is_favourite:
type: boolean
example: false
is_external:
type: boolean
example: true
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: ''
example: praesentium
rank:
type: string
description: ''
example: non
is_favourite:
type: boolean
description: ''
example: false
is_external:
type: boolean
description: ''
example: true
required:
- product_id
- is_favourite
- is_external
delete:
summary: ''
operationId: deleteApiCustomersCustomer_idOrderListsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Customers
parameters:
-
in: path
name: customer_id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the order list.'
example: dolorem
required: true
schema:
type: string
'/api/customer-organization/{customer_organization}/restore':
put:
summary: ''
operationId: putApiCustomerOrganizationCustomer_organizationRestore
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1250
name: 'Bruingoed Expert IBC'
external_id: aa35c090-9bd3-348c-864c-f11ac75b5592
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1250
name:
type: string
example: 'Bruingoed Expert IBC'
external_id:
type: string
example: aa35c090-9bd3-348c-864c-f11ac75b5592
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Customers
parameters:
-
in: path
name: customer_organization
description: ''
example: 1
required: true
schema:
type: integer
'/api/customer/{customer}/restore':
put:
summary: ''
operationId: putApiCustomerCustomerRestore
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 3358
customer_organization_id: 1251
debtor_number: 4828
customer_number: 806c4fa6-c32e-3dc2-b16f-2166963b30e2
name: 'Kookdump IBC'
city: null
address: null
postal_code: null
phone_number: null
mobile_number: '+905672541463'
price_code: 2
sector: slijterij
free_market: true
stock_information_allowed: true
assortment_number: 3
delivery_day: 5
actions: false
invoice_name: null
invoice_city: null
invoice_address: 'de Bruinpad 7757'
invoice_postal_code: 4698BG
invoice_email: null
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
properties:
data:
type: object
properties:
id:
type: integer
example: 3358
customer_organization_id:
type: integer
example: 1251
debtor_number:
type: integer
example: 4828
customer_number:
type: string
example: 806c4fa6-c32e-3dc2-b16f-2166963b30e2
name:
type: string
example: 'Kookdump IBC'
city:
type: string
example: null
address:
type: string
example: null
postal_code:
type: string
example: null
phone_number:
type: string
example: null
mobile_number:
type: string
example: '+905672541463'
price_code:
type: integer
example: 2
sector:
type: string
example: slijterij
free_market:
type: boolean
example: true
stock_information_allowed:
type: boolean
example: true
assortment_number:
type: integer
example: 3
delivery_day:
type: integer
example: 5
actions:
type: boolean
example: false
invoice_name:
type: string
example: null
invoice_city:
type: string
example: null
invoice_address:
type: string
example: 'de Bruinpad 7757'
invoice_postal_code:
type: string
example: 4698BG
invoice_email:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
deleted_at:
type: string
example: null
tags:
- Customers
parameters:
-
in: path
name: customer
description: 'The customer.'
example: 1
required: true
schema:
type: integer
'/api/customer-order-lists/{customer_id}/bulk':
post:
summary: ''
operationId: postApiCustomerOrderListsCustomer_idBulk
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: 'Insert as bulk'
content:
text/plain:
schema:
type: string
example: 'null'
tags:
- Customers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_ids:
type: array
description: ''
example:
- voluptatum
items:
type: string
required:
- product_ids
parameters:
-
in: path
name: customer_id
description: 'The ID of the customer.'
example: 1
required: true
schema:
type: integer
/api/forgot-password:
post:
summary: ''
operationId: postApiForgotPassword
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: maurice.robel@example.net
username:
type: string
description: ''
example: velit
required:
- email
- username
/api/reset-password:
post:
summary: ''
operationId: postApiResetPassword
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: ''
example: mollitia
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: vcummings@example.org
token:
type: string
description: ''
example: qui
password:
type: string
description: ':Attribute moet minimaal 8 tekens zijn.'
example: '~X''k->F58aN?SC"'
password_confirmation:
type: string
description: ':Attribute moet minimaal 8 tekens zijn.'
example: innfsotebjepwsfrqeaxujimkkosyyqxfxdomureyuehybfdxhlakntlrswmimzrsgyruzgdvtgomwdl
required:
- username
- email
- token
- password
- password_confirmation
/api/request-account:
post:
summary: ''
operationId: postApiRequestAccount
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
company_name:
type: string
description: ''
example: qui
customer_number:
type: string
description: ''
example: nobis
address:
type: string
description: ''
example: iure
postal_code:
type: string
description: ''
example: est
place:
type: string
description: ''
example: sapiente
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: kmueller@example.com
required:
- company_name
- address
- postal_code
- place
- email
'/api/frontend/cms/page/{tag}':
get:
summary: ''
operationId: getApiFrontendCmsPageTag
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: tag
description: ''
example: ea
required: true
schema:
type: string
'/api/orders/{order_id}/csv':
get:
summary: ''
operationId: getApiOrdersOrder_idCsv
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: order_id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
'/api/orders/{order_id}/pdf':
get:
summary: ''
operationId: getApiOrdersOrder_idPdf
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: order_id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
/api/action-prices/truncate:
delete:
summary: ''
operationId: deleteApiActionPricesTruncate
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: 'No content'
tags:
- Endpoints
/api/frontend/representative-order-rows:
get:
summary: ''
operationId: getApiFrontendRepresentativeOrderRows
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 30294
article_number: 56
customer_id: 3365
ordered: 38
description: sed
delivered: 86
content: 53.13262
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 30295
article_number: 95
customer_id: 3366
ordered: 54
description: vitae
delivered: 80
content: 42.60398
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 30294
article_number: 56
customer_id: 3365
ordered: 38
description: sed
delivered: 86
content: 53.13262
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 30295
article_number: 95
customer_id: 3366
ordered: 54
description: vitae
delivered: 80
content: 42.60398
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 30294
article_number:
type: integer
example: 56
customer_id:
type: integer
example: 3365
ordered:
type: integer
example: 38
description:
type: string
example: sed
delivered:
type: integer
example: 86
content:
type: number
example: 53.13262
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Endpoints
/api/frontend/product-filters:
get:
summary: ''
operationId: getApiFrontendProductFilters
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/frontend/users:
get:
summary: ''
operationId: getApiFrontendUsers
description: ''
parameters:
-
in: query
name: query
description: 'Search query'
example: veritatis
required: true
schema:
type: string
description: 'Search query'
example: veritatis
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
links:
first: '/?page=1'
last: '/?page=2'
prev: null
next: '/?page=2'
meta:
current_page: 1
from: 1
last_page: 2
links:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
path: /
per_page: 1
to: 1
total: 2
properties:
data:
type: array
example:
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
items:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: Brix
last_name:
type: string
example: CRM
username:
type: string
example: brix
email:
type: string
example: admin@brixcrm.nl
customer_id:
type: integer
example: 1
role_id:
type: integer
example: 1
role:
type: object
properties:
id:
type: integer
example: 1
type:
type: string
example: admin
name:
type: string
example: Admin
order_email:
type: string
example: admin@brixcrm.nl
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=2'
prev:
type: string
example: null
next:
type: string
example: '/?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 2
links:
type: array
example:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Vorige'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 1
to:
type: integer
example: 1
total:
type: integer
example: 2
tags:
- Endpoints
'/api/frontend/users/{user}/act-as':
post:
summary: ''
operationId: postApiFrontendUsersUserActAs
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: user
description: 'The user.'
example: 1
required: true
schema:
type: integer
/api/frontend/users/me:
get:
summary: ''
operationId: getApiFrontendUsersMe
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/frontend/cms/landing-page/{slug}':
get:
summary: ''
operationId: getApiFrontendCmsLandingPageSlug
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: slug
description: 'The slug of the landing page.'
example: autem
required: true
schema:
type: string
'/api/frontend/cms/partner-page/{slug}':
get:
summary: ''
operationId: getApiFrontendCmsPartnerPageSlug
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: slug
description: 'The slug of the partner page.'
example: aperiam
required: true
schema:
type: string
/api/frontend/cms/customer-pages:
get:
summary: ''
operationId: getApiFrontendCmsCustomerPages
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/representative-order-rows:
get:
summary: ''
operationId: getApiRepresentativeOrderRows
description: ''
parameters:
-
in: query
name: customer_id
description: 'Filter by customer ID'
example: 3
required: true
schema:
type: integer
description: 'Filter by customer ID'
example: 3
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 30289
article_number: 26
customer_id: 3343
ordered: 93
description: et
delivered: 12
content: 62.65694
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 30290
article_number: 33
customer_id: 3344
ordered: 69
description: doloremque
delivered: 45
content: 57.70196
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 30289
article_number: 26
customer_id: 3343
ordered: 93
description: et
delivered: 12
content: 62.65694
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 30290
article_number: 33
customer_id: 3344
ordered: 69
description: doloremque
delivered: 45
content: 57.70196
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 30289
article_number:
type: integer
example: 26
customer_id:
type: integer
example: 3343
ordered:
type: integer
example: 93
description:
type: string
example: et
delivered:
type: integer
example: 12
content:
type: number
example: 62.65694
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
post:
summary: ''
operationId: postApiRepresentativeOrderRows
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 30291
article_number: 56
customer_id: 3345
ordered: 40
description: voluptates
delivered: 96
content: 85.70308
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 30291
article_number:
type: integer
example: 56
customer_id:
type: integer
example: 3345
ordered:
type: integer
example: 40
description:
type: string
example: voluptates
delivered:
type: integer
example: 96
content:
type: number
example: 85.70308
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
article_number:
type: string
description: ':Attribute moet minimaal 1 tekens zijn.'
example: nvywbmikbuvqlgbosaubreaxadzmvmrdrhokaipcvsxvnpjiivfacgqakelwxhjxswgnkywgisjlj
customer_id:
type: string
description: ''
example: consequatur
ordered:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 69
description:
type: string
description: ':Attribute moet minimaal 1 tekens zijn.'
example: 'Nobis rerum voluptatem incidunt sint dolorum quas dolor nihil.'
delivered:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 88
content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 41
required:
- article_number
- customer_id
- ordered
- description
- delivered
- content
'/api/representative-order-rows/{id}':
get:
summary: ''
operationId: getApiRepresentativeOrderRowsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 30292
article_number: 55
customer_id: 3346
ordered: 40
description: error
delivered: 37
content: 15.4859
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 30292
article_number:
type: integer
example: 55
customer_id:
type: integer
example: 3346
ordered:
type: integer
example: 40
description:
type: string
example: error
delivered:
type: integer
example: 37
content:
type: number
example: 15.4859
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
put:
summary: ''
operationId: putApiRepresentativeOrderRowsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 30293
article_number: 1
customer_id: 3347
ordered: 98
description: aut
delivered: 78
content: 56.87066
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 30293
article_number:
type: integer
example: 1
customer_id:
type: integer
example: 3347
ordered:
type: integer
example: 98
description:
type: string
example: aut
delivered:
type: integer
example: 78
content:
type: number
example: 56.87066
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
article_number:
type: string
description: ':Attribute moet minimaal 1 tekens zijn.'
example: lprcoaxnleclcgabybuoavc
customer_id:
type: string
description: ''
example: vel
ordered:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 44
description:
type: string
description: ':Attribute moet minimaal 1 tekens zijn.'
example: 'Similique nesciunt numquam rerum officiis vitae atque.'
delivered:
type: integer
description: ':Attribute moet minimaal 0 zijn.'
example: 73
content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 31
required:
- article_number
- customer_id
- ordered
- description
- delivered
- content
delete:
summary: ''
operationId: deleteApiRepresentativeOrderRowsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Orders
parameters:
-
in: path
name: id
description: 'The ID of the representative order row.'
example: 28720
required: true
schema:
type: integer
/api/orders:
get:
summary: ''
operationId: getApiOrders
description: ''
parameters:
-
in: query
name: page
description: 'The page number to load'
example: 5
required: true
schema:
type: integer
description: 'The page number to load'
example: 5
-
in: query
name: customer_id
description: 'The ID of the customer to filter by'
example: 11
required: true
schema:
type: integer
description: 'The ID of the customer to filter by'
example: 11
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 329
customer_id: 3348
foreign_id: 6f3509fb-276a-3912-8dcb-6dd0dc010187
confirmed_at: null
delivery_at: '2020-03-09T00:00:00.000000Z'
comments: 'Quidem ipsa sed cumque et voluptatibus ut.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 330
customer_id: 3349
foreign_id: f97a935f-f2e5-3489-8da9-3d693026f01d
confirmed_at: null
delivery_at: '2012-11-21T00:00:00.000000Z'
comments: 'Voluptate quibusdam possimus dolores consequuntur adipisci rem.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 329
customer_id: 3348
foreign_id: 6f3509fb-276a-3912-8dcb-6dd0dc010187
confirmed_at: null
delivery_at: '2020-03-09T00:00:00.000000Z'
comments: 'Quidem ipsa sed cumque et voluptatibus ut.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 330
customer_id: 3349
foreign_id: f97a935f-f2e5-3489-8da9-3d693026f01d
confirmed_at: null
delivery_at: '2012-11-21T00:00:00.000000Z'
comments: 'Voluptate quibusdam possimus dolores consequuntur adipisci rem.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 329
customer_id:
type: integer
example: 3348
foreign_id:
type: string
example: 6f3509fb-276a-3912-8dcb-6dd0dc010187
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '2020-03-09T00:00:00.000000Z'
comments:
type: string
example: 'Quidem ipsa sed cumque et voluptatibus ut.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
post:
summary: ''
operationId: postApiOrders
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 331
customer_id: 3350
foreign_id: c83d28db-0976-3217-ad27-dd456af4e2eb
confirmed_at: '2014-09-05T22:08:55.000000Z'
delivery_at: '2007-04-07T00:00:00.000000Z'
comments: 'Cum iste quibusdam asperiores doloremque autem nesciunt.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 331
customer_id:
type: integer
example: 3350
foreign_id:
type: string
example: c83d28db-0976-3217-ad27-dd456af4e2eb
confirmed_at:
type: string
example: '2014-09-05T22:08:55.000000Z'
delivery_at:
type: string
example: '2007-04-07T00:00:00.000000Z'
comments:
type: string
example: 'Cum iste quibusdam asperiores doloremque autem nesciunt.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: ''
example: magni
foreign_id:
type: string
description: ''
example: aspernatur
confirmed_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:19'
delivery_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na of gelijk aan tomorrow zijn.'
example: '2054-04-28'
comments:
type: string
description: ''
example: quam
required:
- customer_id
- foreign_id
- delivery_at
'/api/orders/{id}':
get:
summary: ''
operationId: getApiOrdersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 332
customer_id: 3351
foreign_id: be819c00-865b-33fc-a116-599e8c62ce8f
confirmed_at: null
delivery_at: '1975-05-24T00:00:00.000000Z'
comments: 'Ex deleniti facilis odio iusto nostrum deleniti exercitationem.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 332
customer_id:
type: integer
example: 3351
foreign_id:
type: string
example: be819c00-865b-33fc-a116-599e8c62ce8f
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '1975-05-24T00:00:00.000000Z'
comments:
type: string
example: 'Ex deleniti facilis odio iusto nostrum deleniti exercitationem.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
put:
summary: ''
operationId: putApiOrdersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 333
customer_id: 3352
foreign_id: 69df501c-d681-33f1-9a7d-01e680deb121
confirmed_at: null
delivery_at: '1971-10-29T00:00:00.000000Z'
comments: 'Sed voluptas tenetur laudantium dicta molestiae modi.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 333
customer_id:
type: integer
example: 3352
foreign_id:
type: string
example: 69df501c-d681-33f1-9a7d-01e680deb121
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '1971-10-29T00:00:00.000000Z'
comments:
type: string
example: 'Sed voluptas tenetur laudantium dicta molestiae modi.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: ''
example: iusto
foreign_id:
type: string
description: ''
example: sed
confirmed_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:19'
delivery_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na of gelijk aan tomorrow zijn.'
example: '2083-02-06'
comments:
type: string
description: ''
example: quae
required:
- customer_id
- foreign_id
- delivery_at
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
'/api/orders/{order_id}/rows':
get:
summary: ''
operationId: getApiOrdersOrder_idRows
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 263
order_id: 334
product_id: 13110
product_external_id: 73814
product_name: itaque
single_price: 16
total_price: 96
quantity: 6
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 264
order_id: 335
product_id: 13111
product_external_id: 43294
product_name: voluptas
single_price: 10
total_price: 70
quantity: 7
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 263
order_id: 334
product_id: 13110
product_external_id: 73814
product_name: itaque
single_price: 16
total_price: 96
quantity: 6
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 264
order_id: 335
product_id: 13111
product_external_id: 43294
product_name: voluptas
single_price: 10
total_price: 70
quantity: 7
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 263
order_id:
type: integer
example: 334
product_id:
type: integer
example: 13110
product_external_id:
type: integer
example: 73814
product_name:
type: string
example: itaque
single_price:
type: integer
example: 16
total_price:
type: integer
example: 96
quantity:
type: integer
example: 6
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
post:
summary: ''
operationId: postApiOrdersOrder_idRows
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 336
customer_id: 3355
foreign_id: d191e7a4-5f10-36b8-89b8-c7b2be3b023e
confirmed_at: '2001-05-30T12:17:39.000000Z'
delivery_at: '1996-01-09T00:00:00.000000Z'
comments: 'Aut possimus et magni unde culpa dolore qui.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 336
customer_id:
type: integer
example: 3355
foreign_id:
type: string
example: d191e7a4-5f10-36b8-89b8-c7b2be3b023e
confirmed_at:
type: string
example: '2001-05-30T12:17:39.000000Z'
delivery_at:
type: string
example: '1996-01-09T00:00:00.000000Z'
comments:
type: string
example: 'Aut possimus et magni unde culpa dolore qui.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: ''
example: qui
quantity:
type: integer
description: ':Attribute moet minimaal 1 zijn.'
example: 46
required:
- product_id
- quantity
parameters:
-
in: path
name: order_id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
'/api/orders/{order_id}/rows/{id}':
put:
summary: ''
operationId: putApiOrdersOrder_idRowsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 337
customer_id: 3356
foreign_id: 9468f006-3b49-3651-9fca-05bfff22e1de
confirmed_at: null
delivery_at: '1975-12-16T00:00:00.000000Z'
comments: 'Et qui cupiditate tenetur alias consequatur.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 337
customer_id:
type: integer
example: 3356
foreign_id:
type: string
example: 9468f006-3b49-3651-9fca-05bfff22e1de
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '1975-12-16T00:00:00.000000Z'
comments:
type: string
example: 'Et qui cupiditate tenetur alias consequatur.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
product_id:
type: string
description: ''
example: illum
quantity:
type: integer
description: ':Attribute moet minimaal 1 zijn.'
example: 9
required:
- product_id
- quantity
delete:
summary: ''
operationId: deleteApiOrdersOrder_idRowsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 338
customer_id: 3357
foreign_id: 2ef549a2-4cc6-389a-8cec-29007e7d350a
confirmed_at: null
delivery_at: '1977-04-14T00:00:00.000000Z'
comments: 'Sunt aut ut eveniet ut.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 338
customer_id:
type: integer
example: 3357
foreign_id:
type: string
example: 2ef549a2-4cc6-389a-8cec-29007e7d350a
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '1977-04-14T00:00:00.000000Z'
comments:
type: string
example: 'Sunt aut ut eveniet ut.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
parameters:
-
in: path
name: order_id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the row.'
example: alias
required: true
schema:
type: string
/api/representative-order-rows-truncate:
delete:
summary: ''
operationId: deleteApiRepresentativeOrderRowsTruncate
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Orders
/api/frontend/orders/open:
get:
summary: ''
operationId: getApiFrontendOrdersOpen
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 339
customer_id: 3359
foreign_id: 42c20c52-bcf6-38a0-a2da-0ce0b0b26d4b
confirmed_at: '1990-09-21T11:14:34.000000Z'
delivery_at: '2022-05-27T00:00:00.000000Z'
comments: 'Laborum est quos molestiae sed eum.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 339
customer_id:
type: integer
example: 3359
foreign_id:
type: string
example: 42c20c52-bcf6-38a0-a2da-0ce0b0b26d4b
confirmed_at:
type: string
example: '1990-09-21T11:14:34.000000Z'
delivery_at:
type: string
example: '2022-05-27T00:00:00.000000Z'
comments:
type: string
example: 'Laborum est quos molestiae sed eum.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 340
customer_id: 3360
foreign_id: 91dfe6fe-3aff-35fc-b71c-95409c92b261
confirmed_at: null
delivery_at: '2004-08-23T00:00:00.000000Z'
comments: 'Ipsum assumenda non repudiandae.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 340
customer_id:
type: integer
example: 3360
foreign_id:
type: string
example: 91dfe6fe-3aff-35fc-b71c-95409c92b261
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '2004-08-23T00:00:00.000000Z'
comments:
type: string
example: 'Ipsum assumenda non repudiandae.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
/api/frontend/orders:
get:
summary: ''
operationId: getApiFrontendOrders
description: ''
parameters:
-
in: query
name: search
description: 'Search by order number, delivery_at or confirmed_at'
example: eius
required: true
schema:
type: string
description: 'Search by order number, delivery_at or confirmed_at'
example: eius
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 341
customer_id: 3361
foreign_id: 64083ac7-b15e-3e73-bab6-c70f145955f1
confirmed_at: null
delivery_at: '1982-06-23T00:00:00.000000Z'
comments: 'Ratione fugiat beatae ab architecto placeat voluptatem explicabo.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
links:
first: '/?page=1'
last: '/?page=2'
prev: null
next: '/?page=2'
meta:
current_page: 1
from: 1
last_page: 2
links:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
path: /
per_page: 1
to: 1
total: 2
properties:
data:
type: array
example:
-
id: 341
customer_id: 3361
foreign_id: 64083ac7-b15e-3e73-bab6-c70f145955f1
confirmed_at: null
delivery_at: '1982-06-23T00:00:00.000000Z'
comments: 'Ratione fugiat beatae ab architecto placeat voluptatem explicabo.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 341
customer_id:
type: integer
example: 3361
foreign_id:
type: string
example: 64083ac7-b15e-3e73-bab6-c70f145955f1
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '1982-06-23T00:00:00.000000Z'
comments:
type: string
example: 'Ratione fugiat beatae ab architecto placeat voluptatem explicabo.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=2'
prev:
type: string
example: null
next:
type: string
example: '/?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 2
links:
type: array
example:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Vorige'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 1
to:
type: integer
example: 1
total:
type: integer
example: 2
tags:
- Orders
'/api/frontend/orders/{id}':
put:
summary: ''
operationId: putApiFrontendOrdersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 343
customer_id: 3363
foreign_id: 9af50234-fe25-378a-9eb7-ef5ceb6a6529
confirmed_at: '1988-12-03T02:57:24.000000Z'
delivery_at: '2019-02-20T00:00:00.000000Z'
comments: 'Sunt odio porro ullam veniam magni libero alias commodi.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 343
customer_id:
type: integer
example: 3363
foreign_id:
type: string
example: 9af50234-fe25-378a-9eb7-ef5ceb6a6529
confirmed_at:
type: string
example: '1988-12-03T02:57:24.000000Z'
delivery_at:
type: string
example: '2019-02-20T00:00:00.000000Z'
comments:
type: string
example: 'Sunt odio porro ullam veniam magni libero alias commodi.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
delivery_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na of gelijk aan today zijn.'
example: '2115-06-27'
comments:
type: string
description: ''
example: voluptatem
required:
- delivery_at
parameters:
-
in: path
name: id
description: 'The ID of the order.'
example: 1
required: true
schema:
type: integer
'/api/frontend/orders/{order}/confirm':
post:
summary: ''
operationId: postApiFrontendOrdersOrderConfirm
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Orders
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
comments:
type: string
description: ''
example: accusamus
parameters:
-
in: path
name: order
description: 'The order.'
example: 1
required: true
schema:
type: integer
'/api/frontend/orders/{order}/clear':
post:
summary: ''
operationId: postApiFrontendOrdersOrderClear
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 344
customer_id: 3364
foreign_id: ecb8f745-c70d-3e1d-9813-5163d9f36132
confirmed_at: null
delivery_at: '2008-06-23T00:00:00.000000Z'
comments: 'Nesciunt architecto omnis corrupti qui et et vitae.'
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 344
customer_id:
type: integer
example: 3364
foreign_id:
type: string
example: ecb8f745-c70d-3e1d-9813-5163d9f36132
confirmed_at:
type: string
example: null
delivery_at:
type: string
example: '2008-06-23T00:00:00.000000Z'
comments:
type: string
example: 'Nesciunt architecto omnis corrupti qui et et vitae.'
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Orders
parameters:
-
in: path
name: order
description: 'The order.'
example: 1
required: true
schema:
type: integer
/api/products:
get:
summary: ''
operationId: getApiProducts
description: ''
parameters:
-
in: query
name: page
description: 'The page number'
example: 1
required: true
schema:
type: integer
description: 'The page number'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 13090
supplier_id: 1399
product_group_id: 2045
customer_organization_id: null
external_id: 33dbb63f-1c87-3b24-b1a7-1f3d967435b5
name: qui
courant_price: null
advice_price: 90.72
vat_type: 1
stock_code: R
tlo: true
restocked_at: '2023-10-07T12:27:21.000000Z'
box_content: 16
content: 19118.3
free_market: true
package_deposit: 8.66
price_list_description: null
alcohol: 76.7
unit: null
ean_1: '7009055403098'
ean_2: null
ean_3: '1290211543475'
discount: true
own_import: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/33dbb63f-1c87-3b24-b1a7-1f3d967435b5.png'
-
id: 13091
supplier_id: 1400
product_group_id: 2047
customer_organization_id: null
external_id: dbaf4d4f-a910-3542-aa61-84ef94b91591
name: deleniti
courant_price: null
advice_price: 96.99
vat_type: 2
stock_code: G
tlo: true
restocked_at: '2024-05-02T01:48:10.000000Z'
box_content: 11
content: 24
free_market: false
package_deposit: 8.52
price_list_description: null
alcohol: 34.03
unit: KRAT
ean_1: null
ean_2: null
ean_3: '0180526296849'
discount: true
own_import: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/dbaf4d4f-a910-3542-aa61-84ef94b91591.png'
properties:
data:
type: array
example:
-
id: 13090
supplier_id: 1399
product_group_id: 2045
customer_organization_id: null
external_id: 33dbb63f-1c87-3b24-b1a7-1f3d967435b5
name: qui
courant_price: null
advice_price: 90.72
vat_type: 1
stock_code: R
tlo: true
restocked_at: '2023-10-07T12:27:21.000000Z'
box_content: 16
content: 19118.3
free_market: true
package_deposit: 8.66
price_list_description: null
alcohol: 76.7
unit: null
ean_1: '7009055403098'
ean_2: null
ean_3: '1290211543475'
discount: true
own_import: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/33dbb63f-1c87-3b24-b1a7-1f3d967435b5.png'
-
id: 13091
supplier_id: 1400
product_group_id: 2047
customer_organization_id: null
external_id: dbaf4d4f-a910-3542-aa61-84ef94b91591
name: deleniti
courant_price: null
advice_price: 96.99
vat_type: 2
stock_code: G
tlo: true
restocked_at: '2024-05-02T01:48:10.000000Z'
box_content: 11
content: 24
free_market: false
package_deposit: 8.52
price_list_description: null
alcohol: 34.03
unit: KRAT
ean_1: null
ean_2: null
ean_3: '0180526296849'
discount: true
own_import: true
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/dbaf4d4f-a910-3542-aa61-84ef94b91591.png'
items:
type: object
properties:
id:
type: integer
example: 13090
supplier_id:
type: integer
example: 1399
product_group_id:
type: integer
example: 2045
customer_organization_id:
type: string
example: null
external_id:
type: string
example: 33dbb63f-1c87-3b24-b1a7-1f3d967435b5
name:
type: string
example: qui
courant_price:
type: string
example: null
advice_price:
type: number
example: 90.72
vat_type:
type: integer
example: 1
stock_code:
type: string
example: R
tlo:
type: boolean
example: true
restocked_at:
type: string
example: '2023-10-07T12:27:21.000000Z'
box_content:
type: integer
example: 16
content:
type: number
example: 19118.3
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 8.66
price_list_description:
type: string
example: null
alcohol:
type: number
example: 76.7
unit:
type: string
example: null
ean_1:
type: string
example: '7009055403098'
ean_2:
type: string
example: null
ean_3:
type: string
example: '1290211543475'
discount:
type: boolean
example: true
own_import:
type: boolean
example: true
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/33dbb63f-1c87-3b24-b1a7-1f3d967435b5.png'
tags:
- Products
post:
summary: ''
operationId: postApiProducts
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 13092
supplier_id: 1401
product_group_id: 2049
customer_organization_id: null
external_id: e9ac8648-f4c2-354b-b5c4-728e783877d2
name: inventore
courant_price: null
advice_price: 27.32
vat_type: 1
stock_code: O
tlo: true
restocked_at: null
box_content: 20
content: 39.4
free_market: true
package_deposit: 9.15
price_list_description: 'Sed impedit iusto libero provident rerum sint.'
alcohol: 9.72
unit: KIST
ean_1: null
ean_2: null
ean_3: null
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/e9ac8648-f4c2-354b-b5c4-728e783877d2.png'
properties:
data:
type: object
properties:
id:
type: integer
example: 13092
supplier_id:
type: integer
example: 1401
product_group_id:
type: integer
example: 2049
customer_organization_id:
type: string
example: null
external_id:
type: string
example: e9ac8648-f4c2-354b-b5c4-728e783877d2
name:
type: string
example: inventore
courant_price:
type: string
example: null
advice_price:
type: number
example: 27.32
vat_type:
type: integer
example: 1
stock_code:
type: string
example: O
tlo:
type: boolean
example: true
restocked_at:
type: string
example: null
box_content:
type: integer
example: 20
content:
type: number
example: 39.4
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 9.15
price_list_description:
type: string
example: 'Sed impedit iusto libero provident rerum sint.'
alcohol:
type: number
example: 9.72
unit:
type: string
example: KIST
ean_1:
type: string
example: null
ean_2:
type: string
example: null
ean_3:
type: string
example: null
discount:
type: boolean
example: false
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/e9ac8648-f4c2-354b-b5c4-728e783877d2.png'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
supplier_id:
type: string
description: ''
example: impedit
product_group_id:
type: string
description: ''
example: null
customer_organization_id:
type: string
description: ''
example: null
external_id:
type: string
description: ''
example: aut
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: hecyppjadbirszgyhblv
price_0:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 66
price_1:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 43
price_2:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 62
advice_price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 8
vat_type:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 11
stock_code:
type: string
description: 'Must be one of G, O, or R.'
example: O
restocked_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
box_content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 77
package_deposit:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 4
content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 57
price_list_description:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: yafrsvlkceuan
alcohol:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 63
unit:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: jzoedydhhjo
ean_1:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: zkl
ean_2:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: qysbi
ean_3:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: qysutblvemadxyf
discount:
type: boolean
description: ''
example: false
free_market:
type: boolean
description: ''
example: true
own_import:
type: boolean
description: ''
example: true
tlo:
type: boolean
description: ''
example: true
required:
- supplier_id
- external_id
- name
- price_0
- price_1
- price_2
- advice_price
- vat_type
- stock_code
- box_content
- package_deposit
- content
- alcohol
- discount
- free_market
- own_import
- tlo
'/api/products/{id}':
get:
summary: ''
operationId: getApiProductsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 13093
supplier_id: 1402
product_group_id: 2051
customer_organization_id: null
external_id: c8945ea1-8c7d-3f4b-87a2-9c19f097d08e
name: cum
courant_price: null
advice_price: 46.79
vat_type: 2
stock_code: O
tlo: true
restocked_at: '2024-02-17T09:03:47.000000Z'
box_content: 19
content: 977.2
free_market: false
package_deposit: 1.47
price_list_description: null
alcohol: 2.19
unit: VAT
ean_1: '6647153310149'
ean_2: '0915078374901'
ean_3: '1393154459367'
discount: false
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/c8945ea1-8c7d-3f4b-87a2-9c19f097d08e.png'
properties:
data:
type: object
properties:
id:
type: integer
example: 13093
supplier_id:
type: integer
example: 1402
product_group_id:
type: integer
example: 2051
customer_organization_id:
type: string
example: null
external_id:
type: string
example: c8945ea1-8c7d-3f4b-87a2-9c19f097d08e
name:
type: string
example: cum
courant_price:
type: string
example: null
advice_price:
type: number
example: 46.79
vat_type:
type: integer
example: 2
stock_code:
type: string
example: O
tlo:
type: boolean
example: true
restocked_at:
type: string
example: '2024-02-17T09:03:47.000000Z'
box_content:
type: integer
example: 19
content:
type: number
example: 977.2
free_market:
type: boolean
example: false
package_deposit:
type: number
example: 1.47
price_list_description:
type: string
example: null
alcohol:
type: number
example: 2.19
unit:
type: string
example: VAT
ean_1:
type: string
example: '6647153310149'
ean_2:
type: string
example: '0915078374901'
ean_3:
type: string
example: '1393154459367'
discount:
type: boolean
example: false
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/c8945ea1-8c7d-3f4b-87a2-9c19f097d08e.png'
tags:
- Products
put:
summary: ''
operationId: putApiProductsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 13094
supplier_id: 1403
product_group_id: 2053
customer_organization_id: null
external_id: 166c43cc-873d-32a8-8510-8d2546e0f8ae
name: asperiores
courant_price: null
advice_price: 1.83
vat_type: 0
stock_code: O
tlo: false
restocked_at: null
box_content: 3
content: 301886656.4
free_market: true
package_deposit: 6.85
price_list_description: null
alcohol: 35.36
unit: null
ean_1: '6493077507901'
ean_2: '1886057641422'
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/166c43cc-873d-32a8-8510-8d2546e0f8ae.png'
properties:
data:
type: object
properties:
id:
type: integer
example: 13094
supplier_id:
type: integer
example: 1403
product_group_id:
type: integer
example: 2053
customer_organization_id:
type: string
example: null
external_id:
type: string
example: 166c43cc-873d-32a8-8510-8d2546e0f8ae
name:
type: string
example: asperiores
courant_price:
type: string
example: null
advice_price:
type: number
example: 1.83
vat_type:
type: integer
example: 0
stock_code:
type: string
example: O
tlo:
type: boolean
example: false
restocked_at:
type: string
example: null
box_content:
type: integer
example: 3
content:
type: number
example: 301886656.4
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 6.85
price_list_description:
type: string
example: null
alcohol:
type: number
example: 35.36
unit:
type: string
example: null
ean_1:
type: string
example: '6493077507901'
ean_2:
type: string
example: '1886057641422'
ean_3:
type: string
example: null
discount:
type: boolean
example: true
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/166c43cc-873d-32a8-8510-8d2546e0f8ae.png'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
supplier_id:
type: string
description: ''
example: temporibus
product_group_id:
type: string
description: ''
example: null
customer_organization_id:
type: string
description: ''
example: null
external_id:
type: string
description: ''
example: placeat
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: xduslnsq
price_0:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 33
price_1:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 4
price_2:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 41
advice_price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 60
vat_type:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 55
stock_code:
type: string
description: 'Must be one of G, O, or R.'
example: R
restocked_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
box_content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 26
package_deposit:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 22
content:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 22
price_list_description:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: scsttyycbrdza
alcohol:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 70
unit:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: ytlrlikzayiej
ean_1:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: vanocyqs
ean_2:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: mhpzux
ean_3:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: liipzcwd
discount:
type: boolean
description: ''
example: true
free_market:
type: boolean
description: ''
example: true
own_import:
type: boolean
description: ''
example: false
tlo:
type: boolean
description: ''
example: true
required:
- supplier_id
- external_id
- name
- price_0
- price_1
- price_2
- advice_price
- vat_type
- stock_code
- box_content
- package_deposit
- content
- alcohol
- discount
- free_market
- own_import
- tlo
delete:
summary: ''
operationId: deleteApiProductsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Products
parameters:
-
in: path
name: id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
'/api/products/{product_id}/price-updates':
get:
summary: ''
operationId: getApiProductsProduct_idPriceUpdates
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 2913
product_id: 13095
active_at: '2025-05-21T23:39:33.000000Z'
price_0: 27.15
price_1: 2.3
price_2: 24.84
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 2914
product_id: 13096
active_at: '2024-11-16T18:39:32.000000Z'
price_0: 22.07
price_1: 33.9
price_2: 87.17
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: array
example:
-
id: 2913
product_id: 13095
active_at: '2025-05-21T23:39:33.000000Z'
price_0: 27.15
price_1: 2.3
price_2: 24.84
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 2914
product_id: 13096
active_at: '2024-11-16T18:39:32.000000Z'
price_0: 22.07
price_1: 33.9
price_2: 87.17
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2913
product_id:
type: integer
example: 13095
active_at:
type: string
example: '2025-05-21T23:39:33.000000Z'
price_0:
type: number
example: 27.15
price_1:
type: number
example: 2.3
price_2:
type: number
example: 24.84
customer_price:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
post:
summary: ''
operationId: postApiProductsProduct_idPriceUpdates
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2915
product_id: 13097
active_at: '2025-06-16T18:14:13.000000Z'
price_0: 14
price_1: 88.28
price_2: 89.47
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2915
product_id:
type: integer
example: 13097
active_at:
type: string
example: '2025-06-16T18:14:13.000000Z'
price_0:
type: integer
example: 14
price_1:
type: number
example: 88.28
price_2:
type: number
example: 89.47
customer_price:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
active_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
price_0:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 11
price_1:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 21
price_2:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 55
required:
- active_at
- price_0
- price_1
- price_2
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
'/api/products/{product_id}/price-updates/{id}':
get:
summary: ''
operationId: getApiProductsProduct_idPriceUpdatesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2916
product_id: 13098
active_at: '2024-11-24T08:29:13.000000Z'
price_0: 14.26
price_1: 10.25
price_2: 8.86
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2916
product_id:
type: integer
example: 13098
active_at:
type: string
example: '2024-11-24T08:29:13.000000Z'
price_0:
type: number
example: 14.26
price_1:
type: number
example: 10.25
price_2:
type: number
example: 8.86
customer_price:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
put:
summary: ''
operationId: putApiProductsProduct_idPriceUpdatesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2917
product_id: 13099
active_at: '2025-03-09T11:58:26.000000Z'
price_0: 74.47
price_1: 43.79
price_2: 19.8
customer_price: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2917
product_id:
type: integer
example: 13099
active_at:
type: string
example: '2025-03-09T11:58:26.000000Z'
price_0:
type: number
example: 74.47
price_1:
type: number
example: 43.79
price_2:
type: number
example: 19.8
customer_price:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
active_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
price_0:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 79
price_1:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 10
price_2:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 27
required:
- active_at
- price_0
- price_1
- price_2
delete:
summary: ''
operationId: deleteApiProductsProduct_idPriceUpdatesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Products
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the price update.'
example: sit
required: true
schema:
type: string
'/api/products/{product_id}/customer-prices':
get:
summary: ''
operationId: getApiProductsProduct_idCustomerPrices
description: ''
parameters:
-
in: query
name: page
description: 'Page number'
example: 1
required: true
schema:
type: integer
description: 'Page number'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 17378217
price: 47
min_quantity: 90
start_at: '2024-07-30T00:00:00.000000Z'
end_at: '2024-09-07T00:00:00.000000Z'
customer_id: 3333
product_id: 13100
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 17378218
price: 67.62
min_quantity: 8
start_at: '2024-08-14T00:00:00.000000Z'
end_at: '2024-08-16T00:00:00.000000Z'
customer_id: 3334
product_id: 13101
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: array
example:
-
id: 17378217
price: 47
min_quantity: 90
start_at: '2024-07-30T00:00:00.000000Z'
end_at: '2024-09-07T00:00:00.000000Z'
customer_id: 3333
product_id: 13100
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 17378218
price: 67.62
min_quantity: 8
start_at: '2024-08-14T00:00:00.000000Z'
end_at: '2024-08-16T00:00:00.000000Z'
customer_id: 3334
product_id: 13101
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
items:
type: object
properties:
id:
type: integer
example: 17378217
price:
type: integer
example: 47
min_quantity:
type: integer
example: 90
start_at:
type: string
example: '2024-07-30T00:00:00.000000Z'
end_at:
type: string
example: '2024-09-07T00:00:00.000000Z'
customer_id:
type: integer
example: 3333
product_id:
type: integer
example: 13100
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
post:
summary: ''
operationId: postApiProductsProduct_idCustomerPrices
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 17378219
price: 65.09
min_quantity: 34
start_at: '2024-10-15T00:00:00.000000Z'
end_at: '2024-10-25T00:00:00.000000Z'
customer_id: 3335
product_id: 13102
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 17378219
price:
type: number
example: 65.09
min_quantity:
type: integer
example: 34
start_at:
type: string
example: '2024-10-15T00:00:00.000000Z'
end_at:
type: string
example: '2024-10-25T00:00:00.000000Z'
customer_id:
type: integer
example: 3335
product_id:
type: integer
example: 13102
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 70
start_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
end_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na start_at zijn.'
example: '2112-07-31'
customer_id:
type: string
description: ''
example: ut
min_quantity:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 40
required:
- price
- start_at
- end_at
- customer_id
- min_quantity
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
'/api/products/{product_id}/customer-prices/{id}':
get:
summary: ''
operationId: getApiProductsProduct_idCustomerPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 17378220
price: 15.08
min_quantity: 3
start_at: '2024-08-12T00:00:00.000000Z'
end_at: '2024-09-25T00:00:00.000000Z'
customer_id: 3336
product_id: 13103
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 17378220
price:
type: number
example: 15.08
min_quantity:
type: integer
example: 3
start_at:
type: string
example: '2024-08-12T00:00:00.000000Z'
end_at:
type: string
example: '2024-09-25T00:00:00.000000Z'
customer_id:
type: integer
example: 3336
product_id:
type: integer
example: 13103
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
put:
summary: ''
operationId: putApiProductsProduct_idCustomerPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 17378221
price: 15.25
min_quantity: 58
start_at: '2024-09-14T00:00:00.000000Z'
end_at: '2024-10-26T00:00:00.000000Z'
customer_id: 3337
product_id: 13104
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 17378221
price:
type: number
example: 15.25
min_quantity:
type: integer
example: 58
start_at:
type: string
example: '2024-09-14T00:00:00.000000Z'
end_at:
type: string
example: '2024-10-26T00:00:00.000000Z'
customer_id:
type: integer
example: 3337
product_id:
type: integer
example: 13104
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 57
start_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:18'
end_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na start_at zijn.'
example: '2093-05-31'
customer_id:
type: string
description: ''
example: sit
min_quantity:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 0
required:
- price
- start_at
- end_at
- customer_id
- min_quantity
delete:
summary: ''
operationId: deleteApiProductsProduct_idCustomerPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Products
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the customer price.'
example: 14733163
required: true
schema:
type: integer
'/api/products/{product_id}/action-prices':
get:
summary: ''
operationId: getApiProductsProduct_idActionPrices
description: ''
parameters:
-
in: query
name: page
description: 'The page number of the results'
example: quia
required: true
schema:
type: string
description: 'The page number of the results'
example: quia
-
in: query
name: customer_id
description: 'When filled results will be scoped on customer'
example: in
required: true
schema:
type: string
description: 'When filled results will be scoped on customer'
example: in
-
in: query
name: customer_organization_id
description: 'When filled results will be scoped on customer organization'
example: adipisci
required: true
schema:
type: string
description: 'When filled results will be scoped on customer organization'
example: adipisci
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 12084
product_id: 13105
customer_id: 3338
customer_organization_id: 1226
price_code: null
price: 32.59
min_quantity: 25
start_at: '2024-10-03T00:00:00.000000Z'
end_at: '2024-10-05T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 12085
product_id: 13106
customer_id: 3339
customer_organization_id: 1228
price_code: 2
price: 87.83
min_quantity: 17
start_at: '2024-09-04T00:00:00.000000Z'
end_at: '2024-10-17T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 12084
product_id: 13105
customer_id: 3338
customer_organization_id: 1226
price_code: null
price: 32.59
min_quantity: 25
start_at: '2024-10-03T00:00:00.000000Z'
end_at: '2024-10-05T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 12085
product_id: 13106
customer_id: 3339
customer_organization_id: 1228
price_code: 2
price: 87.83
min_quantity: 17
start_at: '2024-09-04T00:00:00.000000Z'
end_at: '2024-10-17T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 12084
product_id:
type: integer
example: 13105
customer_id:
type: integer
example: 3338
customer_organization_id:
type: integer
example: 1226
price_code:
type: string
example: null
price:
type: number
example: 32.59
min_quantity:
type: integer
example: 25
start_at:
type: string
example: '2024-10-03T00:00:00.000000Z'
end_at:
type: string
example: '2024-10-05T00:00:00.000000Z'
current_action:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Products
post:
summary: ''
operationId: postApiProductsProduct_idActionPrices
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 12086
product_id: 13107
customer_id: 3340
customer_organization_id: 1230
price_code: null
price: 38.85
min_quantity: 8
start_at: '2024-10-06T00:00:00.000000Z'
end_at: '2024-10-07T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 12086
product_id:
type: integer
example: 13107
customer_id:
type: integer
example: 3340
customer_organization_id:
type: integer
example: 1230
price_code:
type: string
example: null
price:
type: number
example: 38.85
min_quantity:
type: integer
example: 8
start_at:
type: string
example: '2024-10-06T00:00:00.000000Z'
end_at:
type: string
example: '2024-10-07T00:00:00.000000Z'
current_action:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: ''
example: null
customer_organization_id:
type: string
description: ''
example: null
price_code:
type: integer
description: 'Must be one of 0, 1, or 2.'
example: 0
start_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:19'
end_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na start_at zijn.'
example: '2074-06-25'
min_quantity:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 36
price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 12
required:
- start_at
- end_at
- min_quantity
- price
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
'/api/products/{product_id}/action-prices/{id}':
get:
summary: ''
operationId: getApiProductsProduct_idActionPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 12087
product_id: 13108
customer_id: 3341
customer_organization_id: 1232
price_code: 0
price: 37.06
min_quantity: 42
start_at: '2024-08-15T00:00:00.000000Z'
end_at: '2024-08-16T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 12087
product_id:
type: integer
example: 13108
customer_id:
type: integer
example: 3341
customer_organization_id:
type: integer
example: 1232
price_code:
type: integer
example: 0
price:
type: number
example: 37.06
min_quantity:
type: integer
example: 42
start_at:
type: string
example: '2024-08-15T00:00:00.000000Z'
end_at:
type: string
example: '2024-08-16T00:00:00.000000Z'
current_action:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
put:
summary: ''
operationId: putApiProductsProduct_idActionPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 12088
product_id: 13109
customer_id: 3342
customer_organization_id: 1234
price_code: null
price: 14.22
min_quantity: 59
start_at: '2024-09-11T00:00:00.000000Z'
end_at: '2024-09-27T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 12088
product_id:
type: integer
example: 13109
customer_id:
type: integer
example: 3342
customer_organization_id:
type: integer
example: 1234
price_code:
type: string
example: null
price:
type: number
example: 14.22
min_quantity:
type: integer
example: 59
start_at:
type: string
example: '2024-09-11T00:00:00.000000Z'
end_at:
type: string
example: '2024-09-27T00:00:00.000000Z'
current_action:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_id:
type: string
description: ''
example: null
customer_organization_id:
type: string
description: ''
example: null
price_code:
type: integer
description: 'Must be one of 0, 1, or 2.'
example: 1
start_at:
type: string
description: ':Attribute moet een datum bevatten.'
example: '2024-08-27T08:00:19'
end_at:
type: string
description: ':Attribute moet een datum bevatten. :Attribute moet een datum na start_at zijn.'
example: '2112-02-02'
min_quantity:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 83
price:
type: number
description: ':Attribute moet minimaal 0 zijn.'
example: 79
required:
- start_at
- end_at
- min_quantity
- price
delete:
summary: ''
operationId: deleteApiProductsProduct_idActionPricesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: 'No content'
tags:
- Products
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
-
in: path
name: id
description: 'The ID of the action price.'
example: 10714
required: true
schema:
type: integer
/api/product-groups:
get:
summary: ''
operationId: getApiProductGroups
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 2085
name: 'Shooters/ Kleine flesjes /Discodrankjes'
external_id: 05dee704-32b7-34df-8ed6-bcceb8bdc8d6
product_group_id: 2084
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 2087
name: 'Likeuren Buitenland'
external_id: 210bfe28-0cac-395a-b72f-43b86edcfea3
product_group_id: 2086
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 2085
name: 'Shooters/ Kleine flesjes /Discodrankjes'
external_id: 05dee704-32b7-34df-8ed6-bcceb8bdc8d6
product_group_id: 2084
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 2087
name: 'Likeuren Buitenland'
external_id: 210bfe28-0cac-395a-b72f-43b86edcfea3
product_group_id: 2086
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2085
name:
type: string
example: 'Shooters/ Kleine flesjes /Discodrankjes'
external_id:
type: string
example: 05dee704-32b7-34df-8ed6-bcceb8bdc8d6
product_group_id:
type: integer
example: 2084
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
post:
summary: ''
operationId: postApiProductGroups
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2089
name: Likorettes
external_id: 61b1768b-37e6-30f8-8c7a-099ba4ddf9c9
product_group_id: 2088
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2089
name:
type: string
example: Likorettes
external_id:
type: string
example: 61b1768b-37e6-30f8-8c7a-099ba4ddf9c9
product_group_id:
type: integer
example: 2088
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: gfibfxurpjiyawfuztvp
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: dmqtgqywaycnolqveyzkpf
product_group_id:
type: string
description: ''
example: null
required:
- name
- external_id
'/api/product-groups/{id}':
get:
summary: ''
operationId: getApiProductGroupsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2091
name: 'Jonge Jenever'
external_id: 791a329a-fd02-3161-9d3b-c086f8627d3d
product_group_id: 2090
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2091
name:
type: string
example: 'Jonge Jenever'
external_id:
type: string
example: 791a329a-fd02-3161-9d3b-c086f8627d3d
product_group_id:
type: integer
example: 2090
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
put:
summary: ''
operationId: putApiProductGroupsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 2093
name: Tequila
external_id: 239ce3a9-66d2-31fe-aced-2dde0e125121
product_group_id: 2092
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 2093
name:
type: string
example: Tequila
external_id:
type: string
example: 239ce3a9-66d2-31fe-aced-2dde0e125121
product_group_id:
type: integer
example: 2092
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: qujzgfrasieqwyfbsbxrteiy
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: cgqq
product_group_id:
type: string
description: ''
example: null
required:
- name
- external_id
delete:
summary: ''
operationId: deleteApiProductGroupsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
400:
description: 'Cannot delete group with sub groups'
content:
text/plain:
schema:
type: string
example: 'null'
tags:
- Products
parameters:
-
in: path
name: id
description: 'The ID of the product group.'
example: 1
required: true
schema:
type: integer
'/api/products/{product}/restore':
put:
summary: ''
operationId: putApiProductsProductRestore
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 13112
supplier_id: 1422
product_group_id: 2099
customer_organization_id: null
external_id: 2cac9e86-f629-37ea-8014-aff85958c8bb
name: in
courant_price: null
advice_price: 65.99
vat_type: 0
stock_code: R
tlo: false
restocked_at: '2024-06-14T15:47:38.000000Z'
box_content: 5
content: 6655.5
free_market: true
package_deposit: 3.71
price_list_description: 'Est minus illum voluptate excepturi possimus perferendis reiciendis.'
alcohol: 2.54
unit: DISP
ean_1: null
ean_2: null
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/2cac9e86-f629-37ea-8014-aff85958c8bb.png'
properties:
data:
type: object
properties:
id:
type: integer
example: 13112
supplier_id:
type: integer
example: 1422
product_group_id:
type: integer
example: 2099
customer_organization_id:
type: string
example: null
external_id:
type: string
example: 2cac9e86-f629-37ea-8014-aff85958c8bb
name:
type: string
example: in
courant_price:
type: string
example: null
advice_price:
type: number
example: 65.99
vat_type:
type: integer
example: 0
stock_code:
type: string
example: R
tlo:
type: boolean
example: false
restocked_at:
type: string
example: '2024-06-14T15:47:38.000000Z'
box_content:
type: integer
example: 5
content:
type: number
example: 6655.5
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 3.71
price_list_description:
type: string
example: 'Est minus illum voluptate excepturi possimus perferendis reiciendis.'
alcohol:
type: number
example: 2.54
unit:
type: string
example: DISP
ean_1:
type: string
example: null
ean_2:
type: string
example: null
ean_3:
type: string
example: null
discount:
type: boolean
example: true
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/2cac9e86-f629-37ea-8014-aff85958c8bb.png'
tags:
- Products
parameters:
-
in: path
name: product
description: 'The product.'
example: 2
required: true
schema:
type: integer
/api/products/bulk/cleanup:
post:
summary: 'Clean up products'
operationId: cleanUpProducts
description: '(soft) delete all unknown products'
parameters:
-
in: query
name: knownProductNumbers
description: 'Complete list of product numbers available in the portal'
example:
- 1234567
- 1234568
- 1234569
required: true
schema:
type: array
description: 'Complete list of product numbers available in the portal'
example:
- 1234567
- 1234568
- 1234569
items:
type: string
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
affected:
-
id: 1
external_id: 100056
affected_count: 1
properties:
affected:
type: array
example:
-
id: 1
external_id: 100056
items:
type: object
properties:
id:
type: integer
example: 1
external_id:
type: integer
example: 100056
affected_count:
type: integer
example: 1
tags:
- Products
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
knownProductNumbers:
type: array
description: ''
example: null
items:
type: string
/api/products/bulk/createOrUpdate:
post:
summary: "TODO: part of PoC for DMD-369\n error-responses per product"
operationId: tODOPartOfPoCForDMD369ErrorResponsesPerProduct
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 13113
supplier_id: 1423
product_group_id: 2101
customer_organization_id: null
external_id: d56f009a-7ee1-38a4-8363-f9ef5ebb485d
name: ut
courant_price: null
advice_price: 66.23
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2024-07-19T12:19:15.000000Z'
box_content: 2
content: 90337.7
free_market: false
package_deposit: 5.93
price_list_description: null
alcohol: 29.35
unit: null
ean_1: null
ean_2: '0490357850340'
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/d56f009a-7ee1-38a4-8363-f9ef5ebb485d.png'
-
id: 13114
supplier_id: 1424
product_group_id: 2103
customer_organization_id: null
external_id: 05514f0e-cba5-37a9-aa0d-6e5064989198
name: voluptas
courant_price: null
advice_price: 79.2
vat_type: 1
stock_code: G
tlo: false
restocked_at: '2024-08-12T21:13:22.000000Z'
box_content: 10
content: 2604543.1
free_market: true
package_deposit: 4.65
price_list_description: null
alcohol: 33.76
unit: KIST
ean_1: '5908175014455'
ean_2: '5851522466790'
ean_3: null
discount: false
own_import: true
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/05514f0e-cba5-37a9-aa0d-6e5064989198.png'
properties:
data:
type: array
example:
-
id: 13113
supplier_id: 1423
product_group_id: 2101
customer_organization_id: null
external_id: d56f009a-7ee1-38a4-8363-f9ef5ebb485d
name: ut
courant_price: null
advice_price: 66.23
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2024-07-19T12:19:15.000000Z'
box_content: 2
content: 90337.7
free_market: false
package_deposit: 5.93
price_list_description: null
alcohol: 29.35
unit: null
ean_1: null
ean_2: '0490357850340'
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/d56f009a-7ee1-38a4-8363-f9ef5ebb485d.png'
-
id: 13114
supplier_id: 1424
product_group_id: 2103
customer_organization_id: null
external_id: 05514f0e-cba5-37a9-aa0d-6e5064989198
name: voluptas
courant_price: null
advice_price: 79.2
vat_type: 1
stock_code: G
tlo: false
restocked_at: '2024-08-12T21:13:22.000000Z'
box_content: 10
content: 2604543.1
free_market: true
package_deposit: 4.65
price_list_description: null
alcohol: 33.76
unit: KIST
ean_1: '5908175014455'
ean_2: '5851522466790'
ean_3: null
discount: false
own_import: true
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/05514f0e-cba5-37a9-aa0d-6e5064989198.png'
items:
type: object
properties:
id:
type: integer
example: 13113
supplier_id:
type: integer
example: 1423
product_group_id:
type: integer
example: 2101
customer_organization_id:
type: string
example: null
external_id:
type: string
example: d56f009a-7ee1-38a4-8363-f9ef5ebb485d
name:
type: string
example: ut
courant_price:
type: string
example: null
advice_price:
type: number
example: 66.23
vat_type:
type: integer
example: 0
stock_code:
type: string
example: G
tlo:
type: boolean
example: false
restocked_at:
type: string
example: '2024-07-19T12:19:15.000000Z'
box_content:
type: integer
example: 2
content:
type: number
example: 90337.7
free_market:
type: boolean
example: false
package_deposit:
type: number
example: 5.93
price_list_description:
type: string
example: null
alcohol:
type: number
example: 29.35
unit:
type: string
example: null
ean_1:
type: string
example: null
ean_2:
type: string
example: '0490357850340'
ean_3:
type: string
example: null
discount:
type: boolean
example: true
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/d56f009a-7ee1-38a4-8363-f9ef5ebb485d.png'
tags:
- Products
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
products:
type: object
description: ''
example: null
properties: []
/api/product-price-updates/truncate:
delete:
summary: ''
operationId: deleteApiProductPriceUpdatesTruncate
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Products
'/api/action-prices/{product_id}/bulk':
post:
summary: ''
operationId: postApiActionPricesProduct_idBulk
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: 'Bulk created'
content:
text/plain:
schema:
type: string
example: 'null'
tags:
- Products
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 10714
required: true
schema:
type: integer
'/api/customer-prices/{product_id}/bulk':
post:
summary: ''
operationId: postApiCustomerPricesProduct_idBulk
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: 'Bulk created'
content:
text/plain:
schema:
type: string
example: 'null'
tags:
- Products
parameters:
-
in: path
name: product_id
description: 'The ID of the product.'
example: 14733163
required: true
schema:
type: integer
/api/frontend/products:
get:
summary: ''
operationId: getApiFrontendProducts
description: ''
parameters:
-
in: query
name: page
description: 'The page number to load'
example: 8
required: true
schema:
type: integer
description: 'The page number to load'
example: 8
-
in: query
name: product_group_ids
description: 'The product group ids to filter on'
example:
- recusandae
required: true
schema:
type: array
description: 'The product group ids to filter on'
example:
- recusandae
items:
type: string
-
in: query
name: search
description: 'The search query to filter on'
example: officia
required: true
schema:
type: string
description: 'The search query to filter on'
example: officia
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 13115
supplier_id: 1425
product_group_id: 2105
customer_organization_id: null
external_id: 190a3529-c980-338d-9ba0-c089594b27cf
name: officia
courant_price: null
advice_price: 58.16
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2024-06-01T01:28:33.000000Z'
box_content: 9
content: 22539.9
free_market: true
package_deposit: 1.35
price_list_description: 'Error repellendus aperiam sit neque et et.'
alcohol: 1.39
unit: null
ean_1: '1140376132215'
ean_2: '7533420782124'
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/190a3529-c980-338d-9ba0-c089594b27cf.png'
links:
first: '/?page=1'
last: '/?page=2'
prev: null
next: '/?page=2'
meta:
current_page: 1
from: 1
last_page: 2
links:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
path: /
per_page: 1
to: 1
total: 2
properties:
data:
type: array
example:
-
id: 13115
supplier_id: 1425
product_group_id: 2105
customer_organization_id: null
external_id: 190a3529-c980-338d-9ba0-c089594b27cf
name: officia
courant_price: null
advice_price: 58.16
vat_type: 0
stock_code: G
tlo: false
restocked_at: '2024-06-01T01:28:33.000000Z'
box_content: 9
content: 22539.9
free_market: true
package_deposit: 1.35
price_list_description: 'Error repellendus aperiam sit neque et et.'
alcohol: 1.39
unit: null
ean_1: '1140376132215'
ean_2: '7533420782124'
ean_3: null
discount: true
own_import: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
deleted_at: null
customer_prices: []
image_url: 'https://monnikfoto.nl/bsphoto/groot/190a3529-c980-338d-9ba0-c089594b27cf.png'
items:
type: object
properties:
id:
type: integer
example: 13115
supplier_id:
type: integer
example: 1425
product_group_id:
type: integer
example: 2105
customer_organization_id:
type: string
example: null
external_id:
type: string
example: 190a3529-c980-338d-9ba0-c089594b27cf
name:
type: string
example: officia
courant_price:
type: string
example: null
advice_price:
type: number
example: 58.16
vat_type:
type: integer
example: 0
stock_code:
type: string
example: G
tlo:
type: boolean
example: false
restocked_at:
type: string
example: '2024-06-01T01:28:33.000000Z'
box_content:
type: integer
example: 9
content:
type: number
example: 22539.9
free_market:
type: boolean
example: true
package_deposit:
type: number
example: 1.35
price_list_description:
type: string
example: 'Error repellendus aperiam sit neque et et.'
alcohol:
type: number
example: 1.39
unit:
type: string
example: null
ean_1:
type: string
example: '1140376132215'
ean_2:
type: string
example: '7533420782124'
ean_3:
type: string
example: null
discount:
type: boolean
example: true
own_import:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
deleted_at:
type: string
example: null
customer_prices:
type: array
example: []
image_url:
type: string
example: 'https://monnikfoto.nl/bsphoto/groot/190a3529-c980-338d-9ba0-c089594b27cf.png'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=2'
prev:
type: string
example: null
next:
type: string
example: '/?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 2
links:
type: array
example:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Vorige'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 1
to:
type: integer
example: 1
total:
type: integer
example: 2
tags:
- Products
'/api/frontend/products/{id}':
get:
summary: ''
operationId: getApiFrontendProductsId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Products
parameters:
-
in: path
name: id
description: 'The ID of the product.'
example: 2
required: true
schema:
type: integer
/api/frontend/product-groups:
get:
summary: ''
operationId: getApiFrontendProductGroups
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 2109
name: 'Overige bitters Nederland'
external_id: f454ed6a-e476-323d-9574-9e0b3474fa62
product_group_id: 2108
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 2111
name: 'Overig gedistilleerd Buitenland'
external_id: fbc59d9a-ef5a-3508-bccb-8c5ed051aadb
product_group_id: 2110
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: array
example:
-
id: 2109
name: 'Overige bitters Nederland'
external_id: f454ed6a-e476-323d-9574-9e0b3474fa62
product_group_id: 2108
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
-
id: 2111
name: 'Overig gedistilleerd Buitenland'
external_id: fbc59d9a-ef5a-3508-bccb-8c5ed051aadb
product_group_id: 2110
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2109
name:
type: string
example: 'Overige bitters Nederland'
external_id:
type: string
example: f454ed6a-e476-323d-9574-9e0b3474fa62
product_group_id:
type: integer
example: 2108
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Products
/api/frontend/customers-product-groups:
get:
summary: ''
operationId: getApiFrontendCustomersProductGroups
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Products
/api/frontend/product-price-updates:
get:
summary: ''
operationId: getApiFrontendProductPriceUpdates
description: ''
parameters:
-
in: query
name: favourite
description: 'Filter on `is_personal `customer_order_lists`'
example: false
required: true
schema:
type: boolean
description: 'Filter on `is_personal `customer_order_lists`'
example: false
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 2918
product_id: 13117
active_at: '2025-07-31T07:05:28.000000Z'
price_0: 68.07
price_1: 30.5
price_2: 30.12
customer_price: null
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
links:
first: '/?page=1'
last: '/?page=2'
prev: null
next: '/?page=2'
meta:
current_page: 1
from: 1
last_page: 2
links:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
path: /
per_page: 1
to: 1
total: 2
properties:
data:
type: array
example:
-
id: 2918
product_id: 13117
active_at: '2025-07-31T07:05:28.000000Z'
price_0: 68.07
price_1: 30.5
price_2: 30.12
customer_price: null
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 2918
product_id:
type: integer
example: 13117
active_at:
type: string
example: '2025-07-31T07:05:28.000000Z'
price_0:
type: number
example: 68.07
price_1:
type: number
example: 30.5
price_2:
type: number
example: 30.12
customer_price:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=2'
prev:
type: string
example: null
next:
type: string
example: '/?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 2
links:
type: array
example:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Vorige'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 1
to:
type: integer
example: 1
total:
type: integer
example: 2
tags:
- Products
/api/frontend/action-prices:
get:
summary: ''
operationId: getApiFrontendActionPrices
description: ''
parameters:
-
in: query
name: page
description: 'The page number to load'
example: 4
required: true
schema:
type: integer
description: 'The page number to load'
example: 4
-
in: query
name: product_group_ids
description: 'The product group ids to filter on'
example:
- quis
required: true
schema:
type: array
description: 'The product group ids to filter on'
example:
- quis
items:
type: string
-
in: query
name: favourite
description: 'Filter on `is_favourite `customer_order_lists`'
example: false
required: true
schema:
type: boolean
description: 'Filter on `is_favourite `customer_order_lists`'
example: false
-
in: query
name: currentOnly
description: 'Filter only on current action prices'
example: false
required: true
schema:
type: boolean
description: 'Filter only on current action prices'
example: false
-
in: query
name: search
description: 'Search for a product name'
example: eum
required: true
schema:
type: string
description: 'Search for a product name'
example: eum
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 12089
product_id: 13119
customer_id: 3367
customer_organization_id: 1261
price_code: 0
price: 63.03
min_quantity: 48
start_at: '2024-10-10T00:00:00.000000Z'
end_at: '2024-10-23T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
links:
first: '/?page=1'
last: '/?page=2'
prev: null
next: '/?page=2'
meta:
current_page: 1
from: 1
last_page: 2
links:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
path: /
per_page: 1
to: 1
total: 2
properties:
data:
type: array
example:
-
id: 12089
product_id: 13119
customer_id: 3367
customer_organization_id: 1261
price_code: 0
price: 63.03
min_quantity: 48
start_at: '2024-10-10T00:00:00.000000Z'
end_at: '2024-10-23T00:00:00.000000Z'
current_action: false
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
items:
type: object
properties:
id:
type: integer
example: 12089
product_id:
type: integer
example: 13119
customer_id:
type: integer
example: 3367
customer_organization_id:
type: integer
example: 1261
price_code:
type: integer
example: 0
price:
type: number
example: 63.03
min_quantity:
type: integer
example: 48
start_at:
type: string
example: '2024-10-10T00:00:00.000000Z'
end_at:
type: string
example: '2024-10-23T00:00:00.000000Z'
current_action:
type: boolean
example: false
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
links:
type: object
properties:
first:
type: string
example: '/?page=1'
last:
type: string
example: '/?page=2'
prev:
type: string
example: null
next:
type: string
example: '/?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 2
links:
type: array
example:
-
url: null
label: '« Vorige'
active: false
-
url: '/?page=1'
label: '1'
active: true
-
url: '/?page=2'
label: '2'
active: false
-
url: '/?page=2'
label: 'Volgende »'
active: false
items:
type: object
properties:
url:
type: string
example: null
label:
type: string
example: '« Vorige'
active:
type: boolean
example: false
path:
type: string
example: /
per_page:
type: integer
example: 1
to:
type: integer
example: 1
total:
type: integer
example: 2
tags:
- Products
/api/frontend/customer-order-lists:
get:
summary: ''
operationId: getApiFrontendCustomerOrderLists
description: ''
parameters:
-
in: query
name: product_group_ids
description: 'The product group ids to filter on'
example:
- ipsam
required: true
schema:
type: array
description: 'The product group ids to filter on'
example:
- ipsam
items:
type: string
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Products
/api/frontend/customer-order-list-groups:
get:
summary: ''
operationId: getApiFrontendCustomerOrderListGroups
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Products
/api/suppliers:
get:
summary: ''
operationId: getApiSuppliers
description: ''
parameters:
-
in: query
name: page
description: 'Page number'
example: 1
required: true
schema:
type: integer
description: 'Page number'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1394
name: 'Kunst Markt Stichting'
short_name: Kun
external_id: 9cefc2ab-8b9d-36de-9afa-3d3b41674e9c
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 1395
name: 'Drank Expert'
short_name: Dra
external_id: 7ac344df-be3e-304a-bc0a-9517a7225385
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: array
example:
-
id: 1394
name: 'Kunst Markt Stichting'
short_name: Kun
external_id: 9cefc2ab-8b9d-36de-9afa-3d3b41674e9c
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
-
id: 1395
name: 'Drank Expert'
short_name: Dra
external_id: 7ac344df-be3e-304a-bc0a-9517a7225385
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1394
name:
type: string
example: 'Kunst Markt Stichting'
short_name:
type: string
example: Kun
external_id:
type: string
example: 9cefc2ab-8b9d-36de-9afa-3d3b41674e9c
deleted_at:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Suppliers
post:
summary: ''
operationId: postApiSuppliers
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1396
name: 'Vis Park'
short_name: Vis
external_id: 42d53aec-69fd-3003-a069-26cd296f00ee
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1396
name:
type: string
example: 'Vis Park'
short_name:
type: string
example: Vis
external_id:
type: string
example: 42d53aec-69fd-3003-a069-26cd296f00ee
deleted_at:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Suppliers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: rp
short_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: cxfdrwifnctsmfl
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: ukcskg
required:
- name
- short_name
- external_id
'/api/suppliers/{id}':
get:
summary: ''
operationId: getApiSuppliersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1397
name: 'Garage Çetin VOF'
short_name: Gar
external_id: 1ab72063-39d5-328e-b9b9-3f2876498236
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1397
name:
type: string
example: 'Garage Çetin VOF'
short_name:
type: string
example: Gar
external_id:
type: string
example: 1ab72063-39d5-328e-b9b9-3f2876498236
deleted_at:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Suppliers
put:
summary: ''
operationId: putApiSuppliersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1398
name: Lunchplaza
short_name: Lun
external_id: a45077f1-c857-31f3-a590-02ac417f321c
deleted_at: null
created_at: '2024-08-27T08:00:18.000000Z'
updated_at: '2024-08-27T08:00:18.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1398
name:
type: string
example: Lunchplaza
short_name:
type: string
example: Lun
external_id:
type: string
example: a45077f1-c857-31f3-a590-02ac417f321c
deleted_at:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:18.000000Z'
tags:
- Suppliers
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: nylsmrznbghx
short_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: wjiwuqdvvohgmwgyybrrdrb
external_id:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: ptdznnjeimmy
required:
- name
- short_name
- external_id
delete:
summary: ''
operationId: deleteApiSuppliersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Suppliers
parameters:
-
in: path
name: id
description: 'The ID of the supplier.'
example: 1
required: true
schema:
type: integer
'/api/supplier/{supplier}/restore':
put:
summary: ''
operationId: putApiSupplierSupplierRestore
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1421
name: Witgoedvakhuis
short_name: Wit
external_id: 431f39cb-3435-3ba9-8be4-d2a6317af32a
deleted_at: null
created_at: '2024-08-27T08:00:19.000000Z'
updated_at: '2024-08-27T08:00:19.000000Z'
properties:
data:
type: object
properties:
id:
type: integer
example: 1421
name:
type: string
example: Witgoedvakhuis
short_name:
type: string
example: Wit
external_id:
type: string
example: 431f39cb-3435-3ba9-8be4-d2a6317af32a
deleted_at:
type: string
example: null
created_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
updated_at:
type: string
example: '2024-08-27T08:00:19.000000Z'
tags:
- Suppliers
parameters:
-
in: path
name: supplier
description: 'The supplier.'
example: 1
required: true
schema:
type: integer
/api/users:
get:
summary: ''
operationId: getApiUsers
description: ''
parameters:
-
in: query
name: page
description: 'The page number'
example: 1
required: true
schema:
type: string
description: 'The page number'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
properties:
data:
type: array
example:
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
-
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
items:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: Brix
last_name:
type: string
example: CRM
username:
type: string
example: brix
email:
type: string
example: admin@brixcrm.nl
customer_id:
type: integer
example: 1
role_id:
type: integer
example: 1
role:
type: object
properties:
id:
type: integer
example: 1
type:
type: string
example: admin
name:
type: string
example: Admin
order_email:
type: string
example: admin@brixcrm.nl
tags:
- Users
post:
summary: ''
operationId: postApiUsers
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
properties:
data:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: Brix
last_name:
type: string
example: CRM
username:
type: string
example: brix
email:
type: string
example: admin@brixcrm.nl
customer_id:
type: integer
example: 1
role_id:
type: integer
example: 1
role:
type: object
properties:
id:
type: integer
example: 1
type:
type: string
example: admin
name:
type: string
example: Admin
order_email:
type: string
example: admin@brixcrm.nl
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: bclfzl
customer_id:
type: string
description: ''
example: null
first_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: bqmoqgietzqp
last_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: zutzqxwr
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: eliza36@example.com
order_email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: toby.huels@example.net
password:
type: string
description: ':Attribute moet minimaal 8 tekens zijn.'
example: 7okMi;y
role_id:
type: string
description: ''
example: voluptatem
required:
- username
- email
- order_email
- role_id
'/api/users/{id}':
get:
summary: ''
operationId: getApiUsersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
properties:
data:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: Brix
last_name:
type: string
example: CRM
username:
type: string
example: brix
email:
type: string
example: admin@brixcrm.nl
customer_id:
type: integer
example: 1
role_id:
type: integer
example: 1
role:
type: object
properties:
id:
type: integer
example: 1
type:
type: string
example: admin
name:
type: string
example: Admin
order_email:
type: string
example: admin@brixcrm.nl
tags:
- Users
put:
summary: ''
operationId: putApiUsersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
first_name: Brix
last_name: CRM
username: brix
email: admin@brixcrm.nl
customer_id: 1
role_id: 1
role:
id: 1
type: admin
name: Admin
order_email: admin@brixcrm.nl
properties:
data:
type: object
properties:
id:
type: integer
example: 1
first_name:
type: string
example: Brix
last_name:
type: string
example: CRM
username:
type: string
example: brix
email:
type: string
example: admin@brixcrm.nl
customer_id:
type: integer
example: 1
role_id:
type: integer
example: 1
role:
type: object
properties:
id:
type: integer
example: 1
type:
type: string
example: admin
name:
type: string
example: Admin
order_email:
type: string
example: admin@brixcrm.nl
tags:
- Users
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: p
customer_id:
type: string
description: ''
example: null
first_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: wbitgolcomsuidrgemtvmcwv
last_name:
type: string
description: ':Attribute mag niet uit meer dan 255 tekens bestaan.'
example: dqvipe
email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: concepcion.wehner@example.com
order_email:
type: string
description: ':Attribute is geen geldig e-mailadres.'
example: jana.larson@example.org
password:
type: string
description: ':Attribute moet minimaal 8 tekens zijn.'
example: "gq!`it$[`;'U"
role_id:
type: string
description: ''
example: ullam
required:
- username
- email
- order_email
- role_id
delete:
summary: ''
operationId: deleteApiUsersId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
204:
description: ''
tags:
- Users
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: 1
required: true
schema:
type: integer
/api/roles:
get:
summary: ''
operationId: getApiRoles
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: null
type: admin
name: Admin
-
id: null
type: admin
name: Admin
properties:
data:
type: array
example:
-
id: null
type: admin
name: Admin
-
id: null
type: admin
name: Admin
items:
type: object
properties:
id:
type: string
example: null
type:
type: string
example: admin
name:
type: string
example: Admin
tags:
- Users
'/api/roles/{id}':
get:
summary: ''
operationId: getApiRolesId
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: null
type: b2b
name: B2B
properties:
data:
type: object
properties:
id:
type: string
example: null
type:
type: string
example: b2b
name:
type: string
example: B2B
tags:
- Users
parameters:
-
in: path
name: id
description: 'The ID of the role.'
example: 1
required: true
schema:
type: integer
'/api/user/{user}/restore':
put:
summary: ''
operationId: putApiUserUserRestore
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {YOUR_AUTH_KEY}'
schema:
type: string
responses: { }
tags:
- Users
parameters:
-
in: path
name: user
description: 'The user.'
example: 1
required: true
schema:
type: integer
tags:
-
name: CustomerPrices
description: ''
-
name: 'Customer Products'
description: ''
-
name: Customers
description: ''
-
name: Endpoints
description: ''
-
name: Orders
description: ''
-
name: Products
description: ''
-
name: Suppliers
description: ''
-
name: Users
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []