API: Batches
API: Batches
Programmatic access — early access
The
tieback
API is available to selected workspaces during early access. Endpoints in production today are authenticated with an authenticated session. Standalone API-key access is being onboarded per workspace. Contact
tieback
to enable API credentials for your workspace.
What It Does
The Batches API lets you create and manage production batches for products. Each batch represents a specific production run and can be independently tracked, updated, and used as the scope for minting a Digital Product Passport.
Authentication & Permissions
All RPCs require an authenticated session. Mutations require a role with sufficient permissions for the target brand.
RPCs
create_product_batch
Creates a new production batch for a product.
Request
Response
Errors
- Not authenticated, request has no valid JWT.
- Forbidden, caller does not have sufficient access.
- Invalid input, request is malformed or cannot be processed.
Notes
_production_date,_quantity,_facility_ref, and_attributesare optional._batch_numbermust be unique within the product.
list_product_batches
Returns all batches for a given product.
Request
Response
Errors
- Not authenticated, request has no valid JWT.
- Forbidden, caller does not have sufficient access.
- Invalid input, request is malformed or cannot be processed.
update_product_batch
Updates an existing batch’s metadata.
Request
Response
Errors
- Not authenticated, request has no valid JWT.
- Forbidden, caller does not have sufficient access.
- Invalid input, request is malformed or cannot be processed.