Commerce Webservices V2 Page 1 of 135

Commerce Webservices V2

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 2 of 135

Table of Contents
1. Overview
1.1. Version information
1.2. URI scheme
1.3. Tags
1.4. Produces
2. Security
2.1. oauth2_Password
2.2. oauth2_client_credentials
3. Resources
3.1. Carts
3.1.1. Creates or restore a cart for a user.
3.1.2. Get all customer carts.
3.1.3. Get a cart with a given identifier.
3.1.4. Deletes a cart with a given cart id.
3.1.5. Creates a delivery adress for the cart.
3.1.6. Sets a delivery address for the cart.
3.1.7. Delete the delivery address from the cart.
3.1.8. Get the delivery mode selected for the cart.
3.1.9. Sets the delivery mode for a cart.
3.1.10. Delete the delivery mode from the cart.
3.1.11. Get all delivery modes for the current store and delivery address.
3.1.12. Assigns an email to the cart.
3.1.13. Adds a product to the cart.
3.1.14. Get cart entries.
3.1.15. Get the details of the cart entries.
3.1.16. Set quantity and store details of a cart entry.
3.1.17. Deletes cart entry.
3.1.18. Update quantity and store details of a cart entry.
3.1.19. Defines and assigns details of a new credit card payment to the cart.
3.1.20. Sets credit card payment details for the cart.
3.1.21. Enables promotions based on the promotionsId of the cart.
3.1.22. Get information about promotions applied on cart.
3.1.23. Get information about promotions applied on cart.
3.1.24. Disables the promotion based on the promotionsId of the cart.
3.1.25. Applies a voucher based on the voucherId defined for the cart.
3.1.26. Get a list of vouchers applied to the cart.
3.1.27. Delete a voucher defined for the current cart.
3.2. Catalogs
3.2.1. Get a list of catalogs
3.2.2. Get a catalog
3.2.3. Get information about catalog version
3.2.4. Get information about catagory in a catalog version
3.3. Customer Groups
3.3.1. Creates a new customer group.
3.3.2. Get all subgroups of a customergroup.
3.3.3. Get a specific customer group.
3.3.4. Sets members for a user group.
3.3.5. Assigns user(s) to a customer group.
3.3.6. Delete a user from a customer group.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 3 of 135

3.4. Export
3.4.1. Get a list of product exports.
3.5. Feeds
3.5.1. Get a list of orders with status updates
3.6. Forgotten Passwords
3.6.1. Generates a token to restore customer’s forgotten password.
3.7. Miscs
3.7.1. Get a list of supported payment card types.
3.7.2. Get a list of available currencies.
3.7.3. Get a list of supported countries.
3.7.4. Get a list of available languages.
3.7.5. Get a list of all localized titles.
3.8. Orders
3.8.1. Get a order
3.8.2. Post a order
3.8.3. Get order history for user
3.8.4. Get total number of orders
3.8.5. Get a order
3.9. Products
3.9.1. Get products added to the express update feed
3.9.2. Get a list of products and additional data
3.9.3. Get a header with total number of products
3.9.4. Get a list of available suggestions
3.9.5. Get product details
3.9.6. Get a product reference
3.9.7. Creates a new customer review as an anonymous user
3.9.8. Get reviews for a product
3.9.9. Get a product’s stock level
3.9.10. Get header with a total number of product’s stock levels
3.9.11. Get a product’s stock level for a store
3.10. Promotions
3.10.1. Get a list of promotions
3.10.2. Get a promotion based on code
3.11. Save Cart
3.11.1. Explicitly clones a cart.
3.11.2. Flag a cart for deletion.
3.11.3. Restore a saved cart.
3.11.4. Explicitly saves a cart.
3.11.5. Get a saved cart.
3.12. Stores
3.12.1. Get a list of store locations
3.12.2. Get a header with the number of store locations
3.12.3. Get a store location
3.13. Users
3.13.1. Registers a customer
3.13.2. Get customer profile
3.13.3. Updates customer profile
3.13.4. Delete customer profile
3.13.5. Updates customer profile
3.13.6. Created a new address.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 4 of 135

3.13.7. Get customer’s addresses

3.13.8. Verifies address
3.13.9. Get info about address
3.13.10. Updates the address
3.13.11. Delete customer’s address
3.13.12. Updates the address
3.13.13. Get all customer groups of a customer.
3.13.14. Changes customer’s login
3.13.15. Changes customer’s password
3.13.16. Get customer’s credit card payment details list.
3.13.17. Get customer’s credit card payment details.
3.13.18. Updates existing customer’s credit card payment info.
3.13.19. Delete customer’s credit card payment details.
3.13.20. Updates existing customer’s credit card payment details.
3.14. Vouchers
3.14.1. Get a voucher based on code
4. Definitions
4.1. AddressListWsDTO
4.2. AddressValidationWsDTO
4.3. AddressWsDTO
4.4. BaseOptionWsDTO
4.5. BreadcrumbWsDTO
4.6. CardTypeListWsDTO
4.7. CardTypeWsDTO
4.8. CartListWsDTO
4.9. CartModificationWsDTO
4.10. CartWsDTO
4.11. CatalogListWsDTO
4.12. CatalogVersionWsDTO
4.13. CatalogWsDTO
4.14. CategoryHierarchyWsDTO
4.15. CategoryWsDTO
4.16. ClassificationWsDTO
4.17. ConsignmentEntryWsDTO
4.18. ConsignmentWsDTO
4.19. CountryListWsDTO
4.20. CountryWsDTO
4.21. CurrencyListWsDTO
4.22. CurrencyWsDTO
4.23. DeliveryModeListWsDTO
4.24. DeliveryModeWsDTO
4.25. DeliveryOrderEntryGroupWsDTO
4.26. FacetValueWsDTO
4.27. FacetWsDTO
4.28. FeatureUnitWsDTO
4.29. FeatureValueWsDTO
4.30. FeatureWsDTO
4.31. FutureStockWsDTO
4.32. GeoPointWsDTO
4.33. ImageWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 5 of 135

4.34. LanguageListWsDTO
4.35. LanguageWsDTO
4.36. MemberListWsDTO
4.37. OpeningScheduleWsDTO
4.38. OrderEntryListWsDTO
4.39. OrderEntryWsDTO
4.40. OrderHistoryListWsDTO
4.41. OrderHistoryWsDTO
4.42. OrderStatusUpdateElementListWsDTO
4.43. OrderStatusUpdateElementWsDTO
4.44. OrderWsDTO
4.45. PaginationWsDTO
4.46. PaymentDetailsListWsDTO
4.47. PaymentDetailsWsDTO
4.48. PickupOrderEntryGroupWsDTO
4.49. PointOfServiceStockWsDTO
4.50. PointOfServiceWsDTO
4.51. PriceRangeWsDTO
4.52. PriceWsDTO
4.53. PrincipalWsDTO
4.54. ProductExpressUpdateElementListWsDTO
4.55. ProductExpressUpdateElementWsDTO
4.56. ProductListWsDTO
4.57. ProductReferenceListWsDTO
4.58. ProductReferenceWsDTO
4.59. ProductSearchPageWsDTO
4.60. ProductWsDTO
4.61. PromotionListWsDTO
4.62. PromotionOrderEntryConsumedWsDTO
4.63. PromotionRestrictionWsDTO
4.64. PromotionResultListWsDTO
4.65. PromotionResultWsDTO
4.66. PromotionWsDTO
4.67. RegionWsDTO
4.68. ReviewListWsDTO
4.69. ReviewWsDTO
4.70. SaveCartResultWsDTO
4.71. SearchQueryWsDTO
4.72. SearchStateWsDTO
4.73. SortWsDTO
4.74. SpecialOpeningDayWsDTO
4.75. SpellingSuggestionWsDTO
4.76. StockWsDTO
4.77. StoreFinderSearchPageWsDTO
4.78. StoreFinderStockSearchPageWsDTO
4.79. SuggestionListWsDTO
4.80. SuggestionWsDTO
4.81. TimeWsDTO
4.82. TitleListWsDTO
4.83. TitleWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 6 of 135

4.84. UserGroupListWsDTO
4.85. UserGroupWsDTO
4.86. UserSignUpWsDTO
4.87. UserWsDTO
4.88. VariantCategoryWsDTO
4.89. VariantMatrixElementWsDTO
4.90. VariantOptionQualifierWsDTO
4.91. VariantOptionWsDTO
4.92. VariantValueCategoryWsDTO
4.93. VoucherListWsDTO
4.94. VoucherWsDTO
4.95. WeekdayOpeningDayWsDTO
4.96. error
4.97. errorList

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 7 of 135

1. Overview
Commerce Webservices Version 2

1.1. Version information

Version : 2.0

1.2. URI scheme

Host : localhost:9001
BasePath : /rest/v2

1.3. Tags
• Carts : Carts Controller

• Catalogs : Catalogs Controller

• Customer Groups : Customer Groups Controller

• Export : Export Controller

• Feeds : Feeds Controller

• Forgotten Passwords : Forgotten Passwords Controller

• Miscs : Miscs Controller

• Orders : Orders Controller

• Products : Products Controller

• Promotions : Promotions Controller

• Save Cart : Save Cart Controller

• Stores : Stores Controller

• Users : Users Controller

• Vouchers : Vouchers Controller

1.4. Produces
• application/xml

• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 8 of 135

2. Security
2.1. oauth2_Password
Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

2.2. oauth2_client_credentials
Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

extended

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 9 of 135

3. Resources
3.1. Carts
Carts Controller

3.1.1. Creates or restore a cart for a user.

POST /{baseSiteId}/users/{userId}/carts

Description
Creates a new cart or restores an anonymous cart as a user’s cart (if an old Cart Id is given in the request).

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should enum (BASIC,

Query "DEFAULT"
optional be returned in response) DEFAULT, FULL)

oldCartId
Query Anonymous cart GUID. string
optional

toMergeCartGuid
Query User’s cart GUID to merge anonymous cart to. string
optional

Responses

HTTP
Description Schema
Code

201 Created CartWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 10 of 135

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.2. Get all customer carts.

GET /{baseSiteId}/users/{userId}/carts

Description
Lists all customer carts.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

currentPage Optional pagination parameter in case of

Query integer(int32) "0"
optional savedCartsOnly == true. Default value 0.

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

pageSize Optional {@link PaginationData} parameter in case of

Query integer(int32) "20"
optional savedCartsOnly == true. Default value 20.

savedCartsOnly Optional parameter. If the parameter is provided and

Query boolean "false"
optional its value is true only saved carts are returned.

sort Optional sort criterion in case of savedCartsOnly ==

Query string
optional true. No default value.

Responses

HTTP
Description Schema
Code

200 OK CartListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 11 of 135

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.3. Get a cart with a given identifier.

GET /{baseSiteId}/users/{userId}/carts/{cartId}

Description
Returns the cart with a given identifier.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CartWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 12 of 135

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.4. Deletes a cart with a given cart id.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}

Description
Deletes a cart with a given cart id.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 13 of 135

Type Name

oauth2 oauth2_client_credentials

3.1.5. Creates a delivery adress for the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description
Creates an address and assigns it to the cart as the delivery address.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Request body parameter (DTO in xml or json format)

which contains details like : Customer’s first name
(firstName), Customer’s last name(lastName),
address
Body Customer’s title code(titleCode), country AddressWsDTO
required
(country.isocode), first part of address(line1) , second
part of address(line2), town (town), postal code
(postalCode), region (region.isocode)

Responses

HTTP
Description Schema
Code

201 Created AddressWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 14 of 135

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.6. Sets a delivery address for the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description
Sets a delivery address for the cart. The address country must be placed among the delivery countries of the current base store.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

addressId
Query Address identifier string
required

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 15 of 135

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.7. Delete the delivery address from the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery

Description
Removes the delivery address from the cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 16 of 135

Type Name

oauth2 oauth2_client_credentials

3.1.8. Get the delivery mode selected for the cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description
Returns the delivery mode selected for the cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK DeliveryModeWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 17 of 135

Type Name

oauth2 oauth2_client_credentials

3.1.9. Sets the delivery mode for a cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description
Sets the delivery mode with a given identifier for the cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

deliveryModeId
Query Delivery mode identifier (code) string
required

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 18 of 135

Type Name

oauth2 oauth2_client_credentials

3.1.10. Delete the delivery mode from the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode

Description
Removes the delivery mode from the cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.11. Get all delivery modes for the current store and delivery address.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 19 of 135

Description
Returns all delivery modes supported for the current base store and cart delivery address. A delivery address must be set for the
cart, otherwise an empty list will be returned.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK DeliveryModeListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.12. Assigns an email to the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email

Description

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 20 of 135

Assigns an email to the cart. This step is required to make a guest checkout.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

email Email of the guest user. It will be used during checkout

Query string
required process.

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.13. Adds a product to the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries

Description
Adds a product to the cart.

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 21 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Request body parameter (DTO in xml or json format)

entry which contains details like : product code
Body OrderEntryWsDTO
required (product.code), quantity of product (quantity), pickup
store name (deliveryPointOfService.name)

Responses

HTTP
Description Schema
Code

200 OK CartModificationWsDTO

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.14. Get cart entries.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 22 of 135

GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries

Description
Returns cart entries.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK OrderEntryListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.15. Get the details of the cart entries.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 23 of 135

Description
Returns the details of the cart entries.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

entryNumber
Path Entry number. Zero-based numbering. integer(int64)
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK OrderEntryWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.16. Set quantity and store details of a cart entry.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 24 of 135

Description
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked. Attributes not provided in
request will be defined again (set to null or default)

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

entryNumber
Path Entry number. Zero-based numbering. integer(int64)
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Request body parameter (DTO in xml or json format)

entry which contains details like : quantity of product
Body OrderEntryWsDTO
required (quantity), pickup store name
(deliveryPointOfService.name)

Responses

HTTP
Description Schema
Code

200 OK CartModificationWsDTO

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 25 of 135

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.17. Deletes cart entry.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description
Deletes cart entry.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

entryNumber
Path Entry number. Zero-based numbering. integer(int64)
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 26 of 135

Type Name

oauth2 oauth2_client_credentials

3.1.18. Update quantity and store details of a cart entry.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}

Description
Updates the quantity of a single cart entry and details of the store where the cart entry will be picked.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

entryNumber
Path Entry number. Zero-based numbering. integer(int64)
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Request body parameter (DTO in xml or json format)

entry which contains details like : quantity of product
Body OrderEntryWsDTO
required (quantity), pickup store name
(deliveryPointOfService.name)

Responses

HTTP
Description Schema
Code

200 OK CartModificationWsDTO

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/xml

• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 27 of 135

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.19. Defines and assigns details of a new credit card payment to the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Description
Defines details of a new credit card payment details and assigns the payment to the cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Request body parameter (DTO in xml or json format)

which contains details like : Name on card
(accountHolderName), card number(cardNumber),
card type (cardType.code), Month of expiry date
(expiryMonth), Year of expiry date (expiryYear), if
payment details should be saved (saved), if if the
paymentDetails payment details should be used as default
Body PaymentDetailsWsDTO
required (defaultPaymentInfo), billing address
(billingAddress.firstName, billingAddress.lastName,
billingAddress.titleCode,
billingAddress.country.isocode, billingAddress.line1,
billingAddress.line2, billingAddress.town,
billingAddress.postalCode,
billingAddress.region.isocode)

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 28 of 135

HTTP
Description Schema
Code

201 Created PaymentDetailsWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.20. Sets credit card payment details for the cart.

PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails

Description
Sets credit card payment details for the cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

paymentDetailsId
Query Payment details identifier. string
required

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 29 of 135

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.21. Enables promotions based on the promotionsId of the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Description
Enables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have
been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible
with the new promotion engine.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

promotionId
Query Promotion identifier (code) string
required

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 30 of 135

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.1.22. Get information about promotions applied on cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions

Description
Return information about promotions applied on cart. Requests pertaining to promotions have been developed for the previous
version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 31 of 135

HTTP
Description Schema
Code

200 OK PromotionResultListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.23. Get information about promotions applied on cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Description
Return information about promotion with given id, applied on cart. Requests pertaining to promotions have been developed for
the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new
promotion engine.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

promotionId
Path Promotion identifier (code) string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 32 of 135

Type Name Description Schema Default

Responses

HTTP
Description Schema
Code

200 OK PromotionResultListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.24. Disables the promotion based on the promotionsId of the cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}

Description
Disables the promotion for the order based on the promotionId defined for the cart. Requests pertaining to promotions have
been developed for the previous version of promotions and vouchers and therefore some of them are currently not compatible
with the new promotion engine.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

promotionId
Path Promotion identifier (code) string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 33 of 135

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.1.25. Applies a voucher based on the voucherId defined for the cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Description
Applies a voucher based on the voucherId defined for the cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

voucherId
Query Voucher identifier (code) string
required

Responses

HTTP
Description Schema
Code

200 OK No Content

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 34 of 135

HTTP
Description Schema
Code

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.26. Get a list of vouchers applied to the cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers

Description
Returns list of vouchers applied to the cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 35 of 135

HTTP
Description Schema
Code

200 OK VoucherListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.1.27. Delete a voucher defined for the current cart.

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}

Description
Removes a voucher based on the voucherId defined for the current cart.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

cartId Cart identifier: cart code for logged in user, cart guid for
Path string
required anonymous user, 'current' for the last modified cart

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

voucherId
Path Voucher identifier (code) string
required

Responses

HTTP
Description Schema
Code

200 OK No Content

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 36 of 135

HTTP
Description Schema
Code

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.2. Catalogs
Catalogs Controller

3.2.1. Get a list of catalogs

GET /{baseSiteId}/catalogs

Description
Returns all catalogs with versions defined for the base store.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CatalogListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 37 of 135

HTTP
Description Schema
Code

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.2.2. Get a catalog

GET /{baseSiteId}/catalogs/{catalogId}

Description
Returns a information about a catalog based on its ID, along with versions defined for the current base store.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

catalogId
Path Catalog identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CatalogWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 38 of 135

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.2.3. Get information about catalog version

GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}

Description
Returns information about catalog version that exists for the current base store.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

catalogId
Path Catalog identifier string
required

catalogVersionId
Path Catalog version identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CatalogVersionWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 39 of 135

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.2.4. Get information about catagory in a catalog version

GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}

Description
Returns information about category that exists in a catalog version available for the current base store.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

catalogId
Path Catalog identifier string
required

catalogVersionId
Path Catalog version identifier string
required

categoryId
Path Category identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CategoryHierarchyWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 40 of 135

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.3. Customer Groups

Customer Groups Controller

3.3.1. Creates a new customer group.

POST /{baseSiteId}/customergroups

Description
Creates a new customer group that is a direct subgroup of a customergroup.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userGroup
Body User group object with id and name. UserGroupWsDTO
required

Responses

HTTP
Description Schema
Code

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 41 of 135

Type Name

oauth2 oauth2_client_credentials

3.3.2. Get all subgroups of a customergroup.

GET /{baseSiteId}/customergroups

Description
Returns all customer groups that are direct subgroups of a customergroup.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

currentPage
Query Current page number (starts with 0). integer(int32) "0"
optional

fields Response configuration (list of fields, which should be enum (BASIC,

Query "BASIC"
optional returned in response) DEFAULT, FULL)

pageSize
Query Number of customer group returned in one page. integer(int32) "20"
optional

Responses

HTTP
Description Schema
Code

200 OK UserGroupListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 42 of 135

3.3.3. Get a specific customer group.

GET /{baseSiteId}/customergroups/{groupId}

Description
Returns a customer group with a specific groupId.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

groupId
Path Group identifier. string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "BASIC"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK UserGroupWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.3.4. Sets members for a user group.

PUT /{baseSiteId}/customergroups/{groupId}/members

Description
Sets members for a user group. The list of existing members is overwritten with a new one.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 43 of 135

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

groupId
Path Group identifier. string
required

members
Body List of users to set for customer group. MemberListWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.3.5. Assigns user(s) to a customer group.

PATCH /{baseSiteId}/customergroups/{groupId}/members

Description
Assigns user(s) to a customer group.

Parameters

Type Name Description Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 44 of 135

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

groupId
Path Group identifier. string
required

members
Body List of users to assign to customer group. MemberListWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.3.6. Delete a user from a customer group.

DELETE /{baseSiteId}/customergroups/{groupId}/members/{userId}

Description
Removes user from a customer group.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 45 of 135

Type Name Description Schema

groupId
Path Group identifier. string
required

userId
Path User identifier. string
required

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.4. Export
Export Controller

3.4.1. Get a list of product exports.

GET /{baseSiteId}/export/products

Description
Used for product export. Depending on the timestamp parameter, it can return all products or only products modified after the
given time.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 46 of 135

Type Name Description Schema Default

catalog Catalog from which get products. Must be provided

Query string
optional along with version.

currentPage
Query The current result page requested. integer(int32) "0"
optional

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

pageSize
Query The number of results returned per page. integer(int32) "20"
optional

When this parameter is set, only products modified

timestamp
Query after given time will be returned. This parameter string
optional
should be in ISO-8601 format.

version
Query Catalog version. Must be provided along with catalog. string
optional

Responses

HTTP
Description Schema
Code

200 OK ProductListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.5. Feeds
Feeds Controller

3.5.1. Get a list of orders with status updates

GET /{baseSiteId}/feeds/orders/statusfeed

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 47 of 135

Description
Returns the orders the status has changed for. Returns only the elements from the current baseSite, updated after the provided
timestamp.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Only items newer than the given parameter are

timestamp
Query retrieved. This parameter should be in ISO-8601 string
required
format.

Responses

HTTP
Description Schema
Code

200 OK OrderStatusUpdateElementListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.6. Forgotten Passwords

Forgotten Passwords Controller

3.6.1. Generates a token to restore customer’s forgotten password.

POST /{baseSiteId}/forgottenpasswordtokens

Description
Generates a token to restore customer’s forgotten password.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 48 of 135

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId
Query Customer’s user id. Customer user id is case insensitive. string
required

Responses

HTTP
Description Schema
Code

201 Created No Content

202 Accepted No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.7. Miscs
Miscs Controller

3.7.1. Get a list of supported payment card types.

GET /{baseSiteId}/cardtypes

Description
Lists supported payment card types.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 49 of 135

Type Name Description Schema Default

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CardTypeListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.7.2. Get a list of available currencies.

GET /{baseSiteId}/currencies

Description
Lists all available currencies (all usable currencies for the current store).If the list of currencies for stores is empty, a list of all
currencies available in the system is returned.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 50 of 135

HTTP
Description Schema
Code

200 OK CurrencyListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.7.3. Get a list of supported countries.

GET /{baseSiteId}/deliverycountries

Description
Lists all supported delivery countries for the current store. The list is sorted alphabetically.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK CountryListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 51 of 135

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.7.4. Get a list of available languages.

GET /{baseSiteId}/languages

Description
Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of
all languages available in the system will be returned.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK LanguageListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 52 of 135

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.7.5. Get a list of all localized titles.

GET /{baseSiteId}/titles

Description
Lists all localized titles.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK TitleListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.8. Orders
Orders Controller

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 53 of 135

3.8.1. Get a order

GET /{baseSiteId}/orders/{code}

Description
Returns details of a specific order based on order GUID (Globally Unique Identifier) or order CODE. The response contains a
detailed order information.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

code Order GUID (Globally Unique Identifier) or order

Path string
required CODE

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK OrderWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.8.2. Post a order

POST /{baseSiteId}/users/{userId}/orders

Description
Authorizes cart and places the order. Response contains the new order data.

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 54 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

cartId Cart code for logged in user, cart GUID for guest
Query string
required checkout

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

securityCode
Query CCV security code. string
optional

Responses

HTTP
Description Schema
Code

201 Created OrderWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.8.3. Get order history for user

GET /{baseSiteId}/users/{userId}/orders

Description
Returns order history data for all orders placed by the specific user for the specific base store. Response contains orders search
result displayed in several pages if needed.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 55 of 135

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

currentPage
Query The current result page requested. integer(int32) "0"
optional

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

pageSize
Query The number of results returned per page. integer(int32) "20"
optional

sort
Query Sorting method applied to the return results. string
optional

Filters only certain order statuses. It means:

statuses statuses=CANCELLED,CHECKED_VALID would only
Query string
optional return orders with status CANCELLED or
CHECKED_VALID.

Responses

HTTP
Description Schema
Code

200 OK OrderHistoryListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 56 of 135

3.8.4. Get total number of orders

HEAD /{baseSiteId}/users/{userId}/orders

Description
Returns X-Total-Count header with a total number of results (orders history for all orders placed by the specific user for the
specific base store).

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Filters only certain order statuses. It means:

statuses
Query statuses=CANCELLED,CHECKED_VALID would only return string
optional
orders with status CANCELLED or CHECKED_VALID.

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.8.5. Get a order

GET /{baseSiteId}/users/{userId}/orders/{code}

Description

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 57 of 135

Returns specific order details based on a specific order code. The response contains detailed order information.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

code Order GUID (Globally Unique Identifier) or order

Path string
required CODE

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK OrderWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9. Products
Products Controller

3.9.1. Get products added to the express update feed

GET /{baseSiteId}/products/expressupdate

Description

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 58 of 135

Returns products added to the express update feed. Returns only elements updated after the provided timestamp. The queue is
cleared using a defined cronjob.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

catalog Only products from this catalog are returned. Format:

Query string
optional catalogId:catalogVersion

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Only items newer than the given parameter are

timestamp
Query retrieved from the queue. This parameter should be in string
required
ISO-8601 format.

Responses

HTTP
Description Schema
Code

200 OK ProductExpressUpdateElementListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.9.2. Get a list of products and additional data

GET /{baseSiteId}/products/search

Description
Returns a list of products and additional data such as: available facets, available sorting and pagination options.It can include
spelling suggestions. To make spelling suggestions work you need to: 1. Make sure enableSpellCheck on the SearchQuery is set to
true. By default it should be already set to true. 2. Have indexed properties configured to be used for spellchecking.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 59 of 135

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

currentPage integer
Query The current result page requested. "0"
optional (int32)

fields
Query The context to be used in the search query. string "DEFAULT"
optional

pageSize integer
Query The number of results returned per page. "20"
optional (int32)

Serialized query, free text search, facets. The format of a

query
Query serialized query: string
optional
freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

searchQueryContext
Query searchQueryContext string
optional

enum
sort Response configuration (list of fields, which should be returned (BASIC,
Query
optional in response) DEFAULT,
FULL)

Responses

HTTP
Description Schema
Code

200 OK ProductSearchPageWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 60 of 135

3.9.3. Get a header with total number of products

HEAD /{baseSiteId}/products/search

Description
Returns X-Total-Count header with total number of products satisfying a query. It doesn’t return HTTP body.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

Serialized query, free text search, facets. The format of a

query
Query serialized query: string
optional
freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.4. Get a list of available suggestions

GET /{baseSiteId}/products/suggestions

Description
Returns a list of all available suggestions related to a given term and limits the results to a specific value of the max parameter.

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 61 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

max
Query Specifies the limit of results. integer(int32) "10"
required

term
Query Specified term string
required

Responses

HTTP
Description Schema
Code

200 OK SuggestionListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.5. Get product details

GET /{baseSiteId}/products/{productCode}

Description
Returns details of a single product according to a product code.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 62 of 135

Type Name Description Schema Default

productCode
Path Product identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK ProductWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.6. Get a product reference

GET /{baseSiteId}/products/{productCode}/references

Description
Returns references for a product with a given product code. Reference type specifies which references to return.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

fields Response configuration (list of fields, which should enum (BASIC,

Query "DEFAULT"
optional be returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 63 of 135

Type Name Description Schema Default

pageSize
Query Maximum size of returned results. integer(int32) "2147483647"
optional

referenceType Reference type according to enum

Query string
required ProductReferenceTypeEnum

Responses

HTTP
Description Schema
Code

200 OK ProductReferenceListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.9.7. Creates a new customer review as an anonymous user

POST /{baseSiteId}/products/{productCode}/reviews

Description
Creates a new customer review as an anonymous user.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 64 of 135

Type Name Description Schema Default

review Object contains review details like : rating, alias,

Body ReviewWsDTO
required headline, comment

Responses

HTTP
Description Schema
Code

201 Created ReviewWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.8. Get reviews for a product

GET /{baseSiteId}/products/{productCode}/reviews

Description
Returns the reviews for a product with a given product code.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 65 of 135

Type Name Description Schema Default

maxCount
Query Maximum count of reviews integer(int32)
optional

Responses

HTTP
Description Schema
Code

200 OK ReviewListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.9. Get a product’s stock level

GET /{baseSiteId}/products/{productCode}/stock

Description
Returns product’s stock levels sorted by distance from specific location passed by free-text parameter or longitude and latitude
parameters. The following two sets of parameters are available: location (required), currentPage (optional), pageSize (optional)
or longitude (required), latitude (required), currentPage (optional), pageSize(optional).

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

currentPage
Query The current result page requested. integer(int32) "0"
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 66 of 135

Type Name Description Schema Default

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

latitude
Query Latitude location parameter. number(double)
optional

location
Query Free-text location string
optional

longitude
Query Longitude location parameter. number(double)
optional

pageSize
Query The number of results returned per page. integer(int32) "20"
optional

Responses

HTTP
Description Schema
Code

200 OK StoreFinderStockSearchPageWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.10. Get header with a total number of product’s stock levels

HEAD /{baseSiteId}/products/{productCode}/stock

Description
Returns X-Total-Count header with a total number of product’s stock levels. It does not return the HTTP body. The following two
sets of parameters are available: 1. location (required) or 2. longitude (required), latitude (required).

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 67 of 135

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

latitude
Query Latitude location parameter. number(double)
optional

location
Query Free-text location string
optional

longitude
Query Longitude location parameter. number(double)
optional

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.9.11. Get a product’s stock level for a store

GET /{baseSiteId}/products/{productCode}/stock/{storeName}

Description
Returns product’s stock level for a particular store (POS).

Parameters

Type Name Description Schema Default

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 68 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

productCode
Path Product identifier string
required

storeName
Path Store identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK StockWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.10. Promotions
Promotions Controller

3.10.1. Get a list of promotions

GET /{baseSiteId}/promotions

Description
Returns promotions defined for a current base site. Requests pertaining to promotions have been developed for the previous
version of promotions and vouchers and therefore some of them are currently not compatible with the new promotion engine.

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 69 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "BASIC"
optional returned in response) DEFAULT, FULL)

promotionGroup
Query Only promotions from this group are returned string
optional

Defines what type of promotions should be returned.

Values supported for that parameter are:<ul><li>all:
type All available promotions are enum (all, product,
Query
required returned</li><li>product: Only product promotions order)
are returned</li><li>order: Only order promotions
are returned</li></ul>

Responses

HTTP
Description Schema
Code

200 OK PromotionListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.10.2. Get a promotion based on code

GET /{baseSiteId}/promotions/{code}

Description
Returns details of a single promotion specified by a promotion code. Requests pertaining to promotions have been developed for
the previous version of promotions and vouchers and therefore some of them are currently not compatible with the new
promotion engine.

Parameters

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 70 of 135

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

code
Path Promotion identifier (code) string
optional

fields Response configuration (list of fields, which should be enum (BASIC,

Query "BASIC"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK PromotionWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

3.11. Save Cart

Save Cart Controller

3.11.1. Explicitly clones a cart.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart

Description
Explicitly clones a cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 71 of 135

Type Name Description Schema Default

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

description The description that should be applied to the cloned

Query string
optional cart.

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

name
Query The name that should be applied to the cloned cart. string
optional

Responses

HTTP
Description Schema
Code

200 OK SaveCartResultWsDTO

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.11.2. Flag a cart for deletion.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion

Description

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 72 of 135

Flags a cart for deletion (the cart doesn’t have corresponding save cart attributes anymore). The cart is not actually deleted from
the database. But with the removal of the saved cart attributes, this cart will be taken care of by the cart removal job just like
any other cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK SaveCartResultWsDTO

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.11.3. Restore a saved cart.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart

Description

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 73 of 135

Restore a saved cart.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK SaveCartResultWsDTO

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.11.4. Explicitly saves a cart.

PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save

Description
Explicitly saves a cart.

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 74 of 135

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should enum (BASIC,

Query "DEFAULT"
optional be returned in response) DEFAULT, FULL)

saveCartDescription The description that should be applied to the saved

Query string
optional cart.

saveCartName
Query The name that should be applied to the saved cart. string
optional

Responses

HTTP
Description Schema
Code

200 OK SaveCartResultWsDTO

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.11.5. Get a saved cart.

GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 75 of 135

Description
Returns saved cart by it id for authenticated user.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

Cart identifier: cart code for logged in user, cart guid

cartId
Path for anonymous user, 'current' for the last modified string
required
cart

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK SaveCartResultWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.12. Stores
Stores Controller

3.12.1. Get a list of store locations

GET /{baseSiteId}/stores

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 76 of 135

Description
Lists all store locations that are near the location specified in a query or based on latitude and longitude.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

accuracy
Query Accuracy in meters. number(double) "0.0"
optional

currentPage
Query The current result page requested. integer(int32) "0"
optional

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

latitude Coordinate that specifies the north-south position of a

Query number(double)
optional point on the Earth’s surface.

longitude Coordinate that specifies the east-west position of a

Query number(double)
optional point on the Earth’s surface.

pageSize
Query The number of results returned per page. integer(int32) "20"
optional

query
Query Location in natural language i.e. city or country. string
optional

radius Radius in meters. Max value: 40075000.0 (Earth’s

Query number(double) "100000.0"
optional perimeter).

sort
Query Sorting method applied to the return results. string "asc"
optional

Responses

HTTP
Description Schema
Code

200 OK StoreFinderSearchPageWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 77 of 135

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.12.2. Get a header with the number of store locations

HEAD /{baseSiteId}/stores

Description
Returns X-Total-Count header with the number of all store locations that are near the location specified in a query, or based on
latitude and longitude.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

accuracy
Query Accuracy in meters. number(double) "0.0"
optional

latitude Coordinate that specifies the north-south position of a

Query number(double)
optional point on the Earth’s surface.

longitude Coordinate that specifies the east-west position of a

Query number(double)
optional point on the Earth’s surface.

query
Query Location in natural language i.e. city or country. string
optional

radius Radius in meters. Max value: 40075000.0 (Earth’s

Query number(double) "100000.0"
optional perimeter).

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 78 of 135

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.12.3. Get a store location

GET /{baseSiteId}/stores/{storeId}

Description
Returns store location based on its unique name.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

storeId
Path Store identifier (currently store name) string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK PointOfServiceWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 79 of 135

Type Name

oauth2 oauth2_client_credentials

3.13. Users
Users Controller

3.13.1. Registers a customer

POST /{baseSiteId}/users

Description
Registers a customer. The following two sets of parameters are available: First set is used to register a customer. In this case the
required parameters are: login, password, firstName, lastName, titleCode. Second set is used to convert a guest to a customer. In
this case the required parameters are: guid, password.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

user
Body User’s object. UserSignUpWsDTO
required

Responses

HTTP
Description Schema
Code

201 Created UserWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 80 of 135

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.2. Get customer profile

GET /{baseSiteId}/users/{userId}

Description
Returns customer profile.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK UserWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 81 of 135

3.13.3. Updates customer profile

PUT /{baseSiteId}/users/{userId}

Description
Updates customer profile. Attributes not provided in the request body will be defined again (set to null or default).

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

user
Body User’s object UserWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.4. Delete customer profile

DELETE /{baseSiteId}/users/{userId}

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 82 of 135

Description
Removes customer profile.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.5. Updates customer profile

PATCH /{baseSiteId}/users/{userId}

Description
Updates customer profile. Only attributes provided in the request body will be changed.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 83 of 135

Type Name Description Schema

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

user
Body User’s object. UserWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.6. Created a new address.

POST /{baseSiteId}/users/{userId}/addresses

Description
Created a new address.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 84 of 135

Type Name Description Schema Default

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

address
Body Address object. AddressWsDTO
required

Responses

HTTP
Description Schema
Code

201 Created AddressWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.7. Get customer’s addresses

GET /{baseSiteId}/users/{userId}/addresses

Description
Returns customer’s addresses.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 85 of 135

Type Name Description Schema Default

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK AddressListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.8. Verifies address

POST /{baseSiteId}/users/{userId}/addresses/verification

Description
Verifies address.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 86 of 135

Type Name Description Schema Default

address
Body Address object. AddressWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK AddressValidationWsDTO

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.9. Get info about address

GET /{baseSiteId}/users/{userId}/addresses/{addressId}

Description
Returns detailed information about address with a given id.

Parameters

Type Name Description Schema Default

addressId
Path Address identifier. string
required

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 87 of 135

Type Name Description Schema Default

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

200 OK AddressWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.10. Updates the address

PUT /{baseSiteId}/users/{userId}/addresses/{addressId}

Description
Updates the address. Attributes not provided in the request will be defined again (set to null or default).

Parameters

Type Name Description Schema

addressId
Path Address identifier. string
required

baseSiteId
Path Base site identifier string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 88 of 135

Type Name Description Schema

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

address
Body Address object. AddressWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.11. Delete customer’s address

DELETE /{baseSiteId}/users/{userId}/addresses/{addressId}

Description
Removes customer’s address.

Parameters

Type Name Description Schema

addressId
Path Address identifier. string
required

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 89 of 135

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.12. Updates the address

PATCH /{baseSiteId}/users/{userId}/addresses/{addressId}

Description
Updates the address. Only attributes provided in the request body will be changed.

Parameters

Type Name Description Schema

addressId
Path Address identifier. string
required

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 90 of 135

Type Name Description Schema

address
Body Address object AddressWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.13. Get all customer groups of a customer.

GET /{baseSiteId}/users/{userId}/customergroups

Description
Returns all customer groups of a customer.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 91 of 135

Responses

HTTP
Description Schema
Code

200 OK UserGroupListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.14. Changes customer’s login

PUT /{baseSiteId}/users/{userId}/login

Description
Changes customer’s login.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

newLogin
Query Customer’s new login. Customer login is case insensitive. string
required

password
Query Customer’s current password. string
required

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 92 of 135

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.15. Changes customer’s password

PUT /{baseSiteId}/users/{userId}/password

Description
Changes customer’s password.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

new
Query New password. string
required

old
Query Old password. Required only for ROLE_CUSTOMERGROUP string
optional

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 93 of 135

HTTP
Description Schema
Code

201 Created No Content

202 Accepted No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.16. Get customer’s credit card payment details list.

GET /{baseSiteId}/users/{userId}/paymentdetails

Description
Return customer’s credit card payment details list.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should be enum (BASIC,

Query "DEFAULT"
optional returned in response) DEFAULT, FULL)

saved
Query Type of payment details. boolean "false"
required

Responses

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 94 of 135

HTTP
Description Schema
Code

200 OK PaymentDetailsListWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.17. Get customer’s credit card payment details.

GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description
Returns customer’s credit card payment details for a given id.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

paymentDetailsId
Path Payment details identifier. string
required

User identifier or one of the literals : 'current' for

userId
Path currently authenticated user, 'anonymous' for string
required
anonymous user

fields Response configuration (list of fields, which should enum (BASIC,

Query "DEFAULT"
optional be returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 95 of 135

HTTP
Description Schema
Code

200 OK PaymentDetailsWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.18. Updates existing customer’s credit card payment info.

PUT /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description
Updates existing customer’s credit card payment info based on the payment info ID. Attributes not given in request will be
defined again (set to null or default).

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

paymentDetailsId
Path Payment details identifier. string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

paymentDetails
Body Payment details object. PaymentDetailsWsDTO
required

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 96 of 135

HTTP
Description Schema
Code

200 OK No Content

201 Created No Content

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.19. Delete customer’s credit card payment details.

DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description
Removes customer’s credit card payment details based on its ID.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

paymentDetailsId
Path Payment details identifier. string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 97 of 135

HTTP
Description Schema
Code

200 OK No Content

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.13.20. Updates existing customer’s credit card payment details.

PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}

Description
Updates existing customer’s credit card payment details based on its ID. Only attributes given in request will be changed.

Parameters

Type Name Description Schema

baseSiteId
Path Base site identifier string
required

paymentDetailsId
Path Payment details identifier. string
required

userId User identifier or one of the literals : 'current' for currently

Path string
required authenticated user, 'anonymous' for anonymous user

paymentDetails
Body Payment details object PaymentDetailsWsDTO
required

Responses

HTTP
Description Schema
Code

200 OK No Content

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 98 of 135

HTTP
Description Schema
Code

204 No Content No Content

401 Unauthorized No Content

403 Forbidden No Content

Consumes
• application/xml

• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_Password

oauth2 oauth2_client_credentials

3.14. Vouchers
Vouchers Controller

3.14.1. Get a voucher based on code

GET /{baseSiteId}/vouchers/{code}

Description
Returns details of a single voucher according to a voucher code.

Parameters

Type Name Description Schema Default

baseSiteId
Path Base site identifier string
required

code
Path Voucher identifier (code) string
required

fields Response configuration (list of fields, which should be enum (BASIC,

Query "BASIC"
optional returned in response) DEFAULT, FULL)

Responses

HTTP
Description Schema
Code

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 99 of 135

HTTP
Description Schema
Code

200 OK VoucherWsDTO

401 Unauthorized No Content

403 Forbidden No Content

404 Not Found No Content

Consumes
• application/json

Produces
• application/xml

• application/json

Security

Type Name

oauth2 oauth2_client_credentials

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 100 of 135

4. Definitions
4.1. AddressListWsDTO
Name Schema

addresses
< AddressWsDTO > array
optional

4.2. AddressValidationWsDTO
Name Schema

decision
string
optional

errors
errorList
optional

suggestedAddresses
< AddressWsDTO > array
optional

4.3. AddressWsDTO
Name Schema

companyName
string
optional

country
CountryWsDTO
optional

defaultAddress
boolean
optional

email
string
optional

firstName
string
optional

formattedAddress
string
optional

id
string
optional

lastName
string
optional

line1
string
optional

line2
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 101 of 135

Name Schema

phone
string
optional

postalCode
string
optional

region
RegionWsDTO
optional

shippingAddress
boolean
optional

title
string
optional

titleCode
string
optional

town
string
optional

visibleInAddressBook
boolean
optional

4.4. BaseOptionWsDTO
Name Schema

options
< VariantOptionWsDTO > array
optional

selected
VariantOptionWsDTO
optional

variantType
string
optional

4.5. BreadcrumbWsDTO
Name Schema

facetCode
string
optional

facetName
string
optional

facetValueCode
string
optional

facetValueName
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 102 of 135

Name Schema

removeQuery
SearchStateWsDTO
optional

truncateQuery
SearchStateWsDTO
optional

4.6. CardTypeListWsDTO
Name Schema

cardTypes
< CardTypeWsDTO > array
optional

4.7. CardTypeWsDTO
Name Schema

code
string
optional

name
string
optional

4.8. CartListWsDTO
Name Schema

carts
< CartWsDTO > array
optional

4.9. CartModificationWsDTO
Name Schema

deliveryModeChanged
boolean
optional

entry
OrderEntryWsDTO
optional

quantity
integer(int64)
optional

quantityAdded
integer(int64)
optional

statusCode
string
optional

statusMessage
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 103 of 135

4.10. CartWsDTO
Name Schema

appliedOrderPromotions
< PromotionResultWsDTO > array
optional

appliedProductPromotions
< PromotionResultWsDTO > array
optional

appliedVouchers
< VoucherWsDTO > array
optional

calculated
boolean
optional

code
string
optional

deliveryAddress
AddressWsDTO
optional

deliveryCost
PriceWsDTO
optional

deliveryItemsQuantity
integer(int64)
optional

deliveryMode
DeliveryModeWsDTO
optional

deliveryOrderGroups
< DeliveryOrderEntryGroupWsDTO > array
optional

description
string
optional

entries
< OrderEntryWsDTO > array
optional

expirationTime
string(date-time)
optional

guid
string
optional

name
string
optional

net
boolean
optional

orderDiscounts
PriceWsDTO
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 104 of 135

Name Schema

paymentInfo
PaymentDetailsWsDTO
optional

pickupItemsQuantity
integer(int64)
optional

pickupOrderGroups
< PickupOrderEntryGroupWsDTO > array
optional

potentialOrderPromotions
< PromotionResultWsDTO > array
optional

potentialProductPromotions
< PromotionResultWsDTO > array
optional

productDiscounts
PriceWsDTO
optional

saveTime
string(date-time)
optional

savedBy
PrincipalWsDTO
optional

site
string
optional

store
string
optional

subTotal
PriceWsDTO
optional

totalDiscounts
PriceWsDTO
optional

totalItems
integer(int32)
optional

totalPrice
PriceWsDTO
optional

totalPriceWithTax
PriceWsDTO
optional

totalTax
PriceWsDTO
optional

totalUnitCount
integer(int32)
optional

user
PrincipalWsDTO
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 105 of 135

4.11. CatalogListWsDTO
Name Schema

catalogs
< CatalogWsDTO > array
optional

4.12. CatalogVersionWsDTO
Name Schema

categories
< CategoryHierarchyWsDTO > array
optional

id
string
optional

lastModified
string(date-time)
optional

name
string
optional

url
string
optional

4.13. CatalogWsDTO
Name Schema

catalogVersions
< CatalogVersionWsDTO > array
optional

id
string
optional

lastModified
string(date-time)
optional

name
string
optional

url
string
optional

4.14. CategoryHierarchyWsDTO
Name Schema

id
string
optional

lastModified
string(date-time)
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 106 of 135

Name Schema

name
string
optional

subcategories
< CategoryHierarchyWsDTO > array
optional

url
string
optional

4.15. CategoryWsDTO
Name Schema

code
string
optional

image
ImageWsDTO
optional

url
string
optional

4.16. ClassificationWsDTO
Name Schema

code
string
optional

features
< FeatureWsDTO > array
optional

name
string
optional

4.17. ConsignmentEntryWsDTO
Name Schema

orderEntry
OrderEntryWsDTO
optional

quantity
integer(int64)
optional

shippedQuantity
integer(int64)
optional

4.18. ConsignmentWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 107 of 135

Name Schema

code
string
optional

deliveryPointOfService
PointOfServiceWsDTO
optional

entries
< ConsignmentEntryWsDTO > array
optional

shippingAddress
AddressWsDTO
optional

status
string
optional

statusDate
string(date-time)
optional

trackingID
string
optional

4.19. CountryListWsDTO
Name Schema

countries
< CountryWsDTO > array
optional

4.20. CountryWsDTO
Name Schema

isocode
string
optional

name
string
optional

4.21. CurrencyListWsDTO
Name Schema

currencies
< CurrencyWsDTO > array
optional

4.22. CurrencyWsDTO
Name Schema

active
boolean
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 108 of 135

Name Schema

isocode
string
optional

name
string
optional

symbol
string
optional

4.23. DeliveryModeListWsDTO
Name Schema

deliveryModes
< DeliveryModeWsDTO > array
optional

4.24. DeliveryModeWsDTO
Name Schema

code
string
optional

deliveryCost
PriceWsDTO
optional

description
string
optional

name
string
optional

4.25. DeliveryOrderEntryGroupWsDTO
Name Schema

deliveryAddress
AddressWsDTO
optional

entries
< OrderEntryWsDTO > array
optional

quantity
integer(int64)
optional

totalPriceWithTax
PriceWsDTO
optional

4.26. FacetValueWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 109 of 135

Name Schema

count
integer(int64)
optional

name
string
optional

query
SearchStateWsDTO
optional

selected
boolean
optional

4.27. FacetWsDTO
Name Schema

category
boolean
optional

multiSelect
boolean
optional

name
string
optional

priority
integer(int32)
optional

topValues
< FacetValueWsDTO > array
optional

values
< FacetValueWsDTO > array
optional

visible
boolean
optional

4.28. FeatureUnitWsDTO
Name Schema

name
string
optional

symbol
string
optional

unitType
string
optional

4.29. FeatureValueWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 110 of 135

Name Schema

value
string
optional

4.30. FeatureWsDTO
Name Schema

code
string
optional

comparable
boolean
optional

description
string
optional

featureUnit
FeatureUnitWsDTO
optional

featureValues
< FeatureValueWsDTO > array
optional

name
string
optional

range
boolean
optional

type
string
optional

4.31. FutureStockWsDTO
Name Schema

date
string(date-time)
optional

formattedDate
string
optional

stock
StockWsDTO
optional

4.32. GeoPointWsDTO
Name Schema

latitude
number(double)
optional

longitude
number(double)
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 111 of 135

Name Schema

4.33. ImageWsDTO
Name Schema

altText
string
optional

format
string
optional

galleryIndex
integer(int32)
optional

imageType
enum (PRIMARY, GALLERY)
optional

url
string
optional

4.34. LanguageListWsDTO
Name Schema

languages
< LanguageWsDTO > array
optional

4.35. LanguageWsDTO
Name Schema

active
boolean
optional

isocode
string
optional

name
string
optional

nativeName
string
optional

4.36. MemberListWsDTO
Name Schema

members
< PrincipalWsDTO > array
optional

4.37. OpeningScheduleWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 112 of 135

Name Schema

code
string
optional

name
string
optional

specialDayOpeningList
< SpecialOpeningDayWsDTO > array
optional

weekDayOpeningList
< WeekdayOpeningDayWsDTO > array
optional

4.38. OrderEntryListWsDTO
Name Schema

orderEntries
< OrderEntryWsDTO > array
optional

4.39. OrderEntryWsDTO
Name Schema

basePrice
PriceWsDTO
optional

deliveryMode
DeliveryModeWsDTO
optional

deliveryPointOfService
PointOfServiceWsDTO
optional

entryNumber
integer(int32)
optional

product
ProductWsDTO
optional

quantity
integer(int64)
optional

totalPrice
PriceWsDTO
optional

updateable
boolean
optional

4.40. OrderHistoryListWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 113 of 135

Name Schema

orders
< OrderHistoryWsDTO > array
optional

pagination
PaginationWsDTO
optional

sorts
< SortWsDTO > array
optional

4.41. OrderHistoryWsDTO
Name Schema

code
string
optional

guid
string
optional

placed
string(date-time)
optional

status
string
optional

statusDisplay
string
optional

total
PriceWsDTO
optional

4.42. OrderStatusUpdateElementListWsDTO
Name Schema

orderStatusUpdateElements
< OrderStatusUpdateElementWsDTO > array
optional

4.43. OrderStatusUpdateElementWsDTO
Name Schema

baseSiteId
string
optional

code
string
optional

status
string
optional

4.44. OrderWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 114 of 135

Name Schema

appliedOrderPromotions
< PromotionResultWsDTO > array
optional

appliedProductPromotions
< PromotionResultWsDTO > array
optional

appliedVouchers
< VoucherWsDTO > array
optional

calculated
boolean
optional

code
string
optional

consignments
< ConsignmentWsDTO > array
optional

created
string(date-time)
optional

deliveryAddress
AddressWsDTO
optional

deliveryCost
PriceWsDTO
optional

deliveryItemsQuantity
integer(int64)
optional

deliveryMode
DeliveryModeWsDTO
optional

deliveryOrderGroups
< DeliveryOrderEntryGroupWsDTO > array
optional

deliveryStatus
string
optional

deliveryStatusDisplay
string
optional

entries
< OrderEntryWsDTO > array
optional

guestCustomer
boolean
optional

guid
string
optional

net
boolean
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 115 of 135

Name Schema

orderDiscounts
PriceWsDTO
optional

paymentInfo
PaymentDetailsWsDTO
optional

pickupItemsQuantity
integer(int64)
optional

pickupOrderGroups
< PickupOrderEntryGroupWsDTO > array
optional

productDiscounts
PriceWsDTO
optional

site
string
optional

status
string
optional

statusDisplay
string
optional

store
string
optional

subTotal
PriceWsDTO
optional

totalDiscounts
PriceWsDTO
optional

totalItems
integer(int32)
optional

totalPrice
PriceWsDTO
optional

totalPriceWithTax
PriceWsDTO
optional

totalTax
PriceWsDTO
optional

unconsignedEntries
< OrderEntryWsDTO > array
optional

user
PrincipalWsDTO
optional

4.45. PaginationWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 116 of 135

Name Schema

currentPage
integer(int32)
optional

pageSize
integer(int32)
optional

sort
string
optional

totalPages
integer(int32)
optional

totalResults
integer(int64)
optional

4.46. PaymentDetailsListWsDTO
Name Schema

payments
< PaymentDetailsWsDTO > array
optional

4.47. PaymentDetailsWsDTO
Name Schema

accountHolderName
string
optional

billingAddress
AddressWsDTO
optional

cardNumber
string
optional

cardType
CardTypeWsDTO
optional

defaultPayment
boolean
optional

expiryMonth
string
optional

expiryYear
string
optional

id
string
optional

issueNumber
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 117 of 135

Name Schema

saved
boolean
optional

startMonth
string
optional

startYear
string
optional

subscriptionId
string
optional

4.48. PickupOrderEntryGroupWsDTO
Name Schema

deliveryPointOfService
PointOfServiceWsDTO
optional

distance
number(double)
optional

entries
< OrderEntryWsDTO > array
optional

quantity
integer(int64)
optional

totalPriceWithTax
PriceWsDTO
optional

4.49. PointOfServiceStockWsDTO
Name Schema

address
AddressWsDTO
optional

description
string
optional

displayName
string
optional

distanceKm
number(double)
optional

features
< string, string > map
optional

formattedDistance
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 118 of 135

Name Schema

geoPoint
GeoPointWsDTO
optional

mapIcon
ImageWsDTO
optional

name
string
optional

openingHours
OpeningScheduleWsDTO
optional

stockInfo
StockWsDTO
optional

storeContent
string
optional

storeImages
< ImageWsDTO > array
optional

url
string
optional

4.50. PointOfServiceWsDTO
Name Schema

address
AddressWsDTO
optional

description
string
optional

displayName
string
optional

distanceKm
number(double)
optional

features
< string, string > map
optional

formattedDistance
string
optional

geoPoint
GeoPointWsDTO
optional

mapIcon
ImageWsDTO
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 119 of 135

Name Schema

name
string
optional

openingHours
OpeningScheduleWsDTO
optional

storeContent
string
optional

storeImages
< ImageWsDTO > array
optional

url
string
optional

4.51. PriceRangeWsDTO
Name Schema

maxPrice
PriceWsDTO
optional

minPrice
PriceWsDTO
optional

4.52. PriceWsDTO
Name Schema

currencyIso
string
optional

formattedValue
string
optional

maxQuantity
integer(int64)
optional

minQuantity
integer(int64)
optional

priceType
enum (BUY, FROM)
optional

value
number
optional

4.53. PrincipalWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 120 of 135

Name Schema

name
string
optional

uid
string
optional

4.54. ProductExpressUpdateElementListWsDTO
Name Schema

productExpressUpdateElements
< ProductExpressUpdateElementWsDTO > array
optional

4.55. ProductExpressUpdateElementWsDTO
Name Schema

catalogId
string
optional

catalogVersion
string
optional

code
string
optional

4.56. ProductListWsDTO
Name Schema

catalog
string
optional

currentPage
integer(int32)
optional

products
< ProductWsDTO > array
optional

totalPageCount
integer(int32)
optional

totalProductCount
integer(int32)
optional

version
string
optional

4.57. ProductReferenceListWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 121 of 135

Name Schema

references
< ProductReferenceWsDTO > array
optional

4.58. ProductReferenceWsDTO
Name Schema

description
string
optional

preselected
boolean
optional

quantity
integer(int32)
optional

referenceType
string
optional

target
ProductWsDTO
optional

4.59. ProductSearchPageWsDTO
Name Schema

breadcrumbs
< BreadcrumbWsDTO > array
optional

categoryCode
string
optional

currentQuery
SearchStateWsDTO
optional

facets
< FacetWsDTO > array
optional

freeTextSearch
string
optional

keywordRedirectUrl
string
optional

pagination
PaginationWsDTO
optional

products
< ProductWsDTO > array
optional

sorts
< SortWsDTO > array
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 122 of 135

Name Schema

spellingSuggestion
SpellingSuggestionWsDTO
optional

4.60. ProductWsDTO
Name Schema

availableForPickup
boolean
optional

averageRating
number(double)
optional

baseOptions
< BaseOptionWsDTO > array
optional

baseProduct
string
optional

categories
< CategoryWsDTO > array
optional

classifications
< ClassificationWsDTO > array
optional

code
string
optional

description
string
optional

futureStocks
< FutureStockWsDTO > array
optional

images
< ImageWsDTO > array
optional

manufacturer
string
optional

multidimensional
boolean
optional

name
string
optional

numberOfReviews
integer(int32)
optional

potentialPromotions
< PromotionWsDTO > array
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 123 of 135

Name Schema

price
PriceWsDTO
optional

priceRange
PriceRangeWsDTO
optional

productReferences
< ProductReferenceWsDTO > array
optional

purchasable
boolean
optional

reviews
< ReviewWsDTO > array
optional

stock
StockWsDTO
optional

summary
string
optional

url
string
optional

variantMatrix
< VariantMatrixElementWsDTO > array
optional

variantOptions
< VariantOptionWsDTO > array
optional

variantType
string
optional

volumePrices
< PriceWsDTO > array
optional

volumePricesFlag
boolean
optional

4.61. PromotionListWsDTO
Name Schema

promotions
< PromotionWsDTO > array
optional

4.62. PromotionOrderEntryConsumedWsDTO
Name Schema

adjustedUnitPrice
number(double)
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 124 of 135

Name Schema

code
string
optional

orderEntryNumber
integer(int32)
optional

quantity
integer(int64)
optional

4.63. PromotionRestrictionWsDTO
Name Schema

description
string
optional

restrictionType
string
optional

4.64. PromotionResultListWsDTO
Name Schema

promotions
< PromotionResultWsDTO > array
optional

4.65. PromotionResultWsDTO
Name Schema

consumedEntries
< PromotionOrderEntryConsumedWsDTO > array
optional

description
string
optional

promotion
PromotionWsDTO
optional

4.66. PromotionWsDTO
Name Schema

code
string
optional

couldFireMessages
< string > array
optional

description
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 125 of 135

Name Schema

enabled
boolean
optional

endDate
string(date-time)
optional

firedMessages
< string > array
optional

priority
integer(int32)
optional

productBanner
ImageWsDTO
optional

promotionGroup
string
optional

promotionType
string
optional

restrictions
< PromotionRestrictionWsDTO > array
optional

startDate
string(date-time)
optional

title
string
optional

4.67. RegionWsDTO
Name Schema

countryIso
string
optional

isocode
string
optional

isocodeShort
string
optional

name
string
optional

4.68. ReviewListWsDTO
Name Schema

reviews
< ReviewWsDTO > array
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 126 of 135

4.69. ReviewWsDTO
Name Schema

alias
string
optional

comment
string
optional

date
string(date-time)
optional

headline
string
optional

id
string
optional

principal
UserWsDTO
optional

rating
number(double)
optional

4.70. SaveCartResultWsDTO
Name Schema

savedCartData
CartWsDTO
optional

4.71. SearchQueryWsDTO
Name Schema

value
string
optional

4.72. SearchStateWsDTO
Name Schema

query
SearchQueryWsDTO
optional

url
string
optional

4.73. SortWsDTO
Name Schema

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 127 of 135

Name Schema

code
string
optional

name
string
optional

selected
boolean
optional

4.74. SpecialOpeningDayWsDTO
Name Schema

closed
boolean
optional

closingTime
TimeWsDTO
optional

comment
string
optional

date
string(date-time)
optional

formattedDate
string
optional

name
string
optional

openingTime
TimeWsDTO
optional

4.75. SpellingSuggestionWsDTO
Name Schema

query
string
optional

suggestion
string
optional

4.76. StockWsDTO
Name Schema

stockLevel
integer(int64)
optional

stockLevelStatus
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 128 of 135

Name Schema

4.77. StoreFinderSearchPageWsDTO
Name Schema

boundEastLongitude
number(double)
optional

boundNorthLatitude
number(double)
optional

boundSouthLatitude
number(double)
optional

boundWestLongitude
number(double)
optional

locationText
string
optional

pagination
PaginationWsDTO
optional

sorts
< SortWsDTO > array
optional

sourceLatitude
number(double)
optional

sourceLongitude
number(double)
optional

stores
< PointOfServiceWsDTO > array
optional

4.78. StoreFinderStockSearchPageWsDTO
Name Schema

boundEastLongitude
number(double)
optional

boundNorthLatitude
number(double)
optional

boundSouthLatitude
number(double)
optional

boundWestLongitude
number(double)
optional

locationText
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 129 of 135

Name Schema

pagination
PaginationWsDTO
optional

product
ProductWsDTO
optional

sorts
< SortWsDTO > array
optional

sourceLatitude
number(double)
optional

sourceLongitude
number(double)
optional

stores
< PointOfServiceStockWsDTO > array
optional

4.79. SuggestionListWsDTO
Name Schema

suggestions
< SuggestionWsDTO > array
optional

4.80. SuggestionWsDTO
Name Schema

value
string
optional

4.81. TimeWsDTO
Name Schema

formattedHour
string
optional

hour
string(byte)
optional

minute
string(byte)
optional

4.82. TitleListWsDTO
Name Schema

titles
< TitleWsDTO > array
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 130 of 135

4.83. TitleWsDTO
Name Schema

code
string
optional

name
string
optional

4.84. UserGroupListWsDTO
Name Schema

currentPage
integer(int32)
optional

numberOfPages
integer(int32)
optional

pageSize
integer(int32)
optional

totalNumber
integer(int32)
optional

userGroups
< UserGroupWsDTO > array
optional

4.85. UserGroupWsDTO
Name Schema

members
< PrincipalWsDTO > array
optional

membersCount
integer(int32)
optional

name
string
optional

subGroups
< UserGroupWsDTO > array
optional

uid
string
optional

4.86. UserSignUpWsDTO
Name Schema

firstName
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 131 of 135

Name Schema

lastName
string
optional

password
string
optional

titleCode
string
optional

uid
string
optional

4.87. UserWsDTO
Name Schema

currency
CurrencyWsDTO
optional

customerId
string
optional

deactivationDate
string(date-time)
optional

defaultAddress
AddressWsDTO
optional

displayUid
string
optional

firstName
string
optional

language
LanguageWsDTO
optional

lastName
string
optional

name
string
optional

title
string
optional

titleCode
string
optional

uid
string
optional

4.88. VariantCategoryWsDTO

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 132 of 135

Name Schema

hasImage
boolean
optional

name
string
optional

priority
integer(int32)
optional

4.89. VariantMatrixElementWsDTO
Name Schema

elements
< VariantMatrixElementWsDTO > array
optional

isLeaf
boolean
optional

parentVariantCategory
VariantCategoryWsDTO
optional

variantOption
VariantOptionWsDTO
optional

variantValueCategory
VariantValueCategoryWsDTO
optional

4.90. VariantOptionQualifierWsDTO
Name Schema

image
ImageWsDTO
optional

name
string
optional

qualifier
string
optional

value
string
optional

4.91. VariantOptionWsDTO
Name Schema

code
string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 133 of 135

Name Schema

priceData
PriceWsDTO
optional

stock
StockWsDTO
optional

url
string
optional

variantOptionQualifiers
< VariantOptionQualifierWsDTO > array
optional

4.92. VariantValueCategoryWsDTO
Name Schema

name
string
optional

sequence
integer(int32)
optional

superCategories
< VariantCategoryWsDTO > array
optional

4.93. VoucherListWsDTO
Name Schema

vouchers
< VoucherWsDTO > array
optional

4.94. VoucherWsDTO
Name Schema

appliedValue
PriceWsDTO
optional

code
string
optional

currency
CurrencyWsDTO
optional

description
string
optional

freeShipping
boolean
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 134 of 135

Name Schema

name
string
optional

value
number(double)
optional

valueFormatted
string
optional

valueString
string
optional

voucherCode
string
optional

4.95. WeekdayOpeningDayWsDTO
Name Schema

closed
boolean
optional

closingTime
TimeWsDTO
optional

openingTime
TimeWsDTO
optional

weekDay
string
optional

4.96. error
Error message

Name Description Schema

exceptionMessage
string
optional

language
string
optional

message
Descriptive, human readable error message. string
optional

position
integer(int32)
optional

reason
Additional classification specific for each error type e.g. 'noStock'. string
optional

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15
Commerce Webservices V2 Page 135 of 135

Name Description Schema

subject
Identifier of the related object e.g. '1'. string
optional

subjectType
Type of the object related to the error e.g. 'entry'. string
optional

type
Type of the error e.g. 'LowStockError'. string
optional

4.97. errorList
List of errors

Name Schema

errors
< error > array
optional

Last updated 2017-11-16 10:53:20 -05:00

https://help.hybris.com/6.6.0/api/ycommercewebservices/index.html 30/05/15