Importing Embedded Prices
This endpoint can be used to import Price data to create and update Embedded Prices in a Project.
Embedded Prices are used to include price information within ProductVariants and LineItems. They are different to Standalone Prices. You should check what type of price you are importing to ensure you are using the correct endpoint.
The Embedded Price data to import is represented by Embedded PriceImport and loaded in EmbeddedPriceImportRequest, which is posted to import Embedded Prices.
To monitor an import status, use Get ImportSummary, Get ImportOperation, and Query ImportOperations.
Representations
Embedded PriceImportRequest
The request body to import Embedded Prices. Contains data for Embedded Prices to be created or updated in a Project.
type String | "price" The Embedded Price import resource type. |
resources Array of PriceImport | The price import resources of this request. MaxItems:20 |
{"type" : "price","resources" : [ {"key" : "bigPriceKeyTestCat","country" : "DE","validFrom" : "2021-04-11T14:00:00.000Z","validUntil" : "2022-04-11T14:00:00.000Z","customerGroup" : {"typeId" : "customer-group","key" : "customer-group-key"},"channel" : {"typeId" : "channel","key" : "channel-key"},"discounted" : {"value" : {"type" : "centPrecision","currencyCode" : "EUR","centAmount" : 251},"discount" : {"typeId" : "product-discount","key" : "product-discount-key"}},"tiers" : [ {"minimumQuantity" : 5,"value" : {"type" : "centPrecision","currencyCode" : "EUR","centAmount" : 80}} ],"productVariant" : {"typeId" : "product-variant","key" : "red-t-shirt"},"product" : {"typeId" : "product","key" : "t-shirt"},"value" : {"type" : "centPrecision","currencyCode" : "EUR","centAmount" : 300},"custom" : {"type" : {"typeId" : "type","key" : "custom-type"},"fields" : {"customFieldName" : {"type" : "String","value" : "customFieldValue"}}}}, {"key" : "bigPriceKeyTestCat","country" : "DE","validFrom" : "2021-04-11T14:00:00.000Z","validUntil" : "2022-04-11T14:00:00.000Z","discounted" : {"value" : {"type" : "highPrecision","fractionDigits" : 3,"preciseAmount" : 2513,"currencyCode" : "EUR","centAmount" : 1234},"discount" : {"typeId" : "product-discount","key" : "product-discount-key"}},"tiers" : [ {"minimumQuantity" : 5,"value" : {"type" : "centPrecision","currencyCode" : "EUR","centAmount" : 80}} ],"productVariant" : {"typeId" : "product-variant","key" : "red-t-shirt"},"product" : {"typeId" : "product","key" : "t-shirt"},"value" : {"type" : "centPrecision","currencyCode" : "EUR","centAmount" : 300}} ]}
Embedded PriceImport
The data representation for a price to be imported that is persisted as a Price in the Project.
key String | User-defined unique identifier for the Embedded Price. MinLength:2 MaxLength: 256 Pattern: ^[A-Za-z0-9_-]+$ |
value | Maps to |
country CountryCode | Maps to ^[A-Z]{2}$ |
validFrom | Maps to |
validUntil | Maps to |
customerGroup | The Reference to the CustomerGroup with which the Price is associated.
If referenced CustomerGroup does not exist, the |
channel | The Reference to the Channel with which the Price is associated.
If referenced Channel does not exist, the |
discounted DiscountedPrice | Sets a discounted price from an external service. |
publish Boolean | Only the Embedded Price updates will be published to false |
tiers Array of PriceTier | The tiered prices for this price. |
productVariant | The ProductVariant in which this Embedded Price is contained.
The Reference to the ProductVariant with which the Price is associated.
If referenced ProductVariant does not exist, the |
product | The Product in which the Product Variant containing this Embedded Price is contained. Maps to |
custom | The custom fields for this price. |
Import Embedded Prices
Creates a request for creating new Prices or updating existing ones.
manage_products:{projectKey}
region String | The Region in which the Project is hosted. |
projectKey String | The Project key. |
importContainerKey String | The ImportContainer used to create the new resource |
application/json
application/json