Create an order

POST

/orders

curl --request POST \
  --url https://example.com/orders \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "deliveryAddressId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "deliverToName": "example", "deliverToAddress": "example", "deliveryOptionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "paymentMethod": "on_account", "fulfilment": "delivery", "wantedOn": "2026-04-15", "notes": "example", "lines": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "quantity": 1, "unitPrice": 1 } ], "collect": [ { "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "quantity": 1 } ] }'

Against a saved customer, or a one-off with a name and address. Each line may name its own price; otherwise the rate agreed with that customer applies, and the list price where none has been.

Authorizations

• sessionCookie
  orders:write
• apiKey
  orders:write

Request Body^required

Media typeapplication/json

object

customerId

UUID v7

string format: uuid

Example

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

deliveryAddressId

UUID v7

string format: uuid

Example

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

deliverToName

string | null

<= 200 characters

deliverToAddress

string | null

<= 2000 characters

deliveryOptionId

UUID v7

string format: uuid

Example

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

paymentMethod

On_account: billed later, nothing to collect. link: a payment link raised in the accounting system. cash: the driver takes it at the door.

string

Allowed values: on_account link cash

fulfilment

Delivery: goes on a round. collection: the customer picks it up from the yard; never planned onto a van, and comes off stock when marked collected.

string

Allowed values: delivery collection

wantedOn

string | null format: date

notes

string | null

<= 2000 characters

lines

required

Array<object>

<= 200 items

object

productId

required

UUID v7

string format: uuid

Example

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

quantity

required

integer

> 0 <= 1000

unitPrice

integer

collect

Array<object>

<= 200 items

object

productId

required

UUID v7

string format: uuid

Example

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

quantity

required

integer

> 0 <= 1000

Responses

201

Taken

Media typeapplication/json

object

id

required

UUID v7

string format: uuid

customerId

required

UUID v7

string | null format: uuid

customerName

required

string | null

deliveryAddressId

required

UUID v7

string | null format: uuid

deliverToName

required

string | null

deliverToAddress

required

string | null

location

required

object

latitude

required

number

>= -90 <= 90

longitude

required

number

>= -180 <= 180

roundId

required

UUID v7

string | null format: uuid

status

required

string

Allowed values: placed delivered cancelled

fulfilment

required

Delivery: goes on a round. collection: the customer picks it up from the yard; never planned onto a van, and comes off stock when marked collected.

string

Allowed values: delivery collection

source

required

string

externalRef

required

string | null

trackingRef

required

string

leaveInstruction

required

string | null

Allowed values: none neighbour safe_place

leaveDetail

required

string | null

deliveryOptionId

required

UUID v7

string | null format: uuid

deliveryOptionName

required

string | null

expectedFrom

required

string | null format: date

expectedTo

required

string | null format: date

deliveryChargePence

required

integer

paymentMethod

required

On_account: billed later, nothing to collect. link: a payment link raised in the accounting system. cash: the driver takes it at the door.

string

Allowed values: on_account link cash

wantedOn

required

string | null format: date

notes

required

string | null

lines

required

Array<object>

object

id

required

UUID v7

string format: uuid

productId

required

UUID v7

string format: uuid

productName

required

string

quantity

required

integer

> 0

unitPrice

required

Pence, excluding VAT.

integer

total

required

integer

deliveredQuantity

required

integer

cancelledQuantity

required

integer

collect

required

Array<object>

object

productId

required

UUID v7

string format: uuid

productName

required

string

quantity

required

integer

> 0

total

required

integer

refundDue

required

integer

refundSettledAt

required

string | null format: date-time

paidAt

required

string | null format: date-time

paidVia

required

string | null

Allowed values: stripe office shop cash

paymentLink

required

string | null format: uri

invoice

required

object

id

required

UUID v7

string format: uuid

number

required

string

status

required

string

Allowed values: sent paid void

canEmailPaymentLink

required

boolean

paymentRequestedAt

required

string | null format: date-time

deliveredAt

required

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "deliveryAddressId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "status": "placed",
  "fulfilment": "delivery",
  "source": "office",
  "trackingRef": "7K3M9QWXZ2",
  "leaveInstruction": "none",
  "deliveryOptionId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "paymentMethod": "on_account",
  "lines": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productName": "19kg propane"
    }
  ],
  "collect": [
    {
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "productName": "19kg propane"
    }
  ],
  "paidVia": "stripe",
  "invoice": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
    "number": "INV-BTL00042",
    "status": "sent"
  }
}

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

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