Import Resources

Representations of resources that can be imported into a Project using the Import API.

Import Resources are almost identical to the equivalent type on the HTTP API, with the main difference that id values are not included.

When referencing other resources, such as defining the parent of a CategoryImport, only KeyReferences are accepted. This ensures that resources can be imported to multiple Projects, such as production and staging, without needing to change Project-specific id values.

Types that are identical on the HTTP API, we do not document here, but refer to the respective type on the HTTP API instead.

for Categories

CategoryImport

Represents the data used to import a Category. Once imported, this data is persisted as a Category in the Project.

`key` String	User-defined unique identifier. If a Category with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`externalId` String	Maps to `Category.externalId`.
`name` LocalizedString	Maps to `Category.name`.
`slug` LocalizedString	Maps to `Category.slug`. Must match the pattern `^[A-Za-z0-9_-]{2,256}+$`.
`description` LocalizedString	Maps to `Category.description`.
`parent` CategoryKeyReference	Maps to `Category.parent`. If the referenced Category does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Category is created.
`orderHint` String	Maps to `Category.orderHint`.
`metaTitle` LocalizedString	Maps to `Category.metaTitle`.
`metaDescription` LocalizedString	Maps to `Category.metaDescription`.
`metaKeywords` LocalizedString	Maps to `Category.metaKeywords`.
`assets` Array of Asset	Maps to `Category.assets`.
`custom` Custom	Maps to `Category.custom`.

Example: json

{
  "key": "category-to-import",
  "name": {
    "en": "Category to import"
  },
  "slug": {
    "en": "category-to-import-slug"
  },
  "description": {
    "en": "Description of category to import"
  },
  "parent": {
    "typeId": "category",
    "key": "key-of-parent-category"
  }
}

for Customers

CustomerImport

Represents the data used to import a Customer. Once imported, this data is persisted as a Customer in the Project.

`key` String	User-defined unique identifier. If a Customer with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`customerNumber` String	Maps to `Customer.customerNumber`.
`externalId` String	Maps to `Customer.externalId`.
`email` String	Maps to `Customer.email`.
`password` String	Maps to `Customer.password`. Required when `authenticationMode` is set to `Password`.
`stores` Array of StoreKeyReference	Maps to `Customer.stores`. If the referenced Stores do not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Stores are created.
`firstName` String	Maps to `Customer.firstName`.
`lastName` String	Maps to `Customer.lastName`.
`middleName` String	Maps to `Customer.middleName`.
`title` String	Maps to `Customer.title`.
`salutation` String	Maps to `Customer.salutation`.
`dateOfBirth` Date	Maps to `Customer.dateOfBirth`.
`companyName` String	Maps to `Customer.companyName`.
`vatId` String	Maps to `Customer.vatId`.
`isEmailVerified` Boolean	Maps to `Customer.isEmailVerified`.
`customerGroup` CustomerGroupKeyReference	Maps to `Customer.customerGroup`. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created.
`addresses` Array of CustomerAddress	Maps to `Customer.addresses`.
`defaultBillingAddress` Int	Index of the address in the `addresses` array to use as the default billing address. The `defaultBillingAddressId` of the Customer will be set to the `id` of that address.
`billingAddresses` Array of Integer	Indices of the billing addresses in the `addresses` array. The `billingAddressIds` of the Customer will be set to the `id` of these addresses.
`defaultShippingAddress` Int	The index of the address in the `addresses` array. The `defaultShippingAddressId` of the Customer will be set to the `id` of that address.
`shippingAddresses` Array of Integer	Indices of the shipping addresses in the `addresses` array. The `shippingAddressIds` of the Customer will be set to the `id` of these addresses.
`locale` String	Maps to `Customer.locale`. Pattern: `^[a-zA-Z]{2,3}(?:-[a-zA-Z]{4})?(?:-(?:[a-zA-Z]{2}\|d{3}))?$`
`authenticationMode` AuthenticationMode	Set to `Password` to make the `password` field required for the Customer. Set to `ExternalAuth` when the password is not required for the Customer. Default: `Password`
`custom` Custom	Maps to `Customer.custom`.

Example: json

{
  "key": "customer-to-import",
  "customerNumber": "12345",
  "email": "john@example.com",
  "password": "D0cEx@mpl3!2025",
  "firstName": "John",
  "lastName": "Doe",
  "dateOfBirth": "1980-01-01",
  "isEmailVerified": false,
  "externalId": "external-id-123",
  "customerGroup": {
    "typeId": "customer-group",
    "key": "customer-group-key"
  },
  "addresses": [
    {
      "key": "john-doe-address-key",
      "streetName": "Main Street",
      "streetNumber": "123",
      "postalCode": "12345",
      "city": "Berlin",
      "country": "DE"
    }
  ],
  "authenticationMode": "Password"
}

CustomerAddress

Different from Address in that key is required and id is not supported.

`key` String	User-defined identifier for the address. Must be unique per customer. MinLength: `2`MaxLength: `256`Pattern: `^[a-zA-Z0-9_-]{2,256}$`
`externalId` String	ID for the contact used in an external system.
`country` CountryCode	Name of the country. Pattern: `^[A-Z]{2}$`
`title` String	Title of the contact, for example 'Dr.'
`salutation` String	Salutation of the contact, for example 'Mr.' or 'Ms.'
`firstName` String	Given name (first name) of the contact.
`lastName` String	Family name (last name) of the contact.
`streetName` String	Name of the street.
`streetNumber` String	Street number.
`additionalStreetInfo` String	Further information on the street address.
`postalCode` String	Postal code.
`city` String	Name of the city.
`region` String	Name of the region.
`state` String	Name of the state, for example, Colorado.
`company` String	Name of the company.
`department` String	Name of the department.
`building` String	Number or name of the building.
`apartment` String	Number or name of the apartment.
`pOBox` String	Post office box number.
`phone` String	Phone number of the contact.
`mobile` String	Mobile phone number of the contact.
`email` String	Email address of the contact.
`fax` String	Fax number of the contact.
`additionalAddressInfo` String	Further information on the Address.
`custom` Custom	Custom Fields for the address.

Example: json

{
  "key": "john-doe-address-key",
  "streetName": "Main Street",
  "streetNumber": "123",
  "postalCode": "12345",
  "city": "Berlin",
  "country": "DE"
}

for Discount Codes

DiscountCodeImport

Represents the data used to import a DiscountCode. Once imported, this data is persisted as a DiscountCode in the Project.

`key` String	User-defined unique identifier. If a DiscountCode with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Maps to `DiscountCode.name`.
`description` LocalizedString	Maps to `DiscountCode.description`.
`code` String	Maps to `DiscountCode.code`. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
`cartDiscounts` Array of CartDiscountKeyReference	Maps to `DiscountCode.cartDiscounts`. If the referenced CartDiscounts do not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CartDiscounts are created.
`cartPredicate` String	Maps to `DiscountCode.cartPredicate`.
`isActive` Boolean	Maps to `DiscountCode.isActive`.
`maxApplications` Int	Maps to `DiscountCode.maxApplications`.
`maxApplicationsPerCustomer` Int	Maps to `DiscountCode.maxApplicationsPerCustomer`.
`groups` Array of String	Maps to `DiscountCode.groups`.
`validFrom` DateTime	Maps to `DiscountCode.validFrom`.
`validUntil` DateTime	Maps to `DiscountCode.validUntil`.
`custom` Custom	Maps to `DiscountCode.custom`.

Example: json

{
  "key": "discountCodeKey",
  "code": "Save10",
  "name": {
    "en": "Save10"
  },
  "cartDiscounts": [
    {
      "typeId": "cart-discount",
      "key": "cartDiscountKey"
    }
  ],
  "isActive": false,
  "groups": []
}

for Inventory

InventoryImport

Represents the data used to import an InventoryEntry. Once imported, this data is persisted as a InventoryEntry in the Project.

`key` String	User-defined unique identifier. If an InventoryEntry with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`sku` String	Maps to `InventoryEntry.sku`
`quantityOnStock` Int	Maps to `InventoryEntry.quantityOnStock`
`restockableInDays` Int	Maps to `InventoryEntry.restockableInDays`
`expectedDelivery` DateTime	Maps to `InventoryEntry.expectedDelivery`
`supplyChannel` ChannelKeyReference	Maps to `InventoryEntry.supplyChannel`. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`custom` Custom	Maps to `InventoryEntry.custom`.

Example: json

{
  "key": "inventory-import-key",
  "sku": "product-variant-sku",
  "quantityOnStock": 15,
  "restockableInDays": 2,
  "expectedDelivery": "2022-06-30T14:00:00.000Z",
  "supplyChannel": {
    "typeId": "channel",
    "key": "channel-key"
  }
}

for Product Types

ProductTypeImport

Represents the data used to import a ProductType. Once imported, this data is persisted as a ProductType in the Project.

`key` String	User-defined unique identifier. If a ProductType with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` String	Maps to `ProductType.name`.
`description` String	Maps to `ProductType.description`.
`attributes` Array of AttributeDefinition	The `attributes` of ProductType.

Example: json

{
  "key": "product-type-key",
  "name": "Product Type name",
  "description": "Test product type",
  "attributes": [
    {
      "name": "product-ref-attribute",
      "label": {
        "en": "selling product"
      },
      "isRequired": false,
      "isSearchable": false,
      "type": {
        "name": "reference",
        "referenceTypeId": "category"
      },
      "attributeConstraint": "Unique",
      "inputTip": {
        "en": "product input tip"
      },
      "inputHint": "SingleLine"
    }
  ]
}

for Products

When updating existing Products by import, you must include the existing values of the Product. The import process will remove the values of omitted fields.

ProductImport

Represents the data used to import a Product. Once imported, this data is persisted as a Product in the Project.

This is the minimal representation required for creating a Product in Composable Commerce.

`key` String	User-defined unique identifier. If a Product with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Maps to `ProductData.name`.
`productType` ProductTypeKeyReference	Maps to `Product.productType`. If the referenced ProductType does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ProductType is created.
`slug` LocalizedString	Maps to `ProductData.slug`.
`description` LocalizedString	Maps to `ProductData.description`.
`categories` Array of CategoryKeyReference	Maps to `ProductData.categories`. If the referenced Categories do not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Categories are created.
`attributes` Array of Attribute
`metaTitle` LocalizedString	Maps to `ProductData.metaTitle`.
`metaDescription` LocalizedString	Maps to `ProductData.metaDescription`.
`metaKeywords` LocalizedString	Maps to `ProductData.metaKeywords`.
`taxCategory` TaxCategoryKeyReference	Maps to `Product.taxCategory`. If the referenced TaxCategory does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced TaxCategory is created.
`searchKeywords` SearchKeywords	Maps to `ProductData.searchKeywords`.
`state` StateKeyReference	Maps to `Product.state`. If the referenced State does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced State is created.
`publish` Boolean	Determines the published status and current/staged projection of the Product. For more information, see Managing the published state of Products. Default: `false`
`priceMode` ProductPriceModeEnum	Maps to `Product.priceMode`.

Example: json

{
  "key": "product-key",
  "name": {
    "en": "t-shirt"
  },
  "productType": {
    "typeId": "product-type",
    "key": "product-type-key"
  },
  "slug": {
    "en": "t-shirt-slug"
  },
  "description": {
    "en": "t-shirt-description"
  },
  "categories": [
    {
      "typeId": "category",
      "key": "category-key"
    }
  ],
  "taxCategory": {
    "typeId": "tax-category",
    "key": "tax-category-key"
  },
  "state": {
    "typeId": "state",
    "key": "state-key"
  }
}

ProductDraftImport

The representation of a Product Draft for the import purpose.

`key` String	User-defined unique identifier. If a Product with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`productType` ProductTypeKeyReference	Maps to `Product.productType`. If the referenced ProductType does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ProductType is created.
`name` LocalizedString	Maps to `ProductData.name`.
`slug` LocalizedString	Maps to `ProductData.slug`.
`description` LocalizedString	Maps to `ProductData.description`.
`categories` Array of CategoryKeyReference	Maps to `ProductData.categories`. If the referenced Categories do not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Categories are created.
`attributes` Array of Attribute
`metaTitle` LocalizedString	Maps to `ProductData.metaTitle`.
`metaDescription` LocalizedString	Maps to `ProductData.metaDescription`.
`metaKeywords` LocalizedString	Maps to `ProductData.metaKeywords`.
`masterVariant` ProductVariantDraftImport	The master ProductVariant. Required if `variants` contains at least one ProductVariant.
`variants` Array of ProductVariantDraftImport	An array of related ProductVariants.
`taxCategory` TaxCategoryKeyReference	Maps to `Product.taxCategory`. If the referenced TaxCategory does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced TaxCategory is created.
`searchKeywords` SearchKeywords	Maps to `ProductData.searchKeywords`.
`state` StateKeyReference	Maps to `Product.state`. If the referenced State does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced State is created.
`publish` Boolean	Determines the published status and current/staged projection of the Product. For more information, see Managing the published state of Products. Default: `false`
`priceMode` ProductPriceModeEnum	Maps to `Product.priceMode`. If not provided, the existing `Product.priceMode` is not changed.

Example: json

{
  "key": "product-draft-key",
  "name": {
    "en": "blue shirt"
  },
  "slug": {
    "en": "blue-t-shirt"
  },
  "productType": {
    "typeId": "product-type",
    "key": "sample"
  },
  "masterVariant": {
    "key": "master-variant-key",
    "attributes": [
      {
        "type": "reference",
        "name": "product-ref-attribute",
        "value": {
          "key": "category-key",
          "typeId": "category"
        }
      },
      {
        "type": "reference",
        "name": "product-custom-object-ref-attribute",
        "value": {
          "key": "custom-object-key",
          "container": "custom-object-container-key",
          "typeId": "key-value-document"
        }
      }
    ]
  }
}

ProductVariantDraftImport

The representation of a Product Variant Draft for the import purpose.

`key` String	User-defined unique identifier for the ProductVariant.
`sku` String	User-defined unique SKU of the Product Variant.
`prices` Array of PriceDraftImport	The Embedded Prices for the Product Variant. Each Price must have its unique Price scope (with same currency, country, Customer Group, Channel, `validFrom` and `validUntil`).
`attributes` Array of Attribute	Attributes according to the respective AttributeDefinition.
`images` Array of Image	Images for the Product Variant.
`assets` Array of Asset	Media assets for the Product Variant.

EmbeddedPriceDraftImport

The representation of a Price Draft for the import purpose.

`key` String	User-defined unique identifier for the Embedded Price. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`value` TypedMoney	Money value of this Price.
`country` CountryCode	Set this field if this Price is only valid for the specified country. Pattern: `^[A-Z]{2}$`
`customerGroup` CustomerGroupKeyReference	Set this field if this Price is only valid for the referenced CustomerGroup. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created.
`channel` ChannelKeyReference	Set this field if this Price is only valid for the referenced `ProductDistribution` Channel. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`validFrom` DateTime	Set this field if this Price is only valid from the specified date and time. Must be at least 1 ms earlier than `validUntil`.
`validUntil` DateTime	Set this field if this Price is only valid until the specified date and time. Must be at least 1 ms later than `validFrom`.
`discounted` DiscountedPrice	Set this field to add a DiscountedPrice from an external service.
`tiers` Array of PriceTier	The tiered prices for this price.
`custom` Custom	Custom Fields for the Embedded Price.

for Product Variants

When updating an existing Product Variant by import, you must include the existing values of all fields in ProductVariantImport. The import process will remove the values of omitted fields.

ProductVariantImport

Represents the data used to import a ProductVariant. Once imported, this data is persisted as a ProductVariant in the Project.

`key` String	User-defined unique identifier. If a ProductVariant with this `key` exists on the specified `product`, it is updated with the imported data.
`sku` String	Maps to `ProductVariant.sku`.
`isMasterVariant` Boolean	When creating a new ProductVariant, set to `false`; otherwise, the import operation will fail with a NewMasterVariantAdditionNotAllowed error. Set to `true` if the ProductVariant exists and you want to set this ProductVariant as the Master Variant.
`attributes` Array of Attribute	Maps to `ProductVariant.attributes`. The referenced attribute must be defined in an already existing ProductType in the project, or the `state` of the ImportOperation will be `unresolved`.
`images` Array of Image	Maps to `ProductVariant.images`.
`assets` Array of Asset	Maps to `ProductVariant.assets`.
`staged` Boolean	Set to `false` to update both the current and staged projections of the Product with the new Product Variant data. Leave empty or set to `true` to only update the staged projection. Default: `true`
`product` ProductKeyReference	The Product containing this ProductVariant. If the referenced Product does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Product is created.

Example: json

{
  "key": "red-t-shirt",
  "sku": "red-t-shirt",
  "product": {
    "key": "t-shirt",
    "typeId": "product"
  },
  "isMasterVariant": true,
  "attributes": [
    {
      "name": "new",
      "type": "boolean",
      "value": true
    },
    {
      "name": "weight",
      "type": "number",
      "value": 12.5
    }
  ]
}

Attribute

Represents the Attribute value to be persisted in a Product Variant.

name - String - Optional
Required if used for ProductVariantImport. Must not be set when used for ProductVariantPatch. Must match name of an AttributeDefinition of the ProductType.
type - String - Optional
Required if used for ProductVariantImport. Must not be set when used for ProductVariantPatch. Must match type of an AttributeDefinition of the ProductType.
value - Required
The actual value of the Attribute compliant to the type, see specific Attribute types in this section.

When importing nested Attributes BETA, do not include the type field and value should be an array of Attributes. For an example, see the Handling Structured and Nested Product Data tutorial.

BooleanAttribute

This type represents an attribute whose value is either "true" or "false".

`type` String	`"boolean"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Boolean	`true` or `false`

BooleanSetAttribute

This type represents an attribute whose value is set of boolean values.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"boolean-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of Boolean	A set of boolean values.

DateAttribute

This type represents an attribute whose value is a date.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"date"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Date	A date in the format `YYYY-MM-DD`.

DateSetAttribute

This type represents an attribute whose value is a set of dates.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"date-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of Date-only	A set of dates in the format `YYYY-MM-DD`.

DateTimeAttribute

This type represents an attribute whose value is a date with time.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"datetime"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` DateTime	A date with time in the format `YYYY-MM-DDTHH:mm:ss.SSSZ`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

DateTimeSetAttribute

This type represents an attribute whose value is a set of dates with time.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"datetime-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of Datetime	A set of dates with time in the format `YYYY-MM-DDTHH:mm:ss.SSSZ`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

EnumAttribute

This type represents an attribute whose value is an enum. The attribute value refers to the key of the enum value.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"enum"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` String	The key of the enum value. Must match the key of an AttributePlainEnumValue in the Product Type.

EnumSetAttribute

This type represents an attribute whose value is an enum. The attribute value refers to the key of the enum value.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"enum-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of String	A set of enum values, each represented by its key. Each key must match the key of an AttributePlainEnumValue in the Product Type.

LocalizableEnumAttribute

This type represents an attribute whose value is a localized enum. The attribute value refers to the key of the enum value.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"lenum"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` String	The key of the localized enum value. Must match the key of an AttributeLocalizedEnumValue in the Product Type.

LocalizableEnumSetAttribute

This type represents an attribute whose value is a localized enum. The attribute value refers to the key of the enum value.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"lenum-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of String	A set of localized enum values, each represented by its key. Each key must match the key of an AttributeLocalizedEnumValue in the Product Type.

LocalizableTextAttribute

This type represents an attribute whose value is a localized text.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"ltext"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` LocalizedString	A localized string.

LocalizableTextSetAttribute

This type represents an attribute whose value is a localized text.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"ltext-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of LocalizedString	A set of localized strings.

MoneyAttribute

This type represents an attribute whose value is a money object.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"money"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` TypedMoney	A money value in cent precision format.

MoneySetAttribute

This type represents an attribute whose value is a set of money objects.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"money-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of TypedMoney	A set of money values in cent precision format.

NumberAttribute

This type represents an attribute whose value is a number.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"number"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Float	A number value. Can be an integer or a floating-point number.

NumberSetAttribute

This type represents an attribute whose value is a set of numbers.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"number-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of Number	A set of number values. Each value can be an integer or a floating-point number.

ReferenceAttribute

This type represents an attribute whose value is a key reference.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"reference"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` KeyReference	References a resource by key.

Example: json

{
  "type": "reference",
  "name": "product-custom-object-ref-attribute",
  "value": {
    "key": "custom-object-key",
    "container": "custom-object-container",
    "typeId": "key-value-document"
  }
}

ReferenceSetAttribute

This type represents an attribute whose value is a set of references.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"reference-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of KeyReference	A set of references, each referencing a resource by key. Each reference must match the key of an existing resource in the project.

TextAttribute

This type represents an attribute whose value is a string.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"text"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` String	A text value.

TextSetAttribute

This type represents an attribute whose value is a set of strings.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"text-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of String	A set of text values.

TimeAttribute

This type represents an attribute whose value is a time.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"time"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Time	A time value in the format `HH:mm:ss.SSS`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

TimeSetAttribute

This type represents an attribute whose value is a set of times.

`name` String	Required if used for ProductVariantImport. Must not be set if used for ProductVariantPatch. Must match `name` of an AttributeDefinition of the Product Type.
`type` String	`"time-set"` Must match `type` of an AttributeDefinition of the Product Type. The type is required if this type is used in a product variant and must not be set when used in a product variant patch.
`value` Array of Time-only	A set of time values in the format `HH:mm:ss.SSS`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

ProductVariantPatch

Represents the data used to update a ProductVariant.

`productVariant` ProductVariantKeyReference	Reference to the ProductVariant to update.
`attributes` Attributes	Maps to `ProductVariant.attributes`. The referenced Attribute must be defined in an existing ProductType, or the `state` of the ImportOperation will be `validationFailed`. Setting the value of a non-required Attribute to `null` will remove the Attribute. Attempting to set a `null` value to a required Attribute will make the import operation fail with an InvalidOperation error. Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to `null`.
`staged` Boolean	If `false`, the attribute changes are applied to both current and staged projected representations of the Product. Default: `true`
`product` ProductKeyReference	Reference to the Product that contains the ProductVariant. We recommend to set this value to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest. If the referenced Product does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Product is created.

Example: json

{
  "productVariant": {
    "typeId": "product-variant",
    "key": "red-t-shirt"
  },
  "attributes": {
    "attribute-to-update": {
      "type": "boolean",
      "value": true
    },
    "name-of-attribute-to-delete": null,
    "name-of-localized-attribute-to-update": {
      "type": "ltext",
      "value": {
        "en": "Existing field",
        "es": null,
        "de": "Updating field"
      }
    },
    "name-of-localized-attribute-set-to-update": {
      "type": "ltext-set",
      "value": [
        {
          "en": "Existing field",
          "es": null,
          "de": "Updating field",
          "br": "New field"
        },
        {
          "en": "Another Existing field",
          "es": null,
          "de": "Another Updating field",
          "br": "Another New field"
        }
      ]
    }
  },
  "staged": false
}

for Product Selections

ProductSelectionImport

Represents the data used to import a ProductSelection. Once imported, this data is persisted as a ProductSelection in the Project.

`key` String	User-defined unique identifier. If an ProductSelection with this `key` exists, it is updated with the imported data.
`name` LocalizedString	Maps to `ProductSelection.name`.
`mode` ProductSelectionMode	Maps to `ProductSelection.mode`. Default: `Individual`
`assignments` Array of ProductSelectionAssignment	List of product assignments.
`custom` Custom	Maps to `ProductSelection.custom`.

ProductSelectionAssignment

An assignment of a product and either variantSelection or variantExclusion (not both).

`product` ProductKeyReference	Reference to the Product by key.
`variantSelection` VariantSelection	Variant selection specifying included SKUs.
`variantExclusion` VariantExclusion	Variant exclusion specifying excluded SKUs.

VariantSelectionType

Defines how variants are selected for the product.

includeOnly: Only the specified SKUs are included.
includeAllExcept: All variants except the specified SKUs are included.

for Prices

EmbeddedPriceImport

Represents the data used to import an Embedded Price . Once imported, this data is persisted as a Price in a Product Variant.

`key` String	User-defined unique identifier for the Embedded Price. If a Price with this `key` exists on the specified `productVariant`, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`value` TypedMoney	Maps to `Price.value`.
`country` CountryCode	Maps to `Price.county`. Pattern: `^[A-Z]{2}$`
`validFrom` DateTime	Maps to `Price.validFrom`.
`validUntil` DateTime	Maps to `Price.validUntil`.
`customerGroup` CustomerGroupKeyReference	Maps to `Price.customerGroup`. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created.
`channel` ChannelKeyReference	Maps to `Price.channel`. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`discounted` DiscountedPrice	Sets a discounted price from an external service.
`staged` Boolean	Set to `false` to update both the current and staged projections of the Product with the new Price data. Leave empty or set to `true` to only update the staged projection. Default: `true`
`tiers` Array of PriceTier	The tiered prices for this price.
`productVariant` ProductVariantKeyReference	The ProductVariant which contains this Embedded Price. If the referenced ProductVariant does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ProductVariant is created.
`product` ProductKeyReference	The Product which contains the `productVariant`. If the referenced Product does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Product is created.
`custom` Custom	Maps to `Price.custom`.

Example: json

{
  "key": "price-key",
  "country": "DE",
  "validFrom": "2021-04-11T14:00:00.000Z",
  "validUntil": "2022-04-11T14:00:00.000Z",
  "customerGroup": {
    "typeId": "customer-group",
    "key": "customer-group-key"
  },
  "channel": {
    "typeId": "channel",
    "key": "channel-key"
  },
  "productVariant": {
    "typeId": "product-variant",
    "key": "red-t-shirt"
  },
  "product": {
    "typeId": "product",
    "key": "t-shirt"
  },
  "value": {
    "type": "centPrecision",
    "currencyCode": "EUR",
    "centAmount": 300
  }
}

StandalonePriceImport

When updating an existing StandalonePrice by import, you must include the existing values of all fields in StandalonePriceImport. The import process will remove the values of omitted fields.

Represents the data used to import a StandalonePrice. Once imported, this data is persisted as a StandalonePrice) in the Project.

`key` String	User-defined unique identifier for the StandalonePrice. If a StandalonePrice) with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`sku` String	Maps to `StandalonePrice.sku`. This value is not validated to exist in Product Variants.
`value` TypedMoney	Maps to `StandalonePrice.value`.
`country` CountryCode	Maps to `StandalonePrice.country`. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error. Pattern: `^[A-Z]{2}$`
`customerGroup` CustomerGroupKeyReference	Maps to `StandalonePrice.customerGroup`. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
`channel` ChannelKeyReference	Maps to `StandalonePrice.channel`. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created. This value cannot be updated. Attempting to update this value will result in an InvalidFieldsUpdate error.
`validFrom` DateTime	Maps to `StandalonePrice.validFrom`.
`validUntil` DateTime	Maps to `StandalonePrice.validUntil`.
`tiers` Array of PriceTier	Maps to `StandalonePrice.tiers`.
`discounted` DiscountedPrice	Sets a discounted price for this Price that is different from the base price with value.
`custom` Custom	Maps to `StandalonePrice.custom`.

Example: json

{
  "key": "standalone-price-key",
  "sku": "variantSku",
  "value": {
    "type": "centPrecision",
    "currencyCode": "EUR",
    "centAmount": 100
  }
}

for Orders

OrderImport

Represents the data used to import an Order. Once imported, this data is persisted as an Order in the Project.

An OrderImport is a snapshot of an order at the time it was imported.

`orderNumber` String	Maps to `Order.orderNumber`, String that uniquely identifies an order. It should be unique across a project. Once it's set it cannot be changed.
`customer` CustomerKeyReference	`key` of the Customer that the Order belongs to. If the referenced Customer does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Customer is created.
`customerEmail` String	Maps to `Order.customerEmail`.
`lineItems` Array of LineItemImportDraft	Maps to `Order.lineItems`.
`customLineItems` Array of CustomLineItemDraft	Maps to `Order.customLineItems`
`totalPrice` TypedMoney	Maps to `Order.totalPrice`.
`taxedPrice` TaxedPrice	Maps to `Order.taxedPrice`.
`shippingAddress` Address	Maps to `Order.shippingAddress`.
`billingAddress` Address	Maps to `Order.billingAddress`.
`customerGroup` CustomerGroupKeyReference	Maps to `Order.customerGroup`. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created.
`country` String	Maps to `Order.country`.
`orderState` OrderState	Maps to `Order.orderState`.
`shipmentState` ShipmentState	Maps to `Order.shipmentState`.
`paymentState` PaymentState	Maps to `Order.paymentState`.
`shippingInfo` ShippingInfoImportDraft	Maps to `Order.shippingInfo`.
`completedAt` DateTime	Maps to `Order.completedAt`.
`inventoryMode` InventoryMode	Maps to `Order.inventoryMode`.
`taxRoundingMode` RoundingMode	Maps to `Order.taxRoundingMode`.
`taxCalculationMode` TaxCalculationMode	Maps to `Order.taxCalculationMode`.
`origin` CartOrigin	Maps to `Order.origin`.
`itemShippingAddresses` Array of Address	Maps to `Order.itemShippingAddresses`.
`store` StoreKeyReference	Maps to `Order.store`. If the referenced Store does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Store is created.
`state` StateKeyReference	Maps to `Order.state`. If the referenced State does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced State is created.
`custom` Custom	Maps to `Order.custom`.

Example: json

{
  "orderNumber": "order-number",
  "customer": {
    "typeId": "customer",
    "key": "order-customer-key"
  },
  "lineItems": [
    {
      "name": {
        "en": "abc"
      },
      "quantity": 10,
      "price": {
        "value": {
          "type": "centPrecision",
          "centAmount": 100,
          "currencyCode": "EUR"
        }
      },
      "supplyChannel": {
        "typeId": "channel",
        "key": "supplier-channel-key"
      },
      "variant": {
        "productVariant": {
          "typeId": "product-variant",
          "key": "product-key"
        },
        "sku": "variant-sku"
      }
    }
  ],
  "customerGroup": {
    "typeId": "customer-group",
    "key": "customer-group-key"
  },
  "totalPrice": {
    "type": "centPrecision",
    "currencyCode": "EUR",
    "centAmount": 4200
  }
}

LineItemImportDraft

Represents an individual Line Item in an Order. A line item is a snapshot of a product at the time it was added to the order.

You cannot create an Order that includes line item operations that do not exist in the Project or have been deleted. Products and Product Variants referenced by a line item must already exist in the Project. Product Attributes are merged with Variant Attributes to ensure the full Attribute context of the Product Variant.

`product` ProductKeyReference	Maps to `LineItem.productId`. If the referenced Product does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Product is created.
`name` LocalizedString	Maps to `LineItem.name`.
`variant` LineItemProductVariantImportDraft	Maps to `ProductVariantImportDraft`.
`price` LineItemPrice	Maps to `LineItem.price`.
`quantity` Int	Maps to `LineItem.quantity`.
`state` Array of ItemState	Maps to `LineItem.state`.
`supplyChannel` ChannelKeyReference	Maps to `LineItem.supplyChannel`. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`distributionChannel` ChannelKeyReference	Maps to `LineItem.distributionChannel`. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`taxRate` TaxRate	Maps to `LineItem.taxRate`.
`shippingDetails` ItemShippingDetailsDraft	Maps to `LineItem.shippingDetails`.
`custom` Custom	Maps to `LineItem.custom`.

CustomLineItemDraft

`name` LocalizedString	Maps to `CustomLineItem.name`.
`money` TypedMoney	Maps to `CustomLineItem.money`.
`taxedPrice` CustomLineItemTaxedPrice	Maps to `CustomLineItem.taxedPrice`.
`totalPrice` TypedMoney	Maps to `CustomLineItem.totalPrice`.
`slug` String	Maps to `CustomLineItem.slug`.
`quantity` Int	Maps to `CustomLineItem.quantity`.
`state` Array of ItemState	Maps to `CustomLineItem.state`.
`taxCategory` TaxCategoryKeyReference	Maps to `CustomLineItem.taxCategory`. References a tax category by key. If the referenced TaxCategory does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced TaxCategory is created.
`taxRate` TaxRate	Maps to `CustomLineItem.taxRate`.
`externalTaxRate` ExternalTaxRateDraft	External Tax Rate for the Custom Line Item if the Cart has the `External` TaxMode.
`discountedPricePerQuantity` Array of DiscountedLineItemPriceDraft	Maps to `CustomLineItem.discountedPricePerQuantity`.
`shippingDetails` ItemShippingDetailsDraft	Maps to `CustomLineItem.shippingDetails`.

LineItemProductVariantImportDraft

`productVariant` ProductVariantKeyReference	Maps to `ProductVariant.product`. If the referenced ProductVariant does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ProductVariant is created.
`sku` String	Maps to `ProductVariantImportDraft.sku`.
`prices` Array of LineItemPrice	Maps to `ProductVariantImportDraft.prices`
`attributes` Array of Attribute	Maps to `ProductVariantImportDraft.attributes`
`images` Array of Image	Maps to `ProductVariantImportDraft.images`.

LineItemPrice

`value` TypedMoney	Maps to `Price.value`.
`country` CountryCode	Maps to `Price.county`. Pattern: `^[A-Z]{2}$`
`validFrom` DateTime	Maps to `Price.validFrom`.
`validUntil` DateTime	Maps to `Price.validUntil`.
`customerGroup` CustomerGroupKeyReference	Maps to `Price.customerGroup`. References a customer group by key. If the referenced CustomerGroup does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced CustomerGroup is created.
`channel` ChannelKeyReference	Maps to `Price.channel`. References a channel by key. If the referenced Channel does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Channel is created.
`discounted` DiscountedPrice	Sets a discounted price from an external service.
`tiers` Array of PriceTier	Maps to `Price.tiers`.
`custom` Custom	Maps to `Price.custom`.

DiscountedPrice

`value` TypedMoney	Money value of the discounted price.
`discount` ProductDiscountKeyReference	Reference to a ProductDiscount. If the referenced ProductDiscount does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ProductDiscount is created.

DiscountedLineItemPriceDraft

`value` Money	Discounted money value.
`includedDiscounts` Array of DiscountedLineItemPortion	Discounts to be applied.

ShippingInfoImportDraft

Maps to an Order's shippingInfo property. This field is usually populated by the Cart associated with the Order, but when importing Orders you must provide a draft representation as a part of the OrderImport.

`shippingMethodName` String	Maps to `shippingInfo.shippingMethodName`.
`price` TypedMoney	Maps to `shippingInfo.price`.
`shippingRate` ShippingRateDraft	Used to determine the price.
`taxRate` TaxRate	Maps to `shippingInfo.taxRate`.
`taxCategory` TaxCategoryKeyReference	Maps to `shippingInfo.taxCategory`. If the referenced TaxCategory does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced TaxCategory is created.
`shippingMethod` ShippingMethodKeyReference	Maps to `shippingInfo.shippingMethod`. If the referenced ShippingMethod does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced ShippingMethod is created.
`deliveries` Array of Delivery	Maps to `shippingInfo.deliveries`. You cannot add a `DeliveryItem` on import, as `LineItems` and `CustomLineItems` are not yet referenceable by an `id`.
`discountedPrice` DiscountedLineItemPriceDraft	Maps to `shippingInfo.discountedPrice`.
`shippingMethodState` ShippingMethodState	Maps to `shippingInfo.shippingMethodState`.

OrderPatchImport

Represents the data used to update an Order in a Project.

`orderNumber` String	User-defined unique identifier. If an Order with this `orderNumber` exists, it is updated with the imported data.
`fields` OrderField	Each field referenced must be defined in an existing Order or the ImportOperationState is set to `validationFailed`.

OrderField

ParcelMeasurementDraft

RemoveParcelFromDeliveryDraft

Order fields that needs to be added or updated.

`addReturnInfo` ReturnInfo	Maps to `Order.returnInfo`
`addParcelToDelivery` DeliveryParcel	Maps to `Order.delivery`
`addDeliveries` Array of DeliveryDraft	Maps to `Order.delivery`
`removeDelivery` RemoveDeliveryDraft	Maps to `Order.removeDelivery`
`removeParcelFromDelivery` RemoveParcelFromDeliveryDraft	Maps to `Order.removeParcelFromDelivery`
`setDeliveryAddress` DeliveryAddressDraft	Maps to `Order.addressDraft`
`setParcelMeasurements` ParcelMeasurementDraft	Maps to `Order.parcelMeasurements`
`setParcelTrackingData` ParcelTrackingData	Maps to `Order.parcelTrackingData`
`setParcelItems` Array of ParcelItems	Maps to `Order.parcelItems`

ReturnInfo

`items` Array of ReturnItemDraft	Information on the Line Items or Custom Line Items returned.
`returnTrackingId` String	User-defined identifier to track the return.
`returnDate` DateTime	Date and time (UTC) the return is initiated.

DeliveryParcel

`deliveryId` String	Unique identifier of the Delivery.
`measurements` ParcelMeasurements	Information about the dimensions of the Parcel.
`trackingData` TrackingData	Shipment tracking information of the Parcel.
`items` Array of DeliveryItem	Line Items or Custom Line Items delivered in this Parcel.

DeliveryItem

`id` String	`id` of the LineItem or CustomLineItem delivered.
`quantity` Int	Number of Line Items or Custom Line Items delivered.

DeliveryDraft

`items` Array of DeliveryItem	Line Items or Custom Line Items to deliver. It can also be specified individually for each Parcel.
`address` Address	Address to which the Parcels are delivered.
`parcels` Array of DeliveryParcelDraft	Information regarding the appearance, content, and shipment of a parcel.

DeliveryParcelDraft

`measurements` ParcelMeasurements	Information about the dimensions for the Parcel.
`trackingData` TrackingData	Shipment tracking information for the Parcel.
`items` Array of DeliveryItem	Line Items or Custom Line Items delivered in this Parcel.

DeliveryAddressDraft

`deliveryId` String	Unique identifier of the Delivery.
`address` Address	Address to which Parcels are delivered.

ParcelMeasurement

`heightInMillimeter` Int	Height of the Parcel.
`lengthInMillimeter` Int	Length of the Parcel.
`widthInMillimeter` Int	Width of the Parcel.
`weightInGram` Int	Weight of the Parcel.

ParcelMeasurementDraft

`parcelId` String	`id` of an existing Parcel.
`measurements` ParcelMeasurements	Information about the dimensions of the Parcel.

ParcelTrackingData

`parcelId` String	`id` of an existing Parcel.
`trackingData` TrackingData	Information that helps track a Parcel.

TrackingData

`trackingId` String	Identifier to track the Parcel.
`carrier` String	Name of the carrier that delivers the Parcel.
`provider` String	Name of the provider that serves as facade to several carriers.
`providerTransaction` String	Transaction identifier with the `provider`.
`isReturn` Boolean	If `true`, the Parcel is being returned. If `false`, the Parcel is being delivered to the customer.

ParcelItems

`parcelId` String	`id` of an existing Parcel.
`items` Array of DeliveryItem	Items in the Parcel.

RemoveDeliveryDraft

id

String

RemoveParcelFromDeliveryDraft

parcelId

String

id of the Parcel to be removed from the Delivery.

for Custom Types

TypeImport

Represents the data used to import a Type. Once imported, this data is persisted as a Type in the Project.

`key` String	User-defined unique identifier for the Type. If a Type with this `key` exists, it is updated with the imported data. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`name` LocalizedString	Maps to `Type.name`.
`description` LocalizedString	Maps to `Type.description`.
`resourceTypeIds` Array of ResourceTypeId	Maps to `Type.resourceTypeIds`. This value cannot be changed after the Type is imported. MinItems: `1`
`fieldDefinitions` Array of FieldDefinition	Maps to `Type.fieldDefinitions`.

Example: json

{
  "key": "type-key",
  "name": {
    "en": "Name of type"
  },
  "description": {
    "en": "Description of type"
  },
  "resourceTypeIds": [
    "customer"
  ],
  "fieldDefinitions": [
    {
      "type": {
        "name": "String"
      },
      "name": "exampleStringField",
      "label": {
        "en": "Example string field."
      },
      "required": false,
      "inputHint": "SingleLine"
    }
  ]
}

ResourceTypeId

IDs indicating the type of resource. Maps to Type.resourceTypeIds.

address: Address on BusinessUnit, Cart, Order, OrderEdit, Customer, and Channel
asset: Asset on Category and ProductVariant
business-unit: BusinessUnit
cart-discount: CartDiscount
category: Category
channel: Channel
customer: Customer
customer-group: CustomerGroup
custom-line-item: CustomLineItem on Cart and Order
discount-code: DiscountCode
inventory-entry: InventoryEntry
line-item: LineItem on Cart and Order, and on ShoppingListLineItem.
order: Cart and Order. When a Cart is ordered, the CustomFields need to be copied to the Order. For this reason, the Types for Carts are also valid for Orders, and hence both have the same identifier: order.
order-edit: OrderEdit
order-delivery: Delivery
order-parcel: Parcel
order-return-item: ReturnItem
payment: Payment
payment-interface-interaction: InterfaceInteraction on Payment
product-price: Embedded Price on ProductVariant
product-selection: ProductSelection
quote: Quote, QuoteRequest and StagedQuote. When a StagedQuote is created, the CustomFields will be copied from the QuoteRequest and when a Quote is created, the CustomFields will be copied from the StagedQuote. For this reason, the Types for Quotes are also valid for QuoteRequests and StagedQuotes, and hence all have the same identifier: quote.
review: Review
shipping: Shipping
shipping-method: ShippingMethod
shopping-list: ShoppingList
shopping-list-text-line-item: TextLineItem on ShoppingList
standalone-price: StandalonePrice
store: Store
transaction: Transaction on Payment

FieldDefinition

Defines a Custom Field and its meta-information. Maps to Type.FieldDefinition.

`type` FieldType	Data type of the Custom Field to define.
`name` String	Name of the Custom Field to define. Must be unique for a given ResourceTypeId. In case there is a FieldDefinition with the same `name` in another Type, both FieldDefinitions must have the same `type`. This value cannot be changed after the Type is imported. MinLength: `2`MaxLength: `36`Pattern: `^[A-Za-z0-9_-]+$`
`label` LocalizedString	A human-readable label for the field.
`required` Boolean	Defines whether the field is required to have a value. This value cannot be changed after the Type is imported.
`inputHint` TypeTextInputHint	Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType. Default: `SingleLine`

TypeTextInputHint

Provides a visual representation type for this field. It is only relevant for string-based field types like CustomFieldStringType and CustomFieldLocalizedStringType.

SingleLine: Hint for GUIs to display the field's content in a single line of text.
MultiLine: Hint for GUIs to display the field's content over multiple lines of text.

common to Import Resources

Custom Fields

The value representations of Custom Fields defined on Import Resources.

Custom

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. If the referenced Type does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced Type is created.
`fields` FieldContainer	The Custom Fields of this object.

FieldContainer

JSON object containing key-value pairs with

key being the name of the Custom Field as defined in the respective FieldDefinition
value - CustomField

Example FieldContainer with three Custom Fields of different FieldTypesjson

{
  "example-boolean-field": {
    "type": "Boolean",
    "value": true
  },
  "example-localized-string-field": {
    "type": "LocalizedString",
    "value": {
      "en": "English text",
      "es": "texto en español"
    }
  },
  "example-datetime-field": {
    "type": "DateTime",
    "value": "2018-10-14T14:00:00.000Z"
  }
}

CustomField

JSON object with two fields:

type: The name of the corresponding FieldType.
value: The actual value of the Custom Field compliant to the type, see specific types in this section.

BooleanField

A field with a boolean value.

`type` String	`"Boolean"` The type of this field.
`value` Boolean	`true` or `false`

StringField

A field with a string value.

`type` String	`"String"` The type of this field.
`value` String	A text value.

  "example-string-field": {
    "type": "String",
    "value": "Some String value"
  }

LocalizedStringField

A field with a localized string value.

`type` String	`"LocalizedString"` The type of this field.
`value` LocalizedString	A localized string.

  "example-localized-string-field": {
    "type": "LocalizedString",
    "value": {
      "en": "English text",
      "es": "texto en español"
    }
  }

EnumField

A field with an enum value.

`type` String	`"Enum"` The type of this field.
`value` String	The key of the enum value. Must be a `key` of one of the CustomFieldEnumValues defined in the CustomFieldEnumType.

  "example-enum-field": {
    "type": "Enum",
    "value": "key-of-the-enum-value"
  }

LocalizedEnumField

A field with a localized enum value.

`type` String	`"LocalizedEnum"` The type of this field.
`value` String	The key of the localized enum value. Must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType.

  "example-localized-enum-field": {
    "type": "LocalizedEnum",
    "value": "key-of-the-localized-enum-value"
  }

NumberField

A field with a number value.

`type` String	`"Number"` The type of this field.
`value` Float	A number value. Can be an integer or a floating-point number.

 "example-number-field": {
    "type": "Number",
    "value": 123
  }

MoneyField

A field with a money value.

`type` String	`"Money"` The type of this field.
`value` TypedMoney	A money value in cent precision format.

  "example-money-field": {
    "type": "Money",
    "value": {
      "type": "centPrecision",
      "currencyCode": "USD",
      "centAmount": 124500,
      "fractionDigits": 2
    }
  }

DateField

A field with a date value.

`type` String	`"Date"` The type of this field.
`value` Date	A date in the format `YYYY-MM-DD`.

  "example-date-field": {
    "type": "Date",
    "value": "2001-10-12"
  }

TimeField

A field with a time value.

`type` String	`"Time"` The type of this field.
`value` Time	A time value in the format `HH:mm:ss.SSS`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

  "example-time-field": {
    "type": "Time",
    "value": "14:00:00.000"
  }

DateTimeField

A field with a date time value.

`type` String	`"DateTime"` The type of this field.
`value` DateTime	A date with time in the format `YYYY-MM-DDTHH:mm:ss.SSSZ`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC.

  "example-datetime-field": {
    "type": "DateTime",
    "value": "2018-10-14T14:00:00.000Z"
  }

ReferenceField

A field with a reference value.

`type` String	`"Reference"` The type of this field.
`value` KeyReference	References a resource by key

  "example-reference-field": {
    "type": "Reference",
    "value": {
      "typeId": "product",
      "key": "key-of-a-product"
    }
  }

BooleanSetField

A field with a boolean set value.

`type` String	`"BooleanSet"` The type of this field.
`value` Array of Boolean	JSON array of boolean values without duplicates. The order of items in the array is not fixed.

  "example-set-of-boolean-field": {
    "type": "BooleanSet",
    "value": [true, false, true]
  }

StringSetField

A field with a string set value.

`type` String	`"StringSet"` The type of this field.
`value` Array of String	JSON array of strings. The order of items in the array is not fixed.

  "example-set-of-string-field": {
    "type": "StringSet",
    "value": ["Some String value 1", "Some String value 2"]
  }

LocalizedStringSetField

A field with a localized string set value.

`type` String	`"LocalizedStringSet"` The type of this field.
`value` Array of LocalizedString	JSON array of localized strings. The order of items in the array is not fixed.

  "example-set-of-localized-string-field": {
    "type": "LocalizedStringSet",
    "value": [
      {
        "en": "English text 1",
        "es": "texto en español 1"
      },
      {
        "en": "English text 2",
        "es": "texto en español 2"
      }
    ]
  }

EnumSetField

A field with an enum set value.

`type` String	`"EnumSet"` The type of this field.
`value` Array of String	JSON array of enum values, each represented by its key. Each key must match the key of a CustomFieldLocalizedEnumValue in the CustomFieldEnumType. The order of items in the array is not fixed.

  "example-set-of-enum-field": {
    "type": "Enum",
    "value": ["key-of-enum-value-1", "key-of-enum-value-2", "key-of-enum-value-3"]
  }

LocalizedEnumSetField

A field with a localized enum set value.

`type` String	`"LocalizedEnumSet"` The type of this field.
`value` Array of String	JSON array of localized enum values, each represented by its key. Each key must match the key of an CustomFieldLocalizedEnumValue in the CustomFieldLocalizedEnumType. The order of items in the array is not fixed.

  "example-set-of-localized-enum-field": {
    "type": "Enum",
    "value": ["key-of-localized-enum-value-1", "key-of-localized-enum-value-2"]
  }

NumberSetField

A field with a number value.

`type` String	`"NumberSet"` The type of this field.
`value` Array of Number	JSON array of integer or floating-point number values. The order of items in the array is not fixed.

  "example-set-of-number-field": {
    "type": "NumberSet",
    "value": [123, 456]
  }

MoneySetField

A field with a money set value.

`type` String	`"MoneySet"` The type of this field.
`value` Array of TypedMoney	JSON array of money values in cent precision format. The order of items in the array is not fixed.

  "example-set-of-money-field": {
    "type": "MoneySet",
    "value": [
      {
        "type": "centPrecision",
        "currencyCode": "USD",
        "centAmount": 124500,
        "fractionDigits": 2
      },
      {
        "type": "centPrecision",
        "currencyCode": "USD",
        "centAmount": 1000,
        "fractionDigits": 2
      }
    ]
  }

DateSetField

A field with a date set value.

`type` String	`"DateSet"` The type of this field.
`value` Array of Date-only	JSON array of date values in the format `YYYY-MM-DD` without duplicates. The order of items in the array is not fixed.

  "example-set-of-date-field": {
    "type": "DateSet",
    "value": ["2001-10-12", "2001-10-13"]
  }

TimeSetField

A field with a time set value.

`type` String	`"TimeSet"` The type of this field.
`value` Array of Time-only	JSON array of time values in the format `HH:mm:ss.SSS`. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC. The order of items in the array is not fixed.

  "example-set-of-time-field": {
    "type": "TimeSet",
    "value": ["14:00:00.000", "15:00:00.000"]
  }

DateTimeSetField

A field with a date time set value.

`type` String	`"DateTimeSet"` The type of this field.
`value` Array of Datetime	JSON array of date time values in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` without duplicates. The time zone is optional and defaults to UTC if not specified. If the time zone is specified, it must be in the format `±HH:mm` or `Z` for UTC. The order of items in the array is not fixed.

  "example-set-of-datetime-field": {
    "type": "DateTimeSet",
    "value": ["2018-10-14T14:00:00.000Z", "2018-10-14T15:00:00.000Z"]
  }

ReferenceSetField

A field with a reference set value.

`type` String	`"ReferenceSet"` The type of this field.
`value` Array of KeyReference	JSON array of references, each referencing an existing resource by key. The order of items in the array is not fixed.

  "example-set-of-reference-field": {
    "type": "ReferenceSet",
    "value": [
      {
        "typeId": "product",
        "key": "key-of-a-product"
      },
      {
        "typeId": "product",
        "key": "key-of-a-product"
      }
    ]
  }

References

KeyReference

References a resource by key.

`key` String	User-defined unique identifier of the referenced resource. If the referenced resource does not exist, the `state` of the ImportOperation will be set to `unresolved` until the referenced resource is created. MinLength: `2`MaxLength: `256`Pattern: `^[A-Za-z0-9_-]+$`
`typeId` ReferenceType	Type of referenced resource.

ReferenceType

Type of referenced resource.

cart: References a cart.
cart-discount: References a cart discount.
category: References a category.
channel: References a channel.
customer: References a customer.
customer-group: References a customer group.
discount-code: References a discount code.
key-value-document: References a custom object
order: References an order.
payment: References a payment
price: References a price.
product: References a product.
product-discount: References a product discount.
product-type: References a product type.
product-variant: References a product variant.
shipping-method: References a shipping method.
state: References a state.
store: References a store.
tax-category: References a tax-category.
type: References a type.

Import Resources

for Categories.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CategoryImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Customers.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CustomerImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CustomerAddress.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Discount Codes.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DiscountCodeImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Inventory.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

InventoryImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Product Types.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductTypeImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Products.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductDraftImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductVariantDraftImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

EmbeddedPriceDraftImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Product Variants.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductVariantImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

Attribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

BooleanAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

BooleanSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DateAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DateSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DateTimeAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DateTimeSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

EnumAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

EnumSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LocalizableEnumAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LocalizableEnumSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LocalizableTextAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LocalizableTextSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

MoneyAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

MoneySetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

NumberAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

NumberSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ReferenceAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ReferenceSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TextAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TextSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TimeAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TimeSetAttribute.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductVariantPatch.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Product Selections.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductSelectionImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ProductSelectionAssignment.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

VariantSelectionType.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Prices.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

EmbeddedPriceImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

StandalonePriceImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Orders.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

OrderImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LineItemImportDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

CustomLineItemDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LineItemProductVariantImportDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

LineItemPrice.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DiscountedPrice.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DiscountedLineItemPriceDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ShippingInfoImportDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

OrderPatchImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

OrderField.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ReturnInfo.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeliveryParcel.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeliveryItem.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeliveryDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeliveryParcelDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

DeliveryAddressDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ParcelMeasurement.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ParcelMeasurementDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ParcelTrackingData.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TrackingData.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ParcelItems.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

RemoveDeliveryDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

RemoveParcelFromDeliveryDraft.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Custom Types.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TypeImport.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

ResourceTypeId.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

FieldDefinition.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

TypeTextInputHint.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

common to Import Resources.css-c0cbbx{display:inline-block;}.css-c0cbbx >:disabled{pointer-events:none;}.css-ik49mw{-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;}.css-ik49mw *:not([fill='none']){fill:inherit;}.css-ik49mw,.css-ik49mw image{width:24px;height:24px;}

for Categories

CategoryImport

for Customers

CustomerImport

CustomerAddress

for Discount Codes

DiscountCodeImport

for Inventory

InventoryImport

for Product Types

ProductTypeImport

for Products

ProductImport

ProductDraftImport

ProductVariantDraftImport

EmbeddedPriceDraftImport

for Product Variants

ProductVariantImport

Attribute

BooleanAttribute

BooleanSetAttribute

DateAttribute

DateSetAttribute

DateTimeAttribute

DateTimeSetAttribute

EnumAttribute

EnumSetAttribute

LocalizableEnumAttribute

LocalizableEnumSetAttribute

LocalizableTextAttribute

LocalizableTextSetAttribute

MoneyAttribute

MoneySetAttribute

NumberAttribute

NumberSetAttribute

ReferenceAttribute

ReferenceSetAttribute

TextAttribute

TextSetAttribute

TimeAttribute

TimeSetAttribute

ProductVariantPatch

for Product Selections

ProductSelectionImport

ProductSelectionAssignment

VariantSelectionType

for Prices

EmbeddedPriceImport

StandalonePriceImport

for Orders

OrderImport

LineItemImportDraft

CustomLineItemDraft

LineItemProductVariantImportDraft

LineItemPrice

DiscountedPrice

DiscountedLineItemPriceDraft

ShippingInfoImportDraft

OrderPatchImport

OrderField

ReturnInfo

DeliveryParcel

DeliveryItem

DeliveryDraft

DeliveryParcelDraft

DeliveryAddressDraft

ParcelMeasurement

ParcelMeasurementDraft

ParcelTrackingData

TrackingData

ParcelItems

RemoveDeliveryDraft

RemoveParcelFromDeliveryDraft

for Custom Types

TypeImport

ResourceTypeId

FieldDefinition

TypeTextInputHint

common to Import Resources

Custom Fields