Create or update a price schedule price break

Request

Security

OAuth2(Required scopes: FullAccessPriceScheduleAdmin)

Path

priceScheduleIDstringrequired

ID of the price schedule.

Bodyapplication/jsonrequired

Quantityinteger, (int32), >= 0required

Most commonly 1, except when offering tiered/bulk pricing.

Example:0

Pricenumber, (float)required

Price per unit.

Example:0

SalePricenumber, (float)

Sale Price per unit. If the current date/time is within the PriceSchedule SaleStart and SaleEnd, this SalePrice will be used.

Example:0

SubscriptionPricenumber, (float)

Subscription Price per unit. If set, this price is used when a subscription order is created.

Example:0

BundlePricenumber, (float)

Bundle Price per unit. If set, this price is used when an item being added to an order is part of a bundle.

Example:0

curl -i -X POST \
  'https://api.ordercloud.io/v1/priceschedules/{priceScheduleID}/PriceBreaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Quantity": 0,
    "Price": 0,
    "SalePrice": 0,
    "SubscriptionPrice": 0,
    "BundlePrice": 0
  }'

Responses

Bodyapplication/json

PriceBreaksArray of objects(PriceBreak)

Example:

[
  {
    "Quantity": 0,
    "Price": 0,
    "SalePrice": 0,
    "SubscriptionPrice": 0,
    "BundlePrice": 0
  }
]

OwnerIDstring

ID of the organization that owns the PriceSchedule. Only the marketplace owner can override the OwnerID on create.

Example:""

IDstring, <= 100 characters

Example:""

Namestring, <= 100 characters

Example:""

ApplyTaxboolean

For reference only for calculating tax, does not influence any OrderCloud behavior.

Example:false

ApplyShippingboolean

For reference only for calculating shipping cost, does not influence any OrderCloud behavior.

Example:false

MinQuantityinteger, (int32), >= 1

The minimum line item Quantity when UseCumulativeQuantity is false.

Default:1

Example:0

MaxQuantityinteger, (int32)

The maximum line item Quantity when UseCumulativeQuantity is false.

Example:0

UseCumulativeQuantityboolean

If true, line item quantities will be aggregated by productID when determining which price break applies, and when Min/Max quantities are met. Else, each line item is treated separately.

Example:false

RestrictedQuantityboolean

If true, this product can only be ordered in quantities that exactly match one of the price breaks on this schedule.

Example:false

Currencystring, <= 100 characters

We recommend using ISO-4217 currency codes for compatibility with tax and payment processors.

Example:""

SaleStartstring, (date-time)

Starting date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.

Default:null

Example:"2018-01-01T00:00:00-06:00"

SaleEndstring, (date-time)

Ending date/time for PriceBreak.SalePrice to be used as the price for the LineItem. Requires that the PriceBreak.SalePrice value is set.

Default:null

Example:"2018-01-01T00:00:00-06:00"

IsOnSalebooleanread-only

True when at least one PriceBreak has a SalePrice defined, and the current time is between the SaleStart and SaleEnd date.

Example:false

xpobject

Example:

{}

Response

{
  "PriceBreaks": [
    { … }
  ],
  "OwnerID": "",
  "ID": "",
  "Name": "",
  "ApplyTax": false,
  "ApplyShipping": false,
  "MinQuantity": 0,
  "MaxQuantity": 0,
  "UseCumulativeQuantity": false,
  "RestrictedQuantity": false,
  "Currency": "",
  "SaleStart": "2018-01-01T00:00:00-06:00",
  "SaleEnd": "2018-01-01T00:00:00-06:00",
  "IsOnSale": false,
  "xp": {}
}