Module commercetools.customer

ballerinax/commercetools.customer Ballerina library

1.4.1

Overview

This is a generated connector for Commercetools API v1 OpenAPI specification.

The commercetools Platform HTTP API(Customer) offers an interface for programmatic access to retrieve certain information on customers.

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.customer: Client

Isolated

This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform HTTP API(Customer) offers an interface for programmatic access to retrieve certain information on customer related operations.

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

getCustomersByProjectKeyByID

Isolated FunctionRemote Function

function getCustomersByProjectKeyByID(string projectKey, string id, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

updateCustomersByProjectKeyByID

Isolated FunctionRemote Function

function updateCustomersByProjectKeyByID(string projectKey, string id, CustomerUpdate payload, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

id string -

payload CustomerUpdate -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

deleteCustomerByProjectKeyByID

Isolated FunctionRemote Function

function deleteCustomerByProjectKeyByID(string projectKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

getCustomerInStoreByID

Isolated FunctionRemote Function

function getCustomerInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns Customer|error

Returns a customer by its ID from a specific Store. It also considers customers that do not have the stores field. If the customer exists in the commercetools project but the stores field references different stores, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

updateCustomerInStoreByID

Isolated FunctionRemote Function

function updateCustomerInStoreByID(string projectKey, string storeKey, string id, CustomerUpdate payload, Expansion[]? expand) returns Customer|error

Updates a customer in the store specified by {storeKey}. If the customer exists in the commercetools project but the stores field references a different store, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

id string -

payload CustomerUpdate -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

deleteCustomerInStoreByID

Isolated FunctionRemote Function

function deleteCustomerInStoreByID(string projectKey, string storeKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

getCustomerByKey

Isolated FunctionRemote Function

function getCustomerByKey(string projectKey, string 'key, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

updateCustomerByKey

Isolated FunctionRemote Function

function updateCustomerByKey(string projectKey, string 'key, CustomerUpdate payload, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

'key string -

payload CustomerUpdate -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

deleteCustomerByKey

Isolated FunctionRemote Function

function deleteCustomerByKey(string projectKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

getCustomerInStoreByKey

Isolated FunctionRemote Function

function getCustomerInStoreByKey(string projectKey, string storeKey, string 'key, Expansion[]? expand) returns Customer|error

Returns a customer by its Key from a specific Store. It also considers customers that do not have the stores field. If the customer exists in the commercetools project but the stores field references different stores, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

updateCustomerInStorebyKey

Isolated FunctionRemote Function

function updateCustomerInStorebyKey(string projectKey, string storeKey, string 'key, CustomerUpdate payload, Expansion[]? expand) returns Customer|error

If the customer exists in the commercetools project but the stores field references a different store, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

'key string -

payload CustomerUpdate -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

deleteCustomerInStorebyKey

Isolated FunctionRemote Function

function deleteCustomerInStorebyKey(string projectKey, string storeKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

storeKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

queryCustomers

Isolated FunctionRemote Function

function queryCustomers(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CustomerPagedQueryResponse|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

CustomerPagedQueryResponse|error - 200

createcustomerSignup

Isolated FunctionRemote Function

function createcustomerSignup(string projectKey, CustomerDraft payload, Expansion[]? expand) returns CustomerSignInResult|error

Creates a customer. If an anonymous cart is passed in, then the cart is assigned to the created customer and the version number of the Cart will increase. If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer.

Parameters

projectKey string -

payload CustomerDraft -

expand Expansion[]? (default ()) -

Return Type

CustomerSignInResult|error - 201

queryCustomersInStore

Isolated FunctionRemote Function

function queryCustomersInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CustomerPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CustomerPagedQueryResponse|error - 200

createcustomersinstoreSignup

Isolated FunctionRemote Function

function createcustomersinstoreSignup(string projectKey, string storeKey, CustomerDraft payload, Expansion[]? expand) returns CustomerSignInResult|error

Creates a customer in a specific Store. When using this endpoint, if omitted, the customer's stores field is set to the store specified in the path parameter. If an anonymous cart is passed in as when using this method, then the cart is assigned to the created customer and the version number of the Cart increases. If the ID of an anonymous session is given, all carts and orders will be assigned to the created customer and the store specified. If you pass in a cart with a store field specified, the store field must reference the same store specified in the {storeKey} path parameter.

Parameters

projectKey string -

storeKey string -

payload CustomerDraft -

expand Expansion[]? (default ()) -

Return Type

CustomerSignInResult|error - 201

resetCustomerPassword

Isolated FunctionRemote Function

function resetCustomerPassword(string projectKey, CustomerResetPassword payload) returns Customer|error

Set a new password using a token.

Parameters

projectKey string -

payload CustomerResetPassword -

Return Type

Customer|error - 200

changeCustomerPasswordInStore

Isolated FunctionRemote Function

function changeCustomerPasswordInStore(string projectKey, string storeKey, CustomerChangePassword payload) returns Customer|error

Change a customers password

Parameters

projectKey string -

storeKey string -

payload CustomerChangePassword -

Return Type

Customer|error - 200

authenticateglobalcustomerSignin

Isolated FunctionRemote Function

function authenticateglobalcustomerSignin(string projectKey, CustomerSignin payload) returns CustomerSignInResult|error

Authenticate Customer (Sign In). Retrieves the authenticated customer (a customer that matches the given email/password pair). If used with an access token for Anonymous Sessions, all orders and carts belonging to the anonymousId will be assigned to the newly created customer. If a cart is is returned as part of the CustomerSignInResult, it has been recalculated (It will have up-to-date prices, taxes and discounts, and invalid line items have been removed.).

Parameters

projectKey string -

payload CustomerSignin -

Return Type

CustomerSignInResult|error - 200

authenticatecustomerSigninInstore

Isolated FunctionRemote Function

function authenticatecustomerSigninInstore(string projectKey, string storeKey, CustomerSignin payload) returns CustomerSignInResult|error

Authenticate Customer (Sign In) in store

Parameters

projectKey string -

storeKey string -

payload CustomerSignin -

Return Type

CustomerSignInResult|error - 200

createTokenForVerifyingCustomerEmailByPasswordToken

Isolated FunctionRemote Function

function createTokenForVerifyingCustomerEmailByPasswordToken(string projectKey, CustomerCreatePasswordResetToken payload) returns CustomerToken|error

The token value is used to reset the password of the customer with the given email. The token is valid only for 10 minutes.

Parameters

projectKey string -

payload CustomerCreatePasswordResetToken -

Return Type

CustomerToken|error - 200

getCustomerByPasswordToken

Isolated FunctionRemote Function

function getCustomerByPasswordToken(string projectKey, string passwordToken, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

passwordToken string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

createTokenForResetCustomerPasswordInStore

Isolated FunctionRemote Function

function createTokenForResetCustomerPasswordInStore(string projectKey, string storeKey, CustomerCreatePasswordResetToken payload) returns CustomerToken|error

The token value is used to reset the password of the customer with the given email. The token is valid only for 10 minutes.

Parameters

projectKey string -

storeKey string -

payload CustomerCreatePasswordResetToken -

Return Type

CustomerToken|error - 200

getCustomerByPasswordTokenInStore

Isolated FunctionRemote Function

function getCustomerByPasswordTokenInStore(string projectKey, string storeKey, string passwordToken, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

storeKey string -

passwordToken string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

resetCustomerPasswordInStore

Isolated FunctionRemote Function

function resetCustomerPasswordInStore(string projectKey, string storeKey, CustomerResetPassword payload) returns Customer|error

Set a new password using a token.

Parameters

projectKey string -

storeKey string -

payload CustomerResetPassword -

Return Type

Customer|error - 200

createTokenForVerifyingCustomerEmailByEmailToken

Isolated FunctionRemote Function

function createTokenForVerifyingCustomerEmailByEmailToken(string projectKey, CustomerCreateEmailToken payload) returns CustomerToken|error

Create a Token for verifying the Customer's Email

Parameters

projectKey string -

payload CustomerCreateEmailToken -

Return Type

CustomerToken|error - 200

getCustomerByEmailToken

Isolated FunctionRemote Function

function getCustomerByEmailToken(string projectKey, string emailToken, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

emailToken string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

verifyCustomerEmail

Isolated FunctionRemote Function

function verifyCustomerEmail(string projectKey, CustomerEmailVerify payload) returns Customer|error

Verifies customer's email using a token.

Parameters

projectKey string -

payload CustomerEmailVerify -

Return Type

Customer|error - The email was verified.

verifyCustomerEmailInStore

Isolated FunctionRemote Function

function verifyCustomerEmailInStore(string projectKey, string storeKey, CustomerCreateEmailToken payload) returns CustomerToken|error

Create a Token for verifying the Customer's Email in store

Parameters

projectKey string -

storeKey string -

payload CustomerCreateEmailToken -

Return Type

CustomerToken|error - 200

getCustomerByEmailTokenInStore

Isolated FunctionRemote Function

function getCustomerByEmailTokenInStore(string projectKey, string storeKey, string emailToken, Expansion[]? expand) returns Customer|error

Parameters

projectKey string -

storeKey string -

emailToken string -

expand Expansion[]? (default ()) -

Return Type

Customer|error - 200

verifyCustomerEmailUsingToken

Isolated FunctionRemote Function

function verifyCustomerEmailUsingToken(string projectKey, string storeKey, CustomerEmailVerify payload) returns Customer|error

Verifies customer's email using a token.

Parameters

projectKey string -

storeKey string -

payload CustomerEmailVerify -

Return Type

Customer|error - The email was verified.

getCustomerByProjectKey

Isolated FunctionRemote Function

function getCustomerByProjectKey(string projectKey, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, Expansion[]? expand, QueryPredicate[]? 'where, string[]? varAZaZ09) returns Customer|error

Parameters

projectKey string -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

expand Expansion[]? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

Customer|error - 200

updateCustomerByProjectKey

Isolated FunctionRemote Function

function updateCustomerByProjectKey(string projectKey, MyCustomerUpdate payload) returns Customer|error

Update my customer

Parameters

projectKey string -

payload MyCustomerUpdate -

Return Type

Customer|error - 200

deleteCustomerByProjectKey

Isolated FunctionRemote Function

function deleteCustomerByProjectKey(string projectKey, decimal 'version) returns Customer|error

Delete my Customer

Parameters

projectKey string -

'version decimal -

Return Type

Customer|error - 200

createCustomerSignUpByProjectKey

Isolated FunctionRemote Function

function createCustomerSignUpByProjectKey(string projectKey, MyCustomerDraft payload) returns CustomerSignInResult|error

Parameters

projectKey string -

payload MyCustomerDraft -

Return Type

CustomerSignInResult|error - 201

authenticatecustomerSignin

Isolated FunctionRemote Function

function authenticatecustomerSignin(string projectKey, CustomerSignin payload) returns CustomerSignInResult|error

Parameters

projectKey string -

payload CustomerSignin -

Return Type

CustomerSignInResult|error - 200

changeCustomerPasswordByProjectKey

Isolated FunctionRemote Function

function changeCustomerPasswordByProjectKey(string projectKey, MyCustomerChangePassword payload) returns Customer|error

Parameters

projectKey string -

payload MyCustomerChangePassword -

Return Type

Customer|error - 200

resetCustomerPasswordByProject

Isolated FunctionRemote Function

function resetCustomerPasswordByProject(string projectKey) returns Customer|error

Parameters

projectKey string -

Return Type

Customer|error - 200

verifyCustomerEmailByProject

Isolated FunctionRemote Function

function verifyCustomerEmailByProject(string projectKey) returns Response|error

Parameters

projectKey string -

Return Type

Response|error -
Bad Request A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned in the response before re-sending the request. The following general error codes can appear in responses with the HTTP status code 400: * InvalidInput Invalid input has been sent to the service. The client application should validate the input according to the constraints described in the error message before sending the request. * InvalidOperation The resource(s) involved in the request are not in a valid state for the operation. The client application should validate the constraints described in the error message before sending the request. * InvalidField A field has an invalid value. Extra fields: * field - String The name of the field. * invalidValue - * The invalid value. * allowedValues - Array of * - Optional A fixed set of allowed values for the field, if any. * RequiredField A required field is missing a value. Extra fields: * field - String The name of the field. * DuplicateField A value for a field conflicts with an existing duplicate value. Extra fields: * field - String The name of the field. * duplicateValue - * The offending duplicate value.

getCustomerGroupsByID

Isolated FunctionRemote Function

function getCustomerGroupsByID(string projectKey, string id, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

updateCustomerGroupsByID

Isolated FunctionRemote Function

function updateCustomerGroupsByID(string projectKey, string id, CustomerGroupUpdate payload, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

id string -

payload CustomerGroupUpdate -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

deleteCustomerGroupsByID

Isolated FunctionRemote Function

function deleteCustomerGroupsByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

getCustomerGroupbyKey

Isolated FunctionRemote Function

function getCustomerGroupbyKey(string projectKey, string 'key, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

updateCustomerGroupbyKey

Isolated FunctionRemote Function

function updateCustomerGroupbyKey(string projectKey, string 'key, CustomerGroupUpdate payload, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

'key string -

payload CustomerGroupUpdate -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

deleteCustomerGroupbyKey

Isolated FunctionRemote Function

function deleteCustomerGroupbyKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 200

queryCustomerGroups

Isolated FunctionRemote Function

function queryCustomerGroups(string projectKey, QueryPredicate[]? 'where, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, string[]? varAZaZ09) returns CustomerGroupPagedQueryResponse|error

Parameters

projectKey string -

'where QueryPredicate[]? (default ()) -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CustomerGroupPagedQueryResponse|error - 200

createCustomerGroup

Isolated FunctionRemote Function

function createCustomerGroup(string projectKey, CustomerGroupDraft payload, Expansion[]? expand) returns CustomerGroup|error

Parameters

projectKey string -

payload CustomerGroupDraft -

expand Expansion[]? (default ()) -

Return Type

CustomerGroup|error - 201

Records

commercetools.customer: AccessDeniedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.customer: 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.customer: 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.customer: AnonymousIdAlreadyInUseError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.customer: ApiClient

Fields

id string? -

name string? -

scope string? -

secret string? -

lastUsedAt string? -

deleteAt string? -

createdAt string? -

commercetools.customer: ApiClientDraft

Fields

name string? -

scope string? -

deleteDaysAfterCreation int? -

commercetools.customer: ApiClientPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results ApiClient[]? -

commercetools.customer: Asset

Fields

id string? -

sources AssetSource[]? -

name LocalizedString? -

description LocalizedString? -

tags string[]? -

custom CustomFields? -

'key string? -

commercetools.customer: AssetDimensions

Fields

w int? -

h int? -

commercetools.customer: AssetDraft

Fields

sources AssetSource[]? -

name LocalizedString? -

description LocalizedString? -

tags string[]? -

custom CustomFieldsDraft? -

'key string? -

commercetools.customer: AssetSource

Fields

uri string? -

'key string? -

dimensions AssetDimensions? -

contentType string? -

commercetools.customer: AssignedProductReference

Fields

product ProductReference? -

commercetools.customer: Attribute

Fields

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: AttributeBooleanType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeDateTimeType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeDateType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeDefinition

Fields

'type AttributeType? -

name string? -

label LocalizedString? -

isRequired boolean? -

attributeConstraint AttributeConstraintEnum? -

inputTip LocalizedString? -

inputHint TextInputHint? -

isSearchable boolean? -

commercetools.customer: AttributeDefinitionAlreadyExistsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingProductTypeId string? -

conflictingProductTypeName string? -

conflictingAttributeName string? -

commercetools.customer: AttributeDefinitionDraft

Fields

'type AttributeType? -

name string? -

label LocalizedString? -

isRequired boolean? -

attributeConstraint AttributeConstraintEnum? -

inputTip LocalizedString? -

inputHint TextInputHint? -

isSearchable boolean? -

commercetools.customer: AttributeDefinitionTypeConflictError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingProductTypeId string? -

conflictingProductTypeName string? -

conflictingAttributeName string? -

commercetools.customer: AttributeEnumType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

values AttributePlainEnumValue[]? -

commercetools.customer: AttributeLocalizableTextType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeLocalizedEnumType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

values AttributeLocalizedEnumValue[]? -

commercetools.customer: AttributeLocalizedEnumValue

Fields

'key string? -

label LocalizedString? -

commercetools.customer: AttributeMoneyType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeNameDoesNotExistError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

invalidAttributeName string? -

commercetools.customer: AttributeNestedType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

typeReference ProductTypeReference? -

commercetools.customer: AttributeNumberType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributePlainEnumValue

Fields

'key string? -

label string? -

commercetools.customer: AttributeReferenceType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

referenceTypeId ReferenceTypeId? -

commercetools.customer: AttributeSetType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

elementType AttributeType? -

commercetools.customer: AttributeTextType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeTimeType

Fields

Fields Included from *AttributeType

name string
anydata...

name string? -

commercetools.customer: AttributeType

Fields

name string? -

commercetools.customer: AzureEventGridDestination

Fields

Fields Included from *Destination

type string
anydata...

'type string? -

uri string? -

accessKey string? -

commercetools.customer: AzureServiceBusDestination

Fields

Fields Included from *Destination

type string
anydata...

'type string? -

connectionString string? -

commercetools.customer: BadGatewayError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.customer: 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.customer: BaseResource

Fields

id string? -

'version int? -

createdAt string? -

lastModifiedAt string? -

commercetools.customer: Cart

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

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.customer: 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.customer: CartAddDiscountCodeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

code string? -

commercetools.customer: CartAddItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: 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.customer: CartAddPaymentAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.customer: CartAddShoppingListAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

shoppingList ShoppingListResourceIdentifier? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

commercetools.customer: CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

targetsDelta ItemShippingTarget[]? -

commercetools.customer: CartApplyDeltaToLineItemShippingDetailsTargetsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

targetsDelta ItemShippingTarget[]? -

commercetools.customer: CartChangeCustomLineItemMoneyAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

money Money? -

commercetools.customer: CartChangeCustomLineItemQuantityAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

quantity int? -

commercetools.customer: CartChangeLineItemQuantityAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.customer: CartChangeTaxCalculationModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

taxCalculationMode TaxCalculationMode? -

commercetools.customer: CartChangeTaxModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

taxMode TaxMode? -

commercetools.customer: CartChangeTaxRoundingModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

taxRoundingMode RoundingMode? -

commercetools.customer: CartClassificationTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

value string? -

price Money? -

isMatching boolean? -

commercetools.customer: CartClassificationType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

values CustomFieldLocalizedEnumValue[]? -

commercetools.customer: CartDiscount

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

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.customer: CartDiscountChangeCartPredicateAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

cartPredicate string? -

commercetools.customer: CartDiscountChangeIsActiveAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

isActive boolean? -

commercetools.customer: CartDiscountChangeNameAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.customer: CartDiscountChangeRequiresDiscountCodeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

requiresDiscountCode boolean? -

commercetools.customer: CartDiscountChangeSortOrderAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

sortOrder string? -

commercetools.customer: CartDiscountChangeStackingModeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

stackingMode StackingMode? -

commercetools.customer: CartDiscountChangeTargetAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

target CartDiscountTarget? -

commercetools.customer: CartDiscountChangeValueAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

value CartDiscountValueDraft? -

commercetools.customer: CartDiscountCustomLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

commercetools.customer: 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.customer: CartDiscountLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

commercetools.customer: CartDiscountPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results CartDiscount[]? -

commercetools.customer: CartDiscountReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj CartDiscount? -

commercetools.customer: CartDiscountResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.customer: CartDiscountSetCustomFieldAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartDiscountSetCustomTypeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.customer: CartDiscountSetDescriptionAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.customer: CartDiscountSetKeyAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.customer: CartDiscountSetValidFromAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

commercetools.customer: CartDiscountSetValidFromAndUntilAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

validUntil string? -

commercetools.customer: CartDiscountSetValidUntilAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action string? -

validUntil string? -

commercetools.customer: CartDiscountShippingCostTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type string? -

commercetools.customer: CartDiscountTarget

Fields

'type string? -

commercetools.customer: CartDiscountUpdate

Fields

'version int? -

actions CartDiscountUpdateAction[]? -

commercetools.customer: CartDiscountUpdateAction

Fields

action string? -

commercetools.customer: CartDiscountValue

Fields

'type string? -

commercetools.customer: CartDiscountValueAbsolute

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type string? -

money TypedMoney[]? -

commercetools.customer: CartDiscountValueAbsoluteDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type string? -

money Money[]? -

commercetools.customer: CartDiscountValueDraft

Fields

'type string? -

commercetools.customer: CartDiscountValueFixed

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type string? -

money TypedMoney[]? -

commercetools.customer: CartDiscountValueFixedDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type string? -

money Money[]? -

commercetools.customer: CartDiscountValueGiftLineItem

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type string? -

product ProductReference? -

variantId int? -

supplyChannel ChannelReference? -

distributionChannel ChannelReference? -

commercetools.customer: CartDiscountValueGiftLineItemDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type string? -

product ProductResourceIdentifier? -

variantId int? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

commercetools.customer: CartDiscountValueRelative

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type string? -

permyriad int? -

commercetools.customer: CartDiscountValueRelativeDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type string? -

permyriad int? -

commercetools.customer: 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.customer: CartPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Cart[]? -

commercetools.customer: CartRecalculateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

updateProductData boolean? -

commercetools.customer: CartReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Cart? -

commercetools.customer: CartRemoveCustomLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

commercetools.customer: CartRemoveDiscountCodeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

discountCode DiscountCodeReference? -

commercetools.customer: CartRemoveItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

commercetools.customer: CartRemoveLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

shippingDetailsToRemove ItemShippingDetailsDraft? -

commercetools.customer: CartRemovePaymentAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.customer: CartResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.customer: CartsConfiguration

Fields

countryTaxRateFallbackEnabled boolean? -

deleteDaysAfterLastModification int? -

commercetools.customer: CartScoreTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

score decimal? -

price Money? -

priceFunction PriceFunction? -

isMatching boolean? -

commercetools.customer: CartScoreType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

commercetools.customer: CartSetAnonymousIdAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

anonymousId string? -

commercetools.customer: CartSetBillingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: CartSetBillingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetBillingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetCartTotalTaxAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

externalTotalGross Money? -

externalTaxPortions TaxPortionDraft[]? -

commercetools.customer: CartSetCountryAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

country CountryCode? -

commercetools.customer: CartSetCustomerEmailAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.customer: CartSetCustomerGroupAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customerGroup CustomerGroupResourceIdentifier? -

commercetools.customer: CartSetCustomerIdAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customerId string? -

commercetools.customer: CartSetCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetCustomLineItemCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetCustomLineItemCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetCustomLineItemShippingDetailsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.customer: CartSetCustomLineItemTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.customer: CartSetCustomLineItemTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.customer: CartSetCustomShippingMethodAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

shippingMethodName string? -

shippingRate ShippingRateDraft? -

taxCategory TaxCategoryResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.customer: CartSetCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

deleteDaysAfterLastModification int? -

commercetools.customer: CartSetDeliveryAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

deliveryId string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetDeliveryAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

deliveryId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetItemShippingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetItemShippingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetKeyAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.customer: CartSetLineItemCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetLineItemCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetLineItemDistributionChannelAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.customer: CartSetLineItemPriceAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalPrice Money? -

commercetools.customer: CartSetLineItemShippingDetailsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.customer: CartSetLineItemSupplyChannelAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.customer: CartSetLineItemTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.customer: CartSetLineItemTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.customer: CartSetLineItemTotalPriceAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.customer: CartSetLocaleAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.customer: CartSetShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: CartSetShippingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CartSetShippingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CartSetShippingMethodAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

shippingMethod ShippingMethodResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.customer: CartSetShippingMethodTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.customer: CartSetShippingMethodTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.customer: CartSetShippingRateInputAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

shippingRateInput ShippingRateInputDraft? -

commercetools.customer: CartUpdate

Fields

'version int? -

actions CartUpdateAction[]? -

commercetools.customer: CartUpdateAction

Fields

action string? -

commercetools.customer: CartUpdateItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: CartValueTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

minimumCentAmount int? -

price Money? -

isMatching boolean? -

commercetools.customer: CartValueType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

commercetools.customer: Category

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

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.customer: CategoryAddAssetAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

asset AssetDraft? -

position int? -

commercetools.customer: CategoryChangeAssetNameAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

name LocalizedString? -

commercetools.customer: CategoryChangeAssetOrderAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetOrder string[]? -

commercetools.customer: CategoryChangeNameAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.customer: CategoryChangeOrderHintAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

orderHint string? -

commercetools.customer: CategoryChangeParentAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

parent CategoryResourceIdentifier? -

commercetools.customer: CategoryChangeSlugAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

slug LocalizedString? -

commercetools.customer: 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
anydata...

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.customer: CategoryCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

category Category? -

commercetools.customer: 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.customer: CategoryOrderHints

commercetools.customer: CategoryPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Category[]? -

commercetools.customer: CategoryReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Category? -

commercetools.customer: CategoryRemoveAssetAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

commercetools.customer: CategoryResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.customer: CategorySetAssetCustomFieldAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CategorySetAssetCustomTypeAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.customer: CategorySetAssetDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

description LocalizedString? -

commercetools.customer: CategorySetAssetKeyAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

commercetools.customer: CategorySetAssetSourcesAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

sources AssetSource[]? -

commercetools.customer: CategorySetAssetTagsAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

tags string[]? -

commercetools.customer: CategorySetCustomFieldAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: CategorySetCustomTypeAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: CategorySetDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.customer: CategorySetExternalIdAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

externalId string? -

commercetools.customer: CategorySetKeyAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.customer: CategorySetMetaDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

metaDescription LocalizedString? -

commercetools.customer: CategorySetMetaKeywordsAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

metaKeywords LocalizedString? -

commercetools.customer: CategorySetMetaTitleAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action string? -

metaTitle LocalizedString? -

commercetools.customer: 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
anydata...

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.customer: CategorySlugChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

slug LocalizedString? -

oldSlug LocalizedString? -

commercetools.customer: CategoryUpdate

Fields

'version int? -

actions CategoryUpdateAction[]? -

commercetools.customer: CategoryUpdateAction

Fields

action string? -

commercetools.customer: CentPrecisionMoney

Fields

Fields Included from *TypedMoney

type MoneyType
fractionDigits int
centAmount int
currencyCode CurrencyCode
anydata...

'type MoneyType? -

fractionDigits int? -

centAmount int? -

currencyCode CurrencyCode? -

commercetools.customer: CentPrecisionMoneyDraft

Fields

Fields Included from *TypedMoneyDraft

centAmount int
currencyCode CurrencyCode
type MoneyType
fractionDigits int
anydata...

centAmount int? -

currencyCode CurrencyCode? -

'type MoneyType? -

fractionDigits int? -

commercetools.customer: ChangeSubscription

Fields

resourceTypeId string? -

commercetools.customer: Channel

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

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.customer: ChannelAddRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.customer: ChannelChangeDescriptionAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.customer: ChannelChangeKeyAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.customer: ChannelChangeNameAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.customer: ChannelDraft

Fields

'key string? -

roles ChannelRoleEnum[]? -

name LocalizedString? -

description LocalizedString? -

address BaseAddress? -

custom CustomFieldsDraft? -

geoLocation GeoJson? -

commercetools.customer: ChannelPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results Channel[]? -

commercetools.customer: ChannelReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Channel? -

commercetools.customer: ChannelRemoveRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.customer: ChannelResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.customer: ChannelSetAddressAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: ChannelSetAddressCustomFieldAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: ChannelSetAddressCustomTypeAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: ChannelSetCustomFieldAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

name string? -

value string|record {}|string[]|decimal|int|boolean? -

commercetools.customer: ChannelSetCustomTypeAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.customer: ChannelSetGeoLocationAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

geoLocation GeoJson? -

commercetools.customer: ChannelSetRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.customer: ChannelUpdate

Fields

'version int? -

actions ChannelUpdateAction[]? -

commercetools.customer: ChannelUpdateAction

Fields

action string? -

commercetools.customer: ClassificationShippingRateInput

Fields

Fields Included from *ShippingRateInput

type string
anydata...

'type string? -

'key string? -

label LocalizedString? -

commercetools.customer: ClassificationShippingRateInputDraft

Fields

Fields Included from *ShippingRateInputDraft

type string
anydata...

'type string? -

'key string? -

commercetools.customer: ClientHttp1Settings

Closed record

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.customer: ClientLogging

Fields

clientId string? -

externalUserId string? -

customer CustomerReference? -

anonymousId string? -

commercetools.customer: ConcurrentModificationError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code string? -

message string? -

currentVersion int? -

commercetools.customer: ConnectionConfig

Closed record

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.customer: ContainerAndKey

Fields

'key string? -

container string? -

commercetools.customer: CreatedBy

Fields

Fields Included from *ClientLogging

clientId string
externalUserId string
customer CustomerReference
anonymousId string
anydata...

clientId string? -

externalUserId string? -

customer CustomerReference? -

anonymousId string? -

commercetools.customer: Customer

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

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.customer: CustomerAddAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.customer: CustomerAddBillingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.customer: 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
anydata...

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.customer: CustomerAddressAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.customer: 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
anydata...

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.customer: CustomerAddressChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.customer: 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
anydata...

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.customer: CustomerAddressRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.customer: CustomerAddShippingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.customer: CustomerAddStoreAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

store StoreResourceIdentifier? -

commercetools.customer: CustomerChangeAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

address BaseAddress? -

commercetools.customer: CustomerChangeEmailAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.customer: CustomerChangePassword

Fields

id string? -

'version int? -

currentPassword string? -

newPassword string? -

commercetools.customer: 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
anydata...

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.customer: CustomerCompanyNameSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

companyName string? -

commercetools.customer: 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
anydata...

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.customer: CustomerCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

customer Customer? -

commercetools.customer: CustomerCreateEmailToken

Fields

id string? -

'version int? -

ttlMinutes int? -

commercetools.customer: CustomerCreatePasswordResetToken

Fields

email string? -

ttlMinutes int? -

commercetools.customer: 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
anydata...

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.customer: CustomerDateOfBirthSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

dateOfBirth string? -

commercetools.customer: 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
anydata...

id string? -

'version int? -

createdAt string? -

lastModifiedAt string? -

lastModifiedBy LastModifiedBy? -

createdBy CreatedBy? -

sequenceNumber int? -

'resource Reference? -

resourceVersion int? -

'type string? -

resourceUserProvidedIdentifiers UserProvidedIdentifiers? -

commercetools.customer: CustomerDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

commercetools.customer: 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.customer: 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
anydata...

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.customer: CustomerEmailChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

email string? -

commercetools.customer: 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
anydata...

id string? -

'version int? -

createdAt string? -

lastModifiedAt string? -

lastModifiedBy LastModifiedBy? -

createdBy CreatedBy? -

sequenceNumber int? -

'resource Reference? -

resourceVersion int? -

'type string? -

resourceUserProvidedIdentifiers UserProvidedIdentifiers? -

commercetools.customer: CustomerEmailVerifiedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

commercetools.customer: CustomerEmailVerify

Fields

'version int? -

tokenValue string? -

commercetools.customer: 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
anydata...

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.customer: CustomerFirstNameSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type string? -

firstName string? -

commercetools.customer: CustomerGroup

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id string? -

'version int? -

createdAt string? -

lastModifiedAt string? -

lastModifiedBy LastModifiedBy? -

createdBy CreatedBy? -

'key string? -

name string? -

custom

clients

records

unionTypes

stringTypes

ballerinax/commercetools.customer Ballerina library

Overview

Prerequisites

Clients

commercetools.customer: Client

Constructor

getCustomersByProjectKeyByID

Parameters

Return Type

updateCustomersByProjectKeyByID

Parameters

Return Type

deleteCustomerByProjectKeyByID

Parameters

Return Type

getCustomerInStoreByID

Parameters

Return Type

updateCustomerInStoreByID

Parameters

Return Type

deleteCustomerInStoreByID

Parameters

Return Type

getCustomerByKey

Parameters

Return Type

updateCustomerByKey

Parameters

Return Type

deleteCustomerByKey

Parameters

Return Type

getCustomerInStoreByKey

Parameters

Return Type

updateCustomerInStorebyKey

Parameters

Return Type

deleteCustomerInStorebyKey

Parameters

Return Type

queryCustomers

Parameters

Return Type

createcustomerSignup

Parameters

Return Type

queryCustomersInStore

Parameters

Return Type

createcustomersinstoreSignup

Parameters

Return Type

resetCustomerPassword

Parameters

Return Type

changeCustomerPasswordInStore

Parameters

Return Type

authenticateglobalcustomerSignin

Parameters

Return Type

authenticatecustomerSigninInstore

Parameters

Return Type

createTokenForVerifyingCustomerEmailByPasswordToken

Parameters

Return Type

getCustomerByPasswordToken

Parameters

Return Type

createTokenForResetCustomerPasswordInStore

Parameters

Return Type

getCustomerByPasswordTokenInStore