Verkoop Notitie API
Met de REST API voor Verkoop Notities kunt u informatie aan gelukte verkopen toevoegen in een later stadium. Deze informatie wordt dan getoond bij de order details in de DigiWallet Backoffice.
HTTP Bearer Authenticatie
Deze API vereist HTTP Bearer authenticatie. (Lees meer...) Dit betekent dat uw verzoeken aan deze API een extra HTTP header met uw organisatie's API sleutel nodig hebben om geaccepteerd te worden.
U kunt uw organisatie's API sleutel vinden in uw Organisatie Dashboard.
Een voorbeeld van de HTTP header is als volgt:
Authorization: Bearer 12a34bc5de67f8g9012345678
RESTful API
Dit is een RESTful API. Dit betekent dat de API het RESTful formaat voor webservices volgt (Lees meer...)
Het respons formaat van deze API's is in (JSON).
Een typische respons is een JSON-geëncodeerde array met een status
integer om aan te geven of de aanroep gelukt is of niet, en een message
string met een beschrijving van wat er is gebeurd.
Naast deze standaard elementen kan een API natuurlijk API-specifieke informatie teruggeven. e.g. transactionID
integer voor het maken van een transactie. Of een nested errors
array
waarin gedetailleerde validatiefouten staan.
De HTTP response codes van de RESTful API's volgen de onderstaande logica:
HTTP Status Code | Gebruikt in reactie op |
---|---|
200 (Success) | Een succesvol verwerkt verzoek dat ook informatie teruggeeft |
201 (Created) | Een succesvol verwerkt aanmaak verzoek |
202 (Accepted) | Een succesvol geaccepteerd job verzoek |
400 (Bad Request) | Foutieve input parameters / validatiefouten |
401 (Unauthorized) | Foutieve inloggegevens |
404 (Not Found) | Object kon niet gevonden worden |
405 (Method Not Allowed) | Methode is niet ondersteund in deze API |
500 (Internal Server Error) | Er is een probleem opgetereden in DigiWallet's servers |
Aanmaak Methode Maak nieuwe notitie
Om een nieuwe notitie aan te maken, roep de API aan via HTTP POST
.
https://api.digiwallet.nl/sale-note
Met de volgende parameters (* = verplicht):
Variabele | Toelichting | Voorbeeld |
---|---|---|
outletID* | Het outlet ID van de oorspronkelijke transactie. | 12345 |
paymentMethodCode* |
Aanduidingscode van de betaalmethode van de oorspronkelijke transactie. Gebruik de waarden hieronder:
|
IDE |
saleID* | Het transactienummer van de oorspronkelijke transaction. | 12345678 |
text* | Inhoud van de notitie. | Final Invoice Number #12345 |
test |
Wanneer ingeschakeld hoeft het gegeven saleID niet te bestaan. Notities worden aangemaakt in een test administratie waarnaar u nog steeds kunt refereren, maar ze zullen niet tonen in de DigiWallet Backoffice. Merk op dat als uw outlet in test-modus is gezet via het DigiWallet Dashboard, deze parameter automatisch op 1 komt te staan. Vergeet deze optie niet uit te zetten als de site live gaat. Standaard staat testmode uit. |
"1" of "0" |
U krijgt dan een JSON-geëncodeerde array terug met de volgende inhoud:
Key | Waarde |
---|---|
status | 0 |
message | SaleNote successfully created |
saleNoteID | ID van de aangemaakte notitie |
Voorbeeld rauwe respons
{"status":0,"message":"SaleNote successfully created","saleNoteID":12345}
In het geval van één of meer fouten krijgt u een JSON-geëncodeerde array respons met de volgende inhoud:
Key | Waarde | ||||||
---|---|---|---|---|---|---|---|
status | 1 | ||||||
message | Validation failed | ||||||
errors |
Nested JSON-geëncodeerde array met validatiefouten
Voorbeeld
|
Voorbeeld rauwe respons
{"status":1,"message":"Validation failed","errors":{"saleID":["Sale not found."],"text":["Text cannot be blank."]}}
Update Methode Update bestaande notitie
Om een bestaande notitie bij te werken, roep de API aan via HTTP PATCH
.
https://api.digiwallet.nl/sale-note/<outletID>/<saleID>/<paymentMethodCode>/<text>[/<test>]
Met de volgende parameters (* = verplicht):
Variabele | Toelichting | Voorbeeld |
---|---|---|
outletID* | Het outlet ID van de oorspronkelijke transactie. | 12345 |
paymentMethodCode* |
Aanduidingscode van de betaalmethode van de oorspronkelijke transactie. Gebruik de waarden hieronder:
|
IDE |
saleID* | Het transactienummer van de oorspronkelijke transaction. | 12345678 |
text* | Inhoud van de notitie. | Final Invoice Number #12345 |
test |
Wanneer ingeschakeld hoeft het gegeven saleID niet te bestaan. Notities worden aangemaakt in een test administratie waarnaar u nog steeds kunt refereren, maar ze zullen niet tonen in de DigiWallet Backoffice. Merk op dat als uw outlet in test-modus is gezet via het DigiWallet Dashboard, deze parameter automatisch op 1 komt te staan. Vergeet deze optie niet uit te zetten als de site live gaat. Standaard staat testmode uit. |
"1" of "0" |
U krijgt dan een JSON-geëncodeerde array terug met de volgende inhoud:
Key | Waarde |
---|---|
status | 0 |
message | SaleNote successfully updated |
saleNoteID | ID van de bijgewerkte notitie |
Voorbeeld rauwe respons
{"status":0,"message":"SaleNote successfully updated","saleNoteID":12345}
In het geval van één of meer fouten krijgt u een JSON-geëncodeerde array respons met de volgende inhoud:
Key | Waarde | ||||||
---|---|---|---|---|---|---|---|
status | 1 | ||||||
message | Validation failed | ||||||
errors |
Nested JSON-geëncodeerde array met validatiefouten
Voorbeeld
|
Voorbeeld rauwe respons
{"status":1,"message":"Validation failed","errors":{"saleID":["Sale not found."],"text":["Text cannot be blank."]}}
Verwijder Methode Verwijder bestaande notitie
Om een bestaande notitie te verwijderen, roep de API aan via HTTP DELETE
.
https://api.digiwallet.nl/sale-note/<outletID>/<saleID>/<paymentMethodCode>[/<test>]
De query string parameters kunt u invullen als volgt (* = vereist):
Variabele | Toelichting | Voorbeeld |
---|---|---|
outletID* | Het outlet ID van de oorspronkelijke transactie. | 12345 |
paymentMethodCode* |
Aanduidingscode van de betaalmethode van de oorspronkelijke transactie. Gebruik de waarden hieronder:
|
IDE |
saleID* | Het transactienummer van de oorspronkelijke transaction. | 12345678 |
test |
Wanneer ingeschakeld hoeft het gegeven saleID niet te bestaan. Notities worden aangemaakt in een test administratie waarnaar u nog steeds kunt refereren, maar ze zullen niet tonen in de DigiWallet Backoffice. Merk op dat als uw outlet in test-modus is gezet via het DigiWallet Dashboard, deze parameter automatisch op 1 komt te staan. Vergeet deze optie niet uit te zetten als de site live gaat. Standaard staat testmode uit. |
"1" of "0" |
U krijgt dan een JSON-geëncodeerde array terug met de volgende inhoud:
Key | Waarde |
---|---|
status | 0 |
message | SaleNote successfully deleted |
Voorbeeld rauwe respons
{"status":0,"message":"SaleNote successfully deleted"}
In het geval van één of meer fouten krijgt u een JSON-geëncodeerde array respons met de volgende inhoud:
Key | Waarde | ||||
---|---|---|---|---|---|
status | 1 | ||||
message | Validation failed | ||||
errors |
Nested JSON-geëncodeerde array met validatiefouten
Voorbeeld
|
Voorbeeld rauwe respons
{"status":1,"message":"Validation failed","errors":{"saleID":["Sale not found."]}}