Offsys documentatie
Aanvragen
Aanvragen
Zet een aanvraag - via bijvoorbeeld de website - rechtstreeks in Offsys.
Create
| Veld | Waarde | Verplicht | Omschrijving |
|---|---|---|---|
| date | Date | Ja | Wordt getoond als leverdatum |
| reference | String | Nee | Standaardwaarde: Via website |
| event | 'Bruiloft', 'Geboorte', 'Verjaardag', 'Jubileum', 'Uitvaart', 'Open dag', 'Bedrijfsopening', 'Bedrijfsfeest', 'Zakelijk Event', 'Vergadering', 'Beurs', 'Overig' of 'Doorlevering' | Nee | Standaardwaarde: Overig |
| information | Text | Nee | Voeg extra informatie toe aan de aanvraag |
| customer | Array | Ja | |
| - type | '1' of '2' | Ja | Gebruik '1' voor een eenmalige klant en '2' voor een bestaande klant |
| type 1 | |||
| - name | String | Ja | |
| - address | String | Nee | |
| - postal | String | Nee | |
| - place | String | Nee | |
| - phone | String | Nee | |
| String | Nee | ||
| type 2 | |||
| - id | Integer | Ja | |
| location | Array | Nee | |
| - type | '2', '3' of '4' | Ja | 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 |
| - name | String | Nee | Gebruikt 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 |
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 }}