Skip to content
Bottle

List the account’s orders

GET
/storefront/sites/{host}/account/orders
curl --request GET \
  --url 'https://example.com/storefront/sites/northgate.shop.getbottle.app/account/orders?limit=20&customerId=019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f&offset=0'

Deliberately without a staff session: a shopper on the business’s own shop. Every order of every customer the account buys for, the office’s as well as the shop’s, newest first.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
host
required
string
Example
northgate.shop.getbottle.app

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 20 >= 1 <= 100
customerId

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

offset
integer | null
0

Responses

Section titled “Responses”

200

Section titled “200”

Orders

Media typeapplication/json
object
items
required
Array<object>
object
id
required

UUID v7

string format: uuid
reference
required
string
trackingRef
required
string
placedAt
required
string format: date-time
status
required
string
Allowed values: placed delivered cancelled
fulfilment
required
string
Allowed values: delivery collection
grossPence
required
integer
paid
required
boolean
summary
required
string
invoiceId
required

UUID v7

string | null format: uuid
customerId
required

UUID v7

string format: uuid
customerName
required
string
total
required
integer
Example
{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "status": "placed",
      "fulfilment": "delivery",
      "invoiceId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
    }
  ]
}

400

Section titled “400”

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not a shop. No body.

409

Section titled “409”

A real shop not selling now (shop_closed)

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

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

429

Section titled “429”

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}