Order Fulfillments

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

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

List order fulfillments

Request

List all order fulfillments

Query
order_idinteger

Filter by order ID

pageinteger

Page number

per_pageinteger

Items per page

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/order_fulfillments?order_id=0&page=0&per_page=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
jsonArray of objects
metaobject
Response
application/json
{
  "json": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "pagination": { … }
  }
}

Create order fulfillment

Request

Create a new order fulfillment

Bodyapplication/json
order_idintegerrequired
order_itemsArray of objectsrequired
order_items[].​item_idintegerrequired
order_items[].​quantityintegerrequired
tracking_informationsArray of objects
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/order_fulfillments \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_id": 0,
    "order_items": [
      {
        "item_id": 0,
        "quantity": 0
      }
    ],
    "tracking_informations": [
      {
        "tracking_number": "string",
        "shipping_carrier": "string"
      }
    ]
  }'

Responses

created

Bodyapplication/json
idinteger
created_atstring(date-time)
updated_atstring(date-time)
order_item_fulfillmentsArray of objects
tracking_informationsArray of objects
metaobject
Response
application/json
{
  "id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "order_item_fulfillments": [
    { … }
  ],
  "tracking_informations": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Show order fulfillment

Request

Show a specific order fulfillment

Path
idintegerrequired

Order Fulfillment ID

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

Responses

successful

Bodyapplication/json
idinteger
created_atstring(date-time)
updated_atstring(date-time)
order_item_fulfillmentsArray of objects
tracking_informationsArray of objects
metaobject
Response
application/json
{
  "id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "order_item_fulfillments": [
    { … }
  ],
  "tracking_informations": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Update order fulfillment

Request

Update an order fulfillment

Path
idintegerrequired

Order Fulfillment ID

Bodyapplication/json
order_itemsArray of objects
tracking_informationsArray of objects
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/order_fulfillments/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_items": [
      {
        "item_id": 0,
        "quantity": 0
      }
    ],
    "tracking_informations": [
      {
        "tracking_number": "string",
        "shipping_carrier": "string"
      }
    ]
  }'

Responses

successful

Bodyapplication/json
idinteger
created_atstring(date-time)
updated_atstring(date-time)
order_item_fulfillmentsArray of objects
tracking_informationsArray of objects
metaobject
Response
application/json
{
  "id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "order_item_fulfillments": [
    { … }
  ],
  "tracking_informations": [
    { … }
  ],
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

Delete order fulfillment

Request

Delete an order fulfillment

Path
idintegerrequired

Order Fulfillment ID

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

Responses

successful

Bodyapplication/json
idinteger
metaobject
Response
application/json
{
  "id": 0,
  "meta": {
    "request_id": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

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