POS-API · Reference
Objekter og felter
De vigtigste felter i API'ets svar. Hele strukturen står i eksemplerne ved hvert endpoint og i OpenAPI-specifikationen.
Objekter
De vigtigste felter. Hele strukturen står i eksemplerne ved hvert endpoint og i OpenAPI-specifikationen.
Order
Én ordre. Alle beløb er øre som heltal.
| Felt | Type | Betydning |
|---|---|---|
| id | uuid | Ordrens id. |
| order_number | string | Nummeret kunden og køkkenet ser. |
| status | enum | pending, confirmed, preparing, ready, out_for_delivery, delivered eller cancelled. |
| order_type | enum | pickup, delivery eller dine_in. |
| subtotal_minor | heltal | Varernes pris før rabat og gebyrer. |
| discount_minor | heltal | Rabat fra tilbud. |
| points_discount_minor | heltal | Indløste point omregnet til kroner. |
| delivery_fee_minor · packaging_fee_minor · service_fee_minor | heltal | Gebyrer kunden har betalt. |
| total_minor | heltal | Det kunden har betalt i alt. |
| refunded_amount_minor | heltal | Refunderet indtil nu. |
| payment_status | enum | pending, paid, failed, refunded eller partially_refunded. |
| points_used | heltal | Point kunden brugte på ordren. |
| customer | objekt | id, name, phone og email. Alle er null uden adgangen customers:read. |
| delivery_address | string | Kun med customers:read. null ved afhentning. |
| note · allergy_note · delivery_note | string | Kundens bemærkninger. Vis allergi-noten tydeligt på bonen. |
| scheduled_for | ISO 8601 | Aftalt tidspunkt (UTC). null betyder hurtigst muligt. |
| pickup_time | string | Den tekst restauranten har aftalt med kunden, fx "18:30". |
| lines | OrderLine[] | Ordrens linjer. |
| created_at · updated_at | ISO 8601 | I UTC. |
OrderLine
Én linje på ordren.
| Felt | Type | Betydning |
|---|---|---|
| sku | string | Restaurantens eget varenummer — det felt I typisk matcher jeres varer på. |
| product_name · variant_name | string | Fx "Margherita", "Stor". |
| quantity | heltal | Antal. |
| unit_price_minor · line_total_minor | heltal | Stykpris og linjetotal. |
| options | objekt[] | Valgte tilvalg: group, name og price_minor. |
| bundle_instance_id · bundle_role | string | Linjer med samme bundle_instance_id hører sammen på bonen: én primary og resten menu_upgrade_child. |
Sale
Et butikssalg meldt ind med POST /sales.
| Felt | Type | Betydning |
|---|---|---|
| external_id | string | Jeres bon-id. |
| customer_id | uuid | null, når kunden ikke blev fundet. |
| gross_amount_minor | heltal | Bonens bruttobeløb. |
| points_earned | heltal | Point kunden fik. 0 for ikke-medlemmer. Svaret siger points_capped: true, når døgnloftet gav færre. |
| occurred_at | ISO 8601 | Hvornår salget skete. |
LoyaltyBalance
Kundens saldo og de seneste 20 bevægelser.
| Felt | Type | Betydning |
|---|---|---|
| member | boolean | Om kunden er medlem af kundeklubben. |
| balance | heltal | Point kunden kan bruge nu. |
| point_value_minor | heltal | Værdien af ét point: 100 øre. |
| movements | objekt[] | type (earn, spend eller adjust), amount, balance_after, reference og created_at. |