VariantInventoryLevels

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

MCC Codes

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Create a new variant inventory level

Request

Path
variant_idintegerrequired

Variant ID

Example: 1
Bodyapplication/json
inventory_levelobjectrequired
inventory_level.​warehouse_idinteger
inventory_level.​availableinteger
inventory_level.​committedinteger
inventory_level.​on_handinteger
inventory_level.​unavailableinteger
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/v1/variants/{variant_id}/inventory_levels' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "inventory_level": {
      "warehouse_id": 0,
      "available": 0,
      "committed": 0,
      "on_hand": 0,
      "unavailable": 0
    }
  }'

Responses

Variant inventory level created successfully

Bodyapplication/json
inventory_levelobject(InventoryLevel)required
inventory_level.​idintegerrequired
inventory_level.​committedintegerrequired

Number of items committed to orders

Example: 10
inventory_level.​availableintegerrequired

Number of items available for sale

Example: 25
inventory_level.​on_handintegerrequired

Total number of items physically in stock

Example: 35
inventory_level.​unavailableintegerrequired

Number of items unavailable for sale

Example: 5
inventory_level.​adjustmentsArray of arrays or null or null

Inventory adjustments made to this level

Example: [{"id":1,"quantity":-2,"reason":"damaged"}]
inventory_level.​unavailable_item_counts_by_categoryobject or null

Count of unavailable items grouped by category

Example: {"damaged":3,"reserved":2}
inventory_level.​warningstring or null

Warning message for this inventory level

Example: "Low stock alert"
inventory_level.​variantobjectrequired

Variant information for this inventory level

Example: {"id":456,"sku":"WIDGET-001","track_quantity":true,"keep_selling":false}
inventory_level.​productobjectrequired

Product information for this inventory level

Example: {"id":789,"title":"Premium Widget Collection","image_url":"https://example.com/images/widget.jpg"}
inventory_level.​warehouseobjectrequired

Warehouse information where this inventory is stored

Example: {"id":101,"country":{"id":1,"name":"United States","iso":"US"},"address":{"id":201,"city":"New York","state":"NY","address1":"123 Main Street","postal_code":"10001"}}
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "inventory_level": {
    "id": 0,
    "committed": 10,
    "available": 25,
    "on_hand": 35,
    "unavailable": 5,
    "adjustments": [ … ],
    "unavailable_item_counts_by_category": { … },
    "warning": "Low stock alert",
    "variant": { … },
    "product": { … },
    "warehouse": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations

Delete a media

Request

Path
idintegerrequired

Media ID

Example: 1
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/media/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media destroyed

Bodyapplication/json
string
Response
application/json
"string"