Jobs
List jobs
Plan: Restricted. Usage of this endpoint is off by default and must be enabled for the account - contact shopVOX support. As with every index endpoint, txn_type / txn_number are required unless the account also has the index_api_enabled flag (see Pagination & filter gating).
get/jobs
Request
- Base URLhttps://api.shopvox.com/v1
- AuthAPI key in query parameter account_id and API key in query parameter authToken
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
txn_type'invoice' | 'sales_order' | 'quote'
Filter by the transaction the job belongs to.
txn_numberinteger
Transaction number, e.g. 1001.
pageinteger
per_pageinteger
Capped to 5 when the account lacks the index_api_enabled flag.
Response
OK
Changes
No recorded changes to this operation across all 5 revisions of this API.