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 APIIf 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.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.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.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.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.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.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.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.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.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.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Deleting an AssociateRole generates the AssociateRoleDeleted Message.Creating a Associate Role generates the AssociateRoleCreated Message.Creating a Associate Role generates the AssociateRoleCreated Message.To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.Retrieves the recently modified active Cart of a Customer with CartOriginCustomer
.To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has apredicate
that does not match the Cart.Creating a Cart fails with an InvalidOperation error if the ShippingMethod referenced in the CartDraft has apredicate
that does not match the Cart.Creates a new Cart by replicating an existing Cart or Order.Creates a new Cart by replicating an existing Cart or Order.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopeview_products:{projectKey}
orview_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 scopeview_products:{projectKey}
orview_categories:{projectKey}
is required.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Either the scopeview_products:{projectKey}
orview_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.Either the scopemanage_products:{projectKey}
ormanage_categories:{projectKey}
is required.Deleting a Customer produces the CustomerDeleted Message.Verifying the email of the Customer produces the CustomerEmailVerified Message.Verifying the email of the Customer produces the CustomerEmailVerified Message.Deleting a Customer produces the CustomerDeleted Message.Changing the password produces the CustomerPasswordUpdated Message withreset=false
.Changing the password produces the CustomerPasswordUpdated Message withreset=false
.Resetting the password of the Customer produces the CustomerPasswordUpdated Message withreset=true
.Resetting the password of the Customer produces the CustomerPasswordUpdated Message withreset=true
.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.Deprecated.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.Deprecated scope:manage_orders:{projectKey}
Deprecated scope:view_orders:{projectKey}
Deprecated scope:manage_orders:{projectKey}
Deprecated scope:manage_orders:{projectKey}
Deprecated scope:view_orders:{projectKey}
Deprecated scope:manage_orders:{projectKey}
Deprecated scope:manage_orders:{projectKey}
Execute a GraphQL queryExecute a GraphQL queryThe My Business Unit endpoint does not support assigning existing Customers to a Business Unit.The My Business Unit endpoint does not support assigning existing Customers to a Business Unit.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.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.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.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.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.Updates a Cart in the Store specified bystoreKey
.Updates a Cart in the Store specified bystoreKey
.Retrieves the recently modified active Cart of a Customer with CartOriginCustomer
.Queries carts in a specific Store.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.Creates a Cart in the Store specified bystoreKey
.Creates a Cart in the Store specified bystoreKey
.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.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.The customer verifies the email using the token value.The customer verifies the email using the token value.If the Customer exists in the Project but 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.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.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.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
.Resetting the password of the Customer produces the CustomerPasswordUpdated Message withreset=true
.Resetting the password of the Customer produces the CustomerPasswordUpdated Message withreset=true
.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.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.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 the Store specified by thestoreKey
path parameter.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.Thestore
field in the created Cart is set to the Store specified by thestoreKey
path parameter.Thestore
field in the created Cart is set to the Store specified by thestoreKey
path parameter.This is the last step in the email verification process of a Customer.This is the last step in the email verification process of a Customer.Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.Retrieves the authenticated Customer (that matches the given email/password pair) if they are part of a specific Store.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.The Cart must have a shipping address set for taxes to be calculated.The Cart must have a shipping address set for taxes to be calculated.Changing the password of the Customer produces the CustomerPasswordUpdated Message 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.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.When using this endpoint, thestore
field of a ShoppingList is always set to the Store specified in the path parameter.When using this endpoint, thestore
field of a ShoppingList is always set to the Store specified in the path parameter.If omitted in the request body, the Customerstores
field is set to the Store specified in the path parameter.If omitted in the request body, the Customerstores
field is set to the Store specified in the path parameter.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have thestore
field, or thestore
field references a different Store, this method returns a ResourceNotFound error.Before you create an Order, the Cart must have a shipping address set.Before you create an Order, the Cart must have a shipping address set.Gets the current or staged representation of a Product by its ID from the specified Store.Gets the current or staged representation of a Product by its key from the specified Store.Queries Product Selection assignments in a specific Store.Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart in a given Store.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.If a ShoppingList exists in a Project but does not have thestore
field, or thestore
field references a different Store, the ResourceNotFound error is returned.When using this endpoint, thestore
field of a ShoppingList is always set to the Store specified in the path parameter.When using this endpoint, thestore
field of a ShoppingList is always set to the Store specified in the path parameter.Produces the InventoryEntryDeleted Message.Produces the InventoryEntryDeleted Message.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.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.Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.Creates a new Cart by replicating an existing Cart or Order of the authenticated Customer.This is the last step in the email verification process of a Customer.This is the last step in the email verification process of a Customer.Retrieves the authenticated customer (that matches the given email/password pair).Retrieves the authenticated customer (that matches the given email/password pair).The Cart must have a shipping address set for taxes to be calculated.The Cart must have a shipping address set for taxes to be calculated.When creating B2B Orders, the Customer must have theCreateMyOrdersFromMyQuotes
Permission.When creating B2B Orders, the Customer must have theCreateMyOrdersFromMyQuotes
Permission.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.This endpoint can only delete a Payment when it has no Transactions.This endpoint can only update a Payment when it has no Transactions.This endpoint can only update a Payment when it has no Transactions.This endpoint can only delete a Payment when it has no Transactions.This endpoint can only update a Payment when it has no Transactions.This endpoint can only update a Payment when it has no Transactions.Creating a Payment produces the PaymentCreated Message.Creating a Payment produces the PaymentCreated Message.If used with an 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 access token for an anonymous session, all Orders and Carts that belong to theanonymousId
are assigned to the newly created Customer.Deprecated scope:view_orders:{projectKey}
Deprecated scope:view_orders:{projectKey}
Deleting an Order produces the OrderDeleted Message.Applying an OrderEdit produces the OrderEditApplied Message.Applying an OrderEdit produces the OrderEditApplied Message.You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.Importing an Order produces the Order Imported Message.Importing an Order produces the Order Imported Message.Deleting an Order produces the OrderDeleted Message.Before you create an Order, the Cart must have a shipping address set.Before you create an Order, the Cart must have a shipping address set.Creating an Order produces the OrderCreated Message.Creating an Order produces the OrderCreated Message.Checks whether a search index for the Project's Orders exists.Creating a Payment produces the PaymentCreated Message.Creating a Payment produces the PaymentCreated Message.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.Use the Product Projections query endpoint to get the current or staged representations of Products.Gets the current or staged representation of a Product found by Key.Product Projection SearchProduct Projection SearchIf Price selection query parameters are provided, the selected Prices are added to the response.If Price selection query parameters are provided, the selected Prices are added to the response.Check if a Product exists with a specifiedid
.Upload a JPEG, PNG and GIF file to a ProductVariant.Upload a JPEG, PNG and GIF file to a ProductVariant.If Price selection query parameters are provided, the selected Prices are added to the response.If Price selection query parameters are provided, the selected Prices are added to the response.Deletion will only succeed if the Product Selection is not assigned to any Store.Deletion will only succeed if the Product Selection is not assigned to any Store.If Price selection query parameters are provided, the selected Prices are added to the response.Check if Products exist.If Price selection query parameters are provided, the selected Prices are added to the response.If Price selection query parameters are provided, the selected Prices are added to the response.Check if a Product exists with a specifiedkey
.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.To create a new Product, send a representation that is going to become the initial staged representation of the new Product in the master catalog.To create a new Product, send a representation that is going to become the initial staged representation of the new Product in the master catalog.Checks if a Product Type with givenid
exists.Check if Product Types exist.Checks if a Product Type with givenkey
exists.Retrieves all the ShippingMethods that can ship to the shipping address of the given Cart.Retrieves all the ShippingMethods that can ship to the given Location with apredicate
that matches the given Cart.Retrieves all the ShippingMethods that can ship to the given Location.Retrieves all the ShippingMethods that can ship to the given Location for an OrderEdit.Produces the StandalonePriceDeleted Message.Produces the StandalonePriceDeleted Message.Produces the StandalonePriceCreated Message.Produces the StandalonePriceCreated Message.This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions.A test message is sent to ensure the correct configuration of the Destination.A test message is sent to ensure the correct configuration of the Destination.Middleware to retry a request uponConcurrentModificationException
Implementation of theConcurrentModificationMiddleware
.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>>PriceselectingTraitProject scoped API rootProjectionselectingTrait<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>>SortableTraitStoreprojectingTrait<T extends StoreprojectingTrait<T>>StoreprojectingTraitUpdateActionBuilder<TAction,TActionBuilder> VersionedTrait<T extends VersionedTrait<T>>VersionedTraitWithUpdateActionBuilder<TAction,TActionBuilder, TMethod>