> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arcade.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Dropshipping

> Ship an order to your customer under your brand, or order a single unit.

Dropshipping sends an order straight to your customer, with your brand on the receipt. It also lets you order a single unit.

A checkout where any line has `quantity: 1` needs dropshipping. Without it, `checkouts/create` returns `412 PRECONDITION_FAILED`.

Dropshipping costs credits. The cost is charged for each line with `quantity: 1`, or once for an order that has none. It is free when your paid plan includes dropshipping.

Such a plan also lets you order a single unit without `dropShip`. Still send `"dropShip": true` if you want your brand on the receipt.

## Create a dropshipping checkout

**1. Get a quote**

Call `checkouts/quoteDropshipping` to see the current cost.

```bash cURL theme={null}
curl --fail-with-body https://platform.arcade.ai/v1/checkouts/quoteDropshipping \
  -H "Authorization: Bearer $ARCADE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "User-Agent: your-app/1.0 (you@example.com)" \
  -d '{}'
```

```json theme={null}
{
  "creditCost": 25,
  "standardCreditCost": 25,
  "revision": "3",
  "waiverReason": null,
  "includesDropshipping": false,
  "planId": null
}
```

| Field | Meaning |
| - | - |
| `creditCost` | What one dropshipped item costs you in credits. `0` when it is waived. |
| `standardCreditCost` | The cost without a waiver. |
| `revision` | The version of the pricing this quote uses. |
| `waiverReason` | Why the cost is waived: `plan`, `introductory`, or `null` when it isn't. |
| `includesDropshipping` | Whether your paid plan includes dropshipping. |
| `planId` | Your paid plan, or `null`. |

The checkout is charged `creditCost` for each line with `quantity: 1`, or once if it has none.

**2. Create the checkout**

Call `checkouts/create` with `"dropShip": true` and the quote you accepted:

* `expectedDropshippingCreditCost`: the quote's `creditCost`.
* `expectedDropshippingPolicyRevision`: the quote's `revision`, as a number.

```bash cURL theme={null}
curl --fail-with-body https://platform.arcade.ai/v1/checkouts/create \
  -H "Authorization: Bearer $ARCADE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "User-Agent: your-app/1.0 (you@example.com)" \
  -d '{
    "requestId": "gold-ring-checkout-1",
    "lines": [{ "productId": "4d9a7c12-8e3b-4f60-b5a1-7c2e9d0f3b84", "quantity": 1 }],
    "dropShip": true,
    "expectedDropshippingCreditCost": 25,
    "expectedDropshippingPolicyRevision": 3
  }'
```

The request returns `412 PRECONDITION_FAILED` in two cases:

* The cost or the pricing revision changed since your quote. Get a new quote and try again.
* The account doesn't have enough credits. Add credits or choose a plan in Arcade Studio, then try again.

## Your brand on the receipt

Every order ships with a printed receipt. A dropshipped order carries your brand instead of Arcade's, once your brand is set up.

Set up your brand in Arcade Studio, under **Settings → Branded Receipts**, before your first dropshipped order. The API has no endpoint for this.

| Your brand settings | Receipt on a dropshipped order |
| - | - |
| Complete | Your branded receipt |
| Unfinished, with a brand name | A plain receipt with your brand name and no logo |
| Not set up, or unfinished with no name | Arcade's invoice |

An order with `dropShip: false` always ships with Arcade's invoice.

## When credits are charged

1. Creating the checkout checks that your balance covers the credits. Nothing is reserved.
2. Paying the checkout charges them, even if your balance has dropped since and the charge leaves it negative.

When the cost is waived, nothing is charged.

If the whole order is cancelled or fully refunded later, the credits are refunded. A partial refund of the order doesn't refund them.

## Cancel an unpaid checkout

To cancel an unpaid checkout, call `checkouts/cancel` with the `checkoutId`.

| `state` | Meaning |
| - | - |
| `canceled` | The checkout is cancelled. |
| `completed` | The checkout was already paid, so it was not cancelled. |

Cancelling doesn't guarantee the checkout page stops working. If someone still pays a cancelled checkout, the credits are charged at the cost you agreed to, even if that leaves a negative credit balance.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.