Package com.commercetools.api.client
package com.commercetools.api.client
-
ClassDescription
CorrelationIdProvider
which adds the project key as prefixCreates anInternalLogger
with the API path of the requestEntrypoint for building requests against the APIChecks if an API Client exists with the providedid
.Checks if an API Client exists for the provided query predicate.Checks if a BusinessUnit exists with the providedid
.Checks if one or more BusinessUnits exist for the provided query predicate.Checks if a BusinessUnit exists with the providedkey
.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Cart exists with the providedid
.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if one or more Carts exist for the provided query predicate.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Cart exists with the providedkey
.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Creates a Cart in the BusinessUnit referenced bybusinessUnitKey
.Creates a Cart in the BusinessUnit referenced bybusinessUnitKey
.Creates a new Cart by replicating an existing Cart or Order.Creates a new Cart by replicating an existing Cart or Order.Retrieves an Order with the providedid
in a BusinessUnit.Checks if an Order exists with the providedid
in a BusinessUnit.Updates an Order in a BusinessUnit using one or more update actions.Updates an Order in a BusinessUnit using one or more update actions.Retrieves Orders in a BusinessUnit.Checks if one or more Orders exist with provided query predicate in a BusinessUnit.Retrieves an Order with the providedorderNumber
in a BusinessUnit.Checks if an Order exists with the providedorderNumber
in a BusinessUnit.Updates an Order in a BusinessUnit using one or more update actions.Updates an Order in a BusinessUnit using one or more update actions.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a QuoteRequest exists with the providedid
.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if one or more QuoteRequests exist for the provided query predicate.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a QuoteRequest exists with the providedkey
.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Creates a QuoteRequest in a BusinessUnit.Creates a QuoteRequest in a BusinessUnit.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Quote exists with the providedid
.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if one or more Quotes exist for the provided query predicate.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Quote exists with the providedkey
.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Deletes a ShoppingList in a BusinessUnit.Retrieves a ShoppingList with the providedkey
in a BusinessUnit.Checks if a ShoppingList exists with the providedid
in a BusinessUnit.Updates a ShoppingList in a BusinessUnit using one or more update actions.Updates a ShoppingList in a BusinessUnit using one or more update actions.Retrieves ShoppingLists in a BusinessUnit.Checks if one or more ShoppingLists exist for the provided query predicate in a BusinessUnit.Deletes a ShoppingList in a BusinessUnit.Retrieves a ShoppingList with the providedkey
in a BusinessUnit.Checks if a ShoppingList exists with the providedkey
in a BusinessUnit.Updates a ShoppingList in a BusinessUnit using one or more update actions.Updates a ShoppingList in a BusinessUnit using one or more update actions.Creates a ShoppingList in the BusinessUnit referenced bybusinessUnitKey
.Creates a ShoppingList in the BusinessUnit referenced bybusinessUnitKey
.Checks if an AssociateRole exists with the providedid
.Checks if one or more AssociateRoles exist for the provided query predicate.Deleting an AssociateRole generates the AssociateRoleDeleted Message.Checks if an AssociateRole exists with the providedkey
.Creating a Associate Role generates the AssociateRoleCreated Message.Creating a Associate Role generates the AssociateRoleCreated Message.Checks if an AttributeGroup exists with the providedid
.Checks if one or more AttributeGroups exist for the provided query predicate.Checks if an AttributeGroup exists with the providedkey
.Retrieves roles and permissions of an Associate in a Business Unit.Checks if a BusinessUnit exists with the providedid
.Checks if one or more BusinessUnits exist for the provided query predicate.Retrieves roles and permissions of an Associate in a Business Unit.Checks if a BusinessUnit exists with the providedkey
.Checks whether a search index of Business Units exists for a Project.Returns the indexing status of the Business Unit Search for a Project.If the initial indexing is in progress or the feature is inactive, A SearchNotReady error is returned.If the initial indexing is in progress or the feature is inactive, A SearchNotReady error is returned.Deleting a Cart Discount produces the CartDiscountDeleted Message.Checks if a CartDiscount exists with the providedid
.Checks if one or more CartDiscounts exist for the provided query predicate.Deleting a Cart Discount produces the CartDiscountDeleted Message.Checks if a CartDiscount exists with the providedkey
.Creating a Cart Discount produces the CartDiscountCreated Message.Creating a Cart Discount produces the CartDiscountCreated Message.Deletes a Cart in the Project.Retrieves a Cart with the providedid
.Checks if a Cart exists for the providedid
.Updates a Cart in the Project using one or more update actions.Updates a Cart in the Project using one or more update actions.Retrieves the most recently modified active Cart of a Customer with CartOriginCustomer
.Checks if a Cart exists for a Customer.Retrieves Carts in the Project.Checks if one or more Carts exist for the provided query predicate.Deletes a Cart in the Project.Retrieves a Cart with the providedkey
.Checks if a Cart exists with the providedkey
.Updates a Cart in the Project using one or more update actions.Updates a Cart in the Project using one or more update actions.Creates a Cart in the Project.Creates a Cart in the Project.Creates a new Cart by replicating an existing Cart or Order.Creates a new Cart by replicating an existing Cart or Order.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopeview_products:{projectKey}
orview_categories:{projectKey}
is required.Checks if a Category exists with the providedid
.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopeview_products:{projectKey}
orview_categories:{projectKey}
is required.Checks if one or more Categories exist for the provided query predicate.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopeview_products:{projectKey}
orview_categories:{projectKey}
is required.Checks if a Category exists with the providedkey
.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Returns a ReferenceExists error if other resources reference the Channel to be deleted.Checks if a Channel exists with the providedid
.Checks if one or more Channels exist for the provided query predicate.Returns a ReferenceExists error if other resources reference the Channel to be deleted.Checks if a Channel exists with the providedkey
.Checks if a CustomerGroup exists with the providedid
.Checks if one or more CustomerGroups exist for the provided query predicate.Checks if a CustomerGroup exists with the providedkey
.Deleting a Customer produces the CustomerDeleted Message.Checks if a Customer exists with the providedid
.Simultaneously updating two Customers with the same email address can return a LockedField error.Simultaneously updating two Customers with the same email address can return a LockedField error.Use this method to verify a global Customer's email during their email verification process.Use this method to verify a global Customer's email during their email verification process.Use this method to retrieve a global Customer's details by using the email token during their email verification process.Use this method to create an email token for a global Customer during their email verification process.Use this method to create an email token for a global Customer during their email verification process.Checks if one or more Customers exist for the provided query predicate.Deleting a Customer produces the CustomerDeleted Message.Checks if a Customer exists with the providedkey
.Simultaneously updating two Customers with the same email address can return a LockedField error.Simultaneously updating two Customers with the same email address can return a LockedField error.Changing the password produces the CustomerPasswordUpdated Message withreset=false
.Changing the password produces the CustomerPasswordUpdated Message withreset=false
.Use this method to reset a global Customer's password during their password reset process.Use this method to reset a global Customer's password during their password reset process.Use this method to retrieve the details of a global Customer by using the password token during their password reset process.Use this method to create a password reset token for a global Customer during their password reset process.Use this method to create a password reset token for a global Customer during their password reset process.If theanonymousCart
field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.If theanonymousCart
field is set on the CustomerDraft, then the newly created Customer will be assigned to that Cart.Checks whether a search index of Customers exists for a Project.Returns the indexing status of the Customer Search for a Project.If the initial indexing is in progress or the feature is inactive, a SearchNotReady error is returned.If the initial indexing is in progress or the feature is inactive, a SearchNotReady error is returned.Deprecated.Checks if one or more CustomObjects exist for the provided query predicate.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.Deleting a Discount Code produces the DiscountCodeDeleted Message.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a DiscountCode exists with the providedid
.Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if one or more DiscountCodes exist for the provided query predicate.Deleting a Discount Code produces the DiscountCodeDeleted Message.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a DiscountCode exists with the providedkey
.Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Deprecated OAuth 2.0 Scope:manage_orders:{projectKey}
Creating a Discount Code produces the DiscountCodeCreated Message.Creating a Discount Code produces the DiscountCodeCreated Message.Checks if an Extension exists with the providedid
.Checks if one or more Extensions exist for the provided query predicate.Checks if an Extension exists with the providedkey
.Execute a GraphQL request.Execute a GraphQL request.Checks if a Project exists for a givenprojectKey
.The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.Retrieves roles and permissions of an Associate in a Business Unit in a Store.Checks if a BusinessUnit exists with the providedid
.Checks if one or more BusinessUnits exist for the provided query predicate.Retrieves roles and permissions of an Associate in a Business Unit in a Store.Checks if a BusinessUnit exists with the providedkey
.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists with the providedid
.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.Checks if one or more CartDiscounts exist for the provided query predicate.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists with the providedkey
.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.When using the endpoint, the Store specified in the path and the Stores specified in the payload'sstores
field are added to the CartDiscount.When using the endpoint, the Store specified in the path and the Stores specified in the payload'sstores
field are added to the CartDiscount.Deletes a Cart in a Store.Retrieves a Cart with the providedid
in a Store.Checks if a Cart exists with the providedid
in a Store.Updates a Cart in a Store using one or more update actions.Updates a Cart in a Store using one or more update actions.Retrieves the most recently modified active Cart of a Customer with CartOriginCustomer
.Checks if one or more Carts exist for a Customer in a Store.Retrieves Carts in a Store.Checks if one or more Carts exist for the provided query predicate in a Store.Deletes a Cart in a Store.Retrieves a Cart with the providedkey
in a Store.Checks if a Cart exists with the providedkey
in a Store.Updates a Cart in a Store using one or more update actions.Updates a Cart in a Store using one or more update actions.Creates a Cart in a Store.Creates a Cart in a Store.Creates a new Cart by replicating an existing Cart or Order.Creates a new Cart by replicating an existing Cart or Order.Deleting a Customer produces the CustomerDeleted Message.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists with the providedid
.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.Use this method to verify a Store-specific Customer's email during their email verification process.Use this method to verify a Store-specific Customer's email during their email verification process.Use this method to retrieve a Store-specific Customer's details by using the email token during their email verification process.Use this method to create an email token for a Store-specific Customer during their email verification process.Use this method to create an email token for a Store-specific Customer during their email verification process.Checks if one or more Customers exist for the provided query predicate.Deleting a Customer produces the CustomerDeleted Message.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists with the providedkey
.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.Use this method to reset a Store-specific Customer's password during their password reset process.Use this method to reset a Store-specific Customer's password during their password reset process.Use this method to retrieve a Store-specific Customer's details by using the password reset token during their password reset process.Use this method to create a password reset token for a Store-specific Customer during their password reset process.Use this method to create a password reset token for a Store-specific Customer during their password reset process.When using this endpoint, if omitted, the Customerstores
field is set to the Store specified in the path parameter.When using this endpoint, if omitted, the Customerstores
field is set to the Store specified in the path parameter.Authenticates a Customer associated with a Store.Authenticates a Customer associated with a Store.Retrieves the Customer's most recently modified active Cart in a Store.Checks if an active Cart exists in a Store.Deletes the Cart for a givenid
in a Store.Returns a Cart for a givenid
in a Store.Updates the Cart for a givenid
in a Store.Updates the Cart for a givenid
in a Store.Retrieves Carts for the authenticated Customer or anonymous user in a Store.Checks if a Cart exists for a Store that matches the given Query Predicate, and contains a matchingcustomerId
oranonymousId
.Creates a Cart in a Store for the Customer or anonymous user.Creates a Cart in a Store for the Customer or anonymous user.Deletes the Customer in a Store.This is the last step in the email verification process of a Customer.This is the last step in the email verification process of a Customer.Returns a Customer for a given Query Predicate in a Store.Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.Retrieves an Order with the providedid
in a Store for the authenticated Customer or anonymous user.Checks if an Order exists with the providedid
in a Store for the authenticated Customer or anonymous user.Retrieves Orders in a Store for the authenticated Customer or anonymous user.Checks if one or more Orders exist for the provided query predicate in a Store for the authenticated Customer or anonymous user.Creates an Order from a Cart in a Store for the Customer or anonymous user.Creates an Order from a Cart in a Store for the Customer or anonymous user.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.This is the last step in the password reset process of the authenticated Customer.This is the last step in the password reset process of the authenticated Customer.Updates the Customer in a Store.Updates the Customer in a Store.Deletes a ShoppingList in a Store.Retrieves a ShoppingList with the providedid
for the authenticated Customer or anonymous user in a Store.Checks if a ShoppingList exists with the providedid
for the authenticated Customer or anonymous user in a Store.Updates a ShoppingList for the authenticated Customer or anonymous user in a Store using one or more update actions.Updates a ShoppingList for the authenticated Customer or anonymous user in a Store using one or more update actions.Retrieves ShoppingLists for the authenticated Customer or anonymous user in a Store.Checks if one or more ShoppingLists exist for the provided query predicate for the authenticated Customer or anonymous user in a Store.Deletes a ShoppingList in a Store.Retrieves a ShoppingList with the providedkey
for the authenticated Customer or anonymous user in a Store.Checks if a ShoppingList exists with the providedkey
for the authenticated Customer or anonymous user in a Store.Updates a ShoppingList for the authenticated Customer or anonymous user in a Store using one or more update actions.Updates a ShoppingList for the authenticated Customer or anonymous user in a Store using one or more update actions.Creates a ShoppingList for the authenticated Customer or anonymous user in a Store.Creates a ShoppingList for the authenticated Customer or anonymous user in a Store.If used with an optional access token for an anonymous session, all Orders and Carts that belong to theanonymousId
are assigned to the newly created Customer.If used with an optional access token for an anonymous session, all Orders and Carts that belong to theanonymousId
are assigned to the newly created Customer.Deletes an Order in a Store.Retrieves an Order with the providedid
in a Store.Checks if an Order exists with the providedid
in a Store.Updates an Order in a Store using one or more update actions.Updates an Order in a Store using one or more update actions.Retrieves Orders in a Store.Checks if one or more Orders exist for the provided query predicate in a Store.Deletes an Order in a Store.Retrieves an Order with the providedorderNumber
in a Store.Checks if an Order exists with the providedorderNumber
in a Store.Updates an Order in a Store using one or more update actions.Updates an Order in a Store using one or more update actions.Creates an Order from a Cart in a Store.Creates an Order from a Cart in a Store.Creates an Order from a Quote in a Store.Creates an Order from a Quote in a Store.Gets the current or staged representation of a Product by its ID in the specified Store.Checks if the current or staged representations of a Product exists with the providedid
in the specified Store.Gets the current or staged representation of a Product by its key in the specified Store.Checks if the current or staged representations of a Product exists with the providedkey
in the specified Store.Generates the ProductTailoringDeleted Message.Gets the current or staged representation of a Product Tailoring by its Product ID in the specified Store.Uploads a JPEG, PNG and GIF file to a ProductVariantTailoring.Uploads a JPEG, PNG and GIF file to a ProductVariantTailoring.Updates the current or staged representation of a Product Tailoring by its Product ID in the specified Store.Updates the current or staged representation of a Product Tailoring by its Product ID in the specified Store.Queries Product Selection assignments in a specific Store.Generates the ProductTailoringDeleted Message.Gets the current or staged representation of a Product Tailoring by its Product key in the specified Store.Uploads a JPEG, PNG and GIF file to a ProductVariantTailoring.Uploads a JPEG, PNG and GIF file to a ProductVariantTailoring.Updates the current or staged representation of a Product Tailoring by its Product key in the specified Store.Updates the current or staged representation of a Product Tailoring by its Product key in the specified Store.Queries Product Tailoring in a specific Store.Creates a ProductTailoring in the Store specified bystoreKey
.Creates a ProductTailoring in the Store specified bystoreKey
.Checks if a QuoteRequest exists with the providedid
.Checks if one or more QuoteRequests exist for the provided query predicate.Checks if a QuoteRequest exists with the providedkey
.Checks if a Quote exists with the providedid
.Checks if one or more Quotes exist for the provided query predicate.Checks if a Quote exists with the providedkey
.Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart in a given Store.Checks if an active ShippingMethod that can ship to the shipping address of the given Cart exists in the given Store.Deletes a ShoppingList in a Store.Retrieves a ShoppingList with the providedid
in a Store.Checks if a ShoppingList exists with the providedid
in a Store.Updates a ShoppingList in a Store using one or more update actions.Updates a ShoppingList in a Store using one or more update actions.Retrieves ShoppingLists in a Store.Checks if one or more ShoppingLists exist for the provided query predicate in a Store.Deletes a ShoppingList in a Store.Retrieves a ShoppingList with the providedkey
in a Store.Checks if a ShoppingList exists with the providedkey
in a Store.Updates a ShoppingList in a Store using one or more update actions.Updates a ShoppingList in a Store using one or more update actions.Creates a ShoppingList in a Store.Creates a ShoppingList in a Store.Checks if a StagedQuote exists with the providedid
.Checks if one or more StagedQuotes exist for the provided query predicate.Checks if a StagedQuote exists with the providedkey
.Produces the InventoryEntryDeleted Message.Checks if an InventoryEntry exists with the providedid
.Checks if one or more InventoryEntries exist for the provided query predicate.Produces the InventoryEntryDeleted Message.Checks if an InventoryEntry exists with the providedkey
.Produces the InventoryEntryCreated Message.Produces the InventoryEntryCreated Message.Authenticates a global Customer not associated with a Store.Authenticates a global Customer not associated with a Store.Retrieves the Customer's most recently modified active Cart.Checks if an active Cart exists.Returns a Business Unit for a givenid
.Checks if a BusinessUnit exists with the providedid
.Updates a Business Unit for a givenid
.Updates a Business Unit for a givenid
.Retrieves Business Units for the authenticated Customer.Checks if one or more BusinessUnits exist for the provided query predicate.Returns a Business Unit for a givenkey
.Checks if a BusinessUnit exists with the providedkey
.Updates a Business Unit for a givenkey
.Updates a Business Unit for a givenkey
.Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.Automatically assigns the Associate to the Business Unit in the default Associate Role defined in BusinessUnitConfiguration.Deletes the Cart for a givenid
.Returns a Cart for a givenid
.Checks if a Cart exists with the providedid
.Updates the Cart for a givenid
.Updates the Cart for a givenid
.Retrieves Carts for the authenticated Customer or anonymous user.Checks if a Cart exists that matches a given Query Predicate and contains either a matchingcustomerId
oranonymousId
.Creates a Cart for the Customer or anonymous user.Creates a Cart for the Customer or anonymous user.Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.Deletes the Customer specified in the customer:{id} scope.This is the last step in the email verification process of a Customer.This is the last step in the email verification process of a Customer.Returns a Customer for a given Query Predicate.Retrieves the authenticated customer (that matches the given email/password pair).Retrieves the authenticated customer (that matches the given email/password pair).Retrieves an Order with the providedid
for the authenticated Customer or anonymous user.Checks if an Order exists with the providedid
for the authenticated Customer or anonymous user.Retrieves Orders for the authenticated Customer or anonymous user.Checks if one or more Orders exist for the provided query predicate for the authenticated Customer or anonymous user.Creates an Order from a Cart for the Customer or anonymous user.Creates an Order from a Cart for the Customer or anonymous user.Creates an Order from a Quote for the authenticated Customer.Creates an Order from a Quote for the authenticated Customer.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.Changing the password of the Customer produces the CustomerPasswordUpdated Message withreset=false
.This is the last step in the password reset process of a Customer.This is the last step in the password reset process of a Customer.Deletes a Payment with the providedid
for the authenticated Customer or anonymous user.Retrieves a Payment with the providedid
for the authenticated Customer or anonymous user.Checks if a Payment exists with the providedid
for the authenticated Customer or anonymous user.Updates a Payment for the authenticated Customer or anonymous user using one or more update actions.Updates a Payment for the authenticated Customer or anonymous user using one or more update actions.Retrieves Payments for the authenticated Customer or anonymous user.Checks if one or more Payments exist for the provided query predicate for the authenticated Customer or anonymous user.Creates a Payment for the authenticated Customer or anonymous user.Creates a Payment for the authenticated Customer or anonymous user.Updates the Customer specified in the customer:{id} scope.Updates the Customer specified in the customer:{id} scope.Checks if a QuoteRequest exists with the providedid
.Retrieves Quote Requests for the authenticated Customer.Checks if one or more QuoteRequests exist for the provided query predicate.Checks if a QuoteRequest exists with the providedkey
.Checks if a Quote exists with the providedid
.Checks if one or more Quotes exist for the provided query predicate.Checks if a Quote exists with the providedkey
.Deletes a ShoppingList for the authenticated Customer or anonymous user.Retrieves a ShoppingList with the providedid
for the authenticated Customer or anonymous user.Checks if a ShoppingList exists with the providedid
for the authenticated Customer or anonymous user.Updates a ShoppingList for the authenticated Customer or anonymous user using one or more update actions.Updates a ShoppingList for the authenticated Customer or anonymous user using one or more update actions.Retrieves ShoppingLists for the authenticated Customer or anonymous user.Checks if one or more ShoppingLists exist for the provided query predicate for the authenticated Customer or anonymous user.Deletes a ShoppingList for the authenticated Customer or anonymous user.Retrieves a ShoppingList with the providedkey
for the authenticated Customer or anonymous user.Checks if a ShoppingList exists with the providedkey
for the authenticated Customer or anonymous user.Updates a ShoppingList for the authenticated Customer or anonymous user using one or more update actions.Updates a ShoppingList for the authenticated Customer or anonymous user using one or more update actions.Creates a ShoppingList for the authenticated Customer or anonymous user.Creates a ShoppingList for the authenticated Customer or anonymous user.If used with an optional access token for an anonymous session, all Orders and Carts that belong to theanonymousId
are assigned to the newly created Customer.If used with an optional access token for an anonymous session, all Orders and Carts that belong to theanonymousId
are assigned to the newly created Customer.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a Message exists with the providedid
.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if one or more Messages exist for the provided query predicate.Deletes an Order in the Project.Retrieves an Order with the providedid
.Checks if an Order exists with the providedid
.Updates an Order in the Project using one or more update actions.Updates an Order in the Project using one or more update actions.Applying an OrderEdit produces the OrderEditApplied Message.Applying an OrderEdit produces the OrderEditApplied Message.Deletes an OrderEdit in the Project.Retrieves an OrderEdit with the providedid
.Checks if an OrderEdit exists with the providedid
.Updates an OrderEdit in the Project using one or more update actions.Updates an OrderEdit in the Project using one or more update actions.Retrieves OrderEdits in the Project.Checks if one or more OrderEdits exist for the provided query predicate.Deletes an OrderEdit in the Project.Retrieves an OrderEdit with the providedkey
.Checks if an OrderEdit exists with the providedkey
.Updates an OrderEdit in the Project using one or more update actions.Updates an OrderEdit in the Project using one or more update actions.Creates an OrderEdit in the Project.Creates an OrderEdit in the Project.Retrieves Orders in the Project.Checks if one or more Orders exist for the provided query predicate.Creates an Order without needing to create a Cart first.Creates an Order without needing to create a Cart first.Deletes an Order in the Project.Retrieves an Order with the providedorderNumber
.Checks if an Order exists with the providedorderNumber
.Updates an Order in the Project using one or more update actions.Updates an Order in the Project using one or more update actions.Creates an Order from a Cart.Creates an Order from a Cart.Creates an Order from a Quote.Creates an Order from a Quote.Checks whether a search index for the Project's Orders exists.Deletes a Payment in the Project.Retrieves a Payment with the providedid
.Checks if a Payment exists with the providedid
.Updates a Payment in the Project using one or more update actions.Updates a Payment in the Project using one or more update actions.Retrieves Payments in the Project.Checks if one or more Payments exist for the provided query predicate.Deletes a Payment in the Project.Retrieves a Payment with the providedkey
.Checks if a Payment exists with the providedkey
.Updates a Payment in the Project using one or more update actions.Updates a Payment in the Project using one or more update actions.Creates a Payment in the Project.Creates a Payment in the Project.Checks if a ProductDiscount exists with the providedid
.Checks if one or more ProductDiscounts exist for the provided query predicate.Checks if a ProductDiscount exists with the providedkey
.This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.Gets the current or staged representation of a Product by its ID.Checks if the current or staged representation of a Product exists with the providedid
.Use the Product Projections query endpoint to get the current or staged representations of Products.Checks if the current or staged representation of a Product exists for the provided query predicate.Gets the current or staged representation of a Product found by Key.Checks if the current or staged representation of a Product exists with the providedkey
.This method appends query parameters to the URL.For implementing funnel search on Product Listing Pages where users select multiple filters, use this POST method.If Product price selection query parameters are provided, the selected Prices are added to the response.If Product price selection query parameters are provided, the selected Prices are added to the response.Checks if a Product exists with the providedid
.Uploads a JPEG, PNG, or a GIF image file to a ProductVariant.Uploads a JPEG, PNG, or a GIF image file to a ProductVariant.If Product price selection query parameters are provided, the selected Prices are added to the response.If Product price selection query parameters are provided, the selected Prices are added to the response.Deletion will only succeed if the Product Selection is not assigned to any Store.Checks if a ProductSelection exists with the providedid
.Checks if one or more ProductSelections exist for the provided query predicate.Deletion will only succeed if the Product Selection is not assigned to any Store.Checks if a ProductSelection exists with the providedkey
.If Product price selection query parameters are provided, the selected Prices are added to the response.Checks if one or more Products exist for the provided query predicate.If Product price selection query parameters are provided, the selected Prices are added to the response.If Product price selection query parameters are provided, the selected Prices are added to the response.Checks if a Product exists with the providedkey
.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.If indexing is in progress or if Product Search is inactive, an ObjectNotFound error is returned.If indexing is in progress or if Product Search is inactive, an ObjectNotFound error is returned.Generates the ProductTailoringDeleted Message.Checks if one or more ProductTailorings exist for the provided query predicate.Generates the ProductTailoringDeleted Message.Generates the ProductTailoringCreated Message.Generates the ProductTailoringCreated Message.Checks if a ProductType exists with the providedid
.Checks if one or more ProductTypes exist for the provided query predicate.Checks if a ProductType exists with the providedkey
.Checks if a QuoteRequest exists with the providedid
.Checks if one or more QuoteRequests exist for the provided query predicate.Checks if a QuoteRequest exists with the providedkey
.Checks if a Quote exists with the providedid
.Checks if one or more Quotes exist for the provided query predicate.Checks if a Quote exists with the providedkey
.Checks if a Review exists with the providedid
.Checks if one or more Reviews exist for the provided query predicate.Checks if a Review exists with the providedkey
.Checks if a ShippingMethod exists with the providedid
.Checks if one or more ShippingMethods exist for the provided query predicate.Checks if a ShippingMethod exists with the providedkey
.Retrieves the active ShippingMethods that can ship to the shipping address of the given Cart.Checks if an active ShippingMethod exists for the given Cart.Retrieves the active ShippingMethods that can ship to the given Location with apredicate
that matches the given Cart.Checks if an active ShippingMethod that can ship to the given Location exists for the given Cart.Retrieves the active ShippingMethods that can ship to the given Location.Checks if an active ShippingMethod that can ship to the given Location exists.Retrieves the active ShippingMethods that can ship to the given Location for an OrderEdit.Checks if an active ShippingMethod that can ship to the given Location exists for the given OrderEdit.Deletes a ShoppingList in the Project.Retrieves a ShoppingList with the providedid
.Checks if a ShoppingList exists with the providedid
.Updates a ShoppingList in the Project using one or more update actions.Updates a ShoppingList in the Project using one or more update actions.Retrieves ShoppingLists in the Project.Checks if one or more ShoppingLists exist for the provided query predicate.Deletes a ShoppingList in the Project.Retrieves a ShoppingList with the providedkey
.Checks if a ShoppingList exists with the providedkey
.Updates a ShoppingList in the Project using one or more update actions.Updates a ShoppingList in the Project using one or more update actions.Create a ShoppingList in the Project.Create a ShoppingList in the Project.Checks if a StagedQuote exists with the providedid
.Checks if one or more StagedQuotes exist for the provided query predicate.Checks if a StagedQuote exists with the providedkey
.Produces the StandalonePriceDeleted Message.Checks if a StandalonePrice exists with the providedid
.Checks if one or more StandalonePrices exist for the provided query predicate.Produces the StandalonePriceDeleted Message.Checks if a StandalonePrice exists with the providedkey
.Creating a Standalone Price produces the StandalonePriceCreated Message.Creating a Standalone Price produces the StandalonePriceCreated Message.Checks if a State exists with the providedid
.Checks if one or more States exist for the provided query predicate.Checks if a State exists with the providedkey
.Checks if a Store exists with the providedid
.Checks if one or more Stores exist for the provided query predicate.Checks if a Store exists with the providedkey
.Checks if a Subscription exists with the providedid
.This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions.Checks if one or more Subscriptions exist for the provided query predicate.Checks if a Subscription exists with the providedkey
.A test notification is sent to ensure the correct configuration of the Destination.A test notification is sent to ensure the correct configuration of the Destination.Checks if a TaxCategory exists with the providedid
.Checks if one or more Tax Categories exist for the provided query predicate.Checks if a TaxCategory exists with the providedkey
.Checks if a Type exists with the providedid
.Checks if one or more Types exist for the provided query predicate.Checks if a Type exists with the providedkey
.Checks if a Zone exists with the providedid
.Checks if one or more Zones exist for the provided query predicate.Checks if a Zone exists with the providedkey
.Middleware to retry a request uponConcurrentModificationException
String projectKey = CommercetoolsTestUtils.getProjectKey(); ProjectApiRoot projectApiRoot = ApiRootBuilder.of() .defaultClient(ClientCredentials.of() .withClientId(CommercetoolsTestUtils.getClientId()) .withClientSecret(CommercetoolsTestUtils.getClientSecret()) .build(), ServiceRegion.GCP_EUROPE_WEST1) .addConcurrentModificationMiddleware(3) .build(projectKey); CartsFixtures.withUpdateableCart(cart -> { final ApiHttpResponse<Cart> deCart = projectApiRoot.carts() .withId(cart.getId()) .post(CartUpdateBuilder.of() .version(cart.getVersion()) .actions(CartSetCountryActionBuilder.of().country("DE").build()) .build()) .executeBlocking(); final Cart modCart = projectApiRoot.carts() .withId(cart.getId()) .post(CartUpdateBuilder.of() .version(cart.getVersion()) .actions(CartSetCountryActionBuilder.of().country("DE").build()) .build()) .executeBlocking() .getBody(); Assertions.assertThat(modCart.getId()).isEqualTo(cart.getId()); Assertions.assertThat(modCart.getVersion()).isGreaterThan(cart.getVersion()); Assertions.assertThat(modCart.getVersion()).isGreaterThan(deCart.getBody().getVersion()); return modCart; });
See the test code.
ConflictingTrait<T extends ConflictingTrait<T>>ConflictingTraitDataerasureTrait<T extends DataerasureTrait<T>>DataerasureTraitDeprecatable200Trait<T extends Deprecatable200Trait<T>>Deprecatable200TraitDeprecatable201Trait<T extends Deprecatable201Trait<T>>Deprecatable201TraitErrorableTrait<T extends ErrorableTrait<T>>ErrorableTraitExpandableTrait<T extends ExpandableTrait<T>>ExpandableTraitLocaleprojectingTrait<T extends LocaleprojectingTrait<T>>LocaleprojectingTraitInterface with common methods for query endpointsPagingTrait<T extends PagingTrait<T>>PagingTraitPriceselectingTrait<T extends PriceselectingTrait<T>>PriceselectingTraitProductProjectionExpansionMixin<T extends ExpandableRequest<T,ProductProjectionExpansionBuilderDsl>> Project scoped API rootProjectionselectingtailoringTraitProjectionselectingTrait<T extends ProjectionselectingTrait<T>>ProjectionselectingTraitProjectRequestBuilder<TMethod>QueryTrait<T extends QueryTrait<T>>QueryTraitRetryHandler<TResult>Handler functions to retry single requests.SimplePagedQueryResourceRequest<T extends SimplePagedQueryResourceRequest<T,TResult, TQuery>, TResult, TQuery> Interface with common methods for query endpointsSortableTrait<T extends SortableTrait<T>>SortableTraitStoreprojectingtailoringTrait<T extends StoreprojectingtailoringTrait<T>>StoreprojectingtailoringTraitStoreprojectingTrait<T extends StoreprojectingTrait<T>>StoreprojectingTraitUpdateActionBuilder<TAction,TActionBuilder> VersionedTrait<T extends VersionedTrait<T>>VersionedTraitWithUpdateActionBuilder<TAction,TActionBuilder, TMethod>