Lots
Product lots: number from the package, expiry date and availability. Stock movements and document lines point to the lot.
Lots
Objects
Lot
idintegerrequiredID of the record, unique among records of its kind in the store.
variant_idintegerrequiredProduct variant ID (/v1/variants).
numberstringrequiredLot number — from the supplier's package or assigned by the store; unique within the variant.
expires_onstring (date) or nullrequiredBest before, as an accounting date YYYY-MM-DD; null without an expiry date.
statusstringrequiredAvailability: available — for sale; hold — on hold; quarantine — quarantined. A held or quarantined lot stays in stock but is not sold or picked.
- Values:
availableholdquarantine
received_atstring (date-time)requiredWhen the lot arrived in stock.
documentobject or nullrequiredDocument the lot arrived with; null when the lot was assigned to stock without a document.
Fields · 2
typestringrequiredDocument type: goods_receipt — goods receipt (/v1/goods-receipts); production_order — production order; stocktake — stocktake that found the goods.
- Values:
goods_receiptproduction_orderstocktake
idintegerrequiredDocument ID.
merged_into_lot_idinteger or nullrequiredID of the lot this one was merged into: stock and movements continue on it; null for a standalone lot.
created_atstring (date-time)requiredWhen the record was created.
updated_atstring (date-time)requiredWhen the record last changed.
Endpoints
Product lots: number, expiry date and status, changed since a given moment
get/lots
Scope: inventory:read
Parameters
Query
limitintegerPage size: up to 250 records; 50 by default.
- Minimum:
- 1
- Maximum:
- 250
cursorstringOpaque cursor: next_cursor of the previous page, or sync_cursor of the last page saved by the previous sync. The list goes in commit order, so the sync cursor later returns only what changed after it.
- Max length:
- 4096
updated_sincestring (date-time)Only records changed after this moment, ISO 8601 with a time zone. A filter for the first sync; continue with the cursor.
- Pattern:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
include_deletedbooleantrue — also return deleted records: archived ones with deleted_at set, and records erased from the database as tombstones {id, deleted_at} in the continuation by the sync cursor. Turn it on for a sync.
variant_idintegerOnly lots of this variant.
- Minimum:
- 1
Responses
200Success
application/json
Records of the page.
deletedarray of objectrequiredRecords erased from the database since the cursor, as tombstones: only with include_deleted=true in the continuation by the sync cursor.
Fields · 2
idintegerrequiredID of the erased record.
deleted_atstring (date-time)requiredWhen the record was erased.
next_cursorstring or nullrequiredCursor of the next page; null on the last page.
has_morebooleanrequiredtrue when there is a next page.
sync_cursorstring or nullrequiredOn the last page — the cursor to continue from later: it returns only what changed after this page. null on other pages.
401The token is missing, invalid, expired or revoked
Headers
WWW-AuthenticatestringrequiredAuthentication scheme (RFC 6750).
- Example:
Bearer
application/problem+json
Returns Problem
403The plan, the IP address or the token scopes do not allow the request
Headers
WWW-AuthenticatestringAuthentication scheme (RFC 6750).
- Example:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Returns ForbiddenProblem
410The sync cursor is older than the deletion retention period or was issued before the database was restored
application/problem+json
Returns Problem
422A parameter is invalid or unknown
application/problem+json
Returns ValidationProblem
429The rate limit is exhausted
Headers
Retry-AfterintegerrequiredSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns RateLimitProblem
503The store is temporarily unavailable
Headers
Retry-AfterintegerSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns Problem
Errors of this endpoint
Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors
curl "https://api.saleya.app/v1/lots" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"variant_id": 0,
"number": "string",
"expires_on": "2026-01-15",
"status": "available",
"received_at": "2026-01-15T12:00:00Z",
"document": {
"type": "goods_receipt",
"id": 0
},
"merged_into_lot_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Product lot
get/lots/{lot}
Scope: inventory:read
Parameters
Path
lotintegerrequiredLot ID.
Responses
200Success
application/json
Returns Lot
401The token is missing, invalid, expired or revoked
Headers
WWW-AuthenticatestringrequiredAuthentication scheme (RFC 6750).
- Example:
Bearer
application/problem+json
Returns Problem
403The plan, the IP address or the token scopes do not allow the request
Headers
WWW-AuthenticatestringAuthentication scheme (RFC 6750).
- Example:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Returns ForbiddenProblem
404The object does not exist or is not available to the app
application/problem+json
Returns Problem
422A parameter is invalid or unknown
application/problem+json
Returns ValidationProblem
429The rate limit is exhausted
Headers
Retry-AfterintegerrequiredSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns RateLimitProblem
503The store is temporarily unavailable
Headers
Retry-AfterintegerSeconds to wait before retrying.
- Minimum:
- 0
application/problem+json
Returns Problem
Common errors such as token, access, input validation and rate limit can come from any endpoint; they are listed in the catalog: Errors
curl "https://api.saleya.app/v1/lots/{lot}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"variant_id": 0,
"number": "string",
"expires_on": "2026-01-15",
"status": "available",
"received_at": "2026-01-15T12:00:00Z",
"document": {
"type": "goods_receipt",
"id": 0
},
"merged_into_lot_id": 0,
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}