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.
Â
Namn | Obligatorisk | Exempelvärde | Värdemängd/Datatyp | Förklaring |
---|---|---|---|---|
anonymous | ja | anonymous=true | Boolean | Möjligör att skapa en order utan att ange kund. |
currentbusinessunitid | ja | currentbusinessunitid=331 | ID | Vilken anläggning ordern ska tillhöra OBS sätt currentbusinessunitid först i din querystring annars tolkas den som ¤ 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.
Â
Namn | Obligatorisk | Exempelvärde | Värdemängd/Datatyp | Förklaring |
---|---|---|---|---|
anonymous | ja | anonymous=true | Boolean | Möjligör att ta bort en order utan att ange kund. |
id | ja | id=331 | ID | Vilken 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 |  |
orderedbyid | nej | orderedbyid=12 | Visa endast ordrar bokade på personen | Heltal |  |
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 |
---|---|---|---|
anonymous | anonymous=true | Möjliggör att förändra en order utan att en kund anges | Boolean |
preliminary | preliminary=false | En preliminär order tas automatiskt bort | Boolean |
mark | mark=Jag%20%26%20Mia%20kommer%20sent | En urlenkodad markerng | Sträng |
externalnote | externalnote=Gl%C3%B6m%20inte%20handduk | En urlenkodad externnotering | Sträng |
orderedbyid | orderedbyid=77 | Sätta kund på en anonym order eller byta kund på en order | ID |
Â
Exempel:
PUT:APIURL/orders/{id}.xml?apikey=338934897438&preliminary=false&anonymous=true
Svar
Samma som listning av en order
Â