/meCheck your API key
Returns the organization and key that the request is authenticated as.
Returns object.
A REST API for CoinManagerPro. Read and update your coin inventory with value, cost basis, grading, and location, and read AI valuations, consignments, and sales invoices. Use it to sync inventory with your own website, accounting, or point of sale. The API is part of the Business and Enterprise plans.
curl "https://api.flowauctions.com/inventory/v1/items?q=morgan&limit=5" \ -H "Authorization: Bearer cmp_live_..."
Every request needs Authorization: Bearer <key>. Keys start with cmp_live_ and belong to your workspace. A key acts as the owner or admin who created it, so it stops working if that person leaves or is no longer an owner or admin. Revoke a key from the settings page at any time. Keep keys on your server; do not put them in a web page or mobile app.
https://api.flowauctions.com/inventory/v1Retry-After header.Content-Type: application/json.page and limit (1 to 100) and return hasMore.Errors return { code, message }, plus issues for validation errors.
| Status | Code | Meaning |
|---|---|---|
| 400 | BAD_REQUEST | The request failed validation. `issues` lists each field. |
| 401 | UNAUTHORIZED | The key is missing, unknown, expired, or revoked. |
| 403 | FORBIDDEN | The plan no longer includes the API, or the key's creator is no longer an owner or admin. |
| 404 | NOT_FOUND | No such resource, or it belongs to another organization. |
| 429 | TOO_MANY_REQUESTS | Rate limit reached. Wait for the seconds in `Retry-After`. |
| 500 | INTERNAL_SERVER_ERROR | Something failed on our side. Retry, or email us. |
The full machine-readable reference is the OpenAPI 3.1 document. Load it into Postman, Insomnia, or a code generator.
/meReturns the organization and key that the request is authenticated as.
Returns object.
/itemsYour workspace's inventory items, with value, cost, grading, and images.
Parameters
| Field | Type | Notes |
|---|---|---|
| q | string | |
| status | "in_stock" | "out_of_stock" | "sold" | "at_auction" | |
| categoryId | uuid | |
| gradingService | string | |
| grade | string | |
| sku | string | |
| sort | "newest" | "oldest" | "title" | "value_desc" | "value_asc" | "sku" | Default "newest". |
| page | integer | Page number, starting at 1. Default 1. |
| limit | integer | Results per page, 1 to 100. Default 20. |
Returns a page of Item[].
/itemsAdds an item to your inventory. Without warehouseId and zoneId it goes to your default warehouse. Returns 409 when the SKU is already used. Photos are added in the CoinManagerPro app.
JSON body
| Field | Type | Notes |
|---|---|---|
| sku* | string | Unique within your workspace. |
| title* | string | |
| description | string | |
| quantity | integer | Units available. Default 1. |
| valueInCents | integer | Default 0. |
| acquisitionPriceInCents | integer | |
| acquisitionDate | date-time | |
| acquiredFrom | string | |
| acquisitionNotes | string | |
| gradingService | string | |
| grade | string | |
| certificateNumber | string | |
| gradingNotes | string | |
| categoryId | uuid | |
| attributes | object | |
| warehouseId | uuid | Defaults to your default warehouse. |
| zoneId | uuid | Defaults to the first zone of the warehouse. |
| locationDetails | string |
Returns Item.
/items/{id}Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid |
Returns Item.
/items/{id}Changes only the fields you send. Changing quantity also updates a linked Flow Dealers listing.
Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid |
JSON body
| Field | Type | Notes |
|---|---|---|
| sku | string | Unique within your workspace. |
| title | string | |
| description | string | |
| quantity | integer | Units available. Default 1. |
| valueInCents | integer | Default 0. |
| acquisitionPriceInCents | integer | |
| acquisitionDate | date-time | |
| acquiredFrom | string | |
| acquisitionNotes | string | |
| gradingService | string | |
| grade | string | |
| certificateNumber | string | |
| gradingNotes | string | |
| categoryId | uuid | |
| attributes | object | |
| warehouseId | uuid | Defaults to your default warehouse. |
| zoneId | uuid | Defaults to the first zone of the warehouse. |
| locationDetails | string |
Returns Item.
/items/{id}Removes the item and any Flow Dealers listing made from it.
Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid |
Returns object.
/items/{id}/valuationsAI valuations of the item, newest first, with the comparable sales they used.
Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid | |
| limit | integer | Most recent first, 1 to 50. Default 10. |
Returns a page of Valuation[].
/consignmentsConsignments in your workspace, newest first, with totals and the consignor.
Parameters
| Field | Type | Notes |
|---|---|---|
| q | string | |
| status | "intake" | "cataloging" | "listed" | "partially_sold" | "sold" | "settled" | "withdrawn" | "returned" | |
| consignorId | uuid | |
| page | integer | Page number, starting at 1. Default 1. |
| limit | integer | Results per page, 1 to 100. Default 20. |
Returns a page of Consignment[].
/consignments/{id}Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid |
Returns Consignment.
/invoicesSales invoices in your workspace, with lines and payments.
Parameters
| Field | Type | Notes |
|---|---|---|
| q | string | |
| status | "draft" | "sent" | "paid" | "partially_paid" | "overdue" | "void" | "cancelled" | |
| sort | "newest" | "oldest" | Default "newest". |
| page | integer | Page number, starting at 1. Default 1. |
| limit | integer | Results per page, 1 to 100. Default 20. |
Returns a page of Invoice[].
/invoices/{id}Parameters
| Field | Type | Notes |
|---|---|---|
| {id}* | uuid |
Returns Invoice.
Questions about the API: email support@coinmanagerpro.com.