Producten

Producten

Producten ophalen, aanmaken, bijwerken en verwijderen. Scope: products.read / products.write.

Producten ophalen

GET /v1/products
products.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Query
Naam Type Beschrijving
page integer Paginanummer (vanaf 1, default 1)
per_page integer Items per pagina (default 25, max 200)
search string Zoeken
Request body

Geen

Response
data object[]
guid string
Example: c3d4e5f6-a7b8-9012-cdef-123456789012
name string
Example: Onderhoudspakket
code string
Example: OND-01
price number
Example: 89
vat string
Example: 21
unit string
Example: stuk
description string
Example: Maandelijks onderhoud
active boolean
Example: true
meta object
page integer
Example: 1
per_page integer
Example: 25
total integer
Example: 1
pages integer
Example: 1

Examples

GET /v1/products
curl -X GET "https://api.appficient.nl/v1/products" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Product aanmaken

POST /v1/products
products.write

Response wrapt in { product: … }

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Headers
Naam Type Beschrijving
Idempotency-Key string Optional on POST only; cached 24h; replay returns X-Idempotent-Replay
Request body
name string
Example: Onderhoudspakket
code string
Example: OND-01
price number
Example: 89
vat string
Example: 21
unit string
Example: stuk
active boolean
Example: true
Response
data object
product object
guid string
Example: c3d4e5f6-a7b8-9012-cdef-123456789012
name string
Example: Onderhoudspakket
code string
Example: OND-01
price number
Example: 89
vat string
Example: 21
unit string
Example: stuk
description string
Example: Maandelijks onderhoud
active boolean
Example: true
meta object[]

Examples

POST /v1/products
curl -X POST "https://api.appficient.nl/v1/products" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Onderhoudspakket",
  "code": "OND-01",
  "price": 89.00,
  "vat": "21",
  "unit": "stuk",
  "active": true
}'

Curl, Node en response staan rechts naast dit endpoint.

Product ophalen

GET /v1/products/{id}
products.read
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body

Geen

Response
data object Required
id string
name string
code string
price number
vat_rate string
unit string
description string
active boolean
meta object Required

Examples

GET /v1/products/{id}
curl -X GET "https://api.appficient.nl/v1/products/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.

Product bijwerken

PATCH /v1/products/{id}
products.write
Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body
name string
code string
price number
vat_rate string
unit string
description string
active boolean
Response
data object Required
id string
name string
code string
price number
vat_rate string
unit string
description string
active boolean
meta object Required

Examples

PATCH /v1/products/{id}
curl -X PATCH "https://api.appficient.nl/v1/products/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "code": "string",
    "price": 0,
    "vat_rate": "string",
    "unit": "string",
    "description": "string",
    "active": false
}'

Curl, Node en response staan rechts naast dit endpoint.

Product verwijderen

DELETE /v1/products/{id}
products.write

Returns empty body

Authorization: HTTP
name: httpBearer
type: http
scheme: bearer
Path
Naam Type Beschrijving
id Required string Resource id (UUID, lowercase)
Request body

Geen

Response

Geen

Examples

DELETE /v1/products/{id}
curl -X DELETE "https://api.appficient.nl/v1/products/{id}" \
  -H "Authorization: Bearer apf_xxxxxxxx" \
  -H "Accept: application/json"

Curl, Node en response staan rechts naast dit endpoint.