Váš e-shop může přes API předat objednávku do NeatGravity automaticky, bez ručního vyplňování formuláře. Objednávka se uloží mezi přijaté importy, kde si ji obchodník zkontroluje a teprve poté z ní založí případ.
POST https://www.neatgravity.com/api/v1/claims/import.php
Authorization: Bearer VAS_API_KLIC Content-Type: application/json
{
"external_id": "123456",
"claim_type": "cash_on_delivery",
"payload": {
"order": {
"number": "123456",
"created_at": "2026-08-23T15:30:00+02:00",
"amount": 99,
"currency": "CZK"
},
"customer": {
"name": "Jan",
"familyname": "Novák",
"company": "",
"street": "Dlouhá",
"streetno": "12",
"city": "Praha",
"zip": "11000",
"country_code": "CZ",
"email": "jan@example.cz",
"mobile": "+420777123456"
},
"shipment": {
"packagenumber": "",
"carrier": "Kurýr One"
}
}
}
Pozor u order.amount: jde o částku poštovného / nákladů
požadovaných k vymáhání. Nejde o celkovou cenu objednávky.
| Pole | Význam |
|---|---|
external_id | Unikátní ID objednávky ve vašem e-shopu |
claim_type | Typ pohledávky. Aktuálně podporováno: cash_on_delivery. Pokud není uvedeno, použije se cash_on_delivery. |
order.number | Číslo objednávky |
order.created_at | Datum vytvoření objednávky, formát ISO 8601 |
order.amount | Poštovné / náklad k vymáhání |
order.currency | Měna, např. CZK |
customer.name | Jméno |
customer.familyname | Příjmení |
customer.company | Firma, nepovinné |
customer.street | Ulice |
customer.streetno | Číslo domu |
customer.city | Město |
customer.zip | PSČ |
customer.country_code | ISO kód země, např. CZ |
customer.email | |
customer.mobile | Telefon |
shipment.packagenumber | Číslo zásilky, pokud je známo |
shipment.carrier | Dopravce, pokud je znám |
Nový import:
{"ok":true,"status":"created","import_id":123}
Import, který už existuje:
{"ok":true,"status":"already_exists"}
Opakované odeslání stejného external_id pro stejné napojení duplicitu
nevytvoří - druhé a další volání jen potvrdí, že objednávka je už uložená.
Import se automaticky nestane aktivním případem. Nejprve se zobrazí v Přijatých importech objednávek, kde si obchodník údaje zkontroluje a teprve potom z importu založí případ.