REST API: schválení rizikových zápisů

Rizikové zápisy (zrušení a zamítnutí objednávky, faktura, cenová nabídka, dobropis a jeho storno, vrácení peněz, vyřízení reklamace) napoprvé vrátí 202 se schválením a neprovedou nic. Schválí je vlastník nebo manažer obchodu na stránce schválení v administraci; editor ani účet podpory nikdy. Stav schválení vidí jen klíč, který o něj požádal, a nechce žádné oprávnění. Po schválení pošlete týž požadavek se stejným Idempotency-Key: zápis proběhne právě jednou. Místo dotazování můžete čekat na webhook approval.decided.

Cesty odpovídají na GET, POST, PUT, PATCH a DELETE na doméně vašeho obchodu, například https://muj-eshop.cz/api/v1/…, a klíč se posílá v hlavičce Authorization: Bearer nebo x-api-key. Parametry, pole i chyby na téhle stránce se generují ze smlouvy, podle které API odpovídá, takže platí pro build, na kterém stránka běží. Každá cesta může navíc vrátit chyby společné všem cestám: invalid_api_key, missing_api_key, external_access_disabled, external_access_not_enabled, external_access_suspended, key_surface_mismatch, plan_required, rest_write_disabled, rest_write_not_enabled, shop_unavailable, shop_not_found, rate_limited a server_error. Co znamenají, popisuje článek Chybové odpovědi, klíč a oprávnění Autentizace a oprávnění a průchod výpisem Stránkování a filtry.

GET /api/v1/approvals/{id}

Stav schválení rizikového zápisu: čeká, schváleno, provedeno, zamítnuto, nebo vypršelo. Vidí ho jen klíč, který o schválení požádal.

• Oprávnění: žádné, stačí libovolný platný klíč.
• Odpověď: jeden záznam v data.

curl -s "https://muj-eshop.cz/api/v1/approvals/$ID" \
  -H "Authorization: Bearer $SHOPZI_API_KEY"

Parametry v cestě

• id (UUID; povinný): Identifikátor záznamu (UUID) z výpisu.

Obálka odpovědi

• data (záznam): Jeho pole popisuje seznam Pole záznamu.

Pole záznamu

• id (UUID): Id schválení. Patří do GET /approvals/{id} a do adresy approval_url.
• status (jedna z hodnot pending, approved, declined, consumed a expired): pending = čeká na rozhodnutí v administraci. approved = schváleno: pošlete týž požadavek se stejným Idempotency-Key znovu. consumed = zápis po schválení proběhl; opakování vrátí jeho výsledek. declined = zamítnuto, týž požadavek dostane 403 approval_declined. expired = vypršelo nerozhodnuté (nebo schválené a nepoužité); týž požadavek založí nové schválení.
• operation (text nebo null): Co se schvaluje, tatáž hodnota jako change.operation výsledku, například cancel_order nebo issue_invoice.
• approval_url (text): Stránka schválení v administraci obchodu. Otevře ji vlastník nebo manažer přihlášený do administrace; adresa nenese žádné přihlášení a nikomu jinému nic neukáže.
• expires_at (čas ISO 8601): Do kdy jde schválit a schválené použít (hodinu od žádosti).
• decided_at (čas ISO 8601 nebo null): Kdy člověk schválil nebo zamítl.
• consumed_at (čas ISO 8601 nebo null): Kdy zápis po schválení proběhl.
• created_at (čas ISO 8601)

Chyby této cesty

• 404 not_found: Záznam s tímhle identifikátorem v obchodě není.