Every endpoint in Inventory: 234 operations across 26 resources. Each one takes the same API key and returns the same error shapes as the rest of the API; see Authentication and Errors and limits.
Every path below is relative to https://app.jaicrm.ai. A key only reaches what it was granted when it was created, an endpoint you cannot use answers 403 rather than hiding.
Packages
GET/api/inventory/packages
List packages, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/inventory/packages
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}
Read one package in full
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/comments
List the comments for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/dependencies
List what would break if a package were deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/detail
List the detail for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/detail
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/email-check
List the email check for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/email-check
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/related
List the related for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/related
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/related/{module}
List the related for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
module | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/related/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/similar
Find packages that look like duplicates of this one
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/similar
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/{id}/timeline
Read everything that has happened to a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/timeline
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/box-types
List the box types for a package
curl -X GET https://app.jaicrm.ai/api/inventory/packages/box-types
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/box-types/export.csv
Download packages as a CSV file
curl -X GET https://app.jaicrm.ai/api/inventory/packages/box-types/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/export.csv
Download packages as a CSV file
curl -X GET https://app.jaicrm.ai/api/inventory/packages/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/kanban
Read packages arranged as a board
curl -X GET https://app.jaicrm.ai/api/inventory/packages/kanban
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/orders
List the orders for a package
curl -X GET https://app.jaicrm.ai/api/inventory/packages/orders
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/pending/{documentId}
List the pending for a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/packages/pending/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/pivot
Summarise packages as a pivot table
curl -X GET https://app.jaicrm.ai/api/inventory/packages/pivot
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/packages/report/history
Read the history of a package
curl -X GET https://app.jaicrm.ai/api/inventory/packages/report/history
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages
Create a package
Body
| Field | Type | Required | Notes |
|---|---|---|---|
packageDate | one of several | Optional | None |
warehouseId | string (uuid) | Optional | None |
boxName | string | Optional | at most 120 characters |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X POST https://app.jaicrm.ai/api/inventory/packages
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"packageDate": "…",
"warehouseId": "…",
"boxName": "…",
"notes": "…"
}'
POST/api/inventory/packages/{id}/assignees
Put somebody on a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/assignees
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/comments
Add to the comments of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/delivered
Add to the delivered of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/delivered
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/email
Send an email about a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/email
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/lines
Add to the lines of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/lines
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/notes
Add a note to a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/notes
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/{id}/unpack
Add to the unpack of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/unpack
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/box-types
Add to the box types of a package
curl -X POST https://app.jaicrm.ai/api/inventory/packages/box-types
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/bulk
Change several packages at once
curl -X POST https://app.jaicrm.ai/api/inventory/packages/bulk
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/bulk/assign
Assign several packages to somebody at once
curl -X POST https://app.jaicrm.ai/api/inventory/packages/bulk/assign
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/bulk/delete
Delete several packages at once
curl -X POST https://app.jaicrm.ai/api/inventory/packages/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/from-geometry
Add to the from geometry of a package
curl -X POST https://app.jaicrm.ai/api/inventory/packages/from-geometry
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/geometry
Add to the geometry of a package
curl -X POST https://app.jaicrm.ai/api/inventory/packages/geometry
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/import
Import packages from a CSV file
curl -X POST https://app.jaicrm.ai/api/inventory/packages/import
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/packages/new
Add to the new of a package
curl -X POST https://app.jaicrm.ai/api/inventory/packages/new
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/packages/{id}
Change a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
packageDate | one of several | Optional | None |
warehouseId | string (uuid) | Optional | None |
boxName | string | Optional | at most 120 characters |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X PATCH https://app.jaicrm.ai/api/inventory/packages/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"packageDate": "…",
"warehouseId": "…",
"boxName": "…",
"notes": "…"
}'
PATCH/api/inventory/packages/{id}/notes/{noteId}
Change or remove a note on a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/packages/box-types/{id}
Change the box types of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/packages/box-types/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/packages/{id}
Delete a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/packages/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/packages/{id}/assignees/{userId}
Take somebody off a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
userId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/assignees/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/packages/{id}/comments/{commentId}
Remove from the comments of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/packages/{id}/notes/{noteId}
Change or remove a note on a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/packages/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/packages/box-types/{id}
Remove from the box types of a package
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/packages/box-types/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Items
GET/api/inventory/items
List items
curl -X GET https://app.jaicrm.ai/api/inventory/items
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}
Read one item
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/batches
List batches
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/batches
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/comments
List comments
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/label-options
List label options
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/label-options
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/movements
List movements
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/movements
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/orders
List orders
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/orders
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/photos
List photos
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/photos
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/price-lists
List price lists
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/price-lists
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/sales-summary
List sales summary
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/sales-summary
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/serial-list
List serial list
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/serial-list
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/serials.csv
List serials.csv
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/serials.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/stock
List stock
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/stock
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/{id}/variants
List variants
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/items/RECORD_ID/variants
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/export
List export
curl -X GET https://app.jaicrm.ai/api/inventory/items/export
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/items/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/kanban
List kanban
curl -X GET https://app.jaicrm.ai/api/inventory/items/kanban
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/items/pivot
List pivot
curl -X GET https://app.jaicrm.ai/api/inventory/items/pivot
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items
Create an item
curl -X POST https://app.jaicrm.ai/api/inventory/items
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/batches
Create a batche
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/batches
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/channel/confirm
Create a confirm
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/channel/confirm
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/channel/link
Create a link
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/channel/link
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/channel/unlink
Create an unlink
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/channel/unlink
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/comments
Create a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/labels
Create a label
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/labels
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/opening-stock
Create an opening stock
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/opening-stock
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/photos
Create a photo
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/photos
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/rebuild-balances
Create a rebuild balance
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/rebuild-balances
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/serials
Create a serial
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/serials
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/set-stock
Create a set stock
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/set-stock
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/{id}/variants
Create a variant
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/items/RECORD_ID/variants
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/bulk/delete
Create a delete
curl -X POST https://app.jaicrm.ai/api/inventory/items/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/import
Create an import
curl -X POST https://app.jaicrm.ai/api/inventory/items/import
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/items/sync-vendor-services
Create a sync vendor service
curl -X POST https://app.jaicrm.ai/api/inventory/items/sync-vendor-services
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/items/{id}
Change an item
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/items/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/items/{id}/photos
Change a photo
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/items/RECORD_ID/photos
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/items/{id}/photos/{photoId}
Change a photo
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
photoId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/items/RECORD_ID/photos/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/items/{id}
Delete an item
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/items/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/items/{id}/comments/{commentId}
Delete a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/items/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/items/{id}/photos/{photoId}
Delete a photo
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
photoId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/items/RECORD_ID/photos/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Assemblies
GET/api/inventory/assemblies
List assemblies, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}
Read one assembly in full
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/comments
List the comments for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/dependencies
List what would break if an assembly were deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/detail
List the detail for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/detail
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/email-check
List the email check for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/email-check
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/related
List the related for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/related
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/related/{module}
List the related for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
module | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/related/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/similar
Find assemblies that look like duplicates of this one
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/similar
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/{id}/timeline
Read everything that has happened to an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/timeline
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/export.csv
Download assemblies as a CSV file
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/kanban
Read assemblies arranged as a board
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/kanban
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/pivot
Summarise assemblies as a pivot table
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/pivot
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/assemblies/plan/{itemId}
List the plan for an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
itemId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/assemblies/plan/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies
Create an assembly
Body
| Field | Type | Required | Notes |
|---|---|---|---|
status | string | Optional | one of draft, confirmed, assembled, cancelled |
warehouseId | string (uuid) | Optional | None |
assemblyDate | one of several | Optional | None |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"status": "draft",
"warehouseId": "…",
"assemblyDate": "…",
"notes": "…"
}'
POST/api/inventory/assemblies/{id}/assemble
Add to the assemble of an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/assemble
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/assignees
Put somebody on an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/assignees
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/cancel
Cancel an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/cancel
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/comments
Add to the comments of an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/confirm
Add to the confirm of an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/confirm
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/email
Send an email about an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/email
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/{id}/notes
Add a note to an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/notes
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/bulk
Change several assemblies at once
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/bulk
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/bulk/assign
Assign several assemblies to somebody at once
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/bulk/assign
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/bulk/delete
Delete several assemblies at once
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/import
Import assemblies from a CSV file
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/import
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/assemblies/new
Add to the new of an assembly
curl -X POST https://app.jaicrm.ai/api/inventory/assemblies/new
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/assemblies/{id}
Change an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
status | string | Optional | one of draft, confirmed, assembled, cancelled |
warehouseId | string (uuid) | Optional | None |
assemblyDate | one of several | Optional | None |
notes | string | Optional | None |
custom | object | Optional | None |
curl -X PATCH https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"status": "draft",
"warehouseId": "…",
"assemblyDate": "…",
"notes": "…"
}'
PATCH/api/inventory/assemblies/{id}/notes/{noteId}
Change or remove a note on an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
PUT/api/inventory/assemblies/{id}/lines
Change the lines of an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/lines
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/assemblies/{id}
Delete an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/assemblies/{id}/assignees/{userId}
Take somebody off an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
userId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/assignees/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/assemblies/{id}/comments/{commentId}
Remove from the comments of an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/assemblies/{id}/notes/{noteId}
Change or remove a note on an assembly
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/assemblies/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Boms
GET/api/inventory/boms
List bills of materials, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/inventory/boms
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}
Read one bill of materials in full
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/comments
List the comments for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/dependencies
List what would break if a bill of materials were deleted
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/dependencies
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/detail
List the detail for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/detail
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/email-check
List the email check for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/email-check
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/related
List the related for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/related
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/related/{module}
List the related for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
module | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/related/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/similar
Find bills of materials that look like duplicates of this one
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/similar
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/{id}/timeline
Read everything that has happened to a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/timeline
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/export.csv
Download bills of materials as a CSV file
curl -X GET https://app.jaicrm.ai/api/inventory/boms/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/for-item/{itemId}
List the for item for a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
itemId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/boms/for-item/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/kanban
Read bills of materials arranged as a board
curl -X GET https://app.jaicrm.ai/api/inventory/boms/kanban
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/boms/pivot
Summarise bills of materials as a pivot table
curl -X GET https://app.jaicrm.ai/api/inventory/boms/pivot
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms
Create a bill of materials
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Optional | at most 200 characters |
description | string | Optional | at most 500 characters |
isActive | boolean | Optional | None |
custom | object | Optional | None |
curl -X POST https://app.jaicrm.ai/api/inventory/boms
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"name": "…",
"description": "…",
"isActive": true,
"custom": "…"
}'
POST/api/inventory/boms/{id}/active
Add to the active of a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/active
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/assignees
Put somebody on a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/assignees
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/clone
Add to the clone of a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/clone
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/comments
Add to the comments of a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/email
Send an email about a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/email
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/lines
Add to the lines of a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/lines
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/{id}/notes
Add a note to a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/notes
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/bulk
Change several bills of materials at once
curl -X POST https://app.jaicrm.ai/api/inventory/boms/bulk
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/bulk/assign
Assign several bills of materials to somebody at once
curl -X POST https://app.jaicrm.ai/api/inventory/boms/bulk/assign
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/bulk/delete
Delete several bills of materials at once
curl -X POST https://app.jaicrm.ai/api/inventory/boms/bulk/delete
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/import
Import bills of materials from a CSV file
curl -X POST https://app.jaicrm.ai/api/inventory/boms/import
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/boms/new
Add to the new of a bill of materials
curl -X POST https://app.jaicrm.ai/api/inventory/boms/new
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/boms/{id}
Change a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | Optional | at most 200 characters |
description | string | Optional | at most 500 characters |
isActive | boolean | Optional | None |
custom | object | Optional | None |
curl -X PATCH https://app.jaicrm.ai/api/inventory/boms/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
-H 'Content-Type: application/json'
-d '{
"name": "…",
"description": "…",
"isActive": true,
"custom": "…"
}'
PATCH/api/inventory/boms/{id}/notes/{noteId}
Change or remove a note on a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/boms/{id}
Delete a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/boms/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/boms/{id}/assignees/{userId}
Take somebody off a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
userId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/assignees/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/boms/{id}/comments/{commentId}
Remove from the comments of a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/boms/{id}/notes/{noteId}
Change or remove a note on a bill of materials
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
noteId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/boms/RECORD_ID/notes/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Transfers
GET/api/inventory/transfers
List transfers
curl -X GET https://app.jaicrm.ai/api/inventory/transfers
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/transfers/{id}
Read one transfer
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/transfers/{id}/comments
List comments
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/transfers/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/transfers/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers
Create a transfer
curl -X POST https://app.jaicrm.ai/api/inventory/transfers
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers/{id}/close-short
Create a close short
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/close-short
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers/{id}/comments
Create a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers/{id}/dispatch
Create a dispatch
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/dispatch
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers/{id}/receive
Create a receive
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/receive
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/transfers/{id}/signature
Create a signature
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/signature
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/transfers/{id}
Delete a transfer
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/transfers/{id}/comments/{commentId}
Delete a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/transfers/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Warehouses
GET/api/inventory/warehouses
List warehouses
curl -X GET https://app.jaicrm.ai/api/inventory/warehouses
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/warehouses/{id}
Read one warehouse
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/warehouses/{id}/bins
List bins
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID/bins
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/warehouses/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/warehouses/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/warehouses
Create a warehouse
curl -X POST https://app.jaicrm.ai/api/inventory/warehouses
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/warehouses/{id}/bins
Create a bin
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID/bins
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/warehouses/{id}/bins/bulk
Create a bulk
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID/bins/bulk
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/warehouses/{id}/zones
Create a zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID/zones
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/warehouses/{id}
Change a warehouse
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/warehouses/{id}
Delete a warehouse
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/warehouses/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Adjustments
GET/api/inventory/adjustments
List adjustments
curl -X GET https://app.jaicrm.ai/api/inventory/adjustments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/adjustments/{id}
Read one adjustment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/adjustments/{id}/comments
List comments
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/adjustments/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/adjustments/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/adjustments
Create an adjustment
curl -X POST https://app.jaicrm.ai/api/inventory/adjustments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/adjustments/{id}/comments
Create a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID/comments
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/adjustments/{id}/post
Create a post
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID/post
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/adjustments/{id}
Delete an adjustment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/adjustments/{id}/comments/{commentId}
Delete a comment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
commentId | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/adjustments/RECORD_ID/comments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Price lists
GET/api/inventory/price-lists
List price lists, filtered, sorted and paged
curl -X GET https://app.jaicrm.ai/api/inventory/price-lists
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/price-lists/{id}
Read one price list in full
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/price-lists/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/price-lists/{id}/entries.csv
List the entries.csv for a price list
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/price-lists/RECORD_ID/entries.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/price-lists/export.csv
Download price lists as a CSV file
curl -X GET https://app.jaicrm.ai/api/inventory/price-lists/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/price-lists/rate
List the rate for a price list
curl -X GET https://app.jaicrm.ai/api/inventory/price-lists/rate
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/price-lists
Create a price list
curl -X POST https://app.jaicrm.ai/api/inventory/price-lists
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/price-lists/{id}
Change a price list
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/price-lists/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
PUT/api/inventory/price-lists/{id}/entries
Change the entries of a price list
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PUT https://app.jaicrm.ai/api/inventory/price-lists/RECORD_ID/entries
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/price-lists/{id}
Delete a price list
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/price-lists/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Categories
GET/api/inventory/categories
List categories
curl -X GET https://app.jaicrm.ai/api/inventory/categories
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/categories/{id}/items
List items
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/categories/RECORD_ID/items
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/categories/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/categories/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/categories
Create a category
curl -X POST https://app.jaicrm.ai/api/inventory/categories
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/categories/import
Create an import
curl -X POST https://app.jaicrm.ai/api/inventory/categories/import
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/categories/{id}
Change a category
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/categories/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/categories/{id}
Delete a category
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/categories/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Reports
GET/api/inventory/reports/ageing
Run the ageing report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/ageing
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/reports/expiry
Run the expiry report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/expiry
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/reports/movement-summary
Run the movement summary report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/movement-summary
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/reports/reorder
Run the reorder report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/reorder
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/reports/valuation
Run the valuation report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/valuation
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/reports/vendor-supply
Run the vendor supply report
curl -X GET https://app.jaicrm.ai/api/inventory/reports/vendor-supply
-H 'Authorization: Bearer YOUR_API_KEY'
Receipts
GET/api/inventory/receipts
List receipts
curl -X GET https://app.jaicrm.ai/api/inventory/receipts
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/receipts/{id}
Read one receipt
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/receipts/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/receipts/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/receipts/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/receipts
Create a receipt
curl -X POST https://app.jaicrm.ai/api/inventory/receipts
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/receipts/{id}/post
Create a post
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/receipts/RECORD_ID/post
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/receipts/{id}
Delete a receipt
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/receipts/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Shipments
GET/api/inventory/shipments
List shipments
curl -X GET https://app.jaicrm.ai/api/inventory/shipments
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/shipments/{id}
Read one shipment
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/shipments/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/shipments/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/shipments/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/shipments/{id}/delivered
Create a delivered
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/shipments/RECORD_ID/delivered
-H 'Authorization: Bearer YOUR_API_KEY'
Fulfilment
GET/api/inventory/fulfilment/availability/{documentId}
Read one availability
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/fulfilment/availability/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/fulfilment/picklist/{documentId}
Read one picklist
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/fulfilment/picklist/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/fulfilment/reserve/{documentId}
Act on a reserve
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/fulfilment/reserve/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/fulfilment/ship/{documentId}
Act on a ship
| Parameter | Type | Required | Notes |
|---|---|---|---|
documentId | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/fulfilment/ship/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Serials
GET/api/inventory/serials
List serials
curl -X GET https://app.jaicrm.ai/api/inventory/serials
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/serials/{serial}/history
List history
| Parameter | Type | Required | Notes |
|---|---|---|---|
serial | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/serials/RECORD_ID/history
-H 'Authorization: Bearer YOUR_API_KEY'
POST/api/inventory/serials/{serial}/found
Create a found
| Parameter | Type | Required | Notes |
|---|---|---|---|
serial | string | Required | The record’s id. |
curl -X POST https://app.jaicrm.ai/api/inventory/serials/RECORD_ID/found
-H 'Authorization: Bearer YOUR_API_KEY'
Movements
GET/api/inventory/movements
List movements
curl -X GET https://app.jaicrm.ai/api/inventory/movements
-H 'Authorization: Bearer YOUR_API_KEY'
GET/api/inventory/movements/export.csv
List export.csv
curl -X GET https://app.jaicrm.ai/api/inventory/movements/export.csv
-H 'Authorization: Bearer YOUR_API_KEY'
Batches
GET/api/inventory/batches
List batches
curl -X GET https://app.jaicrm.ai/api/inventory/batches
-H 'Authorization: Bearer YOUR_API_KEY'
PATCH/api/inventory/batches/{batchId}
Change a batche
| Parameter | Type | Required | Notes |
|---|---|---|---|
batchId | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/batches/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Bins
PATCH/api/inventory/bins/{id}
Change a bin
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X PATCH https://app.jaicrm.ai/api/inventory/bins/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
DELETE/api/inventory/bins/{id}
Delete a bin
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/bins/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Dashboard
GET/api/inventory/dashboard
Read the inventory dashboard
curl -X GET https://app.jaicrm.ai/api/inventory/dashboard
-H 'Authorization: Bearer YOUR_API_KEY'
Balances
GET/api/inventory/balances
List balances
curl -X GET https://app.jaicrm.ai/api/inventory/balances
-H 'Authorization: Bearer YOUR_API_KEY'
Cycle count
GET/api/inventory/cycle-count
List cycle count
curl -X GET https://app.jaicrm.ai/api/inventory/cycle-count
-H 'Authorization: Bearer YOUR_API_KEY'
Scan
GET/api/inventory/scan
List scan
curl -X GET https://app.jaicrm.ai/api/inventory/scan
-H 'Authorization: Bearer YOUR_API_KEY'
Zones
DELETE/api/inventory/zones/{id}
Delete a zone
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X DELETE https://app.jaicrm.ai/api/inventory/zones/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Composite
GET/api/inventory/composite/{id}
Read one composite
| Parameter | Type | Required | Notes |
|---|---|---|---|
id | string | Required | The record’s id. |
curl -X GET https://app.jaicrm.ai/api/inventory/composite/RECORD_ID
-H 'Authorization: Bearer YOUR_API_KEY'
Channel push
GET/api/inventory/channel-push
List channel push
curl -X GET https://app.jaicrm.ai/api/inventory/channel-push
-H 'Authorization: Bearer YOUR_API_KEY'
Channel items
GET/api/inventory/channel-items
List channel items
curl -X GET https://app.jaicrm.ai/api/inventory/channel-items
-H 'Authorization: Bearer YOUR_API_KEY'
Inventory
GET/api/inventory/
List inventory
curl -X GET https://app.jaicrm.ai/api/inventory/
-H 'Authorization: Bearer YOUR_API_KEY'
Something missing or wrong here? Tell us. A question that needed asking usually means a page that needed writing.