ASCI API - Status Checker

Status Checker module page - how it works, an interactive test form, and the endpoint reference, all in one place. Set your tenant API Key in the Setup block below; every request sends the ApiKey header. See All Forms for the combined surface or Home for the module index.

How it works

Generic submission status checker.

Status Checker

The Status Checker is a generic poller: pick a document type and paste a submission_id; it GETs the matching /api/{Type}/Status/{id} endpoint and shows the BBx-side lifecycle (submitted → picked_up → processed). When state reaches processed, bbx_reference_no is populated.

Setup

API key + base URL used by every request below.

Credentials

API Key

Base URL

Leave Base URL blank to call this same server with relative paths (the normal case). Set it (e.g. https://asci-api.asciofmiami.com) to point the forms at another host. Every request below sends the ApiKey header.

Idempotency Key

Sent on every create / submit POST. Click Generate for a fresh one, or a new one is auto-generated per submit if blank.

Test form

Interactive form - POSTs to the API and shows the JSON response + HTTP status.

Generic status checker. Pick a document type and paste a submission_id; this GETs the matching /api/{Type}/Status/{id} endpoint and shows the BBx-side lifecycle (submitted → picked_up → processed).

Document Type

Submission ID

What happens after a Submit

After Submit: the API writes the JSON + .txt to the tenant inbox and a typed SQLite row. In the BBx menu, run Import Procedures > Fetch Data from Web (program IPAPIGET) to pick it up, then use the Status tab; the state moves from submitted to processed and bbx_reference_no is populated. Customer / Manufacturer / Product creates enqueue a legacy CU / MF / PR write that runs ahead of the document that references it (FIFO ordering guarantee).

Endpoints

Per-document status endpoints. Full response schema below.

Status endpoints

Method	Path	Purpose
GET	`/api/Isf/Status/{id}`	ISF lifecycle status.
GET	`/api/AceQe/Status/{id}`	Quick Entry lifecycle status.
GET	`/api/Qp/Status/{id}`	QP lifecycle status.
GET	`/api/Bl/Status/{id}`	BL lifecycle status.

Tally In / Out have no per-submission status endpoint; confirm via their Outbound listings.

Schema

Response body for the GET /api/{module}/Status/{id} endpoints. The same shape is returned for every module (ISF / Quick Entry / QP / BL); produced by the shared status handler (InboundSubmitHandler.Status).

Status response

Field	Type	Description
`submission_id`	string	The id returned by the Submit endpoint.
`tenant`	string	Owning tenant domain.
`document_type`	string	ISF / QP / BL / ACEQE.
`status`	string	Lifecycle status (`queued` → `processing` → `processed` \| `error`).
`bbx_reference_no`	string	Reference number assigned / used by legacy BBx.
`metadata`	object	Client-supplied key/value bag (string→string, ≤50 entries), echoed back unchanged.
`entry_no`	string	BBx-reported entry number (notify-back).
`approval_status`	string	BBx-reported approval status (notify-back).
`error_message`	string	Error detail when `status = error`; otherwise null.
`submitted_at`	string	Timestamp the submission was accepted.
`picked_up_at`	string	Timestamp legacy picked the document up.
`processed_at`	string	Timestamp processing completed.
`filesystem_hint`	string	Diagnostic hint about the document's filesystem location.