Get a price rule

GET

/price-rules/{id}

const url = 'https://example.com/price-rules/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

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/price-rules/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --cookie bottle.session_token=<bottle.session_token>

Authorizations

sessionCookie
products:read
apiKey
products:read

Parameters

Path Parameters

required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

200

The rule

application/json

object

name

required

string | null

<= 120 characters

audience

required

Consumer: everybody who is not a trade customer, signed in or not. trade: trade customers. rate_set: the members of one rate set, named by rateSetId. customer: one customer, named by customerId.

string

Allowed values: consumer trade rate_set customer

customerId

required

UUID v7

string | null format: uuid

rateSetId

required

UUID v7

string | null format: uuid

scope

required

What the rule covers: one product (productId), every size of a gas type (gasTypeId), a shop category (categoryId), or everything sold. Never deposits, rent or delivery.

string

Allowed values: product gas_type category all

productId

required

UUID v7

string | null format: uuid

gasTypeId

required

UUID v7

string | null format: uuid

categoryId

required

UUID v7

string | null format: uuid

counting

required

Stepped: each step prices only the units within it (“first 5 at £38, next 5 at £36, then £34.20”). bulk: the highest step reached prices every unit (“10 or more and all of them are £34.20”).

string

Allowed values: stepped bulk

steps

required

Array

>= 1 items <= 10 items

One of:

object

kind

required

string

Allowed values: percent_off

fromQuantity

required

integer

>= 1 <= 100000

percent

required

number

<= 100

active

required

boolean

required

UUID v7

string format: uuid

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "audience": "consumer",
  "customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "rateSetId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "scope": "product",
  "productId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "gasTypeId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "categoryId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "counting": "stepped",
  "steps": [
    {
      "kind": "percent_off"
    }
  ],
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

Not a member, or without the permission this needs

application/json

object

error

required

string

message

required

string

Example

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

404

No such price rule

application/json

object

error

required

string

message

required

string

Example

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