Marketing preferences

GET

/storefront/sites/{host}/account/marketing

const url = 'https://example.com/storefront/sites/northgate.shop.getbottle.app/account/marketing';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/storefront/sites/northgate.shop.getbottle.app/account/marketing

Deliberately without a staff session: a shopper on the business’s own shop. For each customer this account speaks for (a household, or a trade customer it manages), whether the business may send offers and news by email, text message, phone call and post. The same record the office sees and changes. 401 when signed out.

Parameters

Path Parameters

host

required

string

Example

northgate.shop.getbottle.app

Responses

200

The preferences

application/json

object

customers

required

Array<object>

object

customerId

required

UUID v7

string format: uuid

name

required

string

channels

required

Array<object>

object

channel

required

string

Allowed values: email sms phone post

granted

required

boolean

Example

{
  "customers": [
    {
      "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "channels": [
        {
          "channel": "email"
        }
      ]
    }
  ]
}

400

Refused: the message says why

application/json

object

error

required

string

message

required

string

Example

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

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

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

application/json

object

error

required

string

message

required

string

Example

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

404

Not a shop. No body.

409

A real shop not selling now (shop_closed)

application/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

application/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

Too many tries

application/json

object

error

required

string

message

required

string

Example

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