Offsys documentatie
Orders
Orders
Haal alle orders op.
List
Voorbeeld:
curl "https://api.offsys.nl/orders" \-X GET \-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"Resultaat:
{ "status": "success", "orders": [ { "number": 20240001, "status": "offerte", "event": "Bruiloft", "reference": "Bruiloft Janssen", "date": "2025-03-29 15:00:00", "max_delivery_time": "", "retour_date": "", "max_retour_time": "", "lines": [ { "id": "1", "name": "Statafel", "description": "", "amount": "1.0", "price": "50.00", "deposit": "0.00", "discount": "0" } ], "customer": { "type": 1, "name": "Fam Janssen", "address": "", "postal": "", "place": "", "phone": "", "email": "" }, "location": { "type": 4 }, "internal_note": "", "quotation_note": "", "production_note": "", "delivery_note": "" }, { "number": 20240002, "status": "factuur", "event": "Feest", "reference": "Feest Amsterdam", "date": "2024-05-29 12:30:00", "max_delivery_time": "18:50:00", "retour_date": "", "max_retour_time": "", "lines": [ { "id": "1", "name": "Achtergrond 2x2m", "description": "", "amount": "1.0", "price": "150.00", "deposit": "0.00", "discount": "0" } ], "customer": { "type": 1, "name": "Jan Janssen", "address": "", "postal": "", "place": "", "phone": "", "email": "" }, "location": { "type": 4 }, "internal_note": "", "quotation_note": "", "production_note": "", "delivery_note": "" } ]}Show
Voorbeeld:
curl "https://api.offsys.nl/order/20240001" \-X GET \-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"Resultaat:
{ "status": "success", "order": { { "number": 2024001, "status": "offerte", "event": "Bruiloft", "reference": "Bruiloft Janssen", "date": "2025-03-29 15:00:00", "max_delivery_time": "", "retour_date": "", "max_retour_time": "", "lines": [ { "id": "1", "name": "Statafel", "description": "", "amount": "1.0", "price": "50.00", "deposit": "0.00", "discount": "0" } ], "customer": { "type": 1, "name": "Fam Janssen", "address": "", "postal": "", "place": "", "phone": "", "email": "" }, "location": { "type": 4 }, "internal_note": "", "quotation_note": "", "production_note": "", "delivery_note": "" }, }}Create
Zet een nieuwe order - bijvoorbeeld een aanvraag via de website - rechtstreeks in Offsys.
| Veld | Waarde | Verplicht | Omschrijving |
|---|---|---|---|
| date | Datetime | Ja | Wordt getoond als leverdatum |
| office | Integer | Nee | ID van de vestiging, zoals opgehaald bij vestigingen |
| max_delivery_time | Time | Nee | Uiterlijke levertijd |
| retour_date | Datetime | Nee | Retourdatum |
| max_retour_time | Time | Nee | Uiterlijke retourtijd |
| reference | String | Nee | Standaardwaarde: Via website |
| duration | Integer | Nee | Opbouwtijd in minuten |
| event | 'Bruiloft', 'Geboorte', 'Verjaardag', 'Jubileum', 'Uitvaart', 'Open dag', 'Bedrijfsopening', 'Bedrijfsfeest', 'Zakelijk Event', 'Vergadering', 'Beurs', 'Overig', 'Doorlevering', 'Vergaderen', 'Trouwen', 'Feesten' of 'Afscheid' | Nee | Standaardwaarde: Overig |
| status | 'aanvraag', 'offerte' of 'factuur' | Nee | Standaardwaarde: aanvraag |
| information | Text | Nee | Voeg extra informatie toe aan de order |
| payment_method | 'overboeking', 'iDEAL', 'verrekening', 'pin' of 'kas' | Nee | |
| customer | Array | Ja | |
| - type | '1', '2' of '3' | Ja | Gebruik '1' voor een eenmalige klant, '2' voor een bestaande klant (op id) of '3' voor een nieuwe klant (op naam) |
| type 1 | |||
| - name | String | Ja | |
| - address | String | Nee | |
| - postal | String | Nee | |
| - place | String | Nee | |
| - phone | String | Nee | |
| String | Nee | ||
| type 2 | |||
| - id | Integer | Ja | |
| type 3 | |||
| - name | String | Ja | |
| - address | String | Nee | |
| - postal | String | Nee | |
| - place | String | Nee | |
| - phone | String | Nee | |
| String | Nee | ||
| - isCompany | '1' of '0' | Nee | |
| - contact | Array | Nee | Wordt hergebruikt als er al een contactpersoon met deze naam bestaat |
| -- name | String | Ja | |
| String | Nee | ||
| -- phone | String | Nee | |
| location | Array | Nee | |
| - type | '2', '3' of '4' | Nee (standaard geen locatie) | Gebruik '2' voor het adres van de klant, '3' voor een eenmalige locatie en '4' voor een bestaande locatie |
| type 3 | |||
| - name | String | Nee | |
| - address | String | Nee | |
| - postal | String | Nee | |
| - place | String | Nee | |
| String | Nee | ||
| - phone | String | Nee | |
| type 4 | |||
| - id | Integer | Ja | |
| lines | Array | Ja | Alle orderregels dienen in een aparte array geplaatst te worden |
| - id | String | Ja | Het product ID zoals zelf ingevuld bij de producten, of 'TEKST' voor een vrije tekstregel zonder product |
| - name | String | Nee | Verplicht bij id 'TEKST', anders gebruikt het standaard de waarde van het product |
| - description | String | Nee | Gebruikt standaard de waarde van het product |
| - amount | Integer | Nee | Gebruikt standaard de waarde van het product |
| - price | String | Nee | Gebruikt standaard de waarde van het product |
| - deposit | Integer | Nee | Gebruikt standaard de waarde van het product |
| - discount | String | Nee | Gebruikt standaard de waarde van het product |
| - variant | Integer | Nee | ID van de productvariant |
| - options | Array | Nee | Waarde(n) voor de productoptie |
Voorbeeld:
curl "https://api.offsys.nl/order" \-X POST \-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d" \-d "date=2021-01-01" \-d "customer[type]=1" \-d "customer[name]=Jan Janssen" \-d "location[type]=2" \-d "lines[0][id]=1" \-d "lines[0][amount]=4" \-d "lines[1][id]=2"Resultaat:
{ "status": "success", "order": { "number": 20210001 }}