# Functions
No description provided by the author
NewClient creates a new client based on the provided ClientConfig.
NewDate initializes a Date struct.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Version identifies the current library version.
# Variables
No description provided by the author
# Structs
*
* This is the generic error code for access denied.
No description provided by the author
No description provided by the author
*
* The width and height of the Asset Source.
*
* An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* This type represents an attribute whose value is either "true" or "false".
*
* A field with a boolean value.
*
* This type represents an attribute whose value is set of boolean values.
*
* A field with a boolean set value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* References a cart discount by key.
*
* References a cart by key.
*
* The data representation for a Category to be imported that is persisted as a [Category](/../api/projects/categories#category) in the Project.
*
* The request body to [import Categories](#import-categories).
*
* References a category by key.
*
* References a channel by key.
No description provided by the author
No description provided by the author
No description provided by the author
*
* The request conflicts with the current state of the involved resources.
No description provided by the author
*
* The representation to be sent to the server when creating a resource with Custom Fields.
*
* Different from Address in that `key` is required and `id` is not supported.
*
* References a customer group by key.
*
* The data representation for a Customer to be imported that is persisted as a [Customer](/../api/projects/customers#top) in the Project.
*
* The request body to [import Customers](#import-customers).
*
* References a customer by key.
*
* Field type for Boolean values.
*
* Field type for [DateTime](ctp:import:type:DateTime) values.
*
* Field type for [Date](ctp:import:type:Date) values.
*
* Field type for enum values.
*
* Defines an allowed value of a [CustomFieldEnumType](ctp:import:type:CustomFieldEnumType) field.
*
* Field type for localized enum values.
*
* Defines an allowed value of a [CustomFieldLocalizedEnumType](ctp:import:type:CustomFieldLocalizedEnumType) field.
*
* Field type for [LocalizedString](ctp:import:type:LocalizedString) values.
*
* Field type for [CentPrecisionMoney](ctp:import:type:CentPrecisionMoney) values.
*
* Field type for number values.
*
* Field type for [Reference](ctp:import:type:Reference) values.
*
* Values of a SetType Custom Field are sets of values of the specified `elementType` (without duplicate elements).
*
* Field type for string values.
*
* Field type for [Time](ctp:import:type:Time) values.
No description provided by the author
No description provided by the author
*
* References a key value document by key.
No description provided by the author
Date holds date information for Commercetools API format.
*
* This type represents an attribute whose value is a date.
*
* A field with a date value.
*
* This type represents an attribute whose value is a set of dates.
*
* A field with a date set value.
*
* This type represents an attribute whose value is a date with time.
*
* A field with a date time value.
*
* This type represents an attribute whose value is a set of dates with time.
*
* A field with a date time set value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* The data representation for a Discount Code to be imported that is persisted as a [Discount Code](/../api/projects/discountCodes#discountcode) in the Project.
*
* The request body to [import Discount Codes](#import-discount-codes).
No description provided by the author
*
* References a discount code by key.
No description provided by the author
No description provided by the author
No description provided by the author
*
* The `Unique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated.
*
* The `CombinationUnique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated.
*
* The given value already exists for a field that is checked for unique values.
*
* The given combination of values of a [Product Variant](/../api/projects/products#productvariant) conflicts with an existing one.
*
* This type represents an attribute whose value is an enum.
*
* A field with an enum value.
*
* This type represents an attribute whose value is an enum.
*
* A field with an enum set value.
No description provided by the author
*
* The response in case of an error.
No description provided by the author
*
* Defines a [Custom Field](/../api/projects/custom-fields) and its meta-information.
No description provided by the author
No description provided by the author
No description provided by the author
*
* An Image uploaded to commercetools Composable Commerce is stored in a Content Delivery Network and it's available in several pre-defined sizes.
*
* Serves as the entry point of resources.
*
* The representation sent to the server when creating an [ImportContainer](#importcontainer).
*
* [PagedQueryResult](/../api/general-concepts#pagedqueryresult) for [ImportContainers](#importcontainer).
*
* The representation sent to the server when updating an import container.
*
* Import Operation describes the import status of a specific resource.
*
* [PagedQueryResult](/../api/general-concepts#pagedqueryresult) for Import Operations.
No description provided by the author
*
* A representation of the resource to import.
*
* A list of the ID's and validation statuses of newly created [ImportOperations](#importoperation).
*
* Describes the status of an [ImportContainer](/import-container#importcontainer) by the number of resources in each [Processing State](/processing-state#processingstate).
No description provided by the author
No description provided by the author
*
* A given field is not supported.
*
* Returned when a field cannot be updated.
*
* An invalid input has been sent to the service.
*
* An invalid JSON input has been sent to the service.
*
* The resources in the request are not in the valid state for the operation.
*
* The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
No description provided by the author
No description provided by the author
*
* The data representation for an Inventory to be imported that is persisted as a [Inventory](/../api/projects/inventory#top) in the Project.
*
* The request body to [import Inventories](#import-inventory).
No description provided by the author
*
* The item's shipping target.
*
* The item's state.
*
* Represents an individual Line Item in an Order.
No description provided by the author
No description provided by the author
*
* This type represents an attribute whose value is a localized enum.
*
* This type represents an attribute whose value is a localized enum.
*
* This type represents an attribute whose value is a localized text.
*
* This type represents an attribute whose value is a localized text.
*
* A field with a localized enum value.
*
* A field with a localized enum set value.
No description provided by the author
*
* A field with a localized string value.
*
* A field with a localized string set value.
No description provided by the author
*
* This type represents an attribute whose value is a money object.
*
* A field with a money value.
*
* This type represents an attribute whose value is a set of money objects.
*
* A field with a money set value.
*
* This type represents an attribute whose value is a number.
*
* A field with a number value.
*
* This type represents an attribute whose value is a set of numbers.
*
* A field with a number value.
*
* The number of resources in each [Processing State](/processing-state#processingstate).
*
* Order fields that needs to be added or updated.
*
* The data representation for an Order to be imported that is persisted as an [Order](/../api/projects/orders#top) in the Project.
*
* The request body to [import Orders](#import-orders).
*
* References an order by key.
*
* Representation for an update of an [Order](/../api/projects/orders#order).
*
* The request body to [import OrderPatches](#import-orderpatches).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* References a payment by key.
*
* The representation of a Price Draft for the import purpose.
*
* The data representation for a price to be imported that is persisted as a [Price](/../api/types#price) in the Project.
*
* The request body to [import Embedded Prices](#import-embedded-prices).
*
* References a price by key.
*
* A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
*
* References a product discount by key.
*
* The representation of a Product Draft for the import purpose.
*
* The request body to [import ProductDrafts](#import-productdrafts).
*
* The data representation for a Product to be imported that is persisted as a [Product](/../api/projects/products#product) in the Project.
*
* The request body to [import Products](#import-products).
*
* References a product by key.
*
* The data representation for a ProductType to be imported that is persisted as a [ProductType](/../api/projects/productTypes#producttype) in the Project.
*
* The request body to [import ProductTypes](#import-producttypes).
*
* References a product type by key.
*
* The representation of a Product Variant Draft for the import purpose.
*
* The data representation for a ProductVariant to be imported that is persisted as a [ProductVariant](/../api/projects/products#productvariant) in the Project.
*
* The request body to [import ProductVariants](#import-productvariants).
*
* References a product variant by key.
*
* Representation for an update of a [ProductVariant](/../api/projects/products#productvariant).
*
* The request body to [import ProductVariantPatches](#import-productvariantpatches).
*
* This type represents an attribute whose value is a key reference.
*
* Returned when a resource referenced by a [Reference](/../api/types#reference) or a [ResourceIdentifier](/../api/types#resourceidentifier) could not be found.
*
* A field with a reference value.
*
* This type represents an attribute whose value is a set of references.
*
* A field with a reference set value.
No description provided by the author
No description provided by the author
*
* A required field is missing a value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
*
* Maps to an order's `shippingInfo` property.
*
* References a shipping method by key.
No description provided by the author
*
* The data representation for a Standalone Price to be imported that is persisted as a [Standalone Price](/../api/projects/standalone-prices#standaloneprice) in the Project.
*
* The request body to [import Standalone Prices](#import-standalone-prices).
*
* References a state by key.
*
* References a store by key.
*
* A field with a string value.
*
* A field with a string set value.
No description provided by the author
No description provided by the author
*
* References a tax category by key.
No description provided by the author
No description provided by the author
No description provided by the author
*
* This type represents an attribute whose value is a string.
*
* This type represents an attribute whose value is a set of strings.
*
* This type represents an attribute whose value is a time.
*
* A field with a time value.
*
* This type represents an attribute whose value is a set of times.
*
* A field with a time set value.
No description provided by the author
*
* The data representation for a Type to be imported that is persisted as a [Type](/../api/projects/types#type) in the Project.
*
* The request body to [import Types](#import-types).
*
* References a type by key.
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
*
* This type represents the value of an attribute of a product variant.
No description provided by the author
*
* Provides the value for a Custom Field of a specific type.
No description provided by the author
No description provided by the author
No description provided by the author
*
* An import request batches multiple import resources of the same import resource type for processing by an import container.
*
* References a resource by key.
No description provided by the author
No description provided by the author
*
* The tokenizer defines the tokens that are used to match against the [Suggest Query](/../products-suggestions#query-suggestions) input.
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
*
* Maps to `Order.origin`.
*
* Defines which resource type a [CustomFieldReferenceType](ctp:import:type:CustomFieldReferenceType) can reference.
*
* Maps to `DiscountCodeInfo.state`
*/.
*
* Maps the Custom Field names to actual values.
*
* Describes the validation state of a newly created [ImportOperation](#importoperation).
*
* The resource types that can be imported.
*
* Maps to `Order.inventoryMode`.
*
* A localized string is a JSON object where the keys are of [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), and the values the corresponding strings used for that language.
No description provided by the author
*
* Maps to `Order.orderState`.
*
* Maps to `Order.paymentState`.
*
* Every [Import Operation](/import-operation) is assigned one of the following states.
No description provided by the author
*
* The type of the referenced resource.
*
* IDs indicating the [customizable resources and data types](/../api/projects/types#list-of-customizable-data-types).
*
* Maps to `ReturnItem.shipmentState`
*/.
*
* Maps to `Order.taxRoundingMode`.
*
* Search keywords are primarily used by the suggester but are also considered for the full-text search.
*
* Maps to `Order.shipmentState`.
No description provided by the author
No description provided by the author
No description provided by the author
*
* Maps to `Order.taxCalculationMode`.
*
* Maps to `Order.taxMode`
*/.
No description provided by the author
*
* Provides a visual representation type for this field.