Order API
Rendelésekkel kapcsolatos API funkciók
Rendelések lekérdezése
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-HU</shippingMode>
<packPoint>GLS</packPoint>
<packPointId>123</packPointId>
<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,
"paymentTotalDiscounts": 1000,
"paymentCurrency": "HUF",
"shippingMode": "GLS-HU",
"packPoint": "GLS",
"packPointId": "123",
"shippingPrice": 1290,
"shippingVat": 0.27,
"paidAt": "",
"codAmount": 1500,
"codCurrency": "HUF",
"codStatus": "",
"codReceivedAt": "",
"trackingCode": "WSHPY176",
"invoiceStatus": "",
"invoiceCreatedAt": "2018-02-16 00:00:00",
"invoiceNo": "inv#00001",
"refusedInvoiceNo": "",
"invoiceUrl": "",
"refusedDate": "",
"updatedAt": "2018-02-26 12:18:17",
"products": [
{
"sku": "szuperhos-polo-piros-xl",
"productName": "Szuperhős Póló",
"variantName": "Piros, XL",
"priceGross": 1890,
"vat": 0.27,
"quantity": 3
},
{
"sku": "cicanaci-one-size",
"productName": "CicaNaci - One Size",
"variantName": "",
"priceGross": 990,
"vat": 0.27,
"quantity": 1
},
{
"sku": "akcios-sapka",
"productName": "Akciós sapka",
"variantName": "Fekete",
"priceGross": 1990,
"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)"
]
}
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. Amennyiben 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.
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>bela@viragbt.hu</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-HU</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": "bela@viragbt.hu",
"phone": "+36301234567",
"countryCode": "HU",
"stateOrProvinceCode": "",
"zip": "1234",
"city": "Budapest",
"address1": "Vir\u00e1g utca 25.",
"address2": "",
"note": "",
"mode": "GLS-HU"
},
"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
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>
Válasz:
<?xml version="1.0" encoding="utf-8"?>
<response>
<status>error</status>
<message>
<elem>Error: Order is already modified!</elem>
</message>
<wspyId>12345678</wspyId>
<referenceId/>
<referenceName>WSP#12345678</referenceName>
</response>
JSON esetén:
Url: https://app.webshippy.com/wspyapi/deleteOrder/json
Kérés:
{
"apiKey": "api-key-comes-here",
"filters": {
"wspyId": "917872738"
}
}
Válasz (példa):
{
"status": "error",
"message": [
{
"Error": "Order is already modified!"
}
]
}
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.
Csak "new" vagy "draft" státusszal rendelkező megrendelések törölhetőek.
Last updated