List ordre
GET
Virker/api/v1/ordersNyeste først, eller etter endring for å synkronisere (sort=updatedAt med updatedSince og cursor). En testnøkkel ser testordrene. Avropene på en avtale: agreementNumber=12.
- Rettigheter
orders:read- Kundenøkkel
- Ja, for sine egne
- Grense
- lesing, 120 i minuttet
- Siden
Parametre
I spørringen
- En eller flere statuser, med komma:
statusstringmottatt,i_arbeid. viewstringapne: alt som ikke er lukket;klar_ikke_fakturert: Klar eller Levert uten faktura.Verdierapneklar_ikke_fakturert- Hvor ordren kom fra (
sourcestringlapp,manuell,tilbud,avrop,nettbutikk,api,import). Kan få nye verdier: les en ukjent verdi som «annet».Verdierlappmanuelltilbudavropnettbutikkapiimportportalnettverk - UUID
customerIdstring · uuid - Avropene på en avtale: avtalenummeret, som «12» (SR-AVT-4).
agreementNumberstring projectNostringexternalRefstring- Tidspunkt, ISO 8601 i UTC
createdSincestring · date-time - Tidspunkt, ISO 8601 i UTC
updatedSincestring · date-time - Nyeste først (
sortstring-createdAt, standard), eldste først (createdAt), eller etter endring (updatedAt, for synkronisering).Verdier-createdAtcreatedAtupdatedAt - Antall per side, 1–100 (25 når den mangler).
limitinteger cursorstringnextCursorfra forrige side.
Svaret
200OKEn side med ordre
application/jsonOrderList
dataOrder[]Må medVis 39 feltSkjul 39 felt
- UUID
idstring · uuidMå med - Ordrenummeret i verkstedets serie (testordre har sin egen serie).
numberintegerMå med - «004711», eller «T-000012» for en testordre.
numberDisplaystringMå med isTestbooleanMå med- Hvor ordren kom fra (
sourcestringMå medlapp,manuell,tilbud,avrop,nettbutikk,api,import). Kan få nye verdier: les en ukjent verdi som «annet».Verdierlappmanuelltilbudavropnettbutikkapiimportportalnettverk - Navnet på nøkkelen eller butikkens «kilde»: der ordren kom fra.
channelstringMå med - Lagret status:
statusstringMå medforespurt,mottatt,i_arbeid,klar,levert,fakturert,betalt,avbrutt. Stigen får aldri et nytt trinn uten v2.Verdierforespurtmottatti_arbeidklarlevertfakturertbetaltavbrutt - Statusen med appens ord: Forespørsel, Mottatt, I arbeid, Klar, Levert/Hentet, Fakturert, Betalt, Avbrutt/Avvist.
statusLabelstringMå med - Tidspunkt, ISO 8601 i UTC
statusChangedAtstring · date-timeMå med customerobjectMå medVis 3 feltSkjul 3 felt
- UUID
idstring · uuidMå med numberintegerMå mednamestringMå med
- Bare så lenge ordren ikke har en kunde (en forespørsel).
contactobjectMå medVis 5 feltSkjul 5 felt
namestringMå medcompanystringMå medorgNrstringMå medemailstringMå medmobilestringMå med
projectNostringMå medordererstringMå medcustomerPostringMå medtitlestringMå mednotestringMå medagreementobjectMå medVis 1 feltSkjul 1 felt
- UUID
idstring · uuidMå med
deliveryobjectMå medVis 4 feltSkjul 4 felt
modestringMå medVerdierhentinglevering- Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
requestedDatestring · dateMå med - Dato på Oslo-kalenderen, ÅÅÅÅ-MM-DD
deliveryDatestring · dateMå med addressobjectMå medVis 3 feltSkjul 3 felt
linestringMå medpostalCodestringMå medcitystringMå med
linesOrderLine[]Må medVis 13 feltSkjul 13 felt
lineNointegerMå medkindstringMå medproduct(et beslag fra butikken),position(en avtaleposisjon),text(en linje i ord),fee(frakt, emballasje, gebyr). Kan få nye verdier.VerdierproductpositiontextfeedescriptionstringMå medquantitynumberMå medunitstringMå medVerdierstkmm2timelengthMmintegerMå med- UUID
productIdstring · uuidMå med - UUID
agreementPositionIdstring · uuidMå med profileobjectMå medVis 5 feltSkjul 5 felt
familystringMå medparamsRecord<string, number>Må medmaterialstringMå medcolourstringMå medcolourSidestringMå med
priceStatusstringMå medpending: «Pris kommer»;hidden: en kundenøkkel og en butikk som skjuler prisene.Verdierpricedpendinghidden- Hele øre (1 kr = 100 øre)
unitPriceOreintegerMå med - Hele øre (1 kr = 100 øre)
netOreintegerMå med - Moms i basispunkter: 2500 = 25 %
vatBpintegerMå med
totalsobjectMå medVis 5 feltSkjul 5 felt
- Hele øre (1 kr = 100 øre)
netOreintegerMå med - Hele øre (1 kr = 100 øre)
vatOreintegerMå med - Hele øre (1 kr = 100 øre)
grossOreintegerMå med currencystringMå medAlltid"NOK"priceStatusstringMå medpriced: 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 ernullnår de ikke er kjent.Verdierpricedpartialin_kalkylehidden
- Om ordren er priset i en kalkyle; null for en kundenøkkel.
hasKalkylebooleanMå med - Lappnumrene som er knyttet til ordren.
stickerNumbersinteger[]Må med - «Klar uten mottak».
readyWithoutReceiptbooleanMå med - Klar-SMS-en: status og tider, aldri nummer eller tekst. Null for en kundenøkkel.
readySmsobjectMå medVis 3 feltSkjul 3 felt
statusstringMå medVerdierqueuedcancelledsendingsentdeliveredfailed- Tidspunkt, ISO 8601 i UTC
sendAfterstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
sentAtstring · date-timeMå med
invoiceobjectMå medVis 5 feltSkjul 5 felt
- UUID
idstring · uuidMå med kindstringMå medVerdierinvoicecredit_noteerp_marknumberstringMå med- Tidspunkt, ISO 8601 i UTC
issuedAtstring · date-timeMå med erpNostringMå med
attachmentsAttachment[]Må medVis 5 feltSkjul 5 felt
- UUID
idstring · uuidMå med kindstringMå medVerdierfototegningpdfcontentTypestringMå medbytesintegerMå med- Tidspunkt, ISO 8601 i UTC
createdAtstring · date-timeMå med
- Din egen id for ordren, unik per nøkkel.
externalRefstringMå med - Tidspunkt, ISO 8601 i UTC
createdAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
receivedAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
inWorkAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
readyAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
deliveredAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
invoicedAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
paidAtstring · date-timeMå med - Tidspunkt, ISO 8601 i UTC
cancelledAtstring · date-timeMå med cancelReasonstringMå med- Tidspunkt, ISO 8601 i UTC
updatedAtstring · date-timeMå med - Øker ved hver endring. Send den tilbake i
versionintegerMå medIf-Match: "v<version>". - Bøyearkene på ordren, når verkstedet har Produksjon;
productionOrderProductionnulluten Produksjon og for en kundenøkkel. Med i svarene fra ordreoperasjonene, ikke i webhooks ogGET /events. Et bøyd ark endrer ikkeversion, så nårproductionikke ernull, svarerIf-None-Matchaldri 304.Vis 3 feltSkjul 3 felt
- Bøyearkene på ordren: den gjeldende versjonen av hvert, uten de avbrutte.
bendingSheetsintegerMå med - Hvor mange av dem som er bøyd.
bentintegerMå med - Hvor mange som venter på at kunden godkjenner («Venter på kunden»).
waitingForCustomerintegerMå med
- Gi denne som
nextCursorstringMå medcursorfor neste side;nullnår det ikke er flere.
Feilkoder
Alle feil har samme form. Velg handling etter code, aldri etter message. Les mer under Feil.
400Bad Request
- invalid_cursorMarkøren (
cursor) er ikke en vi har gitt ut. - invalid_requestNoe i forespørselen er feil eller ukjent.
fieldssier 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.
featuresier hvilken. - insufficient_scopeNøkkelen har ikke lov til dette.
requiredScopesier hvilken rett som mangler.
429Too Many Requests
- rate_limitedFor mange kall. Vent
retryAfterSecondssekunder.
500Internal Server Error
- internalNoe gikk galt hos oss. Feilen er meldt. Oppgi
requestIdhvis du spør.