Change several orders

POST

/orders/bulk

curl --request POST \
  --url https://example.com/orders/bulk \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "orderIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "change": { "action": "reschedule", "wantedOn": "2026-04-15" } }'

One change made to every order named, up to 500: moved to another day, put on or taken off a round, marked paid, sent a payment link, cancelled, marked delivered, or confirmed from draft. Each is done by the same rules as doing it to that order alone, with the same emails, invoices and stock. One the change does not fit is left as it was and listed as skipped, with why; the rest still go. Rounds need rounds:write and a plan with rounds. Confirming drafts is for an owner or admin signed in.

Authorizations

• sessionCookie
  orders:write
• apiKey
  orders:write

Request Body^required

Media typeapplication/json

object

orderIds

required

Array<string>

>= 1 items <= 500 items

change

required

One of:

object

object

action

required

Move each to another day. Only placed and draft orders move; one already on a round comes off it first.

string

Allowed values: reschedule

wantedOn

required

string format: date

object

object

action

required

Put each on a round, move it to another, or take it off with null. Collections and orders that are not open are skipped. Needs rounds:write.

string

Allowed values: round

roundId

required

UUID v7

string | null format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

object

object

action

required

Mark each paid: cash for money in hand, transfer for a bank transfer. Orders already paid, cancelled, on account or billed by a shop are skipped.

string

Allowed values: paid

via

string

Allowed values: cash transfer

object

object

action

required

Email each customer a link to pay. Orders with no email address, already paid, cancelled or billed by a shop are skipped.

string

Allowed values: paymentLink

object

object

action

required

Cancel each. Stock a shop sale took is put back and any unpaid invoice is voided. Delivered orders are skipped.

string

Allowed values: cancel

object

object

action

required

Mark each delivered or collected, with the empties each order expected back. Only placed orders are marked. deliveryMethod applies to every delivery, and delivery_partner takes each off any round it is waiting on, skipping any it may not take off. Left out, an order a delivery partner has is recorded as delivery_partner, and own_driver takes it off the partner; a collection is marked collected without one.

string

Allowed values: delivered

deliveryMethod

Own_driver: the business’s own driver delivered it. delivery_partner: another company delivered it for the business.

string

Allowed values: own_driver delivery_partner

object

object

partnerId

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

deliveryDate

required

The day it is delivered, today or later.

string format: date

action

required

Give each to a delivery partner for a day, taking it off any round still being planned or not yet out. Needs rounds:write. Only placed deliveries; collections and orders on a round that is out or finished are left alone.

string

Allowed values: deliveryPartner

object

object

action

required

Take each off its delivery partner, so it is waiting for a round again. Needs rounds:write. Orders already delivered are left alone.

string

Allowed values: undoDeliveryPartner

object

object

action

required

Confirm each reviewed draft so it is placed. Owners and admins only, signed in.

string

Allowed values: confirm

Responses

200

What was changed and what was skipped

Media typeapplication/json

object

done

required

Array<object>

object

orderId

required

UUID v7

string format: uuid

number

required

string

skipped

required

Array<object>

object

orderId

required

UUID v7

string format: uuid

number

required

string | null

reason

required

string

Allowed values: not_found draft not_draft not_open cancelled unchanged already_paid on_account shop_billed paid_elsewhere has_receipts no_email nothing_owed payments_not_ready collection on_round in_progress round_out being_planned no_round_access on_delivery_partner not_on_delivery_partner changed refused account_blocked

Example

{
  "done": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ],
  "skipped": [
    {
      "orderId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "reason": "not_found"
    }
  ]
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member, or without the permission this needs

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

404

The round is not one of this business’s

Media typeapplication/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed, or a line names something not sold

Media typeapplication/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}