Vratky (order returns) fungují v Base analogicky k objednávkám a mají v API samostatný, ale zrcadlový blok metod.
Základní metoda
getOrderReturns stahuje vratky z Base od zadaného data, max. 100 na jedno volání — stejný princip stránkování jako u getOrders.
| Parametr | Typ | Popis |
|---|
order_id | int | ID původní objednávky, ze které vratka vznikla. |
return_id | int | Stáhne jen jednu konkrétní vratku. |
date_from | int (unix) | Datum vzniku vratky, od kterého se mají stahovat. |
id_from | int | ID vratky, od kterého se stahují další. |
status_id | int | Omezí výběr na konkrétní stav vratky. |
filter_order_return_source, filter_order_return_source_id | — | Filtrování podle zdroje vratky (marketplace kód). |
include_custom_extra_fields | bool | Přidá hodnoty vlastních polí — viz Extra pole, princip je stejný jako u objednávek (getOrderReturnExtraFields). |
Na rozdíl od objednávek zde neexistuje koncept potvrzené/nepotvrzené vratky (date_confirmed) — stránkujte tedy podle date_from (a hodnoty posledního zpracovaného záznamu +1s), případně id_from.
Klíčová pole v odpovědi
| Pole | Popis |
|---|
return_id / order_id | ID vratky a ID původní objednávky. |
status_id | Stav vratky — seznam přes getOrderReturnStatusList, koncept stejný jako u Statusů objednávek. |
fulfillment_status | Číselný stav zpracování: 0 aktivní, 5 přijatá, 1 vyřízená, 2 zrušená. |
refunded | Informace, zda už byla vratka refundována. |
order_return_account_number / order_return_iban / order_return_swift | Bankovní údaje pro vrácení peněz zákazníkovi. |
products | Vrácené položky (stejná struktura jako u objednávky, navíc return_reason_id). |
Práce se stavy a refundací
Zachytávání změn v čase
Stejně jako u objednávek existuje i pro vratky žurnál: getOrderReturnJournalList — princip i nutnost aktivace v Profil → API je stejná jako u getJournalList.
Vratky z marketplace kanálů
U vybraných marketplace kanálů umí Base automaticky stahovat žádosti o vrácení zboží přímo od zákazníka a zakládat z nich vratky — nastavuje se to v detailu konkrétního prodejního kanálu. Po zapnutí pak stačí sledovat nové vratky výše popsaným způsobem.
Pokud řešíte i vratkové přepravní štítky, princip je stejný jako u standardních zásilek — viz Přepravní štítky, jen s parametrem return_shipment: true.