Offsys documentatie
Producten
Producten
Haal productinformatie op of voeg een nieuw product toe.
List
Voorbeeld:
curl "https://api.offsys.nl/products" \-X GET \-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"Resultaat:
{ "status": "success", "products": [ { "id": 1, "name": "", "description": "", "price_excl": "", "vat": "", "deposit": "0.00", "options": [], "image": null, "variants": [], "pricing_method": "fixed" }, { "id": 2, "name": "", "description": "", "vat": "", "deposit": "0.00", "options": [], "image": null, "variants": [], "pricing_method": "period", "tiers": [ { "amount": 1, "unit": "dag", "price": "24.79" }, { "amount": 3, "unit": "dag", "price": "61.98" } ], "extra_unit": "dag", "extra_price": "16.53" } ]}pricing_method is fixed voor een product met een vaste prijs (price_excl), of period voor een product dat per periode (uur/dag) geprijsd is. Bij period ontbreekt price_excl - die prijs wordt namelijk niet gebruikt - en komen tiers, extra_unit en extra_price erbij:
- tiers: de prijstrappen (amount en unit, waarbij unit "uur" of "dag" is, en price excl. btw)
- extra_unit en extra_price: het toeslagtarief per extra eenheid boven de hoogste trap
Dit zijn puur de ingestelde prijzen - de API berekent hier zelf geen prijs voor een gekozen periode mee uit. Bij het aanmaken/bijwerken van een order gebeurt die berekening wel automatisch als je bij een orderregel geen prijs opgeeft.
Hetzelfde geldt per item in variants, met dien verstande dat een variant zonder eigen trappen de trappen van het hoofdproduct volgt.
Show
Voorbeeld:
curl "https://api.offsys.nl/product/1000" \-X GET \-H "Authorization: 37d37675-59cd-431c-8d28-9553de7bae4d"Resultaat:
{ "status": "success", "product": { "name": "", "description": "", "price_excl": "", "vat": "", "deposit": "", "options": [], "image": null, "stock": 5, "pricing_method": "fixed", "reserved_by_date": { "2025-01-01": [ { "amount": 1, "from": null, "till": null, } ] }, "variants": [] }}Zie List voor de betekenis van pricing_method, tiers, extra_unit en extra_price bij een periode-product.
Heeft het product vestigingen met eigen voorraad, dan komt er in plaats van stock en reserved_by_date een offices-array (per vestiging id, name, place, stock en reserved_by_date), eventueel met een variants-array per vestiging als het product ook varianten heeft.