Skip to content
Bottle

Get a checkout, for its thank-you page

GET
/storefront/sites/{host}/checkouts/{id}
curl --request GET \
  --url 'https://example.com/storefront/sites/northgate.shop.getbottle.app/checkouts/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f?t=example'

Deliberately unauthenticated, but only with the token from the address Stripe sent the shopper back to. Whether it is paid yet (poll until it is), the tracking reference once the order exists, the days, the lines and the total, and the shopper’s first name. Anything else, a wrong token included, is an empty 404. Never cached.

Parameters

Section titled “Parameters”

Path Parameters

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

UUID v7

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

UUID v7

Query Parameters

Section titled “Query Parameters”
t
required
string
<= 100 characters

Responses

Section titled “Responses”

200

Section titled “200”

The checkout

Media typeapplication/json
object
status
required
string
Allowed values: open paid expired failed
trackingRef
required
string | null
fulfilment
required
string
Allowed values: delivery collection
earliest
required
string | null format: date
latest
required
string | null format: date
lines
required
Array<object>
object
kind
required
string
Allowed values: product deposit delivery
productId
required

UUID v7

string | null format: uuid
name
required
string
quantity
required
integer
unitPence
required
integer
totalPence
required
integer
unitPenceExVat
integer
unitPenceIncVat
integer
forProductIds
Array<string>
parts
Array<object>
object
quantity
required
integer
unitPence
required
integer
unitPenceExVat
required
integer
totalPence
required
integer
grossPence
required
integer
firstName
required
string
payment
string
Allowed values: card account
Example
{
  "status": "open",
  "fulfilment": "delivery",
  "lines": [
    {
      "kind": "product",
      "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "forProductIds": [
        "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
      ]
    }
  ],
  "payment": "card"
}

404

Section titled “404”

Not a shop, or not open. No body.

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 requests from one address

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