Queries and mutations for managing Standalone Prices in the platform.
Queries
Query Standalone Prices
StandalonePrices are managed and queried through the StandalonePrices API and associated to a ProductVariant through the sku field.
| Arguments | |
|---|---|
whereString | |
sortArray of String | |
limitInt | |
offsetInt | |
Get Standalone Price
StandalonePrices are managed and queried through the StandalonePrices API and associated to a ProductVariant through the sku field.
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Standalone Price
Update Standalone Price
| Arguments | |
|---|---|
versionLong | |
actionsArray of StandalonePriceUpdateAction | |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Standalone Price
| Arguments | |
|---|---|
versionLong | |
idString | Queries with specified ID |
keyString | 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.
idString | Unique identifier of the StandalonePrice. |
versionLong | Current version of the StandalonePrice. |
keyString | User-defined unique identifier of the StandalonePrice. |
skuString | 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. |
tiersArray 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. |
activeBoolean | 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
minimumQuantityInt | |
value |
DiscountedProductPriceValue
value | |
discountRef | |
discount |
StagedStandalonePrice
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
offsetInt | |
countInt | |
totalLong | |
existsBoolean | |
resultsArray of StandalonePrice |
Input types
CreateStandalonePrice
keyString | |
skuString | |
value | |
staged | |
country | |
customerGroup | |
channel | |
validFrom | |
validUntil | |
tiersArray of ProductPriceTierInput | Default: [] |
custom | |
discounted | |
activeBoolean | Default: true |
recurrencePolicy |
BaseMoneyInput
centPrecision | |
highPrecision |
StagedPriceDraft
value | Money value for the StagedPriceDraft. |
ProductPriceTierInput
minimumQuantityInt | |
value |
DiscountedProductPriceValueInput
value | |
discount |
StandalonePriceUpdateAction
applyStagedChanges | |
changeActive | |
changeValue | |
setKey | |
setDiscountedPrice | |
setCustomField | |
setCustomType | |
setValidFromAndUntil | |
setValidFrom | |
setValidUntil | |
addPriceTier | |
removePriceTier | |
removeStagedChanges | |
setPriceTiers |
Update actions
Apply Staged Changes
dummyString |
Change Active
activeBoolean | New value to set for the active field of the StandalonePrice. |
Change Value
value | New value to set. Must not be empty. To set the money value in high precision, use HighPrecisionMoneyDraft. |
stagedBoolean | default is false |
BaseMoneyInput
centPrecision | |
highPrecision |
Set Key
keyString | 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
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 | |
discount |
BaseMoneyInput
centPrecision | |
highPrecision |
Set Custom Field
nameString | |
valueString |
Set Custom Type
typeIdString | |
typeKeyString | |
type | |
fieldsArray of CustomFieldInput |
Set Valid From And Until
validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.Set Valid From
validFrom value generates the StandalonePriceValidFromSet Message.validFrom | Value to set. If omitted, any existing value is removed. |
Set Valid Until
validUntil value generates the StandalonePriceValidUntilSet Message.validUntil | Value to set. If omitted, any existing value is removed. |
Add Price Tier
tier |
ProductPriceTierInput
minimumQuantityInt | |
value |
BaseMoneyInput
centPrecision | |
highPrecision |
Remove Price Tier
minimumQuantityInt |
Remove Staged Changes
dummyString |
Set Price Tiers
tiersArray of ProductPriceTierInput |
ProductPriceTierInput
minimumQuantityInt | |
value |
BaseMoneyInput
centPrecision | |
highPrecision |