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 for a givenid
.Checks if an API Client exists for a given Query Predicate.Checks if a BusinessUnit exists for a givenid
.Checks if a BusinessUnit exists for a given Query Predicate.Checks if a BusinessUnit exists for a givenkey
.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Cart exists for a givenid
.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Cart exists for a given Query Predicate.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Cart exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Cart exists for a givenkey
.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.Checks if an Order exists for a givenid
.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if an Order exists for a given Query Predicate.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if an Order exists for a givenorderNumber
.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Order exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Cart in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.Creates an Order from a Quote in a BusinessUnit.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a QuoteRequest exists for a givenid
.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a QuoteRequest exists for a given Query Predicate.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a QuoteRequest exists for a givenkey
.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the QuoteRequest exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Creates a QuoteRequest in a BusinessUnit.Creates a QuoteRequest in a BusinessUnit.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Quote exists for a givenid
.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Quote exists for a given Query Predicate.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if a Quote exists for a givenkey
.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.If the Quote exists in the Project but does not reference the requested BusinessUnit, this method returns an InvalidOperation error.Checks if an AssociateRole exists for a givenid
.Checks if an AssociateRole exists for a given Query Predicate.Deleting an AssociateRole generates the AssociateRoleDeleted Message.Checks if an AssociateRole exists for a givenkey
.Creating a Associate Role generates the AssociateRoleCreated Message.Creating a Associate Role generates the AssociateRoleCreated Message.Checks if an AttributeGroup exists for a givenid
.Checks if an AttributeGroup exists for a given Query Predicate.Checks if an AttributeGroup exists for a givenkey
.Checks if a BusinessUnit exists for a givenid
.Checks if a BusinessUnit exists for a given Query Predicate.Checks if a BusinessUnit exists for a givenkey
.Deleting a Cart Discount produces the CartDiscountDeleted Message.Checks if a CartDiscount exists for a givenid
.Checks if a CartDiscount exists for a given Query Predicate.Deleting a Cart Discount produces the CartDiscountDeleted Message.Checks if a CartDiscount exists for a givenkey
.Creating a Cart Discount produces the CartDiscountCreated Message.Creating a Cart Discount produces the CartDiscountCreated Message.To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.Checks if a Cart exists for a givenid
.Retrieves the most recently modified active Cart of a Customer with CartOriginCustomer
.Checks if a Cart of a Customer exists.Checks if a Cart exists for a given Query Predicate.To ensure the Cart is up-to-date with current values (such as Prices and Discounts), use the Recalculate update action.Checks if a Cart exists for a givenkey
.If the referenced ShippingMethod in the CartDraft has a predicate that does not match, or if the Shipping Method is not active, an InvalidOperation error is returned.If the referenced ShippingMethod in the CartDraft has a predicate that does not match, or if the Shipping Method is not active, an InvalidOperation error is returned.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 for a givenid
.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 a Category exists for on a given 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 for a givenkey
.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 for a givenid
.Checks if a Channel exists for a given Query Predicate.Checks if a CustomerGroup exists for a givenid
.Checks if a CustomerGroup exists for a given Query Predicate.Checks if a CustomerGroup exists for a givenkey
.Deleting a Customer produces the CustomerDeleted Message.Checks if a Customer exists for a givenid
.Simultaneously updating two Customers with the same email address can return a LockedField error.Simultaneously updating two Customers with the same email address can return a LockedField error.Verifying the email of the Customer produces the CustomerEmailVerified Message.Verifying the email of the Customer produces the CustomerEmailVerified Message.Produces the CustomerEmailTokenCreated Message.Produces the CustomerEmailTokenCreated Message.Checks if a Customer exists for a given Query Predicate.Deleting a Customer produces the CustomerDeleted Message.Checks if a Customer exists for a givenkey
.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
.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.Checks whether a search index of Customers exists for a Project.Returns the indexing status of the Customer Search for a Project.A SearchNotReady error is returned if the indexing is in progress or the feature is deactivated.A SearchNotReady error is returned if the indexing is in progress or the feature is deactivated.Deprecated.Checks if a CustomObject exists for a given Query Predicate.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented.Deleting a Discount Code produces the DiscountCodeDeleted Message.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a DiscountCode exists for a givenid
.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 a DiscountCode exists for a given Query Predicate.Deleting a Discount Code produces the DiscountCodeDeleted Message.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a DiscountCode exists for a givenkey
.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 for a givenid
.Checks if an Extension exists for a given Query Predicate.Checks if an Extension exists for a givenkey
.Execute a GraphQL queryExecute a GraphQL queryChecks 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.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists for a givenid
.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.To update a CartDiscount, you must have permissions for all Stores the CartDiscount is associated with, except when removing a Store.Checks if a CartDiscount exists for a given Query Predicate.To delete a CartDiscount, specify themanage_cart_discounts:{projectKey}:{storeKey}
scope for all Stores associated with the CartDiscount.Checks if a CartDiscount exists for a givenkey
.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 astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.Checks if a Cart exists for a givenid
.Updates a Cart in the Store specified bystoreKey
.Updates a Cart in the Store specified bystoreKey
.Retrieves the most recently modified active Cart of a Customer with CartOriginCustomer
.Checks if a Cart of a Customer exists.Queries Carts in a specific Store.Checks if a Cart exists for a given Query Predicate.If the Cart exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.Checks if a Cart exists for a givenkey
.If the Cart exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Cart exists in the Project but does not have astore
specified, 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.Checks if a Customer exists for a givenid
.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.Checks if a Customer exists for a given Query Predicate.Deleting a Customer produces the CustomerDeleted Message.If the Customer exists in the Project but thestores
field references a different Store, this method returns a ResourceNotFound error.Checks if a Customer exists for a givenkey
.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 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.Returns all Carts that match a given Query Predicate and contain either a matchingcustomerId
oranonymousId
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.Returns an Order for a givenid
in a Store.Checks if an Order exists for a givenid
in a Store.Returns all Orders in a Store that match a given Query Predicate and contain either acustomerId
that matches the customer_id:{id} scope, or ananonymousId
that matches the anonymous_id:{id} scope.Checks if an Order exists for a given Query Predicate in a Store.Creates an Order in a Store from a Cart for the Customer or anonymous user.Creates an Order in a Store from a Cart 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 the ShoppingList for a givenid
in a Store.Returns a ShoppingList for a givenid
in a Store.Checks if a ShoppingList exists for a givenid
in a Store.Updates a ShoppingList for a givenid
in a Store.Updates a ShoppingList for a givenid
in a Store.Returns ShoppingLists that match the given Query Predicate in a Store.Checks if a ShoppingList exists for the given Query Predicate in a Store.Deletes the ShoppingList for a givenkey
in a Store.Returns a ShoppingList for a givenkey
in a Store.Checks if a ShoppingList exists for a givenkey
in a Store.Updates a ShoppingList for a givenkey
in a Store.Updates a ShoppingList for a givenkey
in a Store.Creates a ShoppingList in a Store for a Customer or anonymous user.Creates a ShoppingList in a Store for a 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.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a givenid
.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a given Query Predicate.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.Checks if an Order exists for a givenorderNumber
.If the Order exists in the Project but does not have astore
specified, or thestore
field references a different Store, this method returns a ResourceNotFound error.If the Order exists in the Project but does not have astore
specified, 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.Creating an Order produces the OrderCreated Message.Creating an Order produces the OrderCreated Message.Gets the current or staged representation of a Product by its ID in the specified Store.Checks if the current or staged representations of a Product exists for a givenid
in the specified Store.Gets the current or staged representation of a Product by its key in the specified Store.Checks if the current or staged representations of a Product exists for a givenkey
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 for a givenid
.Checks if a QuoteRequest exists for a given Query Predicate.Checks if a QuoteRequest exists for a givenkey
.Checks if a Quote exists for a givenid
.Checks if a Quote exists for a given Query Predicate.Checks if a Quote exists for a givenkey
.Retrieves all 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.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.Checks if a ShoppingList exists for a givenid
.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.Checks if a ShoppingList exists for a given Query Predicate.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.Checks if a ShoppingList exists for a givenkey
.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.Checks if a StagedQuote exists for a givenid
.Checks if a StagedQuote exists for a given Query Predicate.Checks if a StagedQuote exists for a givenkey
.Produces the InventoryEntryDeleted Message.Checks if an InventoryEntry exists for a givenid
.Checks if an InventoryEntry exists for a given Query Predicate.Produces the InventoryEntryDeleted Message.Checks if an InventoryEntry exists for a givenkey
.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 for a givenid
.Updates a Business Unit for a givenid
.Updates a Business Unit for a givenid
.Returns all of the authenticated Customer’s Business Units in a Project.Checks if a BusinessUnit exists for a given Query Predicate.Returns a Business Unit for a givenkey
.Checks if a BusinessUnit exists for a givenkey
.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 for a givenid
.Updates the Cart for a givenid
.Updates the Cart for a givenid
.Returns all Carts that match a given Query Predicate and contain either a matchingcustomerId
oranonymousId
.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).Returns an Order for a givenid
.Checks if an Order exists for a givenid
.Returns all Orders that match a given Query Predicate.Checks if an Order exists for a given Query Predicate.Creates an Order from a Cart for the Customer or anonymous user.Creates an Order from a Cart for the Customer or anonymous user.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.Deletes the Payment for a givenid
.Returns a Payment for a givenid
.Checks if a Payment exists for a givenid
.Updates a Payment for a givenid
.Updates a Payment for a givenid
.Returns all Payments that match a given Query Predicate.Checks if a Payment exists for a given Query Predicate.Creates a Payment for the Customer or an anonymous user.Creates a Payment for the Customer or an 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 for a givenid
.Returns all Quote Requests that match a given Query Predicate.Checks if a QuoteRequest exists for a given Query Predicate.Checks if a QuoteRequest exists for a givenkey
.Checks if a Quote exists for a givenid
.Checks if a Quote exists for a given Query Predicate.Checks if a Quote exists for a givenkey
.Deletes the ShoppingList for a givenid
.Returns a ShoppingList for a givenid
.Checks if a ShoppingList exists for a givenid
.Updates a ShoppingList for a givenid
.Updates a ShoppingList for a givenid
.Returns all ShoppingLists that match the given Query Predicate.Checks if a ShoppingList matches the given Query Predicate.Deletes the ShoppingList for a givenkey
.Returns a ShoppingList for a givenkey
.Checks if a ShoppingList exists for a givenkey
.Updates a ShoppingList for a givenkey
.Updates a ShoppingList for a givenkey
.Creates a ShoppingList for the Customer or anonymous user.Creates a ShoppingList for the 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 for a givenid
.Deprecated OAuth 2.0 Scope:view_orders:{projectKey}
Checks if a Message exists for a given Query Predicate.Deleting an Order produces the OrderDeleted Message.Checks if an Order exists for a givenid
.Applying an OrderEdit produces the OrderEditApplied Message.Applying an OrderEdit produces the OrderEditApplied Message.Checks if an OrderEdit exists for a givenid
.Checks if an OrderEdit exists for a given Query Predicate.Checks if an OrderEdit exists for a givenkey
.You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.You can either create multiple Order Edits for an Order and apply them sequentially to an Order, or create multiple Order Edits parallelly (as alternatives to each other) and apply one of them to the Order.Checks if an Order exists for a given Query Predicate.Importing an Order produces the Order Imported Message.Importing an Order produces the Order Imported Message.Deleting an Order produces the OrderDeleted Message.Checks if an Order exists for a givenorderNumber
.Before you create an Order, the Cart must have a shipping address set.Before you create an Order, the Cart must have a shipping address set.Creating an Order produces the OrderCreated Message.Creating an Order produces the OrderCreated Message.Checks whether a search index for the Project's Orders exists.Checks if a Payment exists for a givenid
.Checks if a Payment exists for a given Query Predicate.Checks if a Payment exists for a givenkey
.Creating a Payment produces the PaymentCreated Message.Creating a Payment produces the PaymentCreated Message.Checks if a ProductDiscount exists for a givenid
.Checks if a ProductDiscount exists for a given Query Predicate.Checks if a ProductDiscount exists for a givenkey
.This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.This endpoint can be used to simulate which Product Discounts would be applied if a specified Product Variant had a specified Price.Gets the current or staged representation of a Product by its ID.Checks if the current or staged representation of a Product exists for a givenid
.Use the Product Projections query endpoint to get the current or staged representations of Products.Checks if the current or staged representation of a Product exists for a given Query Predicate.Gets the current or staged representation of a Product found by Key.Checks if the current or staged representation of a Product exists for a givenkey
.Product Projection SearchProduct Projection SearchIf 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 for a givenid
.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 for a givenid
.Checks if a ProductSelection exists for a given Query Predicate.Deletion will only succeed if the Product Selection is not assigned to any Store.Checks if a ProductSelection exists for a givenkey
.If Product price selection query parameters are provided, the selected Prices are added to the response.Checks if a Product exists for a given Query Predicate.If 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 for a givenkey
.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error.To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog.Generates the ProductTailoringDeleted Message.Checks if a ProductTailoring exists for a given Query Predicate.Generates the ProductTailoringDeleted Message.Generates the ProductTailoringCreated Message.Generates the ProductTailoringCreated Message.Checks if a ProductType exists for a givenid
.Checks if a ProductType exists for a given Query Predicate.Checks if a ProductType exists for a givenkey
.Checks if a QuoteRequest exists for a givenid
.Checks if a QuoteRequest exists for a given Query Predicate.Checks if a QuoteRequest exists for a givenkey
.Checks if a Quote exists for a givenid
.Checks if a Quote exists for a given Query Predicate.Checks if a Quote exists for a givenkey
.Checks if a Review exists for a givenid
.Checks if a Review exists for a given Query Predicate.Checks if a Review exists for a givenkey
.Checks if a ShippingMethod exists for a givenid
.Checks if a ShippingMethod exists for a given Query Predicate.Checks if a ShippingMethod exists for a givenkey
.Retrieves all 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 all 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 all the active ShippingMethods that can ship to the given Location.Checks if an active ShippingMethod that can ship to the given Location exists.Retrieves all 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.Checks if a ShoppingList exists for a givenid
.Checks if a ShoppingList exists for a given Query Predicate.Checks if a ShoppingList exists for a givenkey
.Checks if a StagedQuote exists for a givenid
.Checks if a StagedQuote exists for a given Query Predicate.Checks if a StagedQuote exists for a givenkey
.Produces the StandalonePriceDeleted Message.Checks if a StandalonePrice exists for a givenid
.Checks if a StandalonePrice exists for a given Query Predicate.Produces the StandalonePriceDeleted Message.Checks if a StandalonePrice exists for a givenkey
.Creating a Standalone Price produces the StandalonePriceCreated Message.Creating a Standalone Price produces the StandalonePriceCreated Message.Checks if a State exists for a givenid
.Checks if a State exists for a given Query Predicate.Checks if a State exists for a givenkey
.Checks if a Store exists for a givenid
.Checks if a Store exists for a given Query Predicate.Checks if a Store exists for a givenkey
.Checks if a Subscription exists for a givenid
.This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions.Checks if a Subscription exists for a given Query Predicate.Checks if a Subscription exists for a givenkey
.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 for a givenid
.Checks if a TaxCategory exists for a given Query Predicate.Checks if a TaxCategory exists for a givenkey
.Checks if a Type exists for a givenid
.Checks if a Type exists for a given Query Predicate.Checks if a Type exists for a givenkey
.Checks if a Zone exists for a givenid
.Checks if a Zone exists for a given Query Predicate.Checks if a Zone exists for a givenkey
.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(); 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 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>