Avbryt en ordre

POST/api/v1/orders/{number}/cancel

Virker

Med en grunn. En kundenøkkel kan bare trekke tilbake sine egne forespørsler: alt annet kan være i arbeid, og da må kunden ringe.

Rettigheter: orders:write
Kundenøkkel: Ja, for sine egne
Grense: skriving, 30 i minuttet
Siden: 5. oktober 2026

Parametre

I adressen

numberstringMå medhøyst 12 tegn
«4711», «004711», «T-000012» (testnøkler), eller et lappnummer som er blitt ordrens.

Overskrifter

Idempotency-Keystring8–255 tegn
8–255 tegn. Bruk en UUID per forsøk på en handling; samme nøkkel og samme innhold gir samme svar igjen.
If-Matchstringmønster ^"v\d+"$
Versjonen du så, som "v3" (fra version eller ETag).

Det du sender

application/jsonCancelOrderRequestMå med

reasonstringMå med1–500 tegn

Svaret

200OKOrdren er avbrutt

application/jsonOrder

Vis alle 39 feltSkjul de 39 feltene

idstring · uuidMå med
UUID
numberintegerMå med
Ordrenummeret i verkstedets serie (testordre har sin egen serie).
numberDisplaystringMå med
«004711», eller «T-000012» for en testordre.
isTestbooleanMå med
sourcestringMå med
Hvor ordren kom fra (lapp, manuell, tilbud, avrop, nettbutikk, api, import). Kan få nye verdier: les en ukjent verdi som «annet».
Verdierlappmanuelltilbudavropnettbutikkapiimportportalnettverk
channelstringMå medkan være null
Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
statusstringMå med
Lagret status: forespurt, mottatt, i_arbeid, klar, levert, fakturert, betalt, avbrutt. Stigen får aldri et nytt trinn uten v2.
Verdierforespurtmottatti_arbeidklarlevertfakturertbetaltavbrutt
statusLabelstringMå med
Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
statusChangedAtstring · date-timeMå medeks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
customerobjectMå medkan være null
Vis 3 feltSkjul 3 felt
- idstring · uuidMå med
  UUID
- numberintegerMå medkan være null
- namestringMå med
contactobjectMå medkan være null
Bare så lenge ordren ikke har en kunde (en forespørsel).
Vis 5 feltSkjul 5 felt
- namestringMå med
- companystringMå medkan være null
- orgNrstringMå medkan være null
- emailstringMå medkan være null
- mobilestringMå medkan være null
projectNostringMå medkan være null
ordererstringMå medkan være null
customerPostringMå medkan være null
titlestringMå medkan være null
notestringMå medkan være null
agreementobjectMå medkan være null
Vis 1 feltSkjul 1 felt
- idstring · uuidMå med
  UUID
deliveryobjectMå med
Vis 4 feltSkjul 4 felt
- modestringMå medkan være null
  Verdierhentinglevering
- requestedDatestring · dateMå medkan være nulleks. 2026-12-18
  Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
- deliveryDatestring · dateMå medkan være nulleks. 2026-12-18
  Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
- addressobjectMå medkan være null
  Vis 3 feltSkjul 3 felt
  - linestringMå med
  - postalCodestringMå medkan være null
  - citystringMå medkan være null
linesOrderLine[]Må med
Vis 13 feltSkjul 13 felt
- lineNointegerMå med
- kindstringMå med
  product (et beslag fra butikken), position (en avtaleposisjon), text (en linje i ord), fee (frakt, emballasje, gebyr). Kan få nye verdier.
  Verdierproductpositiontextfee
- descriptionstringMå med
- quantitynumberMå med
- unitstringMå med
  Verdierstkmm2time
- lengthMmintegerMå medkan være null
- productIdstring · uuidMå medkan være null
  UUID
- agreementPositionIdstring · uuidMå medkan være null
  UUID
- profileobjectMå medkan være null
  Vis 5 feltSkjul 5 felt
  - familystringMå medkan være null
  - paramsRecord<string, number>Må mednøklene er tekst
  - materialstringMå medkan være null
  - colourstringMå medkan være null
  - colourSidestringMå medkan være null
- priceStatusstringMå med
  pending: «Pris kommer»; hidden: en kundenøkkel og en butikk som skjuler prisene.
  Verdierpricedpendinghidden
- unitPriceOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- netOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- vatBpintegerMå medkan være null0–10000
  Moms i basispunkter: 2500 = 25 %
totalsobjectMå med
Vis 5 feltSkjul 5 felt
- netOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- vatOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- grossOreintegerMå medkan være null
  Hele øre (1 kr = 100 øre)
- currencystringMå med
  Alltid "NOK"
- priceStatusstringMå med
  priced: alle linjer har pris; partial: noen linjer venter på pris; in_kalkyle: prisen står i kalkylen; hidden: skjult for en kundenøkkel. Beløpene er null når de ikke er kjent.
  Verdierpricedpartialin_kalkylehidden
hasKalkylebooleanMå medkan være null
Om ordren er priset i en kalkyle; null for en kundenøkkel.
stickerNumbersinteger[]Må med
Lappnumrene som er knyttet til ordren.
readyWithoutReceiptbooleanMå med
«Klar uten mottak».
readySmsobjectMå medkan være null
Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
Vis 3 feltSkjul 3 felt
- statusstringMå med
  Verdierqueuedcancelledsendingsentdeliveredfailed
- sendAfterstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
- sentAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
invoiceobjectMå medkan være null
Vis 5 feltSkjul 5 felt
- idstring · uuidMå med
  UUID
- kindstringMå med
  Verdierinvoicecredit_noteerp_mark
- numberstringMå medkan være null
- issuedAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
- erpNostringMå medkan være null
attachmentsAttachment[]Må med
Vis 5 feltSkjul 5 felt
- idstring · uuidMå med
  UUID
- kindstringMå med
  Verdierfototegningpdf
- contentTypestringMå med
- bytesintegerMå med
- createdAtstring · date-timeMå medeks. 2026-12-14T09:03:00.000Z
  Tidspunkt, ISO 8601 i UTC
externalRefstringMå medkan være null
Din egen id for ordren, unik per nøkkel.
createdAtstring · date-timeMå medeks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
receivedAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
inWorkAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
readyAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
deliveredAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
invoicedAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
paidAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
cancelledAtstring · date-timeMå medkan være nulleks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
cancelReasonstringMå medkan være null
updatedAtstring · date-timeMå medeks. 2026-12-14T09:03:00.000Z
Tidspunkt, ISO 8601 i UTC
versionintegerMå med
Øker ved hver endring. Send den tilbake i If-Match: "v<version>".
productionOrderProductionkan være null
Bøyearkene på ordren, når verkstedet har Produksjon; null uten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks og GET /events. Et bøyd ark endrer ikke version, så når production ikke er null, svarer If-None-Match aldri 304.
Vis 3 feltSkjul 3 felt
- bendingSheetsintegerMå medminst 0
  Bøyearkene på ordren: den gjeldende versjonen av hvert, uten de avbrutte.
- bentintegerMå medminst 0
  Hvor mange av dem som er bøyd.
- waitingForCustomerintegerMå medminst 0
  Hvor mange som venter på at kunden godkjenner («Venter på kunden»).

Feilkoder

Alle feil har samme form. Velg handling etter code, aldri etter message. Les mer under Feil.

400Bad Request

invalid_jsonInnholdet er ikke gyldig JSON.
invalid_requestNoe i forespørselen er feil eller ukjent. fields sier hva.

401Unauthorized

unauthorizedNøkkelen mangler, er feil, er slått av eller har gått ut. En nøkkel som slås av, slutter å virke innen 1 minutt.

403Forbidden

account_closedVerkstedet er stengt.
dpa_requiredVerkstedet må godta databehandleravtalen før koblinger kan brukes.
feature_not_in_planVerkstedet har ikke slått på delen dette trenger. feature sier hvilken.
insufficient_scopeNøkkelen har ikke lov til dette. requiredScope sier hvilken rett som mangler.

404Not Found

not_foundFant ikke dette.

409Conflict

already_invoicedOrdren er fakturert og kan ikke endres.
cancel_not_allowedOrdren kan ikke avbrytes nå. Ring verkstedet: arbeidet kan være i gang.
idempotency_in_progressEn forespørsel med samme Idempotency-Key holder på. Prøv igjen om litt.
stale_versionOrdren er endret siden du leste den. Hent den på nytt og send med ny versjon.
status_conflictOrdren kan ikke flyttes dit fra statusen den har nå. reason sier hvorfor.

422Unprocessable Entity

idempotency_key_reusedDenne Idempotency-Key ble brukt på en annen forespørsel. Bruk en ny nøkkel for ny handling.

429Too Many Requests

rate_limitedFor mange kall. Vent retryAfterSeconds sekunder.

500Internal Server Error

internalNoe gikk galt hos oss. Feilen er meldt. Oppgi requestId hvis du spør.

POST/orders/{number}/cancel

curl https://vbeslag.com/api/v1/orders/004711/cancel \
  -H "Authorization: Bearer vb_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "tekst"
  }'

const res = await fetch('https://vbeslag.com/api/v1/orders/004711/cancel', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer vb_test_…',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    reason: 'tekst',
  }),
})
const data = await res.json()

$ch = curl_init('https://vbeslag.com/api/v1/orders/004711/cancel');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_HTTPHEADER     => [
        'Authorization: Bearer vb_test_…',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS     => json_encode([
        'reason' => 'tekst',
    ]),
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

Svaret

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "2809d176-2724-4896-a690-52c5303f6825",
  "number": 4711,
  "numberDisplay": "004711",
  "isTest": false,
  "source": "lapp",
  "channel": "Nettsiden",
  "status": "forespurt",
  "statusLabel": "Forespørsel",
  "statusChangedAt": "2026-12-14T09:03:00.000Z",
  "customer": {
    "id": "87febf70-b0ae-4c70-a5cd-01339c01bce3",
    "number": 312,
    "name": "Byggmester Hansen AS"
  },
  "contact": {
    "name": "Kari Nordmann",
    "company": "Byggmester Hansen AS",
    "orgNr": "914276640",
    "email": "kari@example.no",
    "mobile": "+4791234567"
  },
  "projectNo": "P-2231",
  "orderer": "Ole",
  "customerPo": "PO-5512",
  "title": "Pipebeslag",
  "note": "Se bilde av skissen",
  "agreement": {
    "id": "b91241c6-ec40-4fe6-a9ec-63d5046dd995"
  },
  "delivery": {
    "mode": "henting",
    "requestedDate": "2026-12-18",
    "deliveryDate": "2026-12-18",
    "address": {
      "line": "Industriveien 4",
      "postalCode": "9405",
      "city": "Harstad"
    }
  },
  "lines": [
    {
      "lineNo": 1,
      "kind": "product",
      "description": "Vindskie 150×40, stål sort",
      "quantity": 1.5,
      "unit": "stk",
      "lengthMm": 2500,
      "productId": "8bddf77d-f04d-426d-adad-d3d8e49df3ce",
      "agreementPositionId": "6b6b0ced-eb0a-44dd-a1c7-5cc8a808d05e",
      "profile": {
        "family": "tekst",
        "params": {
          "a": 1.5
        },
        "material": "Stål",
        "colour": "Sort",
        "colourSide": "tekst"
      },
      "priceStatus": "priced",
      "unitPriceOre": 61200,
      "netOre": 61200,
      "vatBp": 2500
    }
  ],
  "totals": {
    "netOre": 61200,
    "vatOre": 61200,
    "grossOre": 61200,
    "currency": "NOK",
    "priceStatus": "priced"
  },
  "hasKalkyle": false,
  "stickerNumbers": [
    1
  ],
  "readyWithoutReceipt": false,
  "readySms": {
    "status": "queued",
    "sendAfter": "2026-12-14T09:03:00.000Z",
    "sentAt": "2026-12-14T09:03:00.000Z"
  },
  "invoice": {
    "id": "78dc0317-6985-41e7-aeb9-9deed0da1e24",
    "kind": "invoice",
    "number": "tekst",
    "issuedAt": "2026-12-14T09:03:00.000Z",
    "erpNo": "tekst"
  },
  "attachments": [
    {
      "id": "6fcbc93f-bc8d-4b8f-a1c5-f08647b0754c",
      "kind": "foto",
      "contentType": "image/jpeg",
      "bytes": 284123,
      "createdAt": "2026-12-14T09:03:00.000Z"
    }
  ],
  "externalRef": "woo-18822",
  "createdAt": "2026-12-14T09:03:00.000Z",
  "receivedAt": "2026-12-14T09:03:00.000Z",
  "inWorkAt": "2026-12-14T09:03:00.000Z",
  "readyAt": "2026-12-14T09:03:00.000Z",
  "deliveredAt": "2026-12-14T09:03:00.000Z",
  "invoicedAt": "2026-12-14T09:03:00.000Z",
  "paidAt": "2026-12-14T09:03:00.000Z",
  "cancelledAt": "2026-12-14T09:03:00.000Z",
  "cancelReason": "tekst",
  "updatedAt": "2026-12-14T09:03:00.000Z",
  "version": 3,
  "production": {
    "bendingSheets": 1,
    "bent": 1,
    "waitingForCustomer": 1
  }
}