Snadné Vrácení - Integrace API

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

Objednávka

Jan Ukázkový

ul. Ukázková 12

110 00 Praha

jan@ukazkovy.cz

+420 123 123 123

Číslo objednávky: 2022231345

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

POST https://api.snadnevraceni.cz/partner-api/v1/returns/draft
Content-Type: application/json

{
  "mailbox_hid": "6b147e91-dc99-4cef-9665-5bb7c693f6c6",
  "order": {
    "number": "2022231345",
    "date_created": "2022-05-21 12:33:11",
    "currency": "CZK",
    "products": [
      {
        "id": "PROD-123456",
        "name": "Tričko",
        "link": "https://muj-obchod.cz/produkt/123456",
        "unit_price": "12.30",
        "quantity": 1,
        "unit": "ks",
        "img": "https://muj-obchod.cz/img/product.png",
        "is_returnable": true,
        "attributes": {
          "color": "Modra",
          "size": "42"
        }
      }
    ],
    "client": {
      "name": "Jan Ukázkový",
      "email": "jan@ukazkovy.cz",
      "city": "Praha",
      "address": "Ukázková 12",
      "postal_code": "110 00",
      "phone": "+420 123 123 123",
      "country": "CZ",
      "state": "středočeský"
    }
  },
  "flow": "shipment",
  "is_email_editable": true,
  "is_order_number_editable": true,
  "callback_url": "https://muj-obchod.cz/navrat-z-vraceni"
}

{
  "hid": "6b147e91-dc99-4cef-9665-5bb7c693f6c6",
  "redirect_url": "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
}