commercetools.configuration
Module commercetools.configuration
API
Definitions
ballerinax/commercetools.configuration Ballerina library
Overview
This is a generated connector for Commercetools API v1 OpenAPI specification.
The commercetools Platform - Configuration API offers an interface for programmatic access to retrieve certain information on projects, API-clients,channels, stores and state machines.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an OAuth2 client credentials by following this guide.
Clients
commercetools.configuration: Client
This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform - Configuration API offers an interface for programmatic access to retrieve certain information on projects, API-clients, channels, stores and state machines.
Constructor
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getProject
The Endpoint is responding a limited set of information about settings and configuration of the project.
Parameters
- projectKey string -
updateProject
function updateProject(string projectKey, ProjectUpdate payload) returns Project|error
Update project
getApiClientsByProjectKey
function getApiClientsByProjectKey(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ApiClientPagedQueryResponse|error
Parameters
- projectKey string -
- expand Expansion[]? (default ()) -
- sort Sort[]? (default ()) -
- 'limit decimal? (default ()) -
- offset decimal? (default ()) -
- withTotal boolean? (default ()) -
- 'where QueryPredicate[]? (default ()) -
- varAZaZ09 string[]? (default ()) -
Return Type
updateApiClientsByProjectKey
function updateApiClientsByProjectKey(string projectKey, ApiClientDraft payload, Expansion[]? expand) returns ApiClient|error
getApiClientsByProjectKeyByID
deleteApiClientsByProjectKeyByID
getKeyChannelsByProjectByID
function getKeyChannelsByProjectByID(string projectKey, string id, Expansion[]? expand) returns Channel|error
updateKeyChannelsByProjectByID
function updateKeyChannelsByProjectByID(string projectKey, string id, ChannelUpdate payload, Expansion[]? expand) returns Channel|error
Parameters
- projectKey string -
- id string -
- payload ChannelUpdate -
- expand Expansion[]? (default ()) -
deleteKeyChannelsByProjectByID
function deleteKeyChannelsByProjectByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns Channel|error
queryChannels
function queryChannels(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ChannelPagedQueryResponse|error
Parameters
- projectKey string -
- expand Expansion[]? (default ()) -
- sort Sort[]? (default ()) -
- 'limit decimal? (default ()) -
- offset decimal? (default ()) -
- withTotal boolean? (default ()) -
- 'where QueryPredicate[]? (default ()) -
- varAZaZ09 string[]? (default ()) -
Return Type
byProjectKeyChannelsPost
function byProjectKeyChannelsPost(string projectKey, ChannelDraft payload, Expansion[]? expand) returns Channel|error
getStatesByID
updateStateByID
function updateStateByID(string projectKey, string id, StateUpdate payload, Expansion[]? expand) returns State|error
deleteStateByID
function deleteStateByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns State|error
getStateByKey
updateStateByKey
function updateStateByKey(string projectKey, string 'key, StateUpdate payload, Expansion[]? expand) returns State|error
Parameters
- projectKey string -
- 'key string -
- payload StateUpdate -
- expand Expansion[]? (default ()) -
deleteStateByKey
function deleteStateByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns State|error
queryStates
function queryStates(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns StatePagedQueryResponse|error
Parameters
- projectKey string -
- expand Expansion[]? (default ()) -
- sort Sort[]? (default ()) -
- 'limit decimal? (default ()) -
- offset decimal? (default ()) -
- withTotal boolean? (default ()) -
- 'where QueryPredicate[]? (default ()) -
- varAZaZ09 string[]? (default ()) -
Return Type
- StatePagedQueryResponse|error - 200
createState
function createState(string projectKey, StateDraft payload, Expansion[]? expand) returns State|error
queryStores
function queryStores(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns StorePagedQueryResponse|error
Parameters
- projectKey string -
- expand Expansion[]? (default ()) -
- sort Sort[]? (default ()) -
- 'limit decimal? (default ()) -
- offset decimal? (default ()) -
- withTotal boolean? (default ()) -
- 'where QueryPredicate[]? (default ()) -
- varAZaZ09 string[]? (default ()) -
Return Type
- StorePagedQueryResponse|error - 200
createStore
function createStore(string projectKey, StoreDraft payload, Expansion[]? expand) returns Store|error
getStoreByKey
updateStoreByKey
function updateStoreByKey(string projectKey, string 'key, StoreUpdate payload, Expansion[]? expand) returns Store|error
Parameters
- projectKey string -
- 'key string -
- payload StoreUpdate -
- expand Expansion[]? (default ()) -
deleteStoreByKey
function deleteStoreByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns Store|error
getStoreByID
updateStoreByID
function updateStoreByID(string projectKey, string id, StoreUpdate payload, Expansion[]? expand) returns Store|error
deleteStoreByID
Records
commercetools.configuration: AccessDeniedError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
commercetools.configuration: Address
Fields
- Fields Included from *BaseAddress
- id string
- key string
- title string
- salutation string
- firstName string
- lastName string
- streetName string
- streetNumber string
- additionalStreetInfo string
- postalCode string
- city string
- region string
- state string
- country CountryCode
- company string
- department string
- building string
- apartment string
- pOBox string
- phone string
- mobile string
- email string
- fax string
- additionalAddressInfo string
- externalId string
- anydata...
- id string? -
- 'key string? -
- title string? -
- salutation string? -
- firstName string? -
- lastName string? -
- streetName string? -
- streetNumber string? -
- additionalStreetInfo string? -
- postalCode string? -
- city string? -
- region string? -
- state string? -
- country CountryCode? -
- company string? -
- department string? -
- building string? -
- apartment string? -
- pOBox string? -
- phone string? -
- mobile string? -
- email string? -
- fax string? -
- additionalAddressInfo string? -
- externalId string? -
- custom CustomFields? -
commercetools.configuration: AddressDraft
Fields
- Fields Included from *BaseAddress
- id string
- key string
- title string
- salutation string
- firstName string
- lastName string
- streetName string
- streetNumber string
- additionalStreetInfo string
- postalCode string
- city string
- region string
- state string
- country CountryCode
- company string
- department string
- building string
- apartment string
- pOBox string
- phone string
- mobile string
- email string
- fax string
- additionalAddressInfo string
- externalId string
- anydata...
- id string? -
- 'key string? -
- title string? -
- salutation string? -
- firstName string? -
- lastName string? -
- streetName string? -
- streetNumber string? -
- additionalStreetInfo string? -
- postalCode string? -
- city string? -
- region string? -
- state string? -
- country CountryCode? -
- company string? -
- department string? -
- building string? -
- apartment string? -
- pOBox string? -
- phone string? -
- mobile string? -
- email string? -
- fax string? -
- additionalAddressInfo string? -
- externalId string? -
- custom CustomFieldsDraft? -
commercetools.configuration: AnonymousIdAlreadyInUseError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
commercetools.configuration: ApiClient
Fields
- id string? -
- name string? -
- scope string? -
- secret string? -
- lastUsedAt string? -
- deleteAt string? -
- createdAt string? -
commercetools.configuration: ApiClientDraft
Fields
- name string? -
- scope string? -
- deleteDaysAfterCreation int? -
commercetools.configuration: ApiClientPagedQueryResponse
Fields
- 'limit int? -
- offset int? -
- count int? -
- total int? -
- results ApiClient[]? -
commercetools.configuration: Asset
Fields
- id string? -
- sources AssetSource[]? -
- name LocalizedString? -
- description LocalizedString? -
- tags string[]? -
- custom CustomFields? -
- 'key string? -
commercetools.configuration: AssetDimensions
Fields
- w int? -
- h int? -
commercetools.configuration: AssetDraft
Fields
- sources AssetSource[]? -
- name LocalizedString? -
- description LocalizedString? -
- tags string[]? -
- custom CustomFieldsDraft? -
- 'key string? -
commercetools.configuration: AssetSource
Fields
- uri string? -
- 'key string? -
- dimensions AssetDimensions? -
- contentType string? -
commercetools.configuration: AssignedProductReference
Fields
- product ProductReference? -
commercetools.configuration: Attribute
Fields
- name string? -
commercetools.configuration: AttributeBooleanType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeDateTimeType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeDateType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeDefinition
Fields
- 'type AttributeType? -
- name string? -
- label LocalizedString? -
- isRequired boolean? -
- attributeConstraint AttributeConstraintEnum? -
- inputTip LocalizedString? -
- inputHint TextInputHint? -
- isSearchable boolean? -
commercetools.configuration: AttributeDefinitionAlreadyExistsError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
- conflictingProductTypeId string? -
- conflictingProductTypeName string? -
- conflictingAttributeName string? -
commercetools.configuration: AttributeDefinitionDraft
Fields
- 'type AttributeType? -
- name string? -
- label LocalizedString? -
- isRequired boolean? -
- attributeConstraint AttributeConstraintEnum? -
- inputTip LocalizedString? -
- inputHint TextInputHint? -
- isSearchable boolean? -
commercetools.configuration: AttributeDefinitionTypeConflictError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
- conflictingProductTypeId string? -
- conflictingProductTypeName string? -
- conflictingAttributeName string? -
commercetools.configuration: AttributeEnumType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
- values AttributePlainEnumValue[]? -
commercetools.configuration: AttributeLocalizableTextType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeLocalizedEnumType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
- values AttributeLocalizedEnumValue[]? -
commercetools.configuration: AttributeLocalizedEnumValue
Fields
- 'key string? -
- label LocalizedString? -
commercetools.configuration: AttributeMoneyType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeNameDoesNotExistError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
- invalidAttributeName string? -
commercetools.configuration: AttributeNestedType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
- typeReference ProductTypeReference? -
commercetools.configuration: AttributeNumberType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributePlainEnumValue
Fields
- 'key string? -
- label string? -
commercetools.configuration: AttributeReferenceType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
- referenceTypeId ReferenceTypeId? -
commercetools.configuration: AttributeSetType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
- elementType AttributeType? -
commercetools.configuration: AttributeTextType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeTimeType
Fields
- Fields Included from *AttributeType
- name string
- anydata...
- name string? -
commercetools.configuration: AttributeType
Fields
- name string? -
commercetools.configuration: AzureEventGridDestination
Fields
- Fields Included from *Destination
- type string
- anydata...
- 'type string? -
- uri string? -
- accessKey string? -
commercetools.configuration: AzureServiceBusDestination
Fields
- Fields Included from *Destination
- type string
- anydata...
- 'type string? -
- connectionString string? -
commercetools.configuration: BadGatewayError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
commercetools.configuration: BaseAddress
Fields
- id string? -
- 'key string? -
- title string? -
- salutation string? -
- firstName string? -
- lastName string? -
- streetName string? -
- streetNumber string? -
- additionalStreetInfo string? -
- postalCode string? -
- city string? -
- region string? -
- state string? -
- country CountryCode? -
- company string? -
- department string? -
- building string? -
- apartment string? -
- pOBox string? -
- phone string? -
- mobile string? -
- email string? -
- fax string? -
- additionalAddressInfo string? -
- externalId string? -
commercetools.configuration: BaseResource
Fields
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
commercetools.configuration: Cart
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- 'key string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- customerId string? -
- customerEmail string? -
- anonymousId string? -
- store StoreKeyReference? -
- lineItems LineItem[]? -
- customLineItems CustomLineItem[]? -
- totalPrice TypedMoney? -
- taxedPrice TaxedPrice? -
- cartState CartState? -
- shippingAddress Address? -
- billingAddress Address? -
- inventoryMode InventoryMode? -
- taxMode TaxMode? -
- taxRoundingMode RoundingMode? -
- taxCalculationMode TaxCalculationMode? -
- customerGroup CustomerGroupReference? -
- country CountryCode? -
- shippingInfo ShippingInfo? -
- discountCodes DiscountCodeInfo[]? -
- custom CustomFields? -
- paymentInfo PaymentInfo? -
- locale string? -
- deleteDaysAfterLastModification int? -
- refusedGifts CartDiscountReference[]? -
- origin CartOrigin? -
- shippingRateInput ShippingRateInput? -
- itemShippingAddresses Address[]? -
commercetools.configuration: CartAddCustomLineItemAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- money Money? -
- name LocalizedString? -
- quantity int? -
- slug string? -
- taxCategory TaxCategoryResourceIdentifier? -
- custom CustomFieldsDraft? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartAddDiscountCodeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- code string? -
commercetools.configuration: CartAddItemShippingAddressAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: CartAddLineItemAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- custom CustomFieldsDraft? -
- distributionChannel ChannelResourceIdentifier? -
- externalTaxRate ExternalTaxRateDraft? -
- productId string? -
- variantId int? -
- sku string? -
- quantity int? -
- supplyChannel ChannelResourceIdentifier? -
- externalPrice Money? -
- externalTotalPrice ExternalLineItemTotalPrice? -
- shippingDetails ItemShippingDetailsDraft? -
commercetools.configuration: CartAddPaymentAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- payment PaymentResourceIdentifier? -
commercetools.configuration: CartAddShoppingListAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- shoppingList ShoppingListResourceIdentifier? -
- supplyChannel ChannelResourceIdentifier? -
- distributionChannel ChannelResourceIdentifier? -
commercetools.configuration: CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- targetsDelta ItemShippingTarget[]? -
commercetools.configuration: CartApplyDeltaToLineItemShippingDetailsTargetsAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- targetsDelta ItemShippingTarget[]? -
commercetools.configuration: CartChangeCustomLineItemMoneyAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- money Money? -
commercetools.configuration: CartChangeCustomLineItemQuantityAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- quantity int? -
commercetools.configuration: CartChangeLineItemQuantityAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- quantity int? -
- externalPrice Money? -
- externalTotalPrice ExternalLineItemTotalPrice? -
commercetools.configuration: CartChangeTaxCalculationModeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- taxCalculationMode TaxCalculationMode? -
commercetools.configuration: CartChangeTaxModeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- taxMode TaxMode? -
commercetools.configuration: CartChangeTaxRoundingModeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- taxRoundingMode RoundingMode? -
commercetools.configuration: CartClassificationTier
Fields
- Fields Included from *ShippingRatePriceTier
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
- value string? -
- price Money? -
- isMatching boolean? -
commercetools.configuration: CartClassificationType
Fields
- Fields Included from *ShippingRateInputType
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
- values CustomFieldLocalizedEnumValue[]? -
commercetools.configuration: CartDiscount
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- name LocalizedString? -
- 'key string? -
- description LocalizedString? -
- value CartDiscountValue? -
- cartPredicate string? -
- target CartDiscountTarget? -
- sortOrder string? -
- isActive boolean? -
- validFrom string? -
- validUntil string? -
- requiresDiscountCode boolean? -
- references Reference[]? -
- stackingMode StackingMode? -
- custom CustomFields? -
commercetools.configuration: CartDiscountChangeCartPredicateAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- cartPredicate string? -
commercetools.configuration: CartDiscountChangeIsActiveAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- isActive boolean? -
commercetools.configuration: CartDiscountChangeNameAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- name LocalizedString? -
commercetools.configuration: CartDiscountChangeRequiresDiscountCodeAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- requiresDiscountCode boolean? -
commercetools.configuration: CartDiscountChangeSortOrderAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- sortOrder string? -
commercetools.configuration: CartDiscountChangeStackingModeAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- stackingMode StackingMode? -
commercetools.configuration: CartDiscountChangeTargetAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- target CartDiscountTarget? -
commercetools.configuration: CartDiscountChangeValueAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- value CartDiscountValueDraft? -
commercetools.configuration: CartDiscountCustomLineItemsTarget
Fields
- Fields Included from *CartDiscountTarget
- type string
- anydata...
- 'type string? -
- predicate string? -
commercetools.configuration: CartDiscountDraft
Fields
- name LocalizedString? -
- 'key string? -
- description LocalizedString? -
- value CartDiscountValueDraft? -
- cartPredicate string? -
- target CartDiscountTarget? -
- sortOrder string? -
- isActive boolean? -
- validFrom string? -
- validUntil string? -
- requiresDiscountCode boolean? -
- stackingMode StackingMode? -
- custom CustomFieldsDraft? -
commercetools.configuration: CartDiscountLineItemsTarget
Fields
- Fields Included from *CartDiscountTarget
- type string
- anydata...
- 'type string? -
- predicate string? -
commercetools.configuration: CartDiscountPagedQueryResponse
Fields
- 'limit int? -
- count int? -
- total int? -
- offset int? -
- results CartDiscount[]? -
commercetools.configuration: CartDiscountReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj CartDiscount? -
commercetools.configuration: CartDiscountResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- 'key string? -
commercetools.configuration: CartDiscountSetCustomFieldAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CartDiscountSetCustomTypeAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields record {}? -
commercetools.configuration: CartDiscountSetDescriptionAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- description LocalizedString? -
commercetools.configuration: CartDiscountSetKeyAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- 'key string? -
commercetools.configuration: CartDiscountSetValidFromAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- validFrom string? -
commercetools.configuration: CartDiscountSetValidFromAndUntilAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- validFrom string? -
- validUntil string? -
commercetools.configuration: CartDiscountSetValidUntilAction
Fields
- Fields Included from *CartDiscountUpdateAction
- action string
- anydata...
- action string? -
- validUntil string? -
commercetools.configuration: CartDiscountShippingCostTarget
Fields
- Fields Included from *CartDiscountTarget
- type string
- anydata...
- 'type string? -
commercetools.configuration: CartDiscountTarget
Fields
- 'type string? -
commercetools.configuration: CartDiscountUpdate
Fields
- 'version int? -
- actions CartDiscountUpdateAction[]? -
commercetools.configuration: CartDiscountUpdateAction
Fields
- action string? -
commercetools.configuration: CartDiscountValue
Fields
- 'type string? -
commercetools.configuration: CartDiscountValueAbsolute
Fields
- Fields Included from *CartDiscountValue
- type string
- anydata...
- 'type string? -
- money TypedMoney[]? -
commercetools.configuration: CartDiscountValueAbsoluteDraft
Fields
- Fields Included from *CartDiscountValueDraft
- type string
- anydata...
- 'type string? -
- money Money[]? -
commercetools.configuration: CartDiscountValueDraft
Fields
- 'type string? -
commercetools.configuration: CartDiscountValueFixed
Fields
- Fields Included from *CartDiscountValue
- type string
- anydata...
- 'type string? -
- money TypedMoney[]? -
commercetools.configuration: CartDiscountValueFixedDraft
Fields
- Fields Included from *CartDiscountValueDraft
- type string
- anydata...
- 'type string? -
- money Money[]? -
commercetools.configuration: CartDiscountValueGiftLineItem
Fields
- Fields Included from *CartDiscountValue
- type string
- anydata...
- 'type string? -
- product ProductReference? -
- variantId int? -
- supplyChannel ChannelReference? -
- distributionChannel ChannelReference? -
commercetools.configuration: CartDiscountValueGiftLineItemDraft
Fields
- Fields Included from *CartDiscountValueDraft
- type string
- anydata...
- 'type string? -
- product ProductResourceIdentifier? -
- variantId int? -
- supplyChannel ChannelResourceIdentifier? -
- distributionChannel ChannelResourceIdentifier? -
commercetools.configuration: CartDiscountValueRelative
Fields
- Fields Included from *CartDiscountValue
- type string
- anydata...
- 'type string? -
- permyriad int? -
commercetools.configuration: CartDiscountValueRelativeDraft
Fields
- Fields Included from *CartDiscountValueDraft
- type string
- anydata...
- 'type string? -
- permyriad int? -
commercetools.configuration: CartDraft
Fields
- currency CurrencyCode? -
- 'key string? -
- customerId string? -
- customerEmail string? -
- customerGroup CustomerGroupResourceIdentifier? -
- anonymousId string? -
- store StoreResourceIdentifier? -
- country string? -
- inventoryMode InventoryMode? -
- taxMode TaxMode? -
- taxRoundingMode RoundingMode? -
- taxCalculationMode TaxCalculationMode? -
- lineItems LineItemDraft[]? -
- customLineItems CustomLineItemDraft[]? -
- shippingAddress BaseAddress? -
- billingAddress BaseAddress? -
- shippingMethod ShippingMethodResourceIdentifier? -
- externalTaxRateForShippingMethod ExternalTaxRateDraft? -
- custom CustomFieldsDraft? -
- locale string? -
- deleteDaysAfterLastModification int? -
- origin CartOrigin? -
- shippingRateInput ShippingRateInputDraft? -
- itemShippingAddresses BaseAddress[]? -
- discountCodes string[]? -
commercetools.configuration: CartPagedQueryResponse
Fields
- 'limit int? -
- count int? -
- total int? -
- offset int? -
- results Cart[]? -
commercetools.configuration: CartRecalculateAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- updateProductData boolean? -
commercetools.configuration: CartReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj Cart? -
commercetools.configuration: CartRemoveCustomLineItemAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
commercetools.configuration: CartRemoveDiscountCodeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- discountCode DiscountCodeReference? -
commercetools.configuration: CartRemoveItemShippingAddressAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- addressKey string? -
commercetools.configuration: CartRemoveLineItemAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- quantity int? -
- externalPrice Money? -
- externalTotalPrice ExternalLineItemTotalPrice? -
- shippingDetailsToRemove ItemShippingDetailsDraft? -
commercetools.configuration: CartRemovePaymentAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- payment PaymentResourceIdentifier? -
commercetools.configuration: CartResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- 'key string? -
commercetools.configuration: CartsConfiguration
Fields
- countryTaxRateFallbackEnabled boolean? -
- deleteDaysAfterLastModification int? -
commercetools.configuration: CartScoreTier
Fields
- Fields Included from *ShippingRatePriceTier
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
- score decimal? -
- price Money? -
- priceFunction PriceFunction? -
- isMatching boolean? -
commercetools.configuration: CartScoreType
Fields
- Fields Included from *ShippingRateInputType
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
commercetools.configuration: CartSetAnonymousIdAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- anonymousId string? -
commercetools.configuration: CartSetBillingAddressAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: CartSetBillingAddressCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CartSetBillingAddressCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetCartTotalTaxAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- externalTotalGross Money? -
- externalTaxPortions TaxPortionDraft[]? -
commercetools.configuration: CartSetCountryAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- country CountryCode? -
commercetools.configuration: CartSetCustomerEmailAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- email string? -
commercetools.configuration: CartSetCustomerGroupAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customerGroup CustomerGroupResourceIdentifier? -
commercetools.configuration: CartSetCustomerIdAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customerId string? -
commercetools.configuration: CartSetCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CartSetCustomLineItemCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- name string? -
commercetools.configuration: CartSetCustomLineItemCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetCustomLineItemShippingDetailsAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- shippingDetails ItemShippingDetailsDraft? -
commercetools.configuration: CartSetCustomLineItemTaxAmountAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- externalTaxAmount ExternalTaxAmountDraft? -
commercetools.configuration: CartSetCustomLineItemTaxRateAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- customLineItemId string? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartSetCustomShippingMethodAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- shippingMethodName string? -
- shippingRate ShippingRateDraft? -
- taxCategory TaxCategoryResourceIdentifier? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartSetCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetDeleteDaysAfterLastModificationAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- deleteDaysAfterLastModification int? -
commercetools.configuration: CartSetDeliveryAddressCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- deliveryId string? -
- name string? -
commercetools.configuration: CartSetDeliveryAddressCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- deliveryId string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetItemShippingAddressCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- addressKey string? -
- name string? -
commercetools.configuration: CartSetItemShippingAddressCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- addressKey string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetKeyAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- 'key string? -
commercetools.configuration: CartSetLineItemCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- name string? -
commercetools.configuration: CartSetLineItemCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetLineItemDistributionChannelAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- distributionChannel ChannelResourceIdentifier? -
commercetools.configuration: CartSetLineItemPriceAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- externalPrice Money? -
commercetools.configuration: CartSetLineItemShippingDetailsAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- shippingDetails ItemShippingDetailsDraft? -
commercetools.configuration: CartSetLineItemSupplyChannelAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- supplyChannel ChannelResourceIdentifier? -
commercetools.configuration: CartSetLineItemTaxAmountAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- externalTaxAmount ExternalTaxAmountDraft? -
commercetools.configuration: CartSetLineItemTaxRateAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartSetLineItemTotalPriceAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- lineItemId string? -
- externalTotalPrice ExternalLineItemTotalPrice? -
commercetools.configuration: CartSetLocaleAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- locale string? -
commercetools.configuration: CartSetShippingAddressAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: CartSetShippingAddressCustomFieldAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CartSetShippingAddressCustomTypeAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CartSetShippingMethodAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- shippingMethod ShippingMethodResourceIdentifier? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartSetShippingMethodTaxAmountAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- externalTaxAmount ExternalTaxAmountDraft? -
commercetools.configuration: CartSetShippingMethodTaxRateAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- externalTaxRate ExternalTaxRateDraft? -
commercetools.configuration: CartSetShippingRateInputAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- shippingRateInput ShippingRateInputDraft? -
commercetools.configuration: CartUpdate
Fields
- 'version int? -
- actions CartUpdateAction[]? -
commercetools.configuration: CartUpdateAction
Fields
- action string? -
commercetools.configuration: CartUpdateItemShippingAddressAction
Fields
- Fields Included from *CartUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: CartValueTier
Fields
- Fields Included from *ShippingRatePriceTier
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
- minimumCentAmount int? -
- price Money? -
- isMatching boolean? -
commercetools.configuration: CartValueType
Fields
- Fields Included from *ShippingRateInputType
- type ShippingRateTierType
- anydata...
- 'type ShippingRateTierType? -
commercetools.configuration: Category
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- name LocalizedString? -
- slug LocalizedString? -
- description LocalizedString? -
- ancestors CategoryReference[]? -
- parent CategoryReference? -
- orderHint string? -
- externalId string? -
- metaTitle LocalizedString? -
- metaDescription LocalizedString? -
- metaKeywords LocalizedString? -
- custom CustomFields? -
- assets Asset[]? -
- 'key string? -
commercetools.configuration: CategoryAddAssetAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- asset AssetDraft? -
- position int? -
commercetools.configuration: CategoryChangeAssetNameAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- name LocalizedString? -
commercetools.configuration: CategoryChangeAssetOrderAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetOrder string[]? -
commercetools.configuration: CategoryChangeNameAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- name LocalizedString? -
commercetools.configuration: CategoryChangeOrderHintAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- orderHint string? -
commercetools.configuration: CategoryChangeParentAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- parent CategoryResourceIdentifier? -
commercetools.configuration: CategoryChangeSlugAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- slug LocalizedString? -
commercetools.configuration: CategoryCreatedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- category Category? -
commercetools.configuration: CategoryCreatedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- category Category? -
commercetools.configuration: CategoryDraft
Fields
- name LocalizedString? -
- slug LocalizedString? -
- description LocalizedString? -
- parent CategoryResourceIdentifier? -
- orderHint string? -
- externalId string? -
- metaTitle LocalizedString? -
- metaDescription LocalizedString? -
- metaKeywords LocalizedString? -
- custom CustomFieldsDraft? -
- assets AssetDraft[]? -
- 'key string? -
commercetools.configuration: CategoryOrderHints
commercetools.configuration: CategoryPagedQueryResponse
Fields
- 'limit int? -
- count int? -
- total int? -
- offset int? -
- results Category[]? -
commercetools.configuration: CategoryReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj Category? -
commercetools.configuration: CategoryRemoveAssetAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
commercetools.configuration: CategoryResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- 'key string? -
commercetools.configuration: CategorySetAssetCustomFieldAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- name string? -
commercetools.configuration: CategorySetAssetCustomTypeAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- 'type TypeResourceIdentifier? -
- fields record {}? -
commercetools.configuration: CategorySetAssetDescriptionAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- description LocalizedString? -
commercetools.configuration: CategorySetAssetKeyAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
commercetools.configuration: CategorySetAssetSourcesAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- sources AssetSource[]? -
commercetools.configuration: CategorySetAssetTagsAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- assetId string? -
- assetKey string? -
- tags string[]? -
commercetools.configuration: CategorySetCustomFieldAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CategorySetCustomTypeAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CategorySetDescriptionAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- description LocalizedString? -
commercetools.configuration: CategorySetExternalIdAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- externalId string? -
commercetools.configuration: CategorySetKeyAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- 'key string? -
commercetools.configuration: CategorySetMetaDescriptionAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- metaDescription LocalizedString? -
commercetools.configuration: CategorySetMetaKeywordsAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- metaKeywords LocalizedString? -
commercetools.configuration: CategorySetMetaTitleAction
Fields
- Fields Included from *CategoryUpdateAction
- action string
- anydata...
- action string? -
- metaTitle LocalizedString? -
commercetools.configuration: CategorySlugChangedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- slug LocalizedString? -
- oldSlug LocalizedString? -
commercetools.configuration: CategorySlugChangedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- slug LocalizedString? -
- oldSlug LocalizedString? -
commercetools.configuration: CategoryUpdate
Fields
- 'version int? -
- actions CategoryUpdateAction[]? -
commercetools.configuration: CategoryUpdateAction
Fields
- action string? -
commercetools.configuration: CentPrecisionMoney
Fields
- Fields Included from *TypedMoney
- type MoneyType
- fractionDigits int
- centAmount int
- currencyCode CurrencyCode
- anydata...
- 'type MoneyType? -
- fractionDigits int? -
- centAmount int? -
- currencyCode CurrencyCode? -
commercetools.configuration: CentPrecisionMoneyDraft
Fields
- Fields Included from *TypedMoneyDraft
- centAmount int
- currencyCode CurrencyCode
- type MoneyType
- fractionDigits int
- anydata...
- centAmount int? -
- currencyCode CurrencyCode? -
- 'type MoneyType? -
- fractionDigits int? -
commercetools.configuration: ChangeSubscription
Fields
- resourceTypeId string? -
commercetools.configuration: Channel
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- 'key string? -
- roles ChannelRoleEnum[]? -
- name LocalizedString? -
- description LocalizedString? -
- address Address? -
- reviewRatingStatistics ReviewRatingStatistics? -
- custom CustomFields? -
- geoLocation GeoJson? -
commercetools.configuration: ChannelAddRolesAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- roles ChannelRoleEnum[]? -
commercetools.configuration: ChannelChangeDescriptionAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- description LocalizedString? -
commercetools.configuration: ChannelChangeKeyAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- 'key string? -
commercetools.configuration: ChannelChangeNameAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- name LocalizedString? -
commercetools.configuration: ChannelDraft
Fields
- 'key string? -
- roles ChannelRoleEnum[]? -
- name LocalizedString? -
- description LocalizedString? -
- address BaseAddress? -
- custom CustomFieldsDraft? -
- geoLocation GeoJson? -
commercetools.configuration: ChannelPagedQueryResponse
Fields
- 'limit int? -
- offset int? -
- count int? -
- total int? -
- results Channel[]? -
commercetools.configuration: ChannelReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj Channel? -
commercetools.configuration: ChannelRemoveRolesAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- roles ChannelRoleEnum[]? -
commercetools.configuration: ChannelResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- 'key string? -
commercetools.configuration: ChannelSetAddressAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: ChannelSetAddressCustomFieldAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: ChannelSetAddressCustomTypeAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: ChannelSetCustomFieldAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: ChannelSetCustomTypeAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: ChannelSetGeoLocationAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- geoLocation GeoJson? -
commercetools.configuration: ChannelSetRolesAction
Fields
- Fields Included from *ChannelUpdateAction
- action string
- anydata...
- action string? -
- roles ChannelRoleEnum[]? -
commercetools.configuration: ChannelUpdate
Fields
- 'version int? -
- actions ChannelUpdateAction[]? -
commercetools.configuration: ChannelUpdateAction
Fields
- action string? -
commercetools.configuration: ClassificationShippingRateInput
Fields
- Fields Included from *ShippingRateInput
- type string
- anydata...
- 'type string? -
- 'key string? -
- label LocalizedString? -
commercetools.configuration: ClassificationShippingRateInputDraft
Fields
- Fields Included from *ShippingRateInputDraft
- type string
- anydata...
- 'type string? -
- 'key string? -
commercetools.configuration: ClientHttp1Settings
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
commercetools.configuration: ClientLogging
Fields
- clientId string? -
- externalUserId string? -
- customer CustomerReference? -
- anonymousId string? -
commercetools.configuration: ConcurrentModificationError
Fields
- Fields Included from *ErrorObject
- code string? -
- message string? -
- currentVersion int? -
commercetools.configuration: ConnectionConfig
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
commercetools.configuration: ContainerAndKey
Fields
- 'key string? -
- container string? -
commercetools.configuration: CreatedBy
Fields
- Fields Included from *ClientLogging
- clientId string
- externalUserId string
- customer CustomerReference
- anonymousId string
- anydata...
- clientId string? -
- externalUserId string? -
- customer CustomerReference? -
- anonymousId string? -
commercetools.configuration: Customer
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- customerNumber string? -
- email string? -
- password string? -
- firstName string? -
- lastName string? -
- middleName string? -
- title string? -
- dateOfBirth string? -
- companyName string? -
- vatId string? -
- addresses Address[]? -
- defaultShippingAddressId string? -
- shippingAddressIds string[]? -
- defaultBillingAddressId string? -
- billingAddressIds string[]? -
- isEmailVerified boolean? -
- externalId string? -
- customerGroup CustomerGroupReference? -
- custom CustomFields? -
- locale string? -
- salutation string? -
- 'key string? -
- stores StoreKeyReference[]? -
commercetools.configuration: CustomerAddAddressAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- address BaseAddress? -
commercetools.configuration: CustomerAddBillingAddressIdAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
commercetools.configuration: CustomerAddressAddedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- address Address? -
commercetools.configuration: CustomerAddressAddedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- address Address? -
commercetools.configuration: CustomerAddressChangedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- address Address? -
commercetools.configuration: CustomerAddressChangedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- address Address? -
commercetools.configuration: CustomerAddressRemovedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- address Address? -
commercetools.configuration: CustomerAddressRemovedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- address Address? -
commercetools.configuration: CustomerAddShippingAddressIdAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
commercetools.configuration: CustomerAddStoreAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- store StoreResourceIdentifier? -
commercetools.configuration: CustomerChangeAddressAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
- address BaseAddress? -
commercetools.configuration: CustomerChangeEmailAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- email string? -
commercetools.configuration: CustomerChangePassword
Fields
- id string? -
- 'version int? -
- currentPassword string? -
- newPassword string? -
commercetools.configuration: CustomerCompanyNameSetMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- companyName string? -
commercetools.configuration: CustomerCompanyNameSetMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- companyName string? -
commercetools.configuration: CustomerCreatedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- customer Customer? -
commercetools.configuration: CustomerCreatedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- customer Customer? -
commercetools.configuration: CustomerCreateEmailToken
Fields
- id string? -
- 'version int? -
- ttlMinutes int? -
commercetools.configuration: CustomerCreatePasswordResetToken
Fields
- email string? -
- ttlMinutes int? -
commercetools.configuration: CustomerDateOfBirthSetMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- dateOfBirth string? -
commercetools.configuration: CustomerDateOfBirthSetMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- dateOfBirth string? -
commercetools.configuration: CustomerDeletedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
commercetools.configuration: CustomerDeletedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
commercetools.configuration: CustomerDraft
Fields
- customerNumber string? -
- email string? -
- password string? -
- firstName string? -
- lastName string? -
- middleName string? -
- title string? -
- anonymousCartId string? -
- anonymousCart CartResourceIdentifier? -
- anonymousId string? -
- dateOfBirth string? -
- companyName string? -
- vatId string? -
- addresses BaseAddress[]? -
- defaultShippingAddress int? -
- shippingAddresses int[]? -
- defaultBillingAddress int? -
- billingAddresses int[]? -
- isEmailVerified boolean? -
- externalId string? -
- customerGroup CustomerGroupResourceIdentifier? -
- custom CustomFieldsDraft? -
- locale string? -
- salutation string? -
- 'key string? -
- stores StoreResourceIdentifier[]? -
commercetools.configuration: CustomerEmailChangedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- email string? -
commercetools.configuration: CustomerEmailChangedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- email string? -
commercetools.configuration: CustomerEmailVerifiedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
commercetools.configuration: CustomerEmailVerifiedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
commercetools.configuration: CustomerEmailVerify
Fields
- 'version int? -
- tokenValue string? -
commercetools.configuration: CustomerFirstNameSetMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- firstName string? -
commercetools.configuration: CustomerFirstNameSetMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- firstName string? -
commercetools.configuration: CustomerGroup
Fields
- Fields Included from *BaseResource
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- 'key string? -
- name string? -
- custom CustomFields? -
commercetools.configuration: CustomerGroupChangeNameAction
Fields
- Fields Included from *CustomerGroupUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CustomerGroupDraft
Fields
- 'key string? -
- groupName string? -
- custom CustomFieldsDraft? -
commercetools.configuration: CustomerGroupPagedQueryResponse
Fields
- 'limit int? -
- offset int? -
- count int? -
- total int? -
- results CustomerGroup[]? -
commercetools.configuration: CustomerGroupReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj CustomerGroup? -
commercetools.configuration: CustomerGroupResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- 'key string? -
commercetools.configuration: CustomerGroupSetCustomFieldAction
Fields
- Fields Included from *CustomerGroupUpdateAction
- action string
- anydata...
- action string? -
- name string? -
commercetools.configuration: CustomerGroupSetCustomTypeAction
Fields
- Fields Included from *CustomerGroupUpdateAction
- action string
- anydata...
- action string? -
- 'type TypeResourceIdentifier? -
- fields FieldContainer? -
commercetools.configuration: CustomerGroupSetKeyAction
Fields
- Fields Included from *CustomerGroupUpdateAction
- action string
- anydata...
- action string? -
- 'key string? -
commercetools.configuration: CustomerGroupSetMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- customerGroup CustomerGroupReference? -
commercetools.configuration: CustomerGroupSetMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- customerGroup CustomerGroupReference? -
commercetools.configuration: CustomerGroupUpdate
Fields
- 'version int? -
- actions CustomerGroupUpdateAction[]? -
commercetools.configuration: CustomerGroupUpdateAction
Fields
- action string? -
commercetools.configuration: CustomerLastNameSetMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- lastName string? -
commercetools.configuration: CustomerLastNameSetMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- lastName string? -
commercetools.configuration: CustomerPagedQueryResponse
Fields
- 'limit int? -
- count int? -
- total int? -
- offset int? -
- results Customer[]? -
commercetools.configuration: CustomerPasswordUpdatedMessage
Fields
- Fields Included from *Message
- id string? -
- 'version int? -
- createdAt string? -
- lastModifiedAt string? -
- lastModifiedBy LastModifiedBy? -
- createdBy CreatedBy? -
- sequenceNumber int? -
- 'resource Reference? -
- resourceVersion int? -
- 'type string? -
- resourceUserProvidedIdentifiers UserProvidedIdentifiers? -
- reset boolean? -
commercetools.configuration: CustomerPasswordUpdatedMessagePayload
Fields
- Fields Included from *MessagePayload
- type string
- anydata...
- 'type string? -
- reset boolean? -
commercetools.configuration: CustomerReference
Fields
- Fields Included from *Reference
- typeId ReferenceTypeId
- id string
- anydata...
- typeId ReferenceTypeId? -
- id string? -
- obj Customer? -
commercetools.configuration: CustomerRemoveAddressAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
commercetools.configuration: CustomerRemoveBillingAddressIdAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
commercetools.configuration: CustomerRemoveShippingAddressIdAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- addressId string? -
- addressKey string? -
commercetools.configuration: CustomerRemoveStoreAction
Fields
- Fields Included from *CustomerUpdateAction
- action string
- anydata...
- action string? -
- store StoreResourceIdentifier? -
commercetools.configuration: CustomerResetPassword
Fields
- tokenValue string? -
- newPassword string? -
- 'version int? -
commercetools.configuration: CustomerResourceIdentifier
Fields
- Fields Included from *ResourceIdentifier
- typeId ReferenceTypeId
- id string
- key string
- anydata...
- typeId Refer