BETA

Common Types

This page documents data types that are used across different endpoints of the Import API.

KeyReference

The Import API uses KeyReferences of the HTTP API to reference resources in a commercetools Project. The following KeyReferences are in use.

CategoryKeyReference

References a category by key.

key
String
typeId
String
"category"

References a category.

ProductTypeKeyReference

References a product type by key.

key
String
typeId
String
"product-type"

References a product type.

TypeKeyReference

References a type by key.

key
String
typeId
String
"type"

References a type.

ProductKeyReference

References a product by key.

key
String
typeId
String
"product"

References a product.

ProductVariantKeyReference

References a product variant by key.

key
String
typeId
String
"product-variant"

References a product variant.

TaxCategoryKeyReference

References a tax category by key.

key
String
typeId
String
"tax-category"

References a tax-category.

StateKeyReference

References a state by key.

key
String
typeId
String
"state"

References a state.

CustomerGroupKeyReference

References a customer group by key.

key
String
typeId
String
"customer-group"

References a customer group.

ChannelKeyReference

References a channel by key.

key
String
typeId
String
"channel"

References a channel.

CustomerKeyReference

References a customer by key.

key
String
typeId
String
"customer"

References a customer.

CartDiscountKeyReference

References a cart discount by key.

key
String
typeId
String
"cart-discount"

References a cart discount.

ShippingMethodKeyReference

References a shipping method by key.

key
String
typeId
String
"shipping-method"

References a shipping method.

CustomObjectKeyReference

References a key value document by key.

key
String
typeId
String
"key-value-document"

References a custom object

container
String

Custom

The representation to be sent to the server when creating a resource with custom fields.

The type that provides the field definitions for this object.

The custom fields of this object.