List price lists

GET

/rate-sets

const url = 'https://example.com/rate-sets';
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/rate-sets \
  --cookie bottle.session_token=<bottle.session_token>

Price lists (called rate sets in the API), by name, with how many customers are on each and how many products it prices. Archived ones only when asked for.

Authorizations

sessionCookie
products:read
apiKey
products:read

Parameters

Query Parameters

includeArchived

Include archived sets.

string

Include archived sets.

Responses

200

The sets

application/json

object

items

required

Array<object>

object

required

UUID v7

string format: uuid

name

required

string

colour

required

string | null

notes

required

string | null

memberCount

required

integer

priceCount

required

integer

archivedAt

required

string | null format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "items": [
    {
      "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"
}

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"
    }
  ]
}