Skip to content
Bottle

Ask for a trade account

POST
/storefront/sites/{host}/account/trade-application
curl --request POST \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/trade-application \
  --header 'Content-Type: application/json' \
  --data '{ "businessName": "example", "phone": "example", "companyNumber": "example", "vatNumber": "example", "contacts": [ { "name": "example", "role": "buyer", "email": "hello@example.com", "phone": "example" } ], "address": { "line1": "example", "line2": "example", "city": "example", "postcode": "example" }, "notes": "example" }'

Deliberately without a staff session: a shopper on the business’s own shop. Signed in. The business’s owners and admins are emailed and told in the office. One request waiting at a time. Until it is approved the account pays the shop’s ordinary prices.

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
businessName
required
string
>= 1 characters <= 160 characters
phone
required
string
<= 30 characters
companyNumber
string
<= 20 characters
vatNumber
string
<= 20 characters
contacts
Array<object>
<= 10 items
object
name
required
string
>= 1 characters <= 120 characters
role
string
default: buyer
Allowed values: buyer accounts
email
required
string format: email
<= 200 characters
phone
string
<= 30 characters
address
object
line1
string
<= 120 characters
line2
string
<= 120 characters
city
string
<= 80 characters
postcode
string
<= 10 characters
notes
string
<= 2000 characters

Responses

Section titled “Responses”

201

Section titled “201”

Sent

Media typeapplication/json
object
status
required
string
Allowed values: none pending approved declined
reason
required
string | null
submittedAt
required
string | null format: date-time
Example
{
  "status": "none"
}

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”

One is already waiting, or the shop is 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"
}