The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.
For APIs that authenticate with User tokens, see the Rep APIs documentation.
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels?available_greater_than=string&available_less_than=string&committed_greater_than=string&committed_less_than=string&on_hand_greater_than=string&on_hand_less_than=string&product_tags=string&published_to=string&search=string&unavailable_greater_than=string&unavailable_less_than=string&variant_ids=string&warehouse_ids=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "inventory_levels": [ { … } ], "meta": { "request_id": "string", "timestamp": "string", "total_count": 0, "total_pages": 0, "page_size": 0, "current_page": 0 } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "inventory_level": { "id": 0 }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/set \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "inventory_level": { "variant_id": 1, "warehouse_id": 1, "on_hand": 10, "available": 5, "unavailable": 0, "committed": 5, "reason": "Stock adjustment" } }'
{ "inventory_level": { "id": 0, "committed": 0, "available": 0, "on_hand": 0, "unavailable": 0, "warning": "string", "adjustments": [], "unavailable_item_counts_by_category": [], "variant": { … }, "product": { … }, "warehouse": { … } }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/adjust \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "inventory_level": { "id": 0, "adjustment_attribute": "on_hand", "quantity": 0, "reason": "string" } }'
{ "inventory_level": { "id": 0, "committed": 0, "available": 0, "on_hand": 0, "unavailable": 0, "warning": "string", "adjustments": [], "unavailable_item_counts_by_category": [], "variant": { … }, "product": { … }, "warehouse": { … } }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X DELETE \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/bulk_delete \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "inventory_level_ids": [ 0 ] }'
{ "delete_statuses": [ { … }, { … } ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/export_csv?variant_ids=string&warehouse_ids=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "export_url": "string", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/presigned_csv_url \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "url": "https://path/to/file/sth.csv", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/import_csv \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: multipart/form-data' \ -F file=string \ -F url=https://example.com/path/to/csv
{ "created": 10, "updated": 5, "failed": 2, "invalid_rows": 1, "import_status_url": "https://fake-url.com/file.csv", "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
curl -i -X PATCH \ https://docs.fluid.app/_mock/docs/apis/company.api/api/inventory_levels/bulk_update \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "inventory_levels": [ { "id": 0, "on_hand": 0, "available": 0, "unavailable": 0, "committed": 0, "reason": "lost some items on fire accident", "unavailable_item_counts_by_category": [], "track_quantity": true, "keep_selling": false } ] }'
{ "inventory_levels": [ { … } ], "errors": [ { … } ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }
Social Media