Documentatie
Moeilijkheidsgraad:
Deze sectie is alleen van toepassing indien de module CRM actief is.
API - Order - GET order/filter
GET order/filter
Gebruikt voor
het ophalen van de orders. Via de search en columns variabelen is het overzicht naar wens aan te passen.
Voor meer informatie over filteren, kijk hier: filters
De resultaten van de kolommen worden zowel in volledige opmaak als in originele waarde weergegeven. De originele waarde heeft als suffix "_raw".
Authenticatie
Gebruiker dient ingelogd te zijn op beheerdersniveau.
Parameters
| Parameter | Omschrijving | Verplicht | Standaard | Voorbeeld |
|---|---|---|---|---|
| lang | Language | Nee | dutch | english |
| search | Search string met criteria Indien niet opgegeven wordt het resultaat beperkt tot de eerste 100 activiteiten |
Nee | PRODUCT IN (1,14) | |
| columns | Kolommen om weer te geven | Nee | INVOICE_ID,INV_NUMBER |
Expansie
| Parameter | Omschrijving |
|---|---|
| details | De detail regels |
Response codes
- 200 OK
Voorbeeld
Ophalen volledige order lijst met een optionele zoek filter en kolommen.
GET api/rest/order/filter?search=ORDER_STATUS IN (20)&columns=ORDER_NUMBER,ORDER_DESC,ORDER_DATE
Response:
[
{
"ORDER_NUMBER": "1",
"ORDER_DESC": "",
"ORDER_DATE": "za mrt 27, 2021",
"ORDER_ID": "1",
"CUSTOMER_ID": null,
"ord_id": "1",
"id": 1,
"ORDER_NUMBER_raw": "1",
"ORDER_DESC_raw": "",
"ORDER_DATE_raw": "2021-03-27",
"ORDER_ID_raw": "1"
},
{
Ophalen factuur lijst met expansie op details.
GET api/rest/order/filter?search=ORDER_STATUS IN (20)&columns=ORDER_NUMBER,ORDER_DESC,ORDER_DATE&expand=details
Response:
[{
"ORDER_NUMBER": "1",
"ORDER_DESC": "",
"ORDER_DATE": "za mrt 27, 2021",
"ORDER_ID": "1",
"CUSTOMER_ID": null,
"ord_id": "1",
"id": 1,
"ORDER_NUMBER_raw": "1",
"ORDER_DESC_raw": "",
"ORDER_DATE_raw": "2021-03-27",
"ORDER_ID_raw": "1",
"details": [{
"id": "1",
"ord_id": "1",
"block_id": "1",
"prio": "0",
"inv_id": "447",
"prod_id": "0",
"unit_id": "0",
"optional": "0",
"detail": "total",
"desc": "bonnetje 1",
"memo": "",
"from": "0",
"fromtime": "0",
"til": "0",
"tiltime": "0",
"months": "0",
"nights": "0",
"participants": "0",
"number_of_places": "1",
"price": "222",
