/campaigns/{campaign}/orders
Pokud máte nastavenou analytiku, můžete sledovat objednávky i přes API. A hlavně, pokud vaše kampaň má nastaven PPT model (platíte provizi za provedenou objednávku), můžete přes API zákazníkem zrušené objednávky stornovat, čímž se vám za ně vrátí provize.
GET /campaigns/{campaign}/orders
Vrátí seznam zaznamenaných objednávek v kampani.
Požadavek
Parametr | Typ | Popis | Příklad |
---|---|---|---|
campaign |
integer/string | ID kampaně, popř. slug kampaně |
9999 nebo FRAD000001 |
Odpověď
Jednotlivé položky jsou v poli data
. Jsou řazeny podle data obejednávky od nejnovější.
Odpověď je stránkovaná.
Parametr | Typ | Popis | Příklad |
---|---|---|---|
id |
integer | Naše ID objednávky | 23651783421198380 |
remoteOrderId |
string | Vaše ID objednávky | 6130 |
datetime |
string | Datum uskutečnění objednávky ve formátu YYYY-MM-DD HH:MM:SS . |
2014-09-03 16:55:49 |
storno |
boolean | true , pokud byla objednávka stornována. |
false |
items |
array | Pole položek v objednávce. | |
items.id |
integer | Naše ID položky objednávky | 23651783421198381 |
items.remoteItemId |
string | Vaše ID položky. | 153 |
items.dealId |
integer | Naše ID položky. | 12345 |
items.price |
float | Cena položky v objednávce. | 300.00 |
items.commission |
float | Provize za položku z objednávky. | 9.00 |
Příklad
$ curl -u franta@skrz.cz:sedmikraska -X GET 'https://muj.skrz.cz/api/v2/campaigns/9999/orders?pretty'
"data": [
{
"id": 23651783421198380,
"remoteOrderId": "2512",
"datetime": "2014-09-03 16:55:49",
"storno": false,
"items": [
{
"id": 23651783421198381,
"remoteItemId": "13610",
"dealId": 153,
"price": 300.00,
"commission": 9.00
}
],
"uri": "/api/v2/campaigns/9999/orders/23651783421198380"
},
...
],
"pagination": {
"next": "/api/v2/campaigns/9999/orders?pretty&limit=100&offset=100"
}
}
GET /campaigns/{campaign}/orders/{id}
Vrátí info o konkrétní objednávce v kampani.
Požadavek
Parametr | Typ | Popis | Příklad |
---|---|---|---|
campaign |
integer/string | ID kampaně, popř. slug kampaně |
9999 nebo FRAD000001 |
id |
integer/string | Vaše ID objednávky. | 23651783421198380 |
Odpověď
Parametr | Typ | Popis | Příklad |
---|---|---|---|
id |
integer | Naše ID objednávky | 23651783421198380 |
remoteOrderId |
string | Vaše ID objednávky | 6130 |
datetime |
string | Datum uskutečnění objednávky ve formátu YYYY-MM-DD HH:MM:SS . |
2014-09-03 16:55:49 |
storno |
boolean | true , pokud byla objednávka stornována. |
false |
items |
array | Pole položek v objednávce. | |
items.id |
integer | Naše ID položky objednávky | 23651783421198381 |
items.remoteItemId |
string | Vaše ID položky. | 153 |
items.dealId |
integer | Naše ID položky. | 12345 |
items.price |
float | Cena položky v objednávce. | 300.00 |
items.commission |
float | Provize za položku z objednávky. | 9.00 |
Příklad
$ curl -u franta@skrz.cz:sedmikraska -X GET 'https://muj.skrz.cz/api/v2/campaigns/9999/orders/2512?pretty'
"data": [
{
"id": 23651783421198380,
"remoteOrderId": "2512",
"datetime": "2014-09-03 16:55:49",
"storno": false,
"items": [
{
"id": 23651783421198381,
"remoteItemId": "13610",
"dealId": 153,
"price": 300.00,
"commission": 9.00
}
],
"uri": "/api/v2/campaigns/9999/orders/23651783421198380"
},
...
],
"pagination": {
"next": "/api/v2/campaigns/9999/orders?pretty&limit=100&offset=100"
}
}