1. Overview
Commerce Webservices Version 2
1.3. Tags
-
Address : Address Controller
-
Base Stores : Base Stores Controller
-
Carts : Carts Controller
-
Catalogs : Catalogs Controller
-
Component : Component Controller
-
Consents : Consents Controller
-
Countries : Countries Controller
-
Customer Groups : Customer Groups Controller
-
Export : Export Controller
-
Extended Carts : Extended Carts Controller
-
FSBundles : FS Configurable Bundle Controller
-
FSClaims : FS Claims Controller
-
FSInsurancePolicies : FS Insurance Policies Controller
-
FSInsuranceQuotes : FS Insurance Quotes Controller
-
Feeds : Feeds Controller
-
Forgotten Passwords : Forgotten Passwords Controller
-
Merchant Callback : Merchant Callback Controller
-
Miscs : Miscs Controller
-
Notification Preference : Notification Preference Controller
-
Orders : Orders Controller
-
Page : Page Controller
-
Payment Details : Payment Details Controller
-
Products : Products Controller
-
Promotions : Promotions Controller
-
Save Cart : Save Cart Controller
-
Site Messages : FS Site Message Controller
-
Stores : Stores Controller
-
Users : Users Controller
-
Vouchers : Vouchers Controller
3. Resources
3.1. Address
Address Controller
3.1.1. Creates a new address.
POST /{baseSiteId}/users/{userId}/addresses
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.1.2. Get customer’s addresses
GET /{baseSiteId}/users/{userId}/addresses
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.1.3. Verifies address
POST /{baseSiteId}/users/{userId}/addresses/verification
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.1.4. Get info about address
GET /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.1.5. 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 |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.1.6. Delete customer’s address
DELETE /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.1.7. Updates the address
PATCH /{baseSiteId}/users/{userId}/addresses/{addressId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
addressId |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.2. Base Stores
Base Stores Controller
3.2.1. Get a base store
GET /{baseSiteId}/basestores/{baseStoreUid}
Description
Returns details of a specific base store based on its identifier. The response contains detailed base store information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
baseStoreUid |
Base store name |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3. Carts
Carts Controller
3.3.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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
oldCartId |
Anonymous cart GUID. |
string |
|
Query |
toMergeCartGuid |
The GUID of the user’s cart that will be merged with the anonymous cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.2. Get all customer carts.
GET /{baseSiteId}/users/{userId}/carts
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
Optional pagination parameter in case of savedCartsOnly == true. Default value 0. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. |
integer(int32) |
|
Query |
savedCartsOnly |
Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. |
boolean |
|
Query |
sort |
Optional sort criterion in case of savedCartsOnly == true. No default value. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.3. Get a cart with a given identifier.
GET /{baseSiteId}/users/{userId}/carts/{cartId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.4. Deletes a cart with a given cart id.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.5. Creates a delivery address for the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
address |
Request body parameter that contains details such as the customer’s first name (firstName), the customer’s last name (lastName), the customer’s title (titleCode), the country (country.isocode), the first part of the address (line1), the second part of the address (line2), the town (town), the postal code (postalCode), and the region (region.isocode). |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.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 |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
addressId |
Address identifier |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.7. Delete the delivery address from the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/addresses/delivery
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.8. Get the delivery mode selected for the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.9. Sets the delivery mode for a cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
deliveryModeId |
Delivery mode identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.10. Delete the delivery mode from the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.11. Get all delivery modes for the current store and delivery address.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes
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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.12. Assigns an email to the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
email |
Email of the guest user. It will be used during the checkout process. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.13. Adds a product to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
entry |
Request body parameter that contains details such as the product code (product.code), the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name). |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.14. Get cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.15. Get the details of the cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.16. Set quantity and store details of a cart entry.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Description
Updates the quantity of a single cart entry and the details of the store where the cart entry will be picked up. Attributes not provided in request will be defined again (set to null or default)
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
entry |
Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.17. Deletes cart entry.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.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 the details of the store where the cart entry will be picked up.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer(int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
entry |
Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.19. Defines and assigns details of a new credit card payment to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
paymentDetails |
Request body parameter that contains details such as the name on the card (accountHolderName), the card number (cardNumber), the card type (cardType.code), the month of the expiry date (expiryMonth), the year of the expiry date (expiryYear), whether the payment details should be saved (saved), whether the payment details should be set as default (defaultPaymentInfo), and the billing address (billingAddress.firstName, billingAddress.lastName, billingAddress.titleCode, billingAddress.country.isocode, billingAddress.line1, billingAddress.line2, billingAddress.town, billingAddress.postalCode, billingAddress.region.isocode) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.20. Sets credit card payment details for the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
paymentDetailsId |
Payment details identifier. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.21. Enables promotions based on the promotionsId of the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
Description
Enables a 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 as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
promotionId |
Promotion identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.22. Get information about promotions applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
Description
Returns information about the promotions applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.23. Get information about promotions applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}
Description
Returns information about a promotion (with a specific promotionId), that has been applied on the cart. Requests pertaining to promotions have been developed for the previous version of promotions and vouchers, and as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
promotionId |
Promotion identifier (code) |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.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 as a result, some of them are currently not compatible with the new promotions engine.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
promotionId |
Promotion identifier (code) |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.3.25. Applies a voucher based on the voucherId defined for the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
voucherId |
Voucher identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.26. Get a list of vouchers applied to the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.3.27. Delete a voucher defined for the current cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Path |
voucherId |
Voucher identifier (code) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.4. Catalogs
Catalogs Controller
3.4.1. Get a list of catalogs
GET /{baseSiteId}/catalogs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.4.2. Get a catalog
GET /{baseSiteId}/catalogs/{catalogId}
Description
Returns information about a catalog based on its ID, along with the versions defined for the current base store.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.4.3. Get information about catalog version
GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.4.4. Get information about catagory in a catalog version
GET /{baseSiteId}/catalogs/{catalogId}/{catalogVersionId}/categories/{categoryId}
Description
Returns information about a specified category that exists in a catalog version available for the current base store.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Path |
categoryId |
Category identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.5. Component
Component Controller
3.5.1. Get components' data by id given in body
POST /{baseSiteId}/cms/components
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
catalogCode |
Catalog code |
string |
|
Query |
categoryCode |
Category code |
string |
|
Query |
currentPage |
Optional pagination parameter. Default value 0. |
integer(int32) |
|
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
Optional pagination parameter. Default value 10. |
integer(int32) |
|
Query |
productCode |
Product code |
string |
|
Query |
sort |
Optional sort criterion. No default value. |
string |
|
Body |
componentIdList |
List of Component identifiers |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.5.2. Get component data
GET /{baseSiteId}/cms/components/{componentId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
componentId |
Component identifier |
string |
|
Query |
catalogCode |
Catalog code |
string |
|
Query |
categoryCode |
Category code |
string |
|
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
enum (BASIC, DEFAULT, FULL) |
|
Query |
productCode |
Product code |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.6. Consents
Consents Controller
3.6.1. A user can give consent
POST /{baseSiteId}/users/{userId}/consents
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
consentTemplateId |
Consent template ID. |
string |
Query |
consentTemplateVersion |
Consent template version. |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.6.2. Withdraw the user consent for a given consent code
DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}
Description
If the user consent was given, the consent is withdrawn. If consent was already withdrawn then returns consent already withdrawn error. If there is no such consent then returns not found. If the current user is an anonymous user then returns access denied error.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
consentCode |
consentCode |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.6.3. Fetch the list of consents
GET /{baseSiteId}/users/{userId}/consenttemplates
Description
If user has not given or withdrawn consent to any of the template, no given or withdraw date is returned.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.6.4. Fetch the consent
GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}
Description
If user has not given or withdrawn consent to the template, no given or withdraw date is returned.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
consentTemplateId |
Consent template id. |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.7. Countries
Countries Controller
3.7.1. Get a list of countries.
GET /{baseSiteId}/countries
Description
If the value of type equals to shipping, then return shipping countries. If the value of type equals to billing, then return billing countries. If the value of type is not given, return all countries. The list is sorted alphabetically.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
type |
The type of countries. |
enum (SHIPPING, BILLING) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.7.2. Fetch the list of regions for the provided country
GET /{baseSiteId}/countries/{countyIsoCode}/regions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
countyIsoCode |
An ISO code for a country |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.8. Customer Groups
Customer Groups Controller
3.8.1. Creates a new customer group.
POST /{baseSiteId}/customergroups
Description
Creates a new customer group that is a direct subgroup of a customergroup.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Body |
userGroup |
User group object with id and name. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.8.2. Get all subgroups of a customergroup.
GET /{baseSiteId}/customergroups
Description
Returns all customer groups that are direct subgroups of a customergroup.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
currentPage |
Current page number (starts with 0). |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
Number of customer group returned in one page. |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.8.3. Get a specific customer group.
GET /{baseSiteId}/customergroups/{groupId}
Description
Returns a customer group with a specific groupId.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
groupId |
Group identifier. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.8.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.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
List of users to set for customer group. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.8.5. Assigns user(s) to a customer group.
PATCH /{baseSiteId}/customergroups/{groupId}/members
Description
Assigns user(s) to a customer group.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
List of users to assign to customer group. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.8.6. Delete a user from a customer group.
DELETE /{baseSiteId}/customergroups/{groupId}/members/{userId}
Description
Removes user from a customer group.
To try out the methods of the Customer Groups controller, you must authorize a user who belongs to the “customermanagergroup”.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Path |
userId |
User identifier. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.9. Export
Export Controller
3.9.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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
catalog |
The catalog to retrieve products from. The catalog must be provided along with the version. |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
timestamp |
When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
|
Query |
version |
The catalog version. The catalog version must be provided along with the catalog. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10. Extended Carts
Extended Carts Controller
3.10.1. Handles the consolidating pickup locations
POST /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate
Description
Specifies one store location where all items will be picked up.
Note, if any of the items are not available at the specified location, these items are removed from the cart.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
storeName |
The name of the store where items will be picked up |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.2. Get consolidated pickup options
GET /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate
Description
Returns a list of stores that have all the pick-up items in stock.
Note, if there are no stores that have all the pick up items in stock, or all items are already set to the same pick up location, the response returns an empty list.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.3. Get information needed for create subscription
GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/request
Description
Returns the necessary information for creating a subscription that contacts the payment provider directly. This information contains the payment provider URL and a list of parameters that are needed to create the subscription.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
extendedMerchantCallback |
Define which url should be returned |
boolean |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
responseUrl |
The URL that the payment provider uses to return payment information. Possible values for responseUrl include the following: “orderPage_cancelResponseURL”, “orderPage_declineResponseURL”, and “orderPage_receiptResponseURL”. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.4. Handles response from payment provider and create payment details
POST /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
Description
Handles the response from the payment provider and creates payment details.
Note, the “Try it out” button is not enabled for this method (always returns an error) because the Extended Carts Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorwebservicesaddon AddOn” documentation on help.hybris.com.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.5. Get information about create subscription request results
GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
Description
Returns information related to creating subscription request results. If there is no response from the payment provider, a "202 Accepted" status is returned. If the subscription is created successfully, the payment details are returned. Otherwise, an error response is returned.
Note, the “Try it out” button is not enabled for this method (always returns an error) because the Extended Carts Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorwebservicesaddon AddOn” documentation on help.hybris.com.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.10.6. Deletes payment provider response related to cart
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.11. FSBundles
FS Configurable Bundle Controller
3.11.1. Get bundle template by code
GET /{baseSiteId}/fs-bundle-templates/{bundleTemplateCode}
Description
Get specific bundle template information based on the provided bundle code. Returns the basic information of the bundle, as well as the information on which products are included in the bundle (nested bundles). Parameter to be passed which determines until which depth the nested bundles should be searched for. The product information can be used for later calls.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
bundleTemplateCode |
Bundle Template identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
recurrencies |
Response configuration. This is the number of recurrencies in the response body. |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.11.2. Add to Cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-add-to-cart
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
enum (BASIC, DEFAULT, FULL) |
|
Query |
productCode |
Product code |
string |
|
Query |
quantity |
Quantity |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.11.3. Start bundle
POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-start-bundle
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
bundleTemplateId |
Bundle Template identifier |
string |
|
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
enum (BASIC, DEFAULT, FULL) |
|
Query |
productCode |
Product code |
string |
|
Query |
quantity |
Quantity |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.12. FSClaims
FS Claims Controller
3.12.1. Get all claims
GET /{baseSiteId}/users/{userId}/claims
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.12.2. Create a claim
POST /{baseSiteId}/users/{userId}/claims/create
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
contractId |
Contract identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
policyId |
Policy identifier |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.12.3. Delete a claim
DELETE /{baseSiteId}/users/{userId}/claims/{claimId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
claimId |
Claim identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.13. FSInsurancePolicies
FS Insurance Policies Controller
3.13.1. Get all policies
GET /{baseSiteId}/users/{userId}/policies
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
category |
Parameter for filtering policies based on the category code. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
status |
Parameter for filtering policies based on the policy status. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.13.2. Get a premium calendar
GET /{baseSiteId}/users/{userId}/policies/premium-calendar
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.13.3. Get a policy
GET /{baseSiteId}/users/{userId}/policies/{policyId}/contracts/{contractNumber}
Description
Returns policy details for a provided user of a specified base store based on the policy number and contract number.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
contractNumber |
Contract identifier; used to distinguish cases in which one policy may have multiple insured persons and, therefore, multiple contracts associated with it. |
string |
|
Path |
policyId |
Policy identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14. FSInsuranceQuotes
FS Insurance Quotes Controller
3.14.1. Create insurance quote for a specific user
POST /{baseSiteId}/users/{userId}/carts/{cartId}/insurance-quotes
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.2. Update insurance quote for a specific user
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/insurance-quotes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
insuranceQuote |
insuranceQuote |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.14.3. Get all insurance quotes
GET /{baseSiteId}/users/{userId}/insurance-quotes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.14.4. Get insurance quote for a specific user and quoteId
GET /{baseSiteId}/users/{userId}/insurance-quotes/{quoteId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
quoteId |
Parameter for filtering quotes based on the quoteId. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.15. Feeds
Feeds Controller
3.15.1. Get a list of orders with status updates
GET /{baseSiteId}/feeds/orders/statusfeed
Description
Returns the orders that have changed status. Returns only the elements from the current baseSite that have been updated after the provided timestamp.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
timestamp |
Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.16. Forgotten Passwords
Forgotten Passwords Controller
3.16.1. Generates a token to restore a customer’s forgotten password.
POST /{baseSiteId}/forgottenpasswordtokens
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Query |
userId |
Customer’s user id. Customer user id is case insensitive. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
202 |
Accepted |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.17. Merchant Callback
Merchant Callback Controller
3.17.1. Verify the decision of the Merchant
POST /{baseSiteId}/integration/merchant_callback
Description
Verifies the decision of the merchant.
Note, the “Try it out” button is not enabled for this method (always returns an error) because the Merchant Callback Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorwebservicesaddon AddOn” documentation on help.hybris.com.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.17.2. Verify the decision of the Merchant for a cart
POST /{baseSiteId}/integration/users/{userId}/carts/{cartId}/payment/sop/response
Description
Verifies the decision of the merchant for a specified cart, and stores information of the PaymentSubscriptionResult for the cart.
Note, the “Try it out” button is not enabled for this method (always returns an error) because the Merchant Callback Controller handles parameters differently, depending on which payment provider is used. For more information about this controller, please refer to the “acceleratorwebservicesaddon AddOn” documentation on help.hybris.com.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18. Miscs
Miscs Controller
3.18.1. Get a list of supported payment card types.
GET /{baseSiteId}/cardtypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18.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 a base store is empty, a list of all currencies available in the system is returned.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18.3. Get a list of shipping countries.
GET /{baseSiteId}/deliverycountries
|
Caution
|
operation.deprecated |
Description
Lists all supported delivery countries for the current store. The list is sorted alphabetically.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18.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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.18.5. Get a list of all localized titles.
GET /{baseSiteId}/titles
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.19. Notification Preference
Notification Preference Controller
3.19.1. Gets all notification preferences of current customer
GET /{baseSiteId}/my-account/notificationpreferences
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.19.2. Updates all notification preferences of current customer
PATCH /{baseSiteId}/my-account/notificationpreferences
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Query |
email |
email channel |
string |
Query |
site_message |
site message channel |
string |
Query |
sms |
sms channel |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.20. Orders
Orders Controller
3.20.1. Get a order
GET /{baseSiteId}/orders/{code}
Description
Returns details of a specific order based on the order GUID (Globally Unique Identifier) or the order CODE. The response contains detailed order information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Order GUID (Globally Unique Identifier) or order CODE |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.20.2. Post a order
POST /{baseSiteId}/users/{userId}/orders
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
cartId |
Cart code for logged in user, cart GUID for guest checkout |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
securityCode |
CCV security code. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.20.3. Get order history for user
GET /{baseSiteId}/users/{userId}/orders
Description
Returns order history data for all orders placed by a specified user for a specified base store. The response can display the results across multiple pages, if required.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
|
Query |
statuses |
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.20.4. Get total number of orders
HEAD /{baseSiteId}/users/{userId}/orders
Description
In the response header, the "x-total-count" indicates the total number of orders placed by a specified user for a specified base store.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
statuses |
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.20.5. Get a order
GET /{baseSiteId}/users/{userId}/orders/{code}
Description
Returns specific order details based on a specific order code. The response contains detailed order information.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Order GUID (Globally Unique Identifier) or order CODE |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.21. Page
Page Controller
3.21.1. Get page data with list of cms content slots
GET /{baseSiteId}/cms/pages
Description
Given a page identifier, return the page data with a list of cms content slots, each of which contains a list of cms component data.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
code |
If pageType is ProductPage, code should be product code; if pageType is CategoryPage, code should be category code; if pageType is CatalogPage, code should be catalog code |
string |
|
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageLabelOrId |
Page Label or Id |
string |
|
Query |
pageType |
page type |
enum (ContentPage, ProductPage, CategoryPage, CatalogPage) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22. Payment Details
Payment Details Controller
3.22.1. Get customer’s credit card payment details list.
GET /{baseSiteId}/users/{userId}/paymentdetails
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
saved |
Type of payment details. |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22.2. Get customer’s credit card payment details.
GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
paymentDetailsId |
Payment details identifier. |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22.3. 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 |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.22.4. Delete customer’s credit card payment details.
DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.22.5. Updates existing customer’s credit card payment details.
PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
Description
Updates an existing customer’s credit card payment details based on the specified paymentDetailsId. Only those attributes provided in the request will be updated.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.23. Products
Products Controller
3.23.1. Get products added to the express update feed
GET /{baseSiteId}/products/expressupdate
Description
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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
catalog |
Only products from this catalog are returned. Format: catalogId:catalogVersion |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
timestamp |
Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.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 also include spelling suggestions. To make spelling suggestions work, you need to make sure that "enableSpellCheck" on the SearchQuery is set to "true" (by default, it should already be set to "true"). You also need to have indexed properties configured to be used for spellchecking.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
The context to be used in the search query. |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
|
Query |
searchQueryContext |
searchQueryContext |
string |
|
Query |
sort |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.3. Get a header with total number of products
HEAD /{baseSiteId}/products/search
Description
In the response header, the "x-total-count" indicates the total number of products satisfying a query.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.23.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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
max |
Specifies the limit of results. |
integer(int32) |
|
Query |
term |
Specified term |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.5. Get product details
GET /{baseSiteId}/products/{productCode}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
pageSize |
Maximum size of returned results. |
integer(int32) |
|
Query |
referenceType |
Reference type according to enum ProductReferenceTypeEnum |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.7. Creates a new customer review as an anonymous user
POST /{baseSiteId}/products/{productCode}/reviews
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
review |
Object contains review details like : rating, alias, headline, comment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.8. Get reviews for a product
GET /{baseSiteId}/products/{productCode}/reviews
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
maxCount |
Maximum count of reviews |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.9. Get a product’s stock level
GET /{baseSiteId}/products/{productCode}/stock
Description
Returns a product’s stock levels sorted by distance from the specified location, which is provided using the free-text "location" parameter, or by using the 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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
latitude |
Latitude location parameter. |
number(double) |
|
Query |
location |
Free-text location |
string |
|
Query |
longitude |
Longitude location parameter. |
number(double) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.23.10. Get header with a total number of product’s stock levels
HEAD /{baseSiteId}/products/{productCode}/stock
Description
In the response header, the "x-total-count" indicates the total number of a product’s stock levels. The following two sets of parameters are available: location (required); or longitude (required), and latitude (required).
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
productCode |
Product identifier |
string |
Query |
latitude |
Latitude location parameter. |
number(double) |
Query |
location |
Free-text location |
string |
Query |
longitude |
Longitude location parameter. |
number(double) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.23.11. Get a product’s stock level for a store
GET /{baseSiteId}/products/{productCode}/stock/{storeName}
Description
Returns a product’s stock level for a particular store (in other words, for a particular point of sale).
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Path |
storeName |
Store identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.24. Promotions
Promotions Controller
3.24.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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
promotionGroup |
Only promotions from this group are returned |
string |
|
Query |
type |
Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul> |
enum (all, product, order) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.24.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
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Promotion identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.25. Save Cart
Save Cart Controller
3.25.1. Explicitly clones a cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
description |
The description that should be applied to the cloned cart. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
name |
The name that should be applied to the cloned cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.25.2. Flag a cart for deletion.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion
Description
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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.25.3. Restore a saved cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.25.4. Explicitly saves a cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
saveCartDescription |
The description that should be applied to the saved cart. |
string |
|
Query |
saveCartName |
The name that should be applied to the saved cart. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.25.5. Get a saved cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart
Description
Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.26. Site Messages
FS Site Message Controller
3.26.1. Gets all site messages of current customer
GET /{baseSiteId}/notifications/sitemessages
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
currentPage |
the current result page requested |
string |
|
Query |
lang |
specifies the language |
string |
|
Query |
needsTotal |
the flag for indicating if total number of results is needed or not |
enum (true, false) |
|
Query |
pageSize |
the number of results returned per page |
string |
|
Query |
sort |
the sorting method applied to the return results |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.26.2. Get all site messages by message group
GET /{baseSiteId}/users/{userId}/notifications/sitemessages
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
the current result page requested |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
lang |
specifies the language |
string |
|
Query |
messagegroup |
Message group. Default value is generalMessageGroup. |
string |
|
Query |
pageSize |
the number of results returned per page |
string |
|
Query |
sortCode |
the sorting method applied to the return results |
string |
|
Query |
sortOrder |
the sorting order method applied to the return results |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.26.3. Updates the read date of provided site messages
PUT /{baseSiteId}/users/{userId}/notifications/sitemessages/read-unread
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
messageCodes |
List of site message identifiers |
< string > array(multi) |
Query |
readStatus |
Read status |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.26.4. Get a site message by message code
GET /{baseSiteId}/users/{userId}/notifications/sitemessages/{messageCode}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
messageCode |
Message Code |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27. Stores
Stores Controller
3.27.1. Get a list of store locations
GET /{baseSiteId}/stores
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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number(double) |
|
Query |
currentPage |
The current result page requested. |
integer(int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number(double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number(double) |
|
Query |
pageSize |
The number of results returned per page. |
integer(int32) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number(double) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.27.2. Get a header with the number of store locations
HEAD /{baseSiteId}/stores
Description
In the response header, the "x-total-count" indicates 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 |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number(double) |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number(double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number(double) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number(double) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.27.3. Get a store location
GET /{baseSiteId}/stores/{storeId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
storeId |
Store identifier (currently store name) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28. Users
Users Controller
3.28.1. Registers a customer
POST /{baseSiteId}/users
Description
Registers a customer. There are two options for registering a customer. The first option requires the following parameters: login, password, firstName, lastName, titleCode. The second option converts a guest to a customer. In this case, the required parameters are: guid, password.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Body |
user |
User’s object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.2. Get customer profile
GET /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.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 |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.4. Delete customer profile
DELETE /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.28.5. Updates customer profile
PATCH /{baseSiteId}/users/{userId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
3.28.6. Get all customer groups of a customer.
GET /{baseSiteId}/users/{userId}/customergroups
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.7. Changes customer’s login name.
PUT /{baseSiteId}/users/{userId}/login
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
newLogin |
Customer’s new login name. Customer login is case insensitive. |
string |
Query |
password |
Customer’s current password. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
No Content |
201 |
Created |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.28.8. Changes customer’s password
PUT /{baseSiteId}/users/{userId}/password
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
new |
New password. |
string |
Query |
old |
Old password. Required only for ROLE_CUSTOMERGROUP |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
No Content |
202 |
Accepted |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
3.29. Vouchers
Vouchers Controller
3.29.1. Get a voucher based on code
GET /{baseSiteId}/vouchers/{code}
Description
Returns details of a single voucher that is specified by its voucher identification code.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Voucher identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. |
enum (BASIC, DEFAULT, FULL) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
4. Definitions
4.1. AddressListWsDTO
| Name | Schema |
|---|---|
addresses |
< AddressWsDTO > array |
4.2. AddressValidationWsDTO
| Name | Schema |
|---|---|
decision |
string |
errors |
|
suggestedAddresses |
< AddressWsDTO > array |
4.3. AddressWsDTO
| Name | Schema |
|---|---|
companyName |
string |
country |
|
defaultAddress |
boolean |
email |
string |
firstName |
string |
formattedAddress |
string |
id |
string |
lastName |
string |
line1 |
string |
line2 |
string |
phone |
string |
postalCode |
string |
region |
|
shippingAddress |
boolean |
title |
string |
titleCode |
string |
town |
string |
visibleInAddressBook |
boolean |
4.4. AgentWsDTO
| Name | Schema |
|---|---|
categories |
< CategoryWsDTO > array |
contactEmail |
string |
firstName |
string |
lastName |
string |
pointsOfService |
< PointOfServiceWsDTO > array |
thumbnail |
4.6. BaseOptionWsDTO
| Name | Schema |
|---|---|
options |
< VariantOptionWsDTO > array |
selected |
|
variantType |
string |
4.7. BaseStoreWsDTO
| Name | Schema |
|---|---|
createReturnProcessCode |
string |
currencies |
< CurrencyWsDTO > array |
defaultCurrency |
|
defaultDeliveryOrigin |
|
defaultLanguage |
|
deliveryCountries |
< CountryWsDTO > array |
deliveryModes |
|
externalTaxEnabled |
boolean |
languages |
< LanguageWsDTO > array |
maxRadiusForPosSearch |
number(double) |
name |
string |
paymentProvider |
string |
pointsOfService |
< PointOfServiceWsDTO > array |
submitOrderProcessCode |
string |
4.9. BillingPlanWsDTO
| Name | Schema |
|---|---|
billingCycleDay |
integer(int32) |
billingCycleTypeData |
|
billingTimeData |
|
id |
string |
name |
string |
4.10. BillingTimeWsDTO
| Name | Schema |
|---|---|
code |
string |
description |
string |
helpContent |
string |
name |
string |
nameInOrder |
string |
orderNumber |
integer(int32) |
4.11. BreadcrumbWsDTO
| Name | Schema |
|---|---|
facetCode |
string |
facetName |
string |
facetValueCode |
string |
facetValueName |
string |
removeQuery |
|
truncateQuery |
4.12. BundleTemplateWsDTO
| Name | Schema |
|---|---|
childBundleTemplates |
< BundleTemplateWsDTO > array |
id |
string |
name |
string |
products |
< ProductWsDTO > array |
rootBundleTemplateName |
string |
type |
string |
version |
string |
4.13. CMSPageWsDTO
| Name | Schema |
|---|---|
contentSlots |
|
defaultPage |
boolean |
name |
string |
template |
string |
title |
string |
typeCode |
string |
uid |
string |
4.14. CardTypeListWsDTO
| Name | Schema |
|---|---|
cardTypes |
< CardTypeWsDTO > array |
4.16. CartListWsDTO
| Name | Schema |
|---|---|
carts |
< CartWsDTO > array |
4.17. CartModificationListWsDTO
| Name | Schema |
|---|---|
cartModifications |
< CartModificationWsDTO > array |
4.18. CartModificationWsDTO
| Name | Schema |
|---|---|
deliveryModeChanged |
boolean |
entry |
|
quantity |
integer(int64) |
quantityAdded |
integer(int64) |
statusCode |
string |
statusMessage |
string |
4.19. CartWsDTO
| Name | Schema |
|---|---|
appliedOrderPromotions |
< PromotionResultWsDTO > array |
appliedProductPromotions |
< PromotionResultWsDTO > array |
appliedVouchers |
< VoucherWsDTO > array |
calculated |
boolean |
code |
string |
deliveryAddress |
|
deliveryCost |
|
deliveryItemsQuantity |
integer(int64) |
deliveryMode |
|
deliveryOrderGroups |
< DeliveryOrderEntryGroupWsDTO > array |
description |
string |
entries |
< OrderEntryWsDTO > array |
expirationTime |
string(date-time) |
guid |
string |
insuranceQuote |
|
name |
string |
net |
boolean |
orderDiscounts |
|
paymentInfo |
|
pickupItemsQuantity |
integer(int64) |
pickupOrderGroups |
< PickupOrderEntryGroupWsDTO > array |
potentialOrderPromotions |
< PromotionResultWsDTO > array |
potentialProductPromotions |
< PromotionResultWsDTO > array |
productDiscounts |
|
saveTime |
string(date-time) |
savedBy |
|
site |
string |
store |
string |
subTotal |
|
totalDiscounts |
|
totalItems |
integer(int32) |
totalPrice |
|
totalPriceWithTax |
|
totalTax |
|
totalUnitCount |
integer(int32) |
user |
4.20. CatalogListWsDTO
| Name | Schema |
|---|---|
catalogs |
< CatalogWsDTO > array |
4.21. CatalogVersionWsDTO
| Name | Schema |
|---|---|
categories |
< CategoryHierarchyWsDTO > array |
id |
string |
lastModified |
string(date-time) |
name |
string |
url |
string |
4.22. CatalogWsDTO
| Name | Schema |
|---|---|
catalogVersions |
< CatalogVersionWsDTO > array |
id |
string |
lastModified |
string(date-time) |
name |
string |
url |
string |
4.23. CategoryHierarchyWsDTO
| Name | Schema |
|---|---|
id |
string |
lastModified |
string(date-time) |
name |
string |
subcategories |
< CategoryHierarchyWsDTO > array |
url |
string |
4.24. CategoryWsDTO
| Name | Schema |
|---|---|
allowedFSRequestTypes |
< AllowedFSRequestTypeWsDTO > array |
code |
string |
image |
|
name |
string |
url |
string |
4.25. ClassificationWsDTO
| Name | Schema |
|---|---|
code |
string |
features |
< FeatureWsDTO > array |
name |
string |
4.28. ComponentListWsDTO
| Name | Schema |
|---|---|
component |
< ComponentWsDTO > array |
4.29. ComponentWsDTO
| Name | Schema |
|---|---|
modifiedtime |
string(date-time) |
name |
string |
otherProperties |
object |
simpleCMSComponents |
< ComponentWsDTO > array |
tabComponents |
< ComponentWsDTO > array |
typeCode |
string |
uid |
string |
4.30. ConfigurationInfoWsDTO
| Name | Schema |
|---|---|
configurationLabel |
string |
configurationValue |
string |
configuratorType |
string |
status |
string |
4.31. ConsentTemplateListWsDTO
| Name | Schema |
|---|---|
consentTemplates |
< ConsentTemplateWsDTO > array |
4.32. ConsentTemplateWsDTO
| Name | Schema |
|---|---|
currentConsent |
|
description |
string |
id |
string |
name |
string |
version |
integer(int32) |
4.33. ConsentWsDTO
| Name | Schema |
|---|---|
code |
string |
consentGivenDate |
string(date-time) |
consentWithdrawnDate |
string(date-time) |
4.34. ConsignmentEntryWsDTO
| Name | Schema |
|---|---|
orderEntry |
|
quantity |
integer(int64) |
shippedQuantity |
integer(int64) |
4.35. ConsignmentWsDTO
| Name | Schema |
|---|---|
code |
string |
deliveryPointOfService |
|
entries |
< ConsignmentEntryWsDTO > array |
shippingAddress |
|
status |
string |
statusDate |
string(date-time) |
trackingID |
string |
4.36. ContentSlotListWsDTO
| Name | Schema |
|---|---|
contentSlot |
< ContentSlotWsDTO > array |
4.37. ContentSlotWsDTO
| Name | Schema |
|---|---|
components |
|
name |
string |
position |
string |
slotId |
string |
slotShared |
boolean |
slotStatus |
string |
4.38. CountryListWsDTO
| Name | Schema |
|---|---|
countries |
< CountryWsDTO > array |
4.40. CurrencyListWsDTO
| Name | Schema |
|---|---|
currencies |
< CurrencyWsDTO > array |
4.41. CurrencyWsDTO
| Name | Schema |
|---|---|
active |
boolean |
isocode |
string |
name |
string |
symbol |
string |
4.42. DeliveryModeListWsDTO
| Name | Schema |
|---|---|
deliveryModes |
< DeliveryModeWsDTO > array |
4.43. DeliveryModeWsDTO
| Name | Schema |
|---|---|
code |
string |
deliveryCost |
|
description |
string |
name |
string |
4.44. DeliveryOrderEntryGroupWsDTO
| Name | Schema |
|---|---|
deliveryAddress |
|
entries |
< OrderEntryWsDTO > array |
quantity |
integer(int64) |
totalPriceWithTax |
4.45. EmployeeWsDTO
| Name | Schema |
|---|---|
contactInfos |
< PhoneContactInfoWsDTO > array |
displayName |
string |
email |
string |
4.47. FSInvestmentInfoWsDTO
| Name | Schema |
|---|---|
distributionPercentage |
number(double) |
investmentType |
4.48. FSInvestmentTypeWsDTO
| Name | Schema |
|---|---|
factSheetDocument |
|
fiveYearPerformance |
number(double) |
fundName |
string |
isin |
string |
riskReturningRating |
string |
4.50. FacetValueWsDTO
| Name | Schema |
|---|---|
count |
integer(int64) |
name |
string |
query |
|
selected |
boolean |
4.51. FacetWsDTO
| Name | Schema |
|---|---|
category |
boolean |
multiSelect |
boolean |
name |
string |
priority |
integer(int32) |
topValues |
< FacetValueWsDTO > array |
values |
< FacetValueWsDTO > array |
visible |
boolean |
4.52. FeatureUnitWsDTO
| Name | Schema |
|---|---|
name |
string |
symbol |
string |
unitType |
string |
4.54. FeatureWsDTO
| Name | Schema |
|---|---|
code |
string |
comparable |
boolean |
description |
string |
featureUnit |
|
featureValues |
< FeatureValueWsDTO > array |
name |
string |
range |
boolean |
type |
string |
4.55. FsClaimListWsDTO
| Name | Schema |
|---|---|
claims |
< FsClaimWsDTO > array |
4.56. FsClaimWsDTO
| Name | Schema |
|---|---|
claimHandler |
|
claimNumber |
string |
claimStatus |
string |
dateOfLoss |
string |
incidentType |
|
insurancePolicy |
|
requestId |
string |
4.57. FutureStockWsDTO
| Name | Schema |
|---|---|
date |
string(date-time) |
formattedDate |
string |
stock |
4.59. ImageWsDTO
| Name | Schema |
|---|---|
altText |
string |
format |
string |
galleryIndex |
integer(int32) |
imageType |
enum (PRIMARY, GALLERY) |
url |
string |
4.60. InsuranceBenefitWSDTO
| Name | Schema |
|---|---|
coverageInformation |
string |
coverageValue |
string |
description |
string |
name |
string |
4.61. InsuranceCoverageWsDTO
| Name | Schema |
|---|---|
benefits |
< InsuranceBenefitWSDTO > array |
coverageIsIncluded |
boolean |
coverageProduct |
|
investmentInfo |
< FSInvestmentInfoWsDTO > array |
4.62. InsurancePolicyListWsDTO
| Name | Schema |
|---|---|
insurancePolicies |
< InsurancePolicyWsDTO > array |
4.63. InsurancePolicyWsDTO
| Name | Schema |
|---|---|
billingData |
< SubscriptionBillingWsDTO > array |
categoryData |
|
contractNumber |
string |
insuredObjects |
< InsuredObjectWsDTO > array |
mainProduct |
|
optionalProducts |
< InsuranceCoverageWsDTO > array |
paymentFrequency |
string |
paymentMethod |
|
policyEndDate |
string |
policyNumber |
string |
policyPremium |
|
policyProduct |
|
policyStartDate |
string |
responsibleAgent |
4.64. InsuranceQuoteListWsDTO
| Name | Schema |
|---|---|
insuranceQuotes |
< InsuranceQuoteWsDTO > array |
4.65. InsuranceQuoteWsDTO
| Name | Schema |
|---|---|
cartCode |
string |
configurable |
boolean |
defaultCategory |
|
expiryDate |
string |
isExpired |
boolean |
isMonthly |
boolean |
planName |
string |
quoteDetails |
< string, string > map |
quoteId |
string |
quoteImages |
< ImageWsDTO > array |
quotePrice |
string |
quoteStatus |
string |
quoteTitle |
string |
quoteWorkflowStatus |
|
startDate |
string |
state |
4.66. InsuredObjectItemWsDTO
| Name | Schema |
|---|---|
label |
string |
order |
integer(int32) |
value |
string |
4.68. InsuredObjectWsDTO
| Name | Schema |
|---|---|
insuredObjectItems |
< InsuredObjectItemWsDTO > array |
insuredObjectType |
4.69. LanguageListWsDTO
| Name | Schema |
|---|---|
languages |
< LanguageWsDTO > array |
4.70. LanguageWsDTO
| Name | Schema |
|---|---|
active |
boolean |
isocode |
string |
name |
string |
nativeName |
string |
4.71. ListAdaptedComponents
| Name | Schema |
|---|---|
components |
< ComponentAdaptedData > array |
pagination |
|
sorts |
< sort > array |
4.72. MediaData
| Name | Schema |
|---|---|
altText |
string |
catalogId |
string |
catalogVersion |
string |
code |
string |
description |
string |
downloadUrl |
string |
mime |
string |
url |
string |
uuid |
string |
4.73. MemberListWsDTO
| Name | Schema |
|---|---|
members |
< PrincipalWsDTO > array |
4.75. OpeningScheduleWsDTO
| Name | Schema |
|---|---|
code |
string |
name |
string |
specialDayOpeningList |
< SpecialOpeningDayWsDTO > array |
weekDayOpeningList |
< WeekdayOpeningDayWsDTO > array |
4.76. OrderEntryListWsDTO
| Name | Schema |
|---|---|
orderEntries |
< OrderEntryWsDTO > array |
4.77. OrderEntryWsDTO
| Name | Schema |
|---|---|
addable |
boolean |
basePrice |
|
configurationInfos |
< ConfigurationInfoWsDTO > array |
deliveryMode |
|
deliveryPointOfService |
|
entryNumber |
integer(int32) |
product |
|
quantity |
integer(int64) |
removeable |
boolean |
totalPrice |
|
updateable |
boolean |
4.78. OrderHistoryListWsDTO
| Name | Schema |
|---|---|
orders |
< OrderHistoryWsDTO > array |
pagination |
|
sorts |
< SortWsDTO > array |
4.79. OrderHistoryWsDTO
| Name | Schema |
|---|---|
code |
string |
guid |
string |
placed |
string(date-time) |
status |
string |
statusDisplay |
string |
total |
4.80. OrderStatusUpdateElementListWsDTO
| Name | Schema |
|---|---|
orderStatusUpdateElements |
< OrderStatusUpdateElementWsDTO > array |
4.81. OrderStatusUpdateElementWsDTO
| Name | Schema |
|---|---|
baseSiteId |
string |
code |
string |
status |
string |
4.82. OrderWsDTO
| Name | Schema |
|---|---|
appliedOrderPromotions |
< PromotionResultWsDTO > array |
appliedProductPromotions |
< PromotionResultWsDTO > array |
appliedVouchers |
< VoucherWsDTO > array |
calculated |
boolean |
code |
string |
consignments |
< ConsignmentWsDTO > array |
created |
string(date-time) |
deliveryAddress |
|
deliveryCost |
|
deliveryItemsQuantity |
integer(int64) |
deliveryMode |
|
deliveryOrderGroups |
< DeliveryOrderEntryGroupWsDTO > array |
deliveryStatus |
string |
deliveryStatusDisplay |
string |
entries |
< OrderEntryWsDTO > array |
guestCustomer |
boolean |
guid |
string |
net |
boolean |
orderDiscounts |
|
paymentInfo |
|
pickupItemsQuantity |
integer(int64) |
pickupOrderGroups |
< PickupOrderEntryGroupWsDTO > array |
productDiscounts |
|
site |
string |
status |
string |
statusDisplay |
string |
store |
string |
subTotal |
|
totalDiscounts |
|
totalItems |
integer(int32) |
totalPrice |
|
totalPriceWithTax |
|
totalTax |
|
unconsignedEntries |
< OrderEntryWsDTO > array |
user |
4.83. PaginationWsDTO
| Name | Schema |
|---|---|
currentPage |
integer(int32) |
pageSize |
integer(int32) |
sort |
string |
totalPages |
integer(int32) |
totalResults |
integer(int64) |
4.84. PaymentDetailsListWsDTO
| Name | Schema |
|---|---|
payments |
< PaymentDetailsWsDTO > array |
4.85. PaymentDetailsWsDTO
| Name | Schema |
|---|---|
accountHolderName |
string |
billingAddress |
|
cardNumber |
string |
cardType |
|
defaultPayment |
boolean |
expiryMonth |
string |
expiryYear |
string |
id |
string |
issueNumber |
string |
paymentOption |
string |
saved |
boolean |
startMonth |
string |
startYear |
string |
subscriptionId |
string |
4.86. PaymentRequestWsDTO
| Name | Schema |
|---|---|
mappingLabels |
< string, string > map |
parameters |
< string, string > map |
postUrl |
string |
4.88. PickupOrderEntryGroupWsDTO
| Name | Schema |
|---|---|
deliveryPointOfService |
|
distance |
number(double) |
entries |
< OrderEntryWsDTO > array |
quantity |
integer(int64) |
totalPriceWithTax |
4.89. PointOfServiceListWsDTO
| Name | Schema |
|---|---|
pointOfServices |
< PointOfServiceWsDTO > array |
4.90. PointOfServiceStockWsDTO
| Name | Schema |
|---|---|
address |
|
description |
string |
displayName |
string |
distanceKm |
number(double) |
features |
< string, string > map |
formattedDistance |
string |
geoPoint |
|
mapIcon |
|
name |
string |
openingHours |
|
stockInfo |
|
storeContent |
string |
storeImages |
< ImageWsDTO > array |
url |
string |
4.91. PointOfServiceWsDTO
| Name | Schema |
|---|---|
address |
|
description |
string |
displayName |
string |
distanceKm |
number(double) |
features |
< string, string > map |
formattedDistance |
string |
geoPoint |
|
mapIcon |
|
name |
string |
openingHours |
|
storeContent |
string |
storeImages |
< ImageWsDTO > array |
url |
string |
4.93. PriceWsDTO
| Name | Schema |
|---|---|
currencyIso |
string |
formattedValue |
string |
maxQuantity |
integer(int64) |
minQuantity |
integer(int64) |
name |
string |
oneTimeChargeEntries |
< OneTimeChargeEntryWsDTO > array |
priceType |
enum (BUY, FROM) |
value |
number |
4.95. ProductExpressUpdateElementListWsDTO
| Name | Schema |
|---|---|
productExpressUpdateElements |
< ProductExpressUpdateElementWsDTO > array |
4.96. ProductExpressUpdateElementWsDTO
| Name | Schema |
|---|---|
catalogId |
string |
catalogVersion |
string |
code |
string |
4.97. ProductListWsDTO
| Name | Schema |
|---|---|
catalog |
string |
currentPage |
integer(int32) |
products |
< ProductWsDTO > array |
totalPageCount |
integer(int32) |
totalProductCount |
integer(int32) |
version |
string |
4.98. ProductReferenceListWsDTO
| Name | Schema |
|---|---|
references |
< ProductReferenceWsDTO > array |
4.99. ProductReferenceWsDTO
| Name | Schema |
|---|---|
description |
string |
preselected |
boolean |
quantity |
integer(int32) |
referenceType |
string |
target |
4.100. ProductSearchPageWsDTO
| Name | Schema |
|---|---|
breadcrumbs |
< BreadcrumbWsDTO > array |
categoryCode |
string |
currentQuery |
|
facets |
< FacetWsDTO > array |
freeTextSearch |
string |
keywordRedirectUrl |
string |
pagination |
|
products |
< ProductWsDTO > array |
sorts |
< SortWsDTO > array |
spellingSuggestion |
4.101. ProductWsDTO
| Name | Schema |
|---|---|
addToCartDisabled |
boolean |
addToCartDisabledMessage |
string |
availableForPickup |
boolean |
averageRating |
number(double) |
baseOptions |
< BaseOptionWsDTO > array |
baseProduct |
string |
bundleTemplates |
< BundleTemplateWsDTO > array |
categories |
< CategoryWsDTO > array |
classifications |
< ClassificationWsDTO > array |
code |
string |
configurable |
boolean |
configuratorType |
string |
defaultCategory |
|
description |
string |
futureStocks |
< FutureStockWsDTO > array |
images |
< ImageWsDTO > array |
keywords |
< string > array |
lowestBundlePrice |
|
manufacturer |
string |
multidimensional |
boolean |
name |
string |
numberOfReviews |
integer(int32) |
potentialPromotions |
< PromotionWsDTO > array |
price |
|
priceRange |
|
productReferences |
< ProductReferenceWsDTO > array |
purchasable |
boolean |
reviews |
< ReviewWsDTO > array |
soldIndividually |
boolean |
stock |
|
subscriptionTerm |
|
summary |
string |
tags |
< string > array |
url |
string |
variantMatrix |
< VariantMatrixElementWsDTO > array |
variantOptions |
< VariantOptionWsDTO > array |
variantType |
string |
volumePrices |
< PriceWsDTO > array |
volumePricesFlag |
boolean |
4.102. PromotionListWsDTO
| Name | Schema |
|---|---|
promotions |
< PromotionWsDTO > array |
4.103. PromotionOrderEntryConsumedWsDTO
| Name | Schema |
|---|---|
adjustedUnitPrice |
number(double) |
code |
string |
orderEntryNumber |
integer(int32) |
quantity |
integer(int64) |
4.104. PromotionRestrictionWsDTO
| Name | Schema |
|---|---|
description |
string |
restrictionType |
string |
4.105. PromotionResultListWsDTO
| Name | Schema |
|---|---|
promotions |
< PromotionResultWsDTO > array |
4.106. PromotionResultWsDTO
| Name | Schema |
|---|---|
consumedEntries |
< PromotionOrderEntryConsumedWsDTO > array |
description |
string |
promotion |
4.107. PromotionWsDTO
| Name | Schema |
|---|---|
code |
string |
couldFireMessages |
< string > array |
description |
string |
enabled |
boolean |
endDate |
string(date-time) |
firedMessages |
< string > array |
priority |
integer(int32) |
productBanner |
|
promotionGroup |
string |
promotionType |
string |
restrictions |
< PromotionRestrictionWsDTO > array |
startDate |
string(date-time) |
title |
string |
4.110. RegionListWsDTO
| Name | Schema |
|---|---|
regions |
< RegionWsDTO > array |
4.111. RegionWsDTO
| Name | Schema |
|---|---|
countryIso |
string |
isocode |
string |
isocodeShort |
string |
name |
string |
4.112. ReviewListWsDTO
| Name | Schema |
|---|---|
reviews |
< ReviewWsDTO > array |
4.113. ReviewWsDTO
| Name | Schema |
|---|---|
alias |
string |
comment |
string |
date |
string(date-time) |
headline |
string |
id |
string |
principal |
|
rating |
number(double) |
4.118. SpecialOpeningDayWsDTO
| Name | Schema |
|---|---|
closed |
boolean |
closingTime |
|
comment |
string |
date |
string(date-time) |
formattedDate |
string |
name |
string |
openingTime |
4.121. StoreFinderSearchPageWsDTO
| Name | Schema |
|---|---|
boundEastLongitude |
number(double) |
boundNorthLatitude |
number(double) |
boundSouthLatitude |
number(double) |
boundWestLongitude |
number(double) |
locationText |
string |
pagination |
|
sorts |
< SortWsDTO > array |
sourceLatitude |
number(double) |
sourceLongitude |
number(double) |
stores |
< PointOfServiceWsDTO > array |
4.122. StoreFinderStockSearchPageWsDTO
| Name | Schema |
|---|---|
boundEastLongitude |
number(double) |
boundNorthLatitude |
number(double) |
boundSouthLatitude |
number(double) |
boundWestLongitude |
number(double) |
locationText |
string |
pagination |
|
product |
|
sorts |
< SortWsDTO > array |
sourceLatitude |
number(double) |
sourceLongitude |
number(double) |
stores |
< PointOfServiceStockWsDTO > array |
4.123. SubscriptionBillingWsDTO
| Name | Schema |
|---|---|
billingDate |
string |
billingPeriod |
string |
paymentAmount |
string |
paymentStatus |
string |
4.124. SubscriptionTermWsDTO
| Name | Schema |
|---|---|
billingPlan |
|
cancellable |
boolean |
id |
string |
name |
string |
termOfServiceFrequency |
|
termOfServiceNumber |
integer(int32) |
termOfServiceRenewal |
4.125. SuggestionListWsDTO
| Name | Schema |
|---|---|
suggestions |
< SuggestionWsDTO > array |
4.129. TimeWsDTO
| Name | Schema |
|---|---|
formattedHour |
string |
hour |
string(byte) |
minute |
string(byte) |
4.130. TitleListWsDTO
| Name | Schema |
|---|---|
titles |
< TitleWsDTO > array |
4.132. UserGroupListWsDTO
| Name | Schema |
|---|---|
currentPage |
integer(int32) |
numberOfPages |
integer(int32) |
pageSize |
integer(int32) |
totalNumber |
integer(int32) |
userGroups |
< UserGroupWsDTO > array |
4.133. UserGroupWsDTO
| Name | Schema |
|---|---|
members |
< PrincipalWsDTO > array |
membersCount |
integer(int32) |
name |
string |
subGroups |
< UserGroupWsDTO > array |
uid |
string |
4.134. UserSignUpWsDTO
| Name | Schema |
|---|---|
firstName |
string |
lastName |
string |
password |
string |
titleCode |
string |
uid |
string |
4.135. UserWsDTO
| Name | Schema |
|---|---|
currency |
|
customerId |
string |
deactivationDate |
string(date-time) |
defaultAddress |
|
displayUid |
string |
firstName |
string |
language |
|
lastName |
string |
name |
string |
title |
string |
titleCode |
string |
uid |
string |
4.136. VariantCategoryWsDTO
| Name | Schema |
|---|---|
hasImage |
boolean |
name |
string |
priority |
integer(int32) |
4.137. VariantMatrixElementWsDTO
| Name | Schema |
|---|---|
elements |
< VariantMatrixElementWsDTO > array |
isLeaf |
boolean |
parentVariantCategory |
|
variantOption |
|
variantValueCategory |
4.138. VariantOptionQualifierWsDTO
| Name | Schema |
|---|---|
image |
|
name |
string |
qualifier |
string |
value |
string |
4.139. VariantOptionWsDTO
| Name | Schema |
|---|---|
code |
string |
priceData |
|
stock |
|
url |
string |
variantOptionQualifiers |
< VariantOptionQualifierWsDTO > array |
4.140. VariantValueCategoryWsDTO
| Name | Schema |
|---|---|
name |
string |
sequence |
integer(int32) |
superCategories |
< VariantCategoryWsDTO > array |
4.141. VoucherListWsDTO
| Name | Schema |
|---|---|
vouchers |
< VoucherWsDTO > array |
4.142. VoucherWsDTO
| Name | Schema |
|---|---|
appliedValue |
|
code |
string |
currency |
|
description |
string |
freeShipping |
boolean |
name |
string |
value |
number(double) |
valueFormatted |
string |
valueString |
string |
voucherCode |
string |
4.143. WeekdayOpeningDayWsDTO
| Name | Schema |
|---|---|
closed |
boolean |
closingTime |
|
openingTime |
|
weekDay |
string |
4.144. error
Error message
| Name | Description | Schema |
|---|---|---|
errorCode |
Error code |
string |
exceptionMessage |
string |
|
language |
string |
|
message |
Descriptive, human readable error message. |
string |
position |
integer(int32) |
|
reason |
Additional classification specific for each error type e.g. 'noStock'. |
string |
subject |
Identifier of the related object e.g. '1'. |
string |
subjectType |
Type of the object related to the error e.g. 'entry'. |
string |
type |
Type of the error e.g. 'LowStockError'. |
string |
4.146. notificationPreference
Notification preference
| Name | Description | Schema |
|---|---|---|
channel |
preference channel |
enum (EMAIL, SMS, SITE_MESSAGE) |
enabled |
if true, the channel is on; if false, the channel is off |
boolean |
value |
the corresponding value of current channel, for example, for SMS it should be a mobile number; for email it should be an email address |
string |
4.147. notificationPreferenceList
Notification preference list
| Name | Description | Schema |
|---|---|---|
preferences |
notification preferences |
< notificationPreference > array |
4.148. pagination
Pagination info
| Name | Description | Schema |
|---|---|---|
count |
Number of elements on this page |
integer(int32) |
hasNext |
Indicates if there is next page |
boolean |
hasPrevious |
Indicates if there is previous page |
boolean |
page |
Current page number |
integer(int32) |
totalCount |
Total number of elements |
integer(int64) |
totalPages |
Total number of pages |
integer(int32) |
4.149. siteMessage
Site message
| Name | Description | Schema |
|---|---|---|
content |
message content |
string |
link |
message link |
string |
notificationType |
notification type used for this message |
enum (NOTIFICATION) |
readDate |
message read date |
string(date-time) |
richContent |
message rich content |
string |
richTitle |
message rich title |
string |
sentDate |
sent date |
string(date-time) |
title |
message title |
string |
uid |
message uid |
string |
4.150. siteMessageSearchPage
Site message search page
| Name | Description | Schema |
|---|---|---|
messages |
site messages |
< siteMessage > array |
pagination |
pagination information |
|
sorts |
sorting information |
< sort > array |