Get External Job status

GET

/api/method/public/general/job-status

Polls an External Job created by queued public API requests such as submit POS orders. Returns the current status and includes the final response payload or error message when the job completes. Rate limit: one job status request every 10 seconds; exceeding it returns HTTP 429.

Request

Authorization

API Key

Add parameter in header

X-Access-Token

Example:

X-Access-Token: ********************

Query Params

Responses

🟢200

application/json

Current job status, timestamps, and stored payloads.

Body

🟠401

🟠403

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/api/method/public/general/job-status?job_id' \
--header 'X-Access-Token: <api-key>'

Response Example

200 - Success

{
    "message": {
        "job_id": "01HVVY3Z41R7M8NBBXFQX9M9TY",
        "status": "Completed",
        "timestamp": "2025-03-20T09:12:00",
        "response": {
            "status": "ok"
        },
        "error": null
    }
}

Submit POS orders

ErrorResponse