Webáruházak integrálása

WebShippy API integráció segédlet

422 views March 13, 2018 September 5, 2018 Perényi András 2

A Webshippy rendeléskezelő és csomagolás-optimalizáló szoftvere lehetővé teszi, hogy a webáruházadba érkező rendeléseket valós időben lássuk és amennyiben a raktárkészlet lehetővé teszi, azonnal csomagoljuk és átadjuk a szállítmányozó partnerek részére kiszállításra. A rendszerben lehetőséged van nyomon követni a csomagjaid állapotát, valamint naprakész információkhoz férsz hozzá a pénzügyeiddel kapcsolatban.

Bevezető

Ez a leírás bemutatja, hogy az E-commerce szolgáltatások hogyan tudják használni a WebShippy rendszerét. Az API három fő esetet támogat, melyek szükségesek az E-commerce rendszerekhez:

  • Rendelések szinkronizálása (létrehozás, módosítás, törlés, lekérdezés)
  • Termékek szinkronizálása (létrehozás, módosítás, törlés, lekérdezés, készletinfó)
  • Áruszállítások kezelése (létrehozás, módosítás, törlés, lekérdezés)

A WSAPI a biztonság érdekében HTTPS csatornát használ, az UTF-8 karakterkódolást támogatja, valamint képes kommunikálni XML és JSON formátumban is.

  • API XML url: https://app.webshippy.com/wspyapi/{ACTION}/xml
  • API JSON url: https://app.webshippy.com/wspyapi/{ACTION}/json

Ahol az {ACTION} helyőrző a kért funkciót/akciót jelenti.

API kulcs generálása

A Webshippy API minden esetben egy külön értékesítési csatornaként jelenik meg a Webshippy Admin rendszerében. Ahhoz, hogy sikeres adatkommunikáció jöjjön létre, rendelkeznünk kell egy saját API kulcssal. Ennek létrehozásához navigálj a Beállítások / Webáruházak kezelése oldalra, majd a Webshippy.API gombra kattinva hozz létre egy új értékesítési csatornát. Az alapadatok kitöltése után a rendszer legenerálja az API kulcsot, ami innentől kezdve készen áll a kommunikációra.

Az API hívásokról röviden

Az API minden esetben POST metódust használ, és az átadott adatokat a request mező tartalmazza JSON vagy XML String-ként.

Példa a PHP alapú API hívásra:
$request = '<?xml version="1.0" encoding="UTF-8"?>
<request>
  <apiKey>apiKey</apiKey>
  <filters>
    <lastMod>2018-01-01 00:00:00</lastMod>
  </filters>
</request>';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://app.webshippy.com/wspyapi/GetProduct/xml/');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(['request' => $request]));

$result = curl_exec($ch);

Funciók

Rendelésekkel kapcsolatos 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 mebő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 nyomonkövető kódja
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
invoiceUrl Számla elérési útja
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

Rendelés 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 azt, 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ő azonsosí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
name Igen Címzett neve
company Nem Cég esetén cégnév
email Nem E-mail címe
phone Nem Telefonszáma
countryCode Igen Kétjegyű országkód (pl: HU)
stateOrProvinceCode Nem Állam, tartomány (főleg külföldi címzés esetén fontos)
zip Igen Irányítószám
city Igen Város
address1 Igen Cím első sora
address2 Nem Cím második sora
note Nem Címhez tartozó megjegyzés, <![CDATA[]]> használata ajánlott
mode Nem Szállítási mód
billing Nem* Számlázás adatok, általunk történő számlázás esetén kötelező
name Igen Számlázási név
company Nem Cég esetén cégnév
phone Nem Telefonszám
countryCode Igen Kétjegyű országkód (pl: HU)
zip Igen Irányítószám
city Igen Város
address1 Igen Cím első sora
address2 Nem Cím második sora
payment Igen Fizetéssel kapcsolatos információk
paymentMode Igen Fizetési mód, szabadszavas, intelligens felismerést használ, azonban az ajánlott értékek: cod, card, paypal, stb.
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
paymentStatus Igen Fizetés státusza, lehetséges értélek: paid, pending. Egyéb esetben egyeztetés szükséges
paidDate Nem* Fizetés ideje, fizetett státusz esetén kötelező
shippingPrice Nem Szállítási költség összege (Bruttó)
shippingVat Nem Szállítási költség ÁFA kulcsa
currency Igen Megrendelés pénzneme, 3 karakteres (ISO) azonosító, pl: HUF
discount Nem Kedvezmény a megrendelés végösszegéből
products Nem Rendelés termékei
sku Igen Termék SKU-ja, cikkszáma
productName Igen Termék neve
variantName Nem Termékvariáns neve
priceGross Igen Termék bruttó ára
vat Igen ÁFA kulcs
quantity Igen Rendelt mennyiség

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</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"
    },
    "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

Hamarosan…

Termékekkel kapcsolatos funkciók

Termékek 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ó, termék létrehozásakor az API visszaadja válaszban
referenceId Külső azonosító, termék létrehozásakor megadott azonosító
productName Termék neve, termék létrehozásakor megadott név (SQL wildcard-ok engedélyezettek)
sku Termék SKU-ja, cikkszáma
barcode Termék vonalkódja
lastMod Utolsó módosítás dátuma. A megadott dátum után létrehozott vagy módosított termékeket 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/GetProduct/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>
    <productName></productName>
    <sku></sku>
    <barcode></barcode>
    <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>74210</wspyId>
      <referenceId>1231</referenceId>
      <sku>szuperhos-polo-piros-xl</sku>
      <barcode>126510305031</barcode>
      <productName>Szuperhős Póló</productName>
      <variantName>Piros, XL</variantName>
      <productType>clothes</productType>
      <quantity>191</quantity>
      <updatedAt>2018-03-12 11:59:35</updatedAt>
    </elem>
    <elem>
      <wspyId>74211</wspyId>
      <referenceId>1232</referenceId>
      <sku>cicanaci-one-size</sku>
      <barcode>126510305032</barcode>
      <productName>CicaNaci - One Size</productName>
      <variantName/>
      <productType>clothes</productType>
      <quantity>197</quantity>
      <updatedAt>2018-03-12 11:59:32</updatedAt>
    </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/GetProduct/json

Kérés:

{
  "apiKey": "api-key-comes-here",
  "page": "0",
  "limit": "10",
  "filters": {
    "wspyId": "",
    "referenceId": "",
    "productName": "",
    "sku": "",
    "barcode": "",
    "lastMod": "2018-01-01 00:00:00"
  }
}

Válasz (példa):

{
  "status": "success",
  "message": [],
  "result": [
    {
      "wspyId": "74210",
      "referenceId": "1231",
      "sku": "szuperhos-polo-piros-xl",
      "barcode": "126510305031",
      "productName": "Szuperhős Póló",
      "variantName": "Piros, XL",
      "productType": "clothes",
      "quantity": "191",
      "updatedAt": "2018-03-12 11:59:35"
    },
    {
      "wspyId": "74211",
      "referenceId": "1232",
      "sku": "cicanaci-one-size",
      "barcode": "126510305032",
      "productName": "CicaNaci - One Size",
      "variantName": "",
      "productType": "clothes",
      "quantity": "197",
      "updatedAt": "2018-03-12 11:59:32"
    },
    {
      [ ... ]
    }
  ]
}

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 mebőbe kerül a lekérdezés eredménye, minden esetben tömbként kerül a válaszba
wspyId Belső azonosító, termék létrehozásakor az API visszaadja válaszban
referenceId Külső azonosító, termék létrehozásakor megadott azonosító
sku Termék SKU-ja, cikkszáma
barcode Termék vonalkódja
productName Termék neve
variantName Termék variáns neve
productType Termék típusa
quantity Termék raktárkészlet állapota (csak a szabad készletet tartalmazza, a rendelésekhez lefoglalt mennyiségeket nem
updatedAt Termék utolsó módosításának ideje

Termék létrehozása, módosítása

Ezzel a funkcióval egyszerre lehet létrehozni és módosítani termékeket, amennyiben a megadott sku-val még nem szerepel nálunk termék, akkor az API létrehozza azt, azonban ha már szerepel, akkor módosítja azt. Módosításnál a productName, variantName, productType és referenceId mezők szabadon módosíthatóak, de a barcode, weight, width, height és deep mezők csak akkor, ha nálunk még nincs megadva ezek az adatok. Sikeres létrehozás, vagy módosítás esetén az API visszaadja a rendelés belső azonsosítóját

Mező Kötelező? Leírás
apiKey Igen API kulcs
product Igen Létrehozandó vagy módosítandó termék adatai
referenceId Nem Külső azonosító, szabadszavas, ajánlott a termék azonosítójának használata
sku Igen Termék SKU-ja, cikkszáma
barcode Nem Termék vonalkódja
productName Igen Termék neve
variantName Nem Termék variáns neve (pl.: szín, méret)
productType Nem Termék típusa
weight Nem Termék tömege (kg-ban, lebegőpontos szám)
width Nem Termék szélessége (cm-ben, egész szám)
height Nem Termék magassága (cm-ben, egész szám)
deep Nem Termék mélysége (cm-ben, egész szám)

XML esetén:

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

Kérés:

<?xml version="1.0" encoding="utf-8"?>
<request>
  <apiKey>api-key-comes-here</apiKey>
  <product>
    <referenceId>1231</referenceId>
    <sku>szuperhos-polo-piros-xl</sku>
    <barcode>126510305031</barcode>
    <productName>Szuperhős Póló</productName>
    <variantName>Piros, XL</variantName>
    <productType>clothes</productType>
    <weight>1.25</weight>
    <width>32</width>
    <height>35</height>
    <deep>5</deep>
  </product>
</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>74210</wspyId>
</response>

JSON esetén:

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

Kérés:

{
  "apiKey": "api-key-comes-here",
  "product": {
    "referenceId": "1231",
    "sku": "szuperhos-polo-piros-xl",
    "barcode": "126510305031",
    "productName": "Szuperhős Póló",
    "variantName": "Piros, XL",
    "productType": "clothes",
    "weight": "1.25",
    "width": "32",
    "height": "35",
    "deep": "5"
  }
}

Válasz (példa):

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

További válaszlehetőségek:

  • The order creation was successful
  • The order modification was successful
  • No changes detected in product

Termék törlése

Hamarosan…

Áruszállításokkal kapcsolatos funkciók

Ezzel a funkcióval áruszállítások hozhatók létre.

Mező Kötelező? Leírás
apiKey Igen API kulcs
direction Igen Létrehozandó áruszállítás iránya (in/out)
note Nem Megjegyzés az áruszállításhoz
date Igen Az áruszállítás várható dátuma
quantity Igen Szállított termék mennyisége (pozitív egész)
sku Igen Szállított termék sku

XML esetén:

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

Kérés:

<?xml version="1.0" encoding="utf-8"?>
<request>
 <apiKey>api-key-comes-here</apiKey>
 <transfer>
     <direction>in</direction>
     <note>délután érkezik</note>
     <date>2018-01-01</date>
     <products>
       <elem>
         <quantity>3</quantity>
         <sku>4345</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>67657</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>56464</sku>
       </elem>
     </products>
 </transfer>
</request>

Válasz (példa):

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>success</status>
  <message>
    <elem>The transfer creation was successful</elem>
  </message>
  <transfer_id>74210</transfer_id>
</response>

JSON esetén:

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

Kérés:

{
  "apiKey": "api-key-comes-here",
  "transfer": {
  "direction": "in",
  "transfer_id": 59,
  "note": "délután viszik el",
  "date": "2018-08-20",
  "products": [
   {
     "quantity": 3,
     "sku": 343545
   },
   {
     "quantity": 2,
     "sku": 654564
   },
   {
     "quantity": 1,
     "sku": 32432432
   }
   ]
 }
}

Válasz (példa):

{
  "status": "success",
  "message": [
    "The transfer creation was successful"
  ],
  "transfer_id": 176
}

Hasznos volt ez a tartalom?

Leave A Comment

*
*