Documentation
BETA

Importing Embedded Prices

Elevate, May 20-22-2025, Miami Beach, Florida
Create and update Embedded Prices in your Products.
The Embedded Price data to import is represented by EmbeddedPriceImport and included in an EmbeddedPriceImportRequest, which is imported using Import Embedded Prices.
Embedded Prices are used to include price information within Product Variants and Line Items. They are different to Standalone Prices. You should check what type of price you are importing to ensure you are using the correct endpoint.

Representations

EmbeddedPriceImportRequest

The request body to import Embedded Prices. Contains data for Embedded Prices to be created or updated in a Project.
type​
ImportResourceType​
price

The resource types that can be imported.

resources​
Array of PriceImport​

The price import resources of this request.

MaxItems: 20​
Example: json
{
  "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
      }
    }
  ]
}

EmbeddedPriceImport

To update an existing Embedded Price, it must have a key.
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. If a Price with this key exists on the specified productVariant, it will be updated with the imported data.
MinLength: 2​MaxLength: 256​Pattern: ^[A-Za-z0-9_-]+$​
value​
TypedMoney​
Maps to Price.value.
country​
CountryCode​
Maps to Price.county.
Pattern: ^[A-Z]{2}$​
validFrom​
DateTime​
Maps to Price.validFrom.
validUntil​
DateTime​
Maps to Price.validUntil.
customerGroup​
CustomerGroupKeyReference​
The Reference to the CustomerGroup with which the Price is associated. If referenced CustomerGroup does not exist, the state of the ImportOperation will be set to unresolved until the necessary CustomerGroup is created.
channel​
ChannelKeyReference​
The Reference to the Channel with which the Price is associated. If referenced Channel does not exist, the state of the ImportOperation will be set to unresolved until the necessary Channel is created.
discounted​
DiscountedPrice​

Sets a discounted price from an external service.

staged​
Boolean​
Default: true​
tiers​
Array of PriceTier​

The tiered prices for this price.

productVariant​
ProductVariantKeyReference​
The ProductVariant in which this Embedded Price is contained. The Reference to the ProductVariant with which the Price is associated. If the referenced ProductVariant does not exist, the state of the ImportOperation will be set to unresolved until the necessary ProductVariant is created.
product​
ProductKeyReference​
The Product in which the Product Variant containing this Embedded Price is contained. Maps to ProductVariant.product. The Reference to the Product with which the Price is associated. If referenced Product does not exist, the state of the ImportOperation will be set to unresolved until the necessary Product is created.
custom​
Custom​

The custom fields for this price.

Import Embedded Prices

POST
https://import.{region}.commercetools.com/{projectKey}/prices/import-containers/{importContainerKey}

Creates a request for creating new Prices or updating existing ones.

OAuth 2.0 Scopes:
manage_products:{projectKey}
Path parameters:
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

Request Body:PriceImportRequestasapplication/json
Response:
201

ImportResponse

asapplication/json