Standalone Prices

Queries and mutations for managing Standalone Prices in the platform.

Queries

Query Standalone Prices

QUERYstandalonePrices

StandalonePrices are managed and queried through the StandalonePrices API and associated to a ProductVariant through the sku field.

Arguments
where​
String​
sort​
Array of String​
limit​
Int​
offset​
Int​

Get Standalone Price

QUERYstandalonePrice

StandalonePrices are managed and queried through the StandalonePrices API and associated to a ProductVariant through the sku field.

Arguments
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Mutations

Create Standalone Price

MUTATIONcreateStandalonePrice
Arguments
draft​

Update Standalone Price

MUTATIONupdateStandalonePrice
Arguments
version​
Long​
actions​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Delete Standalone Price

MUTATIONdeleteStandalonePrice
Arguments
version​
Long​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output types

StandalonePrice

StandalonePrices are managed and queried through the StandalonePrices API and associated to a ProductVariant through the sku field.

id​
String​

Unique identifier of the StandalonePrice.

version​
Long​

Current version of the StandalonePrice.

key​
String​

User-defined unique identifier of the StandalonePrice.

sku​
String​

SKU of the ProductVariant to which this Price is associated.

value​

Money value of this Price.

country​

Country for which this Price is valid.

customerGroupRef​

CustomerGroup Reference for which this Price is valid.

customerGroup​
CustomerGroup for which this Price is valid.
channelRef​

Product distribution Channel for which this Price is valid.

channel​
Product distribution Channel for which this Price is valid.
validFrom​

Date from which the Price is valid.

validUntil​

Date until the Price is valid.

tiers​
Array of ProductPriceTier​
Price tiers if any are defined. If discounted is present, the tiered Price is ignored for a Product Variant.
discounted​

Set if a matching ProductDiscount exists.

staged​

Staged changes of the StandalonePrice. Only present if the StandalonePrice has some changes staged.

custom​

Custom Fields for the StandalonePrice.

active​
Boolean​
If set to true, the StandalonePrice is considered during Product price selection. If set to false, the StandalonePrice is not considered during Product price selection and any associated Line Items in a Cart cannot be ordered.
recurrencePolicyRef​
RecurrencePolicy for which this Price is valid.
recurrencePolicy​
RecurrencePolicy for which this Price is valid.
createdAt​

Date and time (UTC) the StandalonePrice was initially created.

lastModifiedAt​

Date and time (UTC) the StandalonePrice was last updated.

createdBy​

IDs and references that created the StandalonePrice.

lastModifiedBy​

IDs and references that last modified the StandalonePrice.

ProductPriceTier

minimumQuantity​
Int​
value​

DiscountedProductPriceValue

value​
discountRef​
discount​

StagedStandalonePrice

Staged changes on a Standalone Price. To update the value property of a Staged Standalone Price, use the Change Value update action. To apply all staged changes to the Standalone Price, use the Apply Staged Changes update action.
value​

Money value of the StagedStandalonePrice.

discounted​

Discounted price for the StagedStandalonePrice.

Standalone Price Query Result

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of StandalonePrice​

Input types

CreateStandalonePrice

This type is equivalent to StandalonePriceDraft in REST.
key​
String​
sku​
String​
value​
staged​
country​
customerGroup​
validFrom​
validUntil​
tiers​
Default: []​
custom​
discounted​
active​
Boolean​
Default: true​
recurrencePolicy​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

StagedPriceDraft

value​

Money value for the StagedPriceDraft.

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

StandalonePriceUpdateAction

applyStagedChanges​
changeActive​
changeValue​
setKey​
setDiscountedPrice​
setCustomField​
setCustomType​
setValidFromAndUntil​
setValidFrom​
setValidUntil​
addPriceTier​
removePriceTier​
removeStagedChanges​
setPriceTiers​

Update actions

Apply Staged Changes

dummy​
String​

Change Active

Updating the value of a StandalonePrice produces the StandalonePriceActiveChanged Message.
active​
Boolean​
New value to set for the active field of the StandalonePrice.

Change Value

Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
value​

New value to set. Must not be empty.

To set the money value in high precision, use HighPrecisionMoneyDraft.
staged​
Boolean​
default is false

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

Set Key

Sets the key on a Standalone Price. Produces the StandalonePriceKeySet Message.
key​
String​

Value to set. If omitted, any existing value is removed.

If the value is used by another Standalone Price, a DuplicateField error is returned.

Set Discounted Price

Discounts a Standalone Price of a Product Variant on a published Product. If the Product Variant does not exist or if it exists only in the staged representation of a Product, an InvalidOperationError error is returned.
discounted​

Value to set. If omitted, any existing value is removed.

The referenced ProductDiscount must be of type external, active, and its predicate must match the referenced Price.

DiscountedProductPriceValueInput

value​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

Set Custom Field

name​
String​
value​
String​

Set Custom Type

typeId​
String​
typeKey​
String​
fields​
Array of CustomFieldInput​

Set Valid From And Until

Updating the validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.
As the validity dates are part of the price scope and are not allowed to overlap, this update might return the DuplicateStandalonePriceScope and OverlappingStandalonePriceValidity errors, respectively. A Price without validity period does not conflict with a Price defined for a time period.
If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict error is returned.
If a modification is already in progress for the combination of SKU and price scope fields (but potentially different validity period), a ValidityLockConflict error is returned.
validFrom​

Value to set. If omitted, any existing value is removed.

validUntil​

Value to set. If omitted, any existing value is removed.

Set Valid From

Updating the validFrom value generates the StandalonePriceValidFromSet Message.
As the validity dates are part of the price scope and are not allowed to overlap, this update might return the DuplicateStandalonePriceScope and OverlappingStandalonePriceValidity errors, respectively. A Price without validity period does not conflict with a Price defined for a time period.
If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict error is returned.
If a modification is already in progress for the combination of SKU and price scope fields (but potentially different validity period), a ValidityLockConflict error is returned.
validFrom​

Value to set. If omitted, any existing value is removed.

Set Valid Until

Updating the validUntil value generates the StandalonePriceValidUntilSet Message.
As the validity dates are part of the price scope and are not allowed to overlap, this update might return the DuplicateStandalonePriceScope and OverlappingStandalonePriceValidity errors, respectively. A Price without validity period does not conflict with a Price defined for a time period.
If a modification is already in progress for the exact combination of SKU and price scope fields, an ExactLockConflict error is returned.
If a modification is already in progress for the combination of SKU and price scope fields (but potentially different validity period), a ValidityLockConflict error is returned.
validUntil​

Value to set. If omitted, any existing value is removed.

Add Price Tier

tier​

ProductPriceTierInput

minimumQuantity​
Int​
value​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

Remove Price Tier

minimumQuantity​
Int​

Remove Staged Changes

dummy​
String​

Set Price Tiers

tiers​

ProductPriceTierInput

minimumQuantity​
Int​
value​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​