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.

References a category by key.

`key` String
`typeId` String	`"category"` References a category.

References a product type by key.

`key` String
`typeId` String	`"product-type"` References a product type.

References a type by key.

`key` String
`typeId` String	`"type"` References a type.

References a product by key.

`key` String
`typeId` String	`"product"` References a product.

References a product variant by key.

`key` String
`typeId` String	`"product-variant"` References a product variant.

References a tax category by key.

`key` String
`typeId` String	`"tax-category"` References a tax-category.

References a state by key.

`key` String
`typeId` String	`"state"` References a state.

References a customer group by key.

`key` String
`typeId` String	`"customer-group"` References a customer group.

References a channel by key.

`key` String
`typeId` String	`"channel"` References a channel.

References a customer by key.

`key` String
`typeId` String	`"customer"` References a customer.

References a cart discount by key.

`key` String
`typeId` String	`"cart-discount"` References a cart discount.

References a shipping method by key.

`key` String
`typeId` String	`"shipping-method"` References a shipping method.

References a key value document by key.

`key` String
`typeId` String	`"key-value-document"` References a custom object
`container` String

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

`type` TypeKeyReference	The type that provides the field definitions for this object.
`fields` FieldContainer	The custom fields of this object.