Products 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
Product master record create / find.
Products
The Products module upserts a product master: POST /api/Products performs a synchronous upsert plus
an enqueued legacy PR write. manufacturer_id is optional -
unlinked products (no MID) are supported. The product_code is an API-only convenience alias.
Setup
API key + base URL used by every request below.
Credentials
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.
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.
Create a product master record: POST /api/Products (sync upsert + enqueue
legacy PR write). manufacturer_id is optional -
unlinked products (no MID) are supported. The product_code is an API-only
convenience alias.
GETs /api/Products?code=&description=&manufacturer_id=. Click a row to load it.
Endpoints
Products endpoint family (api/Products). Full request schema below.
Products endpoints
| Method | Path | Purpose |
|---|---|---|
| POST | /api/Products | Create / upsert a product. |
| GET | /api/Products | Search (?q=, optional &manufacturer_id=). Returns {count, rows}. |
| DELETE | /api/Products/{code} | Delete a product. |
Schema
Request body for POST /api/Products. A product MAY link to a manufacturer, but manufacturer_id is optional - an unlinked product (description + optional tariff, no MID) is fully supported. The GET / import / lookup shape is shown below it; the list endpoint wraps rows as { "count": n, "rows": [ … ] }.
Product create (POST body)
| Field | Type | Req? | Max | Description |
|---|---|---|---|---|
description | string | Yes | 70 | Product description. |
manufacturer_id | string | No | 16 | Optional MID to link the product to (omit for an unlinked product). |
tariff_no | string | No | 10 | HTS tariff number. |
product_code | string | No | 70 | Optional convenience alias / key; synthesized from MID + description (linked) or description (unlinked) when omitted. |
Product (GET / import / lookup shape)
| Field | Type | Req? | Max | Description |
|---|---|---|---|---|
product_code | string | Yes | 30 | Product code. Primary key (per tenant) for the lookup/import shape. |
description | string | No | 70 | Product description. |
tariff_no | string | No | 10 | HTS tariff number. |
manufacturer_id | string | No | 15 | Optional linked MID (foreign manufacturer). |