Fiskaliza
Referenca e API-sëKomandat

List a POS's commands

Combined sale, return and cancellation history, newest first by created_at and then ID descending. Optional kind accepts exactly SALE, RETURN, or CANCELLATION; omitted means all kinds. Kind, status, exact external_id, POS authorization, and downstream grants are intersected before counting and pagination. Explicitly empty, lowercase, unknown, repeated, comma- separated, and canonical CANCEL values are invalid. An empty result is 200 with commands: [], not 404.

GET/v1/pos/{pos_id}/commands

Combined sale, return and cancellation history, newest first by created_at and then ID descending. Optional kind accepts exactly SALE, RETURN, or CANCELLATION; omitted means all kinds. Kind, status, exact external_id, POS authorization, and downstream grants are intersected before counting and pagination. Explicitly empty, lowercase, unknown, repeated, comma- separated, and canonical CANCEL values are invalid. An empty result is 200 with commands: [], not 404.

Authorization

fiskalizaKey fiskaliza:commands:read
AuthorizationBearer <token>

An opaque Fiskaliza API key. Each operation lists the capabilities required on that key.

In: header

Scope: fiskaliza:commands:read

Path Parameters

pos_id*string
Match^nj_pos_

Query Parameters

kind?unknown

Value in

  • "SALE"
  • "RETURN"
  • "CANCELLATION"
status?unknown

PENDING queued, PROCESSING in flight, RETRY failed and will be retried automatically, SUCCEEDED issued, REJECTED refused by ATK and terminal until retried by hand.

Value in

  • "PENDING"
  • "PROCESSING"
  • "RETRY"
  • "SUCCEEDED"
  • "REJECTED"
external_id?string

Exact case-sensitive transaction reference within the POS. Surrounding whitespace is trimmed; an explicitly empty value is invalid.

Length1 <= length
limit?integer
Range0 <= value <= 100
Default50
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/pos/string/commands"
{  "success": true,  "warnings": [    "string"  ],  "data": {    "commands": [      {        "id": "string",        "pos_id": "string",        "external_id": "string",        "type": "SALE",        "sale_type": "STANDARD",        "status": "PENDING",        "issuance_mode": "ONLINE",        "attempt_count": 0,        "last_error": "string",        "next_retry_at": "2019-08-24T14:15:22Z",        "receipt_ready": true,        "created_at": "2019-08-24T14:15:22Z",        "coupon": {          "coupon_id": 0,          "daily_receipt_no": 0,          "reference_no": 0,          "verification_no": "string",          "qr_payload": "string",          "transaction_no": "string",          "atk_message": "string",          "issued_at": "2019-08-24T14:15:22Z",          "transmitted_at": "2019-08-24T14:15:22Z"        }      }    ],    "total": 0,    "limit": 0,    "offset": 0  }}