Integracja z API Wygodne Zwroty

Za pomocą API w łatwy sposób zintegrujesz swoją platformę z Wygodnymi Zwrotami. Poniżej znajdziesz wszystkie potrzebne dane do integracji (przykładowa implementacja, czy też dostępne endpointy).

Do połączenia API będziesz potrzebował numeru HID. Jest to specjalny Identyfikator umożliwiający integrację. Możesz go uzyskać kontaktując się ze swoim opiekunem handlowym. Jeśli korzystasz z wielu magazynów do zwrotów będziesz potrzebował kilku numerów HID, jeden dla każdego magazynu. W takim przypadku zapytaj swojego opiekuna handlowego o możliwość utworzenia odpowiednich komponentów w naszej usłudze.

Integracja z usługą polega na przekazywaniu danych z Twojego systemu do naszego API. W odpowiedzi otrzymasz unikalny adres URL dla klienta, pod którym będzie mógł on dokończyć proces zwrotu bez ponownego uzupełniania danych.

Przykładowa implementacja

Przekazywanie danych do zwrotu

POST https://api.wygodnezwroty.pl/order/return-draft
Content-Type: application/json

{
  "mailboxHid": "9f20ab8e-8e1d-44ba-922c-60fd9e68a98f",
  "order": {
    "number": "2022231345",
    "client": {
      "name": "Jan Przykładowy",
      "email": "[email protected]",
      "city": "Kraków",
      "address": "Przykładowa 12",
      "postal_code": "30-001",
      "phone": "+48 123 123 123"
    }
  }
}

{
  "hid": "9f20ab8e-8e1d-44ba-922c-60fd9e68a98f",
  "link": "https://wygodnezwroty.pl/sklep?draft=2b600349-642b-4218-90fc-128c3a5e3f23"
}

{
  "errors": [
    {
      "message": "Brak odpowiednich danych wejściowych",
      "code": "400",
      "level": "critical"
    }
  ],
  "mainError": {
    "message": "Brak odpowiednich danych wejściowych",
    "code": "400",
    "level": "critical"
  },
  "failure": true,
  "successful": false
}