Order API

Rendelésekkel kapcsolatos API funkciók

Rendelések lekérdezése

Szűrési feltétel

Leírás

limit

Az egy odlalon szereplő találatok száma (alapértelmezett: 100, maximum: 1000)

page

Lekérdezendő oldal sorszáma (alapértelmezett: 0)

wspyId

Belső azonosító, rendelés létrehozásakor az API visszaadja válaszban

referenceId

Külső azonosító, rendelés létrehozásakor megadott azonosító

referenceName

Rendelés neve, rendelés létrehozásakor megadott név

paymentStatus

Fizetési státusz (pl.: paid, pending, stb.)

paymentGateway

Fizetés módja (pl.: cod, card, stb.)

lastMod

Utolsó módosítás dátuma. A megadott dátum után létrehozott vagy módosított rendeléseket listázza ki, akár egyszerre többet is

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:

Url: https://app.webshippy.com/wspyapi/GetOrder/xml

Kérés:

<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey> <page>0</page> <limit>10</limit> <filters> <wspyId></wspyId> <referenceId></referenceId> <referenceName></referenceName> <paymentStatus></paymentStatus> <paymentGateway></paymentGateway> <lastMod>2018-01-01 00:00:00</lastMod> </filters></request>

Válasz (példa):

<?xml version="1.0" encoding="utf-8"?><response> <status>success</status> <message/> <result> <elem> <wspyId>176</wspyId> <status>fulfilled</status> <referenceId>87962-110037</referenceId> <referenceName>87962-110037</referenceName> <createdAt>2018-02-14 13:04:33</createdAt> <fulfilledAt>2018-02-20 16:27:17</fulfilledAt> <paymentGateway>cod</paymentGateway> <paymentStatus>pending</paymentStatus> <paymentTotalPrice>8940.00</paymentTotalPrice> <paymentTotalDiscounts>1000.00</paymentTotalDiscounts> <paymentCurrency>HUF</paymentCurrency> <shippingMode>GLS</shippingMode> <shippingPrice>1290.00</shippingPrice> <shippingVat>0.27</shippingVat> <paidAt/> <codAmount>1500.00</codAmount> <codCurrency>HUF</codCurrency> <codStatus/> <codReceivedAt/> <trackingCode>WSHPY176</trackingCode> <invoiceStatus/> <invoiceCreatedAt>2018-02-16 00:00:00</invoiceCreatedAt> <invoiceNo>inv#00001</invoiceNo> <refusedInvoiceNo/> <invoiceUrl/> <refusedDate/> <updatedAt>2018-02-26 12:18:17</updatedAt> <products> <elem> <sku>szuperhos-polo-piros-xl</sku> <productName>Szuperhős Póló</productName> <variantName>Piros, XL</variantName> <priceGross>1890.00</priceGross> <vat>0.27</vat> <quantity>3</quantity> </elem> <elem> <sku>cicanaci-one-size</sku> <productName>CicaNaci - One Size</productName> <variantName/> <priceGross>990.00</priceGross> <vat>0.27</vat> <quantity>1</quantity> </elem> <elem> <sku>akcios-sapka</sku> <productName>Akciós sapka</productName> <variantName>Fekete</variantName> <priceGross>1990.00</priceGross> <vat>0.27</vat> <quantity>1</quantity> </elem> </products> </elem> <elem> [ ... ] </elem> [ ... ] </result></response>

Hibás kérés esetén (példa):

<?xml version="1.0" encoding="utf-8"?><response> <status>error</status> <message> <elem>[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)</elem> </message></response>

JSON esetén:

Url: https://app.webshippy.com/wspyapi/GetOrder/json

Kérés:

{ "apiKey": "api-key-comes-here", "page": "0", "limit": "10", "filters": { "wspyId": "", "referenceId": "", "referenceName": "", "paymentStatus": "", "paymentGateway": "", "lastMod": "2018-01-01 00:00:00" }}

Válasz (példa):

{ "status": "success", "message": [], "result": [ { "wspyId": "176", "status": "fulfilled", "referenceId": "87962-110037", "referenceName": "87962-110037", "createdAt": "2018-02-14 13:04:33", "fulfilledAt": "2018-02-20 16:27:17", "paymentGateway": "cod", "paymentStatus": "pending", "paymentTotalPrice": "8940.00", "paymentTotalDiscounts": "1000.00", "paymentCurrency": "HUF", "shippingMode": "GLS", "shippingPrice": "1290.00", "shippingVat": "0.27", "paidAt": null, "codAmount": "1500.00", "codCurrency": "HUF", "codStatus": "", "codReceivedAt": null, "trackingCode": "WSHPY176", "invoiceStatus": "", "invoiceCreatedAt": "2018-02-16 00:00:00", "invoiceNo": "inv#00001", "refusedInvoiceNo": null, "invoiceUrl": null, "refusedDate": null, "updatedAt": "2018-02-26 12:18:17", "products": [ { "sku": "szuperhos-polo-piros-xl", "productName": "Szuperhős Póló", "variantName": "Piros, XL", "priceGross": "1890.00", "vat": "0.27", "quantity": "3" }, { "sku": "cicanaci-one-size", "productName": "CicaNaci - One Size", "variantName": null, "priceGross": "990.00", "vat": "0.27", "quantity": "1" }, { "sku": "akcios-sapka", "productName": "Akciós sapka", "variantName": "Fekete", "priceGross": "1990.00", "vat": "0.27", "quantity": "1" } ] }, { [ ... ] } ]}

Hibás kérés esetén (példa):

{ "status": "error", "message": [ "[field: lastMod]The field must be a valid datetime (eg. yyyy-mm-dd hh:ii:ss)" ]}

Mező

Leírás

status

Művelet eredménye. Lehetséges értékek: success, error

message

Hibás kérés esetén ebbe a mezőbe kerülnek a hibaüzenetek

result

Sikeres kérés esetén ebbe a mezőbe kerül a lekérdezés eredménye, minden esetben tömbként kerül a válaszba

wspyId

Belső azonosító, rendelés létrehozásakor az API visszaadja válaszban

status

A rendelés státusza, lehetséges értékek: new: Új draft: Piszkozat ready: Kész packing: Csomagolás alatt fulfilled: Csomagolt refused: Visszautasított

referenceId

Külső azonosító, rendelés létrehozásakor megadott azonosító

referenceName

Rendelés neve, rendelés létrehozásakor megadott név

createdAt

Rendelés létrehozásának (eredeti) ideje

fulfilledAt

Rendelés csomagolt állapotba kerülésének ideje

paymentStatus

Fizetési státusz

paidAt

Amennyiben fizetve, kifizetés ideje

codAmount

Utánvét összege

codCurrency

Utánvét pénzneme

codStatus

Utánvét státusza

codReceivedAt

Utánvét beérkezésének ideje

trackingCode

Futárszolgálat nyomon követő kódja

invoiceUrl

Számla link a letöltéshez (https://example.com/invoice.pdf)

invoiceStatus

Számlázási állapot uninvoiced: Nincs számlázva invoiced: Számlázva storno: Sztornózva

invoiceCreatedAt

Számla létrehozásának ideje

invoiceNo

Számla azonosítója

refusedInvoiceNo

Sztornó számla azonosítója

refusedDate

Csomag visszaérkezésének ideje, és sztornó számla kelte

updatedAt

Rendszerünkben történt utolsó módosítás dátuma

products

Rendelés termékei, minden esetben tömb

sku

Termék SKU-ja, cikkszáma

productName

Termék neve

variantName

Termékvariáns neve

priceGross

Termék bruttó ára

vat

ÁFA kulcs

quantity

Rendelt mennyiség

serial

A termékhez csomagoláskor rögzített egyedi azonosító (opcionális)

Rendelések létrehozása, módosítása

Ezzel a funkcióval egyszerre lehet létrehozni és módosítani rendeléseket. Amennyiben a megadott referenceId-val még nem szerepel nálunk rendelés, akkor az API létrehozza, azonban ha már szerepel, és a létező rendelés státusza új, vagy piszkozat, valamint még nem történt rajta manuális módosítás, akkor módosítja azt. Sikeres létrehozás, vagy módosítás esetén az API visszaadja a rendelés belső azonosítóját

Mező

Kötelező?

Leírás

apiKey

Igen

API kulcs

order

Igen

Létrehozandó vagy módosítandó rendelés adatai

referenceId

Igen

Külső azonosító, szabadszavas, ajánlott a megrendelés azonosítójának használata

referenceName

Nem

Rendelés neve, szabadszavas, ajánlott a megrendelés azonosítójának használata, vagy egy abból képzett név, például RENDELES#1221

createdAt

Igen

Rendelés létrejöttének ideje

shipping

Igen

Szállítási adatok kerülnek ide

shipping.name

Igen

Címzett neve

shipping.company

Nem

Cég esetén cégnév

shipping.email

Nem

E-mail címe

shipping.phone

Nem

Telefonszáma

shipping.countryCode

Igen

Kétjegyű országkód (pl: HU)

shipping.stateOrProvinceCode

Nem

Állam, tartomány (főleg külföldi címzés esetén fontos)

shipping.zip

Igen

Irányítószám

shipping.city

Igen

Város

shipping.address1

Igen

Cím első sora

shipping.address2

Nem

Cím második sora

shipping.note

Nem

Címhez tartozó megjegyzés, <![CDATA[]]> használata ajánlott

shipping.mode

Nem

Szállítási mód, lehetséges értékek: GLS, FOXPOST-HU, PRIO

shipping.packPoint

Nem

Csomagpont fajtája, lehetséges értékek: FOXPOST-HU, GLS, CSOMAGKULDO

shipping.packPointId

Nem

A csomagpont azonosító Id-je

billing

Nem*

Számlázás adatok (kiszervezett számlázás esetén kötelező)

billing.name

Igen

Számlázási név

billing.company

Nem

Cég esetén cégnév

billing.phone

Nem

Telefonszám

billing.taxNumber

Nem

Adószám

billing.countryCode

Igen

Kétjegyű országkód (pl: HU)

billing.zip

Igen

Irányítószám

billing.city

Igen

Város

billing.address1

Igen

Cím első sora

billing.address2

Nem

Cím második sora

payment

Igen

Fizetéssel kapcsolatos információk

payment.paymentMode

Igen

Fizetési mód, szabadszavas, intelligens felismerést használ, azonban az ajánlott értékek: cod, card, paypal, stb.

payment.codAmount

Nem

Utánvét összege, a végösszegtől eltérhet, ez az érték kerül a futárhoz utánvét összegeként

payment.paymentStatus

Igen

Fizetés státusza, lehetséges értékek: paid, pending. Egyéb esetben egyeztetés szükséges

payment.paidDate

Nem*

Fizetés ideje, fizetett státusz esetén kötelező

payment.shippingPrice

Nem

Szállítási költség összege (Bruttó összeg, ami a vevői számlán szerepelni fog)

payment.shippingVat

Nem

Szállítási költség ÁFA kulcsa

payment.currency

Igen

Megrendelés pénzneme, 3 karakteres (ISO) azonosító, pl: HUF

payment.discount

Nem

Kedvezmény a megrendelés végösszegéből

products

Nem

Rendelés termékei

products.sku

Igen

Termék SKU-ja, cikkszáma

products.productName

Igen

Termék neve

products.variantName

Nem

Termékvariáns neve

products.priceGross

Igen

Termék bruttó egységára

products.vat

Igen

ÁFA kulcs

products.quantity

Igen

Rendelt mennyiség

invoiceUrl

Nem

Számla link a letöltéshez (https://example.com/invoice.pdf)

Csak akkor van jelentősége, ha van az API kapcsolathoz beállítva Manuális PDF számlafeltöltő (ez esetben használja fel a rendszer).

attachmentUrl

Nem

Csatolmány link a letöltéshez (https://example.com/attachment.pdf)

Például a használati útmutató a termékhez. Egy rendeléshez 1 pdf melléklet csatolható és minden esetben nyomtatásra kerül.

pdfSource

Nem

Pdf formátumú számla fájl base64 kódolással Csak akkor van jelentősége, ha van az API kapcsolathoz beállítva Manuális PDF számlafeltöltő

XML esetén:

Url: https://app.webshippy.com/wspyapi/CreateOrder/xml

Kérés:

<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey> <order> <referenceId>87962-110037</referenceId> <referenceName>87962-110037</referenceName> <createdAt>2018-02-14 13:04:33</createdAt> <shipping> <name>Kováts Béla</name> <company>Virág Bt.</company> <email>[email protected]</email> <phone>+36301234567</phone> <countryCode>HU</countryCode> <stateOrProvinceCode></stateOrProvinceCode> <zip>1234</zip> <city>Budapest</city> <address1>Virág utca 25.</address1> <address2></address2> <note><![CDATA[Szállításkor kérem a futárt, hogy ne csengessen!!!]]></note> <mode>GLS</mode> </shipping> <billing> <name>Kováts Béla</name> <company>Virág Bt.</company> <phone>+36301234567</phone> <countryCode>HU</countryCode> <zip>1234</zip> <city>Budapest</city> <address1>Virág utca 25.</address1> <address2></address2> </billing> <payment> <paymentMode>COD</paymentMode> <codAmount>1500.00</codAmount> <paymentStatus>pending</paymentStatus> <paidDate></paidDate> <shippingPrice>1290.00</shippingPrice> <shippingVat>0.27</shippingVat> <currency>HUF</currency> <discount>1000.00</discount> </payment> <products> <elem> <sku>szuperhos-polo-piros-xl</sku> <productName>Szuperhős Póló</productName> <variantName>Piros, XL</variantName> <priceGross>1890.00</priceGross> <vat>0.27</vat> <quantity>3</quantity> </elem> <elem> <sku>cicanaci-one-size</sku> <productName>CicaNaci - One Size</productName> <priceGross>990.00</priceGross> <vat>0.27</vat> <quantity>1</quantity> </elem> <elem> <sku>akcios-sapka</sku> <productName>Akciós sapka</productName> <variantName>Fekete</variantName> <priceGross>1990.00</priceGross> <vat>0.27</vat> <quantity>1</quantity> </elem> </products> </order></request>

Válasz (példa):

<?xml version="1.0" encoding="utf-8"?><response> <status>success</status> <message> <elem>The order creation was successful</elem> </message> <wspyId>176</wspyId></response>

JSON esetén

Url: https://app.webshippy.com/wspyapi/CreateOrder/json

Kérés:

{ "apiKey": "api-key-comes-here", "order": { "referenceId": "87962-110037", "referenceName": "87962-110037", "createdAt": "2018-02-14 13:04:33", "shipping": { "name": "Kov\u00e1ts B\u00e9la", "company": "Vir\u00e1g Bt.", "email": "[email protected]", "phone": "+36301234567", "countryCode": "HU", "stateOrProvinceCode": "", "zip": "1234", "city": "Budapest", "address1": "Vir\u00e1g utca 25.", "address2": "", "note": "", "mode": "GLS" }, "billing": { "name": "Kov\u00e1ts B\u00e9la", "company": "Vir\u00e1g Bt.", "phone": "+36301234567", "countryCode": "HU", "zip": "1234", "city": "Budapest", "address1": "Vir\u00e1g utca 25.", "address2": "" }, "payment": { "paymentMode": "COD", "codAmount": "1500.00", "paymentStatus": "pending", "paidDate": "", "shippingPrice": "1290.00", "shippingVat": "0.27", "currency": "HUF", "discount": "1000.00" }, "products": [ { "sku": "szuperhos-polo-piros-xl", "productName": "Szuperh\u0151s P\u00f3l\u00f3", "variantName": "Piros, XL", "priceGross": "1890.00", "vat": "0.27", "quantity": "3" }, { "sku": "cicanaci-one-size", "productName": "CicaNaci - One Size", "priceGross": "990.00", "vat": "0.27", "quantity": "1" }, { "sku": "akcios-sapka", "productName": "Akci\u00f3s sapka", "variantName": "Fekete", "priceGross": "1990.00", "vat": "0.27", "quantity": "1" } ] }}

Válasz (példa):

{ "status": "success", "message": [ "The order creation was successful" ], "wspyId": 176}

További válaszlehetőségek:

  • The order creation was successful

  • The order modification was successful

Rendelés törlése

JSON esetén:

Url: https://app.webshippy.com/wspyapi/deleteOrder/json

Kérés:

{ "apiKey": "api-key-comes-here", "filters": { "wspyId": "917872738" }}

XMLesetén:

Url: https://app.webshippy.com/wspyapi/deleteOrder/xml

Kérés:

<?xml version="1.0" encoding="utf-8"?><request> <apiKey>api-key-comes-here</apiKey> <filters> <wspyId>917872738</wspyId> </filters></request>

Szűrési feltétel

Leírás

wspyId

Belső azonosító, rendelés létrehozásakor az API visszaadja válaszban

referenceId

Külső azonosító, rendelés létrehozásakor megadott azonosító

referenceName

Rendelés neve, rendelés létrehozásakor megadott név

Egyszerre csak egy rendelés törölhető! Olyan rendelést, amit a Webshippy rendszer felületén a felhasználó manuálisan módosított, API hívással nem lehet törölni.