Items API

GET /items

List Inventory Items

Return inventory items matching the documented filters and pagination options.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items \
  -H "Authorization: Bearer $TOKEN"

POST /items

Create Inventory Item

Create an inventory item from the supplied request data.

Request body

Responses

Example

curl -X POST http://localhost:8000/items \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/delete

Bulk Delete Inventory Items

Delete multiple selected inventory items in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/delete \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/expire

Bulk Expire Inventory Items

Expire multiple selected inventory items in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/expire \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/make-available

Bulk Add Draft Items to Stock

Move multiple selected draft inventory items into available stock.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/make-available \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/restore-deleted

Restore Deleted Inventory Items

Undo a delete that moved items to Deleted. Each item comes back as the draft it was. Every selected item must be deleted. Otherwise nothing is restored and the response names the items that are not.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/restore-deleted \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/revert-to-draft

Bulk Revert Inventory Items to Draft

Revert multiple selected inventory items to draft status.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/revert-to-draft \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/status

Bulk Update Inventory Status

Update the status of multiple selected inventory items in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/status \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/bulk/transfer

Bulk Transfer Inventory Items

Move several items to another location in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/bulk/transfer \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/categories

List Inventory Categories

Return the available inventory categories.

Responses

Example

curl -X GET http://localhost:8000/items/categories \
  -H "Authorization: Bearer $TOKEN"

GET /items/export/csv

Export Inventory Items to CSV

Export inventory items to CSV.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/export/csv \
  -H "Authorization: Bearer $TOKEN"

GET /items/field-values

List Inventory Field Values

Return inventory field values matching the documented filters and pagination options.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/field-values \
  -H "Authorization: Bearer $TOKEN"

POST /items/import/batch

Batch Import Inventory Items

Import multiple inventory items in one request.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/import/batch \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/import/batches

List Inventory Import Batches

List all import batches for this company, newest first.

Responses

Example

curl -X GET http://localhost:8000/items/import/batches \
  -H "Authorization: Bearer $TOKEN"

POST /items/import/batches/{batch_id}/undo

Undo Inventory Import Batch

Undo an import batch only when none of its created items changed later.

Parameters

Responses

Example

curl -X POST http://localhost:8000/items/import/batches/:batch_id/undo \
  -H "Authorization: Bearer $TOKEN"

POST /items/import/commit

Commit Inventory Import

Commit an item import you previewed. If the file or column mapping changed since the preview, the import is refused.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/import/commit \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/import/preview

Get Inventory Import Preview

Return inventory import preview.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/import/preview \
  -H "Authorization: Bearer $TOKEN"

POST /items/import/preview

Create Inventory Import Preview

Preview an uploaded catalog with an optional caller-corrected mapping.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/import/preview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/import/rows

Import Mapped Inventory Rows

Import item rows that are already mapped to Celerp fields.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/import/rows \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/import/rows/preview

Preview Mapped Inventory Rows

Preview import rows that are already mapped to Celerp fields. Nothing is written. The response returns the `preview_hash` that the commit must send. The commit is refused when the rows or what they mean now have changed since.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/import/rows/preview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/merge

Merge Inventory Items

Merge several items into one, combining their stock and history.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/merge \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/merge/preview

Preview Inventory Merge

Show what merging these items would do to the books, before the merge is confirmed. Send the same body the merge will be confirmed with, apart from `idempotency_key` and `plan_fingerprint`. The merge is refused if the request or the items change between the preview and the confirmation.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/merge/preview \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/metadata

Get Inventory Item Metadata

Return inventory item metadata.

Request body

Responses

Example

curl -X POST http://localhost:8000/items/metadata \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/valuation

Get Inventory Valuation

Return inventory valuation.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/valuation \
  -H "Authorization: Bearer $TOKEN"

GET /items/{entity_id}

Get Inventory Item

Return inventory item.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/:entity_id \
  -H "Authorization: Bearer $TOKEN"

PATCH /items/{entity_id}

Update Inventory Item

Update inventory item with the supplied fields.

Parameters

Request body

Responses

Example

curl -X PATCH http://localhost:8000/items/:entity_id \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/adjust

Adjust Inventory Quantity

Adjust an item's quantity, for example after a count.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/adjust \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/expire

Expire Inventory Item

Mark an item as expired and take it out of available stock.

Parameters

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/expire \
  -H "Authorization: Bearer $TOKEN"

POST /items/{entity_id}/price

Set Inventory Item Price

Set one of an item's prices.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/price \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/{entity_id}/reorder-suggestion

Get Inventory Reorder Suggestion

Return inventory reorder suggestion.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/:entity_id/reorder-suggestion \
  -H "Authorization: Bearer $TOKEN"

POST /items/{entity_id}/reserve

Reserve Inventory Quantity

Reserve some or all of an item's quantity so it cannot be sold elsewhere.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/reserve \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/split

Split Inventory Item

Split an item into separate lots, each with its own quantity.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/split \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

GET /items/{entity_id}/split-preview

Preview Inventory Split

Show how an item would be split into lots, without making any change.

Parameters

Responses

Example

curl -X GET http://localhost:8000/items/:entity_id/split-preview \
  -H "Authorization: Bearer $TOKEN"

POST /items/{entity_id}/status

Set Inventory Item Status

Change an item's status.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/status \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/transfer

Transfer Inventory Item

Move an item to another location.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/transfer \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/transform

Transform Inventory Item

Turn an item into a new item, for example after processing, keeping the link to its source.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/transform \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

POST /items/{entity_id}/undo-merge

Undo Merge

Undo a merge: the merged items hold their own stock again, each on the inventory account it was in before, and the merge's reclassification entry is reversed. Only while nothing has happened to the merged item or its sources since the merge; after that the merge is part of what followed and stays.

Parameters

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/undo-merge \
  -H "Authorization: Bearer $TOKEN"

POST /items/{entity_id}/unreserve

Release Reserved Inventory

Release a reservation so the quantity is available again.

Parameters

Request body

Responses

Example

curl -X POST http://localhost:8000/items/:entity_id/unreserve \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'