Environment & Testing¶
Base URL¶
| Environment | Base URL |
|---|---|
| Production | https://func-posingest-dev.azurewebsites.net/pos/v1 |
There is one environment. All data you push goes to production.
Credentials¶
HQ issues the following:
| Item | Description |
|---|---|
| API key | Send it in the x-functions-key header. Keep it in a secret store, never in source code. See Authentication |
store_ids |
Store codes registered for your account. Use them exactly as given |
Test store_id |
A store code reserved for testing (for example NCMD-TEST) |
To request credentials, contact your HQ integration contact.
Testing your integration¶
Because there is no separate test environment, use your test store_id while you develop and test. HQ excludes data sent under the test store from reports.
- Push a full business date under the test
store_id: products, trade records, then daily close. - Check the reconciliation result. It should be
MATCHED. - Tell HQ you are ready. After HQ confirms, start sending real data under your real
store_ids.
Warning
Never send test or dummy transactions under a real store_id. They would be counted in sales reports.
Test data: Fried Chicken Master menu¶
You can use the menu below to build test stores, products and transactions. Product IDs are placeholders; use your POS export codes in production.
Products¶
| product_id | Name | product_type | Price (USD) | Modifier groups | Combo contents |
|---|---|---|---|---|---|
| COMBO-01 | Master Tender Sandwich Combo | COMBO | 13.49 | COMBO_DRINK | SGL-TENDER-SANDWICH + SIDE-FRIES + DRK-FOUNTAIN |
| COMBO-02 | Master Jimbo Combo | COMBO | 14.49 | FLAVOR_JIMBO, COMBO_DRINK | SGL-JIMBO + SIDE-FRIES + DRK-FOUNTAIN |
| COMBO-03 | Master Jimbowl Combo | COMBO | 14.49 | FLAVOR_JIMBO, COMBO_DRINK | SGL-JIMBOWL + SIDE-FRIES + DRK-FOUNTAIN |
| COMBO-04 | Master Chicken (Katsu) Combo | COMBO | 14.49 | COMBO_DRINK | SGL-KATSU + SIDE-FRIES + DRK-FOUNTAIN |
| COMBO-05 | Master Tenders 3PC Combo | COMBO | 14.49 | COMBO_DRINK | SGL-TENDERS-3PC + SIDE-FRIES + DRK-FOUNTAIN |
| COMBO-06 | Master Wings 6PC Combo | COMBO | 15.49 | COMBO_DRINK | SGL-WINGS-6PC + SIDE-FRIES + DRK-FOUNTAIN |
| SGL-JIMBO | Master Jimbo | SINGLE | 9.49 | FLAVOR_JIMBO | — |
| SGL-TENDER-SANDWICH | Master Tender Sandwich | SINGLE | 8.49 | — | — |
| SGL-TW-CRISPY | Taiwanese Crispy Chicken | SINGLE | 9.49 | — | — |
| SGL-KATSU | Master Chicken (Katsu) | SINGLE | 9.49 | — | — |
| SGL-TENDERS-3PC | Master Tenders 3PC | SINGLE | 9.49 | — | — |
| SGL-WINGS-6PC | Master Wings 6PC | SINGLE | 10.49 | — | — |
| SGL-JIMBOWL | Master Jimbowl | SINGLE | 11.49 | FLAVOR_JIMBO | — |
| SIDE-RICE | Seasoned Rice | SIDE | 3.49 | — | — |
| SIDE-FRIES | Fries | SIDE | 4.49 | FRIES_EXTRA_FLAVOR | — |
| SIDE-COLESLAW | Coleslaw | SIDE | 4.49 | — | — |
| SIDE-CHEESE-CORN | Cheese Corn | SIDE | 5.49 | — | — |
| SIDE-BEEF-GYOZA | Beef Gyoza | SIDE | 6.49 | — | — |
| DRK-FOUNTAIN | Fountain Drinks | DRINK | 2.99 | — | — |
| DRK-TW-LEMONADE | Taiwan Signature Lemonade | DRINK | 5.49 | — | — |
| DRK-KUMQUAT-LEMONADE | Kumquat Lemonade | DRINK | 5.49 | — | — |
| DRK-BOBA | Taiwan Boba Tea | DRINK | 6.49 | — | — |
Modifier groups¶
| group_id | Options | Price delta | Selection |
|---|---|---|---|
| FLAVOR_JIMBO | Taiwanese Salt & Pepper / Thai Sweet Chili / Mala Hot Sauce | 0.00 | Exactly 1 |
| FRIES_EXTRA_FLAVOR | Seaweed / Cheese Powder | +0.75 each | 0 to 2 |
| COMBO_DRINK | Fountain (default) / Taiwan Signature Lemonade / Kumquat Lemonade / Taiwan Boba Tea | 0.00 / +2.50 / +2.50 / +3.50 | Exactly 1 |
Prices in this menu exclude sales tax (prices_include_tax = false).