Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/CodexaCP/DG_BACK/llms.txt

Use this file to discover all available pages before exploring further.

The Bins and Locations API exposes the warehouse physical structure — bins (storage slots), locations (warehouses), the company warehouse context, and document sequence counters. All endpoints are scoped to the authenticated tenant.

​
GET /api/bins

Returns a paginated list of bins for the tenant. Bins represent the individual storage slots or zones within a warehouse location. Authentication: Authorization: Bearer <token> (required).
​
companyId
string (uuid)
Tenant company ID. Resolved from JWT claims if omitted.
​
activeOnly
boolean
Return only active bins. Defaults to true.
​
pageNumber
integer
1-based page number. Defaults to 1.
​
pageSize
integer
Records per page. Defaults to 20.
​
data
array
Paginated list of bin summaries.
​
pageNumber
integer
Current page.
​
pageSize
integer
Page size.
​
totalRecords
integer
Total bins matching the filter.
​
totalPages
integer
Total pages.
curl -X GET "https://api.example.com/api/bins?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6&activeOnly=true" \
  -H "Authorization: Bearer <token>"

​
GET /api/bins/

Returns full detail for a single bin including the company name and audit timestamps. Authentication: Authorization: Bearer <token> (required). The caller must have access to the bin’s owning company.
​
id
string (uuid)
required
Bin unique identifier.
​
id
string (uuid)
Bin ID.
​
binCode
string
Bin code.
​
description
string
Bin description.
​
isActive
boolean
Active status.
​
isBlocked
boolean
Blocked status.
​
binType
string
Bin type.
​
allowPicking
boolean
Picking allowed flag.
​
allowPutaway
boolean
Putaway allowed flag.
​
companyId
string (uuid)
Owning company ID.
​
companyName
string
Owning company display name.
​
createdAt
string (ISO 8601)
Creation timestamp.
​
updatedAt
string (ISO 8601)
Last update timestamp.
Error codes
StatusMeaning
404Bin not found or not accessible by the caller’s company.
curl -X GET "https://api.example.com/api/bins/5e9a1234-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer <token>"

​
GET /api/locations

Returns a paginated list of warehouse locations for the authenticated company. Locations represent physical warehouses or distribution centers. Authentication: Authorization: Bearer <token> (required).
​
activeOnly
boolean
Filter to active locations only. Defaults to false.
​
receivingOnly
boolean
Filter to locations that allow receiving. Defaults to false.
​
search
string
Free-text search against location code, name, and city.
​
pageNumber
integer
1-based page. Defaults to 1.
​
pageSize
integer
Page size. Defaults to 20.
​
data
array
​
pageNumber
integer
Current page.
​
pageSize
integer
Page size.
​
totalRecords
integer
Total matching locations.
​
totalPages
integer
Total pages.
curl -X GET "https://api.example.com/api/locations?activeOnly=true&pageSize=100" \
  -H "Authorization: Bearer <token>"

​
GET /api/warehouse/locations

Returns the list of warehouse locations scoped to the authenticated company, ordered with the default location first. Authentication: Authorization: Bearer <token> (required).
​
data
array
List of warehouse location summaries with code, name, isDefault, and allowReceiving.
curl -X GET "https://api.example.com/api/warehouse/locations" \
  -H "Authorization: Bearer <token>"

​
GET /api/warehouse/locations/

Returns detail for a single warehouse location including its bins. Authentication: Authorization: Bearer <token> (required).
​
id
string (uuid)
required
Location ID.
curl -X GET "https://api.example.com/api/warehouse/locations/5e9a1234-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer <token>"

​
GET /api/warehouse/setup-status

Returns the warehouse setup status for the company — whether default location and default bin have been configured. Authentication: Authorization: Bearer <token> (required).
​
hasDefaultLocation
boolean
Whether a default location has been set.
​
hasDefaultBin
boolean
Whether a default bin has been set.
​
locationCode
string
Default location code, if any.
​
binCode
string
Default bin code, if any.
curl -X GET "https://api.example.com/api/warehouse/setup-status" \
  -H "Authorization: Bearer <token>"

​
GET /api/document-sequence

Returns the current document sequence counters registered for the company. Sequences track the last auto-generated number for document types such as ITEM_CREATED, RECEIPT_CREATED, and SHIPMENT_CREATE. Authentication: Authorization: Bearer <token> (required).
​
companyId
string (uuid)
Tenant company ID.
​
data
array
curl -X GET "https://api.example.com/api/document-sequence?companyId=3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer <token>"

Build docs developers (and LLMs) love

Get started for freeTalk to us