Get Price Points

GET

/v1/sandbox/{sandbox_id}/price-point

Get Price Points by filters. All filters must be true for a Price Point to be returned. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

• RallyHereHTTPBearer

Parameters

Path Parameters

sandbox_id

required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

price_point_ids

Price Point IDs to filter by

Array<string>

Price Point IDs to filter by

strict_flag

Filter by Price Points with matching strict flag

boolean

Filter by Price Points with matching strict flag

cap_flag

Filter by Price Points with matching cap flag

boolean

Filter by Price Points with matching cap flag

name

Filter by case insensitive name

string

>= 1 characters <= 50 characters

Filter by case insensitive name

expand

Resources to expand and fill in additional detail

Array<string>

Allowed values: * legacy_id

Resources to expand and fill in additional detail

last_modified_account_ids

Filter by last modified account ID

Array<string>

Filter by last modified account ID

sort_by

Sort results by

string

Allowed values: price_point_id strict_flag cap_flag name last_modified_timestamp last_modified_account_id

Sort results by

sort_order

Sort order

string

Allowed values: asc desc

Sort order

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

Responses

200

Successful Response

A collection of Price points.

object

data

The Price Points.

Array<object>

default:

A collection of Price Breakpoints (volume pricing).

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

name

Name of the resource

string

>= 1 characters <= 125 characters

description

Description of the resource

string

>= 1 characters <= 250 characters

strict_flag

Forces the quantity to be equal to a quantity on a Price Breakpoint.

boolean

cap_flag

Only allows quantity to be fulfilled up the highest quantity on the Price Breakpoints

boolean

current_breakpoints

Current Price Breakpoints.

Array<object>

default:

Price based on quantity and the Item ID of the currency used.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

price_break_point_id

ID of the price break point

string format: uuid

price_item_id

Deprecated. Use the currencies field instead.

string format: uuid

price

Deprecated. Use the currencies field instead.

integer

> 0

quantity

required

Quantity for the price break point.

integer

> 0

currencies

List of currencies for this break point

Array<object>

default:

The currencies of a Price Breakpoint.

object

price_break_point_currency_id

ID of the price break point currency

string format: uuid

price_item_id

required

Item ID of the currency used to price.

string format: uuid

price

required

Price for the quantity.

integer

> 0

price_item_name

Name corresponding Item ID

string

pre_sale_breakpoints

Previous Price Breakpoints.

Array<object>

default:

Price based on quantity and the Item ID of the currency used.

object

custom_data

Custom data associated with the resource

object

key

additional properties

string

price_break_point_id

ID of the price break point

string format: uuid

price_item_id

Deprecated. Use the currencies field instead.

string format: uuid

price

Deprecated. Use the currencies field instead.

integer

> 0

quantity

required

Quantity for the price break point.

integer

> 0

currencies

List of currencies for this break point

Array<object>

default:

The currencies of a Price Breakpoint.

object

price_break_point_currency_id

ID of the price break point currency

string format: uuid

price_item_id

required

Item ID of the currency used to price.

string format: uuid

price

required

Price for the quantity.

integer

> 0

price_item_name

Name corresponding Item ID

string

sandbox_id

ID of the Sandbox

string format: uuid

last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid

last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time

created_timestamp

Timestamp of when the resource was created

string format: date-time

price_point_id

The Price Point ID.

string format: uuid

page_meta

required

The paging metadata.

object

cursor

required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string

>= 1 characters <= 128 characters

page_size

The maximum number of elements to be returned per call

integer

default: 50 >= 1 <= 10000

total

The total number of entities.

integer

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string