All Classes and Interfaces
Class
Description
Middleware to add the header
Accept: gzip to the requestThis is the generic error code for access denied.
AccessDeniedErrorBuilder
Example to create an instance using the builder pattern
abstract class for accessor implementations
Change triggered by the Add Address update action.
AddAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddAssetChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Associate update action.
AddAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Attribute Definition update action.
AddAttributeDefinitionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Billing Address ID update action.
AddBillingAddressIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Roles update action.
AddChannelRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add CustomLineItem update action.
AddCustomLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Delivery update action.
AddDeliveryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add DiscountCode update action.
AddDiscountCodeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add EnumValue to FieldDefinition update action.
AddEnumValueChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add External Image update action.
AddExternalImageChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add FieldDefinition update action.
AddFieldDefinitionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Associate update action on a parent of a Business Unit in cases where inheritance applies.
AddInheritedAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add InterfaceInteraction update action.
AddInterfaceInteractionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddItemShippingAddressesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddLocalizedEnumValueChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Location update action.
AddLocationChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add LineItem update action.
AddOrderLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddParcelToDeliveryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddPaymentChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add PlainEnumValue to AttributeDefinition update action.
AddPlainEnumValueChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Price update action.
AddPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Product update action.
AddProductChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Product Selection update action.
AddProductSelectionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when a new property is added.
AddPropertyChangeBuilder
Example to create an instance using the builder pattern
Address type returned by read methods.
Address
Example to create an instance using the builder pattern
Address
Example to create an instance using the builder pattern
AddressBuilder
Example to create an instance using the builder pattern
AddressBuilder
Example to create an instance using the builder pattern
AddressBuilder
Example to create an instance using the builder pattern
Address type to be used on write methods.
AddressDraftBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
AddReturnInfoChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Shipping Address ID update action.
AddShippingAddressIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add ShoppingListLineItem update action.
AddShoppingListLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add State roles update action.
AddStateRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add TaxRate update action.
AddTaxRateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add TextLineItem update action.
AddTextLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add to Category update action.
AddToCategoryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add Transaction update action.
AddTransactionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Add ProductVariant update action.
AddVariantChangeBuilder
Example to create an instance using the builder pattern
AnonymousCartSignInMode
possible values of AnonymousCartSignInMode
Returned when the anonymous ID is being used by another resource.
AnonymousIdAlreadyInUseErrorBuilder
Example to create an instance using the builder pattern
Token supplier using anonymous flow
ApiClient
Example to create an instance using the builder pattern
ApiClientBuilder
Example to create an instance using the builder pattern
ApiClientDraft
Example to create an instance using the builder pattern
ApiClientDraftBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of APIClient.ApiClientPagedQueryResponseBuilder
Example to create an instance using the builder pattern
CorrelationIdProvider which adds the project key as prefixInterface for an HTTP client accessing the API and mapping to a known output type
Default implementation of an
ApiHttpClientCreates an exception bases on the status code of the
ApiHttpResponse with module specific exception for
BadRequestException and ConcurrentModificationExceptionCreates an
InternalLogger with the API path of the requestModule to configure the default jackson
ObjectMapper e.g.Entrypoint for building requests against the API
Entrypoint for building requests against the API
Entrypoint for building requests against the API
Builder to create a
ApiRoot or a project scoped ProjectApiRootApprovalFlow
Example to create an instance using the builder pattern
ApprovalFlowApproval
Example to create an instance using the builder pattern
ApprovalFlowApprovalBuilder
Example to create an instance using the builder pattern
This update action allows an Associate to approve an Approval Flow.
ApprovalFlowApproveActionBuilder
Example to create an instance using the builder pattern
Generated after an approval in the Approval Flow.
ApprovalFlowApprovedMessageBuilder
Example to create an instance using the builder pattern
Generated after an approval in the Approval Flow.
ApprovalFlowApprovedMessagePayloadBuilder
Example to create an instance using the builder pattern
ApprovalFlowBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is completed and reaches a final status.
ApprovalFlowCompletedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is completed and reaches a final status.
ApprovalFlowCompletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is created.
ApprovalFlowCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is created.
ApprovalFlowCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ApprovalFlow.
ApprovalFlowPagedQueryResponseBuilder
Example to create an instance using the builder pattern
This update action allows an Associate to reject an Approval Flow, setting its status to
Rejected.ApprovalFlowRejectActionBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is rejected.
ApprovalFlowRejectedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is rejected.
ApprovalFlowRejectedMessagePayloadBuilder
Example to create an instance using the builder pattern
ApprovalFlowRejection
Example to create an instance using the builder pattern
ApprovalFlowRejectionBuilder
Example to create an instance using the builder pattern
ApprovalFlowSetCustomFieldAction
Example to create an instance using the builder pattern
ApprovalFlowSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ApprovalFlowSetCustomTypeAction
Example to create an instance using the builder pattern
ApprovalFlowSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Indicates whether the Approval Flow is under review, approved, or rejected.
possible values of ApprovalFlowStatus
ApprovalFlowUpdate
Example to create an instance using the builder pattern
ApprovalFlowUpdateAction
Example to create a subtype instance using the builder pattern
ApprovalFlowUpdateActionBuilder
ApprovalFlowUpdateBuilder
Example to create an instance using the builder pattern
ApprovalRule
Example to create an instance using the builder pattern
Generated after a successful Set Approvers update action.
ApprovalRuleApproversSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Approvers update action.
ApprovalRuleApproversSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ApprovalRuleBuilder
Example to create an instance using the builder pattern
Generated after an Approval Rule is created.
ApprovalRuleCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Rule is created.
ApprovalRuleCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Description update action.
ApprovalRuleDescriptionSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Description update action.
ApprovalRuleDescriptionSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ApprovalRuleDraft
Example to create an instance using the builder pattern
ApprovalRuleDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
ApprovalRuleKeySetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
ApprovalRuleKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
ApprovalRuleNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
ApprovalRuleNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ApprovalRule.
ApprovalRulePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Predicate update action.
ApprovalRulePredicateSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Predicate update action.
ApprovalRulePredicateSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Requester update action.
ApprovalRuleRequestersSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Requester update action.
ApprovalRuleRequestersSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Setting the approvers for an Approval Rule generates an ApprovalRuleApproversSet Message.
ApprovalRuleSetApproversActionBuilder
Example to create an instance using the builder pattern
Setting the description for an Approval Rule generates an ApprovalRuleDescriptionSet Message.
ApprovalRuleSetDescriptionActionBuilder
Example to create an instance using the builder pattern
Setting the key for an Approval Rule generates an ApprovalRuleKeySet Message.
ApprovalRuleSetKeyActionBuilder
Example to create an instance using the builder pattern
Setting the name for an Approval Rule generates an ApprovalRuleNameSet Message.
ApprovalRuleSetNameActionBuilder
Example to create an instance using the builder pattern
Setting the Order Predicate for an Approval Rule generates an ApprovalRulePredicateSet Message.
ApprovalRuleSetPredicateActionBuilder
Example to create an instance using the builder pattern
Sets the requesters for an Approval Rule generates an ApprovalRuleRequestersSet Message.
ApprovalRuleSetRequestersActionBuilder
Example to create an instance using the builder pattern
Setting the status for an Approval Rule generates an ApprovalRuleStatusSet Message.
ApprovalRuleSetStatusActionBuilder
Example to create an instance using the builder pattern
Indicates whether the Approval Rule should be matched against Orders or not.
possible values of ApprovalRuleStatus
Generated after a successful Set Status update action.
ApprovalRuleStatusSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Status update action.
ApprovalRuleStatusSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ApprovalRuleUpdate
Example to create an instance using the builder pattern
ApprovalRuleUpdateAction
Example to create a subtype instance using the builder pattern
ApprovalRuleUpdateActionBuilder
ApprovalRuleUpdateBuilder
Example to create an instance using the builder pattern
ApproverConjunction
Example to create an instance using the builder pattern
ApproverConjunctionBuilder
Example to create an instance using the builder pattern
ApproverConjunctionDraft
Example to create an instance using the builder pattern
ApproverConjunctionDraftBuilder
Example to create an instance using the builder pattern
ApproverDisjunction
Example to create an instance using the builder pattern
ApproverDisjunctionBuilder
Example to create an instance using the builder pattern
ApproverDisjunctionDraft
Example to create an instance using the builder pattern
ApproverDisjunctionDraftBuilder
Example to create an instance using the builder pattern
Describes the order in which Associates can approve the matched Order.
ApproverHierarchyBuilder
Example to create an instance using the builder pattern
Describes the sequence in which Associates can approve an Order.
ApproverHierarchyDraftBuilder
Example to create an instance using the builder pattern
Asset
Example to create an instance using the builder pattern
Asset
Example to create an instance using the builder pattern
Asset
Example to create an instance using the builder pattern
AssetBuilder
Example to create an instance using the builder pattern
AssetBuilder
Example to create an instance using the builder pattern
AssetBuilder
Example to create an instance using the builder pattern
AssetChangeValue
Example to create an instance using the builder pattern
AssetChangeValueBuilder
Example to create an instance using the builder pattern
Dimensions of the Asset source specified by the number of pixels.
AssetDimensions
Example to create an instance using the builder pattern
The width and height of the Asset Source.
AssetDimensionsBuilder
Example to create an instance using the builder pattern
AssetDimensionsBuilder
Example to create an instance using the builder pattern
AssetDimensionsBuilder
Example to create an instance using the builder pattern
AssetDraft
Example to create an instance using the builder pattern
AssetDraftBuilder
Example to create an instance using the builder pattern
Representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.
AssetSource
Example to create an instance using the builder pattern
An AssetSource is a representation of an Asset in a specific format, for example, a video in a certain encoding or an image in a certain resolution.
AssetSourceBuilder
Example to create an instance using the builder pattern
AssetSourceBuilder
Example to create an instance using the builder pattern
AssetSourceBuilder
Example to create an instance using the builder pattern
AssignedProductReference
Example to create an instance using the builder pattern
AssignedProductReferenceBuilder
Example to create an instance using the builder pattern
AssignedProductSelection
Example to create an instance using the builder pattern
AssignedProductSelectionBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductSelection.
AssignedProductSelectionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Associate
Example to create an instance using the builder pattern
Associate
Example to create an instance using the builder pattern
AssociateBuilder
Example to create an instance using the builder pattern
AssociateBuilder
Example to create an instance using the builder pattern
AssociateDraft
Example to create an instance using the builder pattern
AssociateDraftBuilder
Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
AssociateMissingPermissionErrorBuilder
Example to create an instance using the builder pattern
AssociateRole
Example to create an instance using the builder pattern
Adding a Permission to an AssociateRole generates an AssociateRolePermissionAdded Message.
AssociateRoleAddPermissionActionBuilder
Example to create an instance using the builder pattern
AssociateRoleAssignment
Example to create an instance using the builder pattern
AssociateRoleAssignment
Example to create an instance using the builder pattern
AssociateRoleAssignmentBuilder
Example to create an instance using the builder pattern
AssociateRoleAssignmentBuilder
Example to create an instance using the builder pattern
AssociateRoleAssignmentDraft
Example to create an instance using the builder pattern
AssociateRoleAssignmentDraftBuilder
Example to create an instance using the builder pattern
AssociateRoleBuilder
Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
AssociateRoleBuyerAssignableChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
AssociateRoleBuyerAssignableChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Changing the
buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.AssociateRoleChangeBuyerAssignableActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
AssociateRoleDraft
Example to create an instance using the builder pattern
AssociateRoleDraftBuilder
Example to create an instance using the builder pattern
Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
possible values of AssociateRoleInheritanceMode
possible values of AssociateRoleInheritanceMode
Reference to an AssociateRole by its key.
AssociateRoleKeyReferenceBuilder
Example to create an instance using the builder pattern
AssociateRoleLabel
Example to create an instance using the builder pattern
AssociateRoleLabelBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
AssociateRoleNameChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
AssociateRoleNameChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of AssociateRole.
AssociateRolePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Permissions update action.
AssociateRolePermissionAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Permissions update action.
AssociateRolePermissionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Permissions update action.
AssociateRolePermissionRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Permissions update action.
AssociateRolePermissionRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Permissions update action.
AssociateRolePermissionsSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Permissions update action.
AssociateRolePermissionsSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to an AssociateRole.
AssociateRoleReferenceBuilder
Example to create an instance using the builder pattern
Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
AssociateRoleRemovePermissionActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of an AssociateRole.
AssociateRoleResourceIdentifierBuilder
Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldAction
Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeAction
Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
AssociateRoleSetNameActionBuilder
Example to create an instance using the builder pattern
Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
AssociateRoleSetPermissionsActionBuilder
Example to create an instance using the builder pattern
AssociateRoleUpdate
Example to create an instance using the builder pattern
AssociateRoleUpdateAction
Example to create a subtype instance using the builder pattern
AssociateRoleUpdateActionBuilder
AssociateRoleUpdateBuilder
Example to create an instance using the builder pattern
Attribute
Example to create an instance using the builder pattern
This type represents the value of an attribute of a product variant.
Accessor for retrieving type safe attribute values
Deprecated.
Attribute type for Boolean values.
AttributeBooleanType
Example to create an instance using the builder pattern
AttributeBooleanTypeBuilder
Example to create an instance using the builder pattern
AttributeBooleanTypeBuilder
Example to create an instance using the builder pattern
AttributeBuilder
Example to create an instance using the builder pattern
AttributeBuilder
Specifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product:
AttributeConstraintEnum
AttributeConstraintEnum
possible values of AttributeConstraintEnum
possible values of AttributeConstraintEnum
possible values of AttributeConstraintEnum
AttributeConstraintEnumDraft
possible values of AttributeConstraintEnumDraft
AttributeDateTimeType
Example to create an instance using the builder pattern
AttributeDateTimeType
Example to create an instance using the builder pattern
AttributeDateTimeTypeBuilder
Example to create an instance using the builder pattern
AttributeDateTimeTypeBuilder
Example to create an instance using the builder pattern
AttributeDateType
Example to create an instance using the builder pattern
AttributeDateType
Example to create an instance using the builder pattern
AttributeDateTypeBuilder
Example to create an instance using the builder pattern
AttributeDateTypeBuilder
Example to create an instance using the builder pattern
Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
AttributeDefinition
Example to create an instance using the builder pattern
AttributeDefinition
Example to create an instance using the builder pattern
Returned when the
name of the AttributeDefinition conflicts with an existing Attribute.AttributeDefinitionAlreadyExistsErrorBuilder
Example to create an instance using the builder pattern
AttributeDefinitionBuilder
Example to create an instance using the builder pattern
AttributeDefinitionBuilder
Example to create an instance using the builder pattern
AttributeDefinitionBuilder
Example to create an instance using the builder pattern
Specify the Attribute to be created with the ProductTypeDraft.
AttributeDefinitionDraftBuilder
Example to create an instance using the builder pattern
Returned when the
type is different for an AttributeDefinition using the same name in multiple Product Types.AttributeDefinitionTypeConflictErrorBuilder
Example to create an instance using the builder pattern
Attribute type for plain enum values.
AttributeEnumType
Example to create an instance using the builder pattern
AttributeEnumTypeBuilder
Example to create an instance using the builder pattern
AttributeEnumTypeBuilder
Example to create an instance using the builder pattern
AttributeGroup
Example to create an instance using the builder pattern
AttributeGroupAddAttributeAction
Example to create an instance using the builder pattern
AttributeGroupAddAttributeActionBuilder
Example to create an instance using the builder pattern
AttributeGroupBuilder
Example to create an instance using the builder pattern
AttributeGroupChangeNameAction
Example to create an instance using the builder pattern
AttributeGroupChangeNameActionBuilder
Example to create an instance using the builder pattern
AttributeGroupDraft
Example to create an instance using the builder pattern
AttributeGroupDraftBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of AttributeGroup.AttributeGroupPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to an AttributeGroup.
AttributeGroupReferenceBuilder
Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeAction
Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an AttributeGroup.
AttributeGroupResourceIdentifierBuilder
Example to create an instance using the builder pattern
AttributeGroupSetAttributesAction
Example to create an instance using the builder pattern
AttributeGroupSetAttributesActionBuilder
Example to create an instance using the builder pattern
AttributeGroupSetDescriptionAction
Example to create an instance using the builder pattern
AttributeGroupSetDescriptionActionBuilder
Example to create an instance using the builder pattern
AttributeGroupSetKeyAction
Example to create an instance using the builder pattern
AttributeGroupSetKeyActionBuilder
Example to create an instance using the builder pattern
AttributeGroupUpdate
Example to create an instance using the builder pattern
AttributeGroupUpdateAction
Example to create a subtype instance using the builder pattern
AttributeGroupUpdateActionBuilder
AttributeGroupUpdateBuilder
Example to create an instance using the builder pattern
Attribute type for LocalizedString values.
AttributeLocalizableTextType
Example to create an instance using the builder pattern
AttributeLocalizableTextTypeBuilder
Example to create an instance using the builder pattern
AttributeLocalizableTextTypeBuilder
Example to create an instance using the builder pattern
Attribute type for localized enum values.
AttributeLocalizedEnumType
Example to create an instance using the builder pattern
AttributeLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
AttributeLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributeLocalizedEnumValue
Example to create an instance using the builder pattern
AttributeLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
AttributeLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
AttributeLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
AttributeMoneyType
Example to create an instance using the builder pattern
AttributeMoneyType
Example to create an instance using the builder pattern
AttributeMoneyTypeBuilder
Example to create an instance using the builder pattern
AttributeMoneyTypeBuilder
Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute
name.AttributeNameDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Attribute type for nesting Attributes based on some existing ProductType.
AttributeNestedType
Example to create an instance using the builder pattern
AttributeNestedTypeBuilder
Example to create an instance using the builder pattern
AttributeNestedTypeBuilder
Example to create an instance using the builder pattern
AttributeNumberType
Example to create an instance using the builder pattern
AttributeNumberType
Example to create an instance using the builder pattern
AttributeNumberTypeBuilder
Example to create an instance using the builder pattern
AttributeNumberTypeBuilder
Example to create an instance using the builder pattern
A plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
A plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributePlainEnumValue
Example to create an instance using the builder pattern
AttributePlainEnumValueBuilder
Example to create an instance using the builder pattern
AttributePlainEnumValueBuilder
Example to create an instance using the builder pattern
AttributePlainEnumValueBuilder
Example to create an instance using the builder pattern
AttributeReference
Example to create an instance using the builder pattern
AttributeReferenceBuilder
Example to create an instance using the builder pattern
AttributeReferenceType
Example to create an instance using the builder pattern
AttributeReferenceType
Example to create an instance using the builder pattern
AttributeReferenceTypeBuilder
Example to create an instance using the builder pattern
AttributeReferenceTypeBuilder
Example to create an instance using the builder pattern
Name of the resource type that the value should reference.
possible values of AttributeReferenceTypeId
Attributes
Example to create an instance using the builder pattern
Accessor to retrieve attribute values type safe
AttributesBuilder
Example to create an instance using the builder pattern
AttributeType that defines a set (without duplicate elements) with values of the given
elementType.AttributeSetType
Example to create an instance using the builder pattern
AttributeSetTypeBuilder
Example to create an instance using the builder pattern
AttributeSetTypeBuilder
Example to create an instance using the builder pattern
Attribute type for plain text values.
AttributeTextType
Example to create an instance using the builder pattern
AttributeTextTypeBuilder
Example to create an instance using the builder pattern
AttributeTextTypeBuilder
Example to create an instance using the builder pattern
AttributeTimeType
Example to create an instance using the builder pattern
AttributeTimeType
Example to create an instance using the builder pattern
AttributeTimeTypeBuilder
Example to create an instance using the builder pattern
AttributeTimeTypeBuilder
Example to create an instance using the builder pattern
Umbrella type for specific attribute types discriminated by property
name.AttributeType
Example to create an instance using the builder pattern
AttributeType
Example to create a subtype instance using the builder pattern
AttributeTypeBuilder
AttributeTypeBuilder
Example to create an instance using the builder pattern
AttributeTypeBuilder
AttributeValue
Example to create an instance using the builder pattern
AttributeValueBuilder
Example to create an instance using the builder pattern
Indicates the source and method that indirectly created or modified the resource.
AttributionBuilder
Example to create an instance using the builder pattern
AttributionSource
possible values of AttributionSource
AuthenticationMode
AuthenticationMode
AuthenticationMode
possible values of AuthenticationMode
possible values of AuthenticationMode
possible values of AuthenticationMode
Represents errors related to authentication and authorization in a format conforming to the OAuth 2.0 specification.
AuthErrorResponseBuilder
Example to create an instance using the builder pattern
The
Authorization header will be set to the content of headerValue.AuthorizationHeaderAuthenticationBuilder
Example to create an instance using the builder pattern
Defines the method of authentication for AWS SQS and SNS Destinations.
possible values of AwsAuthenticationMode
We recommend creating an Identify and Access Management (IAM) user with an
accessKey and accessSecret pair, specifically for each Extension that only has the lambda:InvokeFunction permission on this function.AWSLambdaDestinationBuilder
Example to create an instance using the builder pattern
Azure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.
AzureEventGridDestinationBuilder
Example to create an instance using the builder pattern
To protect your Azure Function, set its
authLevel to function and provide the function's key to be used inside the x-functions-key header.AzureFunctionsAuthenticationBuilder
Example to create an instance using the builder pattern
Azure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.
AzureServiceBusDestinationBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
BadGatewayErrorBuilder
Example to create an instance using the builder pattern
Deserializes the response payload as
ErrorResponsePolymorphic base type that represents a postal address and contact details.
BaseAddressBuilder
Example to create an instance using the builder pattern
Exception hierarchy
In order to work, the sdk needs an
VrapHttpClient provider, this can be done by extending HttpClientSupplier
and exposing it as a serviceBaseResource
Example to create an instance using the builder pattern
MoneyProvider which uses the Money implementation with BigDecimals.
This type represents an attribute whose value is either "true" or "false".
BooleanAttributeBuilder
Example to create an instance using the builder pattern
A field with a boolean value.
BooleanFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is set of boolean values.
BooleanSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a boolean set value.
BooleanSetFieldBuilder
Example to create an instance using the builder pattern
interface to build instance of T
Generic type to model the fields that all types of Business Units have in common.
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
BusinessUnitAddAddressActionBuilder
Example to create an instance using the builder pattern
Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.
BusinessUnitAddAssociateActionBuilder
Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
BusinessUnitAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
BusinessUnitAddressAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
BusinessUnitAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
BusinessUnitAddressChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
BusinessUnitAddressChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from an address of a Business Unit using the Set Address CustomField update action.
BusinessUnitAddressCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from an address of a Business Unit using the Set Custom Type in Address update action.
BusinessUnitAddressCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from an address of a Business Unit using the Set Custom Type in Address update action.
BusinessUnitAddressCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to an address of a Business Unit using the Set Custom Type in Address update action.
BusinessUnitAddressCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to an address of a Business Unit using the Set Custom Type in Address update action.
BusinessUnitAddressCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
BusinessUnitAddressRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
BusinessUnitAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
BusinessUnitAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message.
BusinessUnitAddStoreActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Associate update action.
BusinessUnitAssociateAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Associate update action.
BusinessUnitAssociateAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Associate update action.
BusinessUnitAssociateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Associate update action.
BusinessUnitAssociateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Determines whether a Business Unit can inherit Associates from a parent.
Determines whether a Business Unit can inherit Associates from a parent.
possible values of BusinessUnitAssociateMode
possible values of BusinessUnitAssociateMode
Generated after a successful Change Associate Mode update action.
BusinessUnitAssociateModeChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Associate Mode update action.
BusinessUnitAssociateModeChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Associate update action.
BusinessUnitAssociateRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Associate update action.
BusinessUnitAssociateRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Associates update action.
BusinessUnitAssociatesSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Associates update action.
BusinessUnitAssociatesSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Billing Address Identifier update action.
BusinessUnitBillingAddressAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Billing Address Identifier update action.
BusinessUnitBillingAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBillingAddressRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBillingAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
BusinessUnitBuilder
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
BusinessUnitChangeAddressActionBuilder
Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
BusinessUnitChangeAssociateActionBuilder
Example to create an instance using the builder pattern
Only Business Units of type
Division can be changed to ExplicitAndFromParent.BusinessUnitChangeAssociateModeActionBuilder
Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
BusinessUnitChangeNameActionBuilder
Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
BusinessUnitChangeParentUnitActionBuilder
Example to create an instance using the builder pattern
Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.
BusinessUnitChangeStatusActionBuilder
Example to create an instance using the builder pattern
BusinessUnitConfiguration
Example to create an instance using the builder pattern
BusinessUnitConfigurationBuilder
Example to create an instance using the builder pattern
Default value for Business Unit Status configured though Project settings.
possible values of BusinessUnitConfigurationStatus
Generated after a successful Set Contact Email update action.
BusinessUnitContactEmailSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Contact Email update action.
BusinessUnitContactEmailSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create BusinessUnit request.
BusinessUnitCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create BusinessUnit request.
BusinessUnitCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Business Unit using the Set CustomField update action.
BusinessUnitCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Business Unit using the Set Custom Type update action.
BusinessUnitCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Business Unit using the Set Custom Type update action.
BusinessUnitCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Business Unit using the Set Custom Type update action.
BusinessUnitCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Business Unit using the Set Custom Type update action.
BusinessUnitCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Default Billing Address update action.
BusinessUnitDefaultBillingAddressSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Default Billing Address update action.
BusinessUnitDefaultBillingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Default Shipping Address update action.
BusinessUnitDefaultShippingAddressSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Default Shipping Address update action.
BusinessUnitDefaultShippingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete BusinessUnit request.
BusinessUnitDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete BusinessUnit request.
BusinessUnitDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generic draft type to model those fields all Business Units have in common.
BusinessUnitDraftBuilder
Reference to a BusinessUnit by its key.
BusinessUnitKeyReferenceBuilder
Example to create an instance using the builder pattern
BusinessUnitLabel
Example to create an instance using the builder pattern
BusinessUnitLabelBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Name update action.
BusinessUnitNameChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Name update action.
BusinessUnitNameChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of BusinessUnit.
BusinessUnitPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Parent Unit update action.
BusinessUnitParentChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Parent Unit update action.
BusinessUnitParentChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a BusinessUnit.
BusinessUnitReferenceBuilder
Example to create an instance using the builder pattern
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
BusinessUnitRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
BusinessUnitRemoveAssociateActionBuilder
Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
BusinessUnitRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
BusinessUnitRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes a Store from the Business Unit.
BusinessUnitRemoveStoreActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a BusinessUnit.
BusinessUnitResourceIdentifierBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.
BusinessUnitSetAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.
BusinessUnitSetAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.
BusinessUnitSetAssociatesActionBuilder
Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
BusinessUnitSetContactEmailActionBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.
BusinessUnitSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.
BusinessUnitSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
BusinessUnitSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
BusinessUnitSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Only Business Units of type
Division can be have a store mode of FromParent.BusinessUnitSetStoreModeActionBuilder
Example to create an instance using the builder pattern
Sets the Stores of the Business Unit.
BusinessUnitSetStoresActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Shipping Address Identifier update action.
BusinessUnitShippingAddressAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Shipping Address Identifier update action.
BusinessUnitShippingAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Shipping Address Identifier update action.
BusinessUnitShippingAddressRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Shipping Address Identifier update action.
BusinessUnitShippingAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Indicates whether the Business Unit can be edited and used in Carts, Orders, Quote Requests, or Quotes.
Indicates whether the Business Unit can be edited and used in Carts, Orders, Quote Requests, or Quotes.
possible values of BusinessUnitStatus
possible values of BusinessUnitStatus
Generated after a successful Change Status update action.
BusinessUnitStatusChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Status update action.
BusinessUnitStatusChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
BusinessUnitStoreAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
BusinessUnitStoreAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
possible values of BusinessUnitStoreMode
possible values of BusinessUnitStoreMode
Generated after a successful Set Store Mode update action.
BusinessUnitStoreModeChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Store Mode update action.
BusinessUnitStoreModeChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Store update action.
BusinessUnitStoreRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Store update action.
BusinessUnitStoreRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
BusinessUnitStoresSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
BusinessUnitStoresSetMessagePayloadBuilder
Example to create an instance using the builder pattern
The type of the Business Unit indicating its position in a hierarchy.
possible values of BusinessUnitType
BusinessUnitUpdate
Example to create an instance using the builder pattern
BusinessUnitUpdateAction
Example to create a subtype instance using the builder pattern
BusinessUnitUpdateActionBuilder
BusinessUnitUpdateBuilder
Example to create an instance using the builder pattern
Checks if an API Client exists for a given
id.Checks if an API Client exists for a given Query Predicate.
Checks if a BusinessUnit exists for a given
id.Checks if a BusinessUnit exists for a given Query Predicate.
Checks if a BusinessUnit exists for a given
key.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Cart exists for a given
id.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Cart exists for a given Query Predicate.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Cart exists for a given
key.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Creates a Cart in the BusinessUnit referenced by
businessUnitKey.Creates a Cart in the BusinessUnit referenced by
businessUnitKey.Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if an Order exists for a given
id.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if an Order exists for a given Query Predicate.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if an Order exists for a given
orderNumber.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Creates an Order from a Cart in a BusinessUnit.
Creates an Order from a Cart in a BusinessUnit.
Creates an Order from a Quote in a BusinessUnit.
Creates an Order from a Quote in a BusinessUnit.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a QuoteRequest exists for a given
id.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a QuoteRequest exists for a given Query Predicate.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a QuoteRequest exists for a given
key.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Creates a QuoteRequest in a BusinessUnit.
Creates a QuoteRequest in a BusinessUnit.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Quote exists for a given
id.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Quote exists for a given Query Predicate.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if a Quote exists for a given
key.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.
Checks if an AssociateRole exists for a given
id.Checks if an AssociateRole exists for a given Query Predicate.
Deleting an AssociateRole generates the AssociateRoleDeleted Message.
Checks if an AssociateRole exists for a given
key.Creating a Associate Role generates the AssociateRoleCreated Message.
Creating a Associate Role generates the AssociateRoleCreated Message.
Checks if an AttributeGroup exists for a given
id.Checks if an AttributeGroup exists for a given Query Predicate.
Checks if an AttributeGroup exists for a given
key.Checks if a BusinessUnit exists for a given
id.Checks if a BusinessUnit exists for a given Query Predicate.
Checks if a BusinessUnit exists for a given
key.The
view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.The
view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.Deleting a Cart Discount produces the CartDiscountDeleted Message.
Checks if a CartDiscount exists for a given
id.Checks if a CartDiscount exists for a given Query Predicate.
Deleting a Cart Discount produces the CartDiscountDeleted Message.
Checks if a CartDiscount exists for a given
key.Creating a Cart Discount produces the CartDiscountCreated Message.
Creating a Cart Discount produces the CartDiscountCreated Message.
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
Checks if a Cart exists for a given
id.Retrieves the recently modified active Cart of a Customer with CartOrigin
Customer.Checks if a Cart of a Customer exists.
Checks if a Cart exists for a given Query Predicate.
To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.
Checks if a Cart exists for a given
key.Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has a
predicate that does not match the Cart.Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has a
predicate that does not match the Cart.Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
view_products:{projectKey} or view_categories:{projectKey} is required.Checks if a Category exists for a given
id.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
view_products:{projectKey} or view_categories:{projectKey} is required.Checks if a Category exists for on a given Query Predicate.
Creates a request for creating new Categories or updating existing ones.
Creates a request for creating new Categories or updating existing ones.
Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
view_products:{projectKey} or view_categories:{projectKey} is required.Checks if a Category exists for a given
key.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Either the scope
manage_products:{projectKey} or manage_categories:{projectKey} is required.Returns a ReferenceExists error if other resources reference the Channel to be deleted.
Checks if a Channel exists for a given
id.Checks if a Channel exists for a given Query Predicate.
Checks if a CustomerGroup exists for a given
id.Checks if a CustomerGroup exists for a given Query Predicate.
Checks if a CustomerGroup exists for a given
key.Deleting a Customer produces the CustomerDeleted Message.
Checks if a Customer exists for a given
id.Simultaneously updating two Customers with the same email address can return a LockedField error.
Simultaneously updating two Customers with the same email address can return a LockedField error.
Verifying the email of the Customer produces the CustomerEmailVerified Message.
Verifying the email of the Customer produces the CustomerEmailVerified Message.
Produces the CustomerEmailTokenCreated Message.
Produces the CustomerEmailTokenCreated Message.
Checks if a Customer exists for a given Query Predicate.
Creates a request for creating new Customers or updating existing ones.
Creates a request for creating new Customers or updating existing ones.
Deleting a Customer produces the CustomerDeleted Message.
Checks if a Customer exists for a given
key.Simultaneously updating two Customers with the same email address can return a LockedField error.
Simultaneously updating two Customers with the same email address can return a LockedField error.
Changing the password produces the CustomerPasswordUpdated Message with
reset=false.Changing the password produces the CustomerPasswordUpdated Message with
reset=false.Resetting the password of the Customer produces the CustomerPasswordUpdated Message with
reset=true.Resetting the password of the Customer produces the CustomerPasswordUpdated Message with
reset=true.If the
anonymousCart field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.If the
anonymousCart field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.Deprecated.
Checks if a CustomObject exists for a given Query Predicate.
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.
Deleting a Discount Code produces the DiscountCodeDeleted Message.
Deprecated scope:
view_orders:{projectKey}Checks if a DiscountCode exists for a given
id.Deprecated scope:
manage_orders:{projectKey}Deprecated scope:
manage_orders:{projectKey}Deprecated scope:
view_orders:{projectKey}Checks if a DiscountCode exists for a given Query Predicate.
Creates a request for creating new Discount Codes or updating existing ones.
Creates a request for creating new Discount Codes or updating existing ones.
Deleting a Discount Code produces the DiscountCodeDeleted Message.
Deprecated scope:
view_orders:{projectKey}Checks if a DiscountCode exists for a given
key.Deprecated scope:
manage_orders:{projectKey}Deprecated scope:
manage_orders:{projectKey}Creating a Discount Code produces the DiscountCodeCreated Message.
Creating a Discount Code produces the DiscountCodeCreated Message.
Checks if an Extension exists for a given
id.Checks if an Extension exists for a given Query Predicate.
Checks if an Extension exists for a given
key.The
view_audit_log:{projectKey} scope is required, and depending on the resource type queried, their respective scopes must be granted.Execute a GraphQL query
Execute a GraphQL query
Execute a GraphQL query
Checks if a Project exists for a given
projectKey.Deletes the import container given by the key.
Retrieves the import container given by the key.
Retrieves all ImportOperations of a given ImportContainer key.
Retrieves an ImportSummary for the given import container.
Updates the import container given by the key.
Updates the import container given by the key.
Retrieves all import containers of a given project key.
Creates a new import container.
Creates a new import container.
Retrieves the ImportOperation of a given ID.
The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.
The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.
To delete a CartDiscount, specify the
manage_cart_discounts:{projectKey}:{storeKey} scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists for a given
id.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.
To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.
Checks if a CartDiscount exists for a given Query Predicate.
To delete a CartDiscount, specify the
manage_cart_discounts:{projectKey}:{storeKey} scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists for a given
key.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.
To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.
When using the endpoint, the Store specified in the path and the Stores specified in the payload's
stores field are added to the CartDiscount.When using the endpoint, the Store specified in the path and the Stores specified in the payload's
stores field are added to the CartDiscount.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if a Cart exists for a given
id.Updates a Cart in the Store specified by
storeKey.Updates a Cart in the Store specified by
storeKey.Retrieves the recently modified active Cart of a Customer with CartOrigin
Customer.Checks if a Cart of a Customer exists.
Queries carts in a specific Store.
Checks if a Cart exists for a given Query Predicate.
If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if a Cart exists for a given
key.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Creates a Cart in the Store specified by
storeKey.Creates a Cart in the Store specified by
storeKey.Creates a new Cart by replicating an existing Cart or Order.
Creates a new Cart by replicating an existing Cart or Order.
Deleting a Customer produces the CustomerDeleted Message.
If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists for a given
id.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.The customer verifies the email using the token value.
The customer verifies the email using the token value.
If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists for a given Query Predicate.
Deleting a Customer produces the CustomerDeleted Message.
If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists for a given
key.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.Resetting the password of the Customer produces the CustomerPasswordUpdated Message with
reset=true.Resetting the password of the Customer produces the CustomerPasswordUpdated Message with
reset=true.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but the
stores field references a different Store, this method returns a ResourceNotFound error.When using this endpoint, if omitted, the Customer
stores field is set to the Store specified in the path parameter.When using this endpoint, if omitted, the Customer
stores field is set to the Store specified in the path parameter.Authenticates a Customer associated with a Store.
Authenticates a Customer associated with a Store.
Retrieves the Customer's most recently modified active Cart in the Store specified by the
storeKey path parameter.Checks if an active Cart exists.
Checks ifa My Cart exists for a given
id.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if a Cart exists for a given Query Predicate.
The
store field in the created Cart is set to the Store specified by the storeKey path parameter.The
store field in the created Cart is set to the Store specified by the storeKey path parameter.This is the last step in the email verification process of a Customer.
This is the last step in the email verification process of a Customer.
Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.
Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.
If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a given
id.Checks if an Order exists for a given Query Predicate.
The Cart must have a shipping address set for taxes to be calculated.
The Cart must have a shipping address set for taxes to be calculated.
Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.This is the last step in the password reset process of the authenticated Customer.
This is the last step in the password reset process of the authenticated Customer.
If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given
id.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given Query Predicate.
If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given
key.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.When using this endpoint, the
store field of a ShoppingList is always set to the Store specified in the path parameter.When using this endpoint, the
store field of a ShoppingList is always set to the Store specified in the path parameter.If omitted in the request body, the Customer
stores field is set to the Store specified in the path parameter.If omitted in the request body, the Customer
stores field is set to the Store specified in the path parameter.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a given
id.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a given Query Predicate.
If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a given
orderNumber.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have the
store field, or the store field references a different Store, this method returns a ResourceNotFound error.Before you create an Order, the Cart must have a shipping address set.
Before you create an Order, the Cart must have a shipping address set.
Gets the current or staged representation of a Product by its ID in the specified Store.
Checks if the current or staged representations of a Product exists for a given
id in the specified Store.Gets the current or staged representation of a Product by its key in the specified Store.
Checks if the current or staged representations of a Product exists for a given
key in the specified Store.Generates the ProductTailoringDeleted Message.
Gets the current or staged representation of a Product Tailoring by its Product ID in the specified Store.
Updates the current or staged representation of a Product Tailoring by its Product ID in the specified Store.
Updates the current or staged representation of a Product Tailoring by its Product ID in the specified Store.
Queries Product Selection assignments in a specific Store.
Generates the ProductTailoringDeleted Message.
Gets the current or staged representation of a Product Tailoring by its Product key in the specified Store.
Updates the current or staged representation of a Product Tailoring by its Product key in the specified Store.
Updates the current or staged representation of a Product Tailoring by its Product key in the specified Store.
Queries Product Tailoring in a specific Store.
Creates a ProductTailoring in the Store specified by
storeKey.Creates a ProductTailoring in the Store specified by
storeKey.Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store.
Checks if a ShippingMethod that can ship to the shipping address of the given Cart exists in the given Store.
If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given
id.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given Query Predicate.
If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.Checks if a ShoppingList exists for a given
key.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have the
store field, or the store field references a different Store, the ResourceNotFound error is returned.When using this endpoint, the
store field of a ShoppingList is always set to the Store specified in the path parameter.When using this endpoint, the
store field of a ShoppingList is always set to the Store specified in the path parameter.Creates a request for creating new Inventories or updating existing ones.
Creates a request for creating new Inventories or updating existing ones.
Produces the InventoryEntryDeleted Message.
Checks if an InventoryEntry exists for a given
id.Checks if an InventoryEntry exists for a given Query Predicate.
Produces the InventoryEntryDeleted Message.
Checks if an InventoryEntry exists for a given
key.Produces the InventoryEntryCreated Message.
Produces the InventoryEntryCreated Message.
Authenticates a global Customer not associated with a Store.
Authenticates a global Customer not associated with a Store.
Retrieves the Customer's most recently modified active Cart.
Checks if an active Cart exists.
Checks if a BusinessUnit exists for a given
id.Checks if a BusinessUnit exists for a given Query Predicate.
Checks if a BusinessUnit exists for a given
key.Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.
Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.
Checks if a Cart exists for a given
id.Checks if a Cart exists for a given Query Predicate.
Checks if a Cart exists for a given
key.Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.
Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.
This is the last step in the email verification process of a Customer.
This is the last step in the email verification process of a Customer.
Retrieves the authenticated customer (that matches the given email/password pair).
Retrieves the authenticated customer (that matches the given email/password pair).
Checks if an Order exists for a given
id.Checks if an Order exists for a given Query Predicate.
The Cart must have a shipping address set for taxes to be calculated.
The Cart must have a shipping address set for taxes to be calculated.
When creating B2B Orders, the Customer must have the
CreateMyOrdersFromMyQuotes Permission.When creating B2B Orders, the Customer must have the
CreateMyOrdersFromMyQuotes Permission.Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.Changing the password of the Customer produces the CustomerPasswordUpdated Message with
reset=false.This is the last step in the password reset process of a Customer.
This is the last step in the password reset process of a Customer.
This endpoint can only delete a Payment when it has no Transactions.
Checks if a Payment exists for a given
id.This endpoint can only update a Payment when it has no Transactions.
This endpoint can only update a Payment when it has no Transactions.
Checks if a Payment exists for a given Query Predicate.
Creating a Payment produces the PaymentCreated Message.
Creating a Payment produces the PaymentCreated Message.
Checks if my QuoteRequest exists for a given
id.Checks if my QuoteRequest exists for a given Query Predicate.
Checks if my QuoteRequest exists for a given
key.Checks if a Quote exists for a given
id.Checks if a Quote exists for a given Query Predicate.
Checks if a Quote exists for a given
key.Checks if a ShoppingList exists for a given
id.Checks if a ShoppingList exists for a given Query Predicate.
Checks if a ShoppingList exists for a given
key.If used with an access token for an anonymous session, all Orders and Carts that belong to the
anonymousId are assigned to the newly created Customer.If used with an access token for an anonymous session, all Orders and Carts that belong to the
anonymousId are assigned to the newly created Customer.Deprecated scope:
view_orders:{projectKey}Checks if a Message exists for a given
id.Deprecated scope:
view_orders:{projectKey}Checks if a Message exists for a given Query Predicate.
Creates a new import request for order patches
Creates a new import request for order patches
Deleting an Order produces the OrderDeleted Message.
Checks if an Order exists for a given
id.Applying an OrderEdit produces the OrderEditApplied Message.
Applying an OrderEdit produces the OrderEditApplied Message.
Checks if an OrderEdit exists for a given
id.Checks if an OrderEdit exists for a given Query Predicate.
Checks if an OrderEdit exists for a given
key.You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.
Checks if an Order exists for a given Query Predicate.
Creates a request for creating new Orders.
Creates a request for creating new Orders.
Importing an Order produces the Order Imported Message.
Importing an Order produces the Order Imported Message.
Deleting an Order produces the OrderDeleted Message.
Checks if an Order exists for a given
orderNumber.Before you create an Order, the Cart must have a shipping address set.
Before you create an Order, the Cart must have a shipping address set.
Creating an Order produces the OrderCreated Message.
Creating an Order produces the OrderCreated Message.
Checks whether a search index for the Project's Orders exists.
Checks if a Payment exists for a given
id.Checks if a Payment exists for a given Query Predicate.
Checks if a Payment exists for a given
key.Creating a Payment produces the PaymentCreated Message.
Creating a Payment produces the PaymentCreated Message.
Creates a request for creating new Prices or updating existing ones.
Creates a request for creating new Prices or updating existing ones.
Checks if a ProductDiscount exists for a given
id.Checks if a ProductDiscount exists for a given Query Predicate.
Checks if a ProductDiscount exists for a given
key.This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.
This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.
Creates a request for creating new ProductDrafts or updating existing ones.
Creates a request for creating new ProductDrafts or updating existing ones.
Gets the current or staged representation of a Product by its ID.
Checks if the current or staged representation of a Product exists for a given
id.Use the Product Projections query endpoint to get the current or staged representations of Products.
Checks if the current or staged representation of a Product exists for a given Query Predicate.
Gets the current or staged representation of a Product found by Key.
Checks if the current or staged representation of a Product exists for a given
key.Product Projection Search
Product Projection Search
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
Checks if a Product exists for a given
id.Upload a JPEG, PNG and GIF file to a ProductVariant.
Upload a JPEG, PNG and GIF file to a ProductVariant.
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
Deletion will only succeed if the Product Selection is not assigned to any Store.
Checks if a ProductSelection exists for a given
id.Checks if a ProductSelection exists for a given Query Predicate.
Deletion will only succeed if the Product Selection is not assigned to any Store.
Checks if a ProductSelection exists for a given
key.If Price selection query parameters are provided, the selected Prices are added to the response.
Checks if a Product exists for a given Query Predicate.
Creates a request for creating new Products or updating existing ones.
Creates a request for creating new Products or updating existing ones.
If Price selection query parameters are provided, the selected Prices are added to the response.
If Price selection query parameters are provided, the selected Prices are added to the response.
Checks if a Product exists for a given
key.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.
A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.
To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.
To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.
Generates the ProductTailoringDeleted Message.
Generates the ProductTailoringDeleted Message.
Generates the ProductTailoringCreated Message.
Generates the ProductTailoringCreated Message.
Checks if a ProductType exists for a given
id.Checks if a ProductType exists for a given Query Predicate.
Creates a request for creating new ProductTypes or updating existing ones.
Creates a request for creating new ProductTypes or updating existing ones.
Checks if a ProductType exists for a given
key.Creates a new import request for product variant patches
Creates a new import request for product variant patches
Creates a request for creating new ProductVariants or updating existing ones.
Creates a request for creating new ProductVariants or updating existing ones.
Checks if a QuoteRequest exists for a given
id.Checks if a QuoteRequest exists for a given Query Predicate.
Checks if a QuoteRequest exists for a given
key.Checks if a Quote exists for a given
id.Checks if a Quote exists for a given Query Predicate.
Checks if a Quote exists for a given
key.Checks if a Review exists for a given
id.Checks if a Review exists for a given Query Predicate.
Checks if a Review exists for a given
key.Checks if a ShippingMethod exists for a given
id.Checks if a ShippingMethod exists for a given Query Predicate.
Checks if a ShippingMethod exists for a given
key.Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart.
Checks if a ShippingMethod exists for the given Cart.
Retrieves all the ShippingMethods that can ship to the given Location with a
predicate that matches the given Cart.Checks if a ShippingMethod that can ship to the given Location exists for the given Cart.
Retrieves all the ShippingMethods that can ship to the given Location.
Checks if a ShippingMethod that can ship to the given Location exists.
Retrieves all the ShippingMethods that can ship to the given Location for an OrderEdit.
Checks if a ShippingMethod that can ship to the given Location exists for the given OrderEdit.
Checks if a ShoppingList exists for a given
id.Checks if a ShoppingList exists for a given Query Predicate.
Checks if a ShoppingList exists for a given
key.Checks if a StagedQuote exists for a given
id.Checks if a StagedQuote exists for a given Query Predicate.
Checks if a StagedQuote exists for a given
key.Produces the StandalonePriceDeleted Message.
Checks if a StandalonePrice exists for a given
id.Checks if a StandalonePrice exists for a given Query Predicate.
Creates a request for creating new Standalone Prices or updating existing ones.
Creates a request for creating new Standalone Prices or updating existing ones.
Produces the StandalonePriceDeleted Message.
Checks if a StandalonePrice exists for a given
key.Produces the StandalonePriceCreated Message.
Produces the StandalonePriceCreated Message.
Checks if a State exists for a given
id.Checks if a State exists for a given Query Predicate.
Checks if a State exists for a given
key.Checks if a Store exists for a given
id.Checks if a Store exists for a given Query Predicate.
Checks if a Store exists for a given
key.Checks if a Subscription exists for a given
id.This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions.
Checks if a Subscription exists for a given Query Predicate.
Checks if a Subscription exists for a given
key.A test message is sent to ensure the correct configuration of the Destination.
A test message is sent to ensure the correct configuration of the Destination.
Checks if a TaxCategory exists for a given
id.Checks if a TaxCategory exists for a given Query Predicate.
Checks if a TaxCategory exists for a given
key.Checks if a Type exists for a given
id.Checks if a Type exists for a given Query Predicate.
Creates a request for creating new Type or updating existing ones.
Creates a request for creating new Type or updating existing ones.
Checks if a Type exists for a given
key.Checks if a Zone exists for a given
id.Checks if a Zone exists for a given Query Predicate.
Checks if a Zone exists for a given
key.Cart
Example to create an instance using the builder pattern
If the Cart already contains a CustomLineItem with the same
slug, name, money, taxCategory, state, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.CartAddCustomLineItemActionBuilder
Example to create an instance using the builder pattern
To add a custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) to the Cart, it must have the
Multiple ShippingMode.CartAddCustomShippingMethodActionBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
CartAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
CartAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
CartAddLineItemActionBuilder
Example to create an instance using the builder pattern
CartAddPaymentAction
Example to create an instance using the builder pattern
CartAddPaymentActionBuilder
Example to create an instance using the builder pattern
Adds a Shipping Method for a specified shipping address to a Cart with
Multiple ShippingMode.CartAddShippingMethodActionBuilder
Example to create an instance using the builder pattern
Adds all LineItems of a ShoppingList to the Cart.
CartAddShoppingListActionBuilder
Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction
Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
To override the shipping details, see Set LineItem ShippingDetails.
CartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
CartBuilder
Example to create an instance using the builder pattern
CartChangeCustomLineItemMoneyAction
Example to create an instance using the builder pattern
CartChangeCustomLineItemMoneyActionBuilder
Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeAction
Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeActionBuilder
Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
CartChangeCustomLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
CartChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
Changing the tax calculation mode leads to recalculation of taxes.
CartChangeTaxCalculationModeActionBuilder
Example to create an instance using the builder pattern
When
External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed.
When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress.
Example to create an instance using the builder pattern
CartChangeTaxModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax rounding mode leads to recalculation of taxes.
CartChangeTaxRoundingModeActionBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example,
Light, Medium, or Heavy).CartClassificationTier
Example to create an instance using the builder pattern
CartClassificationTierBuilder
Example to create an instance using the builder pattern
CartClassificationTierBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example,
Light, Medium, or Heavy).CartClassificationTypeBuilder
Example to create an instance using the builder pattern
CartDiscount
Example to create an instance using the builder pattern
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountAddStoreActionBuilder
Example to create an instance using the builder pattern
CartDiscountBuilder
Example to create an instance using the builder pattern
CartDiscountChangeCartPredicateAction
Example to create an instance using the builder pattern
CartDiscountChangeCartPredicateActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeIsActiveAction
Example to create an instance using the builder pattern
CartDiscountChangeIsActiveActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeNameAction
Example to create an instance using the builder pattern
CartDiscountChangeNameActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeAction
Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeSortOrderAction
Example to create an instance using the builder pattern
CartDiscountChangeSortOrderActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeStackingModeAction
Example to create an instance using the builder pattern
CartDiscountChangeStackingModeActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeTargetAction
Example to create an instance using the builder pattern
CartDiscountChangeTargetActionBuilder
Example to create an instance using the builder pattern
Changes the CartDiscountValue for relative, absolute and fixed price CartDiscounts.
CartDiscountChangeValueActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create CartDiscount request.
CartDiscountCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create CartDiscount request.
CartDiscountCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Discount is applied to CustomLineItems matching the
predicate.CartDiscountCustomLineItemsTargetBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete CartDiscount request.
CartDiscountDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete CartDiscount request.
CartDiscountDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
CartDiscountDraft
Example to create an instance using the builder pattern
CartDiscountDraftBuilder
Example to create an instance using the builder pattern
References a cart discount by key.
CartDiscountKeyReferenceBuilder
Example to create an instance using the builder pattern
Discount is applied to LineItems matching the
predicate.CartDiscountLineItemsTargetBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CartDiscount.CartDiscountPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a CartDiscount.
CartDiscountReferenceBuilder
Example to create an instance using the builder pattern
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountRemoveStoreActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a CartDiscount.
CartDiscountResourceIdentifierBuilder
Example to create an instance using the builder pattern
CartDiscountSetCustomFieldAction
Example to create an instance using the builder pattern
CartDiscountSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetCustomTypeAction
Example to create an instance using the builder pattern
CartDiscountSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetDescriptionAction
Example to create an instance using the builder pattern
CartDiscountSetDescriptionActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetKeyAction
Example to create an instance using the builder pattern
CartDiscountSetKeyActionBuilder
Example to create an instance using the builder pattern
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountSetStoresActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidFromAction
Example to create an instance using the builder pattern
CartDiscountSetValidFromActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilAction
Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidUntilAction
Example to create an instance using the builder pattern
CartDiscountSetValidUntilActionBuilder
Example to create an instance using the builder pattern
Discount is applied to the shipping costs of the Cart.
CartDiscountShippingCostTargetBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
CartDiscountStoreAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
CartDiscountStoreAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Store update action.
CartDiscountStoreRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Store update action.
CartDiscountStoreRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
CartDiscountStoresSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
CartDiscountStoresSetMessagePayloadBuilder
Example to create an instance using the builder pattern
CartDiscountTarget
Example to create a subtype instance using the builder pattern
CartDiscountTargetBuilder
Discount is applied to the total price of the Cart.
CartDiscountTotalPriceTargetBuilder
Example to create an instance using the builder pattern
CartDiscountUpdate
Example to create an instance using the builder pattern
CartDiscountUpdateAction
Example to create a subtype instance using the builder pattern
CartDiscountUpdateActionBuilder
CartDiscountUpdateBuilder
Example to create an instance using the builder pattern
CartDiscountValue
Example to create a subtype instance using the builder pattern
Discounts the CartDiscountTarget by an absolute amount (not allowed for MultiBuyLineItemsTarget and MultiBuyCustomLineItemsTarget).
CartDiscountValueAbsoluteBuilder
Example to create an instance using the builder pattern
CartDiscountValueAbsoluteDraft
Example to create an instance using the builder pattern
CartDiscountValueAbsoluteDraftBuilder
Example to create an instance using the builder pattern
CartDiscountValueBuilder
CartDiscountValueDraft
Example to create a subtype instance using the builder pattern
CartDiscountValueDraftBuilder
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the
money field, if it is lower than the current Line Item price for the same currency.CartDiscountValueFixedBuilder
Example to create an instance using the builder pattern
Sets the DiscountedLineItemPrice of the CartDiscountLineItemsTarget or CartDiscountCustomLineItemsTarget to the value specified in the
money field, if it is lower than the current Line Item price for the same currency.CartDiscountValueFixedDraftBuilder
Example to create an instance using the builder pattern
CartDiscountValueGiftLineItem
Example to create an instance using the builder pattern
CartDiscountValueGiftLineItemBuilder
Example to create an instance using the builder pattern
Can only be used in a CartDiscountDraft with no
target specified.CartDiscountValueGiftLineItemDraftBuilder
Example to create an instance using the builder pattern
Discounts the CartDiscountTarget relative to its price.
CartDiscountValueRelativeBuilder
Example to create an instance using the builder pattern
CartDiscountValueRelativeDraft
Example to create an instance using the builder pattern
CartDiscountValueRelativeDraftBuilder
Example to create an instance using the builder pattern
CartDraft
Example to create an instance using the builder pattern
CartDraftBuilder
Example to create an instance using the builder pattern
Changes the CartState from
Active to Frozen.CartFreezeCartActionBuilder
Example to create an instance using the builder pattern
References a cart by key.
CartKeyReferenceBuilder
Example to create an instance using the builder pattern
Indicates who created the Cart.
Maps to
Order.origin.possible values of CartOrigin
possible values of CartOrigin
PagedQueryResult with results containing an array of Cart.
CartPagedQueryResponseBuilder
Example to create an instance using the builder pattern
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
CartRecalculateActionBuilder
Example to create an instance using the builder pattern
Reference to a Cart.
CartReferenceBuilder
Example to create an instance using the builder pattern
This update action does not support specifying quantities, unlike the Remove LineItem update action.
CartRemoveCustomLineItemActionBuilder
Example to create an instance using the builder pattern
CartRemoveDiscountCodeAction
Example to create an instance using the builder pattern
CartRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
CartRemoveItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
CartRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
CartRemovePaymentAction
Example to create an instance using the builder pattern
CartRemovePaymentActionBuilder
Example to create an instance using the builder pattern
Removes a Shipping Method from a Cart that has the
Multiple ShippingMode.CartRemoveShippingMethodActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Cart.
CartResourceIdentifierBuilder
Example to create an instance using the builder pattern
CartsConfiguration
Example to create an instance using the builder pattern
CartsConfigurationBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
CartScoreTierBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
CartScoreTypeBuilder
Example to create an instance using the builder pattern
CartSetAnonymousIdAction
Example to create an instance using the builder pattern
CartSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressAction
Example to create an instance using the builder pattern
CartSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
CartSetBusinessUnitActionBuilder
Example to create an instance using the builder pattern
This update action results in the
taxedPrice field being added to the Cart when the ExternalAmount TaxMode is used.CartSetCartTotalTaxActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
CartSetCountryActionBuilder
Example to create an instance using the builder pattern
CartSetCustomerEmailAction
Example to create an instance using the builder pattern
CartSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
This update action can only be used if a Customer is not assigned to a Cart.
CartSetCustomerGroupActionBuilder
Example to create an instance using the builder pattern
Setting the Cart's
customerId can lead to updates on all its LineItem prices.CartSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
CartSetCustomFieldAction
Example to create an instance using the builder pattern
CartSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
ExternalAmount TaxMode.CartSetCustomLineItemTaxAmountActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.CartSetCustomLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the
Single ShippingMode and a shippingAddress.CartSetCustomShippingMethodActionBuilder
Example to create an instance using the builder pattern
CartSetCustomTypeAction
Example to create an instance using the builder pattern
CartSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Number of days after which a Cart with
Active CartState is deleted since its last modification.CartSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
CartSetDirectDiscountsActionBuilder
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetKeyAction
Example to create an instance using the builder pattern
CartSetKeyActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
CartSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
CartSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.CartSetLineItemDistributionChannelActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemInventoryModeAction
Example to create an instance using the builder pattern
CartSetLineItemInventoryModeActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.CartSetLineItemPriceActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
CartSetLineItemSupplyChannelActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
ExternalAmount TaxMode.CartSetLineItemTaxAmountActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.CartSetLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.CartSetLineItemTotalPriceActionBuilder
Example to create an instance using the builder pattern
CartSetLocaleAction
Example to create an instance using the builder pattern
CartSetLocaleActionBuilder
Example to create an instance using the builder pattern
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
CartSetShippingAddressActionBuilder
Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetShippingCustomFieldAction
Example to create an instance using the builder pattern
CartSetShippingCustomFieldActionBuilder
Example to create an instance using the builder pattern
This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's
shippingMethod or shipping.CartSetShippingCustomTypeActionBuilder
Example to create an instance using the builder pattern
To set the Cart's Shipping Method the Cart must have the
Single ShippingMode and a shippingAddress.CartSetShippingMethodActionBuilder
Example to create an instance using the builder pattern
A Shipping Method tax amount can be set if the Cart has the
ExternalAmount TaxMode.CartSetShippingMethodTaxAmountActionBuilder
Example to create an instance using the builder pattern
A Shipping Method Tax Rate can be set if the Cart has the
External TaxMode.CartSetShippingMethodTaxRateActionBuilder
Example to create an instance using the builder pattern
Input used to select a ShippingRatePriceTier.
CartSetShippingRateInputActionBuilder
Example to create an instance using the builder pattern
Indicates the current status of a Cart.
possible values of CartState
Changes the CartState from
Frozen to Active.CartUnfreezeCartActionBuilder
Example to create an instance using the builder pattern
CartUpdate
Example to create an instance using the builder pattern
CartUpdateAction
Example to create a subtype instance using the builder pattern
CartUpdateActionBuilder
CartUpdateBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.CartUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to the sum of LineItem Prices.
CartValueTierBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to the sum of LineItem Prices.
CartValueTypeBuilder
Example to create an instance using the builder pattern
Category
Example to create an instance using the builder pattern
CategoryAddAssetAction
Example to create an instance using the builder pattern
CategoryAddAssetActionBuilder
Example to create an instance using the builder pattern
CategoryBuilder
Example to create an instance using the builder pattern
CategoryChangeAssetNameAction
Example to create an instance using the builder pattern
CategoryChangeAssetNameActionBuilder
Example to create an instance using the builder pattern
This update action changes the order of the
assets array.CategoryChangeAssetOrderActionBuilder
Example to create an instance using the builder pattern
CategoryChangeNameAction
Example to create an instance using the builder pattern
CategoryChangeNameActionBuilder
Example to create an instance using the builder pattern
CategoryChangeOrderHintAction
Example to create an instance using the builder pattern
CategoryChangeOrderHintActionBuilder
Example to create an instance using the builder pattern
CategoryChangeParentAction
Example to create an instance using the builder pattern
CategoryChangeParentActionBuilder
Example to create an instance using the builder pattern
Changing the slug produces the CategorySlugChanged Message.
CategoryChangeSlugActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Category request.
CategoryCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Category request.
CategoryCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
CategoryDraft
Example to create an instance using the builder pattern
CategoryDraftBuilder
Example to create an instance using the builder pattern
The data representation for a Category to be imported that is persisted as a Category in the Project.
CategoryImportBuilder
Example to create an instance using the builder pattern
The request body to import Categories.
CategoryImportRequestBuilder
Example to create an instance using the builder pattern
References a category by key.
CategoryKeyReferenceBuilder
Example to create an instance using the builder pattern
JSON object where the key is a Category
id and the value is an order hint.CategoryOrderHints
Example to create an instance using the builder pattern
CategoryOrderHintsBuilder
Example to create an instance using the builder pattern
CategoryOrderHintsBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Category.
CategoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a Category.
CategoryReferenceBuilder
Example to create an instance using the builder pattern
CategoryRemoveAssetAction
Example to create an instance using the builder pattern
CategoryRemoveAssetActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Category.
CategoryResourceIdentifierBuilder
Example to create an instance using the builder pattern
CategorySetAssetCustomFieldAction
Example to create an instance using the builder pattern
CategorySetAssetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetCustomTypeAction
Example to create an instance using the builder pattern
CategorySetAssetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetDescriptionAction
Example to create an instance using the builder pattern
CategorySetAssetDescriptionActionBuilder
Example to create an instance using the builder pattern
Set or remove the
key of an Asset.CategorySetAssetKeyActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetSourcesAction
Example to create an instance using the builder pattern
CategorySetAssetSourcesActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetTagsAction
Example to create an instance using the builder pattern
CategorySetAssetTagsActionBuilder
Example to create an instance using the builder pattern
CategorySetCustomFieldAction
Example to create an instance using the builder pattern
CategorySetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CategorySetCustomTypeAction
Example to create an instance using the builder pattern
CategorySetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CategorySetDescriptionAction
Example to create an instance using the builder pattern
CategorySetDescriptionActionBuilder
Example to create an instance using the builder pattern
This update action sets a new ID that can be used as an additional identifier for external systems like customer relationship management (CRM) or enterprise resource planning (ERP).
CategorySetExternalIdActionBuilder
Example to create an instance using the builder pattern
CategorySetKeyAction
Example to create an instance using the builder pattern
CategorySetKeyActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaDescriptionAction
Example to create an instance using the builder pattern
CategorySetMetaDescriptionActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaKeywordsAction
Example to create an instance using the builder pattern
CategorySetMetaKeywordsActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaTitleAction
Example to create an instance using the builder pattern
CategorySetMetaTitleActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
CategorySlugChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
CategorySlugChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
All categories in the project, represented as an in-memory tree.
Helper to create a Tree structure from a list of categories
CategoryUpdate
Example to create an instance using the builder pattern
CategoryUpdateAction
Example to create a subtype instance using the builder pattern
CategoryUpdateActionBuilder
CategoryUpdateBuilder
Example to create an instance using the builder pattern
Object that stores cent amounts in a specific currency.
CentPrecisionMoneyBuilder
Example to create an instance using the builder pattern
This draft type is the alternative to Money.
CentPrecisionMoneyDraftBuilder
Example to create an instance using the builder pattern
Difference between the previous and next version of a resource represented by
previousValue (omitted, for example, on creations) and nextValue of the associated change.Change triggered by the Change Address update action.
ChangeAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
ChangeAmountAuthorizedChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change AmountPlanned update action.
ChangeAmountPlannedChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeAssetNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeAssetOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Associate update action.
ChangeAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Associate Mode update action.
ChangeAssociateModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change AttributeDefinition AttributeConstraint update action.
ChangeAttributeConstraintChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change the order of AttributeDefinitions update action.
ChangeAttributeOrderByNameChangeBuilder
Example to create an instance using the builder pattern
ChangeBuilder
Change triggered by the Change BuyerAssignable update action.
ChangeBuyerAssignableChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change CartDiscounts update action.
ChangeCartDiscountsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Cart Predicate update action.
ChangeCartPredicateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change CustomLineItem Quantity update action.
ChangeCustomLineItemQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Description update action.
ChangeDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Email update action.
ChangeEmailChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change EnumValue Label update action.
ChangeEnumValueLabelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change the order of EnumValues update action.
ChangeEnumValueOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change the order of FieldDefinitions update action.
ChangeFieldDefinitionOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Groups update action.
ChangeGroupsChangeBuilder
Example to create an instance using the builder pattern
This data type represents the supported resource types.
possible values of ChangeHistoryResourceType
Change triggered by the Change Associate update action on a parent of a Business Unit in cases where inheritance applies.
ChangeInheritedAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change initial State update action.
ChangeInitialChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeInputHintChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeIsActiveChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change AttributeDefinition IsSearchable update action.
ChangeIsSearchableChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeKeyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeLabelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change LineItem Quantity update action.
ChangeLineItemQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Description update action.
ChangeLocalizedDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeLocalizedEnumValueLabelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeLocalizedEnumValueOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeLocalizedNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Master Variant update action.
ChangeMasterVariantChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change OrderHint update action.
ChangeOrderHintChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeOrderStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Parent update action.
ChangeParentChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Parent Unit update action.
ChangeParentUnitChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangePaymentStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change the label of an EnumValue update action.
ChangePlainEnumValueLabelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change the order of EnumValues update action.
ChangePlainEnumValueOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Predicate update action.
ChangePredicateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Price update action.
ChangePriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Product Selection Active update action.
ChangeProductSelectionActiveChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Quantity update action.
ChangeQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Quote Request State update action.
ChangeQuoteRequestStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Quote State update action.
ChangeQuoteStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Requires DiscountCode update action.
ChangeRequiresDiscountCodeChangeBuilder
Example to create an instance using the builder pattern
ChangeReviewRatingStatisticsChange
Example to create an instance using the builder pattern
ChangeReviewRatingStatisticsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeShipmentStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change ShoppingListLineItem Quantity update action.
ChangeShoppingListLineItemQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change ShoppingListLineItems Order update action.
ChangeShoppingListLineItemsOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeSlugChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeSortOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Stacking Mode update action.
ChangeStackingModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the ChangeStagedQuoteState update action.
ChangeStagedQuoteStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change State Type update action.
ChangeStateTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Status update action.
ChangeStatusChangeBuilder
Example to create an instance using the builder pattern
Notification about changes to a resource.
ChangeSubscriptionBuilder
Example to create an instance using the builder pattern
Resource types supported by ChangeSubscriptions:
possible values of ChangeSubscriptionResourceTypeId
Change triggered by the Change Target update action.
ChangeTargetChangeBuilder
Example to create an instance using the builder pattern
ChangeTargetChangeValue
Example to create a subtype instance using the builder pattern
ChangeTargetChangeValueBuilder
ChangeTargetCustomLineItemsChangeValue
Example to create an instance using the builder pattern
ChangeTargetCustomLineItemsChangeValueBuilder
Example to create an instance using the builder pattern
ChangeTargetLineItemsChangeValue
Example to create an instance using the builder pattern
ChangeTargetLineItemsChangeValueBuilder
Example to create an instance using the builder pattern
ChangeTargetMultiBuyCustomLineItemsChangeValue
Example to create an instance using the builder pattern
ChangeTargetMultiBuyCustomLineItemsChangeValueBuilder
Example to create an instance using the builder pattern
ChangeTargetMultiBuyLineItemsChangeValue
Example to create an instance using the builder pattern
ChangeTargetMultiBuyLineItemsChangeValueBuilder
Example to create an instance using the builder pattern
ChangeTargetShippingChangeValue
Example to create an instance using the builder pattern
ChangeTargetShippingChangeValueBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TaxCalculationMode update action.
ChangeTaxCalculationModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TaxMode update action.
ChangeTaxModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change Tax RoundingMode update action.
ChangeTaxRoundingModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TextLineItem Name update action.
ChangeTextLineItemNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TextLineItem Quantity update action.
ChangeTextLineItemQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TextLineItems Order update action.
ChangeTextLineItemsOrderChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TransactionInteractionId update action.
ChangeTransactionInteractionIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TransactionState update action.
ChangeTransactionStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Change TransactionTimestamp update action.
ChangeTransactionTimestampChangeBuilder
Example to create an instance using the builder pattern
ChangeValueAbsoluteChangeValue
Example to create an instance using the builder pattern
ChangeValueAbsoluteChangeValueBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
ChangeValueChangeBuilder
Example to create an instance using the builder pattern
ChangeValueChangeValue
Example to create a subtype instance using the builder pattern
ChangeValueChangeValueBuilder
ChangeValueExternalChangeValue
Example to create an instance using the builder pattern
ChangeValueExternalChangeValueBuilder
Example to create an instance using the builder pattern
ChangeValueGiftLineItemChangeValue
Example to create an instance using the builder pattern
ChangeValueGiftLineItemChangeValueBuilder
Example to create an instance using the builder pattern
ChangeValueRelativeChangeValue
Example to create an instance using the builder pattern
ChangeValueRelativeChangeValueBuilder
Example to create an instance using the builder pattern
Channel
Example to create an instance using the builder pattern
ChannelAddRolesAction
Example to create an instance using the builder pattern
ChannelAddRolesActionBuilder
Example to create an instance using the builder pattern
ChannelBuilder
Example to create an instance using the builder pattern
ChannelChangeDescriptionAction
Example to create an instance using the builder pattern
ChannelChangeDescriptionActionBuilder
Example to create an instance using the builder pattern
ChannelChangeKeyAction
Example to create an instance using the builder pattern
ChannelChangeKeyActionBuilder
Example to create an instance using the builder pattern
ChannelChangeNameAction
Example to create an instance using the builder pattern
ChannelChangeNameActionBuilder
Example to create an instance using the builder pattern
ChannelDraft
Example to create an instance using the builder pattern
ChannelDraftBuilder
Example to create an instance using the builder pattern
References a channel by key.
ChannelKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Channel.
ChannelPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a Channel.
ChannelReferenceBuilder
Example to create an instance using the builder pattern
ChannelRemoveRolesAction
Example to create an instance using the builder pattern
ChannelRemoveRolesActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Channel.
ChannelResourceIdentifierBuilder
Example to create an instance using the builder pattern
Describes the purpose and type of the Channel.
Describes the purpose and type of the Channel.
possible values of ChannelRoleEnum
possible values of ChannelRoleEnum
ChannelSetAddressAction
Example to create an instance using the builder pattern
ChannelSetAddressActionBuilder
Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldAction
Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeAction
Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
ChannelSetCustomFieldAction
Example to create an instance using the builder pattern
ChannelSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ChannelSetCustomTypeAction
Example to create an instance using the builder pattern
ChannelSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ChannelSetGeoLocationAction
Example to create an instance using the builder pattern
ChannelSetGeoLocationActionBuilder
Example to create an instance using the builder pattern
ChannelSetRolesAction
Example to create an instance using the builder pattern
ChannelSetRolesActionBuilder
Example to create an instance using the builder pattern
ChannelUpdate
Example to create an instance using the builder pattern
ChannelUpdateAction
Example to create a subtype instance using the builder pattern
ChannelUpdateActionBuilder
ChannelUpdateBuilder
Example to create an instance using the builder pattern
ClassificationShippingRateInput
Example to create an instance using the builder pattern
ClassificationShippingRateInput
Example to create an instance using the builder pattern
ClassificationShippingRateInputBuilder
Example to create an instance using the builder pattern
ClassificationShippingRateInputBuilder
Example to create an instance using the builder pattern
ClassificationShippingRateInputDraft
Example to create an instance using the builder pattern
ClassificationShippingRateInputDraftBuilder
Example to create an instance using the builder pattern
The ClientBuilder is used to configure and create an
ApiHttpClient.Token supplier using client credentials flow
These objects represent information about which API Client created or modified a resource.
ClientLoggingBuilder
Example to create an instance using the builder pattern
The CloudEventsFormat can be used with any Destination, and the payload is delivered in the
JSON Event Format.CloudEventsFormatBuilder
Example to create an instance using the builder pattern
The CloudEventsFormat represents event data in a way that conforms to a common specification.
CloudEventsPayloadBuilder
Example to create an instance using the builder pattern
Business Unit type to represent the top level of a business.
CompanyBuilder
Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
CompanyDraftBuilder
Example to create an instance using the builder pattern
Tools to simplify the work with
CompletionStage and CompletableFuture.Returned when the request conflicts with the current state of the involved resources.
The request conflicts with the current state of the involved resources.
ConcurrentModificationErrorBuilder
Example to create an instance using the builder pattern
ConcurrentModificationErrorBuilder
Example to create an instance using the builder pattern
Deserializes the response payload as
ErrorResponse and extracts the currentVersion of the modified resource
if includedMiddleware to retry a request upon
ConcurrentModificationException
String projectKey = CommercetoolsTestUtils.getProjectKey(); ProjectApiRoot projectApiRoot = ApiRootBuilder.of() .defaultClient(ClientCredentials.of() .withClientId(CommercetoolsTestUtils.getClientId()) .withClientSecret(CommercetoolsTestUtils.getClientSecret()) .build(), ServiceRegion.GCP_EUROPE_WEST1) .addConcurrentModificationMiddleware(3) .build(projectKey); CartsFixtures.withUpdateableCart(cart -> { final ApiHttpResponse<Cart> deCart = projectApiRoot.carts() .withId(cart.getId()) .post(CartUpdateBuilder.of() .version(cart.getVersion()) .actions(CartSetCountryActionBuilder.of().country("DE").build()) .build()) .executeBlocking(); final Cart modCart = projectApiRoot.carts() .withId(cart.getId()) .post(CartUpdateBuilder.of() .version(cart.getVersion()) .actions(CartSetCountryActionBuilder.of().country("DE").build()) .build()) .executeBlocking() .getBody(); return modCart; });See the test code.
ConflictingTrait
This destination can be used to push events and messages to Confluent Cloud.
ConfluentCloudDestinationBuilder
Example to create an instance using the builder pattern
ContainerAndKey is specific to Custom Objects.ContainerAndKeyBuilder
Example to create an instance using the builder pattern
ContentionError
Example to create an instance using the builder pattern
ContentionErrorBuilder
Example to create an instance using the builder pattern
Returned when the request results in too much data being returned from the API.
ContentTooLargeErrorBuilder
Example to create an instance using the builder pattern
Provider for a correlation id which may be added to a request as unique identifier
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
CountryNotConfiguredInStoreErrorBuilder
Example to create an instance using the builder pattern
IDs and references that created the resource.
CreatedByBuilder
Example to create an instance using the builder pattern
The representation to be sent to the server when creating a resource with Custom Fields.
CustomBuilder
Example to create an instance using the builder pattern
If
stores is not empty, the Customer is specific to those Stores.Adding an address to the Customer produces the CustomerAddressAdded Message.
CustomerAddAddressActionBuilder
Example to create an instance using the builder pattern
Adds an Address from the
addresses array to billingAddressIds.CustomerAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Different from Address in that
key is required and id is not supported.Generated after a successful Add Address update action.
CustomerAddressAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
CustomerAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerAddressBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
CustomerAddressChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
CustomerAddressChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from an Address of a Customer using the Set CustomField in Address update action.
CustomerAddressCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from an Address of a Customer using the Set Custom Type in Address update action.
CustomerAddressCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from an Address of a Customer using the Set Custom Type in Address update action.
CustomerAddressCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to an Address of a Customer using the Set Custom Type in Address update action.
CustomerAddressCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to an Address of a Customer using the Set Custom Type in Address update action.
CustomerAddressCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
CustomerAddressRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
CustomerAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Adds an Address from the
addresses array to shippingAddressIds.CustomerAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Associates the Customer with a Store.
CustomerAddStoreActionBuilder
Example to create an instance using the builder pattern
CustomerBuilder
Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
CustomerChangeAddressActionBuilder
Example to create an instance using the builder pattern
Changes the
email of the Customer and sets the isEmailVerified property to false.CustomerChangeEmailActionBuilder
Example to create an instance using the builder pattern
CustomerChangePassword
Example to create an instance using the builder pattern
CustomerChangePasswordBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Company Name update action.
CustomerCompanyNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Company Name update action.
CustomerCompanyNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
CustomerCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
CustomerCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerCreateEmailToken
Example to create an instance using the builder pattern
CustomerCreateEmailTokenBuilder
Example to create an instance using the builder pattern
CustomerCreatePasswordResetToken
Example to create an instance using the builder pattern
CustomerCreatePasswordResetTokenBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Customer using the Set CustomField update action.
CustomerCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Customer using the Set CustomField update action.
CustomerCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Customer using the Set CustomField update action.
CustomerCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Customer using the Set CustomField update action.
CustomerCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Customer using the Set CustomField update action.
CustomerCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Customer using the Set CustomField update action.
CustomerCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Customer using the Set Custom Type update action with empty parameters.
CustomerCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Customer using the Set Custom Type update action with empty parameters.
CustomerCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Customer using the Set Custom Type update action.
CustomerCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Customer using the Set Custom Type update action.
CustomerCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Date of Birth update action.
CustomerDateOfBirthSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Date of Birth update action.
CustomerDateOfBirthSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
CustomerDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
CustomerDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerDraft
Example to create an instance using the builder pattern
CustomerDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Email update action.
CustomerEmailChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Email update action.
CustomerEmailChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create email token for Customer request.
CustomerEmailTokenCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create email token for Customer request.
CustomerEmailTokenCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a CustomerToken for email verification.
CustomerEmailTokenReferenceBuilder
Example to create an instance using the builder pattern
Generated after a successful Verify Customer's Email request.
CustomerEmailVerifiedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Verify Customer's Email request.
CustomerEmailVerifiedMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerEmailVerify
Example to create an instance using the builder pattern
CustomerEmailVerifyBuilder
Example to create an instance using the builder pattern
Generated after a successful Set First Name update action.
CustomerFirstNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set First Name update action.
CustomerFirstNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerGroup
Example to create an instance using the builder pattern
CustomerGroupBuilder
Example to create an instance using the builder pattern
CustomerGroupChangeNameAction
Example to create an instance using the builder pattern
CustomerGroupChangeNameActionBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field to a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after changing an existing Custom Field on a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Field from a Customer Group using the Set CustomField update action.
CustomerGroupCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Customer Group using the Set Custom Type update action with empty parameters.
CustomerGroupCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after removing a Custom Type from a Customer Group using the Set Custom Type update action with empty parameters.
CustomerGroupCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Customer Group using the Set Custom Type update action.
CustomerGroupCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Type to a Customer Group using the Set Custom Type update action.
CustomerGroupCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerGroupDraft
Example to create an instance using the builder pattern
CustomerGroupDraftBuilder
Example to create an instance using the builder pattern
References a customer group by key.
CustomerGroupKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CustomerGroup.CustomerGroupPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a CustomerGroup.
CustomerGroupReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a CustomerGroup.
CustomerGroupResourceIdentifierBuilder
Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldAction
Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
This action sets or removes the custom type for an existing CustomerGroup.
CustomerGroupSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CustomerGroupSetKeyAction
Example to create an instance using the builder pattern
CustomerGroupSetKeyActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
CustomerGroupSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
CustomerGroupSetMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerGroupUpdate
Example to create an instance using the builder pattern
CustomerGroupUpdateAction
Example to create a subtype instance using the builder pattern
CustomerGroupUpdateActionBuilder
CustomerGroupUpdateBuilder
Example to create an instance using the builder pattern
The data representation for a Customer to be imported that is persisted as a Customer in the Project.
CustomerImportBuilder
Example to create an instance using the builder pattern
The request body to import Customers.
CustomerImportRequestBuilder
Example to create an instance using the builder pattern
References a customer by key.
CustomerKeyReferenceBuilder
Example to create an instance using the builder pattern
CustomerLabel
Example to create an instance using the builder pattern
CustomerLabelBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Last Name update action.
CustomerLastNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Last Name update action.
CustomerLastNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Customer.
CustomerPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Create password reset token for Customer request.
CustomerPasswordTokenCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create password reset token for Customer request.
CustomerPasswordTokenCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a CustomerToken for password reset.
CustomerPasswordTokenReferenceBuilder
Example to create an instance using the builder pattern
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
CustomerPasswordUpdatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Reset Customer's Password, Reset Customer's Password in a Store, Change Customer's Password, or Change Customer's Password in a Store request.
CustomerPasswordUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a Customer.
CustomerReferenceBuilder
Example to create an instance using the builder pattern
Removing an address from the Customer produces the CustomerAddressRemoved Message.
CustomerRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removes a billing address from
billingAddressesIds.CustomerRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes a shipping address from
shippingAddressesIds.CustomerRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes the association to a Store from the Customer.
CustomerRemoveStoreActionBuilder
Example to create an instance using the builder pattern
CustomerResetPassword
Example to create an instance using the builder pattern
CustomerResetPasswordBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Customer.
CustomerResourceIdentifierBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to an Address of a Customer generates the CustomerAddressCustomFieldAdded Message, removing one generates the CustomerAddressCustomFieldRemoved Message, and updating an existing one generates the CustomerAddressCustomFieldChanged Message.
CustomerSetAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on an Address of a Customer generates the CustomerAddressCustomTypeSet Message, and removing one generates the CustomerAddressCustomTypeRemoved Message.
CustomerSetAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CustomerSetAuthenticationModeAction
Example to create an instance using the builder pattern
CustomerSetAuthenticationModeActionBuilder
Example to create an instance using the builder pattern
Setting a company name produces the CustomerCompanyNameSet Message.
CustomerSetCompanyNameActionBuilder
Example to create an instance using the builder pattern
Setting the Customer Group of the Customer produces the CustomerGroupSet Message.
CustomerSetCustomerGroupActionBuilder
Example to create an instance using the builder pattern
Sets a new ID that can be used to refer to a Customer in a human-reabable way (for use in emails, invoices, etc).
CustomerSetCustomerNumberActionBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to a Customer generates the CustomerCustomFieldAdded Message, removing one generates the CustomerCustomFieldRemoved Message, and updating an existing one generates the CustomerCustomFieldChanged Message.
CustomerSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.
CustomerSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
CustomerSetDateOfBirthActionBuilder
Example to create an instance using the builder pattern
Sets the default billing address from
addresses.CustomerSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default shipping address from
addresses.CustomerSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
CustomerSetExternalIdAction
Example to create an instance using the builder pattern
CustomerSetExternalIdActionBuilder
Example to create an instance using the builder pattern
Setting the first name of the Customer produces the CustomeFirstNameSet Message.
CustomerSetFirstNameActionBuilder
Example to create an instance using the builder pattern
CustomerSetKeyAction
Example to create an instance using the builder pattern
CustomerSetKeyActionBuilder
Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSet Message.
CustomerSetLastNameActionBuilder
Example to create an instance using the builder pattern
CustomerSetLocaleAction
Example to create an instance using the builder pattern
CustomerSetLocaleActionBuilder
Example to create an instance using the builder pattern
CustomerSetMiddleNameAction
Example to create an instance using the builder pattern
CustomerSetMiddleNameActionBuilder
Example to create an instance using the builder pattern
CustomerSetSalutationAction
Example to create an instance using the builder pattern
CustomerSetSalutationActionBuilder
Example to create an instance using the builder pattern
Sets the Stores the Customer account is associated with.
CustomerSetStoresActionBuilder
Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSet Message.
CustomerSetTitleActionBuilder
Example to create an instance using the builder pattern
CustomerSetVatIdAction
Example to create an instance using the builder pattern
CustomerSetVatIdActionBuilder
Example to create an instance using the builder pattern
CustomerSignin
Example to create an instance using the builder pattern
CustomerSigninBuilder
Example to create an instance using the builder pattern
CustomerSignInResult
Example to create an instance using the builder pattern
CustomerSignInResultBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Title update action.
CustomerTitleSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Title update action.
CustomerTitleSetMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomerToken
Example to create an instance using the builder pattern
CustomerTokenBuilder
Example to create an instance using the builder pattern
CustomerUpdate
Example to create an instance using the builder pattern
CustomerUpdateAction
Example to create a subtype instance using the builder pattern
CustomerUpdateActionBuilder
CustomerUpdateBuilder
Example to create an instance using the builder pattern
Provides the value for a Custom Field of a specific type.
Field type for Boolean values.
Field type for Boolean values.
CustomFieldBooleanTypeBuilder
Example to create an instance using the builder pattern
CustomFieldBooleanTypeBuilder
Example to create an instance using the builder pattern
CustomFieldBuilder
Field type for DateTime values.
Field type for DateTime values.
CustomFieldDateTimeTypeBuilder
Example to create an instance using the builder pattern
CustomFieldDateTimeTypeBuilder
Example to create an instance using the builder pattern
Field type for Date values.
Field type for Date values.
CustomFieldDateTypeBuilder
Example to create an instance using the builder pattern
CustomFieldDateTypeBuilder
Example to create an instance using the builder pattern
Field type for enum values.
Field type for enum values.
CustomFieldEnumTypeBuilder
Example to create an instance using the builder pattern
CustomFieldEnumTypeBuilder
Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldEnumType field.
Defines an allowed value of a CustomFieldEnumType field.
CustomFieldEnumValueBuilder
Example to create an instance using the builder pattern
CustomFieldEnumValueBuilder
Example to create an instance using the builder pattern
Only present if
expand is set to true.CustomFieldExpandedValueBuilder
Example to create an instance using the builder pattern
Field type for localized enum values.
Field type for localized enum values.
CustomFieldLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
CustomFieldLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldLocalizedEnumType field.
Defines an allowed value of a CustomFieldLocalizedEnumType field.
CustomFieldLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
CustomFieldLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
Field type for LocalizedString values.
Field type for LocalizedString values.
CustomFieldLocalizedStringTypeBuilder
Example to create an instance using the builder pattern
CustomFieldLocalizedStringTypeBuilder
Example to create an instance using the builder pattern
Field type for CentPrecisionMoney values.
Field type for CentPrecisionMoney values.
CustomFieldMoneyTypeBuilder
Example to create an instance using the builder pattern
CustomFieldMoneyTypeBuilder
Example to create an instance using the builder pattern
Field type for number values.
Field type for number values.
CustomFieldNumberTypeBuilder
Example to create an instance using the builder pattern
CustomFieldNumberTypeBuilder
Example to create an instance using the builder pattern
Field type for Reference values.
Field type for Reference values.
CustomFieldReferenceTypeBuilder
Example to create an instance using the builder pattern
CustomFieldReferenceTypeBuilder
Example to create an instance using the builder pattern
Defines which resource type a CustomFieldReferenceType can reference.
Defines which resource type a CustomFieldReferenceType can reference.
possible values of CustomFieldReferenceValue
possible values of CustomFieldReferenceValue
Serves as value of the
custom field on a resource or data type customized with a Type.CustomFields
Example to create an instance using the builder pattern
Accessor for retrieving type safe custom field values
CustomFieldsBuilder
Example to create an instance using the builder pattern
CustomFieldsBuilder
Example to create an instance using the builder pattern
The representation used when creating or updating a customizable data type with Custom Fields.
CustomFieldsDraftBuilder
Example to create an instance using the builder pattern
Values of a SetType Custom Field are sets of values of the specified
elementType (without duplicate elements).Values of a SetType Custom Field are sets of values of the specified
elementType (without duplicate elements).CustomFieldSetTypeBuilder
Example to create an instance using the builder pattern
CustomFieldSetTypeBuilder
Example to create an instance using the builder pattern
Field type for string values.
Field type for string values.
CustomFieldStringTypeBuilder
Example to create an instance using the builder pattern
CustomFieldStringTypeBuilder
Example to create an instance using the builder pattern
Field type for Time values.
Field type for Time values.
CustomFieldTimeTypeBuilder
Example to create an instance using the builder pattern
CustomFieldTimeTypeBuilder
Example to create an instance using the builder pattern
Entity with a CustomField property
Entity with a CustomFieldDraft property
A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.
CustomLineItem
Example to create an instance using the builder pattern
CustomLineItemBuilder
Example to create an instance using the builder pattern
CustomLineItemBuilder
Example to create an instance using the builder pattern
CustomLineItemDraft
Example to create an instance using the builder pattern
CustomLineItemDraft
Example to create an instance using the builder pattern
CustomLineItemDraftBuilder
Example to create an instance using the builder pattern
CustomLineItemDraftBuilder
Example to create an instance using the builder pattern
Custom Line Items contain generic user-defined items that are not linked to Products.
CustomLineItemImportDraftBuilder
Example to create an instance using the builder pattern
Determines if Cart Discounts can be applied to a Custom Line Item in the Cart.
possible values of CustomLineItemPriceMode
CustomLineItemReturnItem
Example to create an instance using the builder pattern
CustomLineItemReturnItemBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition CustomLineItem State update action.
CustomLineItemStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition CustomLineItem State update action.
CustomLineItemStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
CustomLineItemTaxedPrice
Example to create an instance using the builder pattern
CustomLineItemTaxedPriceBuilder
Example to create an instance using the builder pattern
CustomObject
Example to create an instance using the builder pattern
CustomObjectBuilder
Example to create an instance using the builder pattern
CustomObjectDraft
Example to create an instance using the builder pattern
CustomObjectDraftBuilder
Example to create an instance using the builder pattern
References a key value document by key.
CustomObjectKeyReferenceBuilder
Example to create an instance using the builder pattern
CustomObjectLabel
Example to create an instance using the builder pattern
CustomObjectLabelBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CustomObject.CustomObjectPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a CustomObject.
CustomObjectReferenceBuilder
Example to create an instance using the builder pattern
CustomShippingDraft
Example to create an instance using the builder pattern
CustomShippingDraftBuilder
Example to create an instance using the builder pattern
CustomShippingMethodChangeValue
Example to create an instance using the builder pattern
CustomShippingMethodChangeValueBuilder
Example to create an instance using the builder pattern
Define arbitrary tokens that are used to match the input.
CustomTokenizer
Example to create an instance using the builder pattern
CustomTokenizerBuilder
Example to create an instance using the builder pattern
CustomTokenizerBuilder
Example to create an instance using the builder pattern
The DatadogTelemetry middleware can be used to report outgoing request to commercetools to Datadog.
The DatadogTelemetry middleware can be used to report outgoing request to commercetools to Datadog.
This serializer uses API to submit metrics to datadog.
This serializer uses dogstatsd library to submit metrics to datadog.
DataerasureTrait
This type represents an attribute whose value is a date.
DateAttributeBuilder
Example to create an instance using the builder pattern
A field with a date value.
DateFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of dates.
DateSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a date set value.
DateSetFieldBuilder
Example to create an instance using the builder pattern
This type consists of one enum value:
possible values of DateStringFilter
This type represents an attribute whose value is a date with time.
DateTimeAttributeBuilder
Example to create an instance using the builder pattern
A field with a date time value.
DateTimeFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of dates with time.
DateTimeSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a date time set value.
DateTimeSetFieldBuilder
Example to create an instance using the builder pattern
Contains information on how items are shipped to Customers, for example, a delivery note.
Delivery
Example to create an instance using the builder pattern
Delivery
Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
DeliveryAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
DeliveryAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
DeliveryAddressDraft
Example to create an instance using the builder pattern
DeliveryAddressDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Address update action.
DeliveryAddressSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Address update action.
DeliveryAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
DeliveryBuilder
Example to create an instance using the builder pattern
DeliveryBuilder
Example to create an instance using the builder pattern
DeliveryBuilder
Example to create an instance using the builder pattern
DeliveryChangeValue
Example to create an instance using the builder pattern
DeliveryChangeValueBuilder
Example to create an instance using the builder pattern
Deprecated.
use
CloudEventsFormat insteadDeprecated.
use
CloudEventsFormatBuilder insteadDeliveryDraft
Example to create an instance using the builder pattern
DeliveryDraft
Example to create an instance using the builder pattern
DeliveryDraftBuilder
Example to create an instance using the builder pattern
DeliveryDraftBuilder
Example to create an instance using the builder pattern
DeliveryFormat
Example to create a subtype instance using the builder pattern
DeliveryFormatBuilder
DeliveryItem
Example to create an instance using the builder pattern
DeliveryItem
Example to create an instance using the builder pattern
DeliveryItem
Example to create an instance using the builder pattern
DeliveryItemBuilder
Example to create an instance using the builder pattern
DeliveryItemBuilder
Example to create an instance using the builder pattern
DeliveryItemBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Items update action.
DeliveryItemsUpdatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Items update action.
DeliveryItemsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
DeliveryParcel
Example to create an instance using the builder pattern
DeliveryParcelBuilder
Example to create an instance using the builder pattern
DeliveryParcelDraft
Example to create an instance using the builder pattern
DeliveryParcelDraftBuilder
Example to create an instance using the builder pattern
All payloads for the PlatformFormat share these common fields.
DeliveryPayloadBuilder
Deprecated.
use
PlatformFormat insteadDeprecated.
use
PlatformFormatBuilder insteadGenerated after a successful Remove Delivery update action.
DeliveryRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Delivery update action.
DeliveryRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Deprecatable200Trait
Deprecatable201Trait
Destination
Example to create a subtype instance using the builder pattern
DestinationBuilder
Represents a CartDiscount that is only associated with a single Cart or Order.
DirectDiscountBuilder
Example to create an instance using the builder pattern
Represents a CartDiscount that can only be associated with a single Cart or Order.
DirectDiscountDraftBuilder
Example to create an instance using the builder pattern
Reference to a DirectDiscount.
DirectDiscountReferenceBuilder
Example to create an instance using the builder pattern
DiscountCode
Example to create an instance using the builder pattern
DiscountCodeBuilder
Example to create an instance using the builder pattern
DiscountCodeChangeCartDiscountsAction
Example to create an instance using the builder pattern
DiscountCodeChangeCartDiscountsActionBuilder
Example to create an instance using the builder pattern
DiscountCodeChangeGroupsAction
Example to create an instance using the builder pattern
DiscountCodeChangeGroupsActionBuilder
Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveAction
Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create DiscountCode request.
DiscountCodeCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create DiscountCode request.
DiscountCodeCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete DiscountCode request.
DiscountCodeDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete DiscountCode request.
DiscountCodeDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
DiscountCodeDraft
Example to create an instance using the builder pattern
DiscountCodeDraftBuilder
Example to create an instance using the builder pattern
The data representation for a Discount Code to be imported that is persisted as a Discount Code in the Project.
DiscountCodeImportBuilder
Example to create an instance using the builder pattern
The request body to import Discount Codes.
DiscountCodeImportRequestBuilder
Example to create an instance using the builder pattern
DiscountCodeInfo
Example to create an instance using the builder pattern
DiscountCodeInfo
Example to create an instance using the builder pattern
DiscountCodeInfo
Example to create an instance using the builder pattern
DiscountCodeInfoBuilder
Example to create an instance using the builder pattern
DiscountCodeInfoBuilder
Example to create an instance using the builder pattern
DiscountCodeInfoBuilder
Example to create an instance using the builder pattern
References a discount code by key.
DiscountCodeKeyReferenceBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
DiscountCodeKeySetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
DiscountCodeKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a Discount Code with a DiscountCodeState other than
MatchesCart.DiscountCodeNonApplicableErrorBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of DiscountCode.DiscountCodePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a DiscountCode.
DiscountCodeReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a DiscountCode.
DiscountCodeResourceIdentifierBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateAction
Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldAction
Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeAction
Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetDescriptionAction
Example to create an instance using the builder pattern
DiscountCodeSetDescriptionActionBuilder
Example to create an instance using the builder pattern
This action generates a DiscountCodeKeySet Message.
DiscountCodeSetKeyActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsAction
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerAction
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetNameAction
Example to create an instance using the builder pattern
DiscountCodeSetNameActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAction
Example to create an instance using the builder pattern
DiscountCodeSetValidFromActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilAction
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidUntilAction
Example to create an instance using the builder pattern
DiscountCodeSetValidUntilActionBuilder
Example to create an instance using the builder pattern
Indicates the state of a Discount Code in a Cart.
DiscountCodeState
Maps to
DiscountCodeInfo.statepossible values of DiscountCodeState
possible values of DiscountCodeState
possible values of DiscountCodeState
DiscountCodeUpdate
Example to create an instance using the builder pattern
DiscountCodeUpdateAction
Example to create a subtype instance using the builder pattern
DiscountCodeUpdateActionBuilder
DiscountCodeUpdateBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPortion
Example to create an instance using the builder pattern
DiscountedLineItemPortion
Example to create an instance using the builder pattern
DiscountedLineItemPortion
Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPortionDraft
Example to create an instance using the builder pattern
DiscountedLineItemPortionDraftBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPrice
Example to create an instance using the builder pattern
DiscountedLineItemPrice
Example to create an instance using the builder pattern
DiscountedLineItemPriceBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft
Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft
Example to create an instance using the builder pattern
DiscountedLineItemPriceDraftBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceDraftBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantity
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantity
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantityBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantityBuilder
Example to create an instance using the builder pattern
DiscountedPrice
Example to create an instance using the builder pattern
DiscountedPrice
Example to create an instance using the builder pattern
DiscountedPriceBuilder
Example to create an instance using the builder pattern
DiscountedPriceBuilder
Example to create an instance using the builder pattern
DiscountedPriceDraft
Example to create an instance using the builder pattern
DiscountedPriceDraftBuilder
Example to create an instance using the builder pattern
DiscountedTotalPricePortion
Example to create an instance using the builder pattern
DiscountedTotalPricePortionBuilder
Example to create an instance using the builder pattern
DiscountOnTotalPrice
Example to create an instance using the builder pattern
DiscountOnTotalPriceBuilder
Example to create an instance using the builder pattern
Business Unit type to model divisions that are part of the Company or a higher-order Division.
DivisionBuilder
Example to create an instance using the builder pattern
Draft type to model divisions that are part of a Company or a higher-order Division.
DivisionDraftBuilder
Example to create an instance using the builder pattern
Interface of a resource with an ID and version
DomainResourceUpdateAction<T extends DomainResourceUpdateAction<T,TResource>,TResource extends DomainResource<TResource>>
Returned when the
Unique AttributeConstraint criteria are not met during an Update Product request.The
Unique AttributeConstraintEnum was violated.DuplicateAttributeValueErrorBuilder
Example to create an instance using the builder pattern
DuplicateAttributeValueErrorBuilder
Example to create an instance using the builder pattern
Returned when the
CombinationUnique AttributeConstraint criteria are not met during an Update Product request.The
CombinationUnique AttributeConstraintEnum was violated.DuplicateAttributeValuesErrorBuilder
Example to create an instance using the builder pattern
DuplicateAttributeValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
DuplicateEnumValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value causing a duplicate.
The given value already exists for a field that is checked for unique values.
DuplicateFieldErrorBuilder
Example to create an instance using the builder pattern
DuplicateFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
DuplicateFieldWithConflictingResourceErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
DuplicatePriceKeyErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price scope conflicts with an existing one during an Update Product request.
DuplicatePriceScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
DuplicateStandalonePriceScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
The given combination of values of a Product Variant conflicts with an existing one.
DuplicateVariantValuesErrorBuilder
Example to create an instance using the builder pattern
DuplicateVariantValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
EditPreviewFailedErrorBuilder
Example to create an instance using the builder pattern
Supported endpoints
This type represents an attribute whose value is an enum.
EnumAttributeBuilder
Example to create an instance using the builder pattern
A field with an enum value.
EnumFieldBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
EnumKeyAlreadyExistsErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
EnumKeyDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is an enum.
EnumSetAttributeBuilder
Example to create an instance using the builder pattern
A field with an enum set value.
EnumSetFieldBuilder
Example to create an instance using the builder pattern
EnumValue
Example to create an instance using the builder pattern
EnumValue
Example to create an instance using the builder pattern
EnumValueBuilder
Example to create an instance using the builder pattern
EnumValueBuilder
Example to create an instance using the builder pattern
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
EnumValueIsUsedErrorBuilder
Example to create an instance using the builder pattern
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
EnumValuesMustMatchErrorBuilder
Example to create an instance using the builder pattern
ErrorableTrait
ErrorByExtension
Example to create an instance using the builder pattern
ErrorByExtensionBuilder
Example to create an instance using the builder pattern
Used to convert API errors to Exceptions.
Represents a single error.
ErrorObject
Example to create an instance using the builder pattern
ErrorObject
Example to create a subtype instance using the builder pattern
ErrorObjectBuilder
ErrorObjectBuilder
Example to create an instance using the builder pattern
ErrorObjectBuilder
Base representation of an error response containing common fields to all errors.
ErrorResponse
Example to create an instance using the builder pattern
The response in case of an error.
ErrorResponseBuilder
Example to create an instance using the builder pattern
ErrorResponseBuilder
Example to create an instance using the builder pattern
ErrorResponseBuilder
Example to create an instance using the builder pattern
Exception which holds the response payload as
ErrorResponseAWS EventBridge can be used to push events and messages to a serverless event bus that can forward them to AWS SQS, SNS, Lambda, and other AWS services based on forwarding rules.
EventBridgeDestinationBuilder
Example to create an instance using the builder pattern
A function like
Function but allows you to throw exceptionTable of content
The exception hierarchy documentation.
ExpandableTrait
Extension
Example to create an instance using the builder pattern
An Extension gets called during any of the following requests of an API call, but before the result is persisted.
possible values of ExtensionAction
Deprecated.
use
AuthorizationHeaderAuthentication insteadDeprecated.
use
AuthorizationHeaderAuthenticationBuilder insteadDeprecated.
use
AWSLambdaDestination insteadDeprecated.
use
AWSLambdaDestinationBuilder insteadDeprecated.
use
AzureFunctionsAuthentication insteadDeprecated.
use
AzureFunctionsAuthenticationBuilder insteadReturned when the response from the API Extension could not be parsed successfully (such as a
500 HTTP status code, or an invalid JSON response).ExtensionBadResponseErrorBuilder
Example to create an instance using the builder pattern
ExtensionBuilder
Example to create an instance using the builder pattern
ExtensionChangeDestinationAction
Example to create an instance using the builder pattern
ExtensionChangeDestinationActionBuilder
Example to create an instance using the builder pattern
ExtensionChangeTriggersAction
Example to create an instance using the builder pattern
ExtensionChangeTriggersActionBuilder
Example to create an instance using the builder pattern
Generic type for destinations.
ExtensionDestinationBuilder
ExtensionDraft
Example to create an instance using the builder pattern
ExtensionDraftBuilder
Example to create an instance using the builder pattern
ExtensionError
Example to create an instance using the builder pattern
ExtensionErrorBuilder
Example to create an instance using the builder pattern
Deprecated.
use
HttpDestination insteadDeprecated.
use
HttpDestinationAuthentication insteadDeprecated.
use
HttpDestinationBuilder insteadExtensionInput
Example to create an instance using the builder pattern
ExtensionInputBuilder
Example to create an instance using the builder pattern
Returned when the API Extension does not respond within the time limit, or could not be reached.
ExtensionNoResponseErrorBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Extension.ExtensionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
ExtensionPredicateEvaluationFailedErrorBuilder
Example to create an instance using the builder pattern
Extensions are available for:
possible values of ExtensionResourceTypeId
ExtensionSetKeyAction
Example to create an instance using the builder pattern
ExtensionSetKeyActionBuilder
Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsAction
Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsActionBuilder
Example to create an instance using the builder pattern
ExtensionTrigger
Example to create an instance using the builder pattern
ExtensionTriggerBuilder
Example to create an instance using the builder pattern
ExtensionUpdate
Example to create an instance using the builder pattern
ExtensionUpdateAction
Example to create a subtype instance using the builder pattern
ExtensionUpdateActionBuilder
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
ExtensionUpdateActionsFailedErrorBuilder
Example to create an instance using the builder pattern
ExtensionUpdateBuilder
Example to create an instance using the builder pattern
ExternalLineItemTotalPrice
Example to create an instance using the builder pattern
ExternalLineItemTotalPriceBuilder
Example to create an instance using the builder pattern
Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.
ExternalOAuthBuilder
Example to create an instance using the builder pattern
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like
500).ExternalOAuthFailedErrorBuilder
Example to create an instance using the builder pattern
Cannot be used in LineItemDraft or CustomLineItemDraft.
ExternalTaxAmountDraftBuilder
Example to create an instance using the builder pattern
Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
ExternalTaxRateDraft
Example to create an instance using the builder pattern
ExternalTaxRateDraftBuilder
Example to create an instance using the builder pattern
ExternalTaxRateDraftBuilder
Example to create an instance using the builder pattern
FacetRange
Example to create an instance using the builder pattern
FacetRangeBuilder
Example to create an instance using the builder pattern
FacetResult
Example to create a subtype instance using the builder pattern
FacetResultBuilder
Deprecated.
use
FacetRange insteadDeprecated.
use
FacetRangeBuilder insteadFacetResults
Example to create an instance using the builder pattern
Accessor to retrieve type safe facet results
Deprecated.
use
FacetResultsAccessor insteadFacetResultsBuilder
Example to create an instance using the builder pattern
Deprecated.
use
FacetTerm insteadDeprecated.
use
FacetTermBuilder insteadFacetTerm
Example to create an instance using the builder pattern
FacetTermBuilder
Example to create an instance using the builder pattern
FacetTypes
possible values of FacetTypes
Interface to enable the configuration of Failsafe instances
Interface to enable the configuration of Failsafe instances
Interface to enable the configuration of Failsafe instances
MonetaryProvider which uses the FastMoney implementation.
Returned when the requested feature was removed.
FeatureRemovedErrorBuilder
Example to create an instance using the builder pattern
FieldContainer
Example to create an instance using the builder pattern
Maps the Custom Field names to actual values.
FieldContainerBuilder
Example to create an instance using the builder pattern
FieldContainerBuilder
Example to create an instance using the builder pattern
Defines a Custom Field and its meta-information.
FieldDefinition
Example to create an instance using the builder pattern
Defines a Custom Field and its meta-information.
FieldDefinitionBuilder
Example to create an instance using the builder pattern
FieldDefinitionBuilder
Example to create an instance using the builder pattern
FieldDefinitionBuilder
Example to create an instance using the builder pattern
FieldDefinitionOrderValue
Example to create an instance using the builder pattern
FieldDefinitionOrderValueBuilder
Example to create an instance using the builder pattern
FieldType
Example to create a subtype instance using the builder pattern
FieldType
Example to create an instance using the builder pattern
FieldType
Example to create a subtype instance using the builder pattern
FieldTypeBuilder
FieldTypeBuilder
Example to create an instance using the builder pattern
FieldTypeBuilder
FilteredFacetResult
Example to create an instance using the builder pattern
FilteredFacetResultBuilder
Example to create an instance using the builder pattern
Table of content
- General concept of the SDK
- ApiHttpClient
- ApiRoot & ProjectApiRoot
- ApiMethod
- Models
Returned when a server-side problem occurs before or after data persistence.
GeneralErrorBuilder
Example to create an instance using the builder pattern
entity to implement a type safe generic custom object
builder for a generic custom object
GenericError
Example to create an instance using the builder pattern
GenericErrorBuilder
Example to create an instance using the builder pattern
generic reference interface
GeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.
GeoJsonBuilder
GeoJsonPoint
Example to create an instance using the builder pattern
GeoJsonPointBuilder
Example to create an instance using the builder pattern
GeoLocation
Example to create an instance using the builder pattern
GeoLocationBuilder
Example to create an instance using the builder pattern
Table of content
Token supplier using password flow
For GoogleCloudFunction destinations, you need to grant permissions to the
extensions@commercetools-platform.iam.gserviceaccount.com service account to invoke your function.GoogleCloudFunctionDestinationBuilder
Example to create an instance using the builder pattern
Destination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.
GoogleCloudPubSubDestinationBuilder
Example to create an instance using the builder pattern
Table of content
Returned when the anonymous ID is being used by another resource.
GraphQLAnonymousIdAlreadyInUseErrorBuilder
Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
GraphQLAssociateMissingPermissionErrorBuilder
Example to create an instance using the builder pattern
Returned when the
name of the AttributeDefinition conflicts with an existing Attribute.GraphQLAttributeDefinitionAlreadyExistsErrorBuilder
Example to create an instance using the builder pattern
Returned when the
type is different for an AttributeDefinition using the same name in multiple Product Types.GraphQLAttributeDefinitionTypeConflictErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute
name.GraphQLAttributeNameDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
GraphQLBadGatewayErrorBuilder
Example to create an instance using the builder pattern
Returned when the request conflicts with the current state of the involved resources.
GraphQLConcurrentModificationErrorBuilder
Example to create an instance using the builder pattern
Returned when the request results in too much data being returned from the API.
GraphQLContentTooLargeErrorBuilder
Example to create an instance using the builder pattern
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
GraphQLCountryNotConfiguredInStoreErrorBuilder
Example to create an instance using the builder pattern
GraphQLResponse
Example to create an instance using the builder pattern
GraphQLDataResponseBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a Discount Code with a DiscountCodeState other than
MatchesCart.GraphQLDiscountCodeNonApplicableErrorBuilder
Example to create an instance using the builder pattern
Returned when the
Unique AttributeConstraint criteria are not met during an Update Product request.GraphQLDuplicateAttributeValueErrorBuilder
Example to create an instance using the builder pattern
Returned when the
CombinationUnique AttributeConstraint criteria are not met during an Update Product request.GraphQLDuplicateAttributeValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
GraphQLDuplicateEnumValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value causing a duplicate.
GraphQLDuplicateFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
GraphQLDuplicateFieldWithConflictingResourceErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
GraphQLDuplicatePriceKeyErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price scope conflicts with an existing one during an Update Product request.
GraphQLDuplicatePriceScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
GraphQLDuplicateStandalonePriceScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
GraphQLDuplicateVariantValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
GraphQLEditPreviewFailedErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains a key that already exists.
GraphQLEnumKeyAlreadyExistsErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
GraphQLEnumKeyDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
GraphQLEnumValueIsUsedErrorBuilder
Example to create an instance using the builder pattern
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
GraphQLEnumValuesMustMatchErrorBuilder
Example to create an instance using the builder pattern
GraphQLError
Example to create an instance using the builder pattern
GraphQLErrorBuilder
Example to create an instance using the builder pattern
GraphQLErrorLocation
Example to create an instance using the builder pattern
GraphQLErrorLocationBuilder
Example to create an instance using the builder pattern
Represents a single error.
GraphQLErrorObjectBuilder
Returned when the response from the API Extension could not be parsed successfully (such as a
500 HTTP status code, or an invalid JSON response).GraphQLExtensionBadResponseErrorBuilder
Example to create an instance using the builder pattern
Returned when the API Extension does not respond within the time limit, or could not be reached.
GraphQLExtensionNoResponseErrorBuilder
Example to create an instance using the builder pattern
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
GraphQLExtensionPredicateEvaluationFailedErrorBuilder
Example to create an instance using the builder pattern
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
GraphQLExtensionUpdateActionsFailedErrorBuilder
Example to create an instance using the builder pattern
Returned when an external OAuth Introspection endpoint does not return a response within the time limit, or the response isn't compliant with RFC 7662 (for example, an HTTP status code like
500).GraphQLExternalOAuthFailedErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested feature was removed.
GraphQLFeatureRemovedErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem occurs before or after data persistence.
GraphQLGeneralErrorBuilder
Example to create an instance using the builder pattern
GraphQLInsufficientScopeError
Example to create an instance using the builder pattern
GraphQLInsufficientScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
GraphQLInternalConstraintViolatedErrorBuilder
Example to create an instance using the builder pattern
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
GraphQLInvalidCredentialsErrorBuilder
Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
GraphQLInvalidCurrentPasswordErrorBuilder
Example to create an instance using the builder pattern
Returned when a field has an invalid value.
GraphQLInvalidFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
GraphQLInvalidInputErrorBuilder
Example to create an instance using the builder pattern
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
GraphQLInvalidItemShippingDetailsErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
GraphQLInvalidJsonInputErrorBuilder
Example to create an instance using the builder pattern
Returned when the resources involved in the request are not in a valid state for the operation.
GraphQLInvalidOperationErrorBuilder
Example to create an instance using the builder pattern
GraphQLInvalidSubjectError
Example to create an instance using the builder pattern
GraphQLInvalidSubjectErrorBuilder
Example to create an instance using the builder pattern
GraphQLInvalidTokenError
Example to create an instance using the builder pattern
GraphQLInvalidTokenErrorBuilder
Example to create an instance using the builder pattern
Returned when a language cannot be removed from a Project as it is being used by a Store.
GraphQLLanguageUsedInStoresErrorBuilder
Example to create an instance using the builder pattern
Returned when two Customers are simultaneously created or updated with the same email address.
GraphQLLockedFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when the Product Variant does not have a Price according to the Product
priceMode value for a selected currency, country, Customer Group, or Channel.GraphQLMatchingPriceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a Cart Discount cannot be created or activated as the limit for active Cart Discounts has been reached.
GraphQLMaxCartDiscountsReachedErrorBuilder
Example to create an instance using the builder pattern
Returned when a resource type cannot be created as it has reached its limits.
GraphQLMaxResourceLimitExceededErrorBuilder
Example to create an instance using the builder pattern
Returned when a Store cannot be added to a Cart Discount as the limit for Stores configured for a Cart Discount has been reached.
GraphQLMaxStoreReferencesReachedErrorBuilder
Example to create an instance using the builder pattern
Returned when one of the following states occur:
GraphQLMissingRoleOnChannelErrorBuilder
Example to create an instance using the builder pattern
Returned when the Tax Category of at least one of the
lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.GraphQLMissingTaxRateForCountryErrorBuilder
Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
GraphQLMoneyOverflowErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
GraphQLNoMatchingProductDiscountFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested resource was not found.
GraphQLObjectNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when some of the Line Items are out of stock at the time of placing an Order.
GraphQLOutOfStockErrorBuilder
Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
GraphQLOverCapacityErrorBuilder
Example to create an instance using the builder pattern
Returned when a given Price validity period conflicts with an existing one.
GraphQLOverlappingStandalonePriceValidityErrorBuilder
Example to create an instance using the builder pattern
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
GraphQLPendingOperationErrorBuilder
Example to create an instance using the builder pattern
Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
GraphQLPriceChangedErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product is not assigned to the Product Selection.
GraphQLProductAssignmentMissingErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
GraphQLProductPresentWithDifferentVariantSelectionErrorBuilder
Example to create an instance using the builder pattern
Returned when the languages set for a Store are not supported by the Project.
GraphQLProjectNotConfiguredForLanguagesErrorBuilder
Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededError
Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededErrorBuilder
Example to create an instance using the builder pattern
GraphQLQueryRequestBuilder<TData,T extends com.netflix.graphql.dgs.client.codegen.BaseProjectionNode>
Returned when the query times out.
GraphQLQueryTimedOutErrorBuilder
Example to create an instance using the builder pattern
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
GraphQLReferencedResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a resource cannot be deleted because it is being referenced by another resource.
GraphQLReferenceExistsErrorBuilder
Example to create an instance using the builder pattern
GraphQLRequest
Example to create an instance using the builder pattern
GraphQLRequestBuilder
Example to create an instance using the builder pattern
GraphQLRequestBuilder
Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
GraphQLRequiredFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource addressed by the request URL does not exist.
GraphQLResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
GraphQLResourceSizeLimitExceededErrorBuilder
Example to create an instance using the builder pattern
GraphQLResponse
Example to create an instance using the builder pattern
GraphQLResponseBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
GraphQLSearchDeactivatedErrorBuilder
Example to create an instance using the builder pattern
Returned when a search query could not be completed due to an unexpected failure.
GraphQLSearchExecutionFailureErrorBuilder
Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
GraphQLSearchFacetPathNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
GraphQLSearchIndexingInProgressErrorBuilder
Example to create an instance using the builder pattern
Returned when a Discount predicate or API Extension predicate is not semantically correct.
GraphQLSemanticErrorErrorBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
GraphQLShippingMethodDoesNotMatchCartErrorBuilder
Example to create an instance using the builder pattern
Returned when a Cart Discount cannot be created or assigned to a Store as the limit for active Cart Discounts in a Store has been reached for one or more Stores in the request.
GraphQLStoreCartDiscountsLimitReachedErrorBuilder
Example to create an instance using the builder pattern
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
GraphQLSyntaxErrorErrorBuilder
Example to create an instance using the builder pattern
GraphQLVariablesMap
Example to create an instance using the builder pattern
GraphQLVariablesMapBuilder
Example to create an instance using the builder pattern
The HandlerStack is used to execute the middlewares in order and transfer the request using the specified
HttpHandlerThe helper methods simplify the use of our SDK.
Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.
HighPrecisionMoney
Example to create an instance using the builder pattern
HighPrecisionMoneyBuilder
Example to create an instance using the builder pattern
HighPrecisionMoneyBuilder
Example to create an instance using the builder pattern
Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.
HighPrecisionMoneyDraftBuilder
Example to create an instance using the builder pattern
Hit
Example to create an instance using the builder pattern
HitBuilder
Example to create an instance using the builder pattern
Interface to supply a HTTP client implementation specified by a
ServiceLoaderWe recommend an encrypted
HTTPS connection for production setups.HttpDestinationAuthentication
Example to create a subtype instance using the builder pattern
HttpDestinationAuthenticationBuilder
HttpDestinationBuilder
Example to create an instance using the builder pattern
Exception which is thrown by
HttpAsyncClient.Exception which is thrown by
CtJavaNetHttpClient.The HttpExceptionFactory creates exceptions based on the HTTP status code returned by the
ApiHttpResponse.Handler to execute the given request using a HTTP client
an object identifiable by an ID
Image
Example to create an instance using the builder pattern
Image
Example to create an instance using the builder pattern
An Image uploaded to commercetools Composable Commerce is stored in a Content Delivery Network and it's available in several pre-defined sizes.
ImageBuilder
Example to create an instance using the builder pattern
ImageBuilder
Example to create an instance using the builder pattern
ImageBuilder
Example to create an instance using the builder pattern
ImageDimensions
Example to create an instance using the builder pattern
ImageDimensions
Example to create an instance using the builder pattern
ImageDimensionsBuilder
Example to create an instance using the builder pattern
ImageDimensionsBuilder
Example to create an instance using the builder pattern
Module to configure the default jackson
ObjectMapper e.g.Serves as the entry point of resources.
ImportContainerBuilder
Example to create an instance using the builder pattern
The representation sent to the server when creating an ImportContainer.
ImportContainerDraftBuilder
Example to create an instance using the builder pattern
PagedQueryResult for ImportContainers.
ImportContainerPagedResponseBuilder
Example to create an instance using the builder pattern
The representation sent to the server when updating an import container.
ImportContainerUpdateDraftBuilder
Example to create an instance using the builder pattern
Import Operation describes the import status of a specific resource.
ImportOperationBuilder
Example to create an instance using the builder pattern
PagedQueryResult for Import Operations.
ImportOperationPagedResponseBuilder
Example to create an instance using the builder pattern
Describes the validation state of a newly created ImportOperation.
possible values of ImportOperationState
ImportOperationStatus
Example to create an instance using the builder pattern
ImportOperationStatusBuilder
Example to create an instance using the builder pattern
An import request batches multiple import resources of the same import resource type for processing by an import container.
ImportRequestBuilder
A representation of the resource to import.
ImportResourceBuilder
Example to create an instance using the builder pattern
The resource types that can be imported.
possible values of ImportResourceType
A list of the ID's and validation statuses of newly created ImportOperations.
ImportResponseBuilder
Example to create an instance using the builder pattern
Describes the status of an ImportContainer by the number of resources in each Processing State.
ImportSummaryBuilder
Example to create an instance using the builder pattern
InheritedAssociate
Example to create an instance using the builder pattern
InheritedAssociate
Example to create an instance using the builder pattern
InheritedAssociateBuilder
Example to create an instance using the builder pattern
InheritedAssociateBuilder
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignment
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignment
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignmentBuilder
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignmentBuilder
Example to create an instance using the builder pattern
Table of content
- Installation
- Modules
- Gradle
- Maven
- Troubleshooting
- Spring Framework
InsufficientScopeError
Example to create an instance using the builder pattern
InsufficientScopeError
Example to create an instance using the builder pattern
InsufficientScopeErrorBuilder
Example to create an instance using the builder pattern
InsufficientScopeErrorBuilder
Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
InternalConstraintViolatedErrorBuilder
Example to create an instance using the builder pattern
Unified logger instance to perform logging only for configured logging levels.
Creates the
InternalLogger instances for the specified requestMiddleware instrumenting the
InternalLoggerReturned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
InvalidCredentialsError
Example to create an instance using the builder pattern
InvalidCredentialsErrorBuilder
Example to create an instance using the builder pattern
InvalidCredentialsErrorBuilder
Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
InvalidCurrentPasswordErrorBuilder
Example to create an instance using the builder pattern
Returned when a field has an invalid value.
A given field is not supported.
InvalidFieldErrorBuilder
Example to create an instance using the builder pattern
InvalidFieldErrorBuilder
Example to create an instance using the builder pattern
An invalid input has been sent to the service.
InvalidInputBuilder
Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
InvalidInputErrorBuilder
Example to create an instance using the builder pattern
Returned when Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
InvalidItemShippingDetailsErrorBuilder
Example to create an instance using the builder pattern
An invalid JSON input has been sent to the service.
InvalidJsonInputBuilder
Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
InvalidJsonInputErrorBuilder
Example to create an instance using the builder pattern
The resources in the request are not in the valid state for the operation.
InvalidOperationBuilder
Example to create an instance using the builder pattern
Returned when the resources involved in the request are not in a valid state for the operation.
InvalidOperationErrorBuilder
Example to create an instance using the builder pattern
The requested scope is invalid, unknown, malformed, or exceeds the scope granted by the resource owner.
InvalidScopeErrorBuilder
Example to create an instance using the builder pattern
InvalidStateTransitionError
Example to create an instance using the builder pattern
InvalidStateTransitionErrorBuilder
Example to create an instance using the builder pattern
InvalidSubjectError
Example to create an instance using the builder pattern
InvalidSubjectErrorBuilder
Example to create an instance using the builder pattern
InvalidTokenError
Example to create an instance using the builder pattern
InvalidTokenError
Example to create an instance using the builder pattern
InvalidTokenErrorBuilder
Example to create an instance using the builder pattern
InvalidTokenErrorBuilder
Example to create an instance using the builder pattern
InventoryEntry
Example to create an instance using the builder pattern
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.InventoryEntryAddQuantityActionBuilder
Example to create an instance using the builder pattern
InventoryEntryBuilder
Example to create an instance using the builder pattern
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.InventoryEntryChangeQuantityActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
InventoryEntryDraft
Example to create an instance using the builder pattern
InventoryEntryDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
InventoryEntryQuantitySetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
InventoryEntryQuantitySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to an InventoryEntry.
InventoryEntryReferenceBuilder
Example to create an instance using the builder pattern
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.InventoryEntryRemoveQuantityActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an InventoryEntry.
InventoryEntryResourceIdentifierBuilder
Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldAction
Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeAction
Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryAction
Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetKeyAction
Example to create an instance using the builder pattern
InventoryEntrySetKeyActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysAction
Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysActionBuilder
Example to create an instance using the builder pattern
If an entry with the same
sku and supplyChannel already exists, an DuplicateField error is returned.InventoryEntrySetSupplyChannelActionBuilder
Example to create an instance using the builder pattern
InventoryEntryUpdate
Example to create an instance using the builder pattern
InventoryEntryUpdateAction
Example to create a subtype instance using the builder pattern
InventoryEntryUpdateActionBuilder
InventoryEntryUpdateBuilder
Example to create an instance using the builder pattern
The data representation for an Inventory to be imported that is persisted as a Inventory in the Project.
InventoryImportBuilder
Example to create an instance using the builder pattern
The request body to import Inventories.
InventoryImportRequestBuilder
Example to create an instance using the builder pattern
Indicates how Line Items in a Cart are tracked.
Maps to
Order.inventoryMode.possible values of InventoryMode
possible values of InventoryMode
InventoryPagedQueryResponse
Example to create an instance using the builder pattern
InventoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
InventoryQuantityValue
Example to create an instance using the builder pattern
InventoryQuantityValueBuilder
Example to create an instance using the builder pattern
ItemShippingDetails
Example to create an instance using the builder pattern
ItemShippingDetails
Example to create an instance using the builder pattern
ItemShippingDetailsBuilder
Example to create an instance using the builder pattern
ItemShippingDetailsBuilder
Example to create an instance using the builder pattern
For order creation and updates, the sum of the
targets must match the quantity of the Line Items or Custom Line Items.ItemShippingDetailsDraft
Example to create an instance using the builder pattern
ItemShippingDetailsDraftBuilder
Example to create an instance using the builder pattern
ItemShippingDetailsDraftBuilder
Example to create an instance using the builder pattern
Determines the address (as a reference to an address in
itemShippingAddresses) and the quantity shipped to the address.ItemShippingTarget
Example to create an instance using the builder pattern
The item's shipping target.
ItemShippingTargetBuilder
Example to create an instance using the builder pattern
ItemShippingTargetBuilder
Example to create an instance using the builder pattern
ItemShippingTargetBuilder
Example to create an instance using the builder pattern
ItemState
Example to create an instance using the builder pattern
ItemState
Example to create an instance using the builder pattern
The item's state.
ItemStateBuilder
Example to create an instance using the builder pattern
ItemStateBuilder
Example to create an instance using the builder pattern
ItemStateBuilder
Example to create an instance using the builder pattern
Class with methods to customize the JSON serialization/deserialization
A KeyReference represents a loose reference to another resource in the same Project identified by the resource's
key field.KeyReference
Example to create an instance using the builder pattern
References a resource by key.
KeyReferenceBuilder
KeyReferenceBuilder
Example to create an instance using the builder pattern
KeyReferenceBuilder
Provides descriptive information specific to the resource.
LabelBuilder
Returned when a language cannot be removed from a Project as it is being used by a Store.
LanguageUsedInStoresErrorBuilder
Example to create an instance using the builder pattern
IDs and references that last modified the resource.
LastModifiedByBuilder
Example to create an instance using the builder pattern
The representation of a Line Item in a Cart or in an Order.
LineItem
Example to create an instance using the builder pattern
LineItemBuilder
Example to create an instance using the builder pattern
LineItemBuilder
Example to create an instance using the builder pattern
For Product Variant identification, either the
productId and variantId, or sku must be provided.LineItemDraftBuilder
Example to create an instance using the builder pattern
Represents a snapshot of a Product Variant at the time it was imported with the Order.
Represents an individual Line Item in an Order.
LineItemImportDraftBuilder
Example to create an instance using the builder pattern
LineItemImportDraftBuilder
Example to create an instance using the builder pattern
Indicates how a Line Item was added to a Cart.
possible values of LineItemMode
LineItemPrice
Example to create an instance using the builder pattern
LineItemPriceBuilder
Example to create an instance using the builder pattern
This mode indicates how the price is set for the Line Item.
possible values of LineItemPriceMode
LineItemProductVariantImportDraft
Example to create an instance using the builder pattern
LineItemProductVariantImportDraftBuilder
Example to create an instance using the builder pattern
LineItemReturnItem
Example to create an instance using the builder pattern
LineItemReturnItemBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition LineItem State update action.
LineItemStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition LineItem State update action.
LineItemStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
serializes a
LocalDate to DateTimeFormatter.ISO_DATE formatLocaleprojectingTrait
This type represents an attribute whose value is a localized enum.
LocalizableEnumAttributeBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized enum.
LocalizableEnumSetAttributeBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized text.
LocalizableTextAttributeBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a localized text.
LocalizableTextSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a localized enum value.
LocalizedEnumFieldBuilder
Example to create an instance using the builder pattern
A field with a localized enum set value.
LocalizedEnumSetFieldBuilder
Example to create an instance using the builder pattern
LocalizedEnumValue
Example to create an instance using the builder pattern
LocalizedEnumValue
Example to create an instance using the builder pattern
LocalizedEnumValueBuilder
Example to create an instance using the builder pattern
LocalizedEnumValueBuilder
Example to create an instance using the builder pattern
LocalizedLabel
Example to create an instance using the builder pattern
LocalizedLabelBuilder
Example to create an instance using the builder pattern
A localized string is a object where the keys are
Locales (HTTP API: ISO language tags),
and the values are the corresponding strings used for that language.LocalizedString
Example to create an instance using the builder pattern
A localized string is a JSON object where the keys are of IETF language tag, and the values the corresponding strings used for that language.
Builder to create a
LocalizedStringLocalizedStringBuilder
Example to create an instance using the builder pattern
LocalizedStringBuilder
Example to create an instance using the builder pattern
Entry of for a LocalizedString
A field with a localized string value.
LocalizedStringFieldBuilder
Example to create an instance using the builder pattern
A field with a localized string set value.
LocalizedStringSetFieldBuilder
Example to create an instance using the builder pattern
serializes a
LocalTime to DateTimeFormatter.ISO_TIME formatA geographical location representing a country and optionally a state within this country.
Shape of the value for
addLocation and removeLocation actionsLocationBuilder
Example to create an instance using the builder pattern
LocationBuilder
Example to create an instance using the builder pattern
Returned when two Customers are simultaneously created or updated with the same email address.
LockedFieldErrorBuilder
Example to create an instance using the builder pattern
Table of content
accessor interface for map objects like attributes or custom fields
Returned when the Product Variant does not have a Price according to the Product
priceMode value for a selected currency, country, Customer Group, or Channel.MatchingPriceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a Cart Discount cannot be created or activated as the limit for active Cart Discounts has been reached.
MaxCartDiscountsReachedErrorBuilder
Example to create an instance using the builder pattern
Returned when a resource type cannot be created as it has reached its limits.
MaxResourceLimitExceededErrorBuilder
Example to create an instance using the builder pattern
Returned when a Store cannot be added to a Cart Discount as the limit for Stores configured for a Cart Discount has been reached.
MaxStoreReferencesReachedErrorBuilder
Example to create an instance using the builder pattern
Base representation of a Message containing common fields to all Message Types.
MessageBuilder
Deprecated.
use
MessagesConfiguration insteadDeprecated.
use
MessagesConfigurationBuilder insteadDeprecated.
use
MessagesConfigurationDraft insteadDeprecated.
use
MessagesConfigurationDraftBuilder insteadDeprecated.
use
MessageDeliveryPayload insteadDeprecated.
use
MessageDeliveryPayloadBuilder insteadThis payload is sent for a MessageSubscription.
MessageDeliveryPayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Message.MessagePagedQueryResponseBuilder
Example to create an instance using the builder pattern
MessagePayload
Example to create a subtype instance using the builder pattern
MessagePayloadBuilder
Holds the configuration for the Messages Query feature for the Project.
MessagesConfigurationBuilder
Example to create an instance using the builder pattern
Defines the configuration for the Messages Query feature for the Project.
MessagesConfigurationDraftBuilder
Example to create an instance using the builder pattern
For supported resources and message types, see Message Types.
MessageSubscriptionBuilder
Example to create an instance using the builder pattern
Resource types supported by MessageSubscriptions:
possible values of MessageSubscriptionResourceTypeId
Interface for resources with meta attributes
MethodExternalTaxRateDraft
Example to create an instance using the builder pattern
MethodExternalTaxRateDraftBuilder
Example to create an instance using the builder pattern
MethodTaxedPrice
Example to create an instance using the builder pattern
MethodTaxedPriceBuilder
Example to create an instance using the builder pattern
MethodTaxRate
Example to create an instance using the builder pattern
MethodTaxRateBuilder
Example to create an instance using the builder pattern
Interface for a HTTP middleware used to modify a request and the response
Returned when one of the following states occur:
MissingRoleOnChannelErrorBuilder
Example to create an instance using the builder pattern
Returned when the Tax Category of at least one of the
lineItems, customLineItems, or shippingInfo in the Cart is missing the TaxRate matching country and state given in the shippingAddress of that Cart.MissingTaxRateForCountryErrorBuilder
Example to create an instance using the builder pattern
Information about the user or API Client who performed the change.
ModifiedByBuilder
Example to create an instance using the builder pattern
Interface to supply a Jackson
SimpleModule specified by a ServiceLoaderconversion methods for Money classes
Draft type that stores amounts in cent precision for the specified currency.
Money
Example to create an instance using the builder pattern
Money
Example to create an instance using the builder pattern
This type represents an attribute whose value is a money object.
MoneyAttributeBuilder
Example to create an instance using the builder pattern
MoneyBuilder
Example to create an instance using the builder pattern
MoneyBuilder
Example to create an instance using the builder pattern
MoneyBuilder
Example to create an instance using the builder pattern
A field with a money value.
MoneyFieldBuilder
Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
MoneyOverflowErrorBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of money objects.
MoneySetAttributeBuilder
Example to create an instance using the builder pattern
A field with a money set value.
MoneySetFieldBuilder
Example to create an instance using the builder pattern
Determines the type of money used.
MoneyType
MoneyType
possible values of MoneyType
possible values of MoneyType
possible values of MoneyType
Utility methods to convert from
MonetaryAmount to Money and vice versaChange triggered by the Move image to position update action.
MoveImageToPositionChangeBuilder
Example to create an instance using the builder pattern
This Discount target is similar to
MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.MultiBuyCustomLineItemsTargetBuilder
Example to create an instance using the builder pattern
MultiBuyLineItemsTarget
Example to create an instance using the builder pattern
MultiBuyLineItemsTargetBuilder
Example to create an instance using the builder pattern
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
MyBusinessUnitAddAddressActionBuilder
Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
MyBusinessUnitAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
MyBusinessUnitAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraft
Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraftBuilder
Example to create an instance using the builder pattern
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
MyBusinessUnitChangeAddressActionBuilder
Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
MyBusinessUnitChangeAssociateActionBuilder
Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
MyBusinessUnitChangeNameActionBuilder
Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
MyBusinessUnitChangeParentUnitActionBuilder
Example to create an instance using the builder pattern
MyBusinessUnitDraft
Example to create a subtype instance using the builder pattern
MyBusinessUnitDraftBuilder
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
MyBusinessUnitRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
MyBusinessUnitRemoveAssociateActionBuilder
Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
MyBusinessUnitRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
MyBusinessUnitRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.
MyBusinessUnitSetAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type to an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.
MyBusinessUnitSetAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
MyBusinessUnitSetContactEmailActionBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to a Business Unit generates the BusinessUnitCustomFieldAdded Message, removing one generates the BusinessUnitCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitCustomFieldChanged Message.
MyBusinessUnitSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.
MyBusinessUnitSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the default billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
MyBusinessUnitSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
MyBusinessUnitSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
MyBusinessUnitUpdate
Example to create an instance using the builder pattern
MyBusinessUnitUpdateAction
Example to create a subtype instance using the builder pattern
MyBusinessUnitUpdateActionBuilder
MyBusinessUnitUpdateBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related CartDiscounts.
MyCartAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
MyCartAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
MyCartAddLineItemActionBuilder
Example to create an instance using the builder pattern
MyCartAddPaymentAction
Example to create an instance using the builder pattern
MyCartAddPaymentActionBuilder
Example to create an instance using the builder pattern
To override the shipping details, see Set LineItem ShippingDetails.
MyCartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
MyCartChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
When
External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed.
When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress.
Example to create an instance using the builder pattern
MyCartChangeTaxModeActionBuilder
Example to create an instance using the builder pattern
The
customerId is determined by a password flow token and automatically set on the resulting Cart.MyCartDraftBuilder
Example to create an instance using the builder pattern
This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state.
MyCartRecalculateActionBuilder
Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeAction
Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
MyCartRemoveItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
MyCartRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
MyCartRemovePaymentAction
Example to create an instance using the builder pattern
MyCartRemovePaymentActionBuilder
Example to create an instance using the builder pattern
MyCartSetBillingAddressAction
Example to create an instance using the builder pattern
MyCartSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
MyCartSetBusinessUnitActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
MyCartSetCountryActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomerEmailAction
Example to create an instance using the builder pattern
MyCartSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomFieldAction
Example to create an instance using the builder pattern
MyCartSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomTypeAction
Example to create an instance using the builder pattern
MyCartSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Number of days after which a Cart with
Active CartState is deleted since its last modification.MyCartSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.MyCartSetLineItemDistributionChannelActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
MyCartSetLineItemSupplyChannelActionBuilder
Example to create an instance using the builder pattern
MyCartSetLocaleAction
Example to create an instance using the builder pattern
MyCartSetLocaleActionBuilder
Example to create an instance using the builder pattern
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
MyCartSetShippingAddressActionBuilder
Example to create an instance using the builder pattern
To set the Cart's Shipping Method the Cart must have the
Single ShippingMode and a shippingAddress.MyCartSetShippingMethodActionBuilder
Example to create an instance using the builder pattern
MyCartUpdate
Example to create an instance using the builder pattern
MyCartUpdateAction
Example to create a subtype instance using the builder pattern
MyCartUpdateActionBuilder
MyCartUpdateBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.MyCartUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
MyCompanyDraftBuilder
Example to create an instance using the builder pattern
Adding an address to the Customer produces the CustomerAddressAdded Message.
MyCustomerAddAddressActionBuilder
Example to create an instance using the builder pattern
Adds an address from the
addresses array to billingAddressIds.MyCustomerAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adds an address from the
addresses array to shippingAddressIds.MyCustomerAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
MyCustomerChangeAddressActionBuilder
Example to create an instance using the builder pattern
Changing the email of the Customer produces the CustomerEmailChanged Message.
MyCustomerChangeEmailActionBuilder
Example to create an instance using the builder pattern
MyCustomerChangePassword
Example to create an instance using the builder pattern
MyCustomerChangePasswordBuilder
Example to create an instance using the builder pattern
MyCustomerDraft
Example to create an instance using the builder pattern
MyCustomerDraftBuilder
Example to create an instance using the builder pattern
MyCustomerEmailVerify
Example to create an instance using the builder pattern
MyCustomerEmailVerifyBuilder
Example to create an instance using the builder pattern
Removing an address of the Customer produces the CustomerAddressRemoved Message.
MyCustomerRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removes an existing billing address from
billingAddressesIds.MyCustomerRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes an existing shipping address from
shippingAddressesIds.MyCustomerRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
MyCustomerResetPassword
Example to create an instance using the builder pattern
MyCustomerResetPasswordBuilder
Example to create an instance using the builder pattern
Setting the
companyName field on the Customer produces the CustomerCompanyNameSet Message.MyCustomerSetCompanyNameActionBuilder
Example to create an instance using the builder pattern
Adding a Custom Field to a Customer generates the CustomerCustomFieldAdded Message, removing one generates the CustomerCustomFieldRemoved Message, and updating an existing one generates the CustomerCustomFieldChanged Message.
MyCustomerSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Adding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.
MyCustomerSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
MyCustomerSetDateOfBirthActionBuilder
Example to create an instance using the builder pattern
Sets the default billing address from
addresses.MyCustomerSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default shipping address from
addresses.MyCustomerSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Setting the first name of the Customer produces the CustomerFirstNameSet Message.
MyCustomerSetFirstNameActionBuilder
Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSet Message.
MyCustomerSetLastNameActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetLocaleAction
Example to create an instance using the builder pattern
MyCustomerSetLocaleActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetMiddleNameAction
Example to create an instance using the builder pattern
MyCustomerSetMiddleNameActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetSalutationAction
Example to create an instance using the builder pattern
MyCustomerSetSalutationActionBuilder
Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSetMessage.
MyCustomerSetTitleActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetVatIdAction
Example to create an instance using the builder pattern
MyCustomerSetVatIdActionBuilder
Example to create an instance using the builder pattern
MyCustomerSignin
Example to create an instance using the builder pattern
MyCustomerSigninBuilder
Example to create an instance using the builder pattern
MyCustomerUpdate
Example to create an instance using the builder pattern
MyCustomerUpdateAction
Example to create a subtype instance using the builder pattern
MyCustomerUpdateActionBuilder
MyCustomerUpdateBuilder
Example to create an instance using the builder pattern
Draft type to model divisions that are part of the Company or a higher-order Division.
MyDivisionDraftBuilder
Example to create an instance using the builder pattern
For Product Variant identification, either the
productId and variantId, or sku must be provided.MyLineItemDraftBuilder
Example to create an instance using the builder pattern
MyOrderFromCartDraft
Example to create an instance using the builder pattern
MyOrderFromCartDraftBuilder
Example to create an instance using the builder pattern
MyOrderFromQuoteDraft
Example to create an instance using the builder pattern
MyOrderFromQuoteDraftBuilder
Example to create an instance using the builder pattern
MyPayment
Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
MyPaymentAddTransactionActionBuilder
Example to create an instance using the builder pattern
MyPaymentBuilder
Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
MyPaymentChangeAmountPlannedActionBuilder
Example to create an instance using the builder pattern
MyPaymentDraft
Example to create an instance using the builder pattern
MyPaymentDraftBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of MyPayment.MyPaymentPagedQueryResponseBuilder
Example to create an instance using the builder pattern
MyPaymentSetCustomFieldAction
Example to create an instance using the builder pattern
MyPaymentSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldAction
Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyPaymentUpdate
Example to create an instance using the builder pattern
MyPaymentUpdateAction
Example to create a subtype instance using the builder pattern
MyPaymentUpdateActionBuilder
MyPaymentUpdateBuilder
Example to create an instance using the builder pattern
When accepting, declining, or renegotiating B2B Quotes, the Customer must have the
AcceptMyQuotes, DeclineMyQuotes, or RenegotiateMyQuotes Permission, respectively.MyQuoteChangeMyQuoteStateActionBuilder
Example to create an instance using the builder pattern
Transitions the
quoteRequestState of the Quote Request to Cancelled.MyQuoteRequestCancelActionBuilder
Example to create an instance using the builder pattern
MyQuoteRequestDraft
Example to create an instance using the builder pattern
MyQuoteRequestDraftBuilder
Example to create an instance using the builder pattern
MyQuoteRequestUpdate
Example to create an instance using the builder pattern
MyQuoteRequestUpdateAction
Example to create a subtype instance using the builder pattern
MyQuoteRequestUpdateActionBuilder
MyQuoteRequestUpdateBuilder
Example to create an instance using the builder pattern
QuoteStates that can be set using the Change My Quote State update action.
possible values of MyQuoteState
MyQuoteUpdate
Example to create an instance using the builder pattern
MyQuoteUpdateAction
Example to create a subtype instance using the builder pattern
MyQuoteUpdateActionBuilder
MyQuoteUpdateBuilder
Example to create an instance using the builder pattern
MyShoppingListAddLineItemAction
Example to create an instance using the builder pattern
MyShoppingListAddLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemAction
Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityAction
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderAction
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeNameAction
Example to create an instance using the builder pattern
MyShoppingListChangeNameActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
A MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.
MyShoppingListDraftBuilder
Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemAction
Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationAction
Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetDescriptionAction
Example to create an instance using the builder pattern
MyShoppingListSetDescriptionActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionActionBuilder
Example to create an instance using the builder pattern
MyShoppingListUpdate
Example to create an instance using the builder pattern
MyShoppingListUpdateAction
Example to create a subtype instance using the builder pattern
MyShoppingListUpdateActionBuilder
MyShoppingListUpdateBuilder
Example to create an instance using the builder pattern
MyTransactionDraft
Example to create an instance using the builder pattern
MyTransactionDraftBuilder
Example to create an instance using the builder pattern
This serializer uses API to submit metrics to newrelic.
The NewRelicTelemetry middleware can be used to report outgoing request to commercetools to NewRelic.
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
NoMatchingProductDiscountFoundErrorBuilder
Example to create an instance using the builder pattern
Middleware to convert a
NotFoundException to a response with a null body valueThis type represents an attribute whose value is a number.
NumberAttributeBuilder
Example to create an instance using the builder pattern
A field with a number value.
NumberFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of numbers.
NumberSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a number value.
NumberSetFieldBuilder
Example to create an instance using the builder pattern
Handler for retrieving an oauth authentication token
Middleware to add an oauth authentication header to requests
Default implementation for the
OAuthMiddleware with automatic retry upon expired accessReturned when the requested resource was not found.
ObjectNotFoundErrorBuilder
Example to create an instance using the builder pattern
The OpenTelemetry middleware can be used to report metrics about outgoing request to commercetools.
The OpenTelemetry ResponseSerializer can be used to report metrics about the De-/Serialization performance.
The number of resources in each Processing State.
OperationStatesBuilder
Example to create an instance using the builder pattern
Order
Example to create an instance using the builder pattern
A Delivery can only be added to an Order if its
shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.OrderAddDeliveryActionBuilder
Example to create an instance using the builder pattern
Adds an address to an Order when shipping to multiple addresses is desired.
OrderAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
To add a Parcel, at least one Delivery must exist.
OrderAddParcelToDeliveryActionBuilder
Example to create an instance using the builder pattern
OrderAddPaymentAction
Example to create an instance using the builder pattern
OrderAddPaymentActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Added Message.
OrderAddReturnInfoActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Billing Address update action.
OrderBillingAddressSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Billing Address update action.
OrderBillingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
OrderBuilder
Example to create an instance using the builder pattern
Produces the Order State Changed Message.
OrderChangeOrderStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Payment State Changed Message.
OrderChangePaymentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Shipment State Changed Message.
OrderChangeShipmentStateActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Order request.
OrderCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Order request.
OrderCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Email update action.
OrderCustomerEmailSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Email update action.
OrderCustomerEmailSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
OrderCustomerGroupSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
OrderCustomerGroupSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer ID update action.
OrderCustomerSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer ID update action.
OrderCustomerSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field using the Set CustomField.
OrderCustomFieldAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field using the Set CustomField.
OrderCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated when an existing Custom Field has been changed using the Set CustomField action.
OrderCustomFieldChangedMessageBuilder
Example to create an instance using the builder pattern
Generated when an existing Custom Field has been changed using the Set CustomField action.
OrderCustomFieldChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated when a Custom Field has been removed from the Order using the Set CustomField action.
OrderCustomFieldRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated when a Custom Field has been removed from the Order using the Set CustomField action.
OrderCustomFieldRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add CustomLineItem update action.
OrderCustomLineItemAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add CustomLineItem update action.
OrderCustomLineItemAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Custom Line Item.
OrderCustomLineItemDiscountSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Custom Line Item.
OrderCustomLineItemDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change CustomLineItem Quantity update action.
OrderCustomLineItemQuantityChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change CustomLineItem Quantity update action.
OrderCustomLineItemQuantityChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove CustomLineItem update action.
OrderCustomLineItemRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove CustomLineItem update action.
OrderCustomLineItemRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type with empty parameters.
OrderCustomTypeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type with empty parameters.
OrderCustomTypeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type.
OrderCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type.
OrderCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
OrderDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
OrderDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add DiscountCode update action.
OrderDiscountCodeAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add DiscountCode update action.
OrderDiscountCodeAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove DiscountCode update action.
OrderDiscountCodeRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove DiscountCode update action.
OrderDiscountCodeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after the DiscountCodeState changes due to a recalculation.
OrderDiscountCodeStateSetMessageBuilder
Example to create an instance using the builder pattern
Generated after the DiscountCodeState changes due to a recalculation.
OrderDiscountCodeStateSetMessagePayloadBuilder
Example to create an instance using the builder pattern
OrderEdit
Example to create an instance using the builder pattern
If the edit was applied, this cannot be updated.
OrderEditAddStagedActionActionBuilder
Example to create an instance using the builder pattern
Result of a succesful application of
stagedActions to the Order.OrderEditAppliedBuilder
Example to create an instance using the builder pattern
Generated after successfully applying an OrderEdit.
OrderEditAppliedMessageBuilder
Example to create an instance using the builder pattern
Generated after successfully applying an OrderEdit.
OrderEditAppliedMessagePayloadBuilder
Example to create an instance using the builder pattern
If the
editVersion and/or resourceVersion do not match the actual version, a ConcurrentModification error will be returned.OrderEditApplyBuilder
Example to create an instance using the builder pattern
OrderEditBuilder
Example to create an instance using the builder pattern
OrderEditDraft
Example to create an instance using the builder pattern
OrderEditDraftBuilder
Example to create an instance using the builder pattern
Indicates that the edit has not been applied or processed in any way.
OrderEditNotProcessedBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of OrderEdit.OrderEditPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Result of a failed application of
stagedActions to the Order.OrderEditPreviewFailureBuilder
Example to create an instance using the builder pattern
The data is not persisted but is dynamically pulled by dry-running the update actions from
stagedActions on the current version of the related Order, not from the Order version at the time the OrderEdit was created.OrderEditPreviewSuccessBuilder
Example to create an instance using the builder pattern
Reference to an OrderEdit.
OrderEditReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an OrderEdit.
OrderEditResourceIdentifierBuilder
Example to create an instance using the builder pattern
OrderEditResult
Example to create a subtype instance using the builder pattern
OrderEditResultBuilder
OrderEditSetCommentAction
Example to create an instance using the builder pattern
OrderEditSetCommentActionBuilder
Example to create an instance using the builder pattern
OrderEditSetCustomFieldAction
Example to create an instance using the builder pattern
OrderEditSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderEditSetCustomTypeAction
Example to create an instance using the builder pattern
OrderEditSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderEditSetKeyAction
Example to create an instance using the builder pattern
OrderEditSetKeyActionBuilder
Example to create an instance using the builder pattern
If the edit is applied,
stagedActions cannot be updated.OrderEditSetStagedActionsActionBuilder
Example to create an instance using the builder pattern
OrderEditUpdate
Example to create an instance using the builder pattern
OrderEditUpdateAction
Example to create a subtype instance using the builder pattern
OrderEditUpdateActionBuilder
OrderEditUpdateBuilder
Example to create an instance using the builder pattern
Excerpt of the Order extracting the total and the taxed price.
OrderExcerptBuilder
Example to create an instance using the builder pattern
Order fields that needs to be added or updated.
OrderFieldBuilder
Example to create an instance using the builder pattern
OrderFromCartDraft
Example to create an instance using the builder pattern
OrderFromCartDraftBuilder
Example to create an instance using the builder pattern
OrderFromQuoteDraft
Example to create an instance using the builder pattern
OrderFromQuoteDraftBuilder
Example to create an instance using the builder pattern
The data representation for an Order to be imported that is persisted as an Order in the Project.
OrderImportBuilder
Example to create an instance using the builder pattern
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
OrderImportCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
A snapshot of an Order at the time it was imported.
OrderImportDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Order Import.
OrderImportedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Order Import.
OrderImportedMessagePayloadBuilder
Example to create an instance using the builder pattern
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
OrderImportLineItemStateActionBuilder
Example to create an instance using the builder pattern
The request body to import Orders.
OrderImportRequestBuilder
Example to create an instance using the builder pattern
References an order by key.
OrderKeyReferenceBuilder
Example to create an instance using the builder pattern
OrderLabel
Example to create an instance using the builder pattern
OrderLabelBuilder
Example to create an instance using the builder pattern
Interface to collect the common stuff between carts and orders.
Generated after a successful Add LineItem update action.
OrderLineItemAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add LineItem update action.
OrderLineItemAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Line Item.
OrderLineItemDiscountSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful recalculation of a Discount on a Line Item.
OrderLineItemDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set LineItem DistributionChannel update action.
OrderLineItemDistributionChannelSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set LineItem DistributionChannel update action.
OrderLineItemDistributionChannelSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove LineItem update action.
OrderLineItemRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove LineItem update action.
OrderLineItemRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
OrderMessage
Example to create an instance using the builder pattern
OrderMessagePayload
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Order.OrderPagedQueryResponseBuilder
Example to create an instance using the builder pattern
OrderPagedSearchResponse
Example to create an instance using the builder pattern
OrderPagedSearchResponseBuilder
Example to create an instance using the builder pattern
Representation for an update of an Order.
OrderPatchImportBuilder
Example to create an instance using the builder pattern
The request body to import OrderPatches.
OrderPatchImportRequestBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
OrderPaymentAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Payment update action or when a Payment is added via Order Edits.
OrderPaymentAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change PaymentState update action.
OrderPaymentStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change PaymentState update action.
OrderPaymentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Purchase Order Number update action.
OrderPurchaseOrderNumberSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Purchase Order Number update action.
OrderPurchaseOrderNumberSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to an Order.
OrderReferenceBuilder
Example to create an instance using the builder pattern
Produces the DeliveryRemoved Message.
OrderRemoveDeliveryActionBuilder
Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
OrderRemoveItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelRemovedFromDelivery Message.
OrderRemoveParcelFromDeliveryActionBuilder
Example to create an instance using the builder pattern
OrderRemovePaymentAction
Example to create an instance using the builder pattern
OrderRemovePaymentActionBuilder
Example to create an instance using the builder pattern
Deprecated.
Deprecated.
Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.
OrderReturnShipmentStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.
OrderReturnShipmentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
OrderSearchAndExpression
Example to create an instance using the builder pattern
OrderSearchAndExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchAnyValue
Example to create an instance using the builder pattern
OrderSearchAnyValueBuilder
Example to create an instance using the builder pattern
OrderSearchCompoundExpression
Example to create an instance using the builder pattern
OrderSearchCompoundExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchDateRangeExpression
Example to create an instance using the builder pattern
OrderSearchDateRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchDateRangeValue
Example to create an instance using the builder pattern
OrderSearchDateRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchExactExpression
Example to create an instance using the builder pattern
OrderSearchExactExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchExistsExpression
Example to create an instance using the builder pattern
OrderSearchExistsExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchFilterExpression
Example to create an instance using the builder pattern
OrderSearchFilterExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchFullTextExpression
Example to create an instance using the builder pattern
OrderSearchFullTextExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchFullTextValue
Example to create an instance using the builder pattern
OrderSearchFullTextValueBuilder
Example to create an instance using the builder pattern
OrderSearchLongRangeExpression
Example to create an instance using the builder pattern
OrderSearchLongRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchLongRangeValue
Example to create an instance using the builder pattern
OrderSearchLongRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchMatchType
possible values of OrderSearchMatchType
OrderSearchNotExpression
Example to create an instance using the builder pattern
OrderSearchNotExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchNumberRangeExpression
Example to create an instance using the builder pattern
OrderSearchNumberRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchNumberRangeValue
Example to create an instance using the builder pattern
OrderSearchNumberRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchOrExpression
Example to create an instance using the builder pattern
OrderSearchOrExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchPrefixExpression
Example to create an instance using the builder pattern
OrderSearchPrefixExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchQuery
Example to create an instance using the builder pattern
OrderSearchQueryBuilder
Example to create an instance using the builder pattern
OrderSearchQueryExpression
Example to create an instance using the builder pattern
OrderSearchQueryExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchQueryExpressionValue
Example to create an instance using the builder pattern
OrderSearchQueryExpressionValueBuilder
Example to create an instance using the builder pattern
OrderSearchRequest
Example to create an instance using the builder pattern
OrderSearchRequestBuilder
Example to create an instance using the builder pattern
OrderSearchSorting
Example to create an instance using the builder pattern
OrderSearchSortingBuilder
Example to create an instance using the builder pattern
OrderSearchSortMode
possible values of OrderSearchSortMode
OrderSearchSortOrder
possible values of OrderSearchSortOrder
Specifies the status of the Order Search index.
possible values of OrderSearchStatus
OrderSearchStringValue
Example to create an instance using the builder pattern
OrderSearchStringValueBuilder
Example to create an instance using the builder pattern
OrderSearchWildCardExpression
Example to create an instance using the builder pattern
OrderSearchWildCardExpressionBuilder
Example to create an instance using the builder pattern
This action updates the
billingAddress on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.OrderSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
This action updates the
customerEmail on the Order, but it does not change the Customer email on the Cart the Order has been created from.OrderSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
Setting the Order's
customerId does not recalculate prices or discounts on the Order.OrderSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomFieldAction
Example to create an instance using the builder pattern
OrderSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomTypeAction
Example to create an instance using the builder pattern
OrderSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryAddressSet Message.
OrderSetDeliveryAddressActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeAction
Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the Delivery Items Updated Message.
OrderSetDeliveryItemsActionBuilder
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
OrderSetLocaleAction
Example to create an instance using the builder pattern
OrderSetLocaleActionBuilder
Example to create an instance using the builder pattern
OrderSetOrderNumberAction
Example to create an instance using the builder pattern
OrderSetOrderNumberActionBuilder
Example to create an instance using the builder pattern
OrderSetParcelCustomFieldAction
Example to create an instance using the builder pattern
OrderSetParcelCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetParcelCustomTypeAction
Example to create an instance using the builder pattern
OrderSetParcelCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelItemsUpdated Message.
OrderSetParcelItemsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelMeasurementsUpdated Message.
OrderSetParcelMeasurementsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelTrackingDataUpdated Message.
OrderSetParcelTrackingDataActionBuilder
Example to create an instance using the builder pattern
Produces the PurchaseOrderNumberSet Message.
OrderSetPurchaseOrderNumberActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Set Message.
OrderSetReturnInfoActionBuilder
Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
To set a ReturnPaymentState, the Order
returnInfo must have at least one ReturnItem.OrderSetReturnPaymentStateActionBuilder
Example to create an instance using the builder pattern
To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.OrderSetReturnShipmentStateActionBuilder
Example to create an instance using the builder pattern
This action updates the
shippingAddress on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.OrderSetShippingAddressActionBuilder
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
Sets the Store the Order is assigned to.
OrderSetStoreActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Change ShipmentState update action.
OrderShipmentStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change ShipmentState update action.
OrderShipmentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Shipping Address update action.
OrderShippingAddressSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Shipping Address update action.
OrderShippingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ShippingMethod and Set Custom ShippingMethod update actions.
OrderShippingInfoSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ShippingMethod and Set Custom ShippingMethod update actions.
OrderShippingInfoSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ShippingRateInput update action.
OrderShippingRateInputSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ShippingRateInput update action.
OrderShippingRateInputSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Indicates the state of the Order.
OrderState
Maps to
Order.orderState.possible values of OrderState
possible values of OrderState
possible values of OrderState
Generated after a successful Change OrderState update action.
OrderStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change OrderState update action.
OrderStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
OrderStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
OrderStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Store update action.
OrderStoreSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Store update action.
OrderStoreSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Produces the Custom Line Item State Transition Message.
OrderTransitionCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Line Item State Transition Message.
OrderTransitionLineItemStateActionBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.OrderTransitionStateActionBuilder
Example to create an instance using the builder pattern
OrderUpdate
Example to create an instance using the builder pattern
OrderUpdateAction
Example to create a subtype instance using the builder pattern
OrderUpdateActionBuilder
OrderUpdateBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.OrderUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
OrderUpdateSyncInfoAction
Example to create an instance using the builder pattern
OrderUpdateSyncInfoActionBuilder
Example to create an instance using the builder pattern
Returned when some of the Line Items are out of stock at the time of placing an Order.
OutOfStockErrorBuilder
Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
OverCapacityErrorBuilder
Example to create an instance using the builder pattern
Returned when a given Price validity period conflicts with an existing one.
OverlappingStandalonePriceValidityErrorBuilder
Example to create an instance using the builder pattern
Interface with common methods for query endpoints
PagedQueryResponse
Example to create an instance using the builder pattern
PagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagingTrait
Information regarding the appearance, content, and shipment of a Parcel.
Parcel
Example to create an instance using the builder pattern
Parcel
Example to create an instance using the builder pattern
Generated after a successful Add Parcel to Delivery update action.
ParcelAddedToDeliveryMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Parcel to Delivery update action.
ParcelAddedToDeliveryMessagePayloadBuilder
Example to create an instance using the builder pattern
ParcelBuilder
Example to create an instance using the builder pattern
ParcelBuilder
Example to create an instance using the builder pattern
ParcelBuilder
Example to create an instance using the builder pattern
ParcelChangeValue
Example to create an instance using the builder pattern
ParcelChangeValueBuilder
Example to create an instance using the builder pattern
ParcelDraft
Example to create an instance using the builder pattern
ParcelDraftBuilder
Example to create an instance using the builder pattern
ParcelItems
Example to create an instance using the builder pattern
ParcelItemsBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Items update action.
ParcelItemsUpdatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Items update action.
ParcelItemsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
ParcelMeasurementDraft
Example to create an instance using the builder pattern
ParcelMeasurementDraftBuilder
Example to create an instance using the builder pattern
ParcelMeasurements
Example to create an instance using the builder pattern
ParcelMeasurements
Example to create an instance using the builder pattern
ParcelMeasurements
Example to create an instance using the builder pattern
ParcelMeasurementsBuilder
Example to create an instance using the builder pattern
ParcelMeasurementsBuilder
Example to create an instance using the builder pattern
ParcelMeasurementsBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Measurements update action.
ParcelMeasurementsUpdatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Measurements update action.
ParcelMeasurementsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Parcel from Delivery update action.
ParcelRemovedFromDeliveryMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Parcel from Delivery update action.
ParcelRemovedFromDeliveryMessagePayloadBuilder
Example to create an instance using the builder pattern
ParcelTrackingData
Example to create an instance using the builder pattern
ParcelTrackingDataBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Tracking Data update action.
ParcelTrackingDataUpdatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Tracking Data update action.
ParcelTrackingDataUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
PayloadNotIncluded
Example to create an instance using the builder pattern
PayloadNotIncludedBuilder
Example to create an instance using the builder pattern
Payment
Example to create an instance using the builder pattern
Adding a Payment interaction generates the PaymentInteractionAdded Message.
PaymentAddInterfaceInteractionActionBuilder
Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
PaymentAddTransactionActionBuilder
Example to create an instance using the builder pattern
PaymentBuilder
Example to create an instance using the builder pattern
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
PaymentChangeAmountPlannedActionBuilder
Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdAction
Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdActionBuilder
Example to create an instance using the builder pattern
Changing the TransactionState generates the PaymentTransactionStateChanged Message.
PaymentChangeTransactionStateActionBuilder
Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampAction
Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
PaymentCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
PaymentCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
PaymentDraft
Example to create an instance using the builder pattern
PaymentDraftBuilder
Example to create an instance using the builder pattern
PaymentInfo
Example to create an instance using the builder pattern
PaymentInfo
Example to create an instance using the builder pattern
PaymentInfoBuilder
Example to create an instance using the builder pattern
PaymentInfoBuilder
Example to create an instance using the builder pattern
Generated after a successful Add InterfaceInteraction update action.
PaymentInteractionAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add InterfaceInteraction update action.
PaymentInteractionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
References a payment by key.
PaymentKeyReferenceBuilder
Example to create an instance using the builder pattern
PaymentLabel
Example to create an instance using the builder pattern
PaymentLabelBuilder
Example to create an instance using the builder pattern
PaymentMethodInfo
Example to create an instance using the builder pattern
PaymentMethodInfoBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Payment.PaymentPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a Payment.
PaymentReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of a Payment.
PaymentResourceIdentifierBuilder
Example to create an instance using the builder pattern
PaymentSetAnonymousIdAction
Example to create an instance using the builder pattern
PaymentSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomerAction
Example to create an instance using the builder pattern
PaymentSetCustomerActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomFieldAction
Example to create an instance using the builder pattern
PaymentSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomTypeAction
Example to create an instance using the builder pattern
PaymentSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
PaymentSetInterfaceIdAction
Example to create an instance using the builder pattern
PaymentSetInterfaceIdActionBuilder
Example to create an instance using the builder pattern
PaymentSetKeyAction
Example to create an instance using the builder pattern
PaymentSetKeyActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoNameAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoNameActionBuilder
Example to create an instance using the builder pattern
Produces the PaymentStatusInterfaceCodeSet Message.
PaymentSetStatusInterfaceCodeActionBuilder
Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextAction
Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextActionBuilder
Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldAction
Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldActionBuilder
Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeAction
Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeActionBuilder
Example to create an instance using the builder pattern
Indicates the payment status for the Order.
PaymentState
Maps to
Order.paymentState.possible values of PaymentState
possible values of PaymentState
possible values of PaymentState
PaymentStatus
Example to create an instance using the builder pattern
PaymentStatusBuilder
Example to create an instance using the builder pattern
PaymentStatusDraft
Example to create an instance using the builder pattern
PaymentStatusDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Set StatusInterfaceCode update action.
PaymentStatusInterfaceCodeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set StatusInterfaceCode update action.
PaymentStatusInterfaceCodeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
PaymentStatusStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
PaymentStatusStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Transaction update action.
PaymentTransactionAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Transaction update action.
PaymentTransactionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change TransactionState update action.
PaymentTransactionStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change TransactionState update action.
PaymentTransactionStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
If the Payment has no current State,
initial must be true for the new State.PaymentTransitionStateActionBuilder
Example to create an instance using the builder pattern
PaymentUpdate
Example to create an instance using the builder pattern
PaymentUpdateAction
Example to create a subtype instance using the builder pattern
PaymentUpdateActionBuilder
PaymentUpdateBuilder
Example to create an instance using the builder pattern
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
PendingOperationErrorBuilder
Example to create an instance using the builder pattern
Permissions grant granular access to Approval Rules, Approval Flows, Business Units, Carts, Orders, Quotes, and Quote Requests.
Permissions grant granular access to Business Units, Carts, Orders, Quotes, and Quote Requests.
possible values of Permission
possible values of Permission
The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.
PlatformFormatBuilder
Example to create an instance using the builder pattern
Updates that are triggered automatically as a result of a user-initiated change.
possible values of PlatformInitiatedChange
PolicyBuilder
Implementation for a failsafe requests handling
The representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode is
Embedded.Price
Example to create an instance using the builder pattern
PriceBuilder
Example to create an instance using the builder pattern
PriceBuilder
Example to create an instance using the builder pattern
Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
PriceChangedErrorBuilder
Example to create an instance using the builder pattern
The draft representation for prices to be embedded into ProductVariantDrafts when the ProductPriceMode is
Embedded.PriceDraftBuilder
Example to create an instance using the builder pattern
The representation of a Price Draft for the import purpose.
PriceDraftImportBuilder
Example to create an instance using the builder pattern
PriceFunction
Example to create an instance using the builder pattern
PriceFunctionBuilder
Example to create an instance using the builder pattern
The data representation for a price to be imported that is persisted as a Price in the Project.
PriceImportBuilder
Example to create an instance using the builder pattern
The request body to import Embedded Prices.
PriceImportRequestBuilder
Example to create an instance using the builder pattern
References a price by key.
PriceKeyReferenceBuilder
Example to create an instance using the builder pattern
PriceselectingTrait
A Price tier is selected instead of the default Price when a certain quantity of the ProductVariant is added to a Cart and ordered.
A price tier is selected instead of the default price when a certain quantity of the ProductVariant is added to a cart and ordered.
PriceTierBuilder
Example to create an instance using the builder pattern
PriceTierBuilder
Example to create an instance using the builder pattern
Specifies a Price tier that applies when the minimum quantity for the LineItem of a ProductVariant with the related Price is reached in a Cart.
PriceTierDraftBuilder
Example to create an instance using the builder pattern
Every Import Operation is assigned one of the following states.
possible values of ProcessingState
An abstract sellable good with a set of Attributes defined by a Product Type.
Either
variantId or sku is required.ProductAddAssetActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add to Category update action.
ProductAddedToCategoryMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add to Category update action.
ProductAddedToCategoryMessagePayloadBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductAddExternalImageActionBuilder
Example to create an instance using the builder pattern
Adds the given Price to the
prices array of the ProductVariant.ProductAddPriceActionBuilder
Example to create an instance using the builder pattern
Produces the ProductAddedToCategory Message.
ProductAddToCategoryActionBuilder
Example to create an instance using the builder pattern
ProductAddVariantAction
Example to create an instance using the builder pattern
ProductAddVariantActionBuilder
Example to create an instance using the builder pattern
Returned when a Product is not assigned to the Product Selection.
ProductAssignmentMissingErrorBuilder
Example to create an instance using the builder pattern
ProductBuilder
Example to create an instance using the builder pattern
Contains the
current and staged ProductData.ProductCatalogDataBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductChangeAssetNameActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductChangeAssetOrderActionBuilder
Example to create an instance using the builder pattern
Assigns the specified Product Variant to the
masterVariant and removes the same from variants at the same time.ProductChangeMasterVariantActionBuilder
Example to create an instance using the builder pattern
ProductChangeNameAction
Example to create an instance using the builder pattern
ProductChangeNameActionBuilder
Example to create an instance using the builder pattern
ProductChangePriceAction
Example to create an instance using the builder pattern
ProductChangePriceActionBuilder
Example to create an instance using the builder pattern
Produces the ProductSlugChanged Message.
ProductChangeSlugActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product request.
ProductCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product request.
ProductCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Contains all the data of a Product and its Product Variants.
ProductDataBuilder
Example to create an instance using the builder pattern
Interface to describe commonalities between differen product representations
Generated after a successful Delete Product request.
ProductDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product request.
ProductDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
ProductDiscount
Example to create an instance using the builder pattern
ProductDiscountBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeIsActiveAction
Example to create an instance using the builder pattern
ProductDiscountChangeIsActiveActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeNameAction
Example to create an instance using the builder pattern
ProductDiscountChangeNameActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangePredicateAction
Example to create an instance using the builder pattern
ProductDiscountChangePredicateActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderAction
Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeValueAction
Example to create an instance using the builder pattern
ProductDiscountChangeValueActionBuilder
Example to create an instance using the builder pattern
ProductDiscountDraft
Example to create an instance using the builder pattern
ProductDiscountDraftBuilder
Example to create an instance using the builder pattern
References a product discount by key.
ProductDiscountKeyReferenceBuilder
Example to create an instance using the builder pattern
ProductDiscountMatchQuery
Example to create an instance using the builder pattern
ProductDiscountMatchQueryBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductDiscount.
ProductDiscountPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a ProductDiscount.
ProductDiscountReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductDiscount.
ProductDiscountResourceIdentifierBuilder
Example to create an instance using the builder pattern
ProductDiscountSetDescriptionAction
Example to create an instance using the builder pattern
ProductDiscountSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetKeyAction
Example to create an instance using the builder pattern
ProductDiscountSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAction
Example to create an instance using the builder pattern
ProductDiscountSetValidFromActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilAction
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidUntilAction
Example to create an instance using the builder pattern
ProductDiscountSetValidUntilActionBuilder
Example to create an instance using the builder pattern
ProductDiscountUpdate
Example to create an instance using the builder pattern
ProductDiscountUpdateAction
Example to create a subtype instance using the builder pattern
ProductDiscountUpdateActionBuilder
ProductDiscountUpdateBuilder
Example to create an instance using the builder pattern
ProductDiscountValue
Example to create a subtype instance using the builder pattern
Discounts the Product's Price by a fixed amount, defined by the
money field.ProductDiscountValueAbsoluteBuilder
Example to create an instance using the builder pattern
Discounts the Product Price by a fixed amount, defined by the
money field.ProductDiscountValueAbsoluteDraftBuilder
Example to create an instance using the builder pattern
ProductDiscountValueBuilder
ProductDiscountValueDraft
Example to create a subtype instance using the builder pattern
ProductDiscountValueDraftBuilder
Discounts the Product Price by allowing the client to explicitly set a discounted value.
ProductDiscountValueExternalBuilder
Example to create an instance using the builder pattern
Discounts the Product Price by allowing the client to explicitly set a discounted value.
ProductDiscountValueExternalDraftBuilder
Example to create an instance using the builder pattern
Discounts the product price by a percentage, defined by the
permyriad field.ProductDiscountValueRelativeBuilder
Example to create an instance using the builder pattern
Discounts the Product Price by a percentage, defined by the
permyriad field.ProductDiscountValueRelativeDraftBuilder
Example to create an instance using the builder pattern
ProductDraft
Example to create an instance using the builder pattern
ProductDraftBuilder
Example to create an instance using the builder pattern
The representation of a Product Draft for the import purpose.
ProductDraftImportBuilder
Example to create an instance using the builder pattern
The request body to import ProductDrafts.
ProductDraftImportRequestBuilder
Example to create an instance using the builder pattern
Generated after a successful Add External Image update action or after the successful upload of an image.
ProductImageAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add External Image update action or after the successful upload of an image.
ProductImageAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
The data representation for a Product to be imported that is persisted as a Product in the Project.
ProductImportBuilder
Example to create an instance using the builder pattern
The request body to import Products.
ProductImportRequestBuilder
Example to create an instance using the builder pattern
References a product by key.
ProductKeyReferenceBuilder
Example to create an instance using the builder pattern
ProductLabel
Example to create an instance using the builder pattern
ProductLabelBuilder
Example to create an instance using the builder pattern
ProductLegacySetSkuAction
Example to create an instance using the builder pattern
ProductLegacySetSkuActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductMoveImageToPositionActionBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Product.ProductPagedQueryResponseBuilder
Example to create an instance using the builder pattern
ProductPagedSearchResponse
Example to create an instance using the builder pattern
ProductPagedSearchResponseBuilder
Example to create an instance using the builder pattern
Returned when a Product is already assigned to a Product Selection, but the Product Selection has either a different Product Variant Selection or a different Product Variant Exclusion.
ProductPresentWithDifferentVariantSelectionErrorBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price update action.
ProductPriceAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price update action.
ProductPriceAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Price update action.
ProductPriceChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Price update action.
ProductPriceChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a Price is updated due to a Product Discount.
ProductPriceDiscountsSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a Price is updated due to a Product Discount.
ProductPriceDiscountsSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Details about a Embedded Price that was updated due to a Discount.
ProductPriceDiscountsSetUpdatedPriceBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
ProductPriceExternalDiscountSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
ProductPriceExternalDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Key update action.
ProductPriceKeySetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Key update action.
ProductPriceKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
This mode determines the type of Prices used for Product Price Selection and for LineItem Price selection.
ProductPriceModeEnum
possible values of ProductPriceModeEnum
possible values of ProductPriceModeEnum
Generated after a successful Set PriceMode update action.
ProductPriceModeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set PriceMode update action.
ProductPriceModeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price update action.
ProductPriceRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price update action.
ProductPriceRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Prices update action.
ProductPricesSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Prices update action.
ProductPricesSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ProductProjection
Example to create an instance using the builder pattern
ProductProjectionBuilder
Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponse
Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponse
Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponseBuilder
Example to create an instance using the builder pattern
Publishes product data from the Product's staged projection to its current projection.
ProductPublishActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Publish update action.
ProductPublishedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Publish update action.
ProductPublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
The scope controls which part of the product information is published.
possible values of ProductPublishScope
Reference to a Product.
ProductReferenceBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductRemoveAssetActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove from Category update action.
ProductRemovedFromCategoryMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove from Category update action.
ProductRemovedFromCategoryMessagePayloadBuilder
Example to create an instance using the builder pattern
Produces the ProductRemovedFromCategory Message.
ProductRemoveFromCategoryActionBuilder
Example to create an instance using the builder pattern
Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted).
ProductRemoveImageActionBuilder
Example to create an instance using the builder pattern
ProductRemovePriceAction
Example to create an instance using the builder pattern
ProductRemovePriceActionBuilder
Example to create an instance using the builder pattern
Either
id or sku is required.ProductRemoveVariantActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Product.
ProductResourceIdentifierBuilder
Example to create an instance using the builder pattern
Generated after a successful Revert Staged Changes update action.
ProductRevertedStagedChangesMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Revert Staged Changes update action.
ProductRevertedStagedChangesMessagePayloadBuilder
Example to create an instance using the builder pattern
Reverts the staged version of a Product to the current version.
ProductRevertStagedChangesActionBuilder
Example to create an instance using the builder pattern
Reverts the staged version of a ProductVariant to the current version.
ProductRevertStagedVariantChangesActionBuilder
Example to create an instance using the builder pattern
ProductSearchErrorResponse
Example to create an instance using the builder pattern
ProductSearchErrorResponseBuilder
Example to create an instance using the builder pattern
ProductSearchFacetCountExpression
Example to create an instance using the builder pattern
ProductSearchFacetCountExpressionBuilder
Example to create an instance using the builder pattern
ProductSearchFacetCountLevelEnum
possible values of ProductSearchFacetCountLevelEnum
ProductSearchFacetCountValue
Example to create an instance using the builder pattern
ProductSearchFacetCountValueBuilder
Example to create an instance using the builder pattern
ProductSearchFacetDistinctBucketSortBy
possible values of ProductSearchFacetDistinctBucketSortBy
ProductSearchFacetDistinctBucketSortExpression
Example to create an instance using the builder pattern
ProductSearchFacetDistinctBucketSortExpressionBuilder
Example to create an instance using the builder pattern
ProductSearchFacetDistinctExpression
Example to create an instance using the builder pattern
ProductSearchFacetDistinctExpressionBuilder
Example to create an instance using the builder pattern
ProductSearchFacetDistinctValue
Example to create an instance using the builder pattern
ProductSearchFacetDistinctValueBuilder
Example to create an instance using the builder pattern
ProductSearchFacetExpression
Example to create an instance using the builder pattern
ProductSearchFacetExpressionBuilder
Example to create an instance using the builder pattern
ProductSearchFacetRangesExpression
Example to create an instance using the builder pattern
ProductSearchFacetRangesExpressionBuilder
Example to create an instance using the builder pattern
Values for
from and to must be a number or DateTime.ProductSearchFacetRangesFacetRangeBuilder
Example to create an instance using the builder pattern
ProductSearchFacetRangesValue
Example to create an instance using the builder pattern
ProductSearchFacetRangesValueBuilder
Example to create an instance using the builder pattern
ProductSearchFacetResult
Example to create an instance using the builder pattern
Result of a distinct facet or a ranges facet.
ProductSearchFacetResultBucketBuilder
Example to create an instance using the builder pattern
ProductSearchFacetResultBucketEntry
Example to create an instance using the builder pattern
ProductSearchFacetResultBucketEntryBuilder
Example to create an instance using the builder pattern
ProductSearchFacetResultBuilder
Example to create an instance using the builder pattern
Result of a count facet.
ProductSearchFacetResultCountBuilder
Example to create an instance using the builder pattern
ProductSearchFacetScope
possible values of ProductSearchFacetScope
ProductSearchFacetScopeEnum
possible values of ProductSearchFacetScopeEnum
ProductSearchIndexingMode
possible values of ProductSearchIndexingMode
ProductSearchMatchingVariantEntry
Example to create an instance using the builder pattern
ProductSearchMatchingVariantEntryBuilder
Example to create an instance using the builder pattern
ProductSearchMatchingVariants
Example to create an instance using the builder pattern
ProductSearchMatchingVariantsBuilder
Example to create an instance using the builder pattern
ProductSearchProjectionParams
Example to create an instance using the builder pattern
ProductSearchProjectionParamsBuilder
Example to create an instance using the builder pattern
ProductSearchRequest
Example to create an instance using the builder pattern
ProductSearchRequestBuilder
Example to create an instance using the builder pattern
ProductSearchResult
Example to create an instance using the builder pattern
ProductSearchResultBuilder
Example to create an instance using the builder pattern
Specifies the status of the Product Search index.
possible values of ProductSearchStatus
ProductSelection
Example to create an instance using the builder pattern
Adds a Product to the Product Selection.
ProductSelectionAddProductActionBuilder
Example to create an instance using the builder pattern
Given the mode of Product Selection, this assignment refers to, it may contain:
ProductSelectionAssignmentBuilder
Example to create an instance using the builder pattern
ProductSelectionBuilder
Example to create an instance using the builder pattern
ProductSelectionChangeNameAction
Example to create an instance using the builder pattern
ProductSelectionChangeNameActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product Selection request.
ProductSelectionCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product Selection request.
ProductSelectionCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product Selection request.
ProductSelectionDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product Selection request.
ProductSelectionDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
ProductSelectionDraft
Example to create an instance using the builder pattern
ProductSelectionDraftBuilder
Example to create an instance using the builder pattern
Excludes a Product from a Product Selection with
IndividualExclusion ProductSelectionMode.ProductSelectionExcludeProductActionBuilder
Example to create an instance using the builder pattern
Product Selections can have the following modes:
possible values of ProductSelectionMode
PagedQueryResult containing an array of ProductSelection.
ProductSelectionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Product update action.
ProductSelectionProductAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Product update action.
ProductSelectionProductAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Exclude Product update action.
ProductSelectionProductExcludedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Exclude Product update action.
ProductSelectionProductExcludedMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductReference.
ProductSelectionProductPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Product update action.
ProductSelectionProductRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Product update action.
ProductSelectionProductRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a ProductSelection.
ProductSelectionReferenceBuilder
Example to create an instance using the builder pattern
ProductSelectionRemoveProductAction
Example to create an instance using the builder pattern
ProductSelectionRemoveProductActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductSelection.
ProductSelectionResourceIdentifierBuilder
Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldAction
Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeAction
Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetKeyAction
Example to create an instance using the builder pattern
ProductSelectionSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetting
Example to create an instance using the builder pattern
ProductSelectionSetting
Example to create an instance using the builder pattern
ProductSelectionSettingBuilder
Example to create an instance using the builder pattern
ProductSelectionSettingBuilder
Example to create an instance using the builder pattern
ProductSelectionSettingDraft
Example to create an instance using the builder pattern
ProductSelectionSettingDraftBuilder
Example to create an instance using the builder pattern
Updates the Product Variant Exclusion of an existing Product Selection Assignment.
ProductSelectionSetVariantExclusionActionBuilder
Example to create an instance using the builder pattern
Updates the Product Variant Selection of an existing Product Selection Assignment.
ProductSelectionSetVariantSelectionActionBuilder
Example to create an instance using the builder pattern
ProductSelectionUpdate
Example to create an instance using the builder pattern
ProductSelectionUpdateAction
Example to create a subtype instance using the builder pattern
ProductSelectionUpdateActionBuilder
ProductSelectionUpdateBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Variant Exclusion update action.
ProductSelectionVariantExclusionChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Variant Exclusion update action.
ProductSelectionVariantExclusionChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Variant Selection update action.
ProductSelectionVariantSelectionChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Variant Selection update action.
ProductSelectionVariantSelectionChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetDescriptionActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetKeyActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetSourcesActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAssetTagsActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetAttributeActionBuilder
Example to create an instance using the builder pattern
Adds, removes, or changes a Product Attribute in all Product Variants at the same time.
ProductSetAttributeInAllVariantsActionBuilder
Example to create an instance using the builder pattern
ProductSetCategoryOrderHintAction
Example to create an instance using the builder pattern
ProductSetCategoryOrderHintActionBuilder
Example to create an instance using the builder pattern
ProductSetDescriptionAction
Example to create an instance using the builder pattern
ProductSetDescriptionActionBuilder
Example to create an instance using the builder pattern
Produces the ProductPriceExternalDiscountSet Message.
ProductSetDiscountedPriceActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetImageLabelActionBuilder
Example to create an instance using the builder pattern
ProductSetKeyAction
Example to create an instance using the builder pattern
ProductSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaDescriptionAction
Example to create an instance using the builder pattern
ProductSetMetaDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaKeywordsAction
Example to create an instance using the builder pattern
ProductSetMetaKeywordsActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaTitleAction
Example to create an instance using the builder pattern
ProductSetMetaTitleActionBuilder
Example to create an instance using the builder pattern
Sets the key of an Embedded Price.
ProductSetPriceKeyActionBuilder
Example to create an instance using the builder pattern
Controls whether the Prices of a Product Variant are embedded into the Product or standalone.
ProductSetPriceModeActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetPricesActionBuilder
Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldAction
Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldActionBuilder
Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeAction
Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetProductVariantKeyActionBuilder
Example to create an instance using the builder pattern
ProductSetSearchKeywordsAction
Example to create an instance using the builder pattern
ProductSetSearchKeywordsActionBuilder
Example to create an instance using the builder pattern
SKU cannot be changed or removed if it is associated with an InventoryEntry.
ProductSetSkuActionBuilder
Example to create an instance using the builder pattern
Cannot be staged.
ProductSetTaxCategoryActionBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of ProductSelectionAssignment.
ProductsInStorePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
ProductSlugChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
ProductSlugChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
ProductStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
ProductStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
A single ProductTailoring representation contains the current and the staged representation of its product data tailored per Store.
ProductTailoringBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product Tailoring or Create Product Tailoring in Store request.
ProductTailoringCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product Tailoring or Create Product Tailoring in Store request.
ProductTailoringCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Contains all the tailored data of a Product.
ProductTailoringDataBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product Tailoring or Delete ProductTailoring assigned to Product in Store request.
ProductTailoringDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product Tailoring or Delete ProductTailoring assigned to Product in Store request.
ProductTailoringDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Description update action.
ProductTailoringDescriptionSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Description update action.
ProductTailoringDescriptionSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Contains all the tailored data of a Product.
ProductTailoringDraftBuilder
Example to create an instance using the builder pattern
Contains all the tailored data of a Product for a specific Store.
ProductTailoringInStoreDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Name update action.
ProductTailoringNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Name update action.
ProductTailoringNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductTailoring.
ProductTailoringPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Publishes the
staged data of the ProductTailoring to current.ProductTailoringPublishActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Publish update action.
ProductTailoringPublishedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Publish update action.
ProductTailoringPublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
Reference to a ProductTailoring.
ProductTailoringReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductTailoring.
ProductTailoringResourceIdentifierBuilder
Example to create an instance using the builder pattern
Generates the ProductTailoringDescriptionSet Message.
ProductTailoringSetDescriptionActionBuilder
Example to create an instance using the builder pattern
Updates all meta attributes at the same time.
ProductTailoringSetMetaAttributesActionBuilder
Example to create an instance using the builder pattern
ProductTailoringSetMetaDescriptionAction
Example to create an instance using the builder pattern
ProductTailoringSetMetaDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductTailoringSetMetaKeywordsAction
Example to create an instance using the builder pattern
ProductTailoringSetMetaKeywordsActionBuilder
Example to create an instance using the builder pattern
ProductTailoringSetMetaTitleAction
Example to create an instance using the builder pattern
ProductTailoringSetMetaTitleActionBuilder
Example to create an instance using the builder pattern
Generates the ProductTailoringNameSet Message.
ProductTailoringSetNameActionBuilder
Example to create an instance using the builder pattern
Generates the ProductTailoringSlugSet Message.
ProductTailoringSetSlugActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Slug update action.
ProductTailoringSlugSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Set Slug update action.
ProductTailoringSlugSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Unpublishes the
current data of the ProductTailoring.ProductTailoringUnpublishActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Unpublish update action.
ProductTailoringUnpublishedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Product Tailoring Unpublish update action.
ProductTailoringUnpublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
ProductTailoringUpdate
Example to create an instance using the builder pattern
ProductTailoringUpdateAction
Example to create a subtype instance using the builder pattern
ProductTailoringUpdateActionBuilder
ProductTailoringUpdateBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.ProductTransitionStateActionBuilder
Example to create an instance using the builder pattern
ProductType
Example to create an instance using the builder pattern
ProductTypeAddAttributeDefinitionAction
Example to create an instance using the builder pattern
ProductTypeAddAttributeDefinitionActionBuilder
Example to create an instance using the builder pattern
Adds a localizable enum to the values of AttributeLocalizedEnumType.
ProductTypeAddLocalizedEnumValueActionBuilder
Example to create an instance using the builder pattern
Adds an enum to the values of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
ProductTypeAddPlainEnumValueActionBuilder
Example to create an instance using the builder pattern
ProductTypeBuilder
Example to create an instance using the builder pattern
Updates the
attributeConstraint of an AttributeDefinition.ProductTypeChangeAttributeConstraintActionBuilder
Example to create an instance using the builder pattern
Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType.
ProductTypeChangeAttributeNameActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameAction
Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeDescriptionAction
Example to create an instance using the builder pattern
ProductTypeChangeDescriptionActionBuilder
Example to create an instance using the builder pattern
Updates the key of a single enum
value in an AttributeEnumType AttributeDefinition, AttributeLocalizedEnumType AttributeDefinition, AttributeSetType of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.ProductTypeChangeEnumKeyActionBuilder
Example to create an instance using the builder pattern
Updates the
inputHint of an AttributeDefinition.ProductTypeChangeInputHintActionBuilder
Example to create an instance using the builder pattern
Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint.
ProductTypeChangeIsSearchableActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeLabelAction
Example to create an instance using the builder pattern
ProductTypeChangeLabelActionBuilder
Example to create an instance using the builder pattern
Updates the label of a single enum
value in an AttributeLocalizedEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.ProductTypeChangeLocalizedEnumValueLabelActionBuilder
Example to create an instance using the builder pattern
Updates the order of localized enum
values in an AttributeLocalizedEnumType AttributeDefinition.ProductTypeChangeLocalizedEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeNameAction
Example to create an instance using the builder pattern
ProductTypeChangeNameActionBuilder
Example to create an instance using the builder pattern
Updates the label of a single enum
value in an AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.ProductTypeChangePlainEnumValueLabelActionBuilder
Example to create an instance using the builder pattern
Updates the order of enum
values in an AttributeEnumType AttributeDefinition.ProductTypeChangePlainEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
ProductTypeDraft
Example to create an instance using the builder pattern
ProductTypeDraftBuilder
Example to create an instance using the builder pattern
The data representation for a ProductType to be imported that is persisted as a ProductType in the Project.
ProductTypeImportBuilder
Example to create an instance using the builder pattern
The request body to import ProductTypes.
ProductTypeImportRequestBuilder
Example to create an instance using the builder pattern
References a product type by key.
ProductTypeKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductType.
ProductTypePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a ProductType.
ProductTypeReferenceBuilder
Example to create an instance using the builder pattern
Removes an AttributeDefinition and also deletes all corresponding Attributes on all Products with this ProductType.
ProductTypeRemoveAttributeDefinitionActionBuilder
Example to create an instance using the builder pattern
Removes enum values from an AttributeDefinition of AttributeEnumType, AttributeLocalizedEnumType, AttributeSetType of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.
ProductTypeRemoveEnumValuesActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductType.
ProductTypeResourceIdentifierBuilder
Example to create an instance using the builder pattern
ProductTypeSetInputTipAction
Example to create an instance using the builder pattern
ProductTypeSetInputTipActionBuilder
Example to create an instance using the builder pattern
ProductTypeSetKeyAction
Example to create an instance using the builder pattern
ProductTypeSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductTypeUpdate
Example to create an instance using the builder pattern
ProductTypeUpdateAction
Example to create a subtype instance using the builder pattern
ProductTypeUpdateActionBuilder
ProductTypeUpdateBuilder
Example to create an instance using the builder pattern
Removes the current projection of the Product.
ProductUnpublishActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Unpublish Product update action.
ProductUnpublishedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Unpublish Product update action.
ProductUnpublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
ProductUpdate
Example to create an instance using the builder pattern
ProductUpdateAction
Example to create a subtype instance using the builder pattern
ProductUpdateActionBuilder
ProductUpdateBuilder
Example to create an instance using the builder pattern
A concrete sellable good for which inventory can be tracked.
Generated after a successful Add ProductVariant update action.
ProductVariantAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add ProductVariant update action.
ProductVariantAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
The InventoryEntry information of the Product Variant.
ProductVariantAvailability
Example to create an instance using the builder pattern
ProductVariantAvailabilityBuilder
Example to create an instance using the builder pattern
ProductVariantAvailabilityBuilder
Example to create an instance using the builder pattern
ProductVariantBuilder
Example to create an instance using the builder pattern
ProductVariantChannelAvailability
Example to create an instance using the builder pattern
ProductVariantChannelAvailability
Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityBuilder
Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityBuilder
Example to create an instance using the builder pattern
JSON object where the key is a supply Channel
id and the value is the ProductVariantChannelAvailability of the InventoryEntry.ProductVariantChannelAvailabilityMap
Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityMapBuilder
Example to create an instance using the builder pattern
ProductVariantChannelAvailabilityMapBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove ProductVariant update action.
ProductVariantDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove ProductVariant update action.
ProductVariantDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Creates a Product Variant when included in the
masterVariant and variants fields of the ProductDraft.ProductVariantDraftBuilder
Example to create an instance using the builder pattern
The representation of a Product Variant Draft for the import purpose.
ProductVariantDraftImportBuilder
Example to create an instance using the builder pattern
Only Product Variants with the explicitly listed SKUs are part of a Product Selection with
IndividualExclusion ProductSelectionMode.ProductVariantExclusionBuilder
Example to create an instance using the builder pattern
The data representation for a ProductVariant to be imported that is persisted as a ProductVariant in the Project.
ProductVariantImportBuilder
Example to create an instance using the builder pattern
Contains the Product Variant to be used in the LineItemImportDraft.
ProductVariantImportDraftBuilder
Example to create an instance using the builder pattern
The request body to import ProductVariants.
ProductVariantImportRequestBuilder
Example to create an instance using the builder pattern
References a product variant by key.
ProductVariantKeyReferenceBuilder
Example to create an instance using the builder pattern
Representation for an update of a ProductVariant.
ProductVariantPatchBuilder
Example to create an instance using the builder pattern
The request body to import ProductVariantPatches.
ProductVariantPatchRequestBuilder
Example to create an instance using the builder pattern
Polymorphic base type for Product Variant Selections.
ProductVariantSelection
Example to create an instance using the builder pattern
ProductVariantSelectionBuilder
ProductVariantSelectionBuilder
Example to create an instance using the builder pattern
All Product Variants except the explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeAllExceptBuilder
Example to create an instance using the builder pattern
Only Product Variants with explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeOnlyBuilder
Example to create an instance using the builder pattern
ProductVariantSelectionTypeEnum
ProductVariantSelectionTypeEnum
possible values of ProductVariantSelectionTypeEnum
possible values of ProductVariantSelectionTypeEnum
Project
Example to create an instance using the builder pattern
Project scoped API root
ProjectBuilder
Example to create an instance using the builder pattern
ProjectChangeBusinessUnitStatusOnCreationAction
Example to create an instance using the builder pattern
ProjectChangeBusinessUnitStatusOnCreationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCountriesAction
Example to create an instance using the builder pattern
ProjectChangeCountriesActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledAction
Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCurrenciesAction
Example to create an instance using the builder pattern
ProjectChangeCurrenciesActionBuilder
Example to create an instance using the builder pattern
Removing a language used by a Store returns a LanguageUsedInStores error.
ProjectChangeLanguagesActionBuilder
Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeNameAction
Example to create an instance using the builder pattern
ProjectChangeNameActionBuilder
Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusAction
Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusActionBuilder
Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledAction
Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledActionBuilder
Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectionselectingTrait
Returned when the languages set for a Store are not supported by the Project.
ProjectNotConfiguredForLanguagesErrorBuilder
Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationAction
Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationActionBuilder
Example to create an instance using the builder pattern
ProjectSetExternalOAuthAction
Example to create an instance using the builder pattern
ProjectSetExternalOAuthActionBuilder
Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeAction
Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeActionBuilder
Example to create an instance using the builder pattern
ProjectUpdate
Example to create an instance using the builder pattern
ProjectUpdateAction
Example to create a subtype instance using the builder pattern
ProjectUpdateActionBuilder
ProjectUpdateBuilder
Example to create an instance using the builder pattern
Change triggered by the Publish update action.
PublishChangeBuilder
Example to create an instance using the builder pattern
QueryComplexityLimitExceededError
Example to create an instance using the builder pattern
QueryComplexityLimitExceededErrorBuilder
Example to create an instance using the builder pattern
QueryPrice
Example to create an instance using the builder pattern
QueryPriceBuilder
Example to create an instance using the builder pattern
Returned when the query times out.
QueryTimedOutErrorBuilder
Example to create an instance using the builder pattern
QueryTrait
Deprecated.
use
PolicyMiddleware insteadDeprecated.
use
PolicyMiddleware insteadQuote
Example to create an instance using the builder pattern
QuoteBuilder
Example to create an instance using the builder pattern
Changes the owner of a Quote to a different Customer.
QuoteChangeCustomerActionBuilder
Example to create an instance using the builder pattern
QuoteChangeQuoteStateAction
Example to create an instance using the builder pattern
QuoteChangeQuoteStateActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
QuoteCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
QuoteCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
QuoteCustomerChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
QuoteCustomerChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
QuoteDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
QuoteDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
QuoteDraft
Example to create an instance using the builder pattern
QuoteDraftBuilder
Example to create an instance using the builder pattern
QuoteLabel
Example to create an instance using the builder pattern
QuoteLabelBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Quote.
QuotePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a Quote.
QuoteReferenceBuilder
Example to create an instance using the builder pattern
Generated after a successful Request Quote Renegotiation update action.
QuoteRenegotiationRequestedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Request Quote Renegotiation update action.
QuoteRenegotiationRequestedMessagePayloadBuilder
Example to create an instance using the builder pattern
QuoteRequest
Example to create an instance using the builder pattern
QuoteRequestBuilder
Example to create an instance using the builder pattern
Changes the owner of a Quote Request to a different Customer.
QuoteRequestChangeCustomerActionBuilder
Example to create an instance using the builder pattern
Transitions the Quote Request to a different state.
QuoteRequestChangeQuoteRequestStateActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create QuoteRequest request.
QuoteRequestCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create QuoteRequest request.
QuoteRequestCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
QuoteRequestCustomerChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
QuoteRequestCustomerChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete QuoteRequest request.
QuoteRequestDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete QuoteRequest request.
QuoteRequestDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
QuoteRequestDraft
Example to create an instance using the builder pattern
QuoteRequestDraftBuilder
Example to create an instance using the builder pattern
QuoteRequestLabel
Example to create an instance using the builder pattern
QuoteRequestLabelBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of QuoteRequest.
QuoteRequestPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Represents the Buyer requesting renegotiation for a Quote.
QuoteRequestQuoteRenegotiationActionBuilder
Example to create an instance using the builder pattern
Reference to a QuoteRequest.
QuoteRequestReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a QuoteRequest.
QuoteRequestResourceIdentifierBuilder
Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldAction
Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeAction
Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Predefined states tracking the status of the Quote Request in the negotiation process.
QuoteRequestState
possible values of QuoteRequestState
possible values of QuoteRequestState
Generated after a successful Change Quote Request State update action.
QuoteRequestStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Quote Request State update action.
QuoteRequestStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
QuoteRequestStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
QuoteRequestStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.QuoteRequestTransitionStateActionBuilder
Example to create an instance using the builder pattern
QuoteRequestUpdate
Example to create an instance using the builder pattern
QuoteRequestUpdateAction
Example to create a subtype instance using the builder pattern
QuoteRequestUpdateActionBuilder
QuoteRequestUpdateBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Quote.
QuoteResourceIdentifierBuilder
Example to create an instance using the builder pattern
QuoteSetCustomFieldAction
Example to create an instance using the builder pattern
QuoteSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
QuoteSetCustomTypeAction
Example to create an instance using the builder pattern
QuoteSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Predefined states tracking the status of the Quote.
QuoteState
possible values of QuoteState
possible values of QuoteState
Generated after a successful Change Quote State update action.
QuoteStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Quote State update action.
QuoteStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
QuoteStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
QuoteStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.QuoteTransitionStateActionBuilder
Example to create an instance using the builder pattern
QuoteUpdate
Example to create an instance using the builder pattern
QuoteUpdateAction
Example to create a subtype instance using the builder pattern
QuoteUpdateActionBuilder
QuoteUpdateBuilder
Example to create an instance using the builder pattern
RangeFacetResult
Example to create an instance using the builder pattern
RangeFacetResultBuilder
Example to create an instance using the builder pattern
Captures the differences between the previous and next version of a resource.
RecordBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Record.RecordPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Interface of a resource with an ID and version
A Reference represents a loose reference to another resource in the same Project identified by its
id.Reference
Example to create an instance using the builder pattern
This type represents an attribute whose value is a key reference.
ReferenceAttributeBuilder
Example to create an instance using the builder pattern
ReferenceBuilder
ReferenceBuilder
Example to create an instance using the builder pattern
Returned when a resource referenced by a Reference or a ResourceIdentifier could not be found.
ReferencedResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a resource cannot be deleted because it is being referenced by another resource.
ReferenceExistsErrorBuilder
Example to create an instance using the builder pattern
A field with a reference value.
ReferenceFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of references.
ReferenceSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a reference set value.
ReferenceSetFieldBuilder
Example to create an instance using the builder pattern
The type of the referenced resource.
possible values of ReferenceType
Type of resource the value should reference.
ReferenceTypeId
possible values of ReferenceTypeId
possible values of ReferenceTypeId
Change triggered by the Remove Address update action.
RemoveAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
RemoveAssetChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Associate update action.
RemoveAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove AttributeDefinition update action.
RemoveAttributeDefinitionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Billing Address ID update action.
RemoveBillingAddressIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Roles update action.
RemoveChannelRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove CustomLineItem update action.
RemoveCustomLineItemChangeBuilder
Example to create an instance using the builder pattern
RemoveDeliveryDraft
Example to create an instance using the builder pattern
RemoveDeliveryDraftBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Delivery update action.
RemoveDeliveryItemsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove DiscountCode update action.
RemoveDiscountCodeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove EnumValues from AttributeDefinition update action.
RemoveEnumValuesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove FieldDefinition update action.
RemoveFieldDefinitionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove from Category update action.
RemoveFromCategoryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Image update action.
RemoveImageChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Associate update action on a parent of a Business Unit in cases where inheritance applies.
RemoveInheritedAssociateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Item Shipping Address update action.
RemoveItemShippingAddressesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove EnumValues from AttributeDefinition update action.
RemoveLocalizedEnumValuesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Location update action.
RemoveLocationChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Parcel From Delivery update action.
RemoveOrderLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
RemoveParcelFromDeliveryChangeBuilder
Example to create an instance using the builder pattern
RemoveParcelFromDeliveryDraft
Example to create an instance using the builder pattern
RemoveParcelFromDeliveryDraftBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
RemovePaymentChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Embedded Price update action.
RemovePriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Product update action.
RemoveProductChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Product Selection update action.
RemoveProductSelectionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when an existing property is removed.
RemovePropertyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove Shipping Address ID update action.
RemoveShippingAddressIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove ShoppingListLineItem update action.
RemoveShoppingListLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove State roles update action.
RemoveStateRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove TaxRate update action.
RemoveTaxRateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove TextLineItem update action.
RemoveTextLineItemChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Remove ProductVariant update action.
RemoveVariantChangeBuilder
Example to create an instance using the builder pattern
Used for replicating an existing Cart or Order.
ReplicaCartDraftBuilder
Example to create an instance using the builder pattern
Deprecated.
ReplicaMyCartDraft
Example to create an instance using the builder pattern
ReplicaMyCartDraftBuilder
Example to create an instance using the builder pattern
Change triggered by the Request Quote Renegotiation update action.
RequestQuoteRenegotiationChangeBuilder
Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
A required field is missing a value.
RequiredFieldErrorBuilder
Example to create an instance using the builder pattern
RequiredFieldErrorBuilder
Example to create an instance using the builder pattern
Reservation
Example to create an instance using the builder pattern
ReservationBuilder
Example to create an instance using the builder pattern
Deprecated.
use
ResourceCreatedDeliveryPayload insteadDeprecated.
use
ResourceCreatedDeliveryPayloadBuilder insteadThis payload is sent for a ChangeSubscription when a resource is created.
ResourceCreatedDeliveryPayloadBuilder
Example to create an instance using the builder pattern
ResourceCreationError
Example to create an instance using the builder pattern
ResourceCreationErrorBuilder
Example to create an instance using the builder pattern
Deprecated.
use
ResourceDeletedDeliveryPayload insteadDeprecated.
use
ResourceDeletedDeliveryPayloadBuilder insteadThis payload is sent for a ChangeSubscription when a resource is deleted.
ResourceDeletedDeliveryPayloadBuilder
Example to create an instance using the builder pattern
ResourceDeletionError
Example to create an instance using the builder pattern
ResourceDeletionErrorBuilder
Example to create an instance using the builder pattern
Interface of a resource with an ID and version
Draft type to create a Reference or a KeyReference to a resource.
ResourceIdentifier
Example to create an instance using the builder pattern
ResourceIdentifierBuilder
ResourceIdentifierBuilder
Example to create an instance using the builder pattern
Returned when the resource addressed by the request URL does not exist.
ResourceNotFoundError
Example to create an instance using the builder pattern
ResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
ResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
ResourceSizeLimitExceededErrorBuilder
Example to create an instance using the builder pattern
IDs indicating the customizable resources and data types.
IDs indicating the customizable resources and data types.
possible values of ResourceTypeId
possible values of ResourceTypeId
ResourceUpdate<U extends ResourceUpdate<U,T,UBuilder>,T extends ResourceUpdateAction<T>,UBuilder extends Builder<U>>
Deprecated.
use
ResourceUpdatedDeliveryPayload insteadDeprecated.
use
ResourceUpdatedDeliveryPayloadBuilder insteadThis payload is sent for a ChangeSubscription when a resource is updated.
ResourceUpdatedDeliveryPayloadBuilder
Example to create an instance using the builder pattern
ResourceUpdateError
Example to create an instance using the builder pattern
ResourceUpdateErrorBuilder
Example to create an instance using the builder pattern
Interface to deserialize a response to a specified output type
Handler functions to retry single requests.
Deprecated.
use
PolicyMiddleware insteadDeprecated.
use
PolicyMiddleware insteadStores information about returns connected to an Order.
ReturnInfo
Example to create an instance using the builder pattern
ReturnInfo
Example to create an instance using the builder pattern
Generated after a successful Add ReturnInfo update action.
ReturnInfoAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add ReturnInfo update action.
ReturnInfoAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
ReturnInfoBuilder
Example to create an instance using the builder pattern
ReturnInfoBuilder
Example to create an instance using the builder pattern
ReturnInfoBuilder
Example to create an instance using the builder pattern
ReturnInfoDraft
Example to create an instance using the builder pattern
ReturnInfoDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnInfo update action on Orders and Order Edits.
ReturnInfoSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnInfo update action on Orders and Order Edits.
ReturnInfoSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ReturnItem
Example to create a subtype instance using the builder pattern
ReturnItem
Example to create an instance using the builder pattern
ReturnItemBuilder
ReturnItemBuilder
Example to create an instance using the builder pattern
ReturnItemDraft
Example to create an instance using the builder pattern
ReturnItemDraft
Example to create an instance using the builder pattern
ReturnItemDraftBuilder
Example to create an instance using the builder pattern
ReturnItemDraftBuilder
Example to create an instance using the builder pattern
ReturnPaymentState
ReturnPaymentState
possible values of ReturnPaymentState
possible values of ReturnPaymentState
ReturnShipmentState
ReturnShipmentState
Maps to
ReturnItem.shipmentStatepossible values of ReturnShipmentState
possible values of ReturnShipmentState
possible values of ReturnShipmentState
Review
Example to create an instance using the builder pattern
ReviewBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Review request.
ReviewCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Review request.
ReviewCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
When creating a new Review, at least one of
title, text or rating should be set.ReviewDraftBuilder
Example to create an instance using the builder pattern
ReviewLabel
Example to create an instance using the builder pattern
ReviewLabelBuilder
Example to create an instance using the builder pattern
Deprecated.
ReviewPagedQueryResponse
Example to create an instance using the builder pattern
ReviewPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Rating update action.
ReviewRatingSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Rating update action.
ReviewRatingSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ReviewRatingStatistics
Example to create an instance using the builder pattern
ReviewRatingStatistics
Example to create an instance using the builder pattern
ReviewRatingStatisticsBuilder
Example to create an instance using the builder pattern
ReviewRatingStatisticsBuilder
Example to create an instance using the builder pattern
Reference to a Review.
ReviewReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Review.
ReviewResourceIdentifierBuilder
Example to create an instance using the builder pattern
ReviewSetAuthorNameAction
Example to create an instance using the builder pattern
ReviewSetAuthorNameActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomerAction
Example to create an instance using the builder pattern
ReviewSetCustomerActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomFieldAction
Example to create an instance using the builder pattern
ReviewSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomTypeAction
Example to create an instance using the builder pattern
ReviewSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ReviewSetKeyAction
Example to create an instance using the builder pattern
ReviewSetKeyActionBuilder
Example to create an instance using the builder pattern
ReviewSetLocaleAction
Example to create an instance using the builder pattern
ReviewSetLocaleActionBuilder
Example to create an instance using the builder pattern
This update action produces the ReviewRatingSet Message.
ReviewSetRatingActionBuilder
Example to create an instance using the builder pattern
ReviewSetTargetAction
Example to create an instance using the builder pattern
ReviewSetTargetActionBuilder
Example to create an instance using the builder pattern
ReviewSetTextAction
Example to create an instance using the builder pattern
ReviewSetTextActionBuilder
Example to create an instance using the builder pattern
ReviewSetTitleAction
Example to create an instance using the builder pattern
ReviewSetTitleActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
ReviewStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
ReviewStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Transition to a new State.
ReviewTransitionStateActionBuilder
Example to create an instance using the builder pattern
ReviewUpdate
Example to create an instance using the builder pattern
ReviewUpdateAction
Example to create a subtype instance using the builder pattern
ReviewUpdateActionBuilder
ReviewUpdateBuilder
Example to create an instance using the builder pattern
Determines how monetary values are rounded.
RoundingMode
Maps to
Order.taxRoundingMode.possible values of RoundingMode
possible values of RoundingMode
possible values of RoundingMode
RuleApprover
Example to create an instance using the builder pattern
RuleApproverBuilder
Example to create an instance using the builder pattern
RuleApproverDraft
Example to create an instance using the builder pattern
RuleApproverDraftBuilder
Example to create an instance using the builder pattern
RuleRequester
Example to create an instance using the builder pattern
RuleRequesterBuilder
Example to create an instance using the builder pattern
RuleRequesterDraft
Example to create an instance using the builder pattern
RuleRequesterDraftBuilder
Example to create an instance using the builder pattern
Scoped Price is contained in a ProductVariant which is returned in response to a Product Projection Search request when Scoped Price Search is used.
ScopedPriceBuilder
Example to create an instance using the builder pattern
ScoreShippingRateInput
Example to create an instance using the builder pattern
ScoreShippingRateInput
Example to create an instance using the builder pattern
ScoreShippingRateInputBuilder
Example to create an instance using the builder pattern
ScoreShippingRateInputBuilder
Example to create an instance using the builder pattern
ScoreShippingRateInputDraft
Example to create an instance using the builder pattern
ScoreShippingRateInputDraftBuilder
Example to create an instance using the builder pattern
SearchAndExpression
Example to create an instance using the builder pattern
SearchAndExpressionBuilder
Example to create an instance using the builder pattern
SearchAnyValue
Example to create an instance using the builder pattern
SearchAnyValueBuilder
Example to create an instance using the builder pattern
SearchCompoundExpression
Example to create an instance using the builder pattern
SearchCompoundExpressionBuilder
Example to create an instance using the builder pattern
SearchDateRangeExpression
Example to create an instance using the builder pattern
SearchDateRangeExpressionBuilder
Example to create an instance using the builder pattern
SearchDateRangeValue
Example to create an instance using the builder pattern
SearchDateRangeValueBuilder
Example to create an instance using the builder pattern
SearchDateTimeRangeExpression
Example to create an instance using the builder pattern
SearchDateTimeRangeExpressionBuilder
Example to create an instance using the builder pattern
SearchDateTimeRangeValue
Example to create an instance using the builder pattern
SearchDateTimeRangeValueBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
SearchDeactivatedErrorBuilder
Example to create an instance using the builder pattern
SearchExactExpression
Example to create an instance using the builder pattern
SearchExactExpressionBuilder
Example to create an instance using the builder pattern
Returned when a search query could not be completed due to an unexpected failure.
SearchExecutionFailureErrorBuilder
Example to create an instance using the builder pattern
SearchExistsExpression
Example to create an instance using the builder pattern
SearchExistsExpressionBuilder
Example to create an instance using the builder pattern
SearchExistsValue
Example to create an instance using the builder pattern
SearchExistsValueBuilder
Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
SearchFacetPathNotFoundErrorBuilder
Example to create an instance using the builder pattern
Possible values for the
fieldType property on query expressions indicating the data type of the field.possible values of SearchFieldType
SearchFilterExpression
Example to create an instance using the builder pattern
SearchFilterExpressionBuilder
Example to create an instance using the builder pattern
SearchFullTextExpression
Example to create an instance using the builder pattern
SearchFullTextExpressionBuilder
Example to create an instance using the builder pattern
SearchFullTextPrefixExpression
Example to create an instance using the builder pattern
SearchFullTextPrefixExpressionBuilder
Example to create an instance using the builder pattern
SearchFullTextPrefixValue
Example to create an instance using the builder pattern
SearchFullTextPrefixValueBuilder
Example to create an instance using the builder pattern
SearchFullTextValue
Example to create an instance using the builder pattern
SearchFullTextValueBuilder
Example to create an instance using the builder pattern
Controls indexing of resources to be provided on high performance read-only search endpoints.
SearchIndexingConfigurationBuilder
Example to create an instance using the builder pattern
Status of resource indexing.
possible values of SearchIndexingConfigurationStatus
SearchIndexingConfigurationValues
Example to create an instance using the builder pattern
SearchIndexingConfigurationValuesBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
SearchIndexingInProgressErrorBuilder
Example to create an instance using the builder pattern
SearchKeyword
Example to create an instance using the builder pattern
SearchKeyword
Example to create an instance using the builder pattern
SearchKeyword
Example to create an instance using the builder pattern
SearchKeywordBuilder
Example to create an instance using the builder pattern
SearchKeywordBuilder
Example to create an instance using the builder pattern
SearchKeywordBuilder
Example to create an instance using the builder pattern
Search keywords are JSON objects primarily used by Product Suggestions, but are also considered for a full text search.
SearchKeywords
Example to create an instance using the builder pattern
Search keywords are primarily used by the suggester but are also considered for the full-text search.
SearchKeywordsBuilder
Example to create an instance using the builder pattern
SearchKeywordsBuilder
Example to create an instance using the builder pattern
SearchKeywordsBuilder
Example to create an instance using the builder pattern
SearchLongRangeExpression
Example to create an instance using the builder pattern
SearchLongRangeExpressionBuilder
Example to create an instance using the builder pattern
SearchLongRangeValue
Example to create an instance using the builder pattern
SearchLongRangeValueBuilder
Example to create an instance using the builder pattern
SearchMatchingVariant
Example to create an instance using the builder pattern
SearchMatchingVariantBuilder
Example to create an instance using the builder pattern
SearchMatchType
possible values of SearchMatchType
SearchNotExpression
Example to create an instance using the builder pattern
SearchNotExpressionBuilder
Example to create an instance using the builder pattern
SearchNumberRangeExpression
Example to create an instance using the builder pattern
SearchNumberRangeExpressionBuilder
Example to create an instance using the builder pattern
SearchNumberRangeValue
Example to create an instance using the builder pattern
SearchNumberRangeValueBuilder
Example to create an instance using the builder pattern
SearchOrExpression
Example to create an instance using the builder pattern
SearchOrExpressionBuilder
Example to create an instance using the builder pattern
SearchPrefixExpression
Example to create an instance using the builder pattern
SearchPrefixExpressionBuilder
Example to create an instance using the builder pattern
SearchQuery
Example to create an instance using the builder pattern
SearchQueryBuilder
Example to create an instance using the builder pattern
SearchQueryExpression
Example to create an instance using the builder pattern
SearchQueryExpressionBuilder
Example to create an instance using the builder pattern
SearchQueryExpressionValue
Example to create an instance using the builder pattern
SearchQueryExpressionValueBuilder
Example to create an instance using the builder pattern
Sorting parameters provided with a Search request.
SearchSortingBuilder
Example to create an instance using the builder pattern
For set-type fields, only a single value of the set is taken into account for sorting.
possible values of SearchSortMode
SearchSortOrder
possible values of SearchSortOrder
SearchTimeRangeExpression
Example to create an instance using the builder pattern
SearchTimeRangeExpressionBuilder
Example to create an instance using the builder pattern
SearchTimeRangeValue
Example to create an instance using the builder pattern
SearchTimeRangeValueBuilder
Example to create an instance using the builder pattern
SearchWildCardExpression
Example to create an instance using the builder pattern
SearchWildCardExpressionBuilder
Example to create an instance using the builder pattern
Secured_by_manage_customersTrait
Secured_by_manage_discount_codesTrait
Secured_by_manage_import_containersTrait
Secured_by_manage_ordersTrait
Secured_by_manage_productsTrait
Secured_by_manage_standalone_pricesTrait
Secured_by_manage_typesTrait
Secured_by_view_customersTrait
Secured_by_view_import_containersTrait
Secured_by_view_ordersTrait
Secured_by_view_productsTrait
Defines which matching items are to be discounted.
SelectionMode
possible values of SelectionMode
possible values of SelectionMode
Returned when a Discount predicate or API Extension predicate is not semantically correct.
SemanticErrorErrorBuilder
Example to create an instance using the builder pattern
Table of content
Implementation of a non executable
ApiHttpClientChange triggered by the Set Address update action.
SetAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Address Custom Field update action.
SetAddressCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Address Custom Type update action.
SetAddressCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAnonymousIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
SetApplicationVersionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetKeyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetSourcesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetAssetTagsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Attribute update action.
SetAttributeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set AuthenticationMode update action.
SetAuthenticationModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Author Name update action.
SetAuthorNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetBillingAddressChangeBuilder
Example to create an instance using the builder pattern
SetCartClassificationShippingRateInputValue
Example to create an instance using the builder pattern
SetCartClassificationShippingRateInputValueBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Cart Predicate update action.
SetCartPredicateChangeBuilder
Example to create an instance using the builder pattern
SetCartScoreShippingRateInputValue
Example to create an instance using the builder pattern
SetCartScoreShippingRateInputValueBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Category Order Hint update action.
SetCategoryOrderHintChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Roles update action.
SetChannelRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Company Name update action.
SetCompanyNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Contact Email update action.
SetContactEmailChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Countries update action.
SetCountriesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Country update action.
SetCountryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomerChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomerEmailChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set CustomerGroup update action.
SetCustomerGroupChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomerIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Customer Number update action.
SetCustomerNumberChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomLineItemCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomLineItemCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem Money update action.
SetCustomLineItemMoneyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomLineItemShippingDetailsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem TaxAmount update action.
SetCustomLineItemTaxAmountChangeBuilder
Example to create an instance using the builder pattern
SetCustomLineItemTaxCategoryChange
Example to create an instance using the builder pattern
SetCustomLineItemTaxCategoryChangeBuilder
Example to create an instance using the builder pattern
SetCustomLineItemTaxedPriceChange
Example to create an instance using the builder pattern
SetCustomLineItemTaxedPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set CustomLineItem TaxRate update action.
SetCustomLineItemTaxRateChangeBuilder
Example to create an instance using the builder pattern
SetCustomLineItemTotalPriceChange
Example to create an instance using the builder pattern
SetCustomLineItemTotalPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Custom ShippingMethod update action.
SetCustomShippingMethodChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Date of Birth update action.
SetDateOfBirthChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Default Billing Address update action.
SetDefaultBillingAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Default Shipping Address update action.
SetDefaultShippingAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set DeleteDaysAfterLastModification update action.
SetDeleteDaysAfterLastModificationChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetDeliveryAddressChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetDeliveryItemsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Discounted Embedded Price update action.
SetDiscountedPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Distribution Channels update action.
SetDistributionChannelsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ExpectedDelivery update action.
SetExpectedDeliveryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetExternalIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set First Name update action.
SetFirstNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set GeoLocation update action.
SetGeoLocationChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Image Label update action.
SetImageLabelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set AttributeDefinition InputTip update action.
SetInputTipChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set InterfaceId update action.
SetInterfaceIdChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
SetIsValidChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetKeyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by Set Languages update action.
SetLanguagesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by Set Last Name update action.
SetLastNameChangeBuilder
Example to create an instance using the builder pattern
SetLineItemDeactivatedAtChange
Example to create an instance using the builder pattern
SetLineItemDeactivatedAtChangeBuilder
Example to create an instance using the builder pattern
SetLineItemDiscountedPriceChange
Example to create an instance using the builder pattern
SetLineItemDiscountedPriceChangeBuilder
Example to create an instance using the builder pattern
SetLineItemDiscountedPricePerQuantityChange
Example to create an instance using the builder pattern
SetLineItemDiscountedPricePerQuantityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set LineItem DistributionChannel update action.
SetLineItemDistributionChannelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set LineItem Price update action.
SetLineItemPriceChangeBuilder
Example to create an instance using the builder pattern
SetLineItemProductKeyChange
Example to create an instance using the builder pattern
SetLineItemProductKeyChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
SetLineItemProductSlugChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetLineItemShippingDetailsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set LineItem TaxAmount update action.
SetLineItemTaxAmountChangeBuilder
Example to create an instance using the builder pattern
SetLineItemTaxedPriceChange
Example to create an instance using the builder pattern
SetLineItemTaxedPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set LineItemTaxRate update action.
SetLineItemTaxRateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set LineItemTotalPrice update action.
SetLineItemTotalPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetLocaleChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetLocalizedDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetLocalizedNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Max Applications update action.
SetMaxApplicationsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Max Applications Per Customer update action.
SetMaxApplicationsPerCustomerChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetMetaDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetMetaKeywordsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetMetaTitleChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoInterface update action.
SetMethodInfoInterfaceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoInterface update action.
SetMethodInfoMethodChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set MethodInfoName update action.
SetMethodInfoNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Middle Name update action.
SetMiddleNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Name update action.
SetNameChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetOrderLineItemCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetOrderLineItemCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetOrderNumberChangeBuilder
Example to create an instance using the builder pattern
SetOrderTaxedPriceChange
Example to create an instance using the builder pattern
SetOrderTaxedPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically due to a user-initiated change.
SetOrderTotalPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set OrderTotalTax update action.
SetOrderTotalTaxChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetParcelItemsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetParcelMeasurementsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetParcelTrackingDataChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Permissions, Add Permission, and Remove Permission update actions.
SetPermissionsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Prices update action.
SetPricesChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically by the Add Product or Remove Product update action.
SetProductCountChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Price CustomField update action.
SetProductPriceCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Price Custom Type update action.
SetProductPriceCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Product Selections update action.
SetProductSelectionsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ProductVariant Key update action.
SetProductVariantKeyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when an existing property is updated.
SetPropertyChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetPurchaseOrderNumberChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Rating update action.
SetRatingChangeBuilder
Example to create an instance using the builder pattern
SetReservationsChange
Example to create an instance using the builder pattern
SetReservationsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set RestockableInDays update action.
SetRestockableInDaysChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetReturnPaymentStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetReturnShipmentStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Salutation update action.
SetSalutationChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set SearchKeywords update action.
SetSearchKeywordsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Seller Comment update action.
SetSellerCommentChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetShippingAddressChangeBuilder
Example to create an instance using the builder pattern
SetShippingInfoPriceChange
Example to create an instance using the builder pattern
SetShippingInfoPriceChangeBuilder
Example to create an instance using the builder pattern
SetShippingInfoTaxedPriceChange
Example to create an instance using the builder pattern
SetShippingInfoTaxedPriceChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod update action.
SetShippingMethodChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod TaxAmount update action.
SetShippingMethodTaxAmountChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ShippingMethod TaxRate update action.
SetShippingMethodTaxRateChangeBuilder
Example to create an instance using the builder pattern
SetShippingRateChange
Example to create an instance using the builder pattern
SetShippingRateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Shipping Rate Input update action.
SetShippingRateInputChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ShoppingListLineItem Custom Field update action.
SetShoppingListLineItemCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set ShoppingListLineItem Custom Type update action.
SetShoppingListLineItemCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set SKU update action.
SetSkuChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Slug update action.
SetSlugChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set State roles update action.
SetStateRolesChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set StatusInterfaceCode update action.
SetStatusInterfaceCodeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set StatusInterfaceText update action.
SetStatusInterfaceTextChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetStoreChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Store Mode update action.
SetStoreModeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Stores update action.
SetStoresChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set SupplyChannel update action.
SetSupplyChannelChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Supply Channels update action.
SetSupplyChannelsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Target update action.
SetTargetChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set TaxCategory update action.
SetTaxCategoryChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Text update action.
SetTextChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem CustomField update action.
SetTextLineItemCustomFieldChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem Custom Type update action.
SetTextLineItemCustomTypeChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set TextLineItem Description update action.
SetTextLineItemDescriptionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetTitleChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Transitions update action.
SetTransitionsChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetValidFromAndUntilChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetValidFromChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Valid To update action.
SetValidToChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
SetValidUntilChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Update CustomObject request when a value of a property is updated.
SetValueChangeBuilder
Example to create an instance using the builder pattern
Change triggered automatically when an InventoryEntry associated with a Product changes.
SetVariantAvailabilityChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Variant Selection update action.
SetVariantSelectionChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Set Vat ID update action.
SetVatIdChangeBuilder
Example to create an instance using the builder pattern
Indicates the shipment status of the Order.
ShipmentState
Maps to
Order.shipmentState.possible values of ShipmentState
possible values of ShipmentState
possible values of ShipmentState
Shipping
Example to create an instance using the builder pattern
ShippingBuilder
Example to create an instance using the builder pattern
Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
ShippingDraftBuilder
Example to create an instance using the builder pattern
ShippingInfo
Example to create an instance using the builder pattern
ShippingInfoBuilder
Example to create an instance using the builder pattern
Becomes the
shippingInfo of the imported Order.Maps to an order's
shippingInfo property.ShippingInfoImportDraftBuilder
Example to create an instance using the builder pattern
ShippingInfoImportDraftBuilder
Example to create an instance using the builder pattern
ShippingMethod
Example to create an instance using the builder pattern
ShippingMethodAddShippingRateAction
Example to create an instance using the builder pattern
ShippingMethodAddShippingRateActionBuilder
Example to create an instance using the builder pattern
ShippingMethodAddZoneAction
Example to create an instance using the builder pattern
ShippingMethodAddZoneActionBuilder
Example to create an instance using the builder pattern
ShippingMethodBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeIsDefaultAction
Example to create an instance using the builder pattern
ShippingMethodChangeIsDefaultActionBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeNameAction
Example to create an instance using the builder pattern
ShippingMethodChangeNameActionBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryAction
Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryActionBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeValue
Example to create an instance using the builder pattern
ShippingMethodChangeValueBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
ShippingMethodDoesNotMatchCartErrorBuilder
Example to create an instance using the builder pattern
ShippingMethodDraft
Example to create an instance using the builder pattern
ShippingMethodDraftBuilder
Example to create an instance using the builder pattern
References a shipping method by key.
ShippingMethodKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of ShippingMethod.ShippingMethodPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a ShippingMethod.
ShippingMethodReferenceBuilder
Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateAction
Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateActionBuilder
Example to create an instance using the builder pattern
ShippingMethodRemoveZoneAction
Example to create an instance using the builder pattern
ShippingMethodRemoveZoneActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ShippingMethod.
ShippingMethodResourceIdentifierBuilder
Example to create an instance using the builder pattern
This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.
ShippingMethodSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeAction
Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Deprecated.
Deprecated.
ShippingMethodSetKeyAction
Example to create an instance using the builder pattern
ShippingMethodSetKeyActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionAction
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameAction
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetPredicateAction
Example to create an instance using the builder pattern
ShippingMethodSetPredicateActionBuilder
Example to create an instance using the builder pattern
Determines whether a ShippingMethod is allowed for a Cart.
ShippingMethodState
possible values of ShippingMethodState
possible values of ShippingMethodState
ShippingMethodTaxAmountChangeValue
Example to create an instance using the builder pattern
ShippingMethodTaxAmountChangeValueBuilder
Example to create an instance using the builder pattern
ShippingMethodUpdate
Example to create an instance using the builder pattern
ShippingMethodUpdateAction
Example to create a subtype instance using the builder pattern
ShippingMethodUpdateActionBuilder
ShippingMethodUpdateBuilder
Example to create an instance using the builder pattern
ShippingMode
possible values of ShippingMode
ShippingRate
Example to create an instance using the builder pattern
ShippingRate
Example to create an instance using the builder pattern
ShippingRateBuilder
Example to create an instance using the builder pattern
ShippingRateBuilder
Example to create an instance using the builder pattern
ShippingRateDraft
Example to create an instance using the builder pattern
ShippingRateDraft
Example to create an instance using the builder pattern
ShippingRateDraftBuilder
Example to create an instance using the builder pattern
ShippingRateDraftBuilder
Example to create an instance using the builder pattern
ShippingRateInput
Example to create a subtype instance using the builder pattern
ShippingRateInput
Example to create a subtype instance using the builder pattern
ShippingRateInputBuilder
ShippingRateInputBuilder
Generic type holding specifc ShippingRateInputDraft types.
ShippingRateInputDraftBuilder
ShippingRateInputType
Example to create a subtype instance using the builder pattern
ShippingRateInputType
possible values of ShippingRateInputType
ShippingRateInputTypeBuilder
ShippingRatePriceTier
Example to create a subtype instance using the builder pattern
ShippingRatePriceTier
Example to create an instance using the builder pattern
ShippingRatePriceTier
Example to create a subtype instance using the builder pattern
ShippingRatePriceTierBuilder
ShippingRatePriceTierBuilder
Example to create an instance using the builder pattern
ShippingRatePriceTierBuilder
ShippingRateTierType
ShippingRateTierType
ShippingRateTierType
possible values of ShippingRateTierType
possible values of ShippingRateTierType
possible values of ShippingRateTierType
ShoppingList
Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the
productID and variantID, or by the sku.ShoppingListAddLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListAddTextLineItemAction
Example to create an instance using the builder pattern
ShoppingListAddTextLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListBuilder
Example to create an instance using the builder pattern
ShoppingListChangeLineItemQuantityAction
Example to create an instance using the builder pattern
ShoppingListChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderAction
Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeNameAction
Example to create an instance using the builder pattern
ShoppingListChangeNameActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
ShoppingListDraft
Example to create an instance using the builder pattern
ShoppingListDraftBuilder
Example to create an instance using the builder pattern
ShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.
ShoppingListLineItemBuilder
Example to create an instance using the builder pattern
The ProductVariant to be included in the ShoppingListLineItem must be specified using the
productID and variantID, or by the sku.ShoppingListLineItemDraftBuilder
Example to create an instance using the builder pattern
ShoppingListLineItemValue
Example to create an instance using the builder pattern
ShoppingListLineItemValueBuilder
Example to create an instance using the builder pattern
ShoppingListPagedQueryResponse
Example to create an instance using the builder pattern
ShoppingListPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a ShoppingList.
ShoppingListReferenceBuilder
Example to create an instance using the builder pattern
ShoppingListRemoveLineItemAction
Example to create an instance using the builder pattern
ShoppingListRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ShoppingList.
ShoppingListResourceIdentifierBuilder
Example to create an instance using the builder pattern
ShoppingListsConfiguration
Example to create an instance using the builder pattern
ShoppingListsConfigurationBuilder
Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdAction
Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomerAction
Example to create an instance using the builder pattern
ShoppingListSetCustomerActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationAction
Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetDescriptionAction
Example to create an instance using the builder pattern
ShoppingListSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetKeyAction
Example to create an instance using the builder pattern
ShoppingListSetKeyActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetSlugAction
Example to create an instance using the builder pattern
ShoppingListSetSlugActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetStoreAction
Example to create an instance using the builder pattern
ShoppingListSetStoreActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionActionBuilder
Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayload
Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ShoppingListUpdate
Example to create an instance using the builder pattern
ShoppingListUpdateAction
Example to create a subtype instance using the builder pattern
ShoppingListUpdateActionBuilder
ShoppingListUpdateBuilder
Example to create an instance using the builder pattern
SimplePagedQueryResourceRequest<T extends SimplePagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>
Interface with common methods for query endpoints
AWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.
SnsDestinationBuilder
Example to create an instance using the builder pattern
Marker interface to generate a solution info for the Java SDK user agent.
SortableTrait
Values for the Source enumeration.
possible values of Source
AWS SQS is a pull-queue on AWS.
SqsDestinationBuilder
Example to create an instance using the builder pattern
Describes how the Cart Discount interacts with other Discounts.
StackingMode
possible values of StackingMode
possible values of StackingMode
StagedOrder
Example to create an instance using the builder pattern
If the Cart already contains a CustomLineItem with the same
slug, name, money, taxCategory, state, and Custom Fields, then only the quantity of the existing Custom Line Item is increased.StagedOrderAddCustomLineItemActionBuilder
Example to create an instance using the builder pattern
A Delivery can only be added to an Order if its
shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.StagedOrderAddDeliveryActionBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
StagedOrderAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds an address to an Order when shipping to multiple addresses is desired.
StagedOrderAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
If the Cart contains a LineItem for a Product Variant with the same LineItemMode, Custom Fields, supply and distribution channel, then only the quantity of the existing Line Item is increased.
StagedOrderAddLineItemActionBuilder
Example to create an instance using the builder pattern
To add a Parcel, at least one Delivery must exist.
StagedOrderAddParcelToDeliveryActionBuilder
Example to create an instance using the builder pattern
StagedOrderAddPaymentAction
Example to create an instance using the builder pattern
StagedOrderAddPaymentActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Added Message.
StagedOrderAddReturnInfoActionBuilder
Example to create an instance using the builder pattern
Adds all LineItems of a ShoppingList to the Cart.
StagedOrderAddShoppingListActionBuilder
Example to create an instance using the builder pattern
StagedOrderBuilder
Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemMoneyAction
Example to create an instance using the builder pattern
StagedOrderChangeCustomLineItemMoneyActionBuilder
Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
StagedOrderChangeCustomLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
StagedOrderChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
Produces the Order State Changed Message.
StagedOrderChangeOrderStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Payment State Changed Message.
StagedOrderChangePaymentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Shipment State Changed Message.
StagedOrderChangeShipmentStateActionBuilder
Example to create an instance using the builder pattern
Changing the tax calculation mode leads to recalculation of taxes.
StagedOrderChangeTaxCalculationModeActionBuilder
Example to create an instance using the builder pattern
When
External TaxMode is changed to Platform or Disabled, all previously set external Tax Rates are removed.
When set to Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart's shippingAddress.
Example to create an instance using the builder pattern
StagedOrderChangeTaxModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax rounding mode leads to recalculation of taxes.
StagedOrderChangeTaxRoundingModeActionBuilder
Example to create an instance using the builder pattern
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
StagedOrderImportCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
StagedOrderImportLineItemStateActionBuilder
Example to create an instance using the builder pattern
This update action does not support specifying a quantity, unlike the Remove LineItem update action.
StagedOrderRemoveCustomLineItemActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryRemoved Message.
StagedOrderRemoveDeliveryActionBuilder
Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeAction
Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
StagedOrderRemoveItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
StagedOrderRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelRemovedFromDelivery Message.
StagedOrderRemoveParcelFromDeliveryActionBuilder
Example to create an instance using the builder pattern
StagedOrderRemovePaymentAction
Example to create an instance using the builder pattern
StagedOrderRemovePaymentActionBuilder
Example to create an instance using the builder pattern
This action updates the
billingAddress on the Order, but it does not change the billing address on the referenced Cart from which the Order is created.StagedOrderSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
StagedOrderSetCountryActionBuilder
Example to create an instance using the builder pattern
This action updates the
customerEmail on the Order, but it does not change the Customer email on the Cart the Order has been created from.StagedOrderSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
This update action can only be used if a Customer is not assigned to a Cart.
StagedOrderSetCustomerGroupActionBuilder
Example to create an instance using the builder pattern
Setting the Order's
customerId does not recalculate prices or discounts on the Order.StagedOrderSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
ExternalAmount TaxMode.StagedOrderSetCustomLineItemTaxAmountActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.StagedOrderSetCustomLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
To set the Cart's custom Shipping Method (independent of the ShippingMethods managed through the Shipping Methods API) the Cart must have the
Single ShippingMode and a shippingAddress.StagedOrderSetCustomShippingMethodActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryAddressSet Message.
StagedOrderSetDeliveryAddressActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the Delivery Items Updated Message.
StagedOrderSetDeliveryItemsActionBuilder
Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Order.
StagedOrderSetDirectDiscountsActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.StagedOrderSetLineItemDistributionChannelActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.StagedOrderSetLineItemPriceActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
ExternalAmount TaxMode.StagedOrderSetLineItemTaxAmountActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.StagedOrderSetLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.StagedOrderSetLineItemTotalPriceActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLocaleAction
Example to create an instance using the builder pattern
StagedOrderSetLocaleActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetOrderNumberAction
Example to create an instance using the builder pattern
StagedOrderSetOrderNumberActionBuilder
Example to create an instance using the builder pattern
Updates the total tax amount of the Order if it has the
ExternalAmount TaxMode.StagedOrderSetOrderTotalTaxActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelItemsUpdated Message.
StagedOrderSetParcelItemsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelMeasurementsUpdated Message.
StagedOrderSetParcelMeasurementsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelTrackingDataUpdated Message.
StagedOrderSetParcelTrackingDataActionBuilder
Example to create an instance using the builder pattern
Produces the PurchaseOrderNumberSet Message.
StagedOrderSetPurchaseOrderNumberActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Set Message.
StagedOrderSetReturnInfoActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
To set a ReturnPaymentState, the Order
returnInfo must have at least one ReturnItem.StagedOrderSetReturnPaymentStateActionBuilder
Example to create an instance using the builder pattern
To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.StagedOrderSetReturnShipmentStateActionBuilder
Example to create an instance using the builder pattern
This action updates the
shippingAddress on the Order, but it does not change the shipping address on the referenced Cart from which the Order is created.StagedOrderSetShippingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the shipping address and a custom Shipping Method together to prevent an inconsistent state.
StagedOrderSetShippingAddressAndCustomShippingMethodActionBuilder
Example to create an instance using the builder pattern
Sets the shipping address and Shipping Method together to prevent an inconsistent state.
StagedOrderSetShippingAddressAndShippingMethodActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
To set the Cart's Shipping Method, the Cart must have the
Single ShippingMode and a shippingAddress.StagedOrderSetShippingMethodActionBuilder
Example to create an instance using the builder pattern
A Shipping Method tax amount can be set if the Cart has the
ExternalAmount TaxMode.StagedOrderSetShippingMethodTaxAmountActionBuilder
Example to create an instance using the builder pattern
A Shipping Method Tax Rate can be set if the Cart has the
External TaxMode.StagedOrderSetShippingMethodTaxRateActionBuilder
Example to create an instance using the builder pattern
Input used to select a ShippingRatePriceTier.
StagedOrderSetShippingRateInputActionBuilder
Example to create an instance using the builder pattern
Sets the Store the Order is assigned to.
StagedOrderSetStoreActionBuilder
Example to create an instance using the builder pattern
Produces the Custom Line Item State Transition Message.
StagedOrderTransitionCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Line Item State Transition Message.
StagedOrderTransitionLineItemStateActionBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.StagedOrderTransitionStateActionBuilder
Example to create an instance using the builder pattern
StagedOrderUpdateAction
Example to create a subtype instance using the builder pattern
StagedOrderUpdateActionBuilder
Updates an address in
itemShippingAddresses by keeping the Address key.StagedOrderUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoAction
Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoActionBuilder
Example to create an instance using the builder pattern
StagedPriceDraft
Example to create an instance using the builder pattern
StagedPriceDraftBuilder
Example to create an instance using the builder pattern
StagedQuote
Example to create an instance using the builder pattern
StagedQuoteBuilder
Example to create an instance using the builder pattern
StagedQuoteChangeStagedQuoteStateAction
Example to create an instance using the builder pattern
StagedQuoteChangeStagedQuoteStateActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StagedQuote request.
StagedQuoteCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StagedQuote request.
StagedQuoteCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StagedQuote request.
StagedQuoteDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StagedQuote request.
StagedQuoteDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
StagedQuoteDraft
Example to create an instance using the builder pattern
StagedQuoteDraftBuilder
Example to create an instance using the builder pattern
StagedQuoteLabel
Example to create an instance using the builder pattern
StagedQuoteLabelBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of StagedQuote.
StagedQuotePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a StagedQuote.
StagedQuoteReferenceBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a StagedQuote.
StagedQuoteResourceIdentifierBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Seller Comment update action.
StagedQuoteSellerCommentSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Seller Comment update action.
StagedQuoteSellerCommentSetMessagePayloadBuilder
Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldAction
Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeAction
Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentAction
Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetValidToAction
Example to create an instance using the builder pattern
StagedQuoteSetValidToActionBuilder
Example to create an instance using the builder pattern
Predefined states tracking the status of the Staged Quote.
StagedQuoteState
possible values of StagedQuoteState
possible values of StagedQuoteState
Generated after a successful Change Staged Quote State update action.
StagedQuoteStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Staged Quote State update action.
StagedQuoteStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
StagedQuoteStateTransitionMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
StagedQuoteStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
If the existing State has set
transitions, there must be a direct transition to the new State.StagedQuoteTransitionStateActionBuilder
Example to create an instance using the builder pattern
StagedQuoteUpdate
Example to create an instance using the builder pattern
StagedQuoteUpdateAction
Example to create a subtype instance using the builder pattern
StagedQuoteUpdateActionBuilder
StagedQuoteUpdateBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid To update action.
StagedQuoteValidToSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid To update action.
StagedQuoteValidToSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Staged changes on a Standalone Price.
StagedStandalonePriceBuilder
Example to create an instance using the builder pattern
StandalonePrice
Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
StandalonePriceActiveChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
StandalonePriceActiveChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Adding a PriceTier to a StandalonePrice produces the Standalone Price Tier Added Message.
StandalonePriceAddPriceTierActionBuilder
Example to create an instance using the builder pattern
Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the StagedStandalonePrice.
StandalonePriceApplyStagedChangesActionBuilder
Example to create an instance using the builder pattern
StandalonePriceBuilder
Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceActiveChanged Message.
StandalonePriceChangeActiveActionBuilder
Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
StandalonePriceChangeValueActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a Product Discount is successfully applied to a StandalonePrice.
StandalonePriceDiscountSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a Product Discount is successfully applied to a StandalonePrice.
StandalonePriceDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Standalone Prices are defined with a scope consisting of
currency and optionally country, customerGroup, and channel and/or a validity period (validFrom and/or validTo).StandalonePriceDraftBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
StandalonePriceExternalDiscountSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
StandalonePriceExternalDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
The data representation for a Standalone Price to be imported that is persisted as a Standalone Price in the Project.
StandalonePriceImportBuilder
Example to create an instance using the builder pattern
The request body to import Standalone Prices.
StandalonePriceImportRequestBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
StandalonePriceKeySetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
StandalonePriceKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
StandalonePricePagedQueryResponse
Example to create an instance using the builder pattern
StandalonePricePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a StandalonePrice.
StandalonePriceReferenceBuilder
Example to create an instance using the builder pattern
Removing a PriceTier from a StandalonePrice produces the Standalone Price Tier Removed Message.
StandalonePriceRemovePriceTierActionBuilder
Example to create an instance using the builder pattern
Removes all staged changes from the StandalonePrice.
StandalonePriceRemoveStagedChangesActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a StandalonePrice.
StandalonePriceResourceIdentifierBuilder
Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldAction
Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeAction
Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Discounts a Standalone Price.
StandalonePriceSetDiscountedPriceActionBuilder
Example to create an instance using the builder pattern
Sets the key on a Standalone Price.
StandalonePriceSetKeyActionBuilder
Example to create an instance using the builder pattern
Sets all PriceTiers for a StandalonePrice in one action, produces the Standalone Price Tiers Set Message.
StandalonePriceSetPriceTiersActionBuilder
Example to create an instance using the builder pattern
Updating the
validFrom value generates the StandalonePriceValidFromSet Message.StandalonePriceSetValidFromActionBuilder
Example to create an instance using the builder pattern
Updating the
validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.StandalonePriceSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
Updating the
validUntil value generates the StandalonePriceValidUntilSet Message.StandalonePriceSetValidUntilActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Apply Staged Changes update action.
StandalonePriceStagedChangesAppliedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Apply Staged Changes update action.
StandalonePriceStagedChangesAppliedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Staged Changes update action.
StandalonePriceStagedChangesRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Staged Changes update action.
StandalonePriceStagedChangesRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price Tier update action
StandalonePriceTierAddedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price Tier update action
StandalonePriceTierAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price Tier update action
StandalonePriceTierRemovedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price Tier update action
StandalonePriceTierRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Tier update action
StandalonePriceTiersSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Tier update action
StandalonePriceTiersSetMessagePayloadBuilder
Example to create an instance using the builder pattern
StandalonePriceUpdate
Example to create an instance using the builder pattern
StandalonePriceUpdateAction
Example to create a subtype instance using the builder pattern
StandalonePriceUpdateActionBuilder
StandalonePriceUpdateBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid From and Until update action.
StandalonePriceValidFromAndUntilSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid From and Until update action.
StandalonePriceValidFromAndUntilSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid From update action.
StandalonePriceValidFromSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid From update action.
StandalonePriceValidFromSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid Until update action.
StandalonePriceValidUntilSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid Until update action.
StandalonePriceValidUntilSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Value update action.
StandalonePriceValueChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Value update action.
StandalonePriceValueChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
State
Example to create an instance using the builder pattern
StateAddRolesAction
Example to create an instance using the builder pattern
StateAddRolesActionBuilder
Example to create an instance using the builder pattern
StateBuilder
Example to create an instance using the builder pattern
StateChangeInitialAction
Example to create an instance using the builder pattern
StateChangeInitialActionBuilder
Example to create an instance using the builder pattern
StateChangeKeyAction
Example to create an instance using the builder pattern
StateChangeKeyActionBuilder
Example to create an instance using the builder pattern
StateChangeTypeAction
Example to create an instance using the builder pattern
StateChangeTypeActionBuilder
Example to create an instance using the builder pattern
StateDraft
Example to create an instance using the builder pattern
StateDraftBuilder
Example to create an instance using the builder pattern
References a state by key.
StateKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of State.StatePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a State.
StateReferenceBuilder
Example to create an instance using the builder pattern
StateRemoveRolesAction
Example to create an instance using the builder pattern
StateRemoveRolesActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a State.
StateResourceIdentifierBuilder
Example to create an instance using the builder pattern
For some resource types, a State can fulfill the following predefined roles:
For some resource types, a State can fulfill the following predefined roles:
possible values of StateRoleEnum
possible values of StateRoleEnum
StateSetDescriptionAction
Example to create an instance using the builder pattern
StateSetDescriptionActionBuilder
Example to create an instance using the builder pattern
StateSetNameAction
Example to create an instance using the builder pattern
StateSetNameActionBuilder
Example to create an instance using the builder pattern
StateSetRolesAction
Example to create an instance using the builder pattern
StateSetRolesActionBuilder
Example to create an instance using the builder pattern
StateSetTransitionsAction
Example to create an instance using the builder pattern
StateSetTransitionsActionBuilder
Example to create an instance using the builder pattern
Resource or object type the State can be assigned to.
Resource or object type the State can be assigned to.
possible values of StateTypeEnum
possible values of StateTypeEnum
StateUpdate
Example to create an instance using the builder pattern
StateUpdateAction
Example to create a subtype instance using the builder pattern
StateUpdateActionBuilder
StateUpdateBuilder
Example to create an instance using the builder pattern
Token supplier using a specified token
Store
Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
StoreAddCountryActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
StoreAddDistributionChannelActionBuilder
Example to create an instance using the builder pattern
To make all included Products available to your customers of a given Store, add the Product Selections to the respective Store.
StoreAddProductSelectionActionBuilder
Example to create an instance using the builder pattern
This action has no effect if a given supply channel is already present in a Store.
StoreAddSupplyChannelActionBuilder
Example to create an instance using the builder pattern
StoreBuilder
Example to create an instance using the builder pattern
Returned when a Cart Discount cannot be created or assigned to a Store as the limit for active Cart Discounts in a Store has been reached for one or more Stores in the request.
StoreCartDiscountsLimitReachedErrorBuilder
Example to create an instance using the builder pattern
ProductSelection in a Store can be activated or deactivated using this update action.
StoreChangeProductSelectionActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountriesChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountriesChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
StoreCountry
Example to create an instance using the builder pattern
StoreCountry
Example to create an instance using the builder pattern
StoreCountryBuilder
Example to create an instance using the builder pattern
StoreCountryBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Store request.
StoreCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Store request.
StoreCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
StoreDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
StoreDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
StoreDistributionChannelsChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
StoreDistributionChannelsChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
StoreDraft
Example to create an instance using the builder pattern
StoreDraftBuilder
Example to create an instance using the builder pattern
Reference to a Store by its key.
References a store by key.
StoreKeyReferenceBuilder
Example to create an instance using the builder pattern
StoreKeyReferenceBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Languages update action.
StoreLanguagesChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Languages update action.
StoreLanguagesChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
StoreNameSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
StoreNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Store.
StorePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
StoreProductSelectionsChangedMessageBuilder
Example to create an instance using the builder pattern
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
StoreProductSelectionsChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
StoreprojectingTrait
Reference to a Store.
StoreReferenceBuilder
Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
StoreRemoveCountryActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
StoreRemoveDistributionChannelActionBuilder
Example to create an instance using the builder pattern
This action has no effect if the given Product Selection is not in the Store.
StoreRemoveProductSelectionActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreSupplyChannelsChanged Message.
StoreRemoveSupplyChannelActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Store.
StoreResourceIdentifierBuilder
Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
StoreSetCountriesActionBuilder
Example to create an instance using the builder pattern
StoreSetCustomFieldAction
Example to create an instance using the builder pattern
StoreSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StoreSetCustomTypeAction
Example to create an instance using the builder pattern
StoreSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
StoreSetDistributionChannelsActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreLanguagesChanged Message.
StoreSetLanguagesActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreNameSet Message.
StoreSetNameActionBuilder
Example to create an instance using the builder pattern
Instead of adding or removing Product Selections individually, you can also change all the Store's Product Selections in one go using this update action.
StoreSetProductSelectionsActionBuilder
Example to create an instance using the builder pattern
Setting a supply channel produces the StoreSupplyChannelsChanged Message.
StoreSetSupplyChannelsActionBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
StoreSupplyChannelsChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
StoreSupplyChannelsChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
StoreUpdate
Example to create an instance using the builder pattern
StoreUpdateAction
Example to create a subtype instance using the builder pattern
StoreUpdateActionBuilder
StoreUpdateBuilder
Example to create an instance using the builder pattern
A field with a string value.
StringFieldBuilder
Example to create an instance using the builder pattern
StringLabel
Example to create an instance using the builder pattern
StringLabelBuilder
Example to create an instance using the builder pattern
A field with a string set value.
StringSetFieldBuilder
Example to create an instance using the builder pattern
It is used to calculate the taxPortions field in a Cart or Order.
SubRate
Example to create an instance using the builder pattern
SubRate
Example to create an instance using the builder pattern
SubRateBuilder
Example to create an instance using the builder pattern
SubRateBuilder
Example to create an instance using the builder pattern
SubRateBuilder
Example to create an instance using the builder pattern
Subscription
Example to create an instance using the builder pattern
SubscriptionBuilder
Example to create an instance using the builder pattern
A test message is sent to ensure the correct configuration of the Destination.
SubscriptionChangeDestinationActionBuilder
Example to create an instance using the builder pattern
Deprecated.
use
DeliveryPayload insteadEither
messages or changes must be set.SubscriptionDraftBuilder
Example to create an instance using the builder pattern
The health status of the Subscription that indicates whether messages are being delivered.
possible values of SubscriptionHealthStatus
PagedQueryResult with
results containing an array of Subscription.SubscriptionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Table of content
SubscriptionSetChangesAction
Example to create an instance using the builder pattern
SubscriptionSetChangesActionBuilder
Example to create an instance using the builder pattern
SubscriptionSetKeyAction
Example to create an instance using the builder pattern
SubscriptionSetKeyActionBuilder
Example to create an instance using the builder pattern
SubscriptionSetMessagesAction
Example to create an instance using the builder pattern
SubscriptionSetMessagesActionBuilder
Example to create an instance using the builder pattern
SubscriptionUpdate
Example to create an instance using the builder pattern
SubscriptionUpdateAction
Example to create a subtype instance using the builder pattern
SubscriptionUpdateActionBuilder
SubscriptionUpdateBuilder
Example to create an instance using the builder pattern
Suggestion
Example to create an instance using the builder pattern
SuggestionBuilder
Example to create an instance using the builder pattern
SuggestionResult
Example to create an instance using the builder pattern
SuggestionResultBuilder
Example to create an instance using the builder pattern
SuggestTokenizer
Example to create a subtype instance using the builder pattern
SuggestTokenizer
Example to create an instance using the builder pattern
The tokenizer defines the tokens that are used to match against the Suggest Query input.
SuggestTokenizerBuilder
SuggestTokenizerBuilder
Example to create an instance using the builder pattern
SuggestTokenizerBuilder
Contains synchronization activity information of the Order (like export or import).
SyncInfo
Example to create an instance using the builder pattern
SyncInfo
Example to create an instance using the builder pattern
SyncInfoBuilder
Example to create an instance using the builder pattern
SyncInfoBuilder
Example to create an instance using the builder pattern
SyncInfoBuilder
Example to create an instance using the builder pattern
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
SyntaxErrorErrorBuilder
Example to create an instance using the builder pattern
Determines in which Tax calculation mode taxed prices are calculated.
TaxCalculationMode
Maps to
Order.taxCalculationMode.possible values of TaxCalculationMode
possible values of TaxCalculationMode
possible values of TaxCalculationMode
TaxCategory
Example to create an instance using the builder pattern
TaxCategoryAddTaxRateAction
Example to create an instance using the builder pattern
TaxCategoryAddTaxRateActionBuilder
Example to create an instance using the builder pattern
TaxCategoryBuilder
Example to create an instance using the builder pattern
TaxCategoryChangeNameAction
Example to create an instance using the builder pattern
TaxCategoryChangeNameActionBuilder
Example to create an instance using the builder pattern
TaxCategoryDraft
Example to create an instance using the builder pattern
TaxCategoryDraftBuilder
Example to create an instance using the builder pattern
References a tax category by key.
TaxCategoryKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of TaxCategory.TaxCategoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a TaxCategory.
TaxCategoryReferenceBuilder
Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateAction
Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateActionBuilder
Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateAction
Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a TaxCategory.
TaxCategoryResourceIdentifierBuilder
Example to create an instance using the builder pattern
TaxCategorySetDescriptionAction
Example to create an instance using the builder pattern
TaxCategorySetDescriptionActionBuilder
Example to create an instance using the builder pattern
TaxCategorySetKeyAction
Example to create an instance using the builder pattern
TaxCategorySetKeyActionBuilder
Example to create an instance using the builder pattern
TaxCategoryUpdate
Example to create an instance using the builder pattern
TaxCategoryUpdateAction
Example to create a subtype instance using the builder pattern
TaxCategoryUpdateActionBuilder
TaxCategoryUpdateBuilder
Example to create an instance using the builder pattern
TaxedItemPrice
Example to create an instance using the builder pattern
TaxedItemPrice
Example to create an instance using the builder pattern
TaxedItemPriceBuilder
Example to create an instance using the builder pattern
TaxedItemPriceBuilder
Example to create an instance using the builder pattern
TaxedItemPriceDraft
Example to create an instance using the builder pattern
TaxedItemPriceDraftBuilder
Example to create an instance using the builder pattern
TaxedPrice
Example to create an instance using the builder pattern
TaxedPrice
Example to create an instance using the builder pattern
TaxedPrice
Example to create an instance using the builder pattern
TaxedPriceBuilder
Example to create an instance using the builder pattern
TaxedPriceBuilder
Example to create an instance using the builder pattern
TaxedPriceBuilder
Example to create an instance using the builder pattern
TaxedPriceDraft
Example to create an instance using the builder pattern
TaxedPriceDraftBuilder
Example to create an instance using the builder pattern
Indicates how taxes are set on the Cart.
TaxMode
Maps to
Order.taxModepossible values of TaxMode
possible values of TaxMode
possible values of TaxMode
The tax portions are calculated from the TaxRates.
TaxPortion
Example to create an instance using the builder pattern
TaxPortionBuilder
Example to create an instance using the builder pattern
TaxPortionBuilder
Example to create an instance using the builder pattern
Represents the portions that sum up to the
totalGross field of a TaxedPrice.TaxPortionDraftBuilder
Example to create an instance using the builder pattern
TaxRate
Example to create an instance using the builder pattern
Shape of the value for
addTaxRate and removeTaxRate actionsTaxRate
Example to create an instance using the builder pattern
TaxRateBuilder
Example to create an instance using the builder pattern
TaxRateBuilder
Example to create an instance using the builder pattern
TaxRateBuilder
Example to create an instance using the builder pattern
TaxRateDraft
Example to create an instance using the builder pattern
TaxRateDraftBuilder
Example to create an instance using the builder pattern
TermFacetResult
Example to create an instance using the builder pattern
TermFacetResultBuilder
Example to create an instance using the builder pattern
TermFacetResultType
possible values of TermFacetResultType
This type represents an attribute whose value is a string.
TextAttributeBuilder
Example to create an instance using the builder pattern
A text input hint is a string with one of the following values:
TextInputHint
TextInputHint
possible values of TextInputHint
possible values of TextInputHint
possible values of TextInputHint
TextLineItems are Line Items that use text values instead of references to Products.
TextLineItem
Example to create an instance using the builder pattern
TextLineItemBuilder
Example to create an instance using the builder pattern
TextLineItemBuilder
Example to create an instance using the builder pattern
TextLineItemDraft
Example to create an instance using the builder pattern
TextLineItemDraftBuilder
Example to create an instance using the builder pattern
TextLineItemValue
Example to create an instance using the builder pattern
TextLineItemValueBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of strings.
TextSetAttributeBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a time.
TimeAttributeBuilder
Example to create an instance using the builder pattern
A field with a time value.
TimeFieldBuilder
Example to create an instance using the builder pattern
This type represents an attribute whose value is a set of times.
TimeSetAttributeBuilder
Example to create an instance using the builder pattern
A field with a time set value.
TimeSetFieldBuilder
Example to create an instance using the builder pattern
Information that helps track a Parcel.
TrackingData
Example to create an instance using the builder pattern
TrackingData
Example to create an instance using the builder pattern
TrackingDataBuilder
Example to create an instance using the builder pattern
TrackingDataBuilder
Example to create an instance using the builder pattern
TrackingDataBuilder
Example to create an instance using the builder pattern
Represents a financial transaction typically created as a result of a notification from the payment service.
Transaction
Example to create an instance using the builder pattern
TransactionBuilder
Example to create an instance using the builder pattern
TransactionBuilder
Example to create an instance using the builder pattern
TransactionChangeValue
Example to create an instance using the builder pattern
TransactionChangeValueBuilder
Example to create an instance using the builder pattern
TransactionDraft
Example to create an instance using the builder pattern
TransactionDraftBuilder
Example to create an instance using the builder pattern
Transactions can be in one of the following States:
TransactionState
possible values of TransactionState
possible values of TransactionState
TransactionType
TransactionType
possible values of TransactionType
possible values of TransactionType
Change triggered by the following update actions:
TransitionCustomLineItemStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
TransitionLineItemStateChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
TransitionStateChangeBuilder
Example to create an instance using the builder pattern
Type
Example to create an instance using the builder pattern
Adds a value to an EnumType.
TypeAddEnumValueActionBuilder
Example to create an instance using the builder pattern
Defines a new field for a Type.
TypeAddFieldDefinitionActionBuilder
Example to create an instance using the builder pattern
Adds a value to a LocalizedEnumType.
TypeAddLocalizedEnumValueActionBuilder
Example to create an instance using the builder pattern
TypeBuilder
Example to create an instance using the builder pattern
Changes the
label of an EnumValue of an EnumType FieldDefinition.TypeChangeEnumValueLabelActionBuilder
Example to create an instance using the builder pattern
Changes the order of EnumValues in an EnumType FieldDefinition.
TypeChangeEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderAction
Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderActionBuilder
Example to create an instance using the builder pattern
Changes the
inputHint of CustomFieldStringType FieldDefinition, a CustomFieldLocalizedStringType FieldDefinition, and CustomFieldSetType FieldDefinition of these string-based FieldTypes.TypeChangeInputHintActionBuilder
Example to create an instance using the builder pattern
TypeChangeKeyAction
Example to create an instance using the builder pattern
TypeChangeKeyActionBuilder
Example to create an instance using the builder pattern
TypeChangeLabelAction
Example to create an instance using the builder pattern
TypeChangeLabelActionBuilder
Example to create an instance using the builder pattern
Changes the
label of a LocalizedEnumValue of a LocalizedEnumType FieldDefinition.TypeChangeLocalizedEnumValueLabelActionBuilder
Example to create an instance using the builder pattern
Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition.
TypeChangeLocalizedEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
TypeChangeNameAction
Example to create an instance using the builder pattern
TypeChangeNameActionBuilder
Example to create an instance using the builder pattern
Base polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents.
TypedMoney
Example to create a subtype instance using the builder pattern
TypedMoneyBuilder
TypedMoneyBuilder
Base polymorphic money type containing common fields for Money and HighPrecisionMoneyDraft.
TypedMoneyDraftBuilder
TypeDraft
Example to create an instance using the builder pattern
TypeDraftBuilder
Example to create an instance using the builder pattern
The data representation for a Type to be imported that is persisted as a Type in the Project.
TypeImportBuilder
Example to create an instance using the builder pattern
The request body to import Types.
TypeImportRequestBuilder
Example to create an instance using the builder pattern
References a type by key.
TypeKeyReferenceBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Types.TypePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Reference to a Type.
TypeReferenceBuilder
Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionAction
Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of a Type.
TypeResourceIdentifierBuilder
Example to create an instance using the builder pattern
TypeSetDescriptionAction
Example to create an instance using the builder pattern
TypeSetDescriptionActionBuilder
Example to create an instance using the builder pattern
Provides a visual representation type for this field.
Provides a visual representation type for this field.
possible values of TypeTextInputHint
possible values of TypeTextInputHint
TypeUpdate
Example to create an instance using the builder pattern
TypeUpdateAction
Example to create a subtype instance using the builder pattern
TypeUpdateActionBuilder
TypeUpdateBuilder
Example to create an instance using the builder pattern
Change triggered when the format of changes on an entity is not identified by Audit Log.
UnknownChangeBuilder
Example to create an instance using the builder pattern
Change triggered by the Unpublish update action.
UnpublishChangeBuilder
Example to create an instance using the builder pattern
UnresolvedReferences
Example to create an instance using the builder pattern
UnresolvedReferencesBuilder
Example to create an instance using the builder pattern
Update
Example to create an instance using the builder pattern
UpdateAction
Example to create an instance using the builder pattern
UpdateActionBuilder
Example to create an instance using the builder pattern
UpdateBuilder
Example to create an instance using the builder pattern
Change triggered by the following update actions:
UpdateSyncInfoChangeBuilder
Example to create an instance using the builder pattern
UpdateType
possible values of UpdateType
Middleware to add a user agent string as header to a request
User-provided identifiers present on the resource for which the Message is created.
UserProvidedIdentifiersBuilder
Example to create an instance using the builder pattern
Table of content
- Using SDK
- Models and Builders
- Request DSL
ValidFromAndUntilValue
Example to create an instance using the builder pattern
ValidFromAndUntilValueBuilder
Example to create an instance using the builder pattern
Variant
Example to create an instance using the builder pattern
VariantBuilder
Example to create an instance using the builder pattern
VariantValues
Example to create an instance using the builder pattern
VariantValues
Example to create an instance using the builder pattern
VariantValuesBuilder
Example to create an instance using the builder pattern
VariantValuesBuilder
Example to create an instance using the builder pattern
Change triggered by a Customer email verification.
VerifyEmailChangeBuilder
Example to create an instance using the builder pattern
VersionedTrait
Wrapper interface for a HTTP client
Creates tokens by splitting the
text field in SearchKeyword by whitespaces.WhitespaceTokenizer
Example to create an instance using the builder pattern
WhitespaceTokenizerBuilder
Example to create an instance using the builder pattern
WhitespaceTokenizerBuilder
Example to create an instance using the builder pattern
an object with a localized Slug
Zone
Example to create an instance using the builder pattern
ZoneAddLocationAction
Example to create an instance using the builder pattern
ZoneAddLocationActionBuilder
Example to create an instance using the builder pattern
ZoneBuilder
Example to create an instance using the builder pattern
ZoneChangeNameAction
Example to create an instance using the builder pattern
ZoneChangeNameActionBuilder
Example to create an instance using the builder pattern
Deserializer converting string to
ZonedDateTimeserializes a
ZonedDateTime to DateTimeFormatter.ISO_DATE formatZoneDraft
Example to create an instance using the builder pattern
ZoneDraftBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Zone.ZonePagedQueryResponseBuilder
Example to create an instance using the builder pattern
Defines shipping rates in different currencies for a specific Zone.
ZoneRateBuilder
Example to create an instance using the builder pattern
ZoneRateDraft
Example to create an instance using the builder pattern
ZoneRateDraftBuilder
Example to create an instance using the builder pattern
Reference to a Zone.
ZoneReferenceBuilder
Example to create an instance using the builder pattern
ZoneRemoveLocationAction
Example to create an instance using the builder pattern
ZoneRemoveLocationActionBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Zone.
ZoneResourceIdentifierBuilder
Example to create an instance using the builder pattern
ZoneSetDescriptionAction
Example to create an instance using the builder pattern
ZoneSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ZoneSetKeyAction
Example to create an instance using the builder pattern
ZoneSetKeyActionBuilder
Example to create an instance using the builder pattern
ZoneUpdate
Example to create an instance using the builder pattern
ZoneUpdateAction
Example to create a subtype instance using the builder pattern
ZoneUpdateActionBuilder
ZoneUpdateBuilder
Example to create an instance using the builder pattern
AttributeAccessorinstead