orders (Level 3 API Key)

Create anonymous order

Skapar en order utan att en kund behöver anges. Ordern måste dock ha en kund när den ska betalas. Går endast att göra med en nivå 3 nyckel.

 

NamnObligatoriskExempelvärdeVärdemängd/DatatypFörklaring
anonymousjaanonymous=trueBooleanMöjligör att skapa en order utan att ange kund.
currentbusinessunitidjacurrentbusinessunitid=331IDVilken anläggning ordern ska tillhöra OBS sätt currentbusinessunitid först i din querystring annars tolkas den som &curren som är html entitiy för tecknet ¤ se Stack overflow

Innan betalning måste ordern ha en person som ägare. Ordern behåller sin businessunit oavsett vad personen tillhör för BU.

Exempel på anrop

POST: APIURL/orders.xml?currentbusinessunitid=331&apikey=338934897438&anonymous=true

Svar

Samma som listning av ordrar

Ta bort order

För att ta bort en order skicka med orderedbyid

Exempel

DELETE: APIURL/orders.xml?apikey=338934897438&orderedbyid=12345&id=33

 

Ta bort order utan kund

Tar bort en order utan att en kund behöver anges. Går endast att göra med en nivå 3 nyckel.

 

NamnObligatoriskExempelvärdeVärdemängd/DatatypFörklaring
anonymousjaanonymous=trueBooleanMöjligör att ta bort en order utan att ange kund.
idjaid=331IDVilken ordern som ska tas bort

 

Exempel på anrop

DELETE: APIURL/orders.xml?apikey=338934897438&anonymous=true&id=33
 
alternativt:
 
DELETE: APIURL/orders/33.xml?apikey=338934897438&anonymous=true

Svar

HTTP 204
Tomt innehåll.

Lista ordar

Listar samtliga ordrar för samtliga personer.

Anrop

HTTP GET till /orders

Filter

namn

obligatorisk

exempelvärde

förklaring

Värdemängd/Datatyp

Default

number

nej

number=1254

Ordernummer

Sträng

 

businessunitids

nej

businessunitids=4,3

Endast angiva anläggningar

ID-lista

 

orderedbyidnejorderedbyid=12Visa endast ordrar bokade på personenHeltal 

fromdate

nej

fromdate=2011-12-24

Startdatum

Datum

Ett år sedan

todate

nej

todate=2012-12-25

Slutdatum

Datum

Imorgon

 

Exempel de som beställde julklappar sent.

 

APIURL/orders.xml?apikey=338934897438&fromdate=2012-12-21&todate=2012-12-24

Svar

Samma för ordrar

 

Ändra order utan kund

Ändra värden en order som inte har en kund. Går endast att göra med en nivå 3 nyckel.

Anrop

Parametrar:

 

namn

exempelvärde

förklaring

Värdemängd/Datatyp

anonymousanonymous=trueMöjliggör att förändra en order utan att en kund angesBoolean

preliminary

preliminary=false

En preliminär order tas automatiskt bort

Boolean

markmark=Jag%20%26%20Mia%20kommer%20sentEn urlenkodad markerng

Sträng 

externalnoteexternalnote=Gl%C3%B6m%20inte%20handdukEn urlenkodad externnoteringSträng
orderedbyidorderedbyid=77Sätta kund på en anonym order eller byta kund på en orderID

 

Exempel:

PUT:APIURL/orders/{id}.xml?apikey=338934897438&preliminary=false&anonymous=true

Svar

Samma som listning av en order