Import API common types

Elevate, May 20-22-2025, Miami Beach, Florida

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.

CartDiscountKeyReference

References a cart discount by key.

key
String
typeId
ReferenceType
cart-discount

The type of the referenced resource.

CategoryKeyReference

References a category by key.

key
String
typeId
ReferenceType
category

The type of the referenced resource.

ChannelKeyReference

References a channel by key.

key
String
typeId
ReferenceType
channel

The type of the referenced resource.

CustomerKeyReference

References a customer by key.

key
String
typeId
ReferenceType
customer

The type of the referenced resource.

CustomerGroupKeyReference

References a customer group by key.

key
String
typeId
ReferenceType
customer-group

The type of the referenced resource.

CustomObjectKeyReference

References a key value document by key.

key
String
typeId
ReferenceType
key-value-document

The type of the referenced resource.

container
String

ProductKeyReference

References a product by key.

key
String
typeId
ReferenceType
product

The type of the referenced resource.

ProductVariantKeyReference

References a product variant by key.

key
String
typeId
ReferenceType
product-variant

The type of the referenced resource.

ProductTypeKeyReference

References a product type by key.

key
String
typeId
ReferenceType
product-type

The type of the referenced resource.

ShippingMethodKeyReference

References a shipping method by key.

key
String
typeId
ReferenceType
shipping-method

The type of the referenced resource.

StateKeyReference

References a state by key.

key
String
typeId
ReferenceType
state

The type of the referenced resource.

StoreKeyReference

References a store by key.

key
String
typeId
ReferenceType
store

The type of the referenced resource.

TaxCategoryKeyReference

References a tax category by key.

key
String
typeId
ReferenceType
tax-category

The type of the referenced resource.

TypeKeyReference

References a type by key.

key
String
typeId
ReferenceType
type

The type of the referenced resource.