Documentation

Common Types

Data types used across different endpoints of the Import API.

KeyReference

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

CartDiscountKeyReference

References a cart discount by key.

key​
String​
typeId​
String​
"cart-discount"

References a cart discount.

CategoryKeyReference

References a category by key.

key​
String​
typeId​
String​
"category"

References a category.

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.

CustomerGroupKeyReference

References a customer group by key.

key​
String​
typeId​
String​
"customer-group"

References a customer group.

CustomObjectKeyReference

References a key value document by key.

key​
String​
typeId​
String​
"key-value-document"

References a custom object

container​
String​

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.

ProductTypeKeyReference

References a product type by key.

key​
String​
typeId​
String​
"product-type"

References a product type.

ShippingMethodKeyReference

References a shipping method by key.

key​
String​
typeId​
String​
"shipping-method"

References a shipping method.

StateKeyReference

References a state by key.

key​
String​
typeId​
String​
"state"

References a state.

StoreKeyReference

References a store by key.

key​
String​
typeId​
String​
"store"

References a store.

TaxCategoryKeyReference

References a tax category by key.

key​
String​
typeId​
String​
"tax-category"

References a tax-category.

TypeKeyReference

References a type by key.

key​
String​
typeId​
String​
"type"

References a type.