Integrace s API Snadné vrácení

Pomocí API jednoduše integrujete svou platformu se službou Snadné vrácení. Níže naleznete všechny potřebné informace k integraci (ukázkovou implementaci i dostupné endpointy).

Pro připojení k API budete potřebovat číslo HID. Jedná se o speciální identifikátor umožňující integraci. Získáte jej kontaktováním svého obchodního zástupce. Pokud využíváte více skladů pro vrácení, budete potřebovat více čísel HID – jedno pro každý sklad. V takovém případě se obraťte na svého obchodního zástupce s žádostí o vytvoření odpovídajících komponent v naší službě.

Integrace spočívá v předávání dat z Vašeho systému do našeho API. V odpovědi následně obdržíte jedinečnou URL adresu pro zákazníka, na které může dokončit proces vrácení bez nutnosti opětovného vyplňování údajů.

Ukázková implementace

Předávání dat pro vrácení

POST https://api.snadnevraceni.cz/order/return-draft
Content-Type: application/json

{
  "mailboxHid": "6b147e91-dc99-4cef-9665-5bb7c693f6c6",
  "order": {
    "number": "2022231345",
    "date_created": "2022-05-21 12:33:11",
    "products": [
      {
        "name": "Tričko",
        "description": "string",
        "link": "https://muj-obchod.cz/produkt/123456",
        "unit_price": 12.3,
        "quantity": 1,
        "unit": "ks",
        "img": "https://muj-obchod.cz/img/product.png",
        "attributes": {
          "color": "Modra",
          "size": "42"
        }
      }
    ],
    "client": {
      "name": "Jan Ukázkový",
      "email": "[email protected]",
      "city": "Praha",
      "address": "Ukázková 12",
      "postal_code": "110 00",
      "phone": "+420 123 123 123",
      "country": "CZ"
    }
  },
  "isEmailEditable": true,
  "isOrderNumberEditable": true
}

{
  "hid": "6b147e91-dc99-4cef-9665-5bb7c693f6c6",
  "link": "https://snadnevraceni.cz/sklep?draft=2b600349-642b-4218-90fc-128c3a5e3f23"
}

{
  "errors": [
    {
      "message": "Chybí odpovídající vstupní data",
      "code": "400",
      "level": "critical"
    }
  ],
  "mainError": {
    "message": "Chybí odpovídající vstupní data",
    "code": "400",
    "level": "critical"
  },
  "failure": true,
  "successful": false
}