Spring til indholdet

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.

FeltTypeBetydning
iduuidOrdrens id.
order_numberstringNummeret kunden og køkkenet ser.
statusenumpending, confirmed, preparing, ready, out_for_delivery, delivered eller cancelled.
order_typeenumpickup, delivery eller dine_in.
subtotal_minorheltalVarernes pris før rabat og gebyrer.
discount_minorheltalRabat fra tilbud.
points_discount_minorheltalIndløste point omregnet til kroner.
delivery_fee_minor · packaging_fee_minor · service_fee_minorheltalGebyrer kunden har betalt.
total_minorheltalDet kunden har betalt i alt.
refunded_amount_minorheltalRefunderet indtil nu.
payment_statusenumpending, paid, failed, refunded eller partially_refunded.
points_usedheltalPoint kunden brugte på ordren.
customerobjektid, name, phone og email. Alle er null uden adgangen customers:read.
delivery_addressstringKun med customers:read. null ved afhentning.
note · allergy_note · delivery_notestringKundens bemærkninger. Vis allergi-noten tydeligt på bonen.
scheduled_forISO 8601Aftalt tidspunkt (UTC). null betyder hurtigst muligt.
pickup_timestringDen tekst restauranten har aftalt med kunden, fx "18:30".
linesOrderLine[]Ordrens linjer.
created_at · updated_atISO 8601I UTC.

OrderLine

Én linje på ordren.

FeltTypeBetydning
skustringRestaurantens eget varenummer — det felt I typisk matcher jeres varer på.
product_name · variant_namestringFx "Margherita", "Stor".
quantityheltalAntal.
unit_price_minor · line_total_minorheltalStykpris og linjetotal.
optionsobjekt[]Valgte tilvalg: group, name og price_minor.
bundle_instance_id · bundle_rolestringLinjer 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.

FeltTypeBetydning
external_idstringJeres bon-id.
customer_iduuidnull, når kunden ikke blev fundet.
gross_amount_minorheltalBonens bruttobeløb.
points_earnedheltalPoint kunden fik. 0 for ikke-medlemmer. Svaret siger points_capped: true, når døgnloftet gav færre.
occurred_atISO 8601Hvornår salget skete.

LoyaltyBalance

Kundens saldo og de seneste 20 bevægelser.

FeltTypeBetydning
memberbooleanOm kunden er medlem af kundeklubben.
balanceheltalPoint kunden kan bruge nu.
point_value_minorheltalVærdien af ét point: 100 øre.
movementsobjekt[]type (earn, spend eller adjust), amount, balance_after, reference og created_at.