All Classes and Interfaces
Class
Description
Address type returned by read methods.
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
Address type to be used on write methods.
Address type returned by read methods.
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
Returned when the anonymous ID is being used by another resource.
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
ApiClientDraft
ApiClient
PagedQueryResult with
results containing an array of APIClient.ApiClientPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of APIClient.CorrelationIdProvider which adds the project key as prefixCreates 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
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
ApprovalFlowApproval
This update action allows an Associate to approve an Approval Flow.
ApprovalFlowApproveActionBuilder
Example to create an instance using the builder pattern
This update action allows an Associate to approve an Approval Flow.
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.
Generated after an approval in the Approval Flow.
ApprovalFlowApprovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after an approval in the Approval Flow.
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.
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 completed and reaches a final status.
Generated after an Approval Flow is created.
ApprovalFlowCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is created.
Generated after an Approval Flow is created.
ApprovalFlowCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is created.
ApprovalFlow
PagedQueryResult with results containing an array of ApprovalFlow.
ApprovalFlowPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ApprovalFlow.
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
This update action allows an Associate to reject an Approval Flow, setting its status to
Rejected.Generated after an Approval Flow is rejected.
ApprovalFlowRejectedMessageBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is rejected.
Generated after an Approval Flow is rejected.
ApprovalFlowRejectedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after an Approval Flow is rejected.
ApprovalFlowRejection
Example to create an instance using the builder pattern
ApprovalFlowRejectionBuilder
Example to create an instance using the builder pattern
ApprovalFlowRejection
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
ApprovalFlowUpdateAction
ApprovalFlowUpdateBuilder
Example to create an instance using the builder pattern
ApprovalFlowUpdate
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.
Generated after a successful Set Approvers update action.
ApprovalRuleApproversSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Approvers update action.
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.
Generated after an Approval Rule is created.
ApprovalRuleCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after an Approval Rule is created.
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.
Generated after a successful Set Description update action.
ApprovalRuleDescriptionSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Description update action.
ApprovalRuleDraft
Example to create an instance using the builder pattern
ApprovalRuleDraftBuilder
Example to create an instance using the builder pattern
ApprovalRuleDraft
ApprovalRule
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.
Generated after a successful Set Key update action.
ApprovalRuleKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
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.
Generated after a successful Set Name update action.
ApprovalRuleNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
PagedQueryResult with results containing an array of ApprovalRule.
ApprovalRulePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ApprovalRule.
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.
Generated after a successful Set Predicate update action.
ApprovalRulePredicateSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Predicate update action.
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.
Generated after a successful Set Requester update action.
ApprovalRuleRequestersSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Requester update action.
Setting the approvers for an Approval Rule generates an ApprovalRuleApproversSet Message.
ApprovalRuleSetApproversActionBuilder
Example to create an instance using the builder pattern
Setting the approvers for an Approval Rule generates an ApprovalRuleApproversSet Message.
Setting the description for an Approval Rule generates an ApprovalRuleDescriptionSet Message.
ApprovalRuleSetDescriptionActionBuilder
Example to create an instance using the builder pattern
Setting the description for an Approval Rule generates an ApprovalRuleDescriptionSet Message.
Setting the key for an Approval Rule generates an ApprovalRuleKeySet Message.
ApprovalRuleSetKeyActionBuilder
Example to create an instance using the builder pattern
Setting the key for an Approval Rule generates an ApprovalRuleKeySet Message.
Setting the name for an Approval Rule generates an ApprovalRuleNameSet Message.
ApprovalRuleSetNameActionBuilder
Example to create an instance using the builder pattern
Setting the name for an Approval Rule generates an ApprovalRuleNameSet Message.
Setting the Order Predicate for an Approval Rule generates an ApprovalRulePredicateSet Message.
ApprovalRuleSetPredicateActionBuilder
Example to create an instance using the builder pattern
Setting the Order Predicate for an Approval Rule generates an ApprovalRulePredicateSet Message.
Sets the requesters for an Approval Rule generates an ApprovalRuleRequestersSet Message.
ApprovalRuleSetRequestersActionBuilder
Example to create an instance using the builder pattern
Sets the requesters for an Approval Rule generates an ApprovalRuleRequestersSet Message.
Setting the status for an Approval Rule generates an ApprovalRuleStatusSet Message.
ApprovalRuleSetStatusActionBuilder
Example to create an instance using the builder pattern
Setting the status for an Approval Rule generates an ApprovalRuleStatusSet Message.
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.
Generated after a successful Set Status update action.
ApprovalRuleStatusSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Status update action.
ApprovalRuleUpdate
Example to create an instance using the builder pattern
ApprovalRuleUpdateAction
Example to create a subtype instance using the builder pattern
ApprovalRuleUpdateActionBuilder
ApprovalRuleUpdateAction
ApprovalRuleUpdateBuilder
Example to create an instance using the builder pattern
ApprovalRuleUpdate
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
ApproverConjunctionDraft
ApproverConjunction
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
ApproverDisjunctionDraft
ApproverDisjunction
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
Describes the sequence in which Associates can approve an Order.
Describes the order in which Associates can approve the matched Order.
Asset
Example to create an instance using the builder pattern
AssetBuilder
Example to create an instance using the builder pattern
Dimensions of the Asset source specified by the number of pixels.
AssetDimensionsBuilder
Example to create an instance using the builder pattern
Dimensions of the Asset source specified by the number of pixels.
AssetDraft
Example to create an instance using the builder pattern
AssetDraftBuilder
Example to create an instance using the builder pattern
AssetDraft
Asset
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
Representation of an Asset in a specific format, for example a video in a certain encoding, or an image in a certain resolution.
AssignedProductReference
Example to create an instance using the builder pattern
AssignedProductReferenceBuilder
Example to create an instance using the builder pattern
AssignedProductReference
AssignedProductSelection
Example to create an instance using the builder pattern
AssignedProductSelectionBuilder
Example to create an instance using the builder pattern
AssignedProductSelection
PagedQueryResult containing an array of AssignedProductSelection.
AssignedProductSelectionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductSelection.
Associate
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
AssociateDraft
Associate
Returned when an Associate is missing a Permission on a B2B resource.
AssociateMissingPermissionErrorBuilder
Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
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
Adding a Permission to an AssociateRole generates an AssociateRolePermissionAdded Message.
AssociateRoleAssignment
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
AssociateRoleAssignmentDraft
AssociateRoleAssignment
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.
Generated after a successful Change BuyerAssignable update action.
AssociateRoleBuyerAssignableChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change BuyerAssignable update action.
Changing the
buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.AssociateRoleChangeBuyerAssignableActionBuilder
Example to create an instance using the builder pattern
Changing the
buyerAssignable value of an AssociateRole generates an AssociateRoleBuyerAssignableChanged Message.Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
Generated after a successful Create AssociateRole request.
AssociateRoleCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create AssociateRole request.
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
Generated after a successful Delete AssociateRole request.
AssociateRoleDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete AssociateRole request.
AssociateRoleDraft
Example to create an instance using the builder pattern
AssociateRoleDraftBuilder
Example to create an instance using the builder pattern
AssociateRoleDraft
AssociateRole
Determines whether an AssociateRoleAssignment can be inherited by child Business Units.
possible values of AssociateRoleInheritanceMode
Reference to an AssociateRole by its key.
AssociateRoleKeyReferenceBuilder
Example to create an instance using the builder pattern
Reference to an AssociateRole by its key.
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.
Generated after a successful Set Name update action.
AssociateRoleNameChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
PagedQueryResult with results containing an array of AssociateRole.
AssociateRolePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of AssociateRole.
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.
Generated after a successful Add Permissions update action.
AssociateRolePermissionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Permissions update action.
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.
Generated after a successful Remove Permissions update action.
AssociateRolePermissionRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Permissions update action.
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.
Generated after a successful Set Permissions update action.
AssociateRolePermissionsSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Permissions update action.
Reference to an AssociateRole.
AssociateRoleReferenceBuilder
Example to create an instance using the builder pattern
Reference to an AssociateRole.
Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
AssociateRoleRemovePermissionActionBuilder
Example to create an instance using the builder pattern
Removing a Permission from an AssociateRole generates an AssociateRolePermissionRemoved Message.
ResourceIdentifier of an AssociateRole.
AssociateRoleResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of an AssociateRole.
AssociateRoleSetCustomFieldAction
Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
AssociateRoleSetCustomFieldAction
AssociateRoleSetCustomTypeAction
Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
AssociateRoleSetCustomTypeAction
Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
AssociateRoleSetNameActionBuilder
Example to create an instance using the builder pattern
Updating the name of an AssociateRole generates an AssociateRoleNameSet Message.
Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
AssociateRoleSetPermissionsActionBuilder
Example to create an instance using the builder pattern
Updating the Permissions on an AssociateRole generates an AssociateRolePermissionsSet Message.
AssociateRoleUpdate
Example to create an instance using the builder pattern
AssociateRoleUpdateAction
Example to create a subtype instance using the builder pattern
AssociateRoleUpdateActionBuilder
AssociateRoleUpdateAction
AssociateRoleUpdateBuilder
Example to create an instance using the builder pattern
AssociateRoleUpdate
Attribute
Example to create an instance using the builder pattern
Accessor for retrieving type safe attribute values
Deprecated.
Attribute type for Boolean values.
AttributeBooleanTypeBuilder
Example to create an instance using the builder pattern
Attribute type for Boolean values.
AttributeBuilder
Example to create an instance using the builder pattern
Specifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product:
possible values of AttributeConstraintEnum
AttributeConstraintEnumDraft
possible values of AttributeConstraintEnumDraft
AttributeDateTimeType
Example to create an instance using the builder pattern
AttributeDateTimeTypeBuilder
Example to create an instance using the builder pattern
AttributeDateTimeType
AttributeDateType
Example to create an instance using the builder pattern
AttributeDateTypeBuilder
Example to create an instance using the builder pattern
AttributeDateType
Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
Returned when the
name of the AttributeDefinition conflicts with an existing Attribute.AttributeDefinitionAlreadyExistsErrorBuilder
Example to create an instance using the builder pattern
Returned when the
name of the AttributeDefinition conflicts with an existing Attribute.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
Specify the Attribute to be created with the ProductTypeDraft.
Describes a Product Attribute and allows you to define meta-information associated with the Attribute (like whether it should be searchable, or its constraints).
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
Returned when the
type is different for an AttributeDefinition using the same name in multiple Product Types.Attribute type for plain enum values.
AttributeEnumTypeBuilder
Example to create an instance using the builder pattern
Attribute type for plain enum values.
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
AttributeGroupAddAttributeAction
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
AttributeGroupChangeNameAction
AttributeGroupDraft
Example to create an instance using the builder pattern
AttributeGroupDraftBuilder
Example to create an instance using the builder pattern
AttributeGroupDraft
AttributeGroup
PagedQueryResult with
results containing an array of AttributeGroup.AttributeGroupPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of AttributeGroup.Reference to an AttributeGroup.
AttributeGroupReferenceBuilder
Example to create an instance using the builder pattern
Reference to an AttributeGroup.
AttributeGroupRemoveAttributeAction
Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeActionBuilder
Example to create an instance using the builder pattern
AttributeGroupRemoveAttributeAction
ResourceIdentifier to an AttributeGroup.
AttributeGroupResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an AttributeGroup.
AttributeGroupSetAttributesAction
Example to create an instance using the builder pattern
AttributeGroupSetAttributesActionBuilder
Example to create an instance using the builder pattern
AttributeGroupSetAttributesAction
AttributeGroupSetDescriptionAction
Example to create an instance using the builder pattern
AttributeGroupSetDescriptionActionBuilder
Example to create an instance using the builder pattern
AttributeGroupSetDescriptionAction
AttributeGroupSetKeyAction
Example to create an instance using the builder pattern
AttributeGroupSetKeyActionBuilder
Example to create an instance using the builder pattern
AttributeGroupSetKeyAction
AttributeGroupUpdate
Example to create an instance using the builder pattern
AttributeGroupUpdateAction
Example to create a subtype instance using the builder pattern
AttributeGroupUpdateActionBuilder
AttributeGroupUpdateAction
AttributeGroupUpdateBuilder
Example to create an instance using the builder pattern
AttributeGroupUpdate
Attribute
Attribute type for LocalizedString values.
AttributeLocalizableTextTypeBuilder
Example to create an instance using the builder pattern
Attribute type for LocalizedString values.
Attribute type for localized enum values.
AttributeLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
Attribute type for localized enum values.
A localized enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributeLocalizedEnumValueBuilder
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.
AttributeMoneyType
Example to create an instance using the builder pattern
AttributeMoneyTypeBuilder
Example to create an instance using the builder pattern
AttributeMoneyType
Returned when an AttributeDefinition does not exist for an Attribute
name.AttributeNameDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute
name.Attribute type for nesting Attributes based on some existing ProductType.
AttributeNestedTypeBuilder
Example to create an instance using the builder pattern
Attribute type for nesting Attributes based on some existing ProductType.
AttributeNumberType
Example to create an instance using the builder pattern
AttributeNumberTypeBuilder
Example to create an instance using the builder pattern
AttributeNumberType
A plain enum value must be unique within the enum, else a DuplicateEnumValues error is returned.
AttributePlainEnumValueBuilder
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.
AttributeReference
Example to create an instance using the builder pattern
AttributeReferenceBuilder
Example to create an instance using the builder pattern
AttributeReference
AttributeReferenceType
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
AttributeReferenceType
Accessor to retrieve attribute values type safe
AttributeType that defines a set (without duplicate elements) with values of the given
elementType.AttributeSetTypeBuilder
Example to create an instance using the builder pattern
AttributeType that defines a set (without duplicate elements) with values of the given
elementType.Attribute type for plain text values.
AttributeTextTypeBuilder
Example to create an instance using the builder pattern
Attribute type for plain text values.
AttributeTimeType
Example to create an instance using the builder pattern
AttributeTimeTypeBuilder
Example to create an instance using the builder pattern
AttributeTimeType
Umbrella type for specific attribute types discriminated by property
name.AttributeTypeBuilder
Umbrella type for specific attribute types discriminated by property
name.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
Represents errors related to authentication and authorization in a format conforming to the OAuth 2.0 specification.
The
Authorization header will be set to the content of headerValue.AuthorizationHeaderAuthenticationBuilder
Example to create an instance using the builder pattern
The
Authorization header will be set to the content of headerValue.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
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.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
Azure Event Grid can be used to push messages to Azure Functions, HTTP endpoints (webhooks), and several other Azure tools.
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
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.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
Azure Service Bus can be used as a pull-queue with Queues, or to fan-out messages with Topics and Subscriptions.
Returned when a server-side problem is caused by scaling infrastructure resources.
BadGatewayErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
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
Polymorphic base type that represents a postal address and contact details.
BaseResource
Example to create an instance using the builder pattern
BaseResource
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 address to a Business Unit generates a BusinessUnitAddressAdded Message.
Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.
BusinessUnitAddAssociateActionBuilder
Example to create an instance using the builder pattern
Adding an Associate to a Business Unit generates a BusinessUnitAssociateAdded Message.
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
BusinessUnitAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
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.
Generated after a successful Add Address update action.
BusinessUnitAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
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.
Generated after a successful Change Address update action.
BusinessUnitAddressChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
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.
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 adding a Custom Field to an address of a Business Unit using the Set Address CustomField update action.
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.
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 changing an existing Custom Field on an address of a Business Unit using the Set Address CustomField update action.
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.
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 Field from an address of a Business Unit using the Set Address CustomField update action.
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.
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 removing a Custom Type from an address of a Business Unit using the Set Custom Type in Address update action.
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.
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 adding a Custom Type to an address of a Business Unit using the Set Custom Type in Address update action.
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.
Generated after a successful Remove Address update action.
BusinessUnitAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
BusinessUnitAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message.
BusinessUnitAddStoreActionBuilder
Example to create an instance using the builder pattern
Adding a Store to a Business Unit generates a BusinessUnitStoreAdded Message.
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.
Generated after a successful Add Associate update action.
BusinessUnitAssociateAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Associate update action.
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.
Generated after a successful Change Associate update action.
BusinessUnitAssociateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Associate update action.
Determines whether a Business Unit can inherit Associates from a parent.
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.
Generated after a successful Change Associate Mode update action.
BusinessUnitAssociateModeChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Associate Mode update action.
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.
Generated after a successful Remove Associate update action.
BusinessUnitAssociateRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Associate update action.
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.
Generated after a successful Set Associates update action.
BusinessUnitAssociatesSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Associates update action.
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.
Generated after a successful Add Billing Address Identifier update action.
BusinessUnitBillingAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Billing Address Identifier update action.
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.
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBillingAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Billing Address Identifier update action.
BusinessUnitBuilder
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
BusinessUnitChangeAddressActionBuilder
Example to create an instance using the builder pattern
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
BusinessUnitChangeAssociateActionBuilder
Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
Only Business Units of type
Division can be changed to ExplicitAndFromParent.BusinessUnitChangeAssociateModeActionBuilder
Example to create an instance using the builder pattern
Only Business Units of type
Division can be changed to ExplicitAndFromParent.Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
BusinessUnitChangeNameActionBuilder
Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
BusinessUnitChangeParentUnitActionBuilder
Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.
BusinessUnitChangeStatusActionBuilder
Example to create an instance using the builder pattern
Changing the status of a Business Unit generates a BusinessUnitStatusChanged Message.
BusinessUnitConfiguration
Example to create an instance using the builder pattern
BusinessUnitConfigurationBuilder
Example to create an instance using the builder pattern
BusinessUnitConfiguration
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.
Generated after a successful Set Contact Email update action.
BusinessUnitContactEmailSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Contact Email update action.
Generated after a successful Create BusinessUnit request.
BusinessUnitCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create BusinessUnit request.
Generated after a successful Create BusinessUnit request.
BusinessUnitCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create BusinessUnit request.
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.
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 adding a Custom Field to a Business Unit using the Set CustomField update action.
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.
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 changing an existing Custom Field on a Business Unit using the Set CustomField update action.
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.
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 Field from a Business Unit using the Set CustomField update action.
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.
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 removing a Custom Type from a Business Unit using the Set Custom Type update action.
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.
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 adding a Custom Type to a Business Unit using the Set Custom Type update action.
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.
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 Billing Address update action.
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.
Generated after a successful Set Default Shipping Address update action.
BusinessUnitDefaultShippingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Default Shipping Address update action.
Generated after a successful Delete BusinessUnit request.
BusinessUnitDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete BusinessUnit request.
Generated after a successful Delete BusinessUnit request.
BusinessUnitDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete BusinessUnit request.
Generic draft type to model those fields all Business Units have in common.
BusinessUnitDraftBuilder
Generic draft type to model those fields all Business Units have in common.
Generic type to model the fields that all types of Business Units have in common.
Reference to a BusinessUnit by its key.
BusinessUnitKeyReferenceBuilder
Example to create an instance using the builder pattern
Reference to a BusinessUnit by its key.
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.
Generated after a successful Change Name update action.
BusinessUnitNameChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Name update action.
PagedQueryResult with results containing an array of BusinessUnit.
BusinessUnitPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of BusinessUnit.
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.
Generated after a successful Change Parent Unit update action.
BusinessUnitParentChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Parent Unit update action.
Reference to a BusinessUnit.
BusinessUnitReferenceBuilder
Example to create an instance using the builder pattern
Reference to a BusinessUnit.
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
BusinessUnitRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
BusinessUnitRemoveAssociateActionBuilder
Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
BusinessUnitRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
BusinessUnitRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
Removes a Store from the Business Unit.
BusinessUnitRemoveStoreActionBuilder
Example to create an instance using the builder pattern
Removes a Store from the Business Unit.
ResourceIdentifier to a BusinessUnit.
BusinessUnitResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a BusinessUnit.
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 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.
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
Adding or updating a Custom Type on an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.
Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.
BusinessUnitSetAssociatesActionBuilder
Example to create an instance using the builder pattern
Changes the Associates of a Business Unit, generates a BusinessUnitAssociatesSet Message.
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
BusinessUnitSetContactEmailActionBuilder
Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
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 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.
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
Adding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.
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 billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
BusinessUnitSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
Only Business Units of type
Division can be have a store mode of FromParent.BusinessUnitSetStoreModeActionBuilder
Example to create an instance using the builder pattern
Only Business Units of type
Division can be have a store mode of FromParent.Sets the Stores of the Business Unit.
BusinessUnitSetStoresActionBuilder
Example to create an instance using the builder pattern
Sets the Stores of the Business Unit.
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.
Generated after a successful Add Shipping Address Identifier update action.
BusinessUnitShippingAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Shipping Address Identifier update action.
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.
Generated after a successful Remove Shipping Address Identifier update action.
BusinessUnitShippingAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Shipping Address Identifier update action.
Indicates whether the Business Unit can be edited and used in Carts, Orders, Quote Requests, or Quotes.
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.
Generated after a successful Change Status update action.
BusinessUnitStatusChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Status update action.
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.
Generated after a successful Add Store update action.
BusinessUnitStoreAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Store update action.
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
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.
Generated after a successful Set Store Mode update action.
BusinessUnitStoreModeChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Store Mode update action.
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.
Generated after a successful Remove Store update action.
BusinessUnitStoreRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Store update action.
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.
Generated after a successful Set Stores update action.
BusinessUnitStoresSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Stores update action.
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
BusinessUnitUpdateAction
BusinessUnitUpdateBuilder
Example to create an instance using the builder pattern
BusinessUnitUpdate
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.Checks if a CartDiscount exists for a given
id.Checks if a CartDiscount exists for a given Query Predicate.
Checks if a CartDiscount exists for a given
key.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.
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.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.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.
Deleting a Customer produces the CustomerDeleted Message.
Checks if a Customer exists for a given
key.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.
Deprecated scope:
manage_orders:{projectKey}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.
Deprecated scope:
manage_orders:{projectKey}Deprecated scope:
manage_orders:{projectKey}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.Execute a GraphQL query
Execute a GraphQL query
Checks if a Project exists for a given
projectKey.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 from 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 from the specified Store.
Checks if the current or staged representations of a Product exists for a given
key in the specified Store.Queries Product Selection assignments in a specific Store.
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.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.
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.
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.
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.
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.
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 representation of the new Product in the master catalog.
To create a new Product, send a representation that is going to become the initial staged representation of the new Product in the master catalog.
Checks if a ProductType exists for a given
id.Checks if a ProductType exists for a given Query Predicate.
Checks if a ProductType exists for a given
key.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.
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.
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
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.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
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.Adds a DiscountCode to the Cart to activate the related Cart Discounts.
CartAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
Adds an address to a Cart when shipping to multiple addresses is desired.
CartAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
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
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.
CartAddPaymentAction
Example to create an instance using the builder pattern
CartAddPaymentActionBuilder
Example to create an instance using the builder pattern
CartAddPaymentAction
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 a Shipping Method for a specified shipping address to a Cart with
Multiple ShippingMode.Adds all LineItems of a ShoppingList to the Cart.
CartAddShoppingListActionBuilder
Example to create an instance using the builder pattern
Adds all LineItems of a ShoppingList to the Cart.
CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction
Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction
To override the shipping details, see Set LineItem ShippingDetails.
CartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
To override the shipping details, see Set LineItem ShippingDetails.
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
CartChangeCustomLineItemMoneyAction
CartChangeCustomLineItemPriceModeAction
Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeActionBuilder
Example to create an instance using the builder pattern
CartChangeCustomLineItemPriceModeAction
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 Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
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
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
Changing the tax calculation mode leads to recalculation of taxes.
CartChangeTaxCalculationModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax calculation mode leads to recalculation of taxes.
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
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.
Changing the tax rounding mode leads to recalculation of taxes.
CartChangeTaxRoundingModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax rounding mode leads to recalculation of taxes.
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example,
Light, Medium, or Heavy).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).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
Used when the ShippingRate maps to an abstract Cart categorization expressed by strings (for example,
Light, Medium, or Heavy).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
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
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
CartDiscountChangeCartPredicateAction
CartDiscountChangeIsActiveAction
Example to create an instance using the builder pattern
CartDiscountChangeIsActiveActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeIsActiveAction
CartDiscountChangeNameAction
Example to create an instance using the builder pattern
CartDiscountChangeNameActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeNameAction
CartDiscountChangeRequiresDiscountCodeAction
Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeRequiresDiscountCodeAction
CartDiscountChangeSortOrderAction
Example to create an instance using the builder pattern
CartDiscountChangeSortOrderActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeSortOrderAction
CartDiscountChangeStackingModeAction
Example to create an instance using the builder pattern
CartDiscountChangeStackingModeActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeStackingModeAction
CartDiscountChangeTargetAction
Example to create an instance using the builder pattern
CartDiscountChangeTargetActionBuilder
Example to create an instance using the builder pattern
CartDiscountChangeTargetAction
Changes the CartDiscountValue for relative, absolute and fixed price CartDiscounts.
CartDiscountChangeValueActionBuilder
Example to create an instance using the builder pattern
Changes the CartDiscountValue for relative, absolute and fixed price CartDiscounts.
Discount is applied to CustomLineItems matching the
predicate.CartDiscountCustomLineItemsTargetBuilder
Example to create an instance using the builder pattern
Discount is applied to CustomLineItems matching the
predicate.CartDiscountDraft
Example to create an instance using the builder pattern
CartDiscountDraftBuilder
Example to create an instance using the builder pattern
CartDiscountDraft
CartDiscount
Discount is applied to LineItems matching the
predicate.CartDiscountLineItemsTargetBuilder
Example to create an instance using the builder pattern
Discount is applied to LineItems matching the
predicate.PagedQueryResult with
results containing an array of CartDiscount.CartDiscountPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CartDiscount.Reference to a CartDiscount.
CartDiscountReferenceBuilder
Example to create an instance using the builder pattern
Reference to a CartDiscount.
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountRemoveStoreActionBuilder
Example to create an instance using the builder pattern
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
ResourceIdentifier to a CartDiscount.
CartDiscountResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a CartDiscount.
CartDiscountSetCustomFieldAction
Example to create an instance using the builder pattern
CartDiscountSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetCustomFieldAction
CartDiscountSetCustomTypeAction
Example to create an instance using the builder pattern
CartDiscountSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetCustomTypeAction
CartDiscountSetDescriptionAction
Example to create an instance using the builder pattern
CartDiscountSetDescriptionActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetDescriptionAction
CartDiscountSetKeyAction
Example to create an instance using the builder pattern
CartDiscountSetKeyActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetKeyAction
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountSetStoresActionBuilder
Example to create an instance using the builder pattern
If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.
CartDiscountSetValidFromAction
Example to create an instance using the builder pattern
CartDiscountSetValidFromActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidFromAction
CartDiscountSetValidFromAndUntilAction
Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidFromAndUntilAction
CartDiscountSetValidUntilAction
Example to create an instance using the builder pattern
CartDiscountSetValidUntilActionBuilder
Example to create an instance using the builder pattern
CartDiscountSetValidUntilAction
Discount is applied to the shipping costs of the Cart.
CartDiscountShippingCostTargetBuilder
Example to create an instance using the builder pattern
Discount is applied to the shipping costs of the Cart.
CartDiscountTarget
Example to create a subtype instance using the builder pattern
CartDiscountTargetBuilder
CartDiscountTarget
Discount is applied to the total price of the Cart.
CartDiscountTotalPriceTargetBuilder
Example to create an instance using the builder pattern
Discount is applied to the total price of the Cart.
CartDiscountUpdate
Example to create an instance using the builder pattern
CartDiscountUpdateAction
Example to create a subtype instance using the builder pattern
CartDiscountUpdateActionBuilder
CartDiscountUpdateAction
CartDiscountUpdateBuilder
Example to create an instance using the builder pattern
CartDiscountUpdate
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
CartDiscountValueAbsoluteDraft
Discounts the CartDiscountTarget by an absolute amount (not allowed for MultiBuyLineItemsTarget and MultiBuyCustomLineItemsTarget).
CartDiscountValueBuilder
CartDiscountValueDraft
Example to create a subtype instance using the builder pattern
CartDiscountValueDraftBuilder
CartDiscountValueDraft
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
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.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.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
Can only be used in a CartDiscountDraft with no
target specified.CartDiscountValueGiftLineItem
CartDiscountValue
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
CartDiscountValueRelativeDraft
Discounts the CartDiscountTarget relative to its price.
CartDraft
Example to create an instance using the builder pattern
CartDraftBuilder
Example to create an instance using the builder pattern
CartDraft
Changes the CartState from
Active to Frozen.CartFreezeCartActionBuilder
Example to create an instance using the builder pattern
Changes the CartState from
Active to Frozen.Cart
Indicates who created the Cart.
possible values of CartOrigin
PagedQueryResult with results containing an array of Cart.
CartPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Cart.
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
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.
Reference to a Cart.
CartReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Cart.
This update action does not support specifying quantities, unlike the Remove LineItem update action.
CartRemoveCustomLineItemActionBuilder
Example to create an instance using the builder pattern
This update action does not support specifying quantities, unlike the Remove LineItem update action.
CartRemoveDiscountCodeAction
Example to create an instance using the builder pattern
CartRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
CartRemoveDiscountCodeAction
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
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
The LineItem price is updated as described in LineItem Price selection.
CartRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
CartRemovePaymentAction
Example to create an instance using the builder pattern
CartRemovePaymentActionBuilder
Example to create an instance using the builder pattern
CartRemovePaymentAction
Removes a Shipping Method from a Cart that has the
Multiple ShippingMode.CartRemoveShippingMethodActionBuilder
Example to create an instance using the builder pattern
Removes a Shipping Method from a Cart that has the
Multiple ShippingMode.ResourceIdentifier to a Cart.
CartResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Cart.
CartsConfiguration
Example to create an instance using the builder pattern
CartsConfigurationBuilder
Example to create an instance using the builder pattern
CartsConfiguration
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).
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
Used when the ShippingRate maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
CartSetAnonymousIdAction
Example to create an instance using the builder pattern
CartSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
CartSetAnonymousIdAction
CartSetBillingAddressAction
Example to create an instance using the builder pattern
CartSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressAction
CartSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressCustomFieldAction
CartSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetBillingAddressCustomTypeAction
Updates the Business Unit on the Cart.
CartSetBusinessUnitActionBuilder
Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
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
This update action results in the
taxedPrice field being added to the Cart when the ExternalAmount TaxMode is used.Setting the country can lead to changes in the LineItem prices.
CartSetCountryActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
CartSetCustomerEmailAction
Example to create an instance using the builder pattern
CartSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
CartSetCustomerEmailAction
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
This update action can only be used if a Customer is not assigned to a Cart.
Setting the Cart's
customerId can lead to updates on all its LineItem prices.CartSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
Setting the Cart's
customerId can lead to updates on all its LineItem prices.CartSetCustomFieldAction
Example to create an instance using the builder pattern
CartSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetCustomFieldAction
CartSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomFieldAction
CartSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemCustomTypeAction
CartSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
CartSetCustomLineItemShippingDetailsAction
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
ExternalAmount TaxMode.Can be used if the Cart has the
External TaxMode.CartSetCustomLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.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
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.CartSetCustomTypeAction
Example to create an instance using the builder pattern
CartSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetCustomTypeAction
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
Number of days after which a Cart with
Active CartState is deleted since its last modification.Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
CartSetDirectDiscountsActionBuilder
Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Cart.
CartSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomFieldAction
CartSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetItemShippingAddressCustomTypeAction
CartSetKeyAction
Example to create an instance using the builder pattern
CartSetKeyActionBuilder
Example to create an instance using the builder pattern
CartSetKeyAction
CartSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
CartSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemCustomFieldAction
CartSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
CartSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemCustomTypeAction
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
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.CartSetLineItemInventoryModeAction
Example to create an instance using the builder pattern
CartSetLineItemInventoryModeActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemInventoryModeAction
Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.CartSetLineItemPriceActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.CartSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
CartSetLineItemShippingDetailsAction
Performing this action has no impact on inventory that should be reserved.
CartSetLineItemSupplyChannelActionBuilder
Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
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
ExternalAmount TaxMode.Can be used if the Cart has the
External TaxMode.CartSetLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.CartSetLineItemTotalPriceActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.CartSetLocaleAction
Example to create an instance using the builder pattern
CartSetLocaleActionBuilder
Example to create an instance using the builder pattern
CartSetLocaleAction
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
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
CartSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetShippingAddressCustomFieldAction
CartSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
CartSetShippingAddressCustomTypeAction
CartSetShippingCustomFieldAction
Example to create an instance using the builder pattern
CartSetShippingCustomFieldActionBuilder
Example to create an instance using the builder pattern
CartSetShippingCustomFieldAction
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
This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's
shippingMethod or shipping.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
To set the Cart's Shipping Method the Cart must have the
Single ShippingMode and a shippingAddress.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 amount can be set if the Cart has the
ExternalAmount TaxMode.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
A Shipping Method Tax Rate can be set if the Cart has the
External TaxMode.Input used to select a ShippingRatePriceTier.
CartSetShippingRateInputActionBuilder
Example to create an instance using the builder pattern
Input used to select a ShippingRatePriceTier.
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
Changes the CartState from
Frozen to Active.CartUpdate
Example to create an instance using the builder pattern
CartUpdateAction
Example to create a subtype instance using the builder pattern
CartUpdateActionBuilder
CartUpdateAction
CartUpdateBuilder
Example to create an instance using the builder pattern
CartUpdate
Updates an address in
itemShippingAddresses by keeping the Address key.CartUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.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.
Used when the ShippingRate maps to the sum of LineItem Prices.
CartValueTypeBuilder
Example to create an instance using the builder pattern
Used when the ShippingRate maps to the sum of LineItem Prices.
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
CategoryAddAssetAction
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
CategoryChangeAssetNameAction
This update action changes the order of the
assets array.CategoryChangeAssetOrderActionBuilder
Example to create an instance using the builder pattern
This update action changes the order of the
assets array.CategoryChangeNameAction
Example to create an instance using the builder pattern
CategoryChangeNameActionBuilder
Example to create an instance using the builder pattern
CategoryChangeNameAction
CategoryChangeOrderHintAction
Example to create an instance using the builder pattern
CategoryChangeOrderHintActionBuilder
Example to create an instance using the builder pattern
CategoryChangeOrderHintAction
CategoryChangeParentAction
Example to create an instance using the builder pattern
CategoryChangeParentActionBuilder
Example to create an instance using the builder pattern
CategoryChangeParentAction
Changing the slug produces the CategorySlugChanged Message.
CategoryChangeSlugActionBuilder
Example to create an instance using the builder pattern
Changing the slug produces the CategorySlugChanged Message.
Generated after a successful Create Category request.
CategoryCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Category request.
Generated after a successful Create Category request.
CategoryCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Category request.
CategoryDraft
Example to create an instance using the builder pattern
CategoryDraftBuilder
Example to create an instance using the builder pattern
CategoryDraft
Category
JSON object where the key is a Category
id and the value is an order hint.CategoryOrderHintsBuilder
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.PagedQueryResult with results containing an array of Category.
CategoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Category.
Reference to a Category.
CategoryReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Category.
CategoryRemoveAssetAction
Example to create an instance using the builder pattern
CategoryRemoveAssetActionBuilder
Example to create an instance using the builder pattern
CategoryRemoveAssetAction
ResourceIdentifier to a Category.
CategoryResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Category.
CategorySetAssetCustomFieldAction
Example to create an instance using the builder pattern
CategorySetAssetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetCustomFieldAction
CategorySetAssetCustomTypeAction
Example to create an instance using the builder pattern
CategorySetAssetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetCustomTypeAction
CategorySetAssetDescriptionAction
Example to create an instance using the builder pattern
CategorySetAssetDescriptionActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetDescriptionAction
Set or remove the
key of an Asset.CategorySetAssetKeyActionBuilder
Example to create an instance using the builder pattern
Set or remove the
key of an Asset.CategorySetAssetSourcesAction
Example to create an instance using the builder pattern
CategorySetAssetSourcesActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetSourcesAction
CategorySetAssetTagsAction
Example to create an instance using the builder pattern
CategorySetAssetTagsActionBuilder
Example to create an instance using the builder pattern
CategorySetAssetTagsAction
CategorySetCustomFieldAction
Example to create an instance using the builder pattern
CategorySetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CategorySetCustomFieldAction
CategorySetCustomTypeAction
Example to create an instance using the builder pattern
CategorySetCustomTypeActionBuilder
Example to create an instance using the builder pattern
CategorySetCustomTypeAction
CategorySetDescriptionAction
Example to create an instance using the builder pattern
CategorySetDescriptionActionBuilder
Example to create an instance using the builder pattern
CategorySetDescriptionAction
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
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).
CategorySetKeyAction
Example to create an instance using the builder pattern
CategorySetKeyActionBuilder
Example to create an instance using the builder pattern
CategorySetKeyAction
CategorySetMetaDescriptionAction
Example to create an instance using the builder pattern
CategorySetMetaDescriptionActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaDescriptionAction
CategorySetMetaKeywordsAction
Example to create an instance using the builder pattern
CategorySetMetaKeywordsActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaKeywordsAction
CategorySetMetaTitleAction
Example to create an instance using the builder pattern
CategorySetMetaTitleActionBuilder
Example to create an instance using the builder pattern
CategorySetMetaTitleAction
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.
Generated after a successful Change Slug update action.
CategorySlugChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
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
CategoryUpdateAction
CategoryUpdateBuilder
Example to create an instance using the builder pattern
CategoryUpdate
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
This draft type is the alternative to Money.
Object that stores cent amounts in a specific currency.
Notification about changes to a resource.
ChangeSubscriptionBuilder
Example to create an instance using the builder pattern
Notification about changes to a resource.
Resource types supported by ChangeSubscriptions:
possible values of ChangeSubscriptionResourceTypeId
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
ChannelAddRolesAction
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
ChannelChangeDescriptionAction
ChannelChangeKeyAction
Example to create an instance using the builder pattern
ChannelChangeKeyActionBuilder
Example to create an instance using the builder pattern
ChannelChangeKeyAction
ChannelChangeNameAction
Example to create an instance using the builder pattern
ChannelChangeNameActionBuilder
Example to create an instance using the builder pattern
ChannelChangeNameAction
ChannelDraft
Example to create an instance using the builder pattern
ChannelDraftBuilder
Example to create an instance using the builder pattern
ChannelDraft
Channel
PagedQueryResult with results containing an array of Channel.
ChannelPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Channel.
Reference to a Channel.
ChannelReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Channel.
ChannelRemoveRolesAction
Example to create an instance using the builder pattern
ChannelRemoveRolesActionBuilder
Example to create an instance using the builder pattern
ChannelRemoveRolesAction
ResourceIdentifier to a Channel.
ChannelResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Channel.
Describes the purpose and type of the Channel.
possible values of ChannelRoleEnum
ChannelSetAddressAction
Example to create an instance using the builder pattern
ChannelSetAddressActionBuilder
Example to create an instance using the builder pattern
ChannelSetAddressAction
ChannelSetAddressCustomFieldAction
Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
ChannelSetAddressCustomFieldAction
ChannelSetAddressCustomTypeAction
Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
ChannelSetAddressCustomTypeAction
ChannelSetCustomFieldAction
Example to create an instance using the builder pattern
ChannelSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ChannelSetCustomFieldAction
ChannelSetCustomTypeAction
Example to create an instance using the builder pattern
ChannelSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ChannelSetCustomTypeAction
ChannelSetGeoLocationAction
Example to create an instance using the builder pattern
ChannelSetGeoLocationActionBuilder
Example to create an instance using the builder pattern
ChannelSetGeoLocationAction
ChannelSetRolesAction
Example to create an instance using the builder pattern
ChannelSetRolesActionBuilder
Example to create an instance using the builder pattern
ChannelSetRolesAction
ChannelUpdate
Example to create an instance using the builder pattern
ChannelUpdateAction
Example to create a subtype instance using the builder pattern
ChannelUpdateActionBuilder
ChannelUpdateAction
ChannelUpdateBuilder
Example to create an instance using the builder pattern
ChannelUpdate
ClassificationShippingRateInput
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
ClassificationShippingRateInputDraft
ClassificationShippingRateInput
These objects represent information about which API Client created or modified a resource.
ClientLoggingBuilder
Example to create an instance using the builder pattern
These objects represent information about which API Client created or modified a resource.
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 can be used with any Destination, and the payload is delivered in the
JSON Event Format.The CloudEventsFormat represents event data in a way that conforms to a common specification.
CloudEventsPayloadBuilder
Example to create an instance using the builder pattern
The CloudEventsFormat represents event data in a way that conforms to a common specification.
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
Draft type to represent the top level of a business.
Business Unit type to represent the top level of a business.
Returned when the request conflicts with the current state of the involved resources.
ConcurrentModificationErrorBuilder
Example to create an instance using the builder pattern
Returned when the request conflicts with the current state of the involved resources.
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.
Implementation of the
ConcurrentModificationMiddleware.ConflictingTrait
This destination can be used to push events and messages to Confluent Cloud.
ConfluentCloudDestinationBuilder
Example to create an instance using the builder pattern
This destination can be used to push events and messages to Confluent Cloud.
ContainerAndKey is specific to Custom Objects.ContainerAndKeyBuilder
Example to create an instance using the builder pattern
ContainerAndKey is specific to Custom Objects.Returned when the request results in too much data being returned from the API.
ContentTooLargeErrorBuilder
Example to create an instance using the builder pattern
Returned when the request results in too much data being returned from the API.
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
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
Present on resources created after 1 February 2019 except for events not tracked.
CreatedByBuilder
Example to create an instance using the builder pattern
Present on resources created after 1 February 2019 except for events not tracked.
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
Adding an address to the Customer produces the CustomerAddressAdded Message.
Adds an Address from the
addresses array to billingAddressIds.CustomerAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adds an Address from the
addresses array to billingAddressIds.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.
Generated after a successful Add Address update action.
CustomerAddressAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Address update action.
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.
Generated after a successful Change Address update action.
CustomerAddressChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Address update action.
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.
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 adding a Custom Field to an Address of a Customer using the Set CustomField in Address update action.
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.
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 changing an existing Custom Field on an Address of a Customer using the Set CustomField in Address update action.
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.
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 Field from an Address of a Customer using the Set CustomField in Address update action.
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.
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 removing a Custom Type from an Address of a Customer using the Set Custom Type in Address update action.
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.
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 adding a Custom Type to an Address of a Customer using the Set Custom Type in Address update action.
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.
Generated after a successful Remove Address update action.
CustomerAddressRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Address update action.
Adds an Address from the
addresses array to shippingAddressIds.CustomerAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adds an Address from the
addresses array to shippingAddressIds.Associates the Customer with a Store.
CustomerAddStoreActionBuilder
Example to create an instance using the builder pattern
Associates the Customer with a Store.
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
Changing an address of the Customer produces the CustomerAddressChanged Message.
Changing the email of the Customer produces the CustomerEmailChanged Message.
CustomerChangeEmailActionBuilder
Example to create an instance using the builder pattern
Changing the email of the Customer produces the CustomerEmailChanged Message.
CustomerChangePassword
Example to create an instance using the builder pattern
CustomerChangePasswordBuilder
Example to create an instance using the builder pattern
CustomerChangePassword
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.
Generated after a successful Set Company Name update action.
CustomerCompanyNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Company Name update action.
Generated after a successful Create Customer request.
CustomerCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
Generated after a successful Create Customer request.
CustomerCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Customer request.
CustomerCreateEmailToken
Example to create an instance using the builder pattern
CustomerCreateEmailTokenBuilder
Example to create an instance using the builder pattern
CustomerCreateEmailToken
CustomerCreatePasswordResetToken
Example to create an instance using the builder pattern
CustomerCreatePasswordResetTokenBuilder
Example to create an instance using the builder pattern
CustomerCreatePasswordResetToken
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.
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 adding a Custom Field to a Customer using the Set CustomField update action.
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.
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 changing an existing Custom Field on a Customer using the Set CustomField update action.
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.
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 Field from a Customer using the Set CustomField update action.
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.
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 removing a Custom Type from a Customer using the Set Custom Type update action with empty parameters.
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.
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 adding a Custom Type to a Customer using the Set Custom Type update action.
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.
Generated after a successful Set Date of Birth update action.
CustomerDateOfBirthSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Date of Birth update action.
Generated after a successful Delete Customer request.
CustomerDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
Generated after a successful Delete Customer request.
CustomerDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Customer request.
CustomerDraft
Example to create an instance using the builder pattern
CustomerDraftBuilder
Example to create an instance using the builder pattern
CustomerDraft
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.
Generated after a successful Change Email update action.
CustomerEmailChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Email update action.
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.
Generated after a successful Create email token for Customer request.
CustomerEmailTokenCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create email token for Customer request.
Reference to a CustomerToken for email verification.
CustomerEmailTokenReferenceBuilder
Example to create an instance using the builder pattern
Reference to a CustomerToken for email verification.
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.
Generated after a successful Verify Customer's Email request.
CustomerEmailVerifiedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Verify Customer's Email request.
CustomerEmailVerify
Example to create an instance using the builder pattern
CustomerEmailVerifyBuilder
Example to create an instance using the builder pattern
CustomerEmailVerify
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.
Generated after a successful Set First Name update action.
CustomerFirstNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set First Name update action.
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
CustomerGroupChangeNameAction
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.
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 adding a Custom Field to a Customer Group using the Set CustomField update action.
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.
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 changing an existing Custom Field on a Customer Group using the Set CustomField update action.
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.
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 Field from a Customer Group using the Set CustomField update action.
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.
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 removing a Custom Type from a Customer Group using the Set Custom Type update action with empty parameters.
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.
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
Generated after adding a Custom Type to a Customer Group using the Set Custom Type update action.
CustomerGroupDraft
Example to create an instance using the builder pattern
CustomerGroupDraftBuilder
Example to create an instance using the builder pattern
CustomerGroupDraft
CustomerGroup
PagedQueryResult with
results containing an array of CustomerGroup.CustomerGroupPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CustomerGroup.Reference to a CustomerGroup.
CustomerGroupReferenceBuilder
Example to create an instance using the builder pattern
Reference to a CustomerGroup.
ResourceIdentifier to a CustomerGroup.
CustomerGroupResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a CustomerGroup.
CustomerGroupSetCustomFieldAction
Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
CustomerGroupSetCustomFieldAction
This action sets or removes the custom type for an existing CustomerGroup.
CustomerGroupSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
This action sets or removes the custom type for an existing CustomerGroup.
CustomerGroupSetKeyAction
Example to create an instance using the builder pattern
CustomerGroupSetKeyActionBuilder
Example to create an instance using the builder pattern
CustomerGroupSetKeyAction
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.
Generated after a successful Set Customer Group update action.
CustomerGroupSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer Group update action.
CustomerGroupUpdate
Example to create an instance using the builder pattern
CustomerGroupUpdateAction
Example to create a subtype instance using the builder pattern
CustomerGroupUpdateActionBuilder
CustomerGroupUpdateAction
CustomerGroupUpdateBuilder
Example to create an instance using the builder pattern
CustomerGroupUpdate
If
stores is not empty, the Customer is specific to those Stores.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.
Generated after a successful Set Last Name update action.
CustomerLastNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Last Name update action.
PagedQueryResult with results containing an array of Customer.
CustomerPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Customer.
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.
Generated after a successful Create password reset token for Customer request.
CustomerPasswordTokenCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create password reset token for Customer request.
Reference to a CustomerToken for password reset.
CustomerPasswordTokenReferenceBuilder
Example to create an instance using the builder pattern
Reference to a CustomerToken for password reset.
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.
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
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.
Reference to a Customer.
CustomerReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Customer.
Removing an address from the Customer produces the CustomerAddressRemoved Message.
CustomerRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing an address from the Customer produces the CustomerAddressRemoved Message.
Removes a billing address from
billingAddressesIds.CustomerRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes a billing address from
billingAddressesIds.Removes a shipping address from
shippingAddressesIds.CustomerRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes a shipping address from
shippingAddressesIds.Removes the association to a Store from the Customer.
CustomerRemoveStoreActionBuilder
Example to create an instance using the builder pattern
Removes the association to a Store from the Customer.
CustomerResetPassword
Example to create an instance using the builder pattern
CustomerResetPasswordBuilder
Example to create an instance using the builder pattern
CustomerResetPassword
ResourceIdentifier to a Customer.
CustomerResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Customer.
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 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.
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
Adding or updating a Custom Type on an Address of a Customer generates the CustomerAddressCustomTypeSet Message, and removing one generates the CustomerAddressCustomTypeRemoved Message.
CustomerSetAuthenticationModeAction
Example to create an instance using the builder pattern
CustomerSetAuthenticationModeActionBuilder
Example to create an instance using the builder pattern
CustomerSetAuthenticationModeAction
Setting a company name produces the CustomerCompanyNameSet Message.
CustomerSetCompanyNameActionBuilder
Example to create an instance using the builder pattern
Setting a company name produces the CustomerCompanyNameSet Message.
Setting the Customer Group of the Customer produces the CustomerGroupSet Message.
CustomerSetCustomerGroupActionBuilder
Example to create an instance using the builder pattern
Setting the Customer Group of the Customer produces the CustomerGroupSet Message.
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
Sets a new ID that can be used to refer to a Customer in a human-reabable way (for use in emails, invoices, etc).
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 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.
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
Adding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
CustomerSetDateOfBirthActionBuilder
Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
Sets the default billing address from
addresses.CustomerSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default billing address from
addresses.Sets the default shipping address from
addresses.CustomerSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default shipping address from
addresses.CustomerSetExternalIdAction
Example to create an instance using the builder pattern
CustomerSetExternalIdActionBuilder
Example to create an instance using the builder pattern
CustomerSetExternalIdAction
CustomerSetFirstNameAction
Example to create an instance using the builder pattern
CustomerSetFirstNameActionBuilder
Example to create an instance using the builder pattern
CustomerSetFirstNameAction
CustomerSetKeyAction
Example to create an instance using the builder pattern
CustomerSetKeyActionBuilder
Example to create an instance using the builder pattern
CustomerSetKeyAction
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
CustomerSetLastNameActionBuilder
Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
CustomerSetLocaleAction
Example to create an instance using the builder pattern
CustomerSetLocaleActionBuilder
Example to create an instance using the builder pattern
CustomerSetLocaleAction
CustomerSetMiddleNameAction
Example to create an instance using the builder pattern
CustomerSetMiddleNameActionBuilder
Example to create an instance using the builder pattern
CustomerSetMiddleNameAction
CustomerSetSalutationAction
Example to create an instance using the builder pattern
CustomerSetSalutationActionBuilder
Example to create an instance using the builder pattern
CustomerSetSalutationAction
Sets the Stores the Customer account is associated with.
CustomerSetStoresActionBuilder
Example to create an instance using the builder pattern
Sets the Stores the Customer account is associated with.
Setting the title of the Customer produces the CustomerTitleSetMessage.
CustomerSetTitleActionBuilder
Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSetMessage.
CustomerSetVatIdAction
Example to create an instance using the builder pattern
CustomerSetVatIdActionBuilder
Example to create an instance using the builder pattern
CustomerSetVatIdAction
CustomerSignin
Example to create an instance using the builder pattern
CustomerSigninBuilder
Example to create an instance using the builder pattern
CustomerSignin
CustomerSignInResult
Example to create an instance using the builder pattern
CustomerSignInResultBuilder
Example to create an instance using the builder pattern
CustomerSignInResult
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.
Generated after a successful Set Title update action.
CustomerTitleSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Title update action.
CustomerToken
Example to create an instance using the builder pattern
CustomerTokenBuilder
Example to create an instance using the builder pattern
CustomerToken
CustomerUpdate
Example to create an instance using the builder pattern
CustomerUpdateAction
Example to create a subtype instance using the builder pattern
CustomerUpdateActionBuilder
CustomerUpdateAction
CustomerUpdateBuilder
Example to create an instance using the builder pattern
CustomerUpdate
Field type for Boolean values.
CustomFieldBooleanTypeBuilder
Example to create an instance using the builder pattern
Field type for Boolean values.
Field type for DateTime values.
CustomFieldDateTimeTypeBuilder
Example to create an instance using the builder pattern
Field type for DateTime values.
Field type for Date values.
CustomFieldDateTypeBuilder
Example to create an instance using the builder pattern
Field type for Date values.
Field type for enum values.
CustomFieldEnumTypeBuilder
Example to create an instance using the builder pattern
Field type for enum values.
Defines an allowed value of a CustomFieldEnumType field.
CustomFieldEnumValueBuilder
Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldEnumType field.
Field type for localized enum values.
CustomFieldLocalizedEnumTypeBuilder
Example to create an instance using the builder pattern
Field type for localized enum values.
Defines an allowed value of a CustomFieldLocalizedEnumType field.
CustomFieldLocalizedEnumValueBuilder
Example to create an instance using the builder pattern
Defines an allowed value of a CustomFieldLocalizedEnumType field.
Field type for LocalizedString values.
CustomFieldLocalizedStringTypeBuilder
Example to create an instance using the builder pattern
Field type for LocalizedString values.
Field type for CentPrecisionMoney values.
CustomFieldMoneyTypeBuilder
Example to create an instance using the builder pattern
Field type for CentPrecisionMoney values.
Field type for number values.
CustomFieldNumberTypeBuilder
Example to create an instance using the builder pattern
Field type for number values.
Field type for Reference values.
CustomFieldReferenceTypeBuilder
Example to create an instance using the builder pattern
Field type for Reference values.
Defines which resource type a CustomFieldReferenceType can reference.
possible values of CustomFieldReferenceValue
Serves as value of the
custom field on a resource or data type customized with a Type.Accessor for retrieving type safe custom field values
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
The representation used when creating or updating a customizable data type with Custom Fields.
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
Values of a SetType Custom Field are sets of values of the specified
elementType (without duplicate elements).Serves as value of the
custom field on a resource or data type customized with a Type.Field type for string values.
CustomFieldStringTypeBuilder
Example to create an instance using the builder pattern
Field type for string values.
Field type for Time values.
CustomFieldTimeTypeBuilder
Example to create an instance using the builder pattern
Field type for Time values.
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.
CustomLineItemBuilder
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
CustomLineItemDraft
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.
Custom Line Items contain generic user-defined items that are not linked to Products.
CustomLineItemImportDraftBuilder
Example to create an instance using the builder pattern
Custom Line Items contain generic user-defined items that are not linked to Products.
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
CustomLineItemReturnItem
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.
Generated after a successful Transition CustomLineItem State update action.
CustomLineItemStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition CustomLineItem State update action.
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
CustomObjectDraft
CustomObject
PagedQueryResult with
results containing an array of CustomObject.CustomObjectPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of CustomObject.Reference to a CustomObject.
CustomObjectReferenceBuilder
Example to create an instance using the builder pattern
Reference to a CustomObject.
CustomShippingDraft
Example to create an instance using the builder pattern
CustomShippingDraftBuilder
Example to create an instance using the builder pattern
CustomShippingDraft
Define arbitrary tokens that are used to match the input.
CustomTokenizerBuilder
Example to create an instance using the builder pattern
Define arbitrary tokens that are used to match the input.
DataerasureTrait
Contains information on how items are shipped to Customers, for example, a delivery note.
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.
Generated after a successful Add Delivery update action.
DeliveryAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Delivery update action.
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.
Generated after a successful Set Delivery Address update action.
DeliveryAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Address update action.
DeliveryBuilder
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
DeliveryDraftBuilder
Example to create an instance using the builder pattern
DeliveryDraft
DeliveryFormat
Example to create a subtype instance using the builder pattern
DeliveryFormatBuilder
DeliveryFormat
Contains information on how items are shipped to Customers, for example, a delivery note.
DeliveryItem
Example to create an instance using the builder pattern
DeliveryItemBuilder
Example to create an instance using the builder pattern
DeliveryItem
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.
Generated after a successful Set Delivery Items update action.
DeliveryItemsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Delivery Items update action.
All payloads for the PlatformFormat share these common fields.
DeliveryPayloadBuilder
All payloads for the PlatformFormat share these common fields.
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.
Generated after a successful Remove Delivery update action.
DeliveryRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Delivery update action.
Deprecatable200Trait
Deprecatable201Trait
Destination
Example to create a subtype instance using the builder pattern
DestinationBuilder
Destination
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
Represents a CartDiscount that can only be associated with a single Cart or Order.
Represents a CartDiscount that is only associated with a single Cart or Order.
Reference to a DirectDiscount.
DirectDiscountReferenceBuilder
Example to create an instance using the builder pattern
Reference to a DirectDiscount.
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
DiscountCodeChangeCartDiscountsAction
DiscountCodeChangeGroupsAction
Example to create an instance using the builder pattern
DiscountCodeChangeGroupsActionBuilder
Example to create an instance using the builder pattern
DiscountCodeChangeGroupsAction
DiscountCodeChangeIsActiveAction
Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveActionBuilder
Example to create an instance using the builder pattern
DiscountCodeChangeIsActiveAction
DiscountCodeDraft
Example to create an instance using the builder pattern
DiscountCodeDraftBuilder
Example to create an instance using the builder pattern
DiscountCodeDraft
DiscountCode
DiscountCodeInfo
Example to create an instance using the builder pattern
DiscountCodeInfoBuilder
Example to create an instance using the builder pattern
DiscountCodeInfo
Returned when the Cart contains a Discount Code with a DiscountCodeState other than
MatchesCart.DiscountCodeNonApplicableErrorBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a Discount Code with a DiscountCodeState other than
MatchesCart.PagedQueryResult with
results containing an array of DiscountCode.DiscountCodePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of DiscountCode.Reference to a DiscountCode.
DiscountCodeReferenceBuilder
Example to create an instance using the builder pattern
Reference to a DiscountCode.
ResourceIdentifier to a DiscountCode.
DiscountCodeResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a DiscountCode.
DiscountCodeSetCartPredicateAction
Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCartPredicateAction
DiscountCodeSetCustomFieldAction
Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCustomFieldAction
DiscountCodeSetCustomTypeAction
Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetCustomTypeAction
DiscountCodeSetDescriptionAction
Example to create an instance using the builder pattern
DiscountCodeSetDescriptionActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetDescriptionAction
DiscountCodeSetMaxApplicationsAction
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsAction
DiscountCodeSetMaxApplicationsPerCustomerAction
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetMaxApplicationsPerCustomerAction
DiscountCodeSetNameAction
Example to create an instance using the builder pattern
DiscountCodeSetNameActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetNameAction
DiscountCodeSetValidFromAction
Example to create an instance using the builder pattern
DiscountCodeSetValidFromActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAction
DiscountCodeSetValidFromAndUntilAction
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidFromAndUntilAction
DiscountCodeSetValidUntilAction
Example to create an instance using the builder pattern
DiscountCodeSetValidUntilActionBuilder
Example to create an instance using the builder pattern
DiscountCodeSetValidUntilAction
Indicates the state of a Discount Code in a Cart.
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
DiscountCodeUpdateAction
DiscountCodeUpdateBuilder
Example to create an instance using the builder pattern
DiscountCodeUpdate
DiscountedLineItemPortion
Example to create an instance using the builder pattern
DiscountedLineItemPortionBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPortion
DiscountedLineItemPrice
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
DiscountedLineItemPriceDraftBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceDraft
DiscountedLineItemPriceForQuantity
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantityBuilder
Example to create an instance using the builder pattern
DiscountedLineItemPriceForQuantity
DiscountedLineItemPrice
DiscountedPrice
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
DiscountedPriceDraft
DiscountedPrice
DiscountedTotalPricePortion
Example to create an instance using the builder pattern
DiscountedTotalPricePortionBuilder
Example to create an instance using the builder pattern
DiscountedTotalPricePortion
DiscountOnTotalPrice
Example to create an instance using the builder pattern
DiscountOnTotalPriceBuilder
Example to create an instance using the builder pattern
DiscountOnTotalPrice
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
Draft type to model divisions that are part of a Company or a higher-order Division.
Business Unit type to model divisions that are part of the Company or a higher-order Division.
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.DuplicateAttributeValueErrorBuilder
Example to create an instance using the builder pattern
Returned when the
Unique AttributeConstraint criteria are not met during an Update Product request.Returned when the
CombinationUnique AttributeConstraint criteria are not met during an Update Product request.DuplicateAttributeValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when the
CombinationUnique AttributeConstraint criteria are not met during an Update Product request.Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
DuplicateEnumValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
Returned when a field value conflicts with an existing value causing a duplicate.
DuplicateFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a field value conflicts with an existing value causing a duplicate.
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 field value conflicts with an existing value stored in a particular resource causing a duplicate.
Returned when a Price key conflicts with an existing key.
DuplicatePriceKeyErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
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 a Price scope conflicts with an existing one during an Update Product request.
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 the given Price scope conflicts with the Price scope of an existing Standalone Price.
Returned when a Product Variant value conflicts with an existing one during an Update Product request.
DuplicateVariantValuesErrorBuilder
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.
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
Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
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 contains a key that already exists.
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
EnumKeyDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
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 an enum value cannot be removed from an Attribute as it is being used by a Product.
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
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
ErrorableTrait
ErrorByExtension
Example to create an instance using the builder pattern
ErrorByExtensionBuilder
Example to create an instance using the builder pattern
ErrorByExtension
Represents a single error.
ErrorObjectBuilder
Represents a single error.
Base representation of an error response containing common fields to all errors.
ErrorResponseBuilder
Example to create an instance using the builder pattern
Exception which holds the response payload as
ErrorResponseBase representation of an error response containing common fields to all errors.
AWS 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
AWS 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.
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
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).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
ExtensionChangeDestinationAction
ExtensionChangeTriggersAction
Example to create an instance using the builder pattern
ExtensionChangeTriggersActionBuilder
Example to create an instance using the builder pattern
ExtensionChangeTriggersAction
Generic type for destinations.
ExtensionDestinationBuilder
Generic type for destinations.
ExtensionDraft
Example to create an instance using the builder pattern
ExtensionDraftBuilder
Example to create an instance using the builder pattern
ExtensionDraft
ExtensionError
Example to create an instance using the builder pattern
ExtensionErrorBuilder
Example to create an instance using the builder pattern
ExtensionError
Deprecated.
use
HttpDestination insteadDeprecated.
use
HttpDestinationAuthentication insteadDeprecated.
use
HttpDestinationBuilder insteadExtension
ExtensionInput
Example to create an instance using the builder pattern
ExtensionInputBuilder
Example to create an instance using the builder pattern
ExtensionInput
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
Returned when the API Extension does not respond within the time limit, or could not be reached.
PagedQueryResult with
results containing an array of Extension.ExtensionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Extension.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
Returned when the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
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
ExtensionSetKeyAction
ExtensionSetTimeoutInMsAction
Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsActionBuilder
Example to create an instance using the builder pattern
ExtensionSetTimeoutInMsAction
ExtensionTrigger
Example to create an instance using the builder pattern
ExtensionTriggerBuilder
Example to create an instance using the builder pattern
ExtensionTrigger
ExtensionUpdate
Example to create an instance using the builder pattern
ExtensionUpdateAction
Example to create a subtype instance using the builder pattern
ExtensionUpdateActionBuilder
ExtensionUpdateAction
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
Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
ExtensionUpdateBuilder
Example to create an instance using the builder pattern
ExtensionUpdate
ExternalLineItemTotalPrice
Example to create an instance using the builder pattern
ExternalLineItemTotalPriceBuilder
Example to create an instance using the builder pattern
ExternalLineItemTotalPrice
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
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).Represents a RFC 7662 compliant OAuth 2.0 Token Introspection endpoint.
Cannot be used in LineItemDraft or CustomLineItemDraft.
ExternalTaxAmountDraftBuilder
Example to create an instance using the builder pattern
Cannot be used in LineItemDraft or CustomLineItemDraft.
Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in Cart tax calculation.
ExternalTaxRateDraftBuilder
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.
FacetRange
Example to create an instance using the builder pattern
FacetRangeBuilder
Example to create an instance using the builder pattern
FacetRange
FacetResult
Example to create a subtype instance using the builder pattern
FacetResultBuilder
FacetResult
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
FacetResults
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
FacetTerm
FacetTypes
possible values of FacetTypes
Returned when the requested feature was removed.
FeatureRemovedErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested feature was removed.
FieldContainer
Example to create an instance using the builder pattern
FieldContainerBuilder
Example to create an instance using the builder pattern
FieldContainer
Defines a Custom Field and its meta-information.
FieldDefinitionBuilder
Example to create an instance using the builder pattern
Defines a Custom Field and its meta-information.
FieldType
Example to create a subtype instance using the builder pattern
FieldTypeBuilder
FieldType
FilteredFacetResult
Example to create an instance using the builder pattern
FilteredFacetResultBuilder
Example to create an instance using the builder pattern
FilteredFacetResult
Returned when a server-side problem occurs.
GeneralErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem occurs.
entity to implement a type safe generic custom object
builder for a generic custom object
generic custom object implementation
generic reference interface
generic reference implementation
GeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.
GeoJsonBuilder
GeoJSON Geometry represents a Geometry Object as defined in the GeoJSON standard.
GeoJsonPoint
Example to create an instance using the builder pattern
GeoJsonPointBuilder
Example to create an instance using the builder pattern
GeoJsonPoint
For GoogleCloudFunction destinations, you need to grant permissions to the
[email protected] service account to invoke your function.GoogleCloudFunctionDestinationBuilder
Example to create an instance using the builder pattern
For GoogleCloudFunction destinations, you need to grant permissions to the
[email protected] service account to invoke your function.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
Destination for Google Cloud Pub/Sub that can be used for Pull subscriptions as well as for Push subscriptions.
Returned when the anonymous ID is being used by another resource.
GraphQLAnonymousIdAlreadyInUseErrorBuilder
Example to create an instance using the builder pattern
Returned when the anonymous ID is being used by another resource.
Returned when an Associate is missing a Permission on a B2B resource.
GraphQLAssociateMissingPermissionErrorBuilder
Example to create an instance using the builder pattern
Returned when an Associate is missing a Permission on a B2B resource.
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
name of the AttributeDefinition conflicts with an existing Attribute.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 the
type is different for an AttributeDefinition using the same name in multiple Product Types.Returned when an AttributeDefinition does not exist for an Attribute
name.GraphQLAttributeNameDoesNotExistErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeDefinition does not exist for an Attribute
name.Returned when a server-side problem is caused by scaling infrastructure resources.
GraphQLBadGatewayErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem is caused by scaling infrastructure resources.
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 conflicts with the current state of the involved resources.
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 the request results in too much data being returned from the API.
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
Returned when a Cart or an Order in a Store references a country that is not included in the countries configured for the Store.
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 Cart contains a Discount Code with a DiscountCodeState other than
MatchesCart.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
Unique AttributeConstraint criteria are not met during an Update Product request.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 the
CombinationUnique AttributeConstraint criteria are not met during an Update Product request.Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
GraphQLDuplicateEnumValuesErrorBuilder
Example to create an instance using the builder pattern
Returned when an AttributeEnumType or AttributeLocalizedEnumType contains duplicate keys.
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 causing a duplicate.
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 field value conflicts with an existing value stored in a particular resource causing a duplicate.
Returned when a Price key conflicts with an existing key.
GraphQLDuplicatePriceKeyErrorBuilder
Example to create an instance using the builder pattern
Returned when a Price key conflicts with an existing key.
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 a Price scope conflicts with an existing one during an Update Product request.
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 the given Price scope conflicts with the Price scope of an existing Standalone Price.
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 Product Variant value conflicts with an existing one during an Update Product request.
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 a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
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 contains a key that already exists.
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 AttributeEnumType or AttributeLocalizedEnumType already contains a value with the given key.
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 an enum value cannot be removed from an Attribute as it is being used by a Product.
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
Returned when during an order update of AttributeEnumType or AttributeLocalizedEnumType the new enum values do not match the existing ones.
GraphQLError
Example to create an instance using the builder pattern
GraphQLErrorBuilder
Example to create an instance using the builder pattern
GraphQLError
GraphQLErrorLocation
Example to create an instance using the builder pattern
GraphQLErrorLocationBuilder
Example to create an instance using the builder pattern
GraphQLErrorLocation
Represents a single error.
GraphQLErrorObjectBuilder
Represents a single error.
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 response from the API Extension could not be parsed successfully (such as a
500 HTTP status code, or an invalid JSON response).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 API Extension does not respond within the time limit, or could not be reached.
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 the predicate defined in the ExtensionTrigger could not be evaluated due to a missing field.
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 update actions could not be applied to the resource (for example, because a referenced resource does not exist).
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 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).Returned when the requested feature was removed.
GraphQLFeatureRemovedErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested feature was removed.
Returned when a server-side problem occurs.
GraphQLGeneralErrorBuilder
Example to create an instance using the builder pattern
Returned when a server-side problem occurs.
GraphQLInsufficientScopeError
Example to create an instance using the builder pattern
GraphQLInsufficientScopeErrorBuilder
Example to create an instance using the builder pattern
GraphQLInsufficientScopeError
Returned when certain API-specific constraints were not met.
GraphQLInternalConstraintViolatedErrorBuilder
Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
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 a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
Returned when the current password of the Customer does not match.
GraphQLInvalidCurrentPasswordErrorBuilder
Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
Returned when a field has an invalid value.
GraphQLInvalidFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a field has an invalid value.
Returned when an invalid input has been sent.
GraphQLInvalidInputErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
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 Line Item or Custom Line Item quantities set under ItemShippingDetails do not match the sum of the quantities in their respective shipping details.
Returned when an invalid JSON input has been sent.
GraphQLInvalidJsonInputErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
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
Returned when the resources involved in the request are not in a valid state for the operation.
GraphQLInvalidSubjectError
Example to create an instance using the builder pattern
GraphQLInvalidSubjectErrorBuilder
Example to create an instance using the builder pattern
GraphQLInvalidSubjectError
GraphQLInvalidTokenError
Example to create an instance using the builder pattern
GraphQLInvalidTokenErrorBuilder
Example to create an instance using the builder pattern
GraphQLInvalidTokenError
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 a language cannot be removed from a Project as it is being used by a Store.
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 the Product Variant does not have a Price according to the Product
priceMode value for a selected currency, country, Customer Group, or Channel.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 Cart Discount cannot be created or activated as the limit for active Cart Discounts has been reached.
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 resource type cannot be created as it has reached its limits.
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 a Store cannot be added to a Cart Discount as the limit for Stores configured for a Cart Discount has been reached.
Returned when one of the following states occur:
GraphQLMissingRoleOnChannelErrorBuilder
Example to create an instance using the builder pattern
Returned when one of the following states occur:
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 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.Returned when a Money operation overflows the 64-bit integer range.
GraphQLMoneyOverflowErrorBuilder
Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
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 a Product Discount could not be found that could be applied to the Price of a Product Variant.
Returned when the Project-specific category recommendations feature is not enabled for the Project.
GraphQLNotEnabledErrorBuilder
Example to create an instance using the builder pattern
Returned when the Project-specific category recommendations feature is not enabled for the Project.
Returned when the requested resource was not found.
GraphQLObjectNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested resource was not found.
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 some of the Line Items are out of stock at the time of placing an Order.
Returned when the service is having trouble handling the load.
GraphQLOverCapacityErrorBuilder
Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
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 given Price validity period conflicts with an existing one.
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 a previous conflicting operation is still pending and needs to finish before the request can succeed.
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
GraphQLPriceChangedErrorBuilder
Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
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 not assigned to the Product Selection.
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 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.
Returned when the languages set for a Store are not supported by the Project.
GraphQLProjectNotConfiguredForLanguagesErrorBuilder
Example to create an instance using the builder pattern
Returned when the languages set for a Store are not supported by the Project.
GraphQLQueryComplexityLimitExceededError
Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededErrorBuilder
Example to create an instance using the builder pattern
GraphQLQueryComplexityLimitExceededError
Returned when the query times out.
GraphQLQueryTimedOutErrorBuilder
Example to create an instance using the builder pattern
Returned when the query times out.
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 referenced by a Reference or a ResourceIdentifier could not be found.
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
Returned when a resource cannot be deleted because it is being referenced by another resource.
GraphQLRequest
Example to create an instance using the builder pattern
GraphQLRequestBuilder
Example to create an instance using the builder pattern
GraphQLRequest
Returned when a value is not defined for a required field.
GraphQLRequiredFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
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 addressed by the request URL does not exist.
Returned when the resource exceeds the maximum allowed size of 16 MB.
GraphQLResourceSizeLimitExceededErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
GraphQLResponse
Example to create an instance using the builder pattern
GraphQLResponseBuilder
Example to create an instance using the builder pattern
GraphQLResponse
Returned when the indexing of Product information is deactivated in a Project.
GraphQLSearchDeactivatedErrorBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
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 query could not be completed due to an unexpected failure.
Returned when a search facet path could not be found.
GraphQLSearchFacetPathNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
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 the indexing of Product information is still in progress for Projects that have indexing activated.
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 a Discount predicate or API Extension predicate is not semantically correct.
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 the Cart contains a ShippingMethod that is not allowed for the Cart.
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 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.
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
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
GraphQLVariablesMap
Example to create an instance using the builder pattern
GraphQLVariablesMapBuilder
Example to create an instance using the builder pattern
GraphQLVariablesMap
Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.
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
Money draft object to store an amount of a fraction of the smallest indivisible unit of the specified currency.
Money object that stores an amount of a fraction of the smallest indivisible unit of the specified currency.
Hit
Example to create an instance using the builder pattern
HitBuilder
Example to create an instance using the builder pattern
Hit
We recommend an encrypted
HTTPS connection for production setups.HttpDestinationAuthentication
Example to create a subtype instance using the builder pattern
HttpDestinationAuthenticationBuilder
HttpDestinationAuthentication
HttpDestinationBuilder
Example to create an instance using the builder pattern
We recommend an encrypted
HTTPS connection for production setups.an object identifiable by an ID
Image
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
ImageDimensionsBuilder
Example to create an instance using the builder pattern
ImageDimensions
Image
InheritedAssociate
Example to create an instance using the builder pattern
InheritedAssociateBuilder
Example to create an instance using the builder pattern
InheritedAssociate
InheritedAssociateRoleAssignment
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignmentBuilder
Example to create an instance using the builder pattern
InheritedAssociateRoleAssignment
InsufficientScopeError
Example to create an instance using the builder pattern
InsufficientScopeErrorBuilder
Example to create an instance using the builder pattern
InsufficientScopeError
Returned when certain API-specific constraints were not met.
InternalConstraintViolatedErrorBuilder
Example to create an instance using the builder pattern
Returned when certain API-specific constraints were not met.
Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
InvalidCredentialsErrorBuilder
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.
Returned when the current password of the Customer does not match.
InvalidCurrentPasswordErrorBuilder
Example to create an instance using the builder pattern
Returned when the current password of the Customer does not match.
Returned when a field has an invalid value.
InvalidFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a field has an invalid value.
Returned when an invalid input has been sent.
InvalidInputErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid input has been sent.
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
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.
Returned when an invalid JSON input has been sent.
InvalidJsonInputErrorBuilder
Example to create an instance using the builder pattern
Returned when an invalid JSON input has been sent.
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
Returned when the resources involved in the request are not in a valid state for the operation.
InvalidSubjectError
Example to create an instance using the builder pattern
InvalidSubjectErrorBuilder
Example to create an instance using the builder pattern
InvalidSubjectError
InvalidTokenError
Example to create an instance using the builder pattern
InvalidTokenErrorBuilder
Example to create an instance using the builder pattern
InvalidTokenError
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
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.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
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
Generated after a successful Create InventoryEntry request.
InventoryEntryCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create InventoryEntry request.
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
Generated after a successful Delete InventoryEntry request.
InventoryEntryDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete InventoryEntry request.
InventoryEntryDraft
Example to create an instance using the builder pattern
InventoryEntryDraftBuilder
Example to create an instance using the builder pattern
InventoryEntryDraft
InventoryEntry
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.
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
InventoryEntryQuantitySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Quantity, Remove Quantity or Change Quantity update action.
Reference to an InventoryEntry.
InventoryEntryReferenceBuilder
Example to create an instance using the builder pattern
Reference to an InventoryEntry.
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.InventoryEntryRemoveQuantityActionBuilder
Example to create an instance using the builder pattern
Updates
availableQuantity based on the new quantityOnStock and amount of active reservations.ResourceIdentifier to an InventoryEntry.
InventoryEntryResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an InventoryEntry.
InventoryEntrySetCustomFieldAction
Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetCustomFieldAction
InventoryEntrySetCustomTypeAction
Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetCustomTypeAction
InventoryEntrySetExpectedDeliveryAction
Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetExpectedDeliveryAction
InventoryEntrySetKeyAction
Example to create an instance using the builder pattern
InventoryEntrySetKeyActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetKeyAction
InventoryEntrySetRestockableInDaysAction
Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysActionBuilder
Example to create an instance using the builder pattern
InventoryEntrySetRestockableInDaysAction
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
If an entry with the same
sku and supplyChannel already exists, an DuplicateField error is returned.InventoryEntryUpdate
Example to create an instance using the builder pattern
InventoryEntryUpdateAction
Example to create a subtype instance using the builder pattern
InventoryEntryUpdateActionBuilder
InventoryEntryUpdateAction
InventoryEntryUpdateBuilder
Example to create an instance using the builder pattern
InventoryEntryUpdate
Indicates how Line Items in a Cart are tracked.
possible values of InventoryMode
InventoryPagedQueryResponse
Example to create an instance using the builder pattern
InventoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
InventoryPagedQueryResponse
ItemShippingDetails
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.ItemShippingDetailsDraftBuilder
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.ItemShippingDetails
Determines the address (as a reference to an address in
itemShippingAddresses) and the quantity shipped to the address.ItemShippingTargetBuilder
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.ItemState
Example to create an instance using the builder pattern
ItemStateBuilder
Example to create an instance using the builder pattern
ItemState
A KeyReference represents a loose reference to another resource in the same Project identified by the resource's
key field.KeyReferenceBuilder
A KeyReference represents a loose reference to another resource in the same Project identified by the resource's
key field.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
Returned when a language cannot be removed from a Project as it is being used by a Store.
Present on resources modified after 1 February 2019 except for events not tracked.
LastModifiedByBuilder
Example to create an instance using the builder pattern
Present on resources modified after 1 February 2019 except for events not tracked.
The representation of a Line Item in a Cart or in an Order.
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
For Product Variant identification, either the
productId and variantId, or sku must be provided.The representation of a Line Item in a Cart or in an Order.
Represents a snapshot of a Product Variant at the time it was imported with the Order.
LineItemImportDraftBuilder
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.
Indicates how a Line Item is added to a Cart.
possible values of LineItemMode
This mode indicates how the price is set for the Line Item.
possible values of LineItemPriceMode
LineItemReturnItem
Example to create an instance using the builder pattern
LineItemReturnItemBuilder
Example to create an instance using the builder pattern
LineItemReturnItem
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.
Generated after a successful Transition LineItem State update action.
LineItemStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition LineItem State update action.
LocaleprojectingTrait
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.Builder to create a
LocalizedStringEntry of for a LocalizedString
LocalizedString implementation
A geographical location representing a country and optionally a state within this country.
LocationBuilder
Example to create an instance using the builder pattern
A geographical location representing a country and optionally a state within this country.
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 the Product Variant does not have a Price according to the Product
priceMode value for a selected currency, country, Customer Group, or Channel.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 Cart Discount cannot be created or activated as the limit for active Cart Discounts has been reached.
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 resource type cannot be created as it has reached its limits.
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
Returned when a Store cannot be added to a Cart Discount as the limit for Stores configured for a Cart Discount has been reached.
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
This payload is sent for a MessageSubscription.
Base representation of a Message containing common fields to all Message Types.
PagedQueryResult with
results containing an array of Message.MessagePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Message.MessagePayload
Example to create a subtype instance using the builder pattern
MessagePayloadBuilder
MessagePayload
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
Defines the configuration for the Messages Query feature for the Project.
Holds the configuration for the Messages Query feature for the Project.
For supported resources and message types, see Message Types.
MessageSubscriptionBuilder
Example to create an instance using the builder pattern
For supported resources and message types, see Message Types.
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
MethodExternalTaxRateDraft
MethodTaxedPrice
Example to create an instance using the builder pattern
MethodTaxedPriceBuilder
Example to create an instance using the builder pattern
MethodTaxedPrice
MethodTaxRate
Example to create an instance using the builder pattern
MethodTaxRateBuilder
Example to create an instance using the builder pattern
MethodTaxRate
Returned when one of the following states occur:
MissingRoleOnChannelErrorBuilder
Example to create an instance using the builder pattern
Returned when one of the following states occur:
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
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.conversion methods for Money classes
Draft type that stores amounts in cent precision for the specified currency.
MoneyBuilder
Example to create an instance using the builder pattern
Draft type that stores amounts in cent precision for the specified currency.
Returned when a Money operation overflows the 64-bit integer range.
MoneyOverflowErrorBuilder
Example to create an instance using the builder pattern
Returned when a Money operation overflows the 64-bit integer range.
Determines the type of money used.
possible values of MoneyType
Utility methods to convert from
MonetaryAmount to Money and vice versaThis 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
This Discount target is similar to
MultiBuyLineItems, but is applied on Custom Line Items instead of Line Items.MultiBuyLineItemsTarget
Example to create an instance using the builder pattern
MultiBuyLineItemsTargetBuilder
Example to create an instance using the builder pattern
MultiBuyLineItemsTarget
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
MyBusinessUnitAddAddressActionBuilder
Example to create an instance using the builder pattern
Adding an address to a Business Unit generates a BusinessUnitAddressAdded Message.
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
MyBusinessUnitAddBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a billing address to a Business Unit generates a BusinessUnitBillingAddressAdded Message.
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
MyBusinessUnitAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adding a shipping address to a Business Unit generates a BusinessUnitShippingAddressAdded Message.
MyBusinessUnitAssociateDraft
Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraftBuilder
Example to create an instance using the builder pattern
MyBusinessUnitAssociateDraft
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
MyBusinessUnitChangeAddressActionBuilder
Example to create an instance using the builder pattern
Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
MyBusinessUnitChangeAssociateActionBuilder
Example to create an instance using the builder pattern
Updating the Associate on a Business Unit generates the BusinessUnitAssociateChanged Message.
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
MyBusinessUnitChangeNameActionBuilder
Example to create an instance using the builder pattern
Updating the name on a Business Unit generates a BusinessUnitNameChanged Message.
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
MyBusinessUnitChangeParentUnitActionBuilder
Example to create an instance using the builder pattern
Changing the parent of a Business Unit generates a BusinessUnitParentChanged Message.
MyBusinessUnitDraft
Example to create a subtype instance using the builder pattern
MyBusinessUnitDraftBuilder
MyBusinessUnitDraft
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
MyBusinessUnitRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
MyBusinessUnitRemoveAssociateActionBuilder
Example to create an instance using the builder pattern
Removing an Associate from a Business Unit generates a BusinessUnitAssociateRemoved Message.
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
MyBusinessUnitRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a billing address from a Business Unit generates a BusinessUnitBillingAddressRemoved Message.
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
MyBusinessUnitRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.
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 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.
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
Adding or updating a Custom Type to an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
MyBusinessUnitSetContactEmailActionBuilder
Example to create an instance using the builder pattern
Setting the contact email on a Business Unit generates a BusinessUnitContactEmailSet Message.
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 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.
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
Adding or updating a Custom Type on a Business Unit generates the BusinessUnitCustomTypeSet Message, removing one generates the BusinessUnitCustomTypeRemoved Message.
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 billing address on a Business Unit generates the BusinessUnitDefaultBillingAddressSet Message.
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
MyBusinessUnitSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.
MyBusinessUnitUpdate
Example to create an instance using the builder pattern
MyBusinessUnitUpdateAction
Example to create a subtype instance using the builder pattern
MyBusinessUnitUpdateActionBuilder
MyBusinessUnitUpdateAction
MyBusinessUnitUpdateBuilder
Example to create an instance using the builder pattern
MyBusinessUnitUpdate
Adds a DiscountCode to the Cart to activate the related CartDiscounts.
MyCartAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related CartDiscounts.
Adds an address to a Cart when shipping to multiple addresses is desired.
MyCartAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Adds an address to a Cart when shipping to multiple addresses is desired.
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
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.
MyCartAddPaymentAction
Example to create an instance using the builder pattern
MyCartAddPaymentActionBuilder
Example to create an instance using the builder pattern
MyCartAddPaymentAction
To override the shipping details, see Set LineItem ShippingDetails.
MyCartApplyDeltaToLineItemShippingDetailsTargetsActionBuilder
Example to create an instance using the builder pattern
To override the shipping details, see Set LineItem ShippingDetails.
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 multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
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
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.
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
The
customerId is determined by a password flow token and automatically set on the resulting Cart.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
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.
MyCartRemoveDiscountCodeAction
Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
MyCartRemoveDiscountCodeAction
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
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
The LineItem price is updated as described in LineItem Price selection.
MyCartRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
MyCartRemovePaymentAction
Example to create an instance using the builder pattern
MyCartRemovePaymentActionBuilder
Example to create an instance using the builder pattern
MyCartRemovePaymentAction
MyCartSetBillingAddressAction
Example to create an instance using the builder pattern
MyCartSetBillingAddressActionBuilder
Example to create an instance using the builder pattern
MyCartSetBillingAddressAction
Updates the Business Unit on the Cart.
MyCartSetBusinessUnitActionBuilder
Example to create an instance using the builder pattern
Updates the Business Unit on the Cart.
Setting the country can lead to changes in the LineItem prices.
MyCartSetCountryActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
MyCartSetCustomerEmailAction
Example to create an instance using the builder pattern
MyCartSetCustomerEmailActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomerEmailAction
MyCartSetCustomFieldAction
Example to create an instance using the builder pattern
MyCartSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomFieldAction
MyCartSetCustomTypeAction
Example to create an instance using the builder pattern
MyCartSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyCartSetCustomTypeAction
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
Number of days after which a Cart with
Active CartState is deleted since its last modification.MyCartSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemCustomFieldAction
MyCartSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemCustomTypeAction
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
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.MyCartSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
MyCartSetLineItemShippingDetailsAction
Performing this action has no impact on inventory that should be reserved.
MyCartSetLineItemSupplyChannelActionBuilder
Example to create an instance using the builder pattern
Performing this action has no impact on inventory that should be reserved.
MyCartSetLocaleAction
Example to create an instance using the builder pattern
MyCartSetLocaleActionBuilder
Example to create an instance using the builder pattern
MyCartSetLocaleAction
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
Setting the shipping address also sets the TaxRate of Line Items and calculates the TaxedPrice.
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
To set the Cart's Shipping Method the Cart must have the
Single ShippingMode and a shippingAddress.MyCartUpdate
Example to create an instance using the builder pattern
MyCartUpdateAction
Example to create a subtype instance using the builder pattern
MyCartUpdateActionBuilder
MyCartUpdateAction
MyCartUpdateBuilder
Example to create an instance using the builder pattern
MyCartUpdate
Updates an address in
itemShippingAddresses by keeping the Address key.MyCartUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.Draft type to represent the top level of a business.
MyCompanyDraftBuilder
Example to create an instance using the builder pattern
Draft type to represent the top level of a business.
Adding an address to the Customer produces the CustomerAddressAdded Message.
MyCustomerAddAddressActionBuilder
Example to create an instance using the builder pattern
Adding an address to the Customer produces the CustomerAddressAdded Message.
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 billingAddressIds.Adds an address from the
addresses array to shippingAddressIds.MyCustomerAddShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Adds an address from the
addresses array to shippingAddressIds.Changing an address of the Customer produces the CustomerAddressChanged Message.
MyCustomerChangeAddressActionBuilder
Example to create an instance using the builder pattern
Changing an address of the Customer produces the CustomerAddressChanged Message.
Changing the email of the Customer produces the CustomerEmailChanged Message.
MyCustomerChangeEmailActionBuilder
Example to create an instance using the builder pattern
Changing the email of the Customer produces the CustomerEmailChanged Message.
MyCustomerChangePassword
Example to create an instance using the builder pattern
MyCustomerChangePasswordBuilder
Example to create an instance using the builder pattern
MyCustomerChangePassword
MyCustomerDraft
Example to create an instance using the builder pattern
MyCustomerDraftBuilder
Example to create an instance using the builder pattern
MyCustomerDraft
MyCustomerEmailVerify
Example to create an instance using the builder pattern
MyCustomerEmailVerifyBuilder
Example to create an instance using the builder pattern
MyCustomerEmailVerify
Removing an address of the Customer produces the CustomerAddressRemoved Message.
MyCustomerRemoveAddressActionBuilder
Example to create an instance using the builder pattern
Removing an address of the Customer produces the CustomerAddressRemoved Message.
Removes an existing billing address from
billingAddressesIds.MyCustomerRemoveBillingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes an existing billing address from
billingAddressesIds.Removes an existing shipping address from
shippingAddressesIds.MyCustomerRemoveShippingAddressIdActionBuilder
Example to create an instance using the builder pattern
Removes an existing shipping address from
shippingAddressesIds.MyCustomerResetPassword
Example to create an instance using the builder pattern
MyCustomerResetPasswordBuilder
Example to create an instance using the builder pattern
MyCustomerResetPassword
Setting the
companyName field on the Customer produces the CustomerCompanyNameSet Message.MyCustomerSetCompanyNameActionBuilder
Example to create an instance using the builder pattern
Setting the
companyName field on the Customer produces the CustomerCompanyNameSet Message.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 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.
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
Adding or updating a Custom Type on a Customer generates the CustomerCustomTypeSet Message, removing one generates the CustomerCustomTypeRemoved Message.
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
MyCustomerSetDateOfBirthActionBuilder
Example to create an instance using the builder pattern
Setting the date of birth of the Customer produces the CustomerDateOfBirthSet Message.
Sets the default billing address from
addresses.MyCustomerSetDefaultBillingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default billing address from
addresses.Sets the default shipping address from
addresses.MyCustomerSetDefaultShippingAddressActionBuilder
Example to create an instance using the builder pattern
Sets the default shipping address from
addresses.Setting the first name of the Customer produces the CustomerFirstNameSetMessage.
MyCustomerSetFirstNameActionBuilder
Example to create an instance using the builder pattern
Setting the first name of the Customer produces the CustomerFirstNameSetMessage.
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
MyCustomerSetLastNameActionBuilder
Example to create an instance using the builder pattern
Setting the last name of the Customer produces the CustomerLastNameSetMessage.
MyCustomerSetLocaleAction
Example to create an instance using the builder pattern
MyCustomerSetLocaleActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetLocaleAction
MyCustomerSetMiddleNameAction
Example to create an instance using the builder pattern
MyCustomerSetMiddleNameActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetMiddleNameAction
MyCustomerSetSalutationAction
Example to create an instance using the builder pattern
MyCustomerSetSalutationActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetSalutationAction
Setting the title of the Customer produces the CustomerTitleSetMessage.
MyCustomerSetTitleActionBuilder
Example to create an instance using the builder pattern
Setting the title of the Customer produces the CustomerTitleSetMessage.
MyCustomerSetVatIdAction
Example to create an instance using the builder pattern
MyCustomerSetVatIdActionBuilder
Example to create an instance using the builder pattern
MyCustomerSetVatIdAction
MyCustomerSignin
Example to create an instance using the builder pattern
MyCustomerSigninBuilder
Example to create an instance using the builder pattern
MyCustomerSignin
MyCustomerUpdate
Example to create an instance using the builder pattern
MyCustomerUpdateAction
Example to create a subtype instance using the builder pattern
MyCustomerUpdateActionBuilder
MyCustomerUpdateAction
MyCustomerUpdateBuilder
Example to create an instance using the builder pattern
MyCustomerUpdate
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
Draft type to model divisions that are part of the Company or a higher-order Division.
For Product Variant identification, either the
productId and variantId, or sku must be provided.MyLineItemDraftBuilder
Example to create an instance using the builder pattern
For Product Variant identification, either the
productId and variantId, or sku must be provided.MyOrderFromCartDraft
Example to create an instance using the builder pattern
MyOrderFromCartDraftBuilder
Example to create an instance using the builder pattern
MyOrderFromCartDraft
MyOrderFromQuoteDraft
Example to create an instance using the builder pattern
MyOrderFromQuoteDraftBuilder
Example to create an instance using the builder pattern
MyOrderFromQuoteDraft
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
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
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
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
MyPaymentDraft
Example to create an instance using the builder pattern
MyPaymentDraftBuilder
Example to create an instance using the builder pattern
MyPaymentDraft
MyPayment
PagedQueryResult with
results containing an array of MyPayment.MyPaymentPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of MyPayment.MyPaymentSetCustomFieldAction
Example to create an instance using the builder pattern
MyPaymentSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetCustomFieldAction
MyPaymentSetMethodInfoInterfaceAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoInterfaceAction
MyPaymentSetMethodInfoMethodAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoMethodAction
MyPaymentSetMethodInfoNameAction
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetMethodInfoNameAction
MyPaymentSetTransactionCustomFieldAction
Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyPaymentSetTransactionCustomFieldAction
MyPaymentUpdate
Example to create an instance using the builder pattern
MyPaymentUpdateAction
Example to create a subtype instance using the builder pattern
MyPaymentUpdateActionBuilder
MyPaymentUpdateAction
MyPaymentUpdateBuilder
Example to create an instance using the builder pattern
MyPaymentUpdate
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
When accepting, declining, or renegotiating B2B Quotes, the Customer must have the
AcceptMyQuotes, DeclineMyQuotes, or RenegotiateMyQuotes Permission, respectively.Transitions the
quoteRequestState of the Quote Request to Cancelled.MyQuoteRequestCancelActionBuilder
Example to create an instance using the builder pattern
Transitions the
quoteRequestState of the Quote Request to Cancelled.MyQuoteRequestDraft
Example to create an instance using the builder pattern
MyQuoteRequestDraftBuilder
Example to create an instance using the builder pattern
MyQuoteRequestDraft
MyQuoteRequestUpdate
Example to create an instance using the builder pattern
MyQuoteRequestUpdateAction
Example to create a subtype instance using the builder pattern
MyQuoteRequestUpdateActionBuilder
MyQuoteRequestUpdateAction
MyQuoteRequestUpdateBuilder
Example to create an instance using the builder pattern
MyQuoteRequestUpdate
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
MyQuoteUpdateAction
MyQuoteUpdateBuilder
Example to create an instance using the builder pattern
MyQuoteUpdate
MyShoppingListAddLineItemAction
Example to create an instance using the builder pattern
MyShoppingListAddLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListAddLineItemAction
MyShoppingListAddTextLineItemAction
Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListAddTextLineItemAction
MyShoppingListChangeLineItemQuantityAction
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemQuantityAction
MyShoppingListChangeLineItemsOrderAction
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeLineItemsOrderAction
MyShoppingListChangeNameAction
Example to create an instance using the builder pattern
MyShoppingListChangeNameActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeNameAction
MyShoppingListChangeTextLineItemNameAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemNameAction
MyShoppingListChangeTextLineItemQuantityAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemQuantityAction
MyShoppingListChangeTextLineItemsOrderAction
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
MyShoppingListChangeTextLineItemsOrderAction
A MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.
MyShoppingListDraftBuilder
Example to create an instance using the builder pattern
A MyShoppingListDraft is the object submitted as payload to the Create MyShoppingList request.
MyShoppingListRemoveLineItemAction
Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListRemoveLineItemAction
MyShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemActionBuilder
Example to create an instance using the builder pattern
MyShoppingListRemoveTextLineItemAction
MyShoppingListSetCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetCustomFieldAction
MyShoppingListSetCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetCustomTypeAction
MyShoppingListSetDeleteDaysAfterLastModificationAction
Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetDeleteDaysAfterLastModificationAction
MyShoppingListSetDescriptionAction
Example to create an instance using the builder pattern
MyShoppingListSetDescriptionActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetDescriptionAction
MyShoppingListSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomFieldAction
MyShoppingListSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetLineItemCustomTypeAction
MyShoppingListSetTextLineItemCustomFieldAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomFieldAction
MyShoppingListSetTextLineItemCustomTypeAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemCustomTypeAction
MyShoppingListSetTextLineItemDescriptionAction
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionActionBuilder
Example to create an instance using the builder pattern
MyShoppingListSetTextLineItemDescriptionAction
MyShoppingListUpdate
Example to create an instance using the builder pattern
MyShoppingListUpdateAction
Example to create a subtype instance using the builder pattern
MyShoppingListUpdateActionBuilder
MyShoppingListUpdateAction
MyShoppingListUpdateBuilder
Example to create an instance using the builder pattern
MyShoppingListUpdate
MyTransactionDraft
Example to create an instance using the builder pattern
MyTransactionDraftBuilder
Example to create an instance using the builder pattern
MyTransactionDraft
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
Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
Returned when the Project-specific category recommendations feature is not enabled for the Project.
NotEnabledErrorBuilder
Example to create an instance using the builder pattern
Returned when the Project-specific category recommendations feature is not enabled for the Project.
Returned when the requested resource was not found.
ObjectNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the requested resource was not found.
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
A Delivery can only be added to an Order if its
shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.Adds an address to an Order when shipping to multiple addresses is desired.
OrderAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Adds an address to an Order when shipping to multiple addresses is desired.
To add a Parcel, at least one Delivery must exist.
OrderAddParcelToDeliveryActionBuilder
Example to create an instance using the builder pattern
To add a Parcel, at least one Delivery must exist.
OrderAddPaymentAction
Example to create an instance using the builder pattern
OrderAddPaymentActionBuilder
Example to create an instance using the builder pattern
OrderAddPaymentAction
Produces the Return Info Added Message.
OrderAddReturnInfoActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Added Message.
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.
Generated after a successful Set Billing Address update action.
OrderBillingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Billing Address update action.
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 State Changed Message.
Produces the Order Payment State Changed Message.
OrderChangePaymentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Payment State Changed Message.
Produces the Order Shipment State Changed Message.
OrderChangeShipmentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Shipment State Changed Message.
Generated after a successful Create Order request.
OrderCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Order request.
Generated after a successful Create Order request.
OrderCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Order request.
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.
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 Email update action.
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.
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 Group update action.
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.
Generated after a successful Set Customer ID update action.
OrderCustomerSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Customer ID update action.
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.
Generated after adding a Custom Field using the Set CustomField.
OrderCustomFieldAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after adding a Custom Field using the Set CustomField.
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.
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 an existing Custom Field has been changed using the Set CustomField action.
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.
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 when a Custom Field has been removed from the Order using the Set CustomField action.
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.
Generated after a successful Add CustomLineItem update action.
OrderCustomLineItemAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add CustomLineItem update action.
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.
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 recalculation of a Discount on a Custom Line Item.
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.
Generated after a successful Change CustomLineItem Quantity update action.
OrderCustomLineItemQuantityChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change CustomLineItem Quantity update action.
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.
Generated after a successful Remove CustomLineItem update action.
OrderCustomLineItemRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove CustomLineItem update action.
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.
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 with empty parameters.
Generated after a successful Set Custom Type.
OrderCustomTypeSetMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type.
Generated after a successful Set Custom Type.
OrderCustomTypeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Custom Type.
Generated after a successful Delete Order request.
OrderDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
Generated after a successful Delete Order request.
OrderDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Order request.
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.
Generated after a successful Add DiscountCode update action.
OrderDiscountCodeAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add DiscountCode update action.
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.
Generated after a successful Remove DiscountCode update action.
OrderDiscountCodeRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove DiscountCode update action.
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.
Generated after the DiscountCodeState changes due to a recalculation.
OrderDiscountCodeStateSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after the DiscountCodeState changes due to a recalculation.
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
If the edit was applied, this cannot be updated.
Result of a succesful application of
stagedActions to the Order.OrderEditAppliedBuilder
Example to create an instance using the builder pattern
Result of a succesful application of
stagedActions to the Order.Generated after successfully applying an OrderEdit.
OrderEditAppliedMessageBuilder
Example to create an instance using the builder pattern
Generated after successfully applying an OrderEdit.
Generated after successfully applying an OrderEdit.
OrderEditAppliedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after successfully applying an OrderEdit.
If the
editVersion and/or resourceVersion do not match the actual version, a 409 Conflict will be returned.OrderEditApplyBuilder
Example to create an instance using the builder pattern
If the
editVersion and/or resourceVersion do not match the actual version, a 409 Conflict will be returned.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
OrderEditDraft
OrderEdit
Indicates that the edit has not been applied or processed in any way.
OrderEditNotProcessedBuilder
Example to create an instance using the builder pattern
Indicates that the edit has not been applied or processed in any way.
PagedQueryResult with
results containing an array of OrderEdit.OrderEditPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of OrderEdit.Result of a failed application of
stagedActions to the Order.OrderEditPreviewFailureBuilder
Example to create an instance using the builder pattern
Result of a failed application of
stagedActions to the Order.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
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.Reference to an OrderEdit.
OrderEditReferenceBuilder
Example to create an instance using the builder pattern
Reference to an OrderEdit.
ResourceIdentifier to an OrderEdit.
OrderEditResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to an OrderEdit.
OrderEditResult
Example to create a subtype instance using the builder pattern
OrderEditResultBuilder
OrderEditResult
OrderEditSetCommentAction
Example to create an instance using the builder pattern
OrderEditSetCommentActionBuilder
Example to create an instance using the builder pattern
OrderEditSetCommentAction
OrderEditSetCustomFieldAction
Example to create an instance using the builder pattern
OrderEditSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderEditSetCustomFieldAction
OrderEditSetCustomTypeAction
Example to create an instance using the builder pattern
OrderEditSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderEditSetCustomTypeAction
OrderEditSetKeyAction
Example to create an instance using the builder pattern
OrderEditSetKeyActionBuilder
Example to create an instance using the builder pattern
OrderEditSetKeyAction
If the edit is applied,
stagedActions cannot be updated.OrderEditSetStagedActionsActionBuilder
Example to create an instance using the builder pattern
If the edit is applied,
stagedActions cannot be updated.OrderEditUpdate
Example to create an instance using the builder pattern
OrderEditUpdateAction
Example to create a subtype instance using the builder pattern
OrderEditUpdateActionBuilder
OrderEditUpdateAction
OrderEditUpdateBuilder
Example to create an instance using the builder pattern
OrderEditUpdate
Excerpt of the Order extracting the total and the taxed price.
OrderExcerptBuilder
Example to create an instance using the builder pattern
Excerpt of the Order extracting the total and the taxed price.
OrderFromCartDraft
Example to create an instance using the builder pattern
OrderFromCartDraftBuilder
Example to create an instance using the builder pattern
OrderFromCartDraft
OrderFromQuoteDraft
Example to create an instance using the builder pattern
OrderFromQuoteDraftBuilder
Example to create an instance using the builder pattern
OrderFromQuoteDraft
Order
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
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
A snapshot of an Order at the time it was imported.
OrderImportDraftBuilder
Example to create an instance using the builder pattern
A snapshot of an Order at the time it was imported.
Generated after a successful Order Import.
OrderImportedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Order Import.
Generated after a successful Order Import.
OrderImportedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Order Import.
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 import of States does not follow any predefined rules and should be only used if no transitions are defined.
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.
Generated after a successful Add LineItem update action.
OrderLineItemAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add LineItem update action.
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.
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 recalculation of a Discount on a Line Item.
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.
Generated after a successful Set LineItem DistributionChannel update action.
OrderLineItemDistributionChannelSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set LineItem DistributionChannel update action.
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.
Generated after a successful Remove LineItem update action.
OrderLineItemRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove LineItem update action.
OrderMessage
Example to create an instance using the builder pattern
OrderMessage
OrderMessagePayload
Example to create an instance using the builder pattern
OrderMessagePayload
PagedQueryResult with
results containing an array of Order.OrderPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Order.OrderPagedSearchResponse
Example to create an instance using the builder pattern
OrderPagedSearchResponseBuilder
Example to create an instance using the builder pattern
OrderPagedSearchResponse
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.
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 Add Payment update action or when a Payment is added via Order Edits.
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.
Generated after a successful Change PaymentState update action.
OrderPaymentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change PaymentState update action.
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.
Generated after a successful Set Purchase Order Number update action.
OrderPurchaseOrderNumberSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Purchase Order Number update action.
Reference to an Order.
OrderReferenceBuilder
Example to create an instance using the builder pattern
Reference to an Order.
Produces the DeliveryRemoved Message.
OrderRemoveDeliveryActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryRemoved Message.
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
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
Produces the ParcelRemovedFromDelivery Message.
OrderRemoveParcelFromDeliveryActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelRemovedFromDelivery Message.
OrderRemovePaymentAction
Example to create an instance using the builder pattern
OrderRemovePaymentActionBuilder
Example to create an instance using the builder pattern
OrderRemovePaymentAction
Deprecated.
Deprecated.
Deprecated.
Generated after a successful Set ReturnShipmentState update action.
OrderReturnShipmentStateChangedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnShipmentState update action.
Generated after a successful Set ReturnShipmentState update action.
OrderReturnShipmentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnShipmentState update action.
OrderSearchAndExpression
Example to create an instance using the builder pattern
OrderSearchAndExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchAndExpression
OrderSearchAnyValue
Example to create an instance using the builder pattern
OrderSearchAnyValueBuilder
Example to create an instance using the builder pattern
OrderSearchAnyValue
OrderSearchCompoundExpression
Example to create an instance using the builder pattern
OrderSearchCompoundExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchCompoundExpression
OrderSearchDateRangeExpression
Example to create an instance using the builder pattern
OrderSearchDateRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchDateRangeExpression
OrderSearchDateRangeValue
Example to create an instance using the builder pattern
OrderSearchDateRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchDateRangeValue
OrderSearchExactExpression
Example to create an instance using the builder pattern
OrderSearchExactExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchExactExpression
OrderSearchExistsExpression
Example to create an instance using the builder pattern
OrderSearchExistsExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchExistsExpression
OrderSearchFilterExpression
Example to create an instance using the builder pattern
OrderSearchFilterExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchFilterExpression
OrderSearchFullTextExpression
Example to create an instance using the builder pattern
OrderSearchFullTextExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchFullTextExpression
OrderSearchFullTextValue
Example to create an instance using the builder pattern
OrderSearchFullTextValueBuilder
Example to create an instance using the builder pattern
OrderSearchFullTextValue
OrderSearchLongRangeExpression
Example to create an instance using the builder pattern
OrderSearchLongRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchLongRangeExpression
OrderSearchLongRangeValue
Example to create an instance using the builder pattern
OrderSearchLongRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchLongRangeValue
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
OrderSearchNotExpression
OrderSearchNumberRangeExpression
Example to create an instance using the builder pattern
OrderSearchNumberRangeExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchNumberRangeExpression
OrderSearchNumberRangeValue
Example to create an instance using the builder pattern
OrderSearchNumberRangeValueBuilder
Example to create an instance using the builder pattern
OrderSearchNumberRangeValue
OrderSearchOrExpression
Example to create an instance using the builder pattern
OrderSearchOrExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchOrExpression
OrderSearchPrefixExpression
Example to create an instance using the builder pattern
OrderSearchPrefixExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchPrefixExpression
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
OrderSearchQueryExpression
OrderSearchQueryExpressionValue
Example to create an instance using the builder pattern
OrderSearchQueryExpressionValueBuilder
Example to create an instance using the builder pattern
OrderSearchQueryExpressionValue
OrderSearchQuery
OrderSearchRequest
Example to create an instance using the builder pattern
OrderSearchRequestBuilder
Example to create an instance using the builder pattern
OrderSearchRequest
OrderSearchSorting
Example to create an instance using the builder pattern
OrderSearchSortingBuilder
Example to create an instance using the builder pattern
OrderSearchSorting
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
OrderSearchStringValue
OrderSearchWildCardExpression
Example to create an instance using the builder pattern
OrderSearchWildCardExpressionBuilder
Example to create an instance using the builder pattern
OrderSearchWildCardExpression
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
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.OrderSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomFieldAction
OrderSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetBillingAddressCustomTypeAction
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
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.Setting the Order's
customerId does not recalculate prices or discounts on the Order.OrderSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
Setting the Order's
customerId does not recalculate prices or discounts on the Order.OrderSetCustomFieldAction
Example to create an instance using the builder pattern
OrderSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomFieldAction
OrderSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomFieldAction
OrderSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemCustomTypeAction
OrderSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomLineItemShippingDetailsAction
OrderSetCustomTypeAction
Example to create an instance using the builder pattern
OrderSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetCustomTypeAction
Produces the DeliveryAddressSet Message.
OrderSetDeliveryAddressActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryAddressSet Message.
OrderSetDeliveryAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomFieldAction
OrderSetDeliveryAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryAddressCustomTypeAction
OrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryCustomFieldAction
OrderSetDeliveryCustomTypeAction
Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetDeliveryCustomTypeAction
Produces the Delivery Items Updated Message.
OrderSetDeliveryItemsActionBuilder
Example to create an instance using the builder pattern
Produces the Delivery Items Updated Message.
OrderSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomFieldAction
OrderSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetItemShippingAddressCustomTypeAction
OrderSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemCustomFieldAction
OrderSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemCustomTypeAction
OrderSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
OrderSetLineItemShippingDetailsAction
OrderSetLocaleAction
Example to create an instance using the builder pattern
OrderSetLocaleActionBuilder
Example to create an instance using the builder pattern
OrderSetLocaleAction
OrderSetOrderNumberAction
Example to create an instance using the builder pattern
OrderSetOrderNumberActionBuilder
Example to create an instance using the builder pattern
OrderSetOrderNumberAction
OrderSetParcelCustomFieldAction
Example to create an instance using the builder pattern
OrderSetParcelCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetParcelCustomFieldAction
OrderSetParcelCustomTypeAction
Example to create an instance using the builder pattern
OrderSetParcelCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetParcelCustomTypeAction
Produces the ParcelItemsUpdated Message.
OrderSetParcelItemsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelItemsUpdated Message.
Produces the ParcelMeasurementsUpdated Message.
OrderSetParcelMeasurementsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelMeasurementsUpdated Message.
Produces the ParcelTrackingDataUpdated Message.
OrderSetParcelTrackingDataActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelTrackingDataUpdated Message.
Produces the PurchaseOrderNumberSet Message.
OrderSetPurchaseOrderNumberActionBuilder
Example to create an instance using the builder pattern
Produces the PurchaseOrderNumberSet Message.
Produces the Return Info Set Message.
OrderSetReturnInfoActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Set Message.
OrderSetReturnItemCustomFieldAction
Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetReturnItemCustomFieldAction
OrderSetReturnItemCustomTypeAction
Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetReturnItemCustomTypeAction
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 ReturnPaymentState, the Order
returnInfo must have at least one ReturnItem.To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.OrderSetReturnShipmentStateActionBuilder
Example to create an instance using the builder pattern
To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.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
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.OrderSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomFieldAction
OrderSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
OrderSetShippingAddressCustomTypeAction
Sets the Store the Order is assigned to.
OrderSetStoreActionBuilder
Example to create an instance using the builder pattern
Sets the Store the Order is assigned to.
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.
Generated after a successful Change ShipmentState update action.
OrderShipmentStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change ShipmentState update action.
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.
Generated after a successful Set Shipping Address update action.
OrderShippingAddressSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Shipping Address update action.
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.
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 ShippingMethod and Set Custom ShippingMethod update actions.
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.
Generated after a successful Set ShippingRateInput update action.
OrderShippingRateInputSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ShippingRateInput update action.
Indicates the state of the Order.
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.
Generated after a successful Change OrderState update action.
OrderStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change OrderState update action.
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.
Generated after a successful Transition State update action.
OrderStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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.
Generated after a successful Set Store update action.
OrderStoreSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Store update action.
Produces the Custom Line Item State Transition Message.
OrderTransitionCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Custom Line Item State Transition Message.
Produces the Line Item State Transition Message.
OrderTransitionLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Line Item State Transition Message.
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
If the existing State has set
transitions, there must be a direct transition to the new State.OrderUpdate
Example to create an instance using the builder pattern
OrderUpdateAction
Example to create a subtype instance using the builder pattern
OrderUpdateActionBuilder
OrderUpdateAction
OrderUpdateBuilder
Example to create an instance using the builder pattern
OrderUpdate
Updates an address in
itemShippingAddresses by keeping the Address key.OrderUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.OrderUpdateSyncInfoAction
Example to create an instance using the builder pattern
OrderUpdateSyncInfoActionBuilder
Example to create an instance using the builder pattern
OrderUpdateSyncInfoAction
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 some of the Line Items are out of stock at the time of placing an Order.
Returned when the service is having trouble handling the load.
OverCapacityErrorBuilder
Example to create an instance using the builder pattern
Returned when the service is having trouble handling the load.
Returned when a given Price validity period conflicts with an existing one.
OverlappingStandalonePriceValidityErrorBuilder
Example to create an instance using the builder pattern
Returned when a given Price validity period conflicts with an existing one.
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
PagedQueryResponse
PagingTrait
Information regarding the appearance, content, and shipment of a Parcel.
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.
Generated after a successful Add Parcel to Delivery update action.
ParcelAddedToDeliveryMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Parcel to Delivery update action.
ParcelBuilder
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
ParcelDraft
Information regarding the appearance, content, and shipment of a Parcel.
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.
Generated after a successful Set Parcel Items update action.
ParcelItemsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Items update action.
ParcelMeasurements
Example to create an instance using the builder pattern
ParcelMeasurementsBuilder
Example to create an instance using the builder pattern
ParcelMeasurements
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.
Generated after a successful Set Parcel Measurements update action.
ParcelMeasurementsUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Measurements update action.
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.
Generated after a successful Remove Parcel from Delivery update action.
ParcelRemovedFromDeliveryMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Parcel from Delivery update action.
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.
Generated after a successful Set Parcel Tracking Data update action.
ParcelTrackingDataUpdatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Parcel Tracking Data update action.
PayloadNotIncluded
Example to create an instance using the builder pattern
PayloadNotIncludedBuilder
Example to create an instance using the builder pattern
PayloadNotIncluded
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 Payment interaction generates the PaymentInteractionAdded Message.
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
PaymentAddTransactionActionBuilder
Example to create an instance using the builder pattern
Adding a Transaction to a Payment generates the PaymentTransactionAdded Message.
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
Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.
PaymentChangeTransactionInteractionIdAction
Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdActionBuilder
Example to create an instance using the builder pattern
PaymentChangeTransactionInteractionIdAction
Changing the TransactionState generates the PaymentTransactionStateChanged Message.
PaymentChangeTransactionStateActionBuilder
Example to create an instance using the builder pattern
Changing the TransactionState generates the PaymentTransactionStateChanged Message.
PaymentChangeTransactionTimestampAction
Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampActionBuilder
Example to create an instance using the builder pattern
PaymentChangeTransactionTimestampAction
Generated after a successful Create Payment request.
PaymentCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
Generated after a successful Create Payment request.
PaymentCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Payment request.
PaymentDraft
Example to create an instance using the builder pattern
PaymentDraftBuilder
Example to create an instance using the builder pattern
PaymentDraft
Payment
PaymentInfo
Example to create an instance using the builder pattern
PaymentInfoBuilder
Example to create an instance using the builder pattern
PaymentInfo
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.
Generated after a successful Add InterfaceInteraction update action.
PaymentInteractionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add InterfaceInteraction update action.
PaymentMethodInfo
Example to create an instance using the builder pattern
PaymentMethodInfoBuilder
Example to create an instance using the builder pattern
PaymentMethodInfo
PagedQueryResult with
results containing an array of Payment.PaymentPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Payment.Reference to a Payment.
PaymentReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Payment.
ResourceIdentifier of a Payment.
PaymentResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of a Payment.
PaymentSetAnonymousIdAction
Example to create an instance using the builder pattern
PaymentSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
PaymentSetAnonymousIdAction
PaymentSetCustomerAction
Example to create an instance using the builder pattern
PaymentSetCustomerActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomerAction
PaymentSetCustomFieldAction
Example to create an instance using the builder pattern
PaymentSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomFieldAction
PaymentSetCustomTypeAction
Example to create an instance using the builder pattern
PaymentSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
PaymentSetCustomTypeAction
PaymentSetInterfaceIdAction
Example to create an instance using the builder pattern
PaymentSetInterfaceIdActionBuilder
Example to create an instance using the builder pattern
PaymentSetInterfaceIdAction
PaymentSetKeyAction
Example to create an instance using the builder pattern
PaymentSetKeyActionBuilder
Example to create an instance using the builder pattern
PaymentSetKeyAction
PaymentSetMethodInfoInterfaceAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoInterfaceAction
PaymentSetMethodInfoMethodAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoMethodAction
PaymentSetMethodInfoNameAction
Example to create an instance using the builder pattern
PaymentSetMethodInfoNameActionBuilder
Example to create an instance using the builder pattern
PaymentSetMethodInfoNameAction
Produces the PaymentStatusInterfaceCodeSet Message.
PaymentSetStatusInterfaceCodeActionBuilder
Example to create an instance using the builder pattern
Produces the PaymentStatusInterfaceCodeSet Message.
PaymentSetStatusInterfaceTextAction
Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextActionBuilder
Example to create an instance using the builder pattern
PaymentSetStatusInterfaceTextAction
PaymentSetTransactionCustomFieldAction
Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldActionBuilder
Example to create an instance using the builder pattern
PaymentSetTransactionCustomFieldAction
PaymentSetTransactionCustomTypeAction
Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeActionBuilder
Example to create an instance using the builder pattern
PaymentSetTransactionCustomTypeAction
Indicates the payment status for the Order.
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
PaymentStatusDraft
PaymentStatus
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.
Generated after a successful Set StatusInterfaceCode update action.
PaymentStatusInterfaceCodeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set StatusInterfaceCode update action.
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.
Generated after a successful Transition State update action.
PaymentStatusStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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.
Generated after a successful Add Transaction update action.
PaymentTransactionAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Transaction update action.
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.
Generated after a successful Change TransactionState update action.
PaymentTransactionStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change TransactionState update action.
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
If the Payment has no current State,
initial must be true for the new State.PaymentUpdate
Example to create an instance using the builder pattern
PaymentUpdateAction
Example to create a subtype instance using the builder pattern
PaymentUpdateActionBuilder
PaymentUpdateAction
PaymentUpdateBuilder
Example to create an instance using the builder pattern
PaymentUpdate
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
Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
Permissions grant granular access to Approval Rules, Approval Flows, Business Units, Carts, Orders, Quotes, and Quote Requests.
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
The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the Messages Query HTTP API.
The representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode is
Embedded.PriceBuilder
Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
PriceChangedErrorBuilder
Example to create an instance using the builder pattern
Returned when the Price, Tax Rate, or Shipping Rate of some Line Items changed since they were last added to the Cart.
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 draft representation for prices to be embedded into ProductVariantDrafts when the ProductPriceMode is
Embedded.PriceFunction
Example to create an instance using the builder pattern
PriceFunctionBuilder
Example to create an instance using the builder pattern
PriceFunction
The representation for prices embedded in LineItems and in ProductVariants when the ProductPriceMode is
Embedded.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.
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
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.
A Price tier is selected instead of the default Price when a certain quantity of the ProductVariant is added to a Cart and ordered.
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
Either
variantId or sku is required.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.
Generated after a successful Add to Category update action.
ProductAddedToCategoryMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add to Category update action.
Either
variantId or sku is required.ProductAddExternalImageActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Adds the given Price to the
prices array of the ProductVariant.ProductAddPriceActionBuilder
Example to create an instance using the builder pattern
Adds the given Price to the
prices array of the ProductVariant.Produces the ProductAddedToCategory Message.
ProductAddToCategoryActionBuilder
Example to create an instance using the builder pattern
Produces the ProductAddedToCategory Message.
ProductAddVariantAction
Example to create an instance using the builder pattern
ProductAddVariantActionBuilder
Example to create an instance using the builder pattern
ProductAddVariantAction
Returned when a Product is not assigned to the Product Selection.
ProductAssignmentMissingErrorBuilder
Example to create an instance using the builder pattern
Returned when a Product is not assigned to the Product Selection.
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
Contains the
current and staged ProductData.Either
variantId or sku is required.ProductChangeAssetNameActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductChangeAssetOrderActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.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
Assigns the specified Product Variant to the
masterVariant and removes the same from variants at the same time.ProductChangeNameAction
Example to create an instance using the builder pattern
ProductChangeNameActionBuilder
Example to create an instance using the builder pattern
ProductChangeNameAction
ProductChangePriceAction
Example to create an instance using the builder pattern
ProductChangePriceActionBuilder
Example to create an instance using the builder pattern
ProductChangePriceAction
Produces the ProductSlugChanged Message.
ProductChangeSlugActionBuilder
Example to create an instance using the builder pattern
Produces the ProductSlugChanged Message.
Generated after a successful Create Product request.
ProductCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product request.
Generated after a successful Create Product request.
ProductCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product request.
Contains all the data of a Product and its Product Variants.
ProductDataBuilder
Example to create an instance using the builder pattern
Contains all the data of a Product and its Product Variants.
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.
Generated after a successful Delete Product request.
ProductDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product request.
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
ProductDiscountChangeIsActiveAction
ProductDiscountChangeNameAction
Example to create an instance using the builder pattern
ProductDiscountChangeNameActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeNameAction
ProductDiscountChangePredicateAction
Example to create an instance using the builder pattern
ProductDiscountChangePredicateActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangePredicateAction
ProductDiscountChangeSortOrderAction
Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeSortOrderAction
ProductDiscountChangeValueAction
Example to create an instance using the builder pattern
ProductDiscountChangeValueActionBuilder
Example to create an instance using the builder pattern
ProductDiscountChangeValueAction
ProductDiscountDraft
Example to create an instance using the builder pattern
ProductDiscountDraftBuilder
Example to create an instance using the builder pattern
ProductDiscountDraft
ProductDiscount
ProductDiscountMatchQuery
Example to create an instance using the builder pattern
ProductDiscountMatchQueryBuilder
Example to create an instance using the builder pattern
ProductDiscountMatchQuery
PagedQueryResult with results containing an array of ProductDiscount.
ProductDiscountPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductDiscount.
Reference to a ProductDiscount.
ProductDiscountReferenceBuilder
Example to create an instance using the builder pattern
Reference to a ProductDiscount.
ResourceIdentifier to a ProductDiscount.
ProductDiscountResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductDiscount.
ProductDiscountSetDescriptionAction
Example to create an instance using the builder pattern
ProductDiscountSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetDescriptionAction
ProductDiscountSetKeyAction
Example to create an instance using the builder pattern
ProductDiscountSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetKeyAction
ProductDiscountSetValidFromAction
Example to create an instance using the builder pattern
ProductDiscountSetValidFromActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAction
ProductDiscountSetValidFromAndUntilAction
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidFromAndUntilAction
ProductDiscountSetValidUntilAction
Example to create an instance using the builder pattern
ProductDiscountSetValidUntilActionBuilder
Example to create an instance using the builder pattern
ProductDiscountSetValidUntilAction
ProductDiscountUpdate
Example to create an instance using the builder pattern
ProductDiscountUpdateAction
Example to create a subtype instance using the builder pattern
ProductDiscountUpdateActionBuilder
ProductDiscountUpdateAction
ProductDiscountUpdateBuilder
Example to create an instance using the builder pattern
ProductDiscountUpdate
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
Discounts the Product Price by a fixed amount, defined by the
money field.Discounts the Product's Price by a fixed amount, defined by the
money field.ProductDiscountValueBuilder
ProductDiscountValueDraft
Example to create a subtype instance using the builder pattern
ProductDiscountValueDraftBuilder
ProductDiscountValueDraft
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 allowing the client to explicitly set a discounted value.
Discounts the Product Price by allowing the client to explicitly set a discounted value.
ProductDiscountValue
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
Discounts the Product Price by a percentage, defined by the
permyriad field.Discounts the product price by a percentage, defined by the
permyriad field.ProductDraft
Example to create an instance using the builder pattern
ProductDraftBuilder
Example to create an instance using the builder pattern
ProductDraft
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.
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
Generated after a successful Add External Image update action or after the successful upload of an image.
An abstract sellable good with a set of Attributes defined by a Product Type.
ProductLegacySetSkuAction
Example to create an instance using the builder pattern
ProductLegacySetSkuActionBuilder
Example to create an instance using the builder pattern
ProductLegacySetSkuAction
Either
variantId or sku is required.ProductMoveImageToPositionActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.PagedQueryResult with
results containing an array of Product.ProductPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Product.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
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.
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.
Generated after a successful Add Price update action.
ProductPriceAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price update action.
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.
Generated after a successful Change Price update action.
ProductPriceChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Price update action.
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.
Generated after a Price is updated due to a Product Discount.
ProductPriceDiscountsSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a Price is updated due to a Product Discount.
Details about a Embedded Price that was updated due to a Discount.
ProductPriceDiscountsSetUpdatedPriceBuilder
Example to create an instance using the builder pattern
Details about a Embedded Price that was updated due to a Discount.
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.
Generated after a successful Set Discounted Price update action.
ProductPriceExternalDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
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.
Generated after a successful Set Price Key update action.
ProductPriceKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Key update action.
This mode determines the type of Prices used for Product Price Selection and for LineItem Price selection.
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.
Generated after a successful Set PriceMode update action.
ProductPriceModeSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set PriceMode update action.
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.
Generated after a successful Remove Price update action.
ProductPriceRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price update action.
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.
Generated after a successful Set Prices update action.
ProductPricesSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Prices update action.
ProductProjection
Example to create an instance using the builder pattern
ProductProjectionBuilder
Example to create an instance using the builder pattern
ProductProjection
ProductProjectionPagedQueryResponse
Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
ProductProjectionPagedQueryResponse
ProductProjectionPagedSearchResponse
Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponseBuilder
Example to create an instance using the builder pattern
ProductProjectionPagedSearchResponse
Publishes product data from the Product's staged projection to its current projection.
ProductPublishActionBuilder
Example to create an instance using the builder pattern
Publishes product data from the Product's staged projection to its current projection.
Generated after a successful Publish update action.
ProductPublishedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Publish update action.
Generated after a successful Publish update action.
ProductPublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Publish update action.
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
Reference to a Product.
Either
variantId or sku is required.ProductRemoveAssetActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.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.
Generated after a successful Remove from Category update action.
ProductRemovedFromCategoryMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove from Category update action.
Produces the ProductRemovedFromCategory Message.
ProductRemoveFromCategoryActionBuilder
Example to create an instance using the builder pattern
Produces the ProductRemovedFromCategory Message.
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
Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted).
ProductRemovePriceAction
Example to create an instance using the builder pattern
ProductRemovePriceActionBuilder
Example to create an instance using the builder pattern
ProductRemovePriceAction
Either
id or sku is required.ProductRemoveVariantActionBuilder
Example to create an instance using the builder pattern
Either
id or sku is required.ResourceIdentifier to a Product.
ProductResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Product.
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.
Generated after a successful Revert Staged Changes update action.
ProductRevertedStagedChangesMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Revert Staged Changes update action.
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 Product to the current version.
Reverts the staged version of a ProductVariant to the current version.
ProductRevertStagedVariantChangesActionBuilder
Example to create an instance using the builder pattern
Reverts the staged version of a ProductVariant to the current version.
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
Adds a Product to the Product Selection.
Given the mode of Product Selection, this assignment refers to, it may contain:
ProductSelectionAssignmentBuilder
Example to create an instance using the builder pattern
Given the mode of Product Selection, this assignment refers to, it may contain:
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
ProductSelectionChangeNameAction
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.
Generated after a successful Create Product Selection request.
ProductSelectionCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Product Selection request.
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.
Generated after a successful Delete Product Selection request.
ProductSelectionDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Product Selection request.
ProductSelectionDraft
Example to create an instance using the builder pattern
ProductSelectionDraftBuilder
Example to create an instance using the builder pattern
ProductSelectionDraft
Excludes a Product from a Product Selection with
IndividualExclusion ProductSelectionMode.ProductSelectionExcludeProductActionBuilder
Example to create an instance using the builder pattern
Excludes a Product from a Product Selection with
IndividualExclusion ProductSelectionMode.ProductSelection
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
PagedQueryResult containing an array of ProductSelection.
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.
Generated after a successful Add Product update action.
ProductSelectionProductAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Product update action.
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.
Generated after a successful Exclude Product update action.
ProductSelectionProductExcludedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Exclude Product update action.
PagedQueryResult containing an array of AssignedProductReference.
ProductSelectionProductPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of AssignedProductReference.
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.
Generated after a successful Remove Product update action.
ProductSelectionProductRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Product update action.
Reference to a ProductSelection.
ProductSelectionReferenceBuilder
Example to create an instance using the builder pattern
Reference to a ProductSelection.
ProductSelectionRemoveProductAction
Example to create an instance using the builder pattern
ProductSelectionRemoveProductActionBuilder
Example to create an instance using the builder pattern
ProductSelectionRemoveProductAction
ResourceIdentifier to a ProductSelection.
ProductSelectionResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductSelection.
ProductSelectionSetCustomFieldAction
Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetCustomFieldAction
ProductSelectionSetCustomTypeAction
Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetCustomTypeAction
ProductSelectionSetKeyAction
Example to create an instance using the builder pattern
ProductSelectionSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductSelectionSetKeyAction
ProductSelectionSetting
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
ProductSelectionSettingDraft
ProductSelectionSetting
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 Exclusion of an existing Product Selection Assignment.
Updates the Product Variant Selection of an existing Product Selection Assignment.
ProductSelectionSetVariantSelectionActionBuilder
Example to create an instance using the builder pattern
Updates the Product Variant Selection of an existing Product Selection Assignment.
ProductSelectionUpdate
Example to create an instance using the builder pattern
ProductSelectionUpdateAction
Example to create a subtype instance using the builder pattern
ProductSelectionUpdateActionBuilder
ProductSelectionUpdateAction
ProductSelectionUpdateBuilder
Example to create an instance using the builder pattern
ProductSelectionUpdate
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.
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 Exclusion update action.
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.
Generated after a successful Set Variant Selection update action.
ProductSelectionVariantSelectionChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Variant Selection update action.
Either
variantId or sku is required.ProductSetAssetCustomFieldActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAssetCustomTypeActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAssetDescriptionActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAssetKeyActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAssetSourcesActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAssetTagsActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.Either
variantId or sku is required.ProductSetAttributeActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.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
Adds, removes, or changes a Product Attribute in all Product Variants at the same time.
ProductSetCategoryOrderHintAction
Example to create an instance using the builder pattern
ProductSetCategoryOrderHintActionBuilder
Example to create an instance using the builder pattern
ProductSetCategoryOrderHintAction
ProductSetDescriptionAction
Example to create an instance using the builder pattern
ProductSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductSetDescriptionAction
Produces the ProductPriceExternalDiscountSet Message.
ProductSetDiscountedPriceActionBuilder
Example to create an instance using the builder pattern
Produces the ProductPriceExternalDiscountSet Message.
Either
variantId or sku is required.ProductSetImageLabelActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetKeyAction
Example to create an instance using the builder pattern
ProductSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductSetKeyAction
ProductSetMetaDescriptionAction
Example to create an instance using the builder pattern
ProductSetMetaDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaDescriptionAction
ProductSetMetaKeywordsAction
Example to create an instance using the builder pattern
ProductSetMetaKeywordsActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaKeywordsAction
ProductSetMetaTitleAction
Example to create an instance using the builder pattern
ProductSetMetaTitleActionBuilder
Example to create an instance using the builder pattern
ProductSetMetaTitleAction
Sets the key of an Embedded Price.
ProductSetPriceKeyActionBuilder
Example to create an instance using the builder pattern
Sets the key of an Embedded Price.
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
Controls whether the Prices of a Product Variant are embedded into the Product or standalone.
Either
variantId or sku is required.ProductSetPricesActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetProductPriceCustomFieldAction
Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldActionBuilder
Example to create an instance using the builder pattern
ProductSetProductPriceCustomFieldAction
ProductSetProductPriceCustomTypeAction
Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeActionBuilder
Example to create an instance using the builder pattern
ProductSetProductPriceCustomTypeAction
Either
variantId or sku is required.ProductSetProductVariantKeyActionBuilder
Example to create an instance using the builder pattern
Either
variantId or sku is required.ProductSetSearchKeywordsAction
Example to create an instance using the builder pattern
ProductSetSearchKeywordsActionBuilder
Example to create an instance using the builder pattern
ProductSetSearchKeywordsAction
SKU cannot be changed or removed if it is associated with an InventoryEntry.
ProductSetSkuActionBuilder
Example to create an instance using the builder pattern
SKU cannot be changed or removed if it is associated with an InventoryEntry.
Cannot be staged.
ProductSetTaxCategoryActionBuilder
Example to create an instance using the builder pattern
Cannot be staged.
PagedQueryResult containing an array of ProductSelectionAssignment.
ProductsInStorePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult containing an array of ProductSelectionAssignment.
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.
Generated after a successful Change Slug update action.
ProductSlugChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Slug update action.
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.
Generated after a successful Transition State update action.
ProductStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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
If the existing State has set
transitions, there must be a direct transition to the new State.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
ProductTypeAddAttributeDefinitionAction
Adds a localizable enum to the values of AttributeLocalizedEnumType.
ProductTypeAddLocalizedEnumValueActionBuilder
Example to create an instance using the builder pattern
Adds a localizable enum to the values of AttributeLocalizedEnumType.
Adds an enum to the values of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
ProductTypeAddPlainEnumValueActionBuilder
Example to create an instance using the builder pattern
Adds an enum to the values of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.
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
Updates the
attributeConstraint of an AttributeDefinition.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
Renames an AttributeDefinition and also renames all corresponding Attributes on all Products with this ProductType.
ProductTypeChangeAttributeOrderByNameAction
Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeAttributeOrderByNameAction
ProductTypeChangeDescriptionAction
Example to create an instance using the builder pattern
ProductTypeChangeDescriptionActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeDescriptionAction
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 key of a single enum
value in an AttributeEnumType AttributeDefinition, AttributeLocalizedEnumType AttributeDefinition, AttributeSetType of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.Updates the
inputHint of an AttributeDefinition.ProductTypeChangeInputHintActionBuilder
Example to create an instance using the builder pattern
Updates the
inputHint of an AttributeDefinition.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
Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint.
ProductTypeChangeLabelAction
Example to create an instance using the builder pattern
ProductTypeChangeLabelActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeLabelAction
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 label of a single enum
value in an AttributeLocalizedEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.Updates the order of localized enum
values in an AttributeLocalizedEnumType AttributeDefinition.ProductTypeChangeLocalizedEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
Updates the order of localized enum
values in an AttributeLocalizedEnumType AttributeDefinition.ProductTypeChangeNameAction
Example to create an instance using the builder pattern
ProductTypeChangeNameActionBuilder
Example to create an instance using the builder pattern
ProductTypeChangeNameAction
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 label of a single enum
value in an AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeEnumType AttributeDefinition.Updates the order of enum
values in an AttributeEnumType AttributeDefinition.ProductTypeChangePlainEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
Updates the order of enum
values in an AttributeEnumType AttributeDefinition.ProductTypeDraft
Example to create an instance using the builder pattern
ProductTypeDraftBuilder
Example to create an instance using the builder pattern
ProductTypeDraft
ProductType
PagedQueryResult with results containing an array of ProductType.
ProductTypePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of ProductType.
Reference to a ProductType.
ProductTypeReferenceBuilder
Example to create an instance using the builder pattern
Reference to a ProductType.
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 an AttributeDefinition and also deletes all corresponding Attributes on all Products with this ProductType.
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
Removes enum values from an AttributeDefinition of AttributeEnumType, AttributeLocalizedEnumType, AttributeSetType of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.
ResourceIdentifier to a ProductType.
ProductTypeResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ProductType.
ProductTypeSetInputTipAction
Example to create an instance using the builder pattern
ProductTypeSetInputTipActionBuilder
Example to create an instance using the builder pattern
ProductTypeSetInputTipAction
ProductTypeSetKeyAction
Example to create an instance using the builder pattern
ProductTypeSetKeyActionBuilder
Example to create an instance using the builder pattern
ProductTypeSetKeyAction
ProductTypeUpdate
Example to create an instance using the builder pattern
ProductTypeUpdateAction
Example to create a subtype instance using the builder pattern
ProductTypeUpdateActionBuilder
ProductTypeUpdateAction
ProductTypeUpdateBuilder
Example to create an instance using the builder pattern
ProductTypeUpdate
Removes the current projection of the Product.
ProductUnpublishActionBuilder
Example to create an instance using the builder pattern
Removes the current projection of the Product.
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.
Generated after a successful Unpublish Product update action.
ProductUnpublishedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Unpublish Product update action.
ProductUpdate
Example to create an instance using the builder pattern
ProductUpdateAction
Example to create a subtype instance using the builder pattern
ProductUpdateActionBuilder
ProductUpdateAction
ProductUpdateBuilder
Example to create an instance using the builder pattern
ProductUpdate
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.
Generated after a successful Add ProductVariant update action.
ProductVariantAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add ProductVariant update action.
The InventoryEntry information of the Product Variant.
ProductVariantAvailabilityBuilder
Example to create an instance using the builder pattern
The InventoryEntry information of the Product Variant.
ProductVariantBuilder
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
ProductVariantChannelAvailability
JSON object where the key is a supply Channel
id and the value is the ProductVariantChannelAvailability of the InventoryEntry.ProductVariantChannelAvailabilityMapBuilder
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.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.
Generated after a successful Remove ProductVariant update action.
ProductVariantDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove ProductVariant update action.
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
Creates a Product Variant when included in the
masterVariant and variants fields of the ProductDraft.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
Only Product Variants with the explicitly listed SKUs are part of a Product Selection with
IndividualExclusion ProductSelectionMode.A concrete sellable good for which inventory can be tracked.
Contains the Product Variant to be used in the LineItemImportDraft.
ProductVariantImportDraftBuilder
Example to create an instance using the builder pattern
Contains the Product Variant to be used in the LineItemImportDraft.
Polymorphic base type for Product Variant Selections.
ProductVariantSelectionBuilder
Polymorphic base type for Product Variant Selections.
All Product Variants except the explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeAllExceptBuilder
Example to create an instance using the builder pattern
All Product Variants except the explicitly stated SKUs are part of the Product Selection.
Only Product Variants with explicitly stated SKUs are part of the Product Selection.
ProductVariantSelectionIncludeOnlyBuilder
Example to create an instance using the builder pattern
Only Product Variants with explicitly stated SKUs are part of the Product Selection.
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
ProjectChangeBusinessUnitStatusOnCreationAction
ProjectChangeCartsConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCartsConfigurationAction
ProjectChangeCountriesAction
Example to create an instance using the builder pattern
ProjectChangeCountriesActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCountriesAction
ProjectChangeCountryTaxRateFallbackEnabledAction
Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCountryTaxRateFallbackEnabledAction
ProjectChangeCurrenciesAction
Example to create an instance using the builder pattern
ProjectChangeCurrenciesActionBuilder
Example to create an instance using the builder pattern
ProjectChangeCurrenciesAction
Removing a language used by a Store returns a LanguageUsedInStores error.
ProjectChangeLanguagesActionBuilder
Example to create an instance using the builder pattern
Removing a language used by a Store returns a LanguageUsedInStores error.
ProjectChangeMessagesConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeMessagesConfigurationAction
ProjectChangeNameAction
Example to create an instance using the builder pattern
ProjectChangeNameActionBuilder
Example to create an instance using the builder pattern
ProjectChangeNameAction
ProjectChangeOrderSearchStatusAction
Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusActionBuilder
Example to create an instance using the builder pattern
ProjectChangeOrderSearchStatusAction
ProjectChangeProductSearchIndexingEnabledAction
Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledActionBuilder
Example to create an instance using the builder pattern
ProjectChangeProductSearchIndexingEnabledAction
ProjectChangeShoppingListsConfigurationAction
Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationActionBuilder
Example to create an instance using the builder pattern
ProjectChangeShoppingListsConfigurationAction
Project
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
Returned when the languages set for a Store are not supported by the Project.
ProjectSetBusinessUnitAssociateRoleOnCreationAction
Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationActionBuilder
Example to create an instance using the builder pattern
ProjectSetBusinessUnitAssociateRoleOnCreationAction
ProjectSetExternalOAuthAction
Example to create an instance using the builder pattern
ProjectSetExternalOAuthActionBuilder
Example to create an instance using the builder pattern
ProjectSetExternalOAuthAction
ProjectSetShippingRateInputTypeAction
Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeActionBuilder
Example to create an instance using the builder pattern
ProjectSetShippingRateInputTypeAction
ProjectUpdate
Example to create an instance using the builder pattern
ProjectUpdateAction
Example to create a subtype instance using the builder pattern
ProjectUpdateActionBuilder
ProjectUpdateAction
ProjectUpdateBuilder
Example to create an instance using the builder pattern
ProjectUpdate
QueryComplexityLimitExceededError
Example to create an instance using the builder pattern
QueryComplexityLimitExceededErrorBuilder
Example to create an instance using the builder pattern
QueryComplexityLimitExceededError
QueryPrice
Example to create an instance using the builder pattern
QueryPriceBuilder
Example to create an instance using the builder pattern
QueryPrice
Returned when the query times out.
QueryTimedOutErrorBuilder
Example to create an instance using the builder pattern
Returned when the query times out.
QueryTrait
Quote
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
Changes the owner of a Quote to a different Customer.
QuoteChangeQuoteStateAction
Example to create an instance using the builder pattern
QuoteChangeQuoteStateActionBuilder
Example to create an instance using the builder pattern
QuoteChangeQuoteStateAction
Generated after a successful Create Quote request.
QuoteCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
Generated after a successful Create Quote request.
QuoteCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Quote request.
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.
Generated after a successful Change Customer update action.
QuoteCustomerChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
Generated after a successful Delete Quote request.
QuoteDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
Generated after a successful Delete Quote request.
QuoteDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Quote request.
QuoteDraft
Example to create an instance using the builder pattern
QuoteDraftBuilder
Example to create an instance using the builder pattern
QuoteDraft
Quote
PagedQueryResult with results containing an array of Quote.
QuotePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Quote.
Reference to a Quote.
QuoteReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Quote.
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.
Generated after a successful Request Quote Renegotiation update action.
QuoteRenegotiationRequestedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Request Quote Renegotiation update action.
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
Changes the owner of a Quote Request to a different Customer.
Transitions the Quote Request to a different state.
QuoteRequestChangeQuoteRequestStateActionBuilder
Example to create an instance using the builder pattern
Transitions the Quote Request to a different state.
Generated after a successful Create QuoteRequest request.
QuoteRequestCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create QuoteRequest request.
Generated after a successful Create QuoteRequest request.
QuoteRequestCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create QuoteRequest request.
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.
Generated after a successful Change Customer update action.
QuoteRequestCustomerChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Customer update action.
Generated after a successful Delete QuoteRequest request.
QuoteRequestDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete QuoteRequest request.
Generated after a successful Delete QuoteRequest request.
QuoteRequestDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete QuoteRequest request.
QuoteRequestDraft
Example to create an instance using the builder pattern
QuoteRequestDraftBuilder
Example to create an instance using the builder pattern
QuoteRequestDraft
QuoteRequest
PagedQueryResult with results containing an array of QuoteRequest.
QuoteRequestPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of QuoteRequest.
Represents the Buyer requesting renegotiation for a Quote.
QuoteRequestQuoteRenegotiationActionBuilder
Example to create an instance using the builder pattern
Represents the Buyer requesting renegotiation for a Quote.
Reference to a QuoteRequest.
QuoteRequestReferenceBuilder
Example to create an instance using the builder pattern
Reference to a QuoteRequest.
ResourceIdentifier to a QuoteRequest.
QuoteRequestResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a QuoteRequest.
QuoteRequestSetCustomFieldAction
Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
QuoteRequestSetCustomFieldAction
QuoteRequestSetCustomTypeAction
Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
QuoteRequestSetCustomTypeAction
Predefined states tracking the status of the Quote Request in the negotiation process.
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.
Generated after a successful Change Quote Request State update action.
QuoteRequestStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Quote Request State update action.
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.
Generated after a successful Transition State update action.
QuoteRequestStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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
If the existing State has set
transitions, there must be a direct transition to the new State.QuoteRequestUpdate
Example to create an instance using the builder pattern
QuoteRequestUpdateAction
Example to create a subtype instance using the builder pattern
QuoteRequestUpdateActionBuilder
QuoteRequestUpdateAction
QuoteRequestUpdateBuilder
Example to create an instance using the builder pattern
QuoteRequestUpdate
ResourceIdentifier to a Quote.
QuoteResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Quote.
QuoteSetCustomFieldAction
Example to create an instance using the builder pattern
QuoteSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
QuoteSetCustomFieldAction
QuoteSetCustomTypeAction
Example to create an instance using the builder pattern
QuoteSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
QuoteSetCustomTypeAction
Predefined states tracking the status of the Quote.
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.
Generated after a successful Change Quote State update action.
QuoteStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Quote State update action.
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.
Generated after a successful Transition State update action.
QuoteStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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
If the existing State has set
transitions, there must be a direct transition to the new State.QuoteUpdate
Example to create an instance using the builder pattern
QuoteUpdateAction
Example to create a subtype instance using the builder pattern
QuoteUpdateActionBuilder
QuoteUpdateAction
QuoteUpdateBuilder
Example to create an instance using the builder pattern
QuoteUpdate
RangeFacetResult
Example to create an instance using the builder pattern
RangeFacetResultBuilder
Example to create an instance using the builder pattern
RangeFacetResult
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.ReferenceBuilder
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 referenced by a Reference or a ResourceIdentifier could not be found.
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
Returned when a resource cannot be deleted because it is being referenced by another resource.
A Reference represents a loose reference to another resource in the same Project identified by its
id.Type of resource the value should reference.
possible values of ReferenceTypeId
Used for replicating an existing Cart or Order.
ReplicaCartDraftBuilder
Example to create an instance using the builder pattern
Used for replicating an existing Cart or Order.
Deprecated.
ReplicaMyCartDraft
Example to create an instance using the builder pattern
ReplicaMyCartDraftBuilder
Example to create an instance using the builder pattern
ReplicaMyCartDraft
Returned when a value is not defined for a required field.
RequiredFieldErrorBuilder
Example to create an instance using the builder pattern
Returned when a value is not defined for a required field.
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
This payload is sent for a ChangeSubscription when a resource is created.
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
This payload is sent for a ChangeSubscription when a resource is deleted.
Interface of a resource with an ID and version
Draft type to create a Reference or a KeyReference to a resource.
ResourceIdentifierBuilder
Draft type to create a Reference or a KeyReference to a resource.
Returned when the resource addressed by the request URL does not exist.
ResourceNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource addressed by the request URL does not exist.
Returned when the resource exceeds the maximum allowed size of 16 MB.
ResourceSizeLimitExceededErrorBuilder
Example to create an instance using the builder pattern
Returned when the resource exceeds the maximum allowed size of 16 MB.
IDs indicating the customizable resources and data types.
possible values of ResourceTypeId
ResourceUpdate<U extends ResourceUpdate<U,T,UBuilder>,T extends ResourceUpdateAction<T>,UBuilder extends io.vrap.rmf.base.client.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
This payload is sent for a ChangeSubscription when a resource is updated.
Handler functions to retry single requests.
Stores information about returns connected to an Order.
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.
Generated after a successful Add ReturnInfo update action.
ReturnInfoAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add ReturnInfo update action.
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
ReturnInfoDraft
Stores information about returns connected to an Order.
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.
Generated after a successful Set ReturnInfo update action on Orders and Order Edits.
ReturnInfoSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set ReturnInfo update action on Orders and Order Edits.
ReturnItem
Example to create a subtype instance using the builder pattern
ReturnItemBuilder
ReturnItemDraft
Example to create an instance using the builder pattern
ReturnItemDraftBuilder
Example to create an instance using the builder pattern
ReturnItemDraft
ReturnItem
ReturnPaymentState
possible values of ReturnPaymentState
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.
Generated after a successful Create Review request.
ReviewCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Review request.
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
When creating a new Review, at least one of
title, text or rating should be set.Review
Deprecated.
ReviewPagedQueryResponse
Example to create an instance using the builder pattern
ReviewPagedQueryResponseBuilder
Example to create an instance using the builder pattern
ReviewPagedQueryResponse
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.
Generated after a successful Set Rating update action.
ReviewRatingSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Rating update action.
ReviewRatingStatistics
Example to create an instance using the builder pattern
ReviewRatingStatisticsBuilder
Example to create an instance using the builder pattern
ReviewRatingStatistics
Reference to a Review.
ReviewReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Review.
ResourceIdentifier to a Review.
ReviewResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Review.
ReviewSetAuthorNameAction
Example to create an instance using the builder pattern
ReviewSetAuthorNameActionBuilder
Example to create an instance using the builder pattern
ReviewSetAuthorNameAction
ReviewSetCustomerAction
Example to create an instance using the builder pattern
ReviewSetCustomerActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomerAction
ReviewSetCustomFieldAction
Example to create an instance using the builder pattern
ReviewSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomFieldAction
ReviewSetCustomTypeAction
Example to create an instance using the builder pattern
ReviewSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ReviewSetCustomTypeAction
ReviewSetKeyAction
Example to create an instance using the builder pattern
ReviewSetKeyActionBuilder
Example to create an instance using the builder pattern
ReviewSetKeyAction
ReviewSetLocaleAction
Example to create an instance using the builder pattern
ReviewSetLocaleActionBuilder
Example to create an instance using the builder pattern
ReviewSetLocaleAction
This update action produces the ReviewRatingSet Message.
ReviewSetRatingActionBuilder
Example to create an instance using the builder pattern
This update action produces the ReviewRatingSet Message.
ReviewSetTargetAction
Example to create an instance using the builder pattern
ReviewSetTargetActionBuilder
Example to create an instance using the builder pattern
ReviewSetTargetAction
ReviewSetTextAction
Example to create an instance using the builder pattern
ReviewSetTextActionBuilder
Example to create an instance using the builder pattern
ReviewSetTextAction
ReviewSetTitleAction
Example to create an instance using the builder pattern
ReviewSetTitleActionBuilder
Example to create an instance using the builder pattern
ReviewSetTitleAction
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.
Generated after a successful Transition State update action.
ReviewStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
Transition to a new State.
ReviewTransitionStateActionBuilder
Example to create an instance using the builder pattern
Transition to a new State.
ReviewUpdate
Example to create an instance using the builder pattern
ReviewUpdateAction
Example to create a subtype instance using the builder pattern
ReviewUpdateActionBuilder
ReviewUpdateAction
ReviewUpdateBuilder
Example to create an instance using the builder pattern
ReviewUpdate
Determines how monetary values are rounded.
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
RuleApproverDraft
RuleApprover
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
RuleRequesterDraft
RuleRequester
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
Scoped Price is contained in a ProductVariant which is returned in response to a Product Projection Search request when Scoped Price Search is used.
ScoreShippingRateInput
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
ScoreShippingRateInputDraft
ScoreShippingRateInput
Returned when the indexing of Product information is deactivated in a Project.
SearchDeactivatedErrorBuilder
Example to create an instance using the builder pattern
Returned when the indexing of Product information is deactivated in a Project.
Returned when a search query could not be completed due to an unexpected failure.
SearchExecutionFailureErrorBuilder
Example to create an instance using the builder pattern
Returned when a search query could not be completed due to an unexpected failure.
Returned when a search facet path could not be found.
SearchFacetPathNotFoundErrorBuilder
Example to create an instance using the builder pattern
Returned when a search facet path could not be found.
Controls indexing of resources to be provided on high performance read-only search endpoints.
SearchIndexingConfigurationBuilder
Example to create an instance using the builder pattern
Controls indexing of resources to be provided on high performance read-only search endpoints.
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
SearchIndexingConfigurationValues
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
Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
SearchKeyword
Example to create an instance using the builder pattern
SearchKeywordBuilder
Example to create an instance using the builder pattern
SearchKeyword
Search keywords are JSON objects primarily used by Product Suggestions, but are also considered for a full text search.
SearchKeywordsBuilder
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.
Defines which matching items are to be discounted.
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
Returned when a Discount predicate or API Extension predicate is not semantically correct.
Indicates the shipment status of the Parcel.
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
Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
Shipping
ShippingInfo
Example to create an instance using the builder pattern
ShippingInfoBuilder
Example to create an instance using the builder pattern
ShippingInfo
Becomes the
shippingInfo of the imported Order.ShippingInfoImportDraftBuilder
Example to create an instance using the builder pattern
Becomes the
shippingInfo of the imported Order.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
ShippingMethodAddShippingRateAction
ShippingMethodAddZoneAction
Example to create an instance using the builder pattern
ShippingMethodAddZoneActionBuilder
Example to create an instance using the builder pattern
ShippingMethodAddZoneAction
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
ShippingMethodChangeIsDefaultAction
ShippingMethodChangeNameAction
Example to create an instance using the builder pattern
ShippingMethodChangeNameActionBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeNameAction
ShippingMethodChangeTaxCategoryAction
Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryActionBuilder
Example to create an instance using the builder pattern
ShippingMethodChangeTaxCategoryAction
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
ShippingMethodDoesNotMatchCartErrorBuilder
Example to create an instance using the builder pattern
Returned when the Cart contains a ShippingMethod that is not allowed for the Cart.
ShippingMethodDraft
Example to create an instance using the builder pattern
ShippingMethodDraftBuilder
Example to create an instance using the builder pattern
ShippingMethodDraft
ShippingMethod
PagedQueryResult with
results containing an array of ShippingMethod.ShippingMethodPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of ShippingMethod.Reference to a ShippingMethod.
ShippingMethodReferenceBuilder
Example to create an instance using the builder pattern
Reference to a ShippingMethod.
ShippingMethodRemoveShippingRateAction
Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateActionBuilder
Example to create an instance using the builder pattern
ShippingMethodRemoveShippingRateAction
ShippingMethodRemoveZoneAction
Example to create an instance using the builder pattern
ShippingMethodRemoveZoneActionBuilder
Example to create an instance using the builder pattern
ShippingMethodRemoveZoneAction
ResourceIdentifier to a ShippingMethod.
ShippingMethodResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ShippingMethod.
This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.
ShippingMethodSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.
ShippingMethodSetCustomTypeAction
Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetCustomTypeAction
Deprecated.
Deprecated.
Deprecated.
Deprecated.
ShippingMethodSetKeyAction
Example to create an instance using the builder pattern
ShippingMethodSetKeyActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetKeyAction
ShippingMethodSetLocalizedDescriptionAction
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedDescriptionAction
ShippingMethodSetLocalizedNameAction
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetLocalizedNameAction
ShippingMethodSetPredicateAction
Example to create an instance using the builder pattern
ShippingMethodSetPredicateActionBuilder
Example to create an instance using the builder pattern
ShippingMethodSetPredicateAction
Determines whether a ShippingMethod is allowed for a Cart.
possible values of ShippingMethodState
ShippingMethodUpdate
Example to create an instance using the builder pattern
ShippingMethodUpdateAction
Example to create a subtype instance using the builder pattern
ShippingMethodUpdateActionBuilder
ShippingMethodUpdateAction
ShippingMethodUpdateBuilder
Example to create an instance using the builder pattern
ShippingMethodUpdate
ShippingMode
possible values of ShippingMode
ShippingRate
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
ShippingRateDraftBuilder
Example to create an instance using the builder pattern
ShippingRateDraft
ShippingRate
ShippingRateInput
Example to create a subtype instance using the builder pattern
ShippingRateInputBuilder
Generic type holding specifc ShippingRateInputDraft types.
ShippingRateInputDraftBuilder
Generic type holding specifc ShippingRateInputDraft types.
ShippingRateInput
ShippingRateInputType
Example to create a subtype instance using the builder pattern
ShippingRateInputTypeBuilder
ShippingRateInputType
ShippingRatePriceTier
Example to create a subtype instance using the builder pattern
ShippingRatePriceTierBuilder
ShippingRatePriceTier
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
The ProductVariant to be included in the ShoppingListLineItem must be specified using the
productID and variantID, or by the sku.ShoppingListAddTextLineItemAction
Example to create an instance using the builder pattern
ShoppingListAddTextLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListAddTextLineItemAction
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
ShoppingListChangeLineItemQuantityAction
ShoppingListChangeLineItemsOrderAction
Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeLineItemsOrderAction
ShoppingListChangeNameAction
Example to create an instance using the builder pattern
ShoppingListChangeNameActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeNameAction
ShoppingListChangeTextLineItemNameAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemNameAction
ShoppingListChangeTextLineItemQuantityAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemQuantityAction
ShoppingListChangeTextLineItemsOrderAction
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderActionBuilder
Example to create an instance using the builder pattern
ShoppingListChangeTextLineItemsOrderAction
ShoppingListDraft
Example to create an instance using the builder pattern
ShoppingListDraftBuilder
Example to create an instance using the builder pattern
ShoppingListDraft
ShoppingList
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
The ProductVariant to be included in the ShoppingListLineItem must be specified using the
productID and variantID, or by the sku.ShoppingListLineItems are Line Items that contain references to ProductVariants in a Product.
ShoppingListPagedQueryResponse
Example to create an instance using the builder pattern
ShoppingListPagedQueryResponseBuilder
Example to create an instance using the builder pattern
ShoppingListPagedQueryResponse
Reference to a ShoppingList.
ShoppingListReferenceBuilder
Example to create an instance using the builder pattern
Reference to a ShoppingList.
ShoppingListRemoveLineItemAction
Example to create an instance using the builder pattern
ShoppingListRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListRemoveLineItemAction
ShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemActionBuilder
Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemAction
ResourceIdentifier to a ShoppingList.
ShoppingListResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a ShoppingList.
ShoppingListsConfiguration
Example to create an instance using the builder pattern
ShoppingListsConfigurationBuilder
Example to create an instance using the builder pattern
ShoppingListsConfiguration
ShoppingListSetAnonymousIdAction
Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetAnonymousIdAction
ShoppingListSetCustomerAction
Example to create an instance using the builder pattern
ShoppingListSetCustomerActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomerAction
ShoppingListSetCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomFieldAction
ShoppingListSetCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetCustomTypeAction
ShoppingListSetDeleteDaysAfterLastModificationAction
Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetDeleteDaysAfterLastModificationAction
ShoppingListSetDescriptionAction
Example to create an instance using the builder pattern
ShoppingListSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetDescriptionAction
ShoppingListSetKeyAction
Example to create an instance using the builder pattern
ShoppingListSetKeyActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetKeyAction
ShoppingListSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomFieldAction
ShoppingListSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetLineItemCustomTypeAction
ShoppingListSetSlugAction
Example to create an instance using the builder pattern
ShoppingListSetSlugActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetSlugAction
ShoppingListSetStoreAction
Example to create an instance using the builder pattern
ShoppingListSetStoreActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetStoreAction
ShoppingListSetTextLineItemCustomFieldAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomFieldAction
ShoppingListSetTextLineItemCustomTypeAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemCustomTypeAction
ShoppingListSetTextLineItemDescriptionAction
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionActionBuilder
Example to create an instance using the builder pattern
ShoppingListSetTextLineItemDescriptionAction
ShoppingListStoreSetMessagePayload
Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayloadBuilder
Example to create an instance using the builder pattern
ShoppingListStoreSetMessagePayload
ShoppingListUpdate
Example to create an instance using the builder pattern
ShoppingListUpdateAction
Example to create a subtype instance using the builder pattern
ShoppingListUpdateActionBuilder
ShoppingListUpdateAction
ShoppingListUpdateBuilder
Example to create an instance using the builder pattern
ShoppingListUpdate
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
AWS SNS can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.
SortableTrait
AWS SQS is a pull-queue on AWS.
SqsDestinationBuilder
Example to create an instance using the builder pattern
AWS SQS is a pull-queue on AWS.
Describes how the Cart Discount interacts with other Discounts.
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
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.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
A Delivery can only be added to an Order if its
shippingInfo (for shippingMode = Single), or its shipping (for shippingMode = Multiple) exists.Adds a DiscountCode to the Cart to activate the related Cart Discounts.
StagedOrderAddDiscountCodeActionBuilder
Example to create an instance using the builder pattern
Adds a DiscountCode to the Cart to activate the related Cart Discounts.
Adds an address to an Order when shipping to multiple addresses is desired.
StagedOrderAddItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Adds an address to an Order when shipping to multiple addresses is desired.
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
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.
To add a Parcel, at least one Delivery must exist.
StagedOrderAddParcelToDeliveryActionBuilder
Example to create an instance using the builder pattern
To add a Parcel, at least one Delivery must exist.
StagedOrderAddPaymentAction
Example to create an instance using the builder pattern
StagedOrderAddPaymentActionBuilder
Example to create an instance using the builder pattern
StagedOrderAddPaymentAction
Produces the Return Info Added Message.
StagedOrderAddReturnInfoActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Added Message.
Adds all LineItems of a ShoppingList to the Cart.
StagedOrderAddShoppingListActionBuilder
Example to create an instance using the builder pattern
Adds all LineItems of a ShoppingList to the Cart.
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
StagedOrderChangeCustomLineItemMoneyAction
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 Custom Line Item, use the Add CustomLineItem update action to change the shipping details.
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
When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details.
Produces the Order State Changed Message.
StagedOrderChangeOrderStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order State Changed Message.
Produces the Order Payment State Changed Message.
StagedOrderChangePaymentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Payment State Changed Message.
Produces the Order Shipment State Changed Message.
StagedOrderChangeShipmentStateActionBuilder
Example to create an instance using the builder pattern
Produces the Order Shipment State Changed Message.
Changing the tax calculation mode leads to recalculation of taxes.
StagedOrderChangeTaxCalculationModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax calculation mode leads to recalculation of taxes.
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
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.
Changing the tax rounding mode leads to recalculation of taxes.
StagedOrderChangeTaxRoundingModeActionBuilder
Example to create an instance using the builder pattern
Changing the tax rounding mode leads to recalculation of taxes.
StagedOrder
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.
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
The import of States does not follow any predefined rules and should be only used if no transitions are defined.
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
This update action does not support specifying a quantity, unlike the Remove LineItem update action.
Produces the DeliveryRemoved Message.
StagedOrderRemoveDeliveryActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryRemoved Message.
StagedOrderRemoveDiscountCodeAction
Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeActionBuilder
Example to create an instance using the builder pattern
StagedOrderRemoveDiscountCodeAction
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
An address can only be removed if it is not referenced in any ItemShippingTarget of the Cart.
The LineItem price is updated as described in LineItem Price selection.
StagedOrderRemoveLineItemActionBuilder
Example to create an instance using the builder pattern
The LineItem price is updated as described in LineItem Price selection.
Produces the ParcelRemovedFromDelivery Message.
StagedOrderRemoveParcelFromDeliveryActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelRemovedFromDelivery Message.
StagedOrderRemovePaymentAction
Example to create an instance using the builder pattern
StagedOrderRemovePaymentActionBuilder
Example to create an instance using the builder pattern
StagedOrderRemovePaymentAction
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
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.StagedOrderSetBillingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomFieldAction
StagedOrderSetBillingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetBillingAddressCustomTypeAction
Setting the country can lead to changes in the LineItem prices.
StagedOrderSetCountryActionBuilder
Example to create an instance using the builder pattern
Setting the country can lead to changes in the LineItem prices.
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 action updates the
customerEmail on the Order, but it does not change the Customer email on the Cart the Order has been created from.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
This update action can only be used if a Customer is not assigned to a Cart.
Setting the Order's
customerId does not recalculate prices or discounts on the Order.StagedOrderSetCustomerIdActionBuilder
Example to create an instance using the builder pattern
Setting the Order's
customerId does not recalculate prices or discounts on the Order.StagedOrderSetCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomFieldAction
StagedOrderSetCustomLineItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomFieldAction
StagedOrderSetCustomLineItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemCustomTypeAction
StagedOrderSetCustomLineItemShippingDetailsAction
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomLineItemShippingDetailsAction
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
ExternalAmount TaxMode.Can be used if the Cart has the
External TaxMode.StagedOrderSetCustomLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.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
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.StagedOrderSetCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetCustomTypeAction
Produces the DeliveryAddressSet Message.
StagedOrderSetDeliveryAddressActionBuilder
Example to create an instance using the builder pattern
Produces the DeliveryAddressSet Message.
StagedOrderSetDeliveryAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomFieldAction
StagedOrderSetDeliveryAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryAddressCustomTypeAction
StagedOrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldAction
StagedOrderSetDeliveryCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomTypeAction
Produces the Delivery Items Updated Message.
StagedOrderSetDeliveryItemsActionBuilder
Example to create an instance using the builder pattern
Produces the Delivery Items Updated Message.
Adds a DirectDiscount, but only if no DiscountCode has been added to the Order.
StagedOrderSetDirectDiscountsActionBuilder
Example to create an instance using the builder pattern
Adds a DirectDiscount, but only if no DiscountCode has been added to the Order.
StagedOrderSetItemShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomFieldAction
StagedOrderSetItemShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetItemShippingAddressCustomTypeAction
StagedOrderSetLineItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomFieldAction
StagedOrderSetLineItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemCustomTypeAction
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
Setting a distribution channel for a LineItem can lead to an updated
price as described in LineItem Price selection.Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.StagedOrderSetLineItemPriceActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
price and changes the priceMode to ExternalPrice LineItemPriceMode.StagedOrderSetLineItemShippingDetailsAction
Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLineItemShippingDetailsAction
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
ExternalAmount TaxMode.Can be used if the Cart has the
External TaxMode.StagedOrderSetLineItemTaxRateActionBuilder
Example to create an instance using the builder pattern
Can be used if the Cart has the
External TaxMode.Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.StagedOrderSetLineItemTotalPriceActionBuilder
Example to create an instance using the builder pattern
Sets the LineItem
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.StagedOrderSetLocaleAction
Example to create an instance using the builder pattern
StagedOrderSetLocaleActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetLocaleAction
StagedOrderSetOrderNumberAction
Example to create an instance using the builder pattern
StagedOrderSetOrderNumberActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetOrderNumberAction
Updates the total tax amount of the Order if it has the
ExternalAmount TaxMode.StagedOrderSetOrderTotalTaxActionBuilder
Example to create an instance using the builder pattern
Updates the total tax amount of the Order if it has the
ExternalAmount TaxMode.StagedOrderSetParcelCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomFieldAction
StagedOrderSetParcelCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetParcelCustomTypeAction
Produces the ParcelItemsUpdated Message.
StagedOrderSetParcelItemsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelItemsUpdated Message.
Produces the ParcelMeasurementsUpdated Message.
StagedOrderSetParcelMeasurementsActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelMeasurementsUpdated Message.
Produces the ParcelTrackingDataUpdated Message.
StagedOrderSetParcelTrackingDataActionBuilder
Example to create an instance using the builder pattern
Produces the ParcelTrackingDataUpdated Message.
Produces the PurchaseOrderNumberSet Message.
StagedOrderSetPurchaseOrderNumberActionBuilder
Example to create an instance using the builder pattern
Produces the PurchaseOrderNumberSet Message.
Produces the Return Info Set Message.
StagedOrderSetReturnInfoActionBuilder
Example to create an instance using the builder pattern
Produces the Return Info Set Message.
StagedOrderSetReturnItemCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomFieldAction
StagedOrderSetReturnItemCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetReturnItemCustomTypeAction
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 ReturnPaymentState, the Order
returnInfo must have at least one ReturnItem.To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.StagedOrderSetReturnShipmentStateActionBuilder
Example to create an instance using the builder pattern
To set a
ReturnShipmentState, the Order returnInfo must have at least one ReturnItem.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
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.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 a custom Shipping Method together to prevent an inconsistent state.
Sets the shipping address and Shipping Method together to prevent an inconsistent state.
StagedOrderSetShippingAddressAndShippingMethodActionBuilder
Example to create an instance using the builder pattern
Sets the shipping address and Shipping Method together to prevent an inconsistent state.
StagedOrderSetShippingAddressCustomFieldAction
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomFieldAction
StagedOrderSetShippingAddressCustomTypeAction
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedOrderSetShippingAddressCustomTypeAction
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
To set the Cart's Shipping Method, the Cart must have the
Single ShippingMode and a shippingAddress.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 amount can be set if the Cart has the
ExternalAmount TaxMode.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
A Shipping Method Tax Rate can be set if the Cart has the
External TaxMode.Input used to select a ShippingRatePriceTier.
StagedOrderSetShippingRateInputActionBuilder
Example to create an instance using the builder pattern
Input used to select a ShippingRatePriceTier.
Sets the Store the Order is assigned to.
StagedOrderSetStoreActionBuilder
Example to create an instance using the builder pattern
Sets the Store the Order is assigned to.
Produces the Custom Line Item State Transition Message.
StagedOrderTransitionCustomLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Custom Line Item State Transition Message.
Produces the Line Item State Transition Message.
StagedOrderTransitionLineItemStateActionBuilder
Example to create an instance using the builder pattern
Produces the Line Item State Transition Message.
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
If the existing State has set
transitions, there must be a direct transition to the new State.StagedOrderUpdateAction
Example to create a subtype instance using the builder pattern
StagedOrderUpdateActionBuilder
StagedOrderUpdateAction
Updates an address in
itemShippingAddresses by keeping the Address key.StagedOrderUpdateItemShippingAddressActionBuilder
Example to create an instance using the builder pattern
Updates an address in
itemShippingAddresses by keeping the Address key.StagedOrderUpdateSyncInfoAction
Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoActionBuilder
Example to create an instance using the builder pattern
StagedOrderUpdateSyncInfoAction
StagedPriceDraft
Example to create an instance using the builder pattern
StagedPriceDraftBuilder
Example to create an instance using the builder pattern
StagedPriceDraft
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
StagedQuoteChangeStagedQuoteStateAction
Generated after a successful Create StagedQuote request.
StagedQuoteCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StagedQuote request.
Generated after a successful Create StagedQuote request.
StagedQuoteCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StagedQuote request.
Generated after a successful Delete StagedQuote request.
StagedQuoteDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StagedQuote request.
Generated after a successful Delete StagedQuote request.
StagedQuoteDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StagedQuote request.
StagedQuoteDraft
Example to create an instance using the builder pattern
StagedQuoteDraftBuilder
Example to create an instance using the builder pattern
StagedQuoteDraft
StagedQuote
PagedQueryResult with results containing an array of StagedQuote.
StagedQuotePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of StagedQuote.
Reference to a StagedQuote.
StagedQuoteReferenceBuilder
Example to create an instance using the builder pattern
Reference to a StagedQuote.
ResourceIdentifier to a StagedQuote.
StagedQuoteResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a StagedQuote.
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.
Generated after a successful Set Seller Comment update action.
StagedQuoteSellerCommentSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Seller Comment update action.
StagedQuoteSetCustomFieldAction
Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetCustomFieldAction
StagedQuoteSetCustomTypeAction
Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetCustomTypeAction
StagedQuoteSetSellerCommentAction
Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetSellerCommentAction
StagedQuoteSetValidToAction
Example to create an instance using the builder pattern
StagedQuoteSetValidToActionBuilder
Example to create an instance using the builder pattern
StagedQuoteSetValidToAction
Predefined states tracking the status of the Staged Quote.
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.
Generated after a successful Change Staged Quote State update action.
StagedQuoteStateChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Staged Quote State update action.
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.
Generated after a successful Transition State update action.
StagedQuoteStateTransitionMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Transition State update action.
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
If the existing State has set
transitions, there must be a direct transition to the new State.StagedQuoteUpdate
Example to create an instance using the builder pattern
StagedQuoteUpdateAction
Example to create a subtype instance using the builder pattern
StagedQuoteUpdateActionBuilder
StagedQuoteUpdateAction
StagedQuoteUpdateBuilder
Example to create an instance using the builder pattern
StagedQuoteUpdate
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.
Generated after a successful Set Valid To update action.
StagedQuoteValidToSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid To update action.
Staged changes on a Standalone Price.
StagedStandalonePriceBuilder
Example to create an instance using the builder pattern
Staged changes on a Standalone Price.
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.
Generated after a successful Change Active update action.
StandalonePriceActiveChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Active update action.
Adding a PriceTier to a StandalonePrice produces the Standalone Price Tier Added Message.
StandalonePriceAddPriceTierActionBuilder
Example to create an instance using the builder pattern
Adding a PriceTier to a StandalonePrice produces the Standalone Price Tier Added Message.
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
Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the StagedStandalonePrice.
StandalonePriceBuilder
Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceActiveChangedMessage.
StandalonePriceChangeActiveActionBuilder
Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceActiveChangedMessage.
Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
StandalonePriceChangeValueActionBuilder
Example to create an instance using the builder pattern
Updating the value of a StandalonePrice produces the StandalonePriceValueChangedMessage.
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
Generated after a successful Create StandalonePrice request.
StandalonePriceCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create StandalonePrice request.
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
Generated after a successful Delete StandalonePrice request.
StandalonePriceDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete StandalonePrice request.
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.
Generated after a Product Discount is successfully applied to a StandalonePrice.
StandalonePriceDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a Product Discount is successfully applied to a StandalonePrice.
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
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).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.
Generated after a successful Set Discounted Price update action.
StandalonePriceExternalDiscountSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Discounted Price update action.
StandalonePrice
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.
Generated after a successful Set Key update action.
StandalonePriceKeySetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Key update action.
StandalonePricePagedQueryResponse
Example to create an instance using the builder pattern
StandalonePricePagedQueryResponseBuilder
Example to create an instance using the builder pattern
StandalonePricePagedQueryResponse
Reference to a StandalonePrice.
StandalonePriceReferenceBuilder
Example to create an instance using the builder pattern
Reference to a StandalonePrice.
Removing a PriceTier from a StandalonePrice produces the Standalone Price Tier Removed Message.
StandalonePriceRemovePriceTierActionBuilder
Example to create an instance using the builder pattern
Removing a PriceTier from a StandalonePrice produces the Standalone Price Tier Removed Message.
Removes all staged changes from the StandalonePrice.
StandalonePriceRemoveStagedChangesActionBuilder
Example to create an instance using the builder pattern
Removes all staged changes from the StandalonePrice.
ResourceIdentifier to a StandalonePrice.
StandalonePriceResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a StandalonePrice.
StandalonePriceSetCustomFieldAction
Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StandalonePriceSetCustomFieldAction
StandalonePriceSetCustomTypeAction
Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
StandalonePriceSetCustomTypeAction
Discounts a Standalone Price.
StandalonePriceSetDiscountedPriceActionBuilder
Example to create an instance using the builder pattern
Discounts a Standalone Price.
Sets the key on a Standalone Price.
StandalonePriceSetKeyActionBuilder
Example to create an instance using the builder pattern
Sets the key on a Standalone Price.
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
Sets all PriceTiers for a StandalonePrice in one action, produces the Standalone Price Tiers Set Message.
Updating the
validFrom value generates the StandalonePriceValidFromSet Message.StandalonePriceSetValidFromActionBuilder
Example to create an instance using the builder pattern
Updating the
validFrom value generates the StandalonePriceValidFromSet Message.Updating the
validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.StandalonePriceSetValidFromAndUntilActionBuilder
Example to create an instance using the builder pattern
Updating the
validFrom and validUntil values generates the StandalonePriceValidFromAndUntilSet Message.Updating the
validUntil value generates the StandalonePriceValidUntilSet Message.StandalonePriceSetValidUntilActionBuilder
Example to create an instance using the builder pattern
Updating the
validUntil value generates the StandalonePriceValidUntilSet Message.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.
Generated after a successful Apply Staged Changes update action.
StandalonePriceStagedChangesAppliedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Apply Staged Changes update action.
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.
Generated after a successful Remove Staged Changes update action.
StandalonePriceStagedChangesRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Staged Changes update action.
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
Generated after a successful Add Price Tier update action
StandalonePriceTierAddedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Price Tier update action
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
Generated after a successful Remove Price Tier update action
StandalonePriceTierRemovedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Remove Price Tier update action
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
Generated after a successful Set Price Tier update action
StandalonePriceTiersSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Price Tier update action
StandalonePriceUpdate
Example to create an instance using the builder pattern
StandalonePriceUpdateAction
Example to create a subtype instance using the builder pattern
StandalonePriceUpdateActionBuilder
StandalonePriceUpdateAction
StandalonePriceUpdateBuilder
Example to create an instance using the builder pattern
StandalonePriceUpdate
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.
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 and Until update action.
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.
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 From update action.
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.
Generated after a successful Set Valid Until update action.
StandalonePriceValidUntilSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Valid Until update action.
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.
Generated after a successful Change Value update action.
StandalonePriceValueChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Change Value update action.
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
StateAddRolesAction
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
StateChangeInitialAction
StateChangeKeyAction
Example to create an instance using the builder pattern
StateChangeKeyActionBuilder
Example to create an instance using the builder pattern
StateChangeKeyAction
StateChangeTypeAction
Example to create an instance using the builder pattern
StateChangeTypeActionBuilder
Example to create an instance using the builder pattern
StateChangeTypeAction
StateDraft
Example to create an instance using the builder pattern
StateDraftBuilder
Example to create an instance using the builder pattern
StateDraft
State
PagedQueryResult with
results containing an array of State.StatePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of State.Reference to a State.
StateReferenceBuilder
Example to create an instance using the builder pattern
Reference to a State.
StateRemoveRolesAction
Example to create an instance using the builder pattern
StateRemoveRolesActionBuilder
Example to create an instance using the builder pattern
StateRemoveRolesAction
ResourceIdentifier to a State.
StateResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a State.
For some resource types, a State can fulfill the following predefined roles:
possible values of StateRoleEnum
StateSetDescriptionAction
Example to create an instance using the builder pattern
StateSetDescriptionActionBuilder
Example to create an instance using the builder pattern
StateSetDescriptionAction
StateSetNameAction
Example to create an instance using the builder pattern
StateSetNameActionBuilder
Example to create an instance using the builder pattern
StateSetNameAction
StateSetRolesAction
Example to create an instance using the builder pattern
StateSetRolesActionBuilder
Example to create an instance using the builder pattern
StateSetRolesAction
StateSetTransitionsAction
Example to create an instance using the builder pattern
StateSetTransitionsActionBuilder
Example to create an instance using the builder pattern
StateSetTransitionsAction
Resource or object type the State can be assigned to.
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
StateUpdateAction
StateUpdateBuilder
Example to create an instance using the builder pattern
StateUpdate
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 StoreCountriesChanged Message.
This update action produces the StoreDistributionChannelsChanged Message.
StoreAddDistributionChannelActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
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
To make all included Products available to your customers of a given Store, add the Product Selections to the respective Store.
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
This action has no effect if a given supply channel is already present in a Store.
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
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.
ProductSelection in a Store can be activated or deactivated using this update action.
StoreChangeProductSelectionActionBuilder
Example to create an instance using the builder pattern
ProductSelection in a Store can be activated or deactivated using this update action.
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.
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountriesChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Add Country, Remove Country, or Set Countries update action.
StoreCountry
Example to create an instance using the builder pattern
StoreCountryBuilder
Example to create an instance using the builder pattern
StoreCountry
Generated after a successful Create Store request.
StoreCreatedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Store request.
Generated after a successful Create Store request.
StoreCreatedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Create Store request.
Generated after a successful Delete Store request.
StoreDeletedMessageBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
Generated after a successful Delete Store request.
StoreDeletedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Delete Store request.
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.
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
Generated after a successful Add Distribution Channel, Remove Distribution Channel, or Set Distribution Channels update action.
StoreDraft
Example to create an instance using the builder pattern
StoreDraftBuilder
Example to create an instance using the builder pattern
StoreDraft
Store
Reference to a Store by its key.
StoreKeyReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Store by its key.
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.
Generated after a successful Set Languages update action.
StoreLanguagesChangedMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Languages update action.
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.
Generated after a successful Set Name update action.
StoreNameSetMessagePayloadBuilder
Example to create an instance using the builder pattern
Generated after a successful Set Name update action.
PagedQueryResult with results containing an array of Store.
StorePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with results containing an array of Store.
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.
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
Generated by a successful Add Product Selection, Remove Product Selection, Set Product Selections, or Change Product Selections Active update action.
StoreprojectingTrait
Reference to a Store.
StoreReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Store.
This update action produces the StoreCountriesChanged Message.
StoreRemoveCountryActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
This update action produces the StoreDistributionChannelsChanged Message.
StoreRemoveDistributionChannelActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
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 action has no effect if the given Product Selection is not in the Store.
This update action produces the StoreSupplyChannelsChanged Message.
StoreRemoveSupplyChannelActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreSupplyChannelsChanged Message.
ResourceIdentifier to a Store.
StoreResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Store.
This update action produces the StoreCountriesChanged Message.
StoreSetCountriesActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreCountriesChanged Message.
StoreSetCustomFieldAction
Example to create an instance using the builder pattern
StoreSetCustomFieldActionBuilder
Example to create an instance using the builder pattern
StoreSetCustomFieldAction
StoreSetCustomTypeAction
Example to create an instance using the builder pattern
StoreSetCustomTypeActionBuilder
Example to create an instance using the builder pattern
StoreSetCustomTypeAction
This update action produces the StoreDistributionChannelsChanged Message.
StoreSetDistributionChannelsActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreDistributionChannelsChanged Message.
This update action produces the StoreLanguagesChanged Message.
StoreSetLanguagesActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreLanguagesChanged Message.
This update action produces the StoreNameSet Message.
StoreSetNameActionBuilder
Example to create an instance using the builder pattern
This update action produces the StoreNameSet Message.
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
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.
Setting a supply channel produces the StoreSupplyChannelsChanged Message.
StoreSetSupplyChannelsActionBuilder
Example to create an instance using the builder pattern
Setting a supply channel produces the StoreSupplyChannelsChanged Message.
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.
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
Generated after a successful Add Supply Channel, Remove Supply Channel, or Set Supply Channels update action.
StoreUpdate
Example to create an instance using the builder pattern
StoreUpdateAction
Example to create a subtype instance using the builder pattern
StoreUpdateActionBuilder
StoreUpdateAction
StoreUpdateBuilder
Example to create an instance using the builder pattern
StoreUpdate
It is used to calculate the taxPortions field in a Cart or Order.
SubRateBuilder
Example to create an instance using the builder pattern
It is used to calculate the taxPortions field in a Cart or Order.
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
A test message is sent to ensure the correct configuration of the Destination.
Deprecated.
use
DeliveryPayload insteadEither
messages or changes must be set.SubscriptionDraftBuilder
Example to create an instance using the builder pattern
Either
messages or changes must be set.The health status of the Subscription that indicates whether messages are being delivered to the Destination.
possible values of SubscriptionHealthStatus
Subscription
PagedQueryResult with
results containing an array of Subscription.SubscriptionPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Subscription.SubscriptionSetChangesAction
Example to create an instance using the builder pattern
SubscriptionSetChangesActionBuilder
Example to create an instance using the builder pattern
SubscriptionSetChangesAction
SubscriptionSetKeyAction
Example to create an instance using the builder pattern
SubscriptionSetKeyActionBuilder
Example to create an instance using the builder pattern
SubscriptionSetKeyAction
SubscriptionSetMessagesAction
Example to create an instance using the builder pattern
SubscriptionSetMessagesActionBuilder
Example to create an instance using the builder pattern
SubscriptionSetMessagesAction
SubscriptionUpdate
Example to create an instance using the builder pattern
SubscriptionUpdateAction
Example to create a subtype instance using the builder pattern
SubscriptionUpdateActionBuilder
SubscriptionUpdateAction
SubscriptionUpdateBuilder
Example to create an instance using the builder pattern
SubscriptionUpdate
Suggestion
Example to create an instance using the builder pattern
SuggestionBuilder
Example to create an instance using the builder pattern
Suggestion
SuggestionResult
Example to create an instance using the builder pattern
SuggestionResultBuilder
Example to create an instance using the builder pattern
SuggestionResult
SuggestTokenizer
Example to create a subtype instance using the builder pattern
SuggestTokenizerBuilder
SuggestTokenizer
Contains synchronization activity information of the Order (like export or import).
SyncInfoBuilder
Example to create an instance using the builder pattern
Contains synchronization activity information of the Order (like export or import).
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
Returned when a Discount predicate, API Extension predicate, or search query does not have the correct syntax.
Determines in which Tax calculation mode taxed prices are calculated.
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
TaxCategoryAddTaxRateAction
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
TaxCategoryChangeNameAction
TaxCategoryDraft
Example to create an instance using the builder pattern
TaxCategoryDraftBuilder
Example to create an instance using the builder pattern
TaxCategoryDraft
TaxCategory
PagedQueryResult with
results containing an array of TaxCategory.TaxCategoryPagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of TaxCategory.Reference to a TaxCategory.
TaxCategoryReferenceBuilder
Example to create an instance using the builder pattern
Reference to a TaxCategory.
TaxCategoryRemoveTaxRateAction
Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateActionBuilder
Example to create an instance using the builder pattern
TaxCategoryRemoveTaxRateAction
TaxCategoryReplaceTaxRateAction
Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateActionBuilder
Example to create an instance using the builder pattern
TaxCategoryReplaceTaxRateAction
ResourceIdentifier to a TaxCategory.
TaxCategoryResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a TaxCategory.
TaxCategorySetDescriptionAction
Example to create an instance using the builder pattern
TaxCategorySetDescriptionActionBuilder
Example to create an instance using the builder pattern
TaxCategorySetDescriptionAction
TaxCategorySetKeyAction
Example to create an instance using the builder pattern
TaxCategorySetKeyActionBuilder
Example to create an instance using the builder pattern
TaxCategorySetKeyAction
TaxCategoryUpdate
Example to create an instance using the builder pattern
TaxCategoryUpdateAction
Example to create a subtype instance using the builder pattern
TaxCategoryUpdateActionBuilder
TaxCategoryUpdateAction
TaxCategoryUpdateBuilder
Example to create an instance using the builder pattern
TaxCategoryUpdate
TaxedItemPrice
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
TaxedItemPriceDraft
TaxedItemPrice
TaxedPrice
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
TaxedPriceDraft
TaxedPrice
Indicates how taxes are set on the Cart.
possible values of TaxMode
The tax portions are calculated from the TaxRates.
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
Represents the portions that sum up to the
totalGross field of a TaxedPrice.The tax portions are calculated from the TaxRates.
TaxRate
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
TaxRateDraft
TaxRate
TermFacetResult
Example to create an instance using the builder pattern
TermFacetResultBuilder
Example to create an instance using the builder pattern
TermFacetResult
TermFacetResultType
possible values of TermFacetResultType
A text input hint is a string with one of the following values:
possible values of TextInputHint
TextLineItems are Line Items that use text values instead of references to Products.
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
TextLineItemDraft
TextLineItems are Line Items that use text values instead of references to Products.
Information that helps track a Parcel.
TrackingDataBuilder
Example to create an instance using the builder pattern
Information that helps track a Parcel.
Represents a financial transaction typically created as a result of a notification from the payment service.
TransactionBuilder
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
TransactionDraft
Represents a financial transaction typically created as a result of a notification from the payment service.
Transactions can be in one of the following States:
possible values of TransactionState
TransactionType
possible values of TransactionType
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
Adds a value to an EnumType.
Defines a new field for a Type.
TypeAddFieldDefinitionActionBuilder
Example to create an instance using the builder pattern
Defines a new field for a Type.
Adds a value to a LocalizedEnumType.
TypeAddLocalizedEnumValueActionBuilder
Example to create an instance using the builder pattern
Adds a value to a LocalizedEnumType.
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
label of an EnumValue of an EnumType FieldDefinition.Changes the order of EnumValues in an EnumType FieldDefinition.
TypeChangeEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
Changes the order of EnumValues in an EnumType FieldDefinition.
TypeChangeFieldDefinitionOrderAction
Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderActionBuilder
Example to create an instance using the builder pattern
TypeChangeFieldDefinitionOrderAction
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
Changes the
inputHint of CustomFieldStringType FieldDefinition, a CustomFieldLocalizedStringType FieldDefinition, and CustomFieldSetType FieldDefinition of these string-based FieldTypes.TypeChangeKeyAction
Example to create an instance using the builder pattern
TypeChangeKeyActionBuilder
Example to create an instance using the builder pattern
TypeChangeKeyAction
TypeChangeLabelAction
Example to create an instance using the builder pattern
TypeChangeLabelActionBuilder
Example to create an instance using the builder pattern
TypeChangeLabelAction
Changes the
label of a LocalizedEnumValue of a LocalizedEnumType FieldDefinition.TypeChangeLocalizedEnumValueLabelActionBuilder
Example to create an instance using the builder pattern
Changes the
label of a LocalizedEnumValue of a LocalizedEnumType FieldDefinition.Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition.
TypeChangeLocalizedEnumValueOrderActionBuilder
Example to create an instance using the builder pattern
Changes the order of LocalizedEnumValues in a LocalizedEnumType FieldDefinition.
TypeChangeNameAction
Example to create an instance using the builder pattern
TypeChangeNameActionBuilder
Example to create an instance using the builder pattern
TypeChangeNameAction
Base polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents.
TypedMoneyBuilder
Base polymorphic money type containing common fields for Money and HighPrecisionMoneyDraft.
TypedMoneyDraftBuilder
Base polymorphic money type containing common fields for Money and HighPrecisionMoneyDraft.
Base polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents.
TypeDraft
Example to create an instance using the builder pattern
TypeDraftBuilder
Example to create an instance using the builder pattern
TypeDraft
Type
PagedQueryResult with
results containing an array of Types.TypePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Types.Reference to a Type.
TypeReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Type.
TypeRemoveFieldDefinitionAction
Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionActionBuilder
Example to create an instance using the builder pattern
TypeRemoveFieldDefinitionAction
ResourceIdentifier of a Type.
TypeResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier of a Type.
TypeSetDescriptionAction
Example to create an instance using the builder pattern
TypeSetDescriptionActionBuilder
Example to create an instance using the builder pattern
TypeSetDescriptionAction
Provides a visual representation type for this field.
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
TypeUpdateAction
TypeUpdateBuilder
Example to create an instance using the builder pattern
TypeUpdate
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
UpdateAction
UpdateBuilder
Example to create an instance using the builder pattern
Update
User-provided identifiers present on the resource for which the Message is created.
UserProvidedIdentifiersBuilder
Example to create an instance using the builder pattern
User-provided identifiers present on the resource for which the Message is created.
VariantValues
Example to create an instance using the builder pattern
VariantValuesBuilder
Example to create an instance using the builder pattern
VariantValues
VersionedTrait
Creates tokens by splitting the
text field in SearchKeyword by whitespaces.WhitespaceTokenizerBuilder
Example to create an instance using the builder pattern
Creates tokens by splitting the
text field in SearchKeyword by whitespaces.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
ZoneAddLocationAction
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
ZoneChangeNameAction
ZoneDraft
Example to create an instance using the builder pattern
ZoneDraftBuilder
Example to create an instance using the builder pattern
ZoneDraft
Zone
PagedQueryResult with
results containing an array of Zone.ZonePagedQueryResponseBuilder
Example to create an instance using the builder pattern
PagedQueryResult with
results containing an array of Zone.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
ZoneRateDraft
Defines shipping rates in different currencies for a specific Zone.
Reference to a Zone.
ZoneReferenceBuilder
Example to create an instance using the builder pattern
Reference to a Zone.
ZoneRemoveLocationAction
Example to create an instance using the builder pattern
ZoneRemoveLocationActionBuilder
Example to create an instance using the builder pattern
ZoneRemoveLocationAction
ResourceIdentifier to a Zone.
ZoneResourceIdentifierBuilder
Example to create an instance using the builder pattern
ResourceIdentifier to a Zone.
ZoneSetDescriptionAction
Example to create an instance using the builder pattern
ZoneSetDescriptionActionBuilder
Example to create an instance using the builder pattern
ZoneSetDescriptionAction
ZoneSetKeyAction
Example to create an instance using the builder pattern
ZoneSetKeyActionBuilder
Example to create an instance using the builder pattern
ZoneSetKeyAction
ZoneUpdate
Example to create an instance using the builder pattern
ZoneUpdateAction
Example to create a subtype instance using the builder pattern
ZoneUpdateActionBuilder
ZoneUpdateAction
ZoneUpdateBuilder
Example to create an instance using the builder pattern
ZoneUpdate
AttributeAccessorinstead