Storefront API reference

Customer

Storefront Customer API endpoints

Endpoints

GET/customers/me
GET/customers/referral
PATCH/customers

Get the current customer

GET /customers/me

An API call to get the customer.

ReturnsCustomer

Customer object response

Error responses

404object

The customer does not exists for the given user. Please create a customer first.

curl https://api.subbly.co/storefront/v1/customers/me \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

{
  "id": 8435732,
  "first_name": "John",
  "last_name": "Smith",
  "email": "test@test.com",
  "marketing_consent": false,
  "tos_consent_at": "2022-04-01 00:00:00",
  "active_subscriptions_count": 0,
  "external_id": "external_id",
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00"
}

Get the current customer referral info

GET /customers/referral

An API call to get the customer referral info.

ReturnsCustomerReferral

Customer referral object response

referral_linkstring

Error responses

404object

The customer does not exists for the given user. Please create a customer first.

curl https://api.subbly.co/storefront/v1/customers/referral \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>'

Response

{
  "referral_link": "https://www.subbly.com/?r=123456&s=1"
}

Update customer

PATCH /customers

An api call to update customer.

Request body

Store customer

marketing_consentoptionalboolean

tos_consentoptionalboolean

external_idoptionalstring | null

ReturnsCustomer

Customer object response

curl -X PATCH https://api.subbly.co/storefront/v1/customers \
  -H 'X-API-KEY: <api-key>' \
  -H 'Authorization: Bearer <access-token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "marketing_consent": true,
  "tos_consent": true,
  "external_id": "external_id"
}'

Response

{
  "id": 8435732,
  "first_name": "John",
  "last_name": "Smith",
  "email": "test@test.com",
  "marketing_consent": false,
  "tos_consent_at": "2022-04-01 00:00:00",
  "active_subscriptions_count": 0,
  "external_id": "external_id",
  "metadata": [
    {
      "id": 1,
      "name": "Color",
      "slug": "color-red",
      "description": "description",
      "unit": "kg",
      "data_type": "single_line_string",
      "preset": true,
      "multiple": true,
      "variant": true,
      "save_behavior": "customer",
      "editable": true,
      "values": [
        {}
      ]
    }
  ],
  "created_at": "2022-04-01 00:00:00"
}