Inventory¶
Endpoints related to inventory.
- GET /stock-projection/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested stock_projection cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /stock-projection/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested stock_projection cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /stock-projection/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested stock_projection cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /stock-projection/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested stock_projection cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /stock-projection/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested stock_projection cannot be found.
405 Method Not Allowed – MethodNotAllowed
- GET /finished-goods-stock-action/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – RecordNotFound
403 Forbidden – You are not authorized to complete the request.
- POST /finished-goods-stock-action/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – RecordNotFound
403 Forbidden – You are not authorized to complete the request.
- Response Headers:
Location – URI of the created resource
- GET /finished-goods-stock-action/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – RecordNotFound
403 Forbidden – You are not authorized to complete the request.
- PUT /finished-goods-stock-action/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – RecordNotFound
403 Forbidden – You are not authorized to complete the request.
- DELETE /finished-goods-stock-action/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – RecordNotFound
403 Forbidden – You are not authorized to complete the request.
- GET /stock/¶
List all of the stocks in the system for your account.
List all of the stocks in the system for your account.
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
400 Bad Request – You cannot delete this stock because it is being tracked with material_lots/containers Delete all related lots and containers first. A stock with requested material and location already exists (this pair should be unique).
404 Not Found – The requested stock cannot be found.
403 Forbidden – You are not authorized to complete the request.
- POST /stock/¶
Create a new stock.
Create a new stock.
- Status Codes:
201 Created – Resource created successfully
400 Bad Request – You cannot delete this stock because it is being tracked with material_lots/containers Delete all related lots and containers first. A stock with requested material and location already exists (this pair should be unique).
404 Not Found – The requested stock cannot be found.
403 Forbidden – You are not authorized to complete the request.
- Response Headers:
Location – URI of the created resource
- GET /stock/{uuid}/¶
Get a single stock by UUID.
Get a single stock by UUID.
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
400 Bad Request – You cannot delete this stock because it is being tracked with material_lots/containers Delete all related lots and containers first. A stock with requested material and location already exists (this pair should be unique).
404 Not Found – The requested stock cannot be found.
403 Forbidden – You are not authorized to complete the request.
- PUT /stock/{uuid}/¶
Update a stock by UUID.
Update a stock by UUID.
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
400 Bad Request – You cannot delete this stock because it is being tracked with material_lots/containers Delete all related lots and containers first. A stock with requested material and location already exists (this pair should be unique).
404 Not Found – The requested stock cannot be found.
403 Forbidden – You are not authorized to complete the request.
- DELETE /stock/{uuid}/¶
Delete a stock by UUID.
Delete a stock by UUID.
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
400 Bad Request – You cannot delete this stock because it is being tracked with material_lots/containers Delete all related lots and containers first. A stock with requested material and location already exists (this pair should be unique).
404 Not Found – The requested stock cannot be found.
403 Forbidden – You are not authorized to complete the request.
- GET /finished-goods-stock-inventory/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested finished goods stock inventory cannot be found.
405 Method Not Allowed – MethodNotAllowed
- POST /finished-goods-stock-inventory/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested finished goods stock inventory cannot be found.
405 Method Not Allowed – MethodNotAllowed
- Response Headers:
Location – URI of the created resource
- GET /finished-goods-stock-inventory/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested finished goods stock inventory cannot be found.
405 Method Not Allowed – MethodNotAllowed
- PUT /finished-goods-stock-inventory/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested finished goods stock inventory cannot be found.
405 Method Not Allowed – MethodNotAllowed
- DELETE /finished-goods-stock-inventory/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource deleted successfully
404 Not Found – The requested finished goods stock inventory cannot be found.
405 Method Not Allowed – MethodNotAllowed