Company Settings - Warehouses

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://fluid-commerce.redocly.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

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

List warehouses

Request

List all warehouses for the company.

curl -i -X GET \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
warehousesArray of objects(Warehouse)
metaobject
Response
application/json
{
  "warehouses": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Create a warehouse

Request

Create a new warehouse for the company.

Bodyapplication/json
namestringnon-empty
activeboolean
defaultboolean
countryobject
addressobject
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "active": true,
    "default": true,
    "country": {
      "id": 0,
      "iso": "string"
    },
    "address": {
      "address1": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "address2": "string"
    }
  }'

Responses

warehouse created

Bodyapplication/json
warehouseobject(Warehouse)
metaobject
Response
application/json
{
  "warehouse": {
    "id": 0,
    "name": "Central Distribution Center",
    "active": true,
    "external_id": "WH-12345",
    "metadata": { … },
    "country": { … },
    "address": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Show a warehouse

Request

Show a warehouse by ID.

Path
idintegerrequired
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

warehouse shown

Bodyapplication/json
warehouseobject(Warehouse)
metaobject
Response
application/json
{
  "warehouse": {
    "id": 0,
    "name": "Central Distribution Center",
    "active": true,
    "external_id": "WH-12345",
    "metadata": { … },
    "country": { … },
    "address": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Update a warehouse

Request

Update a warehouse by ID.

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
namestringnon-empty
activeboolean
defaultboolean
countryobject
addressobject
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "active": true,
    "default": true,
    "country": {
      "id": 0,
      "iso": "string"
    },
    "address": {
      "address1": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "address2": "string"
    }
  }'

Responses

warehouse updated

Bodyapplication/json
warehouseobject(Warehouse)
metaobject
Response
application/json
{
  "warehouse": {
    "id": 0,
    "name": "Central Distribution Center",
    "active": true,
    "external_id": "WH-12345",
    "metadata": { … },
    "country": { … },
    "address": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Delete a warehouse

Request

Delete a warehouse by ID.

Path
idintegerrequired
curl -i -X DELETE \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

warehouse deleted

Bodyapplication/json
successboolean
messagestring
metaobject
Response
application/json
{
  "success": true,
  "message": "string",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Assign warehouse to country

Request

Assign a warehouse to a country.

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
country_codestringnon-emptyrequired
customsstringnon-empty
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses/{id}/assign_to_country' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "country_code": "string",
    "customs": "string"
  }'

Responses

warehouse assigned to country with customs option

Bodyapplication/json
warehouseobject(Warehouse)
metaobject
Response
application/json
{
  "warehouse": {
    "id": 0,
    "name": "Central Distribution Center",
    "active": true,
    "external_id": "WH-12345",
    "metadata": { … },
    "country": { … },
    "address": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Append metadata field

Request

Append a metadata field to a warehouse.

Path
idintegerrequired

Warehouse's Id

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

Example: {"capacity":{"total_square_feet":50000},"operations":{"staff_count":15,"security_level":"high"}}
curl -i -X PATCH \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/settings/warehouses/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {
      "capacity": {
        "total_square_feet": 50000
      },
      "operations": {
        "staff_count": 15,
        "security_level": "high"
      }
    }
  }'

Responses

success

Bodyapplication/json
warehouseobject(Warehouse)
metaobject
Response
application/json
{
  "warehouse": {
    "id": 0,
    "name": "Central Distribution Center",
    "active": true,
    "external_id": "WH-12345",
    "metadata": { … },
    "country": { … },
    "address": { … }
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations