> For the complete documentation index, see [llms.txt](https://apidoc.webshippy.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidoc.webshippy.com/webaruhaz-integraciok/order-api.md).

# Order API

### **Rendelések lekérdezése**

| Szűrési feltétel | Leírás                                                                                                                                         |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `page`           | <p>A lekérdezendő oldal sorszáma.</p><p>(Alapértelmezett: 0.)</p>                                                                              |
| `limit`          | <p>Az egy oldalon szereplő találatok száma.</p><p>(Alapértelmezett: 100, maximum: 1000.)</p>                                                   |
| `wspyId`         | <p>Belső azonosító.</p><p>A rendelés létrehozásakor az API visszaadja válaszban.</p>                                                           |
| `referenceId`    | <p>Külső azonosító.</p><p>A rendelés létrehozásakor megadott azonosító.</p>                                                                    |
| `referenceName`  | <p>A rendelés neve.</p><p>A rendelés létrehozásakor megadott név.</p>                                                                          |
| `paymentStatus`  | <p>A fizetési státusz, lehetséges értékek:</p><ul><li><code>paid</code>, </li><li><code>pending</code>, </li><li>stb.</li></ul>                |
| `paymentGateway` | <p>A fizetés módja, lehetséges értékek:</p><ul><li><code>cod</code>, </li><li><code>card</code>, </li><li>stb.</li></ul>                       |
| `lastMod`        | <p>Az utolsó módosítás dátuma.</p><p>A megadott dátum után létrehozott vagy módosított rendeléseket listázza ki, akár egyszerre többet is.</p> |

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)"  
  ]
}
```

| Mező               | Leírás                                                                                                                                                                                                                                                                                                      |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `status`           | <p>A művelet eredménye, lehetséges értékek: </p><ul><li><code>success</code>: sikeres,</li><li><code>error</code>: hiba.</li></ul>                                                                                                                                                                          |
| `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`           | <p>Belső azonosító.</p><p>A rendelés létrehozásakor az API visszaadja válaszban.</p>                                                                                                                                                                                                                        |
| `status`           | <p>A rendelés státusza, lehetséges értékek:</p><ul><li><code>new</code>: új,</li><li><code>draft</code>: piszkozat,</li><li><code>ready</code>: kész,</li><li><code>packing</code>: csomagolás alatt,</li><li><code>fulfilled</code>: teljesített,</li><li><code>refused</code>: visszautasított.</li></ul> |
| `referenceId`      | <p>Külső azonosító.</p><p>A rendelés létrehozásakor megadott azonosító.</p>                                                                                                                                                                                                                                 |
| `referenceName`    | <p>A rendelés neve.</p><p>A rendelés létrehozásakor megadott név.</p>                                                                                                                                                                                                                                       |
| `createdAt`        | A rendelés létrehozásának (eredeti) ideje.                                                                                                                                                                                                                                                                  |
| `fulfilledAt`      | A rendelés csomagolt állapotba kerülésének ideje.                                                                                                                                                                                                                                                           |
| `paymentStatus`    | <p>A fizetési státusz, lehetséges értékek:</p><ul><li><code>paid</code>, </li><li><code>pending</code>, </li><li>stb.</li></ul>                                                                                                                                                                             |
| `paidAt`           | Amennyiben `paid` (fizetve), a kifizetés ideje.                                                                                                                                                                                                                                                             |
| `codAmount`        | Az utánvét összege.                                                                                                                                                                                                                                                                                         |
| `codCurrency`      | Az utánvét pénzneme.                                                                                                                                                                                                                                                                                        |
| `codStatus`        | Az utánvét státusza.                                                                                                                                                                                                                                                                                        |
| `codReceivedAt`    | Az utánvét beérkezésének ideje.                                                                                                                                                                                                                                                                             |
| `trackingCode`     | A futárszolgálat nyomon követő kódja. Több csomagos megrendelés esetén a főcsomag kódja.                                                                                                                                                                                                                    |
| `invoiceUrl`       | <p>Számla link a letöltéshez.</p><p><a href="http://example.com/invoice.pdf"><https://example.com/invoice.pdf></a></p>                                                                                                                                                                                      |
| `invoiceStatus`    | <p>A számlázási állapot, lehetséges értékek:</p><ul><li><code>uninvoiced</code>: nincs számlázva,</li><li><code>invoiced</code>: számlázva,</li><li><code>storno</code>: sztornózva.</li></ul>                                                                                                              |
| `invoiceCreatedAt` | A számla létrehozásának ideje.                                                                                                                                                                                                                                                                              |
| `invoiceNo`        | A számla azonosítója.                                                                                                                                                                                                                                                                                       |
| `refusedInvoiceNo` | A sztornó számla azonosítója.                                                                                                                                                                                                                                                                               |
| `refusedDate`      | A csomag visszaérkezésének ideje, és a sztornó számla kelte.                                                                                                                                                                                                                                                |
| `updatedAt`        | A rendszerünkben történt utolsó módosítás dátuma.                                                                                                                                                                                                                                                           |
| `products`         | A rendelés termékei, minden esetben tömb.                                                                                                                                                                                                                                                                   |
| `sku`              | A termék SKU-ja (cikkszáma).                                                                                                                                                                                                                                                                                |
| `productName`      | A termék neve.                                                                                                                                                                                                                                                                                              |
| `variantName`      | A termékvariáns neve.                                                                                                                                                                                                                                                                                       |
| `priceGross`       | A termék bruttó ára.                                                                                                                                                                                                                                                                                        |
| `vat`              | Az ÁFA kulcs.                                                                                                                                                                                                                                                                                               |
| `quantity`         | A rendelt mennyiség.                                                                                                                                                                                                                                                                                        |
| `serial`           | <p>A termékhez csomagoláskor rögzített egyedi azonosító.</p><p>(Opcionális.)</p>                                                                                                                                                                                                                            |

### **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.

<table data-header-hidden><thead><tr><th>Mező</th><th width="115.33333333333331">Kötelező?</th><th>Leírás</th></tr></thead><tbody><tr><td>Mező</td><td>Kötelező?</td><td>Leírás</td></tr><tr><td><code>apiKey</code></td><td>Igen</td><td>Az API kulcs.</td></tr><tr><td><code>order</code></td><td>Igen</td><td>A létrehozandó vagy módosítandó rendelés adatai.</td></tr><tr><td><code>referenceId</code></td><td>Igen</td><td><p>Külső azonosító. </p><p>Szabadszavas, ajánlott a megrendelés azonosítójának használata.</p></td></tr><tr><td><code>referenceName</code></td><td>Nem</td><td><p>A rendelés neve.</p><p>A rendelés létrehozásakor megadott név.</p><p>Szabadszavas, ajánlott a megrendelés azonosítójának használata, vagy egy abból képzett név.</p><p>(pl.:<code>RENDELES#1221</code>)</p></td></tr><tr><td><code>createdAt</code></td><td>Igen</td><td>A rendelés létrejöttének ideje.</td></tr><tr><td><code>shipping</code></td><td>Igen</td><td>A szállítási adatai.</td></tr><tr><td><code>shipping.name</code></td><td>Igen</td><td>A címzett neve.</td></tr><tr><td><code>shipping.company</code></td><td>Nem</td><td>Cég esetén, a cégnév.</td></tr><tr><td><code>shipping.email</code></td><td>Nem</td><td>E-mail cím.</td></tr><tr><td><code>shipping.phone</code></td><td>Nem</td><td>Telefonszám.</td></tr><tr><td><code>shipping.countryCode</code></td><td>Igen</td><td><p>Kétjegyű országkód. </p><p>(pl.: <code>HU</code>)</p></td></tr><tr><td><code>shipping.stateOrProvinceCode</code></td><td>Nem</td><td><p>Állam, tartomány.</p><p>(Főleg külföldi címzés esetén fontos.)</p></td></tr><tr><td><code>shipping.zip</code></td><td>Igen</td><td>Irányítószám.</td></tr><tr><td><code>shipping.city</code></td><td>Igen</td><td>Város.</td></tr><tr><td><code>shipping.address1</code></td><td>Igen</td><td>A cím első sora.</td></tr><tr><td><code>shipping.address2</code></td><td>Nem</td><td>A cím második sora.</td></tr><tr><td><code>shipping.note</code></td><td>Nem</td><td><p>A címhez tartozó megjegyzés, <code>&#x3C;![CDATA[]]></code>.</p><p>(Használata ajánlott.)</p></td></tr><tr><td><code>shipping.mode</code></td><td>Nem</td><td><p>A szállítási mód, lehetséges értékek:</p><ul><li><code>GLS-HU</code>,</li><li><code>DPD-HU,</code></li><li><code>FOXPOST-HU</code>,</li><li><code>PRIO</code>, </li><li><code>DHL</code>,</li><li><code>SPRINTER</code>,</li><li><code>GLS-SK</code>,</li><li><code>MPL.</code></li></ul></td></tr><tr><td><code>shipping.packPoint</code></td><td>Nem</td><td><p>A csomagpont fajtája, lehetséges értékek: </p><ul><li><code>GLS</code>,</li><li><code>FOXPOST-HU</code>,</li><li><code>CSOMAGKULDO</code>,</li><li><code>MPL</code>,</li><li><code>SPRINTER,</code></li><li><code>EUSHIPMENTS-328-ROMANIA-SAMEDAY,</code></li><li><code>EUSHIPMENTS-643-POLAND-INPOST-LOCKERS,</code></li><li><code>EUSHIPMENTS-722-CROATIA-GLS-LOCKERS,</code></li><li><code>EUSHIPMENTS-15-BULGARIA-ECONT.</code></li></ul></td></tr><tr><td><code>shipping.packPointId</code></td><td>Nem</td><td>A csomagpont azonosító Id-je.</td></tr><tr><td><code>billing</code></td><td>Nem*</td><td><p>A számlázás adatok.</p><p>(Kiszervezett számlázás esetén kötelező.)</p></td></tr><tr><td><code>billing.name</code></td><td>Igen</td><td>A számlázási név.</td></tr><tr><td><code>billing.company</code></td><td>Nem</td><td>Cég esetén, a cégnév.</td></tr><tr><td><code>billing.phone</code></td><td>Nem</td><td>Telefonszám.</td></tr><tr><td><code>billing.taxNumber</code></td><td>Nem</td><td>Adószám.</td></tr><tr><td><code>billing.countryCode</code></td><td>Igen</td><td><p>Kétjegyű országkód. </p><p>(pl.: <code>HU</code>)</p></td></tr><tr><td><code>billing.zip</code></td><td>Igen</td><td>Irányítószám.</td></tr><tr><td><code>billing.city</code></td><td>Igen</td><td>Város.</td></tr><tr><td><code>billing.address1</code></td><td>Igen</td><td>A cím első sora.</td></tr><tr><td><code>billing.address2</code></td><td>Nem</td><td>A cím második sora.</td></tr><tr><td><code>payment</code></td><td>Igen</td><td>A fizetéssel kapcsolatos információk.</td></tr><tr><td><code>payment.paymentMode</code></td><td>Igen</td><td><p>A fizetési mód, szabadszavas, intelligens felismerést használ, azonban az ajánlott értékek:</p><ul><li> <code>cod</code>, </li><li><code>card</code>, </li><li><code>paypal</code>, </li><li>stb.</li></ul></td></tr><tr><td><code>payment.codAmount</code></td><td>Nem</td><td><p>Az utánvét összege. </p><p>A végösszegtől eltérhet, ez az érték kerül a futárhoz utánvét összegeként.</p></td></tr><tr><td><code>payment.paymentStatus</code></td><td>Igen</td><td><p>A fizetés státusza, lehetséges értékek: </p><ul><li><code>paid</code>, </li><li><code>pending</code>. </li></ul><p>Egyéb esetben egyeztetés szükséges.</p></td></tr><tr><td><code>payment.paidDate</code></td><td>Nem*</td><td><p>A fizetés ideje. </p><p><code>paid</code> (fizetve) státusz esetén kötelező. </p></td></tr><tr><td><code>payment.shippingPrice</code></td><td>Nem</td><td><p>A szállítási költség összege.</p><p>(Bruttó összeg, ami a vevői számlán szerepelni fog.)</p></td></tr><tr><td><code>payment.shippingVat</code></td><td>Nem</td><td>A szállítási költség ÁFA kulcsa.</td></tr><tr><td><code>payment.currency</code></td><td>Igen</td><td><p>A rendelés pénzneme, 3 karakteres (ISO) azonosító.</p><p>(pl.: <code>HUF</code>)</p></td></tr><tr><td><code>payment.discount</code></td><td>Nem</td><td>Kedvezmény a megrendelés végösszegéből.</td></tr><tr><td><code>products</code></td><td>Nem</td><td>A rendelés termékei.</td></tr><tr><td><code>products.sku</code></td><td>Igen</td><td>A termék SKU-ja (cikkszáma).</td></tr><tr><td><code>products.productName</code></td><td>Igen</td><td>A termék neve.</td></tr><tr><td><code>products.variantName</code></td><td>Nem</td><td>A termékvariáns neve.</td></tr><tr><td><code>products.priceGross</code></td><td>Igen</td><td>A termék bruttó egységára.</td></tr><tr><td><code>products.vat</code></td><td>Igen</td><td>A termék ÁFA kulcsa.</td></tr><tr><td><code>products.quantity</code></td><td>Igen</td><td>A termékből rendelt mennyiség.</td></tr><tr><td><code>invoiceUrl</code></td><td>Nem</td><td><p>Számla link a letöltéshez.</p><p><a href="http://example.com/invoice.pdf">https://example.com/invoice.pdf</a></p><p>Csak akkor van jelentősége, ha van Manuális PDF számlafeltöltő beállítva az API kapcsolathoz, mert ebben az esetben használja fel a rendszer.</p></td></tr><tr><td><code>attachmentUrl</code></td><td>Nem</td><td><p>Csatolmány link a letöltéshez.</p><p><a href="http://example.com/invoice.pdf">https://example.com/attachment.pdf</a></p><p>Egy rendeléshez 1 pdf melléklet csatolható és minden esetben nyomtatásra kerül.</p><p>(pl. A használati útmutató a termékhez.)</p></td></tr><tr><td><code>pdfSource</code></td><td>Nem</td><td><p>Pdf formátumú számla fájl base64 kódolással.</p><p>Csak akkor van jelentősége, ha van Manuális PDF számlafeltöltő beállítva az API kapcsolathoz, mert ebben az esetben használja fel a rendszer.</p></td></tr></tbody></table>

**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**

**XML**eseté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!"
        }
    ]
}
```

| Szűrési feltétel | Leírás                                                                               |
| ---------------- | ------------------------------------------------------------------------------------ |
| `wspyId`         | <p>Belső azonosító.</p><p>A rendelés létrehozásakor az API visszaadja válaszban.</p> |
| `referenceId`    | <p>Külső azonosító. </p><p>A rendelés létrehozásakor megadott azonosító.</p>         |
| `referenceName`  | <p>A rendelés neve. </p><p>A rendelés létrehozásakor megadott név.</p>               |

{% hint style="info" %}
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.&#x20;

Csak "new" vagy "draft" státusszal rendelkező megrendelések törölhetőek.
{% endhint %}