Contacts and items

Customers, vendors and items referenced by events.

List customers

GET /customers

Sends Vortex-Entity.

Parameters

NameInTypeAbout
limitqueryinteger
starting_afterquerystring
external_idquerystring

Answers

  • 200 any. A page of customers.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Create or update a customer

POST /customers

Sends Vortex-Entity and Idempotency-Key.

Upserts by external_id within the connection. Requires events:write.

Body

ContactUpsert

Answers

  • 200 Contact. The customer.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

List vendors

GET /vendors

Sends Vortex-Entity.

Parameters

NameInTypeAbout
limitqueryinteger
starting_afterquerystring
external_idquerystring

Answers

  • 200 any. A page of vendors.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

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

ContactUpsert

Answers

  • 200 Contact. The vendor.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

List items

GET /items

Sends Vortex-Entity.

Parameters

NameInTypeAbout
limitqueryinteger
starting_afterquerystring
skuquerystring
barcodequerystring

The item with this barcode, for a scanner.

low_stockqueryboolean

Only items at or under their reorder point.

Answers

  • 200 any. A page of items.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

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

ItemUpsert

Answers

  • 200 Item. The item.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

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

FieldTypeAbout
counted_on requiredstring (date)
memostring
locationstring
counts requiredlist of object

Answers

  • 201 object. The count. `event_id` is the inventory movement event, or null when nothing differed.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what