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.

References a cart discount by key.

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

References a category by key.

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

References a channel by key.

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

References a customer by key.

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

References a customer group by key.

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

References a key value document by key.

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

References a product by key.

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

References a product variant by key.

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

References a product type by key.

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

References a shipping method by key.

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

References a state by key.

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

References a store by key.

`key` String
`typeId` ReferenceType	`"store"` References a store.

References a tax category by key.

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

References a type by key.

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