Contacts and items
Customers, vendors and items referenced by events.
GET /customersList customersPOST /customersCreate or update a customerGET /vendorsList vendorsPOST /vendorsCreate or update a vendorGET /itemsList itemsPOST /itemsCreate or update an itemPOST /inventory-countsRecord a physical count
List customers
GET /customers
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
limit | query | integer | |
starting_after | query | string | |
external_id | query | string |
Answers
Create or update a customer
POST /customers
Sends Vortex-Entity and Idempotency-Key.
Upserts by external_id within the connection. Requires events:write.
Body
Answers
List vendors
GET /vendors
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
limit | query | integer | |
starting_after | query | string | |
external_id | query | string |
Answers
Create or update a vendor
POST /vendors
Sends Vortex-Entity and Idempotency-Key.
Upserts by external_id within the connection. Set is_1099 for vendors who receive information returns. Requires events:write.
Body
Answers
List items
GET /items
Sends Vortex-Entity.
Parameters
| Name | In | Type | About |
|---|---|---|---|
limit | query | integer | |
starting_after | query | string | |
sku | query | string | |
barcode | query | string | The item with this barcode, for a scanner. |
low_stock | query | boolean | Only items at or under their reorder point. |
Answers
Create or update an item
POST /items
Sends Vortex-Entity and Idempotency-Key.
Upserts by sku. Account overrides must be active accounts of the right type (422 wrong_account_type). An item can't stop being inventory while it has stock (422 item_has_stock). Send reorder_point or reorder_quantity as null to clear it. Requires events:write.
Body
Answers
Record a physical count
POST /inventory-counts
Sends Vortex-Entity and Idempotency-Key.
Give what is on the shelf for each item counted. Each item whose count differs from the books gets an adjustment movement against inventory shrinkage, valued at the business's costing method; items that match change nothing. An item can be counted once per request (422 duplicate_item). Requires events:write and the Growth plan or above.
Body
| Field | Type | About |
|---|---|---|
counted_on required | string (date) | |
memo | string | |
location | string | |
counts required | list of object |

