Drop Zones

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}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company 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

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

An array of available drop zones

Request

Query
paginationobject
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/drop_zones?active=true&page=0&per_page=100&public=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a list of drop zones

Bodyapplication/json
drop_zonesArray of objects(DropZone)required
drop_zones[].​uuidstringrequired
drop_zones[].​namestringrequired
drop_zones[].​activeboolean or null
Default false
drop_zones[].​settingsobject or null
Default "{}"
drop_zones[].​embed_urlstringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{
  "drop_zones": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z",
    "pagination": { … }
  }
}

creates a drop zone

Request

Bodyapplication/json
drop_zoneobjectrequired
drop_zone.​namestringnon-emptyrequired
drop_zone.​embed_urlstringnon-emptyrequired
drop_zone.​activeboolean
drop_zone.​settingsobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/drop_zones \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "drop_zone": {
      "name": "string",
      "embed_url": "string",
      "active": true,
      "settings": {}
    }
  }'

Responses

drop zone created successfully

Bodyapplication/json
drop_zoneobject(DropZone)required
drop_zone.​uuidstringrequired
drop_zone.​namestringrequired
drop_zone.​activeboolean or null
Default false
drop_zone.​settingsobject or null
Default "{}"
drop_zone.​embed_urlstringrequired
drop_zone.​created_atstring(date-time)required
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "drop_zone": {
    "uuid": "string",
    "name": "string",
    "active": false,
    "settings": "{}",
    "embed_url": "string",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

shows a drop zone

Request

Path
uuidstringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/drop_zones/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a single drop zone

Bodyapplication/json
drop_zoneobject(DropZone)required
drop_zone.​uuidstringrequired
drop_zone.​namestringrequired
drop_zone.​activeboolean or null
Default false
drop_zone.​settingsobject or null
Default "{}"
drop_zone.​embed_urlstringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "drop_zone": {
    "uuid": "string",
    "name": "string",
    "active": false,
    "settings": "{}",
    "embed_url": "string"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

updates a drop zone

Request

Path
uuidstringrequired
Bodyapplication/json
uuidstringrequired
drop_zoneobjectrequired
drop_zone.​namestringnon-empty
drop_zone.​activeboolean
drop_zone.​settingsobject
drop_zone.​embed_urlstringnon-empty
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/drop_zones/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuid": "string",
    "drop_zone": {
      "name": "string",
      "active": true,
      "settings": {},
      "embed_url": "string"
    }
  }'

Responses

drop zone updated successfully

Bodyapplication/json
drop_zoneobject(DropZone)required
drop_zone.​uuidstringrequired
drop_zone.​namestringrequired
drop_zone.​activeboolean or null
Default false
drop_zone.​settingsobject or null
Default "{}"
drop_zone.​embed_urlstringrequired
drop_zone.​updated_atstring(date-time)required
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "drop_zone": {
    "uuid": "string",
    "name": "string",
    "active": false,
    "settings": "{}",
    "embed_url": "string",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

deletes a drop zone

Request

Path
uuidstringrequired
Bodyapplication/json
uuidstringrequired
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/drop_zones/{uuid}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuid": "string"
  }'

Responses

drop zone deleted successfully

Bodyapplication/json
uuidstringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{
  "uuid": "string",
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

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

Responses

returns a list of droplet categories

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