Marketplace Transaction API

Tranzakciók lekérdezése

Ezzel a funkcióval lekérdezhetőek a Marketplace tranzakciók részletes adatai.
Szűrési feltétel
Leírás
invoiceStatus
Számla státusza (adott tranzakcióhoz van-e már számla), lehetséges értékei:
  • invoiced,
  • uninvoiced,
  • error.
dateFrom
Tranzakció létrehozás dátuma aznapi vagy frissebb.
dateTo
Tranzakció létrehozás dátuma aznapi vagy régebbi.
transactionRole
A tranzakcióban betöltött szerep, lehetséges értékek:
  • supplier,
  • retailer.
A táblázatban megadott szűrési feltételek ÉS kapcsolatban állnak egymással, csak azokat a szűrőket kell megadni, amelyekre szűrni szeretnénk.
XML esetén:
Kérés (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
<request>
3
<apiKey>your-api-key</apiKey>
4
<filters>
5
<invoiceStatus>invoiced</invoiceStatus>
6
<dateFrom>2021-04-21</dateFrom>
7
<dateTo>2022-01-12</dateTo>
8
<transactionRole>supplier</transactionRole>
9
</filters>
10
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
<response>
3
<status>success</status>
4
<result>
5
<transactionId>DSPY1000134</transactionId>
6
<date>2021-02-14 13:09:11</date>
7
<paymentStatus>paid</paymentStatus>
8
<transferredAt>2021-06-12 14:12:00</transferredAt>
9
<parties>
10
<supplier>
11
<name>Webshippy</name>
12
</supplier>
13
<retailer>
14
<name>Koala Adventures Teszt Bt.</name>
15
<address>7621 Hungary Pécs Asd street</address>
16
<email>[email protected]</email>
17
<billingTaxNumber>000000000000-99</billingTaxNumber>
18
</retailer>
19
</parties>
20
<payment>
21
<paymentId>500864504</paymentId>
22
</payment>
23
<products>
24
<name>Premium Quality Shirt</name>
25
<sku>ws2_dspy_rules_11</sku>
26
<barcode>ws2_dspy_rules_11-b</barcode>
27
<quantity>2</quantity>
28
<transactionAmountNet>3800</transactionAmountNet>
29
<vat>0</vat>
30
<vatSum>0</vatSum>
31
<transactionAmountGross>3800</transactionAmountGross>
32
<currency>HUF</currency>
33
</products>
34
<invoice>
35
<url>http://webshippy.lh/dropshippy/getTransactionInvoice/1000134</url>
36
<status>invoiced</status>
37
<serialNumber>Invoice-12345-1-54365</serialNumber>
38
</invoice>
39
</result>
40
</response>
Copied!
Hibás kérés esetén (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
<response>
3
<status>error</status>
4
<notagname>Invalid API key</notagname>
5
</response>
Copied!
JSON esetén:
Kérés (példa):
1
{
2
"apiKey": "your-api-key",
3
"filters": {
4
"invoiceStatus": "invoiced",
5
"dateFrom": "2021-04-21",
6
"dateTo": "2022-01-12",
7
"transactionRole": "supplier"
8
}
9
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"result": [
4
{
5
"transactionId": "DSPY1000134",
6
"date": "2021-02-14 13:09:11",
7
"paymentStatus": "paid",
8
"transferredAt": "2021-06-12 14:12:00",
9
"parties": {
10
"supplier": {
11
"name": "Webshippy"
12
},
13
"retailer": {
14
"name": "Koala Adventures Teszt Bt.",
15
"address": "7621 Hungary Pécs Asd street",
16
"email": "[email protected]",
17
"billingTaxNumber": "000000000000-99"
18
}
19
},
20
"payment": {
21
"paymentId": 500864504
22
},
23
"products": [
24
{
25
"name": "Premium Quality Shirt",
26
"sku": "ws2_dspy_rules_11",
27
"barcode": "ws2_dspy_rules_11-b",
28
"quantity": 2,
29
"transactionAmountNet": 3800,
30
"vat": 0,
31
"vatSum": 0,
32
"transactionAmountGross": 3800,
33
"currency": "HUF"
34
}
35
],
36
"invoice": {
37
"url": "http://webshippy.lh/dropshippy/getTransactionInvoice/1000134",
38
"status": "invoiced",
39
"serialNumber": "Invoice-12345-1-54365"
40
}
41
}
42
]
43
}
Copied!
Hibás kérés esetén (példa):
1
{
2
"status": "error",
3
"message": [
4
"Invalid API key"
5
]
6
}
Copied!

Kiállított számla feltöltés

Ezzel a funkcióval a Marketplace beszállító partnerek a kiállított számláikat fel tudják tölteni a vonatkozó tranzakciókhoz. 1 api hívással n tranzakcióhoz lehet feltölteni számlát. 1 db számla feltöltés base64 formátumban tranzakciónként. Amennyiben a megadott tranzakció azonosítóhoz még nem szerepel nálunk számla, akkor az API létrehozza.
Mező
Kötelező?
Leírás
apiKey
Igen
Az API kulcs.
transactionId
Igen
A tranzakció azonosítója.
invoiceSerialNumber
Igen
A számla sorszáma (a fájl neve).
fileInput
Igen
A számla base64 formátumban.
XML esetén:
Kérés (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
<request>
3
<apiKey>your-api-key</apiKey>
4
<invoice>
5
<transactionId>DSPY1000134</transactionId>
6
<invoiceSerialNumber>Invoice-12345-1-54365</invoiceSerialNumber>
7
<fileInput>iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==</fileInput>
8
</invoice>
9
</request>
Copied!
Válasz (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
<response>
3
<status>success</status>
4
<result>
5
<transactionId>DSPY1000134</transactionId>
6
<invoiceSerialNumber>Invoice-12345-1-54365</invoiceSerialNumber>
7
<fileInput>iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==</fileInput>
8
</result>
9
</response>
Copied!
Hibás kérés esetén (példa):
1
<?xml version="1.0" encoding="UTF-8"?>
2
3
<response>
4
5
<status>error</status>
6
7
<result>
8
9
<transactionId>DSPY1000134</transactionId>
10
11
<invoiceSerialNumber>Invoice-12345-1-54365</invoiceSerialNumber>
12
13
<fileInput>iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg==</fileInput>
14
15
</result>
16
17
<message>Invoice [invoiceSerialNumber] upload failed, due to: [error]</message>
18
19
</response>
Copied!
JSON esetén:
Kérés (példa):
1
{
2
"apiKey": "your-api-key",
3
"invoice": [
4
{
5
"transactionId": "DSPY1000134",
6
"invoiceSerialNumber": "Invoice-12345-1-54365",
7
"fileInput": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
8
}
9
]
10
}
Copied!
Válasz (példa):
1
{
2
"status": "success",
3
"result": [
4
{
5
"transactionId": "DSPY1000134",
6
"invoiceSerialNumber": "Invoice-12345-1-54365",
7
"fileInput": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
8
}
9
]
10
}
Copied!
Hibás kérés esetén (példa):
1
{
2
"status": "error",
3
"result": [
4
{
5
"transactionId": "DSPY1000134",
6
"invoiceSerialNumber": "Invoice-12345-1-54365",
7
"fileInput": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
8
}
9
],
10
"message": [
11
"Invoice [invoiceSerialNumber] upload failed, due to: [error]"
12
]
13
}
Copied!
További válasz lehetőségek hibás kérés esetén:
  • "[field:example] Example field has to be integer"
  • "Invalid API key"
  • "Entity not found"
  • "Already existing entity"