order_edits

Dry-run an edit and return the would-be order shape

Accepts the same payload as POST /api/v202604/orders//edits. Runs the operations through the same editing engine as the commit endpoint inside a database savepoint that is ALWAYS rolled back, then returns the order with its recalculated current_* totals reflecting the post-operation state.

Use this to render a “before / after” preview before committing the real edit — e.g. an admin Edit Order sheet showing the new totals before the user clicks Commit.

No persistence happens:

order-edit audit records are not written
order_edited lifecycle event does NOT fire
subscribed webhooks do NOT receive the payload
order.updated_at does NOT advance

Authentication and authorization match the create endpoint (orders.update, company-scoped). Validation and business errors return the same shapes (400 / 422). Variant / item / discount lookups still happen, so 422s match what a real commit would produce — there is no “preview passed but commit failed” gap.

POST

api

v202604

orders

{order_id}

edits

preview

Dry-run an edit and return the would-be order shape

curl --request POST \
  --url https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operations": [
    {
      "type": "insert_item",
      "variant_id": "abc123",
      "quantity": 1,
      "price": "29.99"
    },
    {
      "type": "add_adjustment",
      "amount": "-29.99",
      "label": "Free gift credit",
      "adjustment_type": "credit",
      "source_type": "droplet",
      "source_id": "free-gift-droplet"
    }
  ]
}
'

import requests

url = "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview"

payload = { "operations": [
        {
            "type": "insert_item",
            "variant_id": "abc123",
            "quantity": 1,
            "price": "29.99"
        },
        {
            "type": "add_adjustment",
            "amount": "-29.99",
            "label": "Free gift credit",
            "adjustment_type": "credit",
            "source_type": "droplet",
            "source_id": "free-gift-droplet"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operations: [
      {type: 'insert_item', variant_id: 'abc123', quantity: 1, price: '29.99'},
      {
        type: 'add_adjustment',
        amount: '-29.99',
        label: 'Free gift credit',
        adjustment_type: 'credit',
        source_type: 'droplet',
        source_id: 'free-gift-droplet'
      }
    ]
  })
};

fetch('https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'operations' => [
        [
                'type' => 'insert_item',
                'variant_id' => 'abc123',
                'quantity' => 1,
                'price' => '29.99'
        ],
        [
                'type' => 'add_adjustment',
                'amount' => '-29.99',
                'label' => 'Free gift credit',
                'adjustment_type' => 'credit',
                'source_type' => 'droplet',
                'source_id' => 'free-gift-droplet'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview"

	payload := strings.NewReader("{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "order": {
    "id": 90210,
    "order_number": "1001",
    "status": "complete",
    "currency_code": "USD",
    "current_subtotal": "129.99",
    "current_discount": "0.00",
    "current_adjustment_total": "-29.99",
    "current_amount": "100.00"
  },
  "dry_run": true,
  "status": 200,
  "meta": {
    "request_id": "018f2c1a-8b3a-7e6d-9f10-2a3b4c5d6e7f",
    "timestamp": "2026-04-01T12:00:00Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "Invalid credentials."
}

{
  "message": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Accepts company tokens, partner tokens, public tokens, droplet installation tokens, and user_company tokens. The authenticated credential determines editor_type and editor_id on the resulting order-edit audit records — the payload never carries either field.

Path Parameters

order_id

integer

required

Primary-key id of the order to edit. Must belong to the authenticated company; an unknown id or an order owned by another company returns 404.

Body

application/json

operations

object[]

required

One or more edit operations to apply atomically. The whole transaction commits or rolls back together.

Minimum array length: 1

Show child attributes

expected_updated_at

string<date-time>

Optional optimistic-concurrency guard. When provided, the server compares against the order's current updated_at before applying any operations and returns HTTP 409 with the current value on mismatch. Pass the ISO-8601 string received in a prior order response verbatim. Callers that don't load the order first can omit this and bypass the check.

Response

Dry run succeeded. Returns the order with post-edit current_* totals. The response carries dry_run: true at the envelope level to make the no-persistence semantics explicit on the wire.

Dry-run response for POST /api/v202604/orders/{order_id}/edits/preview. Same shape as OrderResponse with an additional dry_run: true flag on the envelope so consumers can statically confirm the no-persistence semantics. The order object's current_* totals reflect the hypothetical post-operation state.

order

object

required

The would-be order state, with current_* totals reflecting the hypothetical post-operation result. Not persisted.

Show child attributes

dry_run

boolean

required

Always true on preview responses. Distinguishes the preview payload from a committed edit response wire-side.

status

integer

required

HTTP status code, repeated in the body (200 on a successful dry run).

meta

object

required

Response metadata (request_id and timestamp).

Show child attributes

Atomically apply one or more edits to an existing order

List callback definitions

Dry-run an edit and return the would-be order shape

curl --request POST \
  --url https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operations": [
    {
      "type": "insert_item",
      "variant_id": "abc123",
      "quantity": 1,
      "price": "29.99"
    },
    {
      "type": "add_adjustment",
      "amount": "-29.99",
      "label": "Free gift credit",
      "adjustment_type": "credit",
      "source_type": "droplet",
      "source_id": "free-gift-droplet"
    }
  ]
}
'

import requests

url = "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview"

payload = { "operations": [
        {
            "type": "insert_item",
            "variant_id": "abc123",
            "quantity": 1,
            "price": "29.99"
        },
        {
            "type": "add_adjustment",
            "amount": "-29.99",
            "label": "Free gift credit",
            "adjustment_type": "credit",
            "source_type": "droplet",
            "source_id": "free-gift-droplet"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    operations: [
      {type: 'insert_item', variant_id: 'abc123', quantity: 1, price: '29.99'},
      {
        type: 'add_adjustment',
        amount: '-29.99',
        label: 'Free gift credit',
        adjustment_type: 'credit',
        source_type: 'droplet',
        source_id: 'free-gift-droplet'
      }
    ]
  })
};

fetch('https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'operations' => [
        [
                'type' => 'insert_item',
                'variant_id' => 'abc123',
                'quantity' => 1,
                'price' => '29.99'
        ],
        [
                'type' => 'add_adjustment',
                'amount' => '-29.99',
                'label' => 'Free gift credit',
                'adjustment_type' => 'credit',
                'source_type' => 'droplet',
                'source_id' => 'free-gift-droplet'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview"

	payload := strings.NewReader("{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/v202604/orders/{order_id}/edits/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"operations\": [\n    {\n      \"type\": \"insert_item\",\n      \"variant_id\": \"abc123\",\n      \"quantity\": 1,\n      \"price\": \"29.99\"\n    },\n    {\n      \"type\": \"add_adjustment\",\n      \"amount\": \"-29.99\",\n      \"label\": \"Free gift credit\",\n      \"adjustment_type\": \"credit\",\n      \"source_type\": \"droplet\",\n      \"source_id\": \"free-gift-droplet\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "order": {
    "id": 90210,
    "order_number": "1001",
    "status": "complete",
    "currency_code": "USD",
    "current_subtotal": "129.99",
    "current_discount": "0.00",
    "current_adjustment_total": "-29.99",
    "current_amount": "100.00"
  },
  "dry_run": true,
  "status": 200,
  "meta": {
    "request_id": "018f2c1a-8b3a-7e6d-9f10-2a3b4c5d6e7f",
    "timestamp": "2026-04-01T12:00:00Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "message": "Invalid credentials."
}

{
  "message": "Not authorized."
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

{
  "error": {
    "message": "<string>",
    "details": {}
  },
  "status": 123,
  "meta": {
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Overview

Task guides

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Dry-run an edit and return the would-be order shape

Authorizations

Path Parameters

Body

Response