package
1.7.0
Repository: https://github.com/labd/commercetools-go-sdk.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
NewClient creates a new client based on the provided ClientConfig.
NewDate initializes a Date struct.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Version identifies the current library version.

# Variables

No description provided by the author

# Structs

* * Address type returned by read methods.
* * Address type to be used on write methods.
* * Returned when the anonymous ID is being used by another resource.
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [APIClient](ctp:api:type:ApiClient).
No description provided by the author
No description provided by the author
* * This update action allows an [Associate](ctp:api:type:Associate) to approve an Approval Flow.
* * Generated after an [approval in the Approval Flow](/projects/approval-flows#approve).
* * Generated after an [approval in the Approval Flow](/projects/approval-flows#approve).
* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is completed and reaches a final status.
* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is completed and reaches a final status.
* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is created.
* * Generated after an [Approval Flow](ctp:api:type:ApprovalFlow) is created.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ApprovalFlow](ctp:api:type:ApprovalFlow).
* * This update action allows an [Associate](ctp:api:type:Associate) to reject an Approval Flow, setting its status to `Rejected`.
* * Generated after an [Approval Flow is rejected](/projects/approval-flows#reject).
* * Generated after an [Approval Flow is rejected](/projects/approval-flows#reject).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
* * Generated after a successful [Set Approvers](ctp:api:type:ApprovalRuleSetApproversAction) update action.
* * Generated after an [Approval Rule](ctp:api:type:ApprovalRule) is created.
* * Generated after an [Approval Rule](ctp:api:type:ApprovalRule) is created.
* * Generated after a successful [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
* * Generated after a successful [Set Description](ctp:api:type:ApprovalRuleSetDescriptionAction) update action.
No description provided by the author
* * Generated after a successful [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
* * Generated after a successful [Set Key](ctp:api:type:ApprovalRuleSetKeyAction) update action.
* * Generated after a successful [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
* * Generated after a successful [Set Name](ctp:api:type:ApprovalRuleSetNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ApprovalRule](ctp:api:type:ApprovalRule).
* * Generated after a successful [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
* * Generated after a successful [Set Predicate](ctp:api:type:ApprovalRuleSetPredicateAction) update action.
* * Generated after a successful [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
* * Generated after a successful [Set Requester](ctp:api:type:ApprovalRuleSetRequestersAction) update action.
* * Setting the approvers for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleApproversSet](ctp:api:type:ApprovalRuleApproversSetMessage) Message.
* * Setting the description for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleDescriptionSet](ctp:api:type:ApprovalRuleDescriptionSetMessage) Message.
* * Setting the key for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleKeySet](ctp:api:type:ApprovalRuleKeySetMessage) Message.
* * Setting the name for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleNameSet](ctp:api:type:ApprovalRuleNameSetMessage) Message.
* * Setting the [Order Predicate](/../api/projects/predicates#order-predicates) for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRulePredicateSet](ctp:api:type:ApprovalRulePredicateSetMessage) Message.
* * Sets the requesters for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleRequestersSet](ctp:api:type:ApprovalRuleRequestersSetMessage) Message.
* * Setting the status for an [Approval Rule](ctp:api:type:ApprovalRule) generates an [ApprovalRuleStatusSet](ctp:api:type:ApprovalRuleStatusSetMessage) Message.
* * Generated after a successful [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
* * Generated after a successful [Set Status](ctp:api:type:ApprovalRuleSetStatusAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Describes the order in which [Associates](ctp:api:type:Associate) can approve the matched [Order](ctp:api:type:Order).
* * Describes the sequence in which [Associates](ctp:api:type:Associate) can approve an [Order](ctp:api:type:Order).
No description provided by the author
* * Dimensions of the Asset source specified by the number of pixels.
No description provided by the author
* * Representation of an [Asset](#asset) in a specific format, for example a video in a certain encoding, or an image in a certain resolution.
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [AssignedProductSelection](ctp:api:type:AssignedProductSelection).
No description provided by the author
No description provided by the author
* * Returned when an [Associate](/projects/business-units#associate) is missing a [Permission](/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources).
No description provided by the author
* * Adding a Permission to an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionAdded](ctp:api:type:AssociateRolePermissionAddedMessage) Message.
No description provided by the author
No description provided by the author
* * Generated after a successful [Change BuyerAssignable](ctp:api:type:AssociateRoleChangeBuyerAssignableAction) update action.
* * Generated after a successful [Change BuyerAssignable](ctp:api:type:AssociateRoleChangeBuyerAssignableAction) update action.
* * Changing the `buyerAssignable` value of an AssociateRole generates an [AssociateRoleBuyerAssignableChanged](ctp:api:type:AssociateRoleBuyerAssignableChangedMessage) Message.
* * Generated after a successful [Create AssociateRole](ctp:api:endpoint:/{projectKey}/associate-roles:POST) request.
* * Generated after a successful [Create AssociateRole](ctp:api:endpoint:/{projectKey}/associate-roles:POST) request.
* * Generated after a successful [Delete AssociateRole](/projects/associate-roles#delete-associaterole) request.
* * Generated after a successful [Delete AssociateRole](/projects/associate-roles#delete-associaterole) request.
No description provided by the author
* * [KeyReference](ctp:api:type:KeyReference) to an [AssociateRole](ctp:api:type:AssociateRole).
* * Generated after a successful [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action.
* * Generated after a successful [Set Name](ctp:api:type:AssociateRoleSetNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [AssociateRole](ctp:api:type:AssociateRole).
* * Generated after a successful [Add Permissions](ctp:api:type:AssociateRoleAddPermissionAction) update action.
* * Generated after a successful [Add Permissions](ctp:api:type:AssociateRoleAddPermissionAction) update action.
* * Generated after a successful [Remove Permissions](ctp:api:type:AssociateRoleRemovePermissionAction) update action.
* * Generated after a successful [Remove Permissions](ctp:api:type:AssociateRoleRemovePermissionAction) update action.
* * Generated after a successful [Set Permissions](ctp:api:type:AssociateRoleSetPermissionsAction) update action.
* * Generated after a successful [Set Permissions](ctp:api:type:AssociateRoleSetPermissionsAction) update action.
* * [Reference](ctp:api:type:Reference) to an [AssociateRole](ctp:api:type:AssociateRole).
* * Removing a Permission from an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionRemoved](ctp:api:type:AssociateRolePermissionRemovedMessage) Message.
* * [ResourceIdentifier](ctp:api:type:TypeResourceIdentifier) of an [AssociateRole](ctp:api:type:AssociateRole).
No description provided by the author
No description provided by the author
* * Updating the name of an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRoleNameSet](ctp:api:type:AssociateRoleNameSetMessage) Message.
* * Updating the Permissions on an [AssociateRole](ctp:api:type:AssociateRole) generates an [AssociateRolePermissionsSet](ctp:api:type:AssociateRolePermissionsSetMessage) Message.
No description provided by the author
No description provided by the author
* * Attribute type for Boolean values.
No description provided by the author
No description provided by the author
* * 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](ctp:api:type:AttributeDefinition) conflicts with an existing Attribute.
* * Specify the Attribute to be created with the [ProductTypeDraft](ctp:api:type:ProductTypeDraft).
* * Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types.
* * Attribute type for plain enum values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [AttributeGroup](ctp:api:type:AttributeGroup).
* * [Reference](ctp:api:type:Reference) to an [AttributeGroup](ctp:api:type:AttributeGroup).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [AttributeGroup](ctp:api:type:AttributeGroup).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Attribute type for [LocalizedString](ctp:api:type:LocalizedString) values.
* * Attribute type for localized enum values.
* * A localized enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned.
No description provided by the author
* * Returned when an [AttributeDefinition](ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`.
* * Attribute type for nesting Attributes based on some existing ProductType.
No description provided by the author
* * A plain enum value must be unique within the enum, else a [DuplicateEnumValues](ctp:api:type:DuplicateEnumValuesError) error is returned.
No description provided by the author
No description provided by the author
* * AttributeType that defines a set (without duplicate elements) with values of the given `elementType`.
* * Attribute type for plain text values.
No description provided by the author
* * Indicates the source and method that indirectly created or modified the resource.
* * Represents errors related to authentication and authorization in a format conforming to the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2).
* * The `Authorization` header will be set to the content of `headerValue`.
* * 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](https://azure.microsoft.com/en-us/products/event-grid/) can be used to push notifications 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.
* * [Azure Service Bus](https://azure.microsoft.com/en-us/products/service-bus/) can be used as a pull-queue with [Queues](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-queues-topics-subscriptions#queues), or to fan-out notifications with [Topics and Subscriptions](https://learn.microsoft.com/en-us/azure/service-bus-messaging/service-bus-queues-topics-subscriptions).
* * Returned when a server-side problem is caused by scaling infrastructure resources.
* * Polymorphic base type that represents a postal address and contact details.
No description provided by the author
* * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
* * Adding an Associate to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateAdded](ctp:api:type:BusinessUnitAssociateAddedMessage) Message.
* * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message.
* * Generated after a successful [Add Address](ctp:api:type:BusinessUnitAddAddressAction) update action.
* * Generated after a successful [Add Address](ctp:api:type:BusinessUnitAddAddressAction) update action.
* * Generated after a successful [Change Address](ctp:api:type:BusinessUnitChangeAddressAction) update action.
* * Generated after a successful [Change Address](ctp:api:type:BusinessUnitChangeAddressAction) update action.
* * Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
* * Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
* * Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
* * Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action.
* * Generated after a successful [Remove Address](ctp:api:type:BusinessUnitRemoveAddressAction) update action.
* * Generated after a successful [Remove Address](ctp:api:type:BusinessUnitRemoveAddressAction) update action.
* * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message.
* * Adding a [Store](ctp:api:type:Store) to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitStoreAdded](ctp:api:type:BusinessUnitStoreAddedMessage) Message.
* * Generated after a successful [Change Approval Rule Mode](ctp:api:type:BusinessUnitChangeApprovalRuleModeAction) update action.
* * Generated after a successful [Change Approval Rule Mode](ctp:api:type:BusinessUnitChangeApprovalRuleModeAction) update action.
* * Generated after a successful [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.
* * Generated after a successful [Add Associate](ctp:api:type:BusinessUnitAddAssociateAction) update action.
* * Generated after a successful [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action.
* * Generated after a successful [Change Associate](ctp:api:type:BusinessUnitChangeAssociateAction) update action.
* * Generated after a successful [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
* * Generated after a successful [Change Associate Mode](ctp:api:type:BusinessUnitChangeAssociateModeAction) update action.
* * Generated after a successful [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action.
* * Generated after a successful [Remove Associate](ctp:api:type:BusinessUnitRemoveAssociateAction) update action.
* * Generated after a successful [Set Associates](ctp:api:type:BusinessUnitSetAssociatesAction) update action.
* * Generated after a successful [Set Associates](ctp:api:type:BusinessUnitSetAssociatesAction) update action.
* * Generated after a successful [Add Billing Address Identifier](ctp:api:type:BusinessUnitAddBillingAddressIdAction) update action.
* * Generated after a successful [Add Billing Address Identifier](ctp:api:type:BusinessUnitAddBillingAddressIdAction) update action.
* * Generated after a successful [Remove Billing Address Identifier](ctp:api:type:BusinessUnitRemoveBillingAddressIdAction) update action.
* * Generated after a successful [Remove Billing Address Identifier](ctp:api:type:BusinessUnitRemoveBillingAddressIdAction) update action.
* * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message.
* * Updates [Approval Rules](/projects/approval-rules) inheritance behavior between Business Units.
* * Updating the [Associate](ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message.
* * Only Business Units of type `Division` can be changed to `ExplicitAndFromParent`.
* * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message.
* * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message.
* * Changing the status of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitStatusChanged](ctp:api:type:BusinessUnitStatusChangedMessage) Message.
No description provided by the author
* * Generated after a successful [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action.
* * Generated after a successful [Set Contact Email](ctp:api:type:BusinessUnitSetContactEmailAction) update action.
* * Generated after a successful [Create BusinessUnit](ctp:api:endpoint:/{projectKey}/business-units:POST) request.
* * Generated after a successful [Create BusinessUnit](ctp:api:endpoint:/{projectKey}/business-units:POST) request.
* * Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action.
* * Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
* * Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
* * Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
* * Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action.
* * Generated after a successful [Set Default Billing Address](ctp:api:type:BusinessUnitSetDefaultBillingAddressAction) update action.
* * Generated after a successful [Set Default Billing Address](ctp:api:type:BusinessUnitSetDefaultBillingAddressAction) update action.
* * Generated after a successful [Set Default Shipping Address](ctp:api:type:BusinessUnitSetDefaultShippingAddressAction) update action.
* * Generated after a successful [Set Default Shipping Address](ctp:api:type:BusinessUnitSetDefaultShippingAddressAction) update action.
* * Generated after a successful [Delete BusinessUnit](/projects/business-units#delete-businessunit) request.
* * Generated after a successful [Delete BusinessUnit](/projects/business-units#delete-businessunit) request.
* * [KeyReference](ctp:api:type:KeyReference) to a [BusinessUnit](ctp:api:type:BusinessUnit).
* * Generated after a successful [Change Name](ctp:api:type:BusinessUnitChangeNameAction) update action.
* * Generated after a successful [Change Name](ctp:api:type:BusinessUnitChangeNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [BusinessUnit](ctp:api:type:BusinessUnit).
* * Generated after a successful [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
* * Generated after a successful [Change Parent Unit](ctp:api:type:BusinessUnitChangeParentUnitAction) update action.
* * [Reference](ctp:api:type:Reference) to a [BusinessUnit](ctp:api:type:BusinessUnit).
* * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message.
* * Removing an [Associate](ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message.
* * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message.
* * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message.
* * Removes a Store from the Business Unit.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [BusinessUnit](ctp:api:type:BusinessUnit).
* * Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message.
* * Changes the Associates of a [Business Unit](ctp:api:type:BusinessUnit), generates a [BusinessUnitAssociatesSet](ctp:api:type:BusinessUnitAssociatesSetMessage) Message.
* * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message.
* * Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message.
* * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message.
* * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message.
* * Only Business Units of type `Division` can be have a store mode of `FromParent`.
* * Sets the Stores of the Business Unit.
* * Generated after a successful [Add Shipping Address Identifier](ctp:api:type:BusinessUnitAddShippingAddressIdAction) update action.
* * Generated after a successful [Add Shipping Address Identifier](ctp:api:type:BusinessUnitAddShippingAddressIdAction) update action.
* * Generated after a successful [Remove Shipping Address Identifier](ctp:api:type:BusinessUnitRemoveShippingAddressIdAction) update action.
* * Generated after a successful [Remove Shipping Address Identifier](ctp:api:type:BusinessUnitRemoveShippingAddressIdAction) update action.
* * Generated after a successful [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action.
* * Generated after a successful [Change Status](ctp:api:type:BusinessUnitChangeStatusAction) update action.
* * Generated after a successful [Add Store](ctp:api:type:BusinessUnitAddStoreAction) update action.
* * Generated after a successful [Add Store](ctp:api:type:BusinessUnitAddStoreAction) update action.
* * Generated after a successful [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
* * Generated after a successful [Set Store Mode](ctp:api:type:BusinessUnitSetStoreModeAction) update action.
* * Generated after a successful [Remove Store](ctp:api:type:BusinessUnitRemoveStoreAction) update action.
* * Generated after a successful [Remove Store](ctp:api:type:BusinessUnitRemoveStoreAction) update action.
* * Generated after a successful [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action.
* * Generated after a successful [Set Stores](ctp:api:type:BusinessUnitSetStoresAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * If the Cart already contains a [CustomLineItem](ctp:api:type: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](ctp:api:type:ShippingMethod) managed through * the [Shipping Methods API](/projects/shippingMethods)) to the Cart, it **must have** the `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
* * Adds a [DiscountCode](ctp:api:type:DiscountCode) to the Cart to activate the related [Cart Discounts](/../api/projects/cartDiscounts).
* * Adds an address to a Cart when shipping to multiple addresses is desired.
* * If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased.
No description provided by the author
* * Adds a Shipping Method for a specified shipping address to a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
* * Adds all [LineItems](ctp:api:type:LineItem) of a [ShoppingList](ctp:api:type:ShoppingList) to the Cart.
No description provided by the author
* * To override the shipping details, see [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction).
No description provided by the author
No description provided by the author
* * When multiple shipping addresses are set for a Custom Line Item, * use the [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction) update action to change the shipping details.
* * When multiple shipping addresses are set for a Line Item, * use the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) and [Add LineItem](ctp:api:type:CartAddLineItemAction) update action * to change the shipping details.
No description provided by the author
* * Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
* * - When `External` [TaxMode](ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed.
* * Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
* * The [ShippingRate](ctp:api:type:ShippingRate) maps to an abstract Cart categorization expressed by strings (for example, `Light`, `Medium`, or `Heavy`).
* * The [ShippingRate](ctp:api:type:ShippingRate) maps to an abstract Cart categorization expressed by strings (for example, `Light`, `Medium`, or `Heavy`).
No description provided by the author
* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Changes the [CartDiscountValue](ctp:api:type:CartDiscountValue) for [relative](ctp:api:type:CartDiscountValueRelative), [absolute](ctp:api:type:CartDiscountValueAbsolute) and [fixed price](ctp:api:type:CartDiscountValueFixed) CartDiscounts.
* * Generated after a successful [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) request.
* * Generated after a successful [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) request.
* * Discount is applied to [CustomLineItems](ctp:api:type:CustomLineItem) matching the `predicate`.
* * Generated after a successful [Delete CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts/{id}:DELETE) request.
* * Generated after a successful [Delete CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts/{id}:DELETE) request.
No description provided by the author
* * Discount is applied to [LineItems](ctp:api:type:LineItem) matching the `predicate`.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [CartDiscount](ctp:api:type:CartDiscount).
* * [Reference](ctp:api:type:Reference) to a [CartDiscount](ctp:api:type:CartDiscount).
* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CartDiscount](ctp:api:type:CartDiscount).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * If a referenced Store does not exist, a [ReferencedResourceNotFound](ctp:api:type:ReferencedResourceNotFoundError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
* * Discount is applied to the shipping costs of the [Cart](ctp:api:type:Cart).
* * Generated after a successful [Add Store](ctp:api:type:CartDiscountAddStoreAction) update action.
* * Generated after a successful [Add Store](ctp:api:type:CartDiscountAddStoreAction) update action.
* * Generated after a successful [Remove Store](ctp:api:type:CartDiscountRemoveStoreAction) update action.
* * Generated after a successful [Remove Store](ctp:api:type:CartDiscountRemoveStoreAction) update action.
* * Generated after a successful [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action.
* * Generated after a successful [Set Stores](ctp:api:type:CartDiscountSetStoresAction) update action.
* * Discount is applied to the total price of the [Cart](ctp:api:type:Cart).
No description provided by the author
* * Discounts the [CartDiscountTarget](ctp:api:type:CartDiscountTarget) by an absolute amount (not allowed for [MultiBuyLineItemsTarget](ctp:api:type:MultiBuyLineItemsTarget) and [MultiBuyCustomLineItemsTarget](ctp:api:type:MultiBuyCustomLineItemsTarget)).
No description provided by the author
* * Sets the [DiscountedLineItemPrice](ctp:api:type:DiscountedLineItemPrice) of the [CartDiscountLineItemsTarget](ctp:api:type:CartDiscountLineItemsTarget) or [CartDiscountCustomLineItemsTarget](ctp:api:type: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](ctp:api:type:DiscountedLineItemPrice) of the [CartDiscountLineItemsTarget](ctp:api:type:CartDiscountLineItemsTarget) or [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget) to the value specified in the `money` field, if it is lower than the current Line Item price for the same currency.
No description provided by the author
* * Can only be used in a [CartDiscountDraft](ctp:api:type:CartDiscountDraft) with no `target` specified.
* * Discounts the [CartDiscountTarget](ctp:api:type:CartDiscountTarget) relative to its price.
No description provided by the author
No description provided by the author
* * Changes the [CartState](ctp:api:type:CartState) from `Active` to `Frozen`.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Cart](ctp:api:type:Cart).
* * This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates) * to bring prices and discounts to the latest state.
* * [Reference](ctp:api:type:Reference) to a [Cart](ctp:api:type:Cart).
* * This update action does not support specifying quantities, unlike the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update action.
No description provided by the author
* * An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
* * The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
No description provided by the author
* * Removes a Shipping Method from a Cart that has the `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Cart](ctp:api:type:Cart).
No description provided by the author
* * The [ShippingRate](ctp:api:type:ShippingRate) maps to an abstract Cart categorization expressed by integers (such as shipping scores or weight ranges).
* * The [ShippingRate](ctp:api:type:ShippingRate) maps to an abstract [Cart](ctp:api:type:Cart) categorization expressed by integers (such as shipping scores or weight ranges).
* * If the Cart is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
* * Updates the Business Unit on the Cart.
* * Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * Setting the country can lead to changes in the [LineItem](ctp:api:type:LineItem) prices.
No description provided by the author
* * This update action can only be used if a Customer is not assigned to the Cart.
* * Setting the Cart's `customerId` can lead to updates on all its [LineItem](ctp:api:type:LineItem) `prices`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * To set the Cart's custom Shipping Method (independent of the [ShippingMethods](ctp:api:type:ShippingMethod) managed through * the [Shipping Methods API](/projects/shippingMethods)) the Cart must have * the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
No description provided by the author
* * Number of days after which a Cart with `Active` [CartState](ctp:api:type:CartState) is deleted since its last modification.
* * Adds a [DirectDiscount](ctp:api:type:DirectDiscount), but only if no [DiscountCode](ctp:api:type:DiscountCode) has been added to the Cart.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
No description provided by the author
* * Sets the [LineItem](ctp:api:type:LineItem) `price` and changes the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
No description provided by the author
* * Performing this action has no impact on inventory that should be reserved.
* * Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * Sets the [LineItem](ctp:api:type:LineItem) `totalPrice` and `price`, and changes the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
No description provided by the author
* * Setting the shipping address also sets the [TaxRate](ctp:api:type:TaxRate) of Line Items and calculates the [TaxedPrice](ctp:api:type:TaxedPrice).
No description provided by the author
No description provided by the author
No description provided by the author
* * 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](ctp:api:type:ShippingMode) and a `shippingAddress`.
* * A Shipping Method tax amount can be set if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * A Shipping Method Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
* * Changes the [CartState](ctp:api:type:CartState) from `Frozen` to `Active`.
No description provided by the author
* * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
* * * The [ShippingRate](ctp:api:type:ShippingRate) maps to the value of the Cart and is used to select a tier.
* * The [ShippingRate](ctp:api:type:ShippingRate) maps to the value of the Cart and is used to select a tier.
No description provided by the author
No description provided by the author
No description provided by the author
* * This update action changes the order of the `assets` array.
No description provided by the author
No description provided by the author
No description provided by the author
* * Changing the slug produces the [CategorySlugChanged](ctp:api:type:CategorySlugChangedMessage) Message.
* * Generated after a successful [Create Category](ctp:api:endpoint:/{projectKey}/categories:POST) request.
* * Generated after a successful [Create Category](ctp:api:endpoint:/{projectKey}/categories:POST) request.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Category](ctp:api:type:Category).
* * [Reference](ctp:api:type:Reference) to a [Category](ctp:api:type:Category).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Category](ctp:api:type:Category).
No description provided by the author
No description provided by the author
No description provided by the author
* * Set or remove the `key` of an [Asset](ctp:api:type:Asset).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * This 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).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
* * Generated after a successful [Change Slug](ctp:api:type:CategoryChangeSlugAction) update action.
No description provided by the author
* * Object that stores money in cent amounts of a specific currency.
* * This draft type is the alternative to [Money](ctp:api:type:Money).
* * Notification about changes to a resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Channel](ctp:api:type:Channel).
* * [Reference](ctp:api:type:Reference) to a [Channel](ctp:api:type:Channel).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource.
* * The CloudEventsFormat can be used with any [Destination](#destination), and the payload is delivered in the `JSON Event Format`.
* * The [CloudEventsFormat](ctp:api:type:CloudEventsFormat) represents event data in a way that conforms to a common specification.
* * Business Unit type to represent the top level of a business.
* * Draft type to represent the top level of a business.
* * Returned when the request conflicts with the current state of the involved resources.
* * This destination can be used to push notifications to [Confluent Cloud](https://www.confluent.io/confluent-cloud/).
* * `ContainerAndKey` is specific to [Custom Objects](ctp:api:type:CustomObject).
* * Returned when the request results in too much data being returned from the API.
* * Returned when a [Cart](ctp:api:type:Cart) or an [Order](ctp:api:type:Order) in a [Store](ctp:api:type:Store) references a country that is not included in the countries configured for the Store.
* * IDs and references that created the resource.
* * If `stores` is not empty, the Customer is specific to those Stores.
* * Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message.
* * Adds an Address from the `addresses` array to `billingAddressIds`.
* * Generated after a successful [Add Address](ctp:api:type:CustomerAddAddressAction) update action.
* * Generated after a successful [Add Address](ctp:api:type:CustomerAddAddressAction) update action.
* * Generated after a successful [Change Address](ctp:api:type:CustomerChangeAddressAction) update action.
* * Generated after a successful [Change Address](ctp:api:type:CustomerChangeAddressAction) update action.
* * Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action.
* * Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action.
* * Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action.
* * Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action.
* * Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action.
* * Generated after a successful [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action.
* * Generated after a successful [Remove Address](ctp:api:type:CustomerRemoveAddressAction) update action.
* * Adds an Address from the `addresses` array to `shippingAddressIds`.
* * Associates the Customer with a Store.
* * Changing an address of the Customer produces the [CustomerAddressChanged](ctp:api:type:CustomerAddressChangedMessage) Message.
* * Changes the `email` of the Customer and sets the `isEmailVerified` property to `false`.
No description provided by the author
* * Generated after a successful [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action.
* * Generated after a successful [Set Company Name](ctp:api:type:CustomerSetCompanyNameAction) update action.
* * Generated after a successful [Create Customer](ctp:api:endpoint:/{projectKey}/customers:POST) request.
* * Generated after a successful [Create Customer](ctp:api:endpoint:/{projectKey}/customers:POST) request.
No description provided by the author
No description provided by the author
* * Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action.
* * Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters.
* * Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters.
* * Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action.
* * Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action.
* * Generated after a successful [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action.
* * Generated after a successful [Set Date of Birth](ctp:api:type:CustomerSetDateOfBirthAction) update action.
* * Generated after a successful [Delete Customer](/../api/projects/customers#delete-customer) request.
* * Generated after a successful [Delete Customer](/../api/projects/customers#delete-customer) request.
No description provided by the author
* * Generated after a successful [Change Email](ctp:api:type:CustomerChangeEmailAction) update action.
* * Generated after a successful [Change Email](ctp:api:type:CustomerChangeEmailAction) update action.
* * Generated after a successful [Create email token for Customer](ctp:api:endpoint:/{projectKey}/customers/email-token:POST) request.
* * Generated after a successful [Create email token for Customer](ctp:api:endpoint:/{projectKey}/customers/email-token:POST) request.
* * [Reference](ctp:api:type:Reference) to a [CustomerToken](ctp:api:type:CustomerToken) for email verification.
* * Generated after a successful [Verify Customer's Email](ctp:api:endpoint:/{projectKey}/customers/email/confirm:POST) request.
* * Generated after a successful [Verify Customer's Email](ctp:api:endpoint:/{projectKey}/customers/email/confirm:POST) request.
No description provided by the author
* * Generated after a successful [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action.
* * Generated after a successful [Set First Name](ctp:api:type:CustomerSetFirstNameAction) update action.
No description provided by the author
No description provided by the author
* * Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action.
* * Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters.
* * Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters.
* * Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action.
* * Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action.
No description provided by the author
* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [CustomerGroup](ctp:api:type:CustomerGroup).
* * [Reference](ctp:api:type:Reference) to a [CustomerGroup](ctp:api:type:CustomerGroup).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup).
No description provided by the author
* * This action sets or removes the custom type for an existing CustomerGroup.
No description provided by the author
* * Generated after a successful [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action.
* * Generated after a successful [Set Customer Group](ctp:api:type:CustomerSetCustomerGroupAction) update action.
No description provided by the author
No description provided by the author
* * Generated after a successful [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action.
* * Generated after a successful [Set Last Name](ctp:api:type:CustomerSetLastNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Customer](ctp:api:type:Customer).
No description provided by the author
* * Generated after a successful [Create password reset token for Customer](ctp:api:endpoint:/{projectKey}/customers/password-token:POST) request.
* * Generated after a successful [Create password reset token for Customer](ctp:api:endpoint:/{projectKey}/customers/password-token:POST) request.
* * [Reference](ctp:api:type:Reference) to a [CustomerToken](ctp:api:type:CustomerToken) for password reset.
* * Generated after a successful [Reset Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST), [Reset Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password/reset:POST), [Change Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password:POST), or [Change Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) request.
* * Generated after a successful [Reset Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password/reset:POST), [Reset Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password/reset:POST), [Change Customer's Password](ctp:api:endpoint:/{projectKey}/customers/password:POST), or [Change Customer's Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) request.
* * [Reference](ctp:api:type:Reference) to a [Customer](ctp:api:type:Customer).
* * Removing an address from the Customer produces the [CustomerAddressRemoved](ctp:api:type:CustomerAddressRemovedMessage) Message.
* * Removes a billing address from `billingAddressesIds`.
* * Removes a shipping address from `shippingAddressesIds`.
* * Removes the association to a Store from the Customer.
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Customer](ctp:api:type:Customer).
No description provided by the author
No description provided by the author
No description provided by the author
* * Adding a Custom Field to an Address of a Customer generates the [CustomerAddressCustomFieldAdded](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message, removing one generates the [CustomerAddressCustomFieldRemoved](ctp:api:type:CustomerAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on an Address of a Customer generates the [CustomerAddressCustomTypeSet](ctp:api:type:CustomerAddressCustomTypeSetMessage) Message, and removing one generates the [CustomerAddressCustomTypeRemoved](ctp:api:type:CustomerAddressCustomTypeRemovedMessage) Message.
No description provided by the author
* * Setting a company name produces the [CustomerCompanyNameSet](ctp:api:type:CustomerCompanyNameSetMessage) Message.
* * Setting the Customer Group of the Customer produces the [CustomerGroupSet](ctp:api:type:CustomerGroupSetMessage) 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).
* * Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message.
* * Setting the date of birth of the Customer produces the [CustomerDateOfBirthSet](ctp:api:type:CustomerDateOfBirthSetMessage) Message.
* * Sets the default billing address from `addresses`.
* * Sets the default shipping address from `addresses`.
No description provided by the author
* * Setting the first name of the Customer produces the [CustomeFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message.
No description provided by the author
* * Setting the last name of the Customer produces the [CustomerLastNameSet](ctp:api:type:CustomerLastNameSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
* * Sets the Stores the Customer account is associated with.
* * Setting the title of the Customer produces the [CustomerTitleSet](ctp:api:type:CustomerTitleSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Set Title](ctp:api:type:CustomerSetTitleAction) update action.
* * Generated after a successful [Set Title](ctp:api:type:CustomerSetTitleAction) update action.
No description provided by the author
No description provided by the author
* * Field type for Boolean values.
* * Field type for [DateTime](ctp:api:type:DateTime) values.
* * Field type for [Date](ctp:api:type:Date) values.
* * Field type for enum values.
* * Defines an allowed value of a [CustomFieldEnumType](ctp:api:type:CustomFieldEnumType) field.
* * Field type for localized enum values.
* * Defines an allowed value of a [CustomFieldLocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) field.
* * Field type for [LocalizedString](ctp:api:type:LocalizedString) values.
* * Field type for [CentPrecisionMoney](ctp:api:type:CentPrecisionMoney) values.
* * Field type for number values.
* * Field type for [Reference](ctp:api:type:Reference) values.
* * Serves as value of the `custom` field on a resource or data type customized with a [Type](ctp:api:type:Type).
* * The representation used when creating or updating a [customizable data type](/../api/projects/types#list-of-customizable-data-types) with Custom Fields.
* * Values of a SetType Custom Field are sets of values of the specified `elementType` (without duplicate elements).
* * Field type for string values.
* * Field type for [Time](ctp:api:type:Time) values.
* * 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.
No description provided by the author
* * Custom Line Items contain generic user-defined items that are not linked to Products.
No description provided by the author
* * Generated after a successful [Transition CustomLineItem State](ctp:api:type:OrderTransitionCustomLineItemStateAction) update action.
* * Generated after a successful [Transition CustomLineItem State](ctp:api:type:OrderTransitionCustomLineItemStateAction) update action.
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [CustomObject](ctp:api:type:CustomObject).
* * [Reference](ctp:api:type:Reference) to a [CustomObject](ctp:api:type:CustomObject).
No description provided by the author
* * Define arbitrary tokens that are used to match the input.
Date holds date information for Commercetools API format.
* * Contains information on how items are shipped to Customers, for example, a delivery note.
* * Generated after a successful [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action.
* * Generated after a successful [Add Delivery](ctp:api:type:OrderAddDeliveryAction) update action.
* * Generated after a successful [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
* * Generated after a successful [Set Delivery Address](ctp:api:type:OrderSetDeliveryAddressAction) update action.
* * Generated after adding a Custom Field to a Delivery using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated after adding a Custom Field to a Delivery using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated when an existing Custom Field on a Delivery has been changed using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated when an existing Custom Field on a Delivery has been changed using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated when a Custom Field has been removed from the Delivery using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated when a Custom Field has been removed from the Delivery using the [Set CustomField](ctp:api:type:OrderSetDeliveryCustomFieldAction) update action.
* * Generated after removing a Custom Type from a Delivery using the [Set Custom Type](ctp:api:type:OrderSetDeliveryCustomTypeAction) update action with empty parameters.
* * Generated after removing a Custom Type from a Delivery using the [Set Custom Type](ctp:api:type:OrderSetDeliveryCustomTypeAction) update action with empty parameters.
* * Generated after adding a Custom Type to a Delivery using the [Set Custom Type](ctp:api:type:OrderSetDeliveryCustomTypeAction) update action.
* * Generated after adding a Custom Type to a Delivery using the [Set Custom Type](ctp:api:type:OrderSetDeliveryCustomTypeAction) update action.
No description provided by the author
No description provided by the author
* * Generated after a successful [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
* * Generated after a successful [Set Delivery Items](ctp:api:type:OrderSetDeliveryItemsAction) update action.
* * Generated after a successful [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action.
* * Generated after a successful [Remove Delivery](ctp:api:type:OrderRemoveDeliveryAction) update action.
* * Represents a [CartDiscount](ctp:api:type:CartDiscount) that is only associated with a single Cart or Order.
* * Represents a [CartDiscount](ctp:api:type:CartDiscount) that can only be associated with a single Cart or Order.
* * [Reference](ctp:api:type:Reference) to a [DirectDiscount](ctp:api:type:DirectDiscount).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Create DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes:POST) request.
* * Generated after a successful [Create DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes:POST) request.
* * Generated after a successful [Delete DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes/{id}:DELETE) request.
* * Generated after a successful [Delete DiscountCode](ctp:api:endpoint:/{projectKey}/discount-codes/{id}:DELETE) request.
No description provided by the author
No description provided by the author
* * Generated after a successful [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
* * Generated after a successful [Set Key](ctp:api:type:DiscountCodeSetKeyAction) update action.
* * Returned when the Cart contains a Discount Code with a [DiscountCodeState](ctp:api:type:DiscountCodeState) other than `MatchesCart`.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [DiscountCode](ctp:api:type:DiscountCode).
* * [Reference](ctp:api:type:Reference) to a [DiscountCode](ctp:api:type:DiscountCode).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [DiscountCode](ctp:api:type:DiscountCode).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * This action generates a [DiscountCodeKeySet](ctp:api:type:DiscountCodeKeySetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Business Unit type to model divisions that are part of the [Company](ctp:api:type:Company) or a higher-order Division.
* * Draft type to model divisions that are part of a [Company](ctp:api:type:Company) or a higher-order [Division](ctp:api:type:Division).
* * Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys.
* * 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.
* * Returned when a Price key conflicts with an existing key.
* * Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
* * Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type: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.
* * Returned when during an order update of [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones.
No description provided by the author
* * Base representation of an error response containing common fields to all errors.
* * [AWS EventBridge](https://aws.amazon.com/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.
No description provided by the author
* * 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).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when the API Extension does not respond within the [time limit](/../api/projects/api-extensions#time-limits), or could not be reached.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Extension](ctp:api:type:Extension).
* * Returned when the predicate defined in the [ExtensionTrigger](ctp:api:type:ExtensionTrigger) could not be evaluated due to a missing field.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
No description provided by the author
* * Represents a RFC 7662 compliant [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662) endpoint.
* * Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
* * Cannot be used in [LineItemDraft](ctp:api:type:LineItemDraft) or [CustomLineItemDraft](ctp:api:type:CustomLineItemDraft).
* * Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
No description provided by the author
No description provided by the author
* * Returned when the requested feature was removed.
* * Defines a [Custom Field](/../api/projects/custom-fields) and its meta-information.
No description provided by the author
* * Returned when a server-side problem occurs before or after data persistence.
No description provided by the author
No description provided by the author
* * For GoogleCloudFunction destinations, you need to grant permissions to the `[email protected]` service account to invoke your function.
* * Destination for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/) that can be used * for [Pull subscriptions](https://cloud.google.com/pubsub/docs/pull) as well as for [Push subscriptions](https://cloud.google.com/pubsub/docs/push).
* * Returned when the anonymous ID is being used by another resource.
* * Returned when an [Associate](/projects/business-units#associate) is missing a [Permission](/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources).
* * Returned when the `name` of the [AttributeDefinition](ctp:api:type:AttributeDefinition) conflicts with an existing Attribute.
* * Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types.
* * Returned when an [AttributeDefinition](ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`.
* * 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.
* * Returned when the request results in too much data being returned from the API.
* * Returned when a [Cart](ctp:api:type:Cart) or an [Order](ctp:api:type:Order) in a [Store](ctp:api:type: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](ctp:api:type:DiscountCodeState) other than `MatchesCart`.
* * Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys.
* * 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.
* * Returned when a Price key conflicts with an existing key.
* * Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
* * Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
* * Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists.
* * Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type: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.
* * Returned when during an order update of [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones.
No description provided by the author
No description provided by the author
* * 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](/../api/projects/api-extensions#time-limits), or could not be reached.
* * Returned when the predicate defined in the [ExtensionTrigger](ctp:api:type: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).
* * Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
* * Returned when the requested feature was removed.
* * Returned when a server-side problem occurs before or after data persistence.
No description provided by the author
* * 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.
* * Returned when the current password of the Customer does not match.
* * Returned when a field has an invalid value.
* * Returned when an invalid input has been sent.
* * Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details.
* * 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.
No description provided by the author
No description provided by the author
* * Returned when a language cannot be removed from a Project as it is being used by a Store.
* * Returned when two [Customers](ctp:api:type:Customer) are simultaneously created or updated with the same email address.
* * Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type: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](/../api/limits#cart-discounts) for active Cart Discounts has been reached.
* * Returned when a resource type cannot be created as it has reached its [limits](/../api/limits).
* * Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached.
* * Returned when one of the following states occur: * * - [Channel](ctp:api:type:Channel) is added or set on a [Store](ctp:api:type:Store) with missing Channel `roles`.
* * Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart.
* * Returned when a [Money](ctp:api:type: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.
* * Returned when the requested resource was not found.
* * Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an [Order](ctp:api:type:Order).
* * Returned when the service is having trouble handling the load.
* * 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.
* * Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
* * Returned when a Product is not assigned to the Product Selection.
* * Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion).
* * Returned when the languages set for a Store are not supported by the Project.
No description provided by the author
* * Returned when the query times out.
* * Returned when a resource referenced by a [Reference](ctp:api:type:Reference) or a [ResourceIdentifier](ctp:api:type:ResourceIdentifier) could not be found.
* * Returned when a resource cannot be deleted because it is being referenced by another resource.
No description provided by the author
* * Returned when a value is not defined for a required field.
* * Returned when the resource addressed by the request URL does not exist.
* * Returned when the resource exceeds the maximum allowed size of 16 MB.
No description provided by the author
* * 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.
* * 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.
* * Returned if the requested search service is not ready.
* * Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct.
* * Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart).
* * Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request.
* * Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
* * Object that stores money as a fraction of the smallest indivisible unit of a specific currency.
* * Draft object to store money as a fraction of the smallest indivisible unit for a specific currency.
No description provided by the author
* * We recommend an encrypted `HTTPS` connection for production setups.
No description provided by the author
No description provided by the author
* * Contained in responses to an [Upload Product image](/projects/products#upload-product-image) or an [Upload Product Tailoring image](/projects/product-tailoring#upload-product-tailoring-image) request with response status code `202 Accepted`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * 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.
* * Returned when the current password of the Customer does not match.
* * Returned when a field has an invalid value.
* * Returned when an invalid input has been sent.
* * Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details.
* * 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.
No description provided by the author
No description provided by the author
No description provided by the author
* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
* * Generated after a successful [Create InventoryEntry](ctp:api:endpoint:/{projectKey}/inventory:POST) request.
* * Generated after a successful [Create InventoryEntry](ctp:api:endpoint:/{projectKey}/inventory:POST) request.
* * Generated after a successful [Delete InventoryEntry](/../api/projects/inventory#delete-inventoryentry) request.
* * Generated after a successful [Delete InventoryEntry](/../api/projects/inventory#delete-inventoryentry) request.
No description provided by the author
* * Generated after a successful [Add Quantity](ctp:api:type:InventoryEntryAddQuantityAction), [Remove Quantity](ctp:api:type:InventoryEntryRemoveQuantityAction) or [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action.
* * Generated after a successful [Add Quantity](ctp:api:type:InventoryEntryAddQuantityAction), [Remove Quantity](ctp:api:type:InventoryEntryRemoveQuantityAction) or [Change Quantity](ctp:api:type:InventoryEntryChangeQuantityAction) update action.
* * [Reference](ctp:api:type:Reference) to an [InventoryEntry](ctp:api:type:InventoryEntry).
* * Updates `availableQuantity` based on the new `quantityOnStock` and amount of active reservations.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [InventoryEntry](ctp:api:type:InventoryEntry).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * If an entry with the same `sku` and `supplyChannel` already exists, an [DuplicateField](ctp:api:type:DuplicateFieldError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
* * Determines the address (as a reference to an address in `itemShippingAddresses`) and the quantity shipped to the address.
No description provided by the author
* * Returned when a language cannot be removed from a Project as it is being used by a Store.
* * IDs and references that last modified the resource.
* * The representation of a [Line Item](/../api/carts-orders-overview#line-items) in a [Cart](ctp:api:type:Cart) or in an [Order](ctp:api:type:Order).
* * For Product Variant identification, either the `productId` and `variantId`, or `sku` must be provided.
* * Represents a snapshot of a Product Variant at the time it was imported with the Order.
No description provided by the author
* * Generated after a successful [Transition LineItem State](ctp:api:type:OrderTransitionLineItemStateAction) update action.
* * Generated after a successful [Transition LineItem State](ctp:api:type:OrderTransitionLineItemStateAction) update action.
* * A geographical location representing a country and optionally a state within this country.
* * Returned when two [Customers](ctp:api:type:Customer) are simultaneously created or updated with the same email address.
* * Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type: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](/../api/limits#cart-discounts) for active Cart Discounts has been reached.
* * Returned when a resource type cannot be created as it has reached its [limits](/../api/limits).
* * Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached.
* * This payload is sent for a [MessageSubscription](ctp:api:type:MessageSubscription).
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Message](ctp:api:type:Message).
* * Holds the configuration for the [Messages Query](/../api/projects/messages) feature for the Project.
* * Defines the configuration for the [Messages Query](/../api/projects/messages) feature for the Project.
* * Messages will be delivered even if the Messages Query HTTP API [is not enabled](/../api/projects/messages#enable-querying-messages-via-the-api).
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when one of the following states occur: * * - [Channel](ctp:api:type:Channel) is added or set on a [Store](ctp:api:type:Store) with missing Channel `roles`.
* * Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart.
* * Draft object to store money in cent amounts for a specific currency.
* * Returned when a [Money](ctp:api:type:Money) operation overflows the 64-bit integer range.
* * This Discount target is similar to `MultiBuyLineItems`, but is applied on Custom Line Items instead of Line Items.
No description provided by the author
* * Adding an address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAddressAdded](ctp:api:type:BusinessUnitAddressAddedMessage) Message.
* * Adding a billing address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressAdded](ctp:api:type:BusinessUnitBillingAddressAddedMessage) Message.
* * Adding a shipping address to a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressAdded](ctp:api:type:BusinessUnitShippingAddressAddedMessage) Message.
No description provided by the author
* * Changing the address on a Business Unit generates the [BusinessUnitAddressChanged](ctp:api:type:BusinessUnitAddressChangedMessage) Message.
* * Updating the [Associate](ctp:api:type:Associate) on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAssociateChanged](ctp:api:type:BusinessUnitAssociateChangedMessage) Message.
* * Updating the name on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitNameChanged](ctp:api:type:BusinessUnitNameChangedMessage) Message.
* * Changing the parent of a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitParentChanged](ctp:api:type:BusinessUnitParentChangedMessage) Message.
* * Removing the address from a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitAddressRemoved](ctp:api:type:BusinessUnitAddressRemovedMessage) Message.
* * Removing an [Associate](ctp:api:type:Associate) from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitAssociateRemoved](ctp:api:type:BusinessUnitAssociateRemovedMessage) Message.
* * Removing a billing address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitBillingAddressRemoved](ctp:api:type:BusinessUnitBillingAddressRemovedMessage) Message.
* * Removing a shipping address from a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitShippingAddressRemoved](ctp:api:type:BusinessUnitShippingAddressRemovedMessage) Message.
* * Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type to an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message.
* * Setting the contact email on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitContactEmailSet](ctp:api:type:BusinessUnitContactEmailSetMessage) Message.
* * Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message.
* * Setting the default billing address on a [Business Unit](ctp:api:type:BusinessUnit) generates the [BusinessUnitDefaultBillingAddressSet](ctp:api:type:BusinessUnitDefaultBillingAddressSetMessage) Message.
* * Setting the default shipping address on a [Business Unit](ctp:api:type:BusinessUnit) generates a [BusinessUnitDefaultShippingAddressSet](ctp:api:type:BusinessUnitDefaultShippingAddressSetMessage) Message.
No description provided by the author
* * Adds a [DiscountCode](ctp:api:type:DiscountCode) to the Cart to activate the related [CartDiscounts](/../api/projects/cartDiscounts).
* * Adds an address to a Cart when shipping to multiple addresses is desired.
* * If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/custom-fields), supply and distribution channel, then only the quantity of the existing Line Item is increased.
No description provided by the author
* * To override the shipping details, see [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction).
* * When multiple shipping addresses are set for a Line Item, * use the [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) and [Add LineItem](ctp:api:type:CartAddLineItemAction) update action * to change the shipping details.
No description provided by the author
* * - When `External` [TaxMode](ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed.
* * The `customerId` is determined by a [password flow token](/../api/authorization#password-flow) and * automatically set on the resulting [Cart](ctp:api:type:Cart).
* * This update action does not set any Cart field in particular, but it triggers several [Cart updates](/../api/carts-orders-overview#cart-updates) * to bring prices and discounts to the latest state.
No description provided by the author
* * An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
* * The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
No description provided by the author
No description provided by the author
* * Updates the Business Unit on the Cart.
* * Setting the country can lead to changes in the [LineItem](ctp:api:type:LineItem) prices.
No description provided by the author
No description provided by the author
No description provided by the author
* * Number of days after which a Cart with `Active` [CartState](ctp:api:type:CartState) is deleted since its last modification.
No description provided by the author
No description provided by the author
* * Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
No description provided by the author
* * Performing this action has no impact on inventory that should be reserved.
No description provided by the author
* * Setting the shipping address also sets the [TaxRate](ctp:api:type:TaxRate) of Line Items and calculates the [TaxedPrice](ctp:api:type:TaxedPrice).
* * To set the Cart's Shipping Method the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
No description provided by the author
* * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
* * Draft type to represent the top level of a business.
* * Adding an address to the Customer produces the [CustomerAddressAdded](ctp:api:type:CustomerAddressAddedMessage) Message.
* * Adds an address from the `addresses` array to `billingAddressIds`.
* * Adds an address from the `addresses` array to `shippingAddressIds`.
* * Changing an address of the Customer produces the [CustomerAddressChanged](ctp:api:type:CustomerAddressChangedMessage) Message.
* * Changing the email of the Customer produces the [CustomerEmailChanged](ctp:api:type:CustomerEmailChangedMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
* * Removing an address of the Customer produces the [CustomerAddressRemoved](ctp:api:type:CustomerAddressRemovedMessage) Message.
* * Removes an existing billing address from `billingAddressesIds`.
* * Removes an existing shipping address from `shippingAddressesIds`.
No description provided by the author
* * Setting the `companyName` field on the Customer produces the [CustomerCompanyNameSet](ctp:api:type:CustomerCompanyNameSetMessage) Message.
* * Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message.
* * Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message.
* * Setting the date of birth of the Customer produces the [CustomerDateOfBirthSet](ctp:api:type:CustomerDateOfBirthSetMessage) Message.
* * Sets the default billing address from `addresses`.
* * Sets the default shipping address from `addresses`.
* * Setting the first name of the Customer produces the [CustomerFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message.
* * Setting the last name of the Customer produces the [CustomerLastNameSet](ctp:api:type:CustomerLastNameSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
* * Setting the title of the Customer produces the [CustomerTitleSetMessage](ctp:api:type:CustomerTitleSetMessage).
No description provided by the author
No description provided by the author
No description provided by the author
* * Draft type to model divisions that are part of the [Company](ctp:api:type:Company) or a higher-order [Division](ctp:api:type:Division).
* * For Product Variant identification, either the `productId` and `variantId`, or `sku` must be provided.
No description provided by the author
No description provided by the author
No description provided by the author
* * Adding a Transaction to a Payment generates the [PaymentTransactionAdded](ctp:api:type:PaymentTransactionAddedMessage) Message.
* * Can be used to update the Payment if a customer changes the [Cart](ctp:api:type:Cart), or adds or removes a [CartDiscount](ctp:api:type:CartDiscount) during checkout.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [MyPayment](ctp:api:type:MyPayment).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * When accepting, declining, or renegotiating [B2B Quotes](/../api/associates-overview#b2b-resources), the Customer must have the `AcceptMyQuotes`, `DeclineMyQuotes`, or `RenegotiateMyQuotes` [Permission](ctp:api:type:Permission), respectively.
* * Transitions the `quoteRequestState` of the Quote Request to `Cancelled`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * A [MyShoppingListDraft](ctp:api:type:MyShoppingListDraft) is the object submitted as payload to the [Create MyShoppingList request](ctp:api:endpoint:/{projectKey}/me/shopping-lists:POST).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
* * Returned when the requested resource was not found.
No description provided by the author
* * A [Delivery](ctp:api:type:Delivery) can only be added to an [Order](ctp:api:type: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.
* * To add a Parcel, at least one [Delivery](ctp:api:type:Delivery) must exist.
No description provided by the author
* * Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message.
* * Generated after a successful [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
* * Generated after a successful [Set Billing Address](ctp:api:type:OrderSetBillingAddressAction) update action.
* * Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message.
* * Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message.
* * Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message.
* * Generated after a successful [Create Order](ctp:api:endpoint:/{projectKey}/orders:POST) request.
* * Generated after a successful [Create Order](ctp:api:endpoint:/{projectKey}/orders:POST) request.
* * Generated after a successful [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
* * Generated after a successful [Set Customer Email](ctp:api:type:OrderSetCustomerEmailAction) update action.
* * Generated after a successful [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
* * Generated after a successful [Set Customer Group](ctp:api:type:StagedOrderSetCustomerGroupAction) update action.
* * Generated after a successful [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
* * Generated after a successful [Set Customer ID](ctp:api:type:OrderSetCustomerIdAction) update action.
* * Generated after adding a Custom Field using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction).
* * Generated after adding a Custom Field using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction).
* * Generated when an existing Custom Field has been changed using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action.
* * Generated when an existing Custom Field has been changed using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action.
* * Generated when a Custom Field has been removed from the Order using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action.
* * Generated when a Custom Field has been removed from the Order using the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) action.
* * Generated after a successful [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action.
* * Generated after a successful [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action.
* * Generated after a successful recalculation of a Discount on a [Custom Line Item](ctp:api:type:CustomLineItem).
* * Generated after a successful recalculation of a Discount on a [Custom Line Item](ctp:api:type:CustomLineItem).
* * Generated after a successful [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
* * Generated after a successful [Change CustomLineItem Quantity](ctp:api:type:StagedOrderChangeCustomLineItemQuantityAction) update action.
* * Generated after a successful [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action.
* * Generated after a successful [Remove CustomLineItem](ctp:api:type:StagedOrderRemoveCustomLineItemAction) update action.
* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) with empty parameters.
* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction) with empty parameters.
* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction).
* * Generated after a successful [Set Custom Type](ctp:api:type:OrderSetCustomTypeAction).
* * Generated after a successful [Delete Order](/../api/projects/orders#delete-order) request.
* * Generated after a successful [Delete Order](/../api/projects/orders#delete-order) request.
* * Generated after a successful [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action.
* * Generated after a successful [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action.
* * Generated after a successful [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action.
* * Generated after a successful [Remove DiscountCode](ctp:api:type:StagedOrderRemoveDiscountCodeAction) update action.
* * Generated after the [DiscountCodeState](ctp:api:type:DiscountCodeState) changes due to a [recalculation](/../api/projects/carts#recalculate).
* * Generated after the [DiscountCodeState](ctp:api:type:DiscountCodeState) changes due to a [recalculation](/../api/projects/carts#recalculate).
No description provided by the author
* * The `stagedActions` field cannot be updated if the Order Edit `result` is [OrderEdit Applied](/projects/order-edits#orderedit-applied).
* * Result of a succesful application of `stagedActions` to the Order.
* * Generated after successfully [applying an OrderEdit](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST).
* * Generated after successfully [applying an OrderEdit](ctp:api:endpoint:/{projectKey}/orders/edits/{id}/apply:POST).
* * If the `editVersion` and/or `resourceVersion` do not match the actual version, a [ConcurrentModification](ctp:api:type:ConcurrentModificationError) error will be returned.
No description provided by the author
* * Indicates that the edit has not been applied or processed in any way.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [OrderEdit](ctp:api:type:OrderEdit).
* * 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](ctp:api:type:Order), not from the Order version at the time the OrderEdit was created.
* * [Reference](ctp:api:type:Reference) to an [OrderEdit](ctp:api:type:OrderEdit).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * The `stagedActions` field cannot be updated if the Order Edit `result` is [OrderEdit Applied](/projects/order-edits#orderedit-applied).
No description provided by the author
* * Excerpt of the Order extracting the total and the taxed price.
No description provided by the author
No description provided by the author
* * 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.
* * Generated after a successful [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST).
* * Generated after a successful [Order Import](ctp:api:endpoint:/{projectKey}/orders/import:POST).
* * The import of States does not follow any predefined rules and should be only used if no transitions are defined.
* * Generated after a successful [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action.
* * Generated after a successful [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action.
* * Generated after a successful recalculation of a Discount on a [Line Item](ctp:api:type:LineItem).
* * Generated after a successful recalculation of a Discount on a [Line Item](ctp:api:type:LineItem).
* * Generated after a successful [Set LineItem DistributionChannel](/../api/projects/order-edits#set-lineitem-distributionchannel) update action.
* * Generated after a successful [Set LineItem DistributionChannel](/../api/projects/order-edits#set-lineitem-distributionchannel) update action.
* * Generated after a successful [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
* * Generated after a successful [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Order](ctp:api:type:Order).
No description provided by the author
* * Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a [Payment](ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction).
* * Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a [Payment](ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction).
* * Generated after a successful [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) update action.
* * Generated after a successful [Change PaymentState](ctp:api:type:OrderChangePaymentStateAction) update action.
* * Generated after a successful [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
* * Generated after a successful [Set Purchase Order Number](ctp:api:type:OrderSetPurchaseOrderNumberAction) update action.
* * [Reference](ctp:api:type:Reference) to an [Order](ctp:api:type:Order).
* * Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message.
* * An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
* * Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message.
No description provided by the author
* * Generated after a successful [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit).
* * Generated after a successful [Set ReturnShipmentState](ctp:api:type:OrderSetReturnShipmentStateAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * This action updates the `billingAddress` on the Order, but it does not change the billing address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
No description provided by the author
No description provided by the author
* * This action updates the `customerEmail` on the Order, but it does not change the Customer email on the [Cart](ctp:api:type:Cart) the Order has been created from.
* * Setting the Order's `customerId` does not recalculate prices or discounts on the Order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message.
* * Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message.
* * Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message.
* * Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message.
* * Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message.
No description provided by the author
No description provided by the author
* * To set a [ReturnPaymentState](ctp:api:type:ReturnPaymentState), the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
* * To set a `ReturnShipmentState`, the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
* * This action updates the `shippingAddress` on the Order, but it does not change the shipping address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
No description provided by the author
No description provided by the author
No description provided by the author
* * This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's `shippingMethod` or `shipping`.
* * Sets the [Store](ctp:api:type:Store) the Order is assigned to.
* * Generated after a successful [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) update action.
* * Generated after a successful [Change ShipmentState](ctp:api:type:OrderChangeShipmentStateAction) update action.
* * Generated after a successful [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
* * Generated after a successful [Set Shipping Address](ctp:api:type:OrderSetShippingAddressAction) update action.
* * Generated after a successful [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) and [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update actions.
* * Generated after a successful [Set ShippingMethod](ctp:api:type:StagedOrderSetShippingMethodAction) and [Set Custom ShippingMethod](ctp:api:type:StagedOrderSetCustomShippingMethodAction) update actions.
* * Generated after a successful [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
* * Generated after a successful [Set ShippingRateInput](ctp:api:type:StagedOrderSetShippingRateInputAction) update action.
* * Generated after a successful [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) update action.
* * Generated after a successful [Change OrderState](ctp:api:type:OrderChangeOrderStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:OrderTransitionStateAction) update action.
* * Generated after a successful [Set Store](ctp:api:type:OrderSetStoreAction) update action.
* * Generated after a successful [Set Store](ctp:api:type:OrderSetStoreAction) update action.
* * Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message.
* * Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message.
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
No description provided by the author
* * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
No description provided by the author
* * Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an [Order](ctp:api:type:Order).
* * Returned when the service is having trouble handling the load.
* * Returned when a given Price validity period conflicts with an existing one.
No description provided by the author
* * Information regarding the appearance, content, and shipment of a Parcel.
* * Generated after a successful [Add Parcel to Delivery](ctp:api:type:OrderAddParcelToDeliveryAction) update action.
* * Generated after a successful [Add Parcel to Delivery](ctp:api:type:OrderAddParcelToDeliveryAction) update action.
No description provided by the author
* * Generated after a successful [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
* * Generated after a successful [Set Parcel Items](ctp:api:type:OrderSetParcelItemsAction) update action.
No description provided by the author
* * Generated after a successful [Set Parcel Measurements](ctp:api:type:OrderSetParcelMeasurementsAction) update action.
* * Generated after a successful [Set Parcel Measurements](ctp:api:type:OrderSetParcelMeasurementsAction) update action.
* * Generated after a successful [Remove Parcel from Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) update action.
* * Generated after a successful [Remove Parcel from Delivery](ctp:api:type:OrderRemoveParcelFromDeliveryAction) update action.
* * Generated after a successful [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) update action.
* * Generated after a successful [Set Parcel Tracking Data](ctp:api:type:OrderSetParcelTrackingDataAction) update action.
No description provided by the author
No description provided by the author
* * Adding a Payment interaction generates the [PaymentInteractionAdded](ctp:api:type:PaymentInteractionAddedMessage) Message.
* * Adding a Transaction to a Payment generates the [PaymentTransactionAdded](ctp:api:type:PaymentTransactionAddedMessage) Message.
* * Can be used to update the Payment if a customer changes the [Cart](ctp:api:type:Cart), or adds or removes a [CartDiscount](ctp:api:type:CartDiscount) during checkout.
No description provided by the author
* * Changing the [TransactionState](ctp:api:type:TransactionState) generates the [PaymentTransactionStateChanged](ctp:api:type:PaymentTransactionStateChangedMessage) Message.
No description provided by the author
* * Generated after a successful [Create Payment](ctp:api:endpoint:/{projectKey}/payments:POST) request.
* * Generated after a successful [Create Payment](ctp:api:endpoint:/{projectKey}/payments:POST) request.
No description provided by the author
No description provided by the author
* * Generated after a successful [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action.
* * Generated after a successful [Add InterfaceInteraction](ctp:api:type:PaymentAddInterfaceInteractionAction) update action.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Payment](ctp:api:type:Payment).
* * [Reference](ctp:api:type:Reference) to a [Payment](ctp:api:type:Payment).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
No description provided by the author
No description provided by the author
* * If the Payment is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Produces the [PaymentStatusInterfaceCodeSet](ctp:api:type:PaymentStatusInterfaceCodeSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action.
* * Generated after a successful [Set StatusInterfaceCode](ctp:api:type:PaymentSetStatusInterfaceCodeAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:PaymentTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:PaymentTransitionStateAction) update action.
* * Generated after a successful [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action.
* * Generated after a successful [Add Transaction](ctp:api:type:PaymentAddTransactionAction) update action.
* * Generated after a successful [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action.
* * Generated after a successful [Change TransactionState](ctp:api:type:PaymentChangeTransactionStateAction) update action.
* * If the Payment has no current [State](ctp:api:type:State), `initial` must be `true` for the new State.
No description provided by the author
* * Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
* * The PlatformFormat uses constructs that are similar to the ones used in the REST API, for example, on the [Messages Query HTTP API](/../api/projects/messages).
* * The representation for prices embedded in [LineItems](ctp:api:type:LineItem) and in [ProductVariants](ctp:api:type:ProductVariant) when the [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) is `Embedded`.
* * Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
* * The draft representation for prices to be embedded into [ProductVariantDrafts](ctp:api:type:ProductVariantDraft) when the [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) is `Embedded`.
No description provided by the author
* * A Price tier is selected instead of the default Price when a certain quantity of the [ProductVariant](ctp:api:type:ProductVariant) is [added to a Cart](/projects/carts#add-lineitem) and ordered.
* * Specifies a Price tier that applies when the minimum quantity for the [LineItem](ctp:api:type:LineItem) of a ProductVariant with the related Price is reached in a Cart.
* * An abstract sellable good with a set of Attributes defined by a Product Type.
* * Either `variantId` or `sku` is required.
* * Generated after a successful [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action.
* * Generated after a successful [Add to Category](ctp:api:type:ProductAddToCategoryAction) update action.
* * Either `variantId` or `sku` is required.
* * Adds the given Price to the `prices` array of the [ProductVariant](ctp:api:type:ProductVariant).
* * Produces the [ProductAddedToCategory](/projects/messages/product-catalog-messages#product-added-to-category) Message.
No description provided by the author
* * Returned when a Product is not assigned to the Product Selection.
* * Contains the `current` and `staged` [ProductData](ctp:api:type:ProductData).
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Assigns the specified Product Variant to the `masterVariant` and removes the same from `variants` at the same time.
No description provided by the author
No description provided by the author
* * Produces the [ProductSlugChanged](ctp:api:type:ProductSlugChangedMessage) Message.
* * Generated after a successful [Create Product](ctp:api:endpoint:/{projectKey}/products:POST) request.
* * Generated after a successful [Create Product](ctp:api:endpoint:/{projectKey}/products:POST) request.
* * Contains all the data of a Product and its Product Variants.
* * Generated after a successful [Delete Product](/../api/projects/products#delete-product) request.
* * Generated after a successful [Delete Product](/../api/projects/products#delete-product) request.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ProductDiscount](ctp:api:type:ProductDiscount).
* * [Reference](ctp:api:type:Reference) to a [ProductDiscount](ctp:api:type:ProductDiscount).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductDiscount](ctp:api:type:ProductDiscount).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Discounts the Product's Price by a fixed amount, defined by the `money` field.
* * Discounts the Product Price by a fixed amount, defined by the `money` field.
* * Discounts the Product Price by allowing the client to explicitly [set a discounted value](ctp:api:type:ProductSetDiscountedPriceAction).
* * Discounts the Product Price by allowing the client to explicitly [set a discounted value](ctp:api:type:ProductSetDiscountedPriceAction).
* * Discounts the product price by a percentage, defined by the `permyriad` field.
* * Discounts the Product Price by a percentage, defined by the `permyriad` field.
No description provided by the author
* * Generated after a successful [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action or after the successful [upload of an image](/../api/projects/products#upload-product-image).
* * Generated after a successful [Add External Image](ctp:api:type:ProductAddExternalImageAction) update action or after the successful [upload of an image](/../api/projects/products#upload-product-image).
No description provided by the author
* * Either `variantId` or `sku` is required.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Product](ctp:api:type:Product).
No description provided by the author
* * Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion).
* * Generated after a successful [Add Price](ctp:api:type:ProductAddPriceAction) update action.
* * Generated after a successful [Add Price](ctp:api:type:ProductAddPriceAction) update action.
* * Generated after a successful [Change Price](ctp:api:type:ProductChangePriceAction) update action.
* * Generated after a successful [Change Price](ctp:api:type:ProductChangePriceAction) update action.
* * Generated after adding a Custom Field to a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after adding a Custom Field to a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after changing an existing Custom Field on a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after removing a Custom Field from a Price using the [Set Price CustomField](ctp:api:type:ProductSetProductPriceCustomFieldAction) update action.
* * Generated after removing a Custom Type from a Price using the [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action.
* * Generated after removing a Custom Type from a Price using the [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action.
* * Generated after a successful [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action.
* * Generated after a successful [Set Price Custom Type](ctp:api:type:ProductSetProductPriceCustomTypeAction) update action.
* * Generated after a Price is updated due to a [Product Discount](ctp:api:type:ProductDiscount).
* * Generated after a Price is updated due to a [Product Discount](ctp:api:type:ProductDiscount).
* * Details about an [Embedded Price](ctp:api:type:Price) that was updated due to a Discount.
* * Generated after a successful [Set Discounted Price](ctp:api:type:ProductSetDiscountedPriceAction) update action.
* * Generated after a successful [Set Discounted Price](ctp:api:type:ProductSetDiscountedPriceAction) update action.
* * Generated after a successful [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
* * Generated after a successful [Set Price Key](ctp:api:type:ProductSetPriceKeyAction) update action.
* * Generated after a successful [Set PriceMode](ctp:api:type:ProductSetPriceModeAction) update action.
* * Generated after a successful [Set PriceMode](ctp:api:type:ProductSetPriceModeAction) update action.
* * Generated after a successful [Remove Price](ctp:api:type:ProductRemovePriceAction) update action.
* * Generated after a successful [Remove Price](ctp:api:type:ProductRemovePriceAction) update action.
* * Generated after a successful [Set Prices](ctp:api:type:ProductSetPricesAction) update action.
* * Generated after a successful [Set Prices](ctp:api:type:ProductSetPricesAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
* * Publishes product data from the Product's staged projection to its current projection.
* * Generated after a successful [Publish](ctp:api:type:ProductPublishAction) update action.
* * Generated after a successful [Publish](ctp:api:type:ProductPublishAction) update action.
* * [Reference](ctp:api:type:Reference) to a [Product](ctp:api:type:Product).
* * Either `variantId` or `sku` is required.
* * Generated after a successful [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action.
* * Generated after a successful [Remove from Category](ctp:api:type:ProductRemoveFromCategoryAction) update action.
* * Produces the [ProductRemovedFromCategory](ctp:api:type:ProductRemovedFromCategoryMessage) Message.
* * Removes a Product image and deletes it from the Content Delivery Network (external images are not deleted).
No description provided by the author
* * Either `id` or `sku` is required.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Product](ctp:api:type:Product).
* * Generated after a successful [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action.
* * Generated after a successful [Revert Staged Changes](ctp:api:type:ProductRevertStagedChangesAction) update action.
* * Reverts the staged version of a Product to the current version.
* * Reverts the staged version of a ProductVariant to the current version.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Values for `from` and `to` must be a number or [DateTime](ctp:api:type:DateTime).
No description provided by the author
No description provided by the author
* * Result of a [distinct facet](/../api/projects/product-search#distinct-facets) or a [ranges facet](/../api/projects/product-search#ranges-facets).
No description provided by the author
* * Result of a [count facet](/../api/projects/product-search#count-facets).
No description provided by the author
No description provided by the author
* * The query parameters used for [data integration with Product Projection parameters](/../api/projects/product-search#with-product-projection-parameters).
No description provided by the author
No description provided by the author
No description provided by the author
* * Adds a Product to the Product Selection.
* * * Given the mode of Product Selection, this assignment refers to, it may contain: * * - `variantSelection` field for a Product Selection with `Individual` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
No description provided by the author
* * Generated after a successful [Create Product Selection](ctp:api:endpoint:/{projectKey}/product-selections:POST) request.
* * Generated after a successful [Create Product Selection](ctp:api:endpoint:/{projectKey}/product-selections:POST) request.
* * Generated after a successful [Delete Product Selection](/../api/projects/product-selections#delete-productselection) request.
* * Generated after a successful [Delete Product Selection](/../api/projects/product-selections#delete-productselection) request.
No description provided by the author
* * Excludes a Product from a Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [ProductSelection](ctp:api:type:ProductSelection).
* * Generated after a successful [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action.
* * Generated after a successful [Add Product](ctp:api:type:ProductSelectionAddProductAction) update action.
* * Generated after a successful [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
* * Generated after a successful [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [AssignedProductReference](ctp:api:type:AssignedProductReference).
* * Generated after a successful [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action.
* * Generated after a successful [Remove Product](ctp:api:type:ProductSelectionRemoveProductAction) update action.
* * [Reference](ctp:api:type:Reference) to a [ProductSelection](ctp:api:type:ProductSelection).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductSelection](ctp:api:type:ProductSelection).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Updates the Product Variant Exclusion of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment).
* * Updates the Product Variant Selection of an existing [Product Selection Assignment](ctp:api:type:ProductSelectionAssignment).
No description provided by the author
* * Generated after a successful [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
* * Generated after a successful [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
* * Generated after a successful [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
* * Generated after a successful [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) update action.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Either `variantId` or `sku` is required.
* * Adds, removes, or changes a Product Attribute in all Product Variants at the same time.
No description provided by the author
No description provided by the author
* * Produces the [ProductPriceExternalDiscountSet](ctp:api:type:ProductPriceExternalDiscountSetMessage) Message.
* * Either `variantId` or `sku` is required.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Sets the key of an [Embedded Price](ctp:api:type:Price).
* * Controls whether the Prices of a Product Variant are embedded into the Product or standalone.
* * Either `variantId` or `sku` is required.
No description provided by the author
No description provided by the author
* * Either `variantId` or `sku` is required.
No description provided by the author
* * SKU cannot be changed or removed if it is associated with an [InventoryEntry](ctp:api:type:InventoryEntry).
* * Cannot be staged.
* * [PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [ProductSelectionAssignment](ctp:api:type:ProductSelectionAssignment).
* * Generated after a successful [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
* * Generated after a successful [Change Slug](ctp:api:type:ProductChangeSlugAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:ProductTransitionStateAction) update action.
* * A single ProductTailoring representation contains the _current_ and the _staged_ representation of its product data tailored per Store.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `id` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * The same rules for `name` and `value` apply as for [Attribute](ctp:api:type:Attribute) in Product Variants.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Generated after a successful [Create Product Tailoring](/../api/projects/product-tailoring#create-producttailoring) or * [Create Product Tailoring in Store](/../api/projects/product-tailoring#create-producttailoring-in-store) request.
* * Generated after a successful [Create Product Tailoring](/../api/projects/product-tailoring#create-producttailoring) or * [Create Product Tailoring in Store](/../api/projects/product-tailoring#create-producttailoring-in-store) request.
* * Contains all the tailored data of a Product.
* * Generated after a successful [Delete Product Tailoring](/../api/projects/product-tailoring#delete-producttailoring) or * [Delete ProductTailoring assigned to Product in Store](/../api/projects/product-tailoring#delete-producttailoring-assigned-to-product-in-store) request.
* * Generated after a successful [Delete Product Tailoring](/../api/projects/product-tailoring#delete-producttailoring) or * [Delete ProductTailoring assigned to Product in Store](/../api/projects/product-tailoring#delete-producttailoring-assigned-to-product-in-store) request.
* * Generated after a successful Product Tailoring [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
* * Generated after a successful Product Tailoring [Set Description](ctp:api:type:ProductTailoringSetDescriptionAction) update action.
* * Contains all the tailored data of a Product.
* * Generated after a successful [Add External Image](ctp:api:type:ProductTailoringAddExternalImageAction) update action * or after a successful [Upload Product Tailoring image](/projects/product-tailoring#upload-product-tailoring-image) request.
* * Generated after a successful [Add External Image](ctp:api:type:ProductTailoringAddExternalImageAction) update action * or after a successful [Upload Product Tailoring image](/projects/product-tailoring#upload-product-tailoring-image) request.
* * Generated after a successful [Set Images](ctp:api:type:ProductTailoringSetExternalImagesAction) update action.
* * Generated after a successful [Set Images](ctp:api:type:ProductTailoringSetExternalImagesAction) update action.
* * Contains all the tailored data of a Product for a specific Store.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Generated after a successful Product Tailoring [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
* * Generated after a successful Product Tailoring [Set Name](ctp:api:type:ProductTailoringSetNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ProductTailoring](ctp:api:type:ProductTailoring).
* * Publishes the `staged` data of the ProductTailoring to `current`.
* * Generated after a successful [Product Tailoring Publish](ctp:api:type:ProductTailoringPublishAction) update action.
* * Generated after a successful [Product Tailoring Publish](ctp:api:type:ProductTailoringPublishAction) update action.
* * [Reference](ctp:api:type:Reference) to a [ProductTailoring](ctp:api:type:ProductTailoring).
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `id` or `sku` is required.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductTailoring](ctp:api:type:ProductTailoring).
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required.
* * Adds, removes, or changes a tailored Attribute in all Product Variants of a Product at the same time.
* * Generates the [ProductTailoringDescriptionSet](ctp:api:type:ProductTailoringDescriptionSetMessage) Message.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Either `variantId` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Updates all meta attributes at the same time.
No description provided by the author
No description provided by the author
No description provided by the author
* * Generates the [ProductTailoringNameSet](ctp:api:type:ProductTailoringNameSetMessage) Message.
* * Generates the [ProductTailoringSlugSet](ctp:api:type:ProductTailoringSlugSetMessage) Message.
* * Generated after a successful Product Tailoring [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
* * Generated after a successful Product Tailoring [Set Slug](ctp:api:type:ProductTailoringSetSlugAction) update action.
* * Unpublishes the `current` data of the ProductTailoring.
* * Generated after a successful [Product Tailoring Unpublish](ctp:api:type:ProductTailoringUnpublishAction) update action.
* * Generated after a successful [Product Tailoring Unpublish](ctp:api:type:ProductTailoringUnpublishAction) update action.
No description provided by the author
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
No description provided by the author
No description provided by the author
* * Adds a localizable enum to the values of [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType).
* * Adds an enum to the values of [AttributeEnumType](ctp:api:type:AttributeEnumType) AttributeDefinition, or [AttributeSetType](ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition.
* * Updates the `attributeConstraint` of an [AttributeDefinition](ctp:api:type:AttributeDefinition).
* * Renames an AttributeDefinition and also renames all corresponding Attributes on all [Products](/projects/products) with this ProductType.
No description provided by the author
No description provided by the author
No description provided by the author
* * Updates the key of a single enum `value` in an [AttributeEnumType](ctp:api:type:AttributeEnumType) AttributeDefinition, [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition, [AttributeSetType](ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition, or AttributeSetType of AttributeLocalizedEnumType AttributeDefinition.
* * Updates the `inputHint` of an [AttributeDefinition](ctp:api:type:AttributeDefinition).
* * Following this update the Products are reindexed asynchronously to reflect this change on the search endpoint.
No description provided by the author
* * Updates the label of a single enum `value` in an [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition, or [AttributeSetType](ctp:api:type:AttributeSetType) of AttributeLocalizedEnumType AttributeDefinition.
* * Updates the order of localized enum `values` in an [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) AttributeDefinition.
No description provided by the author
* * Updates the label of a single enum `value` in an [AttributeEnumType](ctp:api:type:AttributeEnumType) AttributeDefinition, or [AttributeSetType](ctp:api:type:AttributeSetType) of AttributeEnumType AttributeDefinition.
* * Updates the order of enum `values` in an [AttributeEnumType](ctp:api:type:AttributeEnumType) AttributeDefinition.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [ProductType](ctp:api:type:ProductType).
* * [Reference](ctp:api:type:Reference) to a [ProductType](ctp:api:type:ProductType).
* * Removes an AttributeDefinition and also deletes all corresponding Attributes on all [Products](/projects/products) with this ProductType.
* * Removes enum values from an AttributeDefinition of [AttributeEnumType](ctp:api:type:AttributeEnumType), [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType), [AttributeSetType](ctp:api:type:AttributeSetType) of AttributeEnumType, or AttributeSetType of AttributeLocalizedEnumType.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ProductType](ctp:api:type:ProductType).
No description provided by the author
No description provided by the author
No description provided by the author
* * Removes the current [projection](/../api/projects/productProjections#current--staged) of the Product.
* * Generated after a successful [Unpublish Product](ctp:api:type:ProductUnpublishAction) update action.
* * Generated after a successful [Unpublish Product](ctp:api:type:ProductUnpublishAction) update action.
No description provided by the author
* * A concrete sellable good for which inventory can be tracked.
* * Generated after a successful [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action.
* * Generated after a successful [Add ProductVariant](ctp:api:type:ProductAddVariantAction) update action.
* * The [InventoryEntry](ctp:api:type:InventoryEntry) information of the Product Variant.
No description provided by the author
* * Generated after a successful [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action.
* * Generated after a successful [Remove ProductVariant](ctp:api:type:ProductRemoveVariantAction) update action.
* * Creates a Product Variant when included in the `masterVariant` and `variants` fields of the [ProductDraft](ctp:api:type:ProductDraft).
* * Only Product Variants with the explicitly listed SKUs are part of a Product Selection with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode).
* * Contains the Product Variant to be used in the [LineItemImportDraft](ctp:api:type:LineItemImportDraft).
* * All Product Variants except the explicitly stated SKUs are part of the Product Selection.
* * 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.
* * Only Product Variants with explicitly stated SKUs are part of the Product Selection.
* * The tailoring of a [ProductVariant](ctp:api:type:ProductVariant).
* * Generated after a successful [Add ProductVariant Tailoring](ctp:api:type:ProductTailoringAddVariantAction) update action.
* * Generated after a successful [Add ProductVariant Tailoring](ctp:api:type:ProductTailoringAddVariantAction) update action.
* * Either `id` or `sku` is required to reference a [ProductVariant](ctp:api:type:ProductVariant) that exists.
* * Generated after a successful [Remove ProductVariant Tailoring](ctp:api:type:ProductTailoringRemoveVariantAction) update action.
* * Generated after a successful [Remove ProductVariant Tailoring](ctp:api:type:ProductTailoringRemoveVariantAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Removing a language used by a [Store](ctp:api:type:Store) returns a [LanguageUsedInStores](ctp:api:type:LanguageUsedInStoresError) error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when the languages set for a Store are not supported by the Project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when the query times out.
No description provided by the author
* * Changes the owner of a Quote to a different Customer.
No description provided by the author
* * Generated after a successful [Create Quote](ctp:api:endpoint:/{projectKey}/quotes:POST) request.
* * Generated after a successful [Create Quote](ctp:api:endpoint:/{projectKey}/quotes:POST) request.
* * Generated after a successful [Change Customer](ctp:api:type:QuoteChangeCustomerAction) update action.
* * Generated after a successful [Change Customer](ctp:api:type:QuoteChangeCustomerAction) update action.
* * Generated after a successful [Delete Quote](/../api/projects/quotes#delete-quote) request.
* * Generated after a successful [Delete Quote](/../api/projects/quotes#delete-quote) request.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Quote](ctp:api:type:Quote).
* * [Reference](ctp:api:type:Reference) to a [Quote](ctp:api:type:Quote).
* * Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action.
* * Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action.
No description provided by the author
* * Changes the owner of a Quote Request to a different Customer.
* * Transitions the Quote Request to a different state.
* * Generated after a successful [Create QuoteRequest](ctp:api:endpoint:/{projectKey}/quote-requests:POST) request.
* * Generated after a successful [Create QuoteRequest](ctp:api:endpoint:/{projectKey}/quote-requests:POST) request.
* * Generated after a successful [Change Customer](ctp:api:type:QuoteRequestChangeCustomerAction) update action.
* * Generated after a successful [Change Customer](ctp:api:type:QuoteRequestChangeCustomerAction) update action.
* * Generated after a successful [Delete QuoteRequest](/../api/projects/quote-requests#delete-quoterequest) request.
* * Generated after a successful [Delete QuoteRequest](/../api/projects/quote-requests#delete-quoterequest) request.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [QuoteRequest](ctp:api:type:QuoteRequest).
* * Represents the Buyer requesting renegotiation for a Quote.
* * [Reference](ctp:api:type:Reference) to a [QuoteRequest](ctp:api:type:QuoteRequest).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [QuoteRequest](ctp:api:type:QuoteRequest).
No description provided by the author
No description provided by the author
* * Generated after a successful [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
* * Generated after a successful [Change Quote Request State](ctp:api:type:QuoteRequestChangeQuoteRequestStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:QuoteRequestTransitionStateAction) update action.
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Quote](ctp:api:type:Quote).
No description provided by the author
No description provided by the author
* * Generated after a successful [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
* * Generated after a successful [Change Quote State](ctp:api:type:QuoteChangeQuoteStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:QuoteTransitionStateAction) update action.
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
No description provided by the author
No description provided by the author
* * Returned when a resource referenced by a [Reference](ctp:api:type:Reference) or a [ResourceIdentifier](ctp:api:type:ResourceIdentifier) could not be found.
* * Returned when a resource cannot be deleted because it is being referenced by another resource.
* * Used for [replicating an existing Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST) or Order.
No description provided by the author
* * Returned when a value is not defined for a required field.
* * This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is created.
* * This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is deleted.
* * Returned when the resource addressed by the request URL does not exist.
* * Returned when the resource exceeds the maximum allowed size of 16 MB.
* * This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is updated.
* * Stores information about returns connected to an Order.
* * Generated after a successful [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) update action.
* * Generated after a successful [Add ReturnInfo](ctp:api:type:OrderAddReturnInfoAction) update action.
No description provided by the author
* * Generated after a successful [Set ReturnInfo](ctp:api:type:OrderSetReturnInfoAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit).
* * Generated after a successful [Set ReturnInfo](ctp:api:type:OrderSetReturnInfoAction) update action on [Orders](ctp:api:type:Order) and [Order Edits](ctp:api:type:OrderEdit).
No description provided by the author
No description provided by the author
* * Generated after a successful [Create Review](ctp:api:endpoint:/{projectKey}/reviews:POST) request.
* * Generated after a successful [Create Review](ctp:api:endpoint:/{projectKey}/reviews:POST) request.
* * When creating a new Review, at least one of `title`, `text` or `rating` should be set.
No description provided by the author
* * Generated after a successful [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
* * Generated after a successful [Set Rating](ctp:api:type:ReviewSetRatingAction) update action.
No description provided by the author
* * [Reference](ctp:api:type:Reference) to a [Review](ctp:api:type:Review).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Review](ctp:api:type:Review).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * This update action produces the [ReviewRatingSet](ctp:api:type:ReviewRatingSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:ReviewTransitionStateAction) update action.
* * Transition to a new State.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Scoped Price is contained in a [ProductVariant](ctp:api:type:ProductVariant) which is returned in response to a * [Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request when [Scoped Price Search](/../api/pricing-and-discounts-overview#scoped-price-search) is used.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when the indexing of Product information is deactivated in a Project.
No description provided by the author
* * Returned when a search query could not be completed due to an unexpected failure.
No description provided by the author
No description provided by the author
* * Returned when a search facet path could not be found.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Controls indexing of resources to be provided on high performance read-only search endpoints.
No description provided by the author
* * Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned if the requested search service is not ready.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Sorting parameters provided with a Search request.
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct.
No description provided by the author
No description provided by the author
* * Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
No description provided by the author
* * Becomes the `shippingInfo` of the imported Order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart).
No description provided by the author
* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [ShippingMethod](ctp:api:type:ShippingMethod).
* * [Reference](ctp:api:type:Reference) to a [ShippingMethod](ctp:api:type:ShippingMethod).
No description provided by the author
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod).
* * This action sets, overwrites, or removes any existing [Custom Field](/projects/custom-fields) for an existing ShippingMethod.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * ShoppingListLineItems are Line Items that contain references to [ProductVariants](ctp:api:type:ProductVariant) in a [Product](ctp:api:type:Product).
* * The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
No description provided by the author
* * [Reference](ctp:api:type:Reference) to a [ShoppingList](ctp:api:type:ShoppingList).
No description provided by the author
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList).
No description provided by the author
* * If the Shopping List is already associated with a Customer, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [AWS SNS](https://aws.amazon.com/sns/) can be used to push messages to AWS Lambda, HTTP endpoints (webhooks), or fan-out messages to SQS queues.
* * [AWS SQS](https://aws.amazon.com/sqs/) is a pull-queue on AWS.
No description provided by the author
* * If the Cart already contains a [CustomLineItem](ctp:api:type: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](ctp:api:type:Delivery) can only be added to an [Order](ctp:api:type:Order) if * its `shippingInfo` (for `shippingMode` = `Single`), or its `shipping` (for `shippingMode` = `Multiple`) exists.
* * Adds a [DiscountCode](ctp:api:type:DiscountCode) to the Cart to activate the related [Cart Discounts](/../api/projects/cartDiscounts).
* * Adds an address to an Order when shipping to multiple addresses is desired.
* * If the Cart contains a [LineItem](ctp:api:type:LineItem) for a Product Variant with the same [LineItemMode](ctp:api:type:LineItemMode), [Custom Fields](/../api/projects/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](ctp:api:type:Delivery) must exist.
No description provided by the author
* * Produces the [Return Info Added](ctp:api:type:ReturnInfoAddedMessage) Message.
* * Adds all [LineItems](ctp:api:type:LineItem) of a [ShoppingList](ctp:api:type:ShoppingList) to the Cart.
No description provided by the author
* * When multiple shipping addresses are set for a Custom Line Item, use the [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction) update action to change the shipping details.
* * When multiple shipping addresses are set for a Line Item, use the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) and [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction) update action to change the shipping details.
* * Produces the [Order State Changed](ctp:api:type:OrderStateChangedMessage) Message.
* * Produces the [Order Payment State Changed](ctp:api:type:OrderPaymentStateChangedMessage) Message.
* * Produces the [Order Shipment State Changed](ctp:api:type:OrderShipmentStateChangedMessage) Message.
* * Changing the tax calculation mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
* * - When `External` [TaxMode](ctp:api:type:TaxMode) is changed to `Platform` or `Disabled`, all previously set external Tax Rates are removed.
* * Changing the tax rounding mode leads to [recalculation of taxes](/../api/carts-orders-overview#cart-tax-calculation).
* * 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.
* * This update action does not support specifying a quantity, unlike the [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update action.
* * Produces the [DeliveryRemoved](ctp:api:type:DeliveryRemovedMessage) Message.
No description provided by the author
* * An address can only be removed if it is not referenced in any [ItemShippingTarget](ctp:api:type:ItemShippingTarget) of the Cart.
* * The [LineItem](ctp:api:type:LineItem) price is updated as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
* * Produces the [ParcelRemovedFromDelivery](ctp:api:type:ParcelRemovedFromDeliveryMessage) Message.
No description provided by the author
* * This action updates the `billingAddress` on the Order, but it does not change the billing address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
No description provided by the author
No description provided by the author
* * Setting the country can lead to changes in the [LineItem](ctp:api:type:LineItem) prices.
* * This action updates the `customerEmail` on the Order, but it does not change the Customer email on the [Cart](ctp:api:type:Cart) the Order has been created from.
* * 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.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * To set the Cart's custom Shipping Method (independent of the [ShippingMethods](ctp:api:type:ShippingMethod) managed through the [Shipping Methods API](/../api/projects/shippingMethods)) the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
No description provided by the author
* * Produces the [DeliveryAddressSet](ctp:api:type:DeliveryAddressSetMessage) Message.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Produces the [Delivery Items Updated](ctp:api:type:DeliveryItemsUpdatedMessage) Message.
* * Adds a [DirectDiscount](ctp:api:type:DirectDiscount), but only if no [DiscountCode](ctp:api:type:DiscountCode) has been added to the Order.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Setting a distribution channel for a [LineItem](ctp:api:type:LineItem) can lead to an updated `price` as described in [Line Item price selection](/../api/pricing-and-discounts-overview#line-item-price-selection).
* * Sets the [LineItem](ctp:api:type:LineItem) `price` and changes the `priceMode` to `ExternalPrice` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
No description provided by the author
* * Can be used if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * Can be used if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * Sets the [LineItem](ctp:api:type:LineItem) `totalPrice` and `price`, and changes the `priceMode` to `ExternalTotal` [LineItemPriceMode](ctp:api:type:LineItemPriceMode).
No description provided by the author
No description provided by the author
* * Updates the total tax amount of the Order if it has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
No description provided by the author
No description provided by the author
* * Produces the [ParcelItemsUpdated](ctp:api:type:ParcelItemsUpdatedMessage) Message.
* * Produces the [ParcelMeasurementsUpdated](ctp:api:type:ParcelMeasurementsUpdatedMessage) Message.
* * Produces the [ParcelTrackingDataUpdated](ctp:api:type:ParcelTrackingDataUpdatedMessage) Message.
* * Produces the [PurchaseOrderNumberSet](ctp:api:type:OrderPurchaseOrderNumberSetMessage) Message.
* * Produces the [Return Info Set](ctp:api:type:ReturnInfoSetMessage) Message.
No description provided by the author
No description provided by the author
* * To set a [ReturnPaymentState](ctp:api:type:ReturnPaymentState), the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
* * To set a `ReturnShipmentState`, the [Order](ctp:api:type:Order) `returnInfo` must have at least one [ReturnItem](ctp:api:type:ReturnItem).
* * This action updates the `shippingAddress` on the Order, but it does not change the shipping address on the referenced [Cart](ctp:api:type:Cart) from which the Order is created.
* * 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.
No description provided by the author
No description provided by the author
No description provided by the author
* * This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's `shippingMethod` or `shipping`.
* * To set the Cart's Shipping Method, the Cart must have the `Single` [ShippingMode](ctp:api:type:ShippingMode) and a `shippingAddress`.
* * A Shipping Method tax amount can be set if the Cart has the `ExternalAmount` [TaxMode](ctp:api:type:TaxMode).
* * A Shipping Method Tax Rate can be set if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode).
* * Input used to select a [ShippingRatePriceTier](ctp:api:type:ShippingRatePriceTier).
* * Sets the [Store](ctp:api:type:Store) the Order is assigned to.
* * Produces the [Custom Line Item State Transition](ctp:api:type:CustomLineItemStateTransitionMessage) Message.
* * Produces the [Line Item State Transition](ctp:api:type:LineItemStateTransitionMessage) Message.
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
* * Updates an address in `itemShippingAddresses` by keeping the Address `key`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Create StagedQuote](ctp:api:endpoint:/{projectKey}/staged-quotes:POST) request.
* * Generated after a successful [Create StagedQuote](ctp:api:endpoint:/{projectKey}/staged-quotes:POST) request.
* * Generated after a successful [Delete StagedQuote](/../api/projects/staged-quotes#delete-stagedquote) request.
* * Generated after a successful [Delete StagedQuote](/../api/projects/staged-quotes#delete-stagedquote) request.
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [StagedQuote](ctp:api:type:StagedQuote).
* * [Reference](ctp:api:type:Reference) to a [StagedQuote](ctp:api:type:StagedQuote).
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [StagedQuote](ctp:api:type:StagedQuote).
* * Generated after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action.
* * Generated after a successful [Set Seller Comment](ctp:api:type:StagedQuoteSetSellerCommentAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generated after a successful [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
* * Generated after a successful [Change Staged Quote State](ctp:api:type:StagedQuoteChangeStagedQuoteStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
* * Generated after a successful [Transition State](ctp:api:type:StagedQuoteTransitionStateAction) update action.
* * If the existing [State](ctp:api:type:State) has set `transitions`, there must be a direct transition to the new State.
No description provided by the author
* * Generated after a successful [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action.
* * Generated after a successful [Set Valid To](ctp:api:type:StagedQuoteSetValidToAction) update action.
* * Staged changes on a Standalone Price.
No description provided by the author
* * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
* * Generated after a successful [Change Active](ctp:api:type:StandalonePriceChangeActiveAction) update action.
* * Adding a [PriceTier](ctp:api:type:PriceTier) to a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Added](ctp:api:type:StandalonePriceTierAddedMessage) Message.
* * Applies all staged changes to the StandalonePrice by overwriting all current values with the values in the [StagedStandalonePrice](ctp:api:type:StagedStandalonePrice).
* * Updating the value of a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [StandalonePriceActiveChanged](ctp:api:type:StandalonePriceActiveChangedMessage) Message.
* * Updating the value of a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [StandalonePriceValueChangedMessage](ctp:api:type:StandalonePriceValueChangedMessage).
* * Generated after a successful [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
* * Generated after a successful [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
* * Generated after a successful [Delete StandalonePrice](/../api/projects/standalone-prices#delete-standaloneprice) request.
* * Generated after a successful [Delete StandalonePrice](/../api/projects/standalone-prices#delete-standaloneprice) request.
* * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice.
* * Generated after a [Product Discount](ctp:api:type:ProductDiscount) is successfully applied to a StandalonePrice.
No description provided by the author
* * Generated after a successful [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action.
* * Generated after a successful [Set Discounted Price](ctp:api:type:StandalonePriceSetDiscountedPriceAction) update action.
* * Generated after a successful [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
* * Generated after a successful [Set Key](ctp:api:type:StandalonePriceSetKeyAction) update action.
* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [StandalonePrice](ctp:api:type:StandalonePrice).
* * [Reference](ctp:api:type:Reference) to a [StandalonePrice](ctp:api:type:StandalonePrice).
* * Removing a [PriceTier](ctp:api:type:PriceTier) from a [StandalonePrice](ctp:api:type:StandalonePrice) produces the [Standalone Price Tier Removed](ctp:api:type:StandalonePriceTierRemovedMessage) Message.
* * Removes all staged changes from the StandalonePrice.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [StandalonePrice](ctp:api:type:StandalonePrice).
No description provided by the author
No description provided by the author
* * Discounts a Standalone Price of a Product Variant on a published [Product](ctp:api:type:Product).
* * Sets the key on a Standalone Price.
* * Sets all [PriceTiers](ctp:api:type:PriceTier) for a [StandalonePrice](ctp:api:type:StandalonePrice) in one action, produces the [Standalone Price Tiers Set](ctp:api:type:StandalonePriceTiersSetMessage) Message.
* * Updating the `validFrom` value generates the [StandalonePriceValidFromSet](ctp:api:type:StandalonePriceValidFromSetMessage) Message.
* * Updating the `validFrom` and `validUntil` values generates the [StandalonePriceValidFromAndUntilSet](ctp:api:type:StandalonePriceValidFromAndUntilSetMessage) Message.
* * Updating the `validUntil` value generates the [StandalonePriceValidUntilSet](ctp:api:type:StandalonePriceValidUntilSetMessage) Message.
* * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action.
* * Generated after a successful [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action.
* * Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action.
* * Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action.
* * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action * */.
* * Generated after a successful [Add Price Tier](ctp:api:type:StandalonePriceAddPriceTierAction) update action * */.
* * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action * */.
* * Generated after a successful [Remove Price Tier](ctp:api:type:StandalonePriceRemovePriceTierAction) update action * */.
* * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action * */.
* * Generated after a successful [Set Price Tier](ctp:api:type:StandalonePriceSetPriceTiersAction) update action * */.
No description provided by the author
* * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
* * Generated after a successful [Set Valid From and Until](ctp:api:type:StandalonePriceSetValidFromAndUntilAction) update action.
* * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
* * Generated after a successful [Set Valid From](ctp:api:type:StandalonePriceSetValidFromAction) update action.
* * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
* * Generated after a successful [Set Valid Until](ctp:api:type:StandalonePriceSetValidUntilAction) update action.
* * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action.
* * Generated after a successful [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [State](ctp:api:type:State).
* * [Reference](ctp:api:type:Reference) to a [State](ctp:api:type:State).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message.
* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message.
* * To make all included Products available to your customers of a given Store, add the [Product Selections](/../api/projects/product-selections) to the respective Store.
* * This action has no effect if a given supply channel is already present in a Store.
* * Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request.
* * [ProductSelection](ctp:api:type:ProductSelection) in a Store can be activated or deactivated using this update action.
* * Generated after a successful [Add Country](ctp:api:type:StoreAddCountryAction), * [Remove Country](ctp:api:type:StoreRemoveCountryAction), or * [Set Countries](ctp:api:type:StoreSetCountriesAction) update action.
* * Generated after a successful [Add Country](ctp:api:type:StoreAddCountryAction), * [Remove Country](ctp:api:type:StoreRemoveCountryAction), or * [Set Countries](ctp:api:type:StoreSetCountriesAction) update action.
No description provided by the author
* * Generated after a successful [Create Store](ctp:api:endpoint:/{projectKey}/stores:POST) request.
* * Generated after a successful [Create Store](ctp:api:endpoint:/{projectKey}/stores:POST) request.
* * Generated after a successful [Delete Store](/../api/projects/stores#delete-store) request.
* * Generated after a successful [Delete Store](/../api/projects/stores#delete-store) request.
* * Generated after a successful [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), * [Remove Distribution Channel](ctp:api:type:StoreRemoveDistributionChannelAction), or * [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action.
* * Generated after a successful [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), * [Remove Distribution Channel](ctp:api:type:StoreRemoveDistributionChannelAction), or * [Set Distribution Channels](ctp:api:type:StoreSetDistributionChannelsAction) update action.
No description provided by the author
* * [KeyReference](ctp:api:type:KeyReference) to a [Store](ctp:api:type:Store).
* * Generated after a successful [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
* * Generated after a successful [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
* * Generated after a successful [Set Name](ctp:api:type:StoreSetNameAction) update action.
* * Generated after a successful [Set Name](ctp:api:type:StoreSetNameAction) update action.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with results containing an array of [Store](ctp:api:type:Store).
* * Generated by a successful [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction), * [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction), * [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction), * or [Change Product Selections Active](ctp:api:type:StoreChangeProductSelectionAction) update action.
* * Generated by a successful [Add Product Selection](ctp:api:type:StoreAddProductSelectionAction), * [Remove Product Selection](ctp:api:type:StoreRemoveProductSelectionAction), * [Set Product Selections](ctp:api:type:StoreSetProductSelectionsAction), * or [Change Product Selections Active](ctp:api:type:StoreChangeProductSelectionAction) update action.
* * [Reference](ctp:api:type:Reference) to a [Store](ctp:api:type:Store).
* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message.
* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message.
* * This action has no effect if the given Product Selection is not in the Store.
* * This update action produces the [StoreSupplyChannelsChanged](ctp:api:type:StoreSupplyChannelsChangedMessage) Message.
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Store](ctp:api:type:Store).
* * This update action produces the [StoreCountriesChanged](ctp:api:type:StoreCountriesChangedMessage) Message.
No description provided by the author
No description provided by the author
* * This update action produces the [StoreDistributionChannelsChanged](ctp:api:type:StoreDistributionChannelsChangedMessage) Message.
* * This update action produces the [StoreLanguagesChanged](ctp:api:type:StoreLanguagesChangedMessage) Message.
* * This update action produces the [StoreNameSet](ctp:api:type:StoreNameSetMessage) Message.
* * Instead of adding or removing [Product Selections](/../api/projects/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](ctp:api:type:StoreSupplyChannelsChangedMessage) Message.
* * Generated after a successful [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), * [Remove Supply Channel](ctp:api:type:StoreRemoveSupplyChannelAction), or * [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action.
* * Generated after a successful [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), * [Remove Supply Channel](ctp:api:type:StoreRemoveSupplyChannelAction), or * [Set Supply Channels](ctp:api:type:StoreSetSupplyChannelsAction) update action.
No description provided by the author
* * It is used to calculate the [taxPortions](/../api/projects/carts#taxedprice) field in a Cart or Order.
No description provided by the author
* * A test notification is sent to ensure the correct configuration of the Destination.
* * Either `messages` or `changes` must be set.
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Subscription](ctp:api:type:Subscription).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Contains synchronization activity information of the Order (like export or import).
* * Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [TaxCategory](ctp:api:type:TaxCategory).
* * [Reference](ctp:api:type:Reference) to a [TaxCategory](ctp:api:type:TaxCategory).
No description provided by the author
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * The tax portions are calculated from the [TaxRates](ctp:api:type:TaxRate).
* * Represents the portions that sum up to the `totalGross` field of a [TaxedPrice](ctp:api:type:TaxedPrice).
No description provided by the author
No description provided by the author
No description provided by the author
* * TextLineItems are Line Items that use text values instead of references to Products.
No description provided by the author
* * Information that helps track a Parcel.
* * Represents a financial transaction typically created as a result of a notification from the payment service.
No description provided by the author
No description provided by the author
* * Adds a value to an [EnumType](ctp:api:type:CustomFieldEnumType).
* * Defines a new field for a Type.
* * Adds a value to a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType).
* * Changes the `label` of an [EnumValue](ctp:api:type:CustomFieldEnumValue) of an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition.
* * Changes the order of [EnumValues](ctp:api:type:CustomFieldEnumValue) in an [EnumType](ctp:api:type:CustomFieldEnumType) FieldDefinition.
No description provided by the author
No description provided by the author
* * Changes the `inputHint` of [CustomFieldStringType](ctp:api:type:CustomFieldStringType) [FieldDefinition](ctp:api:type:FieldDefinition), a [CustomFieldLocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType) [FieldDefinition](ctp:api:type:FieldDefinition), and [CustomFieldSetType](ctp:api:type:CustomFieldSetType) [FieldDefinition](ctp:api:type:FieldDefinition) of these string-based FieldTypes.
No description provided by the author
No description provided by the author
* * Changes the `label` of a [LocalizedEnumValue](ctp:api:type:CustomFieldLocalizedEnumValue) of a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition.
* * Changes the order of [LocalizedEnumValues](ctp:api:type:CustomFieldLocalizedEnumValue) in a [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) FieldDefinition.
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/../api/general-concepts#pagedqueryresult) with `results` containing an array of [Types](ctp:api:type:Type).
* * [Reference](ctp:api:type:Reference) to a [Type](ctp:api:type:Type).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Type](ctp:api:type:Type).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * User-provided identifiers present on the resource for which the Message is created.
No description provided by the author
* * Creates tokens by splitting the `text` field in [SearchKeyword](ctp:api:type:SearchKeyword) by whitespaces.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * [PagedQueryResult](/general-concepts#pagedqueryresult) with `results` containing an array of [Zone](ctp:api:type:Zone).
* * Defines shipping rates in different currencies for a specific [Zone](ctp:api:type:Zone).
No description provided by the author
* * [Reference](ctp:api:type:Reference) to a [Zone](ctp:api:type:Zone).
No description provided by the author
* * [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Zone](ctp:api:type:Zone).
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Umbrella type for specific attribute types discriminated by property `name`.
* * Generic type to model the fields that all types of Business Units have in common.
* * Generic draft type to model those fields all Business Units have in common.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
No description provided by the author
No description provided by the author
* * Represents a single error.
* * Generic type for destinations.
No description provided by the author
No description provided by the author
No description provided by the author
* * GeoJSON Geometry represents a [Geometry Object](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) as defined in the GeoJSON standard.
* * Represents a single error.
No description provided by the author
No description provided by the author
* * A KeyReference represents a loose reference to another resource in the same Project identified by the resource's `key` field.
* * Base representation of a Message containing common fields to all [Message Types](/../api/projects/messages#message-types).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Polymorphic base type for Product Variant Selections.
No description provided by the author
No description provided by the author
No description provided by the author
* * A Reference represents a loose reference to another resource in the same Project identified by its `id`.
* * Draft type to create a [Reference](ctp:api:type:Reference) or a [KeyReference](ctp:api:type:KeyReference) to a resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Generic type holding specifc ShippingRateInputDraft types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Base polymorphic read-only money type that stores currency in cent precision or high precision, that is in sub-cents.
* * Base polymorphic money type containing common fields for [Money](ctp:api:type:Money) and [HighPrecisionMoneyDraft](ctp:api:type:HighPrecisionMoneyDraft).
No description provided by the author
* * Represents a warning related to the returned response.
No description provided by the author

# Type aliases

No description provided by the author
* * Indicates whether the [Approval Flow](ctp:api:type:ApprovalFlow) is under review, approved, or rejected.
* * Indicates whether the Approval Rule should be matched against [Orders](ctp:api:type:Order) or not.
* * Roles defining how an [Associate](ctp:api:type:Associate) can interact with a Business Unit.
* * Determines whether an [AssociateRoleAssignment](ctp:api:type:AssociateRoleAssignment) can be inherited by child Business Units.
* * Specifies how an Attribute (or a set of Attributes) should be validated across all variants of a Product: * */.
No description provided by the author
* * Name of the resource type that the value should reference.
No description provided by the author
No description provided by the author
* * Defines the method of authentication for AWS SQS and SNS Destinations.
* * Determines whether a Business Unit can inherit [Approval Rules](/projects/approval-rules) from a parent.
* * Determines whether a Business Unit can inherit Associates from a parent.
* * Default value for [Business Unit Status](ctp:api:type:BusinessUnitStatus) configured though [Project settings](/../api/projects/project#change-my-business-unit-status-on-creation).
* * Indicates whether the Business Unit can be edited and used in [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), or [Quotes](ctp:api:type:Quote).
* * Defines whether the Stores of the Business Unit are set directly on the Business Unit or are inherited from its parent unit.
* * The type of the Business Unit indicating its position in a hierarchy.
* * Indicates who created the Cart.
* * Indicates the current status of a Cart.
* * JSON object where the key is a [Category](ctp:api:type:Category) `id` and the value is an order hint.
* * Resource types supported by [ChangeSubscriptions](ctp:api:type:ChangeSubscription): * */.
* * Describes the purpose and type of the Channel.
* * The current indexing status of Customer Search.
* * Specifies the status of the [Customer Search](/../api/projects/customer-search) index.
* * Defines which resource type a [CustomFieldReferenceType](ctp:api:type:CustomFieldReferenceType) can reference.
* * Determines if Cart Discounts can be applied to a Custom Line Item in the Cart.
* * This mode determines how absolute Discounts are applied on Line Items or Custom Line Items.
* * Indicates the state of a Discount Code in a Cart.
* * An Extension gets called during any of the following requests of an API call, but before the result is persisted.
* * Extensions are available for: * */.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Indicates how Line Items in a Cart are tracked.
* * Indicates how a Line Item was added to a Cart.
* * This mode indicates how the price is set for the Line Item.
* * JSON object where the keys are of type [Locale](ctp:api:type:Locale), and the values are the strings used for the corresponding language.
* * Resource types supported by [MessageSubscriptions](ctp:api:type:MessageSubscription): * */.
* * Determines the type of money used.
* * [QuoteStates](ctp:api:type:QuoteState) that can be set using the [Change My Quote State](ctp:api:type:MyQuoteChangeMyQuoteStateAction) update action.
No description provided by the author
* * Possible values for the `customType` property on [query expressions](/../api/projects/order-search#query-expressions) indicating the data type of the `field`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Specifies the status of the [Order Search](/../api/projects/order-search) index.
* * Indicates the state of the Order.
* * Indicates the payment status for the Order.
* * Permissions grant granular access to [Approval Rules](ctp:api:type:ApprovalRule), [Approval Flows](ctp:api:type:ApprovalFlow), [Business Units](ctp:api:type:BusinessUnit), [Carts](ctp:api:type:Cart), [Orders](ctp:api:type:Order), [Quotes](ctp:api:type:Quote), and [Quote Requests](ctp:api:type:QuoteRequest).
* * This mode determines the type of Prices used for [price selection](/../api/pricing-and-discounts-overview#price-selection) by Line Items and Products.
* * The scope controls which part of the product information is published.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
* * Product Selections can have the following modes: * */.
* * The following types of Product Selections are supported: * */.
* * JSON object where the key is a supply [Channel](ctp:api:type:Channel) `id` and the value is the [ProductVariantChannelAvailability](ctp:api:type:ProductVariantChannelAvailability) of the [InventoryEntry](ctp:api:type:InventoryEntry).
No description provided by the author
* * Predefined states tracking the status of the Quote Request in the negotiation process.
* * Predefined states tracking the status of the Quote.
* * Type of resource the value should reference.
* * IDs indicating the [customizable resources and data types](/../api/projects/types#list-of-customizable-data-types).
No description provided by the author
No description provided by the author
* * Determines how monetary values are rounded.
No description provided by the author
* * Possible values for the `fieldType` property on [query expressions](/../api/search-query-language#query-expressions) indicating the data type of the `field`.
* * Status of resource indexing.
* * Search keywords are JSON objects primarily used by [Product Suggestions](/projects/products-suggestions), but are also considered for a [full text search](/projects/products-search#full-text-search).
No description provided by the author
No description provided by the author
No description provided by the author
* * For set-type fields, only a single value of the set is taken into account for sorting.
No description provided by the author
* * Defines which matching items are to be discounted.
* * Indicates the shipment status of the Order.
* * Determines whether the selected [ShippingMethod](ctp:api:type:ShippingMethod) is allowed for the Cart.
No description provided by the author
No description provided by the author
* * Describes how the Cart Discount interacts with other Discounts.
* * Predefined states tracking the status of the Staged Quote.
* * For some resource types, a State can fulfill the following predefined roles: * */.
* * Resource or object type the State can be assigned to.
* * The health status of the Subscription that indicates whether notifications are being delivered.
No description provided by the author
* * Determines in which [Tax calculation mode](/carts-orders-overview#tax-calculation-mode) taxed prices are calculated.
* * Indicates how taxes are set on the Cart.
No description provided by the author
* * A text input hint is a string with one of the following values: * */.
* * Transactions can be in one of the following States: * */.
No description provided by the author
* * Provides a visual representation type for this field.