List a customer's agreed rates

GET

/customers/{customerId}/prices

const url = 'https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-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/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/prices \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every product, with the rate agreed for this customer and the list price beside it. agreed says whether the customer has an explicit rate; when false, unitPrice is the consumer list price for display only.

Authorizations

sessionCookie
products:read
apiKey
products:read

Parameters

Path Parameters

customerId

required

UUID v7

string format: uuid

Example

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

UUID v7

Responses

200

Prices

application/json

object

items

required

Array<object>

object

productId

required

UUID v7

string format: uuid

productName

required

string

agreed

required

boolean

unitPrice

required

integer

<= 100000000

priceIncludesVat

required

boolean

listPrice

required

integer

listPriceIncludesVat

required

boolean

vatRate

required

integer

<= 10000

updatedAt

required

string format: date-time

Example

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

Not found

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