Get Catalog Price Point

GET 
/inventory/v1/catalog/price-point/:price_point_id

Get a specific Price Point.

Request

Path Parameters

price_point_id Price Point Idrequired

Header Parameters

if-none-match any

If you provide the ETag that matches the current ETag for this content, will return a 304 response - indicating that the content has not changed.

Responses

200

Successful Response

Response Headers

• ETag

  string

  Used to identify this version of the content. Provide with a get request to avoid downloading the same data multiple times.

application/json

Schema

Schema

custom_data

object

Custom data associated with the resource

property name* string

name

object

The name of the Price Point.

anyOf

MOD1

string

strict_flag Strict Flag (boolean)

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

cap_flag Cap Flag (boolean)

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

current_breakpoints

object[]

Current Price Breakpoints.

Array [

price_item_uuid

object

The Item used as the currency for the purchase.

anyOf

MOD1

string

price_item_id

object

deprecated

Deprecated. Use the currencies field instead.

anyOf

MOD1

integer

quantity Quantity (integer)required

price

object

deprecated

Deprecated. Use the currencies field instead.

anyOf

MOD1

integer

currencies

object

List of currencies for this break point

anyOf

MOD1

Array [

price_item_uuid uuidrequired

The Item used as the currency for the purchase.

price_item_id Price Item Id (integer)required

The Item used as the currency for the purchase.

price Price (integer)required

The price of the Item.

]

]

pre_sale_breakpoints

object[]

Previous Price Breakpoints.

Array [

price_item_uuid

object

The Item used as the currency for the purchase.

anyOf

MOD1

string

price_item_id

object

deprecated

Deprecated. Use the currencies field instead.

anyOf

MOD1

integer

quantity Quantity (integer)required

price

object

deprecated

Deprecated. Use the currencies field instead.

anyOf

MOD1

integer

currencies

object

List of currencies for this break point

anyOf

MOD1

Array [

price_item_uuid uuidrequired

The Item used as the currency for the purchase.

price_item_id Price Item Id (integer)required

The Item used as the currency for the purchase.

price Price (integer)required

The price of the Item.

]

]

cache_info

object

Cache info for the Price Point.

anyOf

CacheInfo

Cache information for the resource it is attached to. The etag value can be used with the If-None-Match and If-Match headers

etag Etag (string)required

Possible values: non-empty

Example (from schema)

{
  "custom_data": {},
  "name": "string",
  "strict_flag": false,
  "cap_flag": false,
  "current_breakpoints": [
    {
      "price_item_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 0,
      "currencies": [
        null
      ]
    }
  ],
  "pre_sale_breakpoints": [
    {
      "price_item_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "quantity": 0,
      "currencies": [
        null
      ]
    }
  ],
  "cache_info": {}
}

304

Content still has the same etag and has not changed

403

Forbidden

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...