1. Overview

Commerce Webservices Version 2

1.1. Version information

Version : 2.0

1.2. URI scheme

Host : localhost:9001
BasePath : /rest/v2

1.3. Tags

  • 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

1.4. Produces

  • application/xml

  • application/json

2. Security

2.1. oauth2_Password

Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token

Name

basic

2.2. oauth2_client_credentials

Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token

Name

extended

3. Resources

3.1. Address

Address Controller

3.1.1. Creates a new address.

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

Creates a new address.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

address
required

Address object.

AddressWsDTO

Responses
HTTP Code Description Schema

201

Created

AddressWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.1.2. Get customer’s addresses

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

Returns customer’s addresses.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

AddressListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.1.3. Verifies address

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

Verifies address.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

address
required

Address object.

AddressWsDTO

Responses
HTTP Code Description Schema

200

OK

AddressValidationWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.1.4. Get info about address

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

Returns detailed information about address with a given id.

Parameters
Type Name Description Schema Default

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

AddressWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object.

AddressWsDTO

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

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.1.6. Delete customer’s address

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

Removes customer’s address.

Parameters
Type Name Description Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.1.7. Updates the address

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

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

Parameters
Type Name Description Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

address
required

Address object

AddressWsDTO

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

baseStoreUid
required

Base store name

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

BaseStoreWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3. 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
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

oldCartId
optional

Anonymous cart GUID.

string

Query

toMergeCartGuid
optional

The GUID of the user’s cart that will be merged with the anonymous cart.

string

Responses
HTTP Code Description Schema

201

Created

CartWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.2. Get all customer carts.

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

Lists all customer carts.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

Optional pagination parameter in case of savedCartsOnly == true. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20.

integer(int32)

"20"

Query

savedCartsOnly
optional

Optional parameter. If the parameter is provided and its value is true, only saved carts are returned.

boolean

"false"

Query

sort
optional

Optional sort criterion in case of savedCartsOnly == true. No default value.

string

Responses
HTTP Code Description Schema

200

OK

CartListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.3. Get a cart with a given identifier.

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

Returns the cart with a given identifier.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CartWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.4. Deletes a cart with a given cart id.

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

Deletes a cart with a given cart id.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.5. Creates a delivery address for the cart.

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

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

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

address
required

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).

The DTO is in XML or .json format.

AddressWsDTO

Responses
HTTP Code Description Schema

201

Created

AddressWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

addressId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.7. Delete the delivery address from the cart.

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

Removes the delivery address from the cart.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.8. Get the delivery mode selected for the cart.

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

Returns the delivery mode selected for the cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

DeliveryModeWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.9. Sets the delivery mode for a cart.

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

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

deliveryModeId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.10. Delete the delivery mode from the cart.

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

Removes the delivery mode from the cart.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

DeliveryModeListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.12. Assigns an email to the cart.

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

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

email
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.13. Adds a product to the cart.

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

Adds a product to the cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

entry
required

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).

The DTO is in XML or .json format.

OrderEntryWsDTO

Responses
HTTP Code Description Schema

200

OK

CartModificationWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.14. Get cart entries.

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

Returns cart entries.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

OrderEntryListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.15. Get the details of the cart entries.

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

Returns the details of the cart entries.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

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
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

OrderEntryWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

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
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name)

The DTO is in XML or .json format.

OrderEntryWsDTO

Responses
HTTP Code Description Schema

200

OK

CartModificationWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.17. Deletes cart entry.

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

Deletes cart entry.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

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
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

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
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

entry
required

Request body parameter that contains details such as the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name)

The DTO is in XML or .json format.

OrderEntryWsDTO

Responses
HTTP Code Description Schema

200

OK

CartModificationWsDTO

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

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

Defines the details of a new credit card, and assigns this payment option to the cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

paymentDetails
required

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)

The DTO is in XML or .json format.

PaymentDetailsWsDTO

Responses
HTTP Code Description Schema

201

Created

PaymentDetailsWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.20. Sets credit card payment details for the cart.

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

Sets credit card payment details for the cart.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

paymentDetailsId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

promotionId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PromotionResultListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PromotionResultListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

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

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

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

voucherId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

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

Returns a list of vouchers applied to the cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

VoucherListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3.27. Delete a voucher defined for the current cart.

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

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Path

voucherId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4. Catalogs

Catalogs Controller

3.4.1. Get a list of catalogs

GET /{baseSiteId}/catalogs
Description

Returns all catalogs with versions defined for the base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CatalogListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CatalogWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.3. Get information about catalog version

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

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

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CatalogVersionWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Path

categoryId
required

Category identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CategoryHierarchyWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5. Component

Component Controller

3.5.1. Get components' data by id given in body

POST /{baseSiteId}/cms/components
Description

Given a list of component identifiers in body, return cms component data.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalogCode
optional

Catalog code

string

Query

categoryCode
optional

Category code

string

Query

currentPage
optional

Optional pagination parameter. Default value 0.

integer(int32)

"0"

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Optional pagination parameter. Default value 10.

integer(int32)

"10"

Query

productCode
optional

Product code

string

Query

sort
optional

Optional sort criterion. No default value.

string

Body

componentIdList
required

List of Component identifiers

ComponentIDListWsDTO

Responses
HTTP Code Description Schema

200

OK

ListAdaptedComponents

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5.2. Get component data

GET /{baseSiteId}/cms/components/{componentId}
Description

Given a component identifier, return cms component data.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

componentId
required

Component identifier

string

Query

catalogCode
optional

Catalog code

string

Query

categoryCode
optional

Category code

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

productCode
optional

Product code

string

Responses
HTTP Code Description Schema

200

OK

ComponentAdaptedData

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.6. Consents

Consents Controller

3.6.1. A user can give consent

POST /{baseSiteId}/users/{userId}/consents
Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

consentTemplateId
optional

Consent template ID.

string

Query

consentTemplateVersion
optional

Consent template version.

integer(int32)

Responses
HTTP Code Description Schema

200

OK

ConsentTemplateWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

consentCode
required

consentCode

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

ConsentTemplateListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

consentTemplateId
required

Consent template id.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

ConsentTemplateWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.7. 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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

type
optional

The type of countries.

enum (SHIPPING, BILLING)

Responses
HTTP Code Description Schema

200

OK

CountryListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.7.2. Fetch the list of regions for the provided country

GET /{baseSiteId}/countries/{countyIsoCode}/regions
Description

Lists all regions

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countyIsoCode
required

An ISO code for a country

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

RegionListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.8. 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
required

Base site identifier

string

Body

userGroup
required

User group object with id and name.

UserGroupWsDTO

Responses
HTTP Code Description Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

currentPage
optional

Current page number (starts with 0).

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"BASIC"

Query

pageSize
optional

Number of customer group returned in one page.

integer(int32)

"20"

Responses
HTTP Code Description Schema

200

OK

UserGroupListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"BASIC"

Responses
HTTP Code Description Schema

200

OK

UserGroupWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to set for customer group.

MemberListWsDTO

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

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to assign to customer group.

MemberListWsDTO

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Query

catalog
optional

The catalog to retrieve products from. The catalog must be provided along with the version.

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

timestamp
optional

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
optional

The catalog version. The catalog version must be provided along with the catalog.

string

Responses
HTTP Code Description Schema

200

OK

ProductListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

storeName
required

The name of the store where items will be picked up

string

Responses
HTTP Code Description Schema

200

OK

CartModificationListWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PointOfServiceListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.10.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

extendedMerchantCallback
optional

Define which url should be returned

boolean

"false"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

responseUrl
required

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

PaymentRequestWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.10.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
required

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PaymentDetailsWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PaymentDetailsWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.10.6. Deletes payment provider response related to cart

DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
Description

Deletes the payment provider response related to the specified cart.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

bundleTemplateCode
required

Bundle Template identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

recurrencies
optional

Response configuration. This is the number of recurrencies in the response body.

integer(int32)

"4"

Responses
HTTP Code Description Schema

200

OK

BundleTemplateWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.11.2. Add to Cart

POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-add-to-cart
Description

Adds a provided product to the specified cart of a specified user.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

productCode
optional

Product code

string

Query

quantity
optional

Quantity

integer(int32)

"1"

Responses
HTTP Code Description Schema

200

OK

CartModificationWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.11.3. Start bundle

POST /{baseSiteId}/users/{userId}/carts/{cartId}/fs-start-bundle
Description

Starts a new bundle with a specified main product of a specified cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

bundleTemplateId
optional

Bundle Template identifier

string

Query

fields
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

productCode
optional

Product code

string

Query

quantity
optional

Quantity

integer(int32)

"1"

Responses
HTTP Code Description Schema

200

OK

CartModificationWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.12. FSClaims

FS Claims Controller

3.12.1. Get all claims

GET /{baseSiteId}/users/{userId}/claims
Description

Returns information on all claims for a provided user of a specified base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

FsClaimListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.12.2. Create a claim

POST /{baseSiteId}/users/{userId}/claims/create
Description

Creates a claim for a provided policy.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

contractId
required

Contract identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

policyId
required

Policy identifier

string

Responses
HTTP Code Description Schema

201

Created

FsClaimWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.12.3. Delete a claim

DELETE /{baseSiteId}/users/{userId}/claims/{claimId}
Description

Deletes a claim for a provided user of a specified base store.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

claimId
required

Claim identifier

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.13. FSInsurancePolicies

FS Insurance Policies Controller

3.13.1. Get all policies

GET /{baseSiteId}/users/{userId}/policies
Description

Returns information on all policies for a provided user of a specified base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

category
optional

Parameter for filtering policies based on the category code.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

status
optional

Parameter for filtering policies based on the policy status.

string

Responses
HTTP Code Description Schema

200

OK

InsurancePolicyListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.13.2. Get a premium calendar

GET /{baseSiteId}/users/{userId}/policies/premium-calendar
Description

Returns premium calendar for a provided user of a specified base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

InsurancePolicyListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.13.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
required

Base site identifier

string

Path

contractNumber
required

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
required

Policy identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

InsurancePolicyWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Responses
HTTP Code Description Schema

201

Created

InsuranceQuoteWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

insuranceQuote
required

insuranceQuote

InsuranceQuoteWsDTO

Responses
HTTP Code Description Schema

200

OK

InsuranceQuoteWsDTO

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.14.3. Get all insurance quotes

GET /{baseSiteId}/users/{userId}/insurance-quotes
Description

Returns information on all quotes for a provided user of a specified base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

InsuranceQuoteListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.14.4. Get insurance quote for a specific user and quoteId

GET /{baseSiteId}/users/{userId}/insurance-quotes/{quoteId}
Description

Returns information on quote for a provided user of a specified base store.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

quoteId
optional

Parameter for filtering quotes based on the quoteId.

string

Responses
HTTP Code Description Schema

200

OK

InsuranceQuoteWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

timestamp
required

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

OrderStatusUpdateElementListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.16. Forgotten Passwords

Forgotten Passwords Controller

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

POST /{baseSiteId}/forgottenpasswordtokens
Description

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Query

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

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.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site 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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.18. Miscs

Miscs Controller

3.18.1. Get a list of supported payment card types.

GET /{baseSiteId}/cardtypes
Description

Lists supported payment card types.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CardTypeListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CurrencyListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

CountryListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

LanguageListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.18.5. Get a list of all localized titles.

GET /{baseSiteId}/titles
Description

Lists all localized titles.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

TitleListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19. Notification Preference

Notification Preference Controller

3.19.1. Gets all notification preferences of current customer

GET /{baseSiteId}/my-account/notificationpreferences
Description

Returns the notification preferences of current customer.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Responses
HTTP Code Description Schema

200

OK

notificationPreferenceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.2. Updates all notification preferences of current customer

PATCH /{baseSiteId}/my-account/notificationpreferences
Description

Updates the notification preference of current customer.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Query

email
optional

email channel

string

Query

site_message
optional

site message channel

string

Query

sms
optional

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

code
required

Order GUID (Globally Unique Identifier) or order CODE

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

OrderWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.20.2. Post a order

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

Authorizes the cart and places the order. The response contains the new order data.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

cartId
required

Cart code for logged in user, cart GUID for guest checkout

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

securityCode
optional

CCV security code.

string

Responses
HTTP Code Description Schema

201

Created

OrderWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

sort
optional

Sorting method applied to the return results.

string

Query

statuses
optional

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

OrderHistoryListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

statuses
optional

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

code
required

Order GUID (Globally Unique Identifier) or order CODE

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

OrderWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

code
optional

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
optional

Response configuration (list of fields, which should be returned in response)

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageLabelOrId
optional

Page Label or Id

string

Query

pageType
optional

page type

enum (ContentPage, ProductPage, CategoryPage, CatalogPage)

"ContentPage"

Responses
HTTP Code Description Schema

200

OK

CMSPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22. Payment Details

Payment Details Controller

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

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

Return customer’s credit card payment details list.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

saved
required

Type of payment details.

boolean

"false"

Responses
HTTP Code Description Schema

200

OK

PaymentDetailsListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.2. Get customer’s credit card payment details.

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

Returns a customer’s credit card payment details for the specified paymentDetailsId.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PaymentDetailsWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

paymentDetails
required

Payment details object.

PaymentDetailsWsDTO

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

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.4. Delete customer’s credit card payment details.

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

Removes a customer’s credit card payment details based on a specified paymentDetailsId.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

paymentDetailsId
required

Payment details identifier.

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

paymentDetails
required

Payment details object

PaymentDetailsWsDTO

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

catalog
optional

Only products from this catalog are returned. Format: catalogId:catalogVersion

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

timestamp
required

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

ProductExpressUpdateElementListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

The context to be used in the search query.

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

query
optional

Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2

string

Query

searchQueryContext
optional

searchQueryContext

string

Query

sort
optional

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

ProductSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Query

query
optional

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

max
required

Specifies the limit of results.

integer(int32)

"10"

Query

term
required

Specified term

string

Responses
HTTP Code Description Schema

200

OK

SuggestionListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.5. Get product details

GET /{baseSiteId}/products/{productCode}
Description

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

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

ProductWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

pageSize
optional

Maximum size of returned results.

integer(int32)

"2147483647"

Query

referenceType
required

Reference type according to enum ProductReferenceTypeEnum

string

Responses
HTTP Code Description Schema

200

OK

ProductReferenceListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.23.7. Creates a new customer review as an anonymous user

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

Creates a new customer review as an anonymous user.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

review
required

Object contains review details like : rating, alias, headline, comment

ReviewWsDTO

Responses
HTTP Code Description Schema

201

Created

ReviewWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.8. Get reviews for a product

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

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

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

maxCount
optional

Maximum count of reviews

integer(int32)

Responses
HTTP Code Description Schema

200

OK

ReviewListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

latitude
optional

Latitude location parameter.

number(double)

Query

location
optional

Free-text location

string

Query

longitude
optional

Longitude location parameter.

number(double)

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Responses
HTTP Code Description Schema

200

OK

StoreFinderStockSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

latitude
optional

Latitude location parameter.

number(double)

Query

location
optional

Free-text location

string

Query

longitude
optional

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Path

storeName
required

Store identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

StockWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"BASIC"

Query

promotionGroup
optional

Only promotions from this group are returned

string

Query

type
required

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

PromotionListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

code
required

Promotion identifier (code)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"BASIC"

Responses
HTTP Code Description Schema

200

OK

PromotionWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

3.25. Save Cart

Save Cart Controller

3.25.1. Explicitly clones a cart.

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

Explicitly clones a cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

description
optional

The description that should be applied to the cloned cart.

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

name
optional

The name that should be applied to the cloned cart.

string

Responses
HTTP Code Description Schema

200

OK

SaveCartResultWsDTO

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

SaveCartResultWsDTO

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.25.3. Restore a saved cart.

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

Restore a saved cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

SaveCartResultWsDTO

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.25.4. Explicitly saves a cart.

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

Explicitly saves a cart.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

saveCartDescription
optional

The description that should be applied to the saved cart.

string

Query

saveCartName
optional

The name that should be applied to the saved cart.

string

Responses
HTTP Code Description Schema

200

OK

SaveCartResultWsDTO

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

SaveCartResultWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.26. Site Messages

FS Site Message Controller

3.26.1. Gets all site messages of current customer

GET /{baseSiteId}/notifications/sitemessages
Description

Returns the site messages of current customer.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

the current result page requested

string

"0"

Query

lang
optional

specifies the language

string

Query

needsTotal
optional

the flag for indicating if total number of results is needed or not

enum (true, false)

"true"

Query

pageSize
optional

the number of results returned per page

string

"10"

Query

sort
optional

the sorting method applied to the return results

string

Responses
HTTP Code Description Schema

200

OK

siteMessageSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.26.2. Get all site messages by message group

GET /{baseSiteId}/users/{userId}/notifications/sitemessages
Description

Returns the site messages of customer for specified message group.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

currentPage
optional

the current result page requested

string

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

lang
optional

specifies the language

string

"en"

Query

messagegroup
optional

Message group. Default value is generalMessageGroup.

string

"generalMessageGroup"

Query

pageSize
optional

the number of results returned per page

string

"5"

Query

sortCode
optional

the sorting method applied to the return results

string

"sentDate"

Query

sortOrder
optional

the sorting order method applied to the return results

string

"desc"

Responses
HTTP Code Description Schema

200

OK

siteMessageSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.26.3. Updates the read date of provided site messages

PUT /{baseSiteId}/users/{userId}/notifications/sitemessages/read-unread
Description

Updates the read date of provided site messages for a customer

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

messageCodes
required

List of site message identifiers

< string > array(multi)

Query

readStatus
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.26.4. Get a site message by message code

GET /{baseSiteId}/users/{userId}/notifications/sitemessages/{messageCode}
Description

Returns the site message of customer for specified message code.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

messageCode
required

Message Code

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

siteMessage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number(double)

"0.0"

Query

currentPage
optional

The current result page requested.

integer(int32)

"0"

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

latitude
optional

Coordinate that specifies the north-south position of a point on the Earth’s surface.

number(double)

Query

longitude
optional

Coordinate that specifies the east-west position of a point on the Earth’s surface.

number(double)

Query

pageSize
optional

The number of results returned per page.

integer(int32)

"20"

Query

query
optional

Location in natural language i.e. city or country.

string

Query

radius
optional

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

number(double)

"100000.0"

Query

sort
optional

Sorting method applied to the return results.

string

"asc"

Responses
HTTP Code Description Schema

200

OK

StoreFinderSearchPageWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.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
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number(double)

"0.0"

Query

latitude
optional

Coordinate that specifies the north-south position of a point on the Earth’s surface.

number(double)

Query

longitude
optional

Coordinate that specifies the east-west position of a point on the Earth’s surface.

number(double)

Query

query
optional

Location in natural language i.e. city or country.

string

Query

radius
optional

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

number(double)

"100000.0"

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.27.3. Get a store location

GET /{baseSiteId}/stores/{storeId}
Description

Returns store location based on its unique name.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

storeId
required

Store identifier (currently store name)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

PointOfServiceWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Body

user
required

User’s object.

UserSignUpWsDTO

Responses
HTTP Code Description Schema

201

Created

UserWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.2. Get customer profile

GET /{baseSiteId}/users/{userId}
Description

Returns customer profile.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

UserWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

user
required

User’s object

UserWsDTO

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

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.4. Delete customer profile

DELETE /{baseSiteId}/users/{userId}
Description

Removes customer profile.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.5. Updates customer profile

PATCH /{baseSiteId}/users/{userId}
Description

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

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Body

user
required

User’s object.

UserWsDTO

Responses
HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes
  • application/xml

  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.6. Get all customer groups of a customer.

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

Returns all customer groups of a customer.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Responses
HTTP Code Description Schema

200

OK

UserGroupListWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.7. Changes customer’s login name.

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

Changes a customer’s login name. Requires the customer’s current password.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

newLogin
required

Customer’s new login name. Customer login is case insensitive.

string

Query

password
required

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.28.8. Changes customer’s password

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

Changes customer’s password.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user

string

Query

new
required

New password.

string

Query

old
optional

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

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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
required

Base site identifier

string

Path

code
required

Voucher identifier (code)

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body.

enum (BASIC, DEFAULT, FULL)

"BASIC"

Responses
HTTP Code Description Schema

200

OK

VoucherWsDTO

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes
  • application/json

Produces
  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_client_credentials

4. Definitions

4.1. AddressListWsDTO

Name Schema

addresses
optional

< AddressWsDTO > array

4.2. AddressValidationWsDTO

Name Schema

decision
optional

string

errors
optional

errorList

suggestedAddresses
optional

< AddressWsDTO > array

4.3. AddressWsDTO

Name Schema

companyName
optional

string

country
optional

CountryWsDTO

defaultAddress
optional

boolean

email
optional

string

firstName
optional

string

formattedAddress
optional

string

id
optional

string

lastName
optional

string

line1
optional

string

line2
optional

string

phone
optional

string

postalCode
optional

string

region
optional

RegionWsDTO

shippingAddress
optional

boolean

title
optional

string

titleCode
optional

string

town
optional

string

visibleInAddressBook
optional

boolean

4.4. AgentWsDTO

Name Schema

categories
optional

< CategoryWsDTO > array

contactEmail
optional

string

firstName
optional

string

lastName
optional

string

pointsOfService
optional

< PointOfServiceWsDTO > array

thumbnail
optional

ImageWsDTO

4.5. AllowedFSRequestTypeWsDTO

Name Schema

code
optional

string

requestType
optional

FSRequestTypeWsDTO

4.6. BaseOptionWsDTO

Name Schema

options
optional

< VariantOptionWsDTO > array

selected
optional

VariantOptionWsDTO

variantType
optional

string

4.7. BaseStoreWsDTO

Name Schema

createReturnProcessCode
optional

string

currencies
optional

< CurrencyWsDTO > array

defaultCurrency
optional

CurrencyWsDTO

defaultDeliveryOrigin
optional

PointOfServiceWsDTO

defaultLanguage
optional

LanguageWsDTO

deliveryCountries
optional

< CountryWsDTO > array

deliveryModes
optional

DeliveryModeListWsDTO

externalTaxEnabled
optional

boolean

languages
optional

< LanguageWsDTO > array

maxRadiusForPosSearch
optional

number(double)

name
optional

string

paymentProvider
optional

string

pointsOfService
optional

< PointOfServiceWsDTO > array

submitOrderProcessCode
optional

string

4.8. BillingCycleTypeWsDTO

Name Schema

code
optional

string

name
optional

string

4.9. BillingPlanWsDTO

Name Schema

billingCycleDay
optional

integer(int32)

billingCycleTypeData
optional

BillingCycleTypeWsDTO

billingTimeData
optional

BillingTimeWsDTO

id
optional

string

name
optional

string

4.10. BillingTimeWsDTO

Name Schema

code
optional

string

description
optional

string

helpContent
optional

string

name
optional

string

nameInOrder
optional

string

orderNumber
optional

integer(int32)

4.11. BreadcrumbWsDTO

Name Schema

facetCode
optional

string

facetName
optional

string

facetValueCode
optional

string

facetValueName
optional

string

removeQuery
optional

SearchStateWsDTO

truncateQuery
optional

SearchStateWsDTO

4.12. BundleTemplateWsDTO

Name Schema

childBundleTemplates
optional

< BundleTemplateWsDTO > array

id
optional

string

name
optional

string

products
optional

< ProductWsDTO > array

rootBundleTemplateName
optional

string

type
optional

string

version
optional

string

4.13. CMSPageWsDTO

Name Schema

contentSlots
optional

ContentSlotListWsDTO

defaultPage
optional

boolean

name
optional

string

template
optional

string

title
optional

string

typeCode
optional

string

uid
optional

string

4.14. CardTypeListWsDTO

Name Schema

cardTypes
optional

< CardTypeWsDTO > array

4.15. CardTypeWsDTO

Name Schema

code
optional

string

name
optional

string

4.16. CartListWsDTO

Name Schema

carts
optional

< CartWsDTO > array

4.17. CartModificationListWsDTO

Name Schema

cartModifications
optional

< CartModificationWsDTO > array

4.18. CartModificationWsDTO

Name Schema

deliveryModeChanged
optional

boolean

entry
optional

OrderEntryWsDTO

quantity
optional

integer(int64)

quantityAdded
optional

integer(int64)

statusCode
optional

string

statusMessage
optional

string

4.19. CartWsDTO

Name Schema

appliedOrderPromotions
optional

< PromotionResultWsDTO > array

appliedProductPromotions
optional

< PromotionResultWsDTO > array

appliedVouchers
optional

< VoucherWsDTO > array

calculated
optional

boolean

code
optional

string

deliveryAddress
optional

AddressWsDTO

deliveryCost
optional

PriceWsDTO

deliveryItemsQuantity
optional

integer(int64)

deliveryMode
optional

DeliveryModeWsDTO

deliveryOrderGroups
optional

< DeliveryOrderEntryGroupWsDTO > array

description
optional

string

entries
optional

< OrderEntryWsDTO > array

expirationTime
optional

string(date-time)

guid
optional

string

insuranceQuote
optional

InsuranceQuoteWsDTO

name
optional

string

net
optional

boolean

orderDiscounts
optional

PriceWsDTO

paymentInfo
optional

PaymentDetailsWsDTO

pickupItemsQuantity
optional

integer(int64)

pickupOrderGroups
optional

< PickupOrderEntryGroupWsDTO > array

potentialOrderPromotions
optional

< PromotionResultWsDTO > array

potentialProductPromotions
optional

< PromotionResultWsDTO > array

productDiscounts
optional

PriceWsDTO

saveTime
optional

string(date-time)

savedBy
optional

PrincipalWsDTO

site
optional

string

store
optional

string

subTotal
optional

PriceWsDTO

totalDiscounts
optional

PriceWsDTO

totalItems
optional

integer(int32)

totalPrice
optional

PriceWsDTO

totalPriceWithTax
optional

PriceWsDTO

totalTax
optional

PriceWsDTO

totalUnitCount
optional

integer(int32)

user
optional

PrincipalWsDTO

4.20. CatalogListWsDTO

Name Schema

catalogs
optional

< CatalogWsDTO > array

4.21. CatalogVersionWsDTO

Name Schema

categories
optional

< CategoryHierarchyWsDTO > array

id
optional

string

lastModified
optional

string(date-time)

name
optional

string

url
optional

string

4.22. CatalogWsDTO

Name Schema

catalogVersions
optional

< CatalogVersionWsDTO > array

id
optional

string

lastModified
optional

string(date-time)

name
optional

string

url
optional

string

4.23. CategoryHierarchyWsDTO

Name Schema

id
optional

string

lastModified
optional

string(date-time)

name
optional

string

subcategories
optional

< CategoryHierarchyWsDTO > array

url
optional

string

4.24. CategoryWsDTO

Name Schema

allowedFSRequestTypes
optional

< AllowedFSRequestTypeWsDTO > array

code
optional

string

image
optional

ImageWsDTO

name
optional

string

url
optional

string

4.25. ClassificationWsDTO

Name Schema

code
optional

string

features
optional

< FeatureWsDTO > array

name
optional

string

4.26. ComponentAdaptedData

Type : object

4.27. ComponentIDListWsDTO

Name Schema

idList
optional

< string > array

4.28. ComponentListWsDTO

Name Schema

component
optional

< ComponentWsDTO > array

4.29. ComponentWsDTO

Name Schema

modifiedtime
optional

string(date-time)

name
optional

string

otherProperties
optional

object

simpleCMSComponents
optional

< ComponentWsDTO > array

tabComponents
optional

< ComponentWsDTO > array

typeCode
optional

string

uid
optional

string

4.30. ConfigurationInfoWsDTO

Name Schema

configurationLabel
optional

string

configurationValue
optional

string

configuratorType
optional

string

status
optional

string

4.31. ConsentTemplateListWsDTO

Name Schema

consentTemplates
optional

< ConsentTemplateWsDTO > array

4.32. ConsentTemplateWsDTO

Name Schema

currentConsent
optional

ConsentWsDTO

description
optional

string

id
optional

string

name
optional

string

version
optional

integer(int32)

4.33. ConsentWsDTO

Name Schema

code
optional

string

consentGivenDate
optional

string(date-time)

consentWithdrawnDate
optional

string(date-time)

4.34. ConsignmentEntryWsDTO

Name Schema

orderEntry
optional

OrderEntryWsDTO

quantity
optional

integer(int64)

shippedQuantity
optional

integer(int64)

4.35. ConsignmentWsDTO

Name Schema

code
optional

string

deliveryPointOfService
optional

PointOfServiceWsDTO

entries
optional

< ConsignmentEntryWsDTO > array

shippingAddress
optional

AddressWsDTO

status
optional

string

statusDate
optional

string(date-time)

trackingID
optional

string

4.36. ContentSlotListWsDTO

Name Schema

contentSlot
optional

< ContentSlotWsDTO > array

4.37. ContentSlotWsDTO

Name Schema

components
optional

ComponentListWsDTO

name
optional

string

position
optional

string

slotId
optional

string

slotShared
optional

boolean

slotStatus
optional

string

4.38. CountryListWsDTO

Name Schema

countries
optional

< CountryWsDTO > array

4.39. CountryWsDTO

Name Schema

isocode
optional

string

name
optional

string

4.40. CurrencyListWsDTO

Name Schema

currencies
optional

< CurrencyWsDTO > array

4.41. CurrencyWsDTO

Name Schema

active
optional

boolean

isocode
optional

string

name
optional

string

symbol
optional

string

4.42. DeliveryModeListWsDTO

Name Schema

deliveryModes
optional

< DeliveryModeWsDTO > array

4.43. DeliveryModeWsDTO

Name Schema

code
optional

string

deliveryCost
optional

PriceWsDTO

description
optional

string

name
optional

string

4.44. DeliveryOrderEntryGroupWsDTO

Name Schema

deliveryAddress
optional

AddressWsDTO

entries
optional

< OrderEntryWsDTO > array

quantity
optional

integer(int64)

totalPriceWithTax
optional

PriceWsDTO

4.45. EmployeeWsDTO

Name Schema

contactInfos
optional

< PhoneContactInfoWsDTO > array

displayName
optional

string

email
optional

string

4.46. FSIncidentTypeWsDTO

Name Schema

icon
optional

ImageWsDTO

incidentName
optional

string

4.47. FSInvestmentInfoWsDTO

Name Schema

distributionPercentage
optional

number(double)

investmentType
optional

FSInvestmentTypeWsDTO

4.48. FSInvestmentTypeWsDTO

Name Schema

factSheetDocument
optional

MediaData

fiveYearPerformance
optional

number(double)

fundName
optional

string

isin
optional

string

riskReturningRating
optional

string

4.49. FSRequestTypeWsDTO

Name Schema

code
optional

string

4.50. FacetValueWsDTO

Name Schema

count
optional

integer(int64)

name
optional

string

query
optional

SearchStateWsDTO

selected
optional

boolean

4.51. FacetWsDTO

Name Schema

category
optional

boolean

multiSelect
optional

boolean

name
optional

string

priority
optional

integer(int32)

topValues
optional

< FacetValueWsDTO > array

values
optional

< FacetValueWsDTO > array

visible
optional

boolean

4.52. FeatureUnitWsDTO

Name Schema

name
optional

string

symbol
optional

string

unitType
optional

string

4.53. FeatureValueWsDTO

Name Schema

value
optional

string

4.54. FeatureWsDTO

Name Schema

code
optional

string

comparable
optional

boolean

description
optional

string

featureUnit
optional

FeatureUnitWsDTO

featureValues
optional

< FeatureValueWsDTO > array

name
optional

string

range
optional

boolean

type
optional

string

4.55. FsClaimListWsDTO

Name Schema

claims
optional

< FsClaimWsDTO > array

4.56. FsClaimWsDTO

Name Schema

claimHandler
optional

EmployeeWsDTO

claimNumber
optional

string

claimStatus
optional

string

dateOfLoss
optional

string

incidentType
optional

FSIncidentTypeWsDTO

insurancePolicy
optional

InsurancePolicyWsDTO

requestId
optional

string

4.57. FutureStockWsDTO

Name Schema

date
optional

string(date-time)

formattedDate
optional

string

stock
optional

StockWsDTO

4.58. GeoPointWsDTO

Name Schema

latitude
optional

number(double)

longitude
optional

number(double)

4.59. ImageWsDTO

Name Schema

altText
optional

string

format
optional

string

galleryIndex
optional

integer(int32)

imageType
optional

enum (PRIMARY, GALLERY)

url
optional

string

4.60. InsuranceBenefitWSDTO

Name Schema

coverageInformation
optional

string

coverageValue
optional

string

description
optional

string

name
optional

string

4.61. InsuranceCoverageWsDTO

Name Schema

benefits
optional

< InsuranceBenefitWSDTO > array

coverageIsIncluded
optional

boolean

coverageProduct
optional

ProductWsDTO

investmentInfo
optional

< FSInvestmentInfoWsDTO > array

4.62. InsurancePolicyListWsDTO

Name Schema

insurancePolicies
optional

< InsurancePolicyWsDTO > array

4.63. InsurancePolicyWsDTO

Name Schema

billingData
optional

< SubscriptionBillingWsDTO > array

categoryData
optional

CategoryWsDTO

contractNumber
optional

string

insuredObjects
optional

< InsuredObjectWsDTO > array

mainProduct
optional

InsuranceCoverageWsDTO

optionalProducts
optional

< InsuranceCoverageWsDTO > array

paymentFrequency
optional

string

paymentMethod
optional

PaymentDetailsWsDTO

policyEndDate
optional

string

policyNumber
optional

string

policyPremium
optional

PriceWsDTO

policyProduct
optional

ProductWsDTO

policyStartDate
optional

string

responsibleAgent
optional

AgentWsDTO

4.64. InsuranceQuoteListWsDTO

Name Schema

insuranceQuotes
optional

< InsuranceQuoteWsDTO > array

4.65. InsuranceQuoteWsDTO

Name Schema

cartCode
optional

string

configurable
optional

boolean

defaultCategory
optional

CategoryWsDTO

expiryDate
optional

string

isExpired
optional

boolean

isMonthly
optional

boolean

planName
optional

string

quoteDetails
optional

< string, string > map

quoteId
optional

string

quoteImages
optional

< ImageWsDTO > array

quotePrice
optional

string

quoteStatus
optional

string

quoteTitle
optional

string

quoteWorkflowStatus
optional

QuoteWorkflowStatusWsDTO

startDate
optional

string

state
optional

QuoteBindingStateWsDTO

4.66. InsuredObjectItemWsDTO

Name Schema

label
optional

string

order
optional

integer(int32)

value
optional

string

4.67. InsuredObjectTypeWsDTO

Name Schema

code
optional

string

4.68. InsuredObjectWsDTO

Name Schema

insuredObjectItems
optional

< InsuredObjectItemWsDTO > array

insuredObjectType
optional

InsuredObjectTypeWsDTO

4.69. LanguageListWsDTO

Name Schema

languages
optional

< LanguageWsDTO > array

4.70. LanguageWsDTO

Name Schema

active
optional

boolean

isocode
optional

string

name
optional

string

nativeName
optional

string

4.71. ListAdaptedComponents

Name Schema

components
optional

< ComponentAdaptedData > array

pagination
optional

pagination

sorts
optional

< sort > array

4.72. MediaData

Name Schema

altText
optional

string

catalogId
optional

string

catalogVersion
optional

string

code
optional

string

description
optional

string

downloadUrl
optional

string

mime
optional

string

url
optional

string

uuid
optional

string

4.73. MemberListWsDTO

Name Schema

members
optional

< PrincipalWsDTO > array

4.74. OneTimeChargeEntryWsDTO

Name Schema

billingTime
optional

BillingTimeWsDTO

name
optional

string

price
optional

PriceWsDTO

4.75. OpeningScheduleWsDTO

Name Schema

code
optional

string

name
optional

string

specialDayOpeningList
optional

< SpecialOpeningDayWsDTO > array

weekDayOpeningList
optional

< WeekdayOpeningDayWsDTO > array

4.76. OrderEntryListWsDTO

Name Schema

orderEntries
optional

< OrderEntryWsDTO > array

4.77. OrderEntryWsDTO

Name Schema

addable
optional

boolean

basePrice
optional

PriceWsDTO

configurationInfos
optional

< ConfigurationInfoWsDTO > array

deliveryMode
optional

DeliveryModeWsDTO

deliveryPointOfService
optional

PointOfServiceWsDTO

entryNumber
optional

integer(int32)

product
optional

ProductWsDTO

quantity
optional

integer(int64)

removeable
optional

boolean

totalPrice
optional

PriceWsDTO

updateable
optional

boolean

4.78. OrderHistoryListWsDTO

Name Schema

orders
optional

< OrderHistoryWsDTO > array

pagination
optional

PaginationWsDTO

sorts
optional

< SortWsDTO > array

4.79. OrderHistoryWsDTO

Name Schema

code
optional

string

guid
optional

string

placed
optional

string(date-time)

status
optional

string

statusDisplay
optional

string

total
optional

PriceWsDTO

4.80. OrderStatusUpdateElementListWsDTO

Name Schema

orderStatusUpdateElements
optional

< OrderStatusUpdateElementWsDTO > array

4.81. OrderStatusUpdateElementWsDTO

Name Schema

baseSiteId
optional

string

code
optional

string

status
optional

string

4.82. OrderWsDTO

Name Schema

appliedOrderPromotions
optional

< PromotionResultWsDTO > array

appliedProductPromotions
optional

< PromotionResultWsDTO > array

appliedVouchers
optional

< VoucherWsDTO > array

calculated
optional

boolean

code
optional

string

consignments
optional

< ConsignmentWsDTO > array

created
optional

string(date-time)

deliveryAddress
optional

AddressWsDTO

deliveryCost
optional

PriceWsDTO

deliveryItemsQuantity
optional

integer(int64)

deliveryMode
optional

DeliveryModeWsDTO

deliveryOrderGroups
optional

< DeliveryOrderEntryGroupWsDTO > array

deliveryStatus
optional

string

deliveryStatusDisplay
optional

string

entries
optional

< OrderEntryWsDTO > array

guestCustomer
optional

boolean

guid
optional

string

net
optional

boolean

orderDiscounts
optional

PriceWsDTO

paymentInfo
optional

PaymentDetailsWsDTO

pickupItemsQuantity
optional

integer(int64)

pickupOrderGroups
optional

< PickupOrderEntryGroupWsDTO > array

productDiscounts
optional

PriceWsDTO

site
optional

string

status
optional

string

statusDisplay
optional

string

store
optional

string

subTotal
optional

PriceWsDTO

totalDiscounts
optional

PriceWsDTO

totalItems
optional

integer(int32)

totalPrice
optional

PriceWsDTO

totalPriceWithTax
optional

PriceWsDTO

totalTax
optional

PriceWsDTO

unconsignedEntries
optional

< OrderEntryWsDTO > array

user
optional

PrincipalWsDTO

4.83. PaginationWsDTO

Name Schema

currentPage
optional

integer(int32)

pageSize
optional

integer(int32)

sort
optional

string

totalPages
optional

integer(int32)

totalResults
optional

integer(int64)

4.84. PaymentDetailsListWsDTO

Name Schema

payments
optional

< PaymentDetailsWsDTO > array

4.85. PaymentDetailsWsDTO

Name Schema

accountHolderName
optional

string

billingAddress
optional

AddressWsDTO

cardNumber
optional

string

cardType
optional

CardTypeWsDTO

defaultPayment
optional

boolean

expiryMonth
optional

string

expiryYear
optional

string

id
optional

string

issueNumber
optional

string

paymentOption
optional

string

saved
optional

boolean

startMonth
optional

string

startYear
optional

string

subscriptionId
optional

string

4.86. PaymentRequestWsDTO

Name Schema

mappingLabels
optional

< string, string > map

parameters
optional

< string, string > map

postUrl
optional

string

4.87. PhoneContactInfoWsDTO

Name Schema

code
optional

string

phoneNumber
optional

string

4.88. PickupOrderEntryGroupWsDTO

Name Schema

deliveryPointOfService
optional

PointOfServiceWsDTO

distance
optional

number(double)

entries
optional

< OrderEntryWsDTO > array

quantity
optional

integer(int64)

totalPriceWithTax
optional

PriceWsDTO

4.89. PointOfServiceListWsDTO

Name Schema

pointOfServices
optional

< PointOfServiceWsDTO > array

4.90. PointOfServiceStockWsDTO

Name Schema

address
optional

AddressWsDTO

description
optional

string

displayName
optional

string

distanceKm
optional

number(double)

features
optional

< string, string > map

formattedDistance
optional

string

geoPoint
optional

GeoPointWsDTO

mapIcon
optional

ImageWsDTO

name
optional

string

openingHours
optional

OpeningScheduleWsDTO

stockInfo
optional

StockWsDTO

storeContent
optional

string

storeImages
optional

< ImageWsDTO > array

url
optional

string

4.91. PointOfServiceWsDTO

Name Schema

address
optional

AddressWsDTO

description
optional

string

displayName
optional

string

distanceKm
optional

number(double)

features
optional

< string, string > map

formattedDistance
optional

string

geoPoint
optional

GeoPointWsDTO

mapIcon
optional

ImageWsDTO

name
optional

string

openingHours
optional

OpeningScheduleWsDTO

storeContent
optional

string

storeImages
optional

< ImageWsDTO > array

url
optional

string

4.92. PriceRangeWsDTO

Name Schema

maxPrice
optional

PriceWsDTO

minPrice
optional

PriceWsDTO

4.93. PriceWsDTO

Name Schema

currencyIso
optional

string

formattedValue
optional

string

maxQuantity
optional

integer(int64)

minQuantity
optional

integer(int64)

name
optional

string

oneTimeChargeEntries
optional

< OneTimeChargeEntryWsDTO > array

priceType
optional

enum (BUY, FROM)

value
optional

number

4.94. PrincipalWsDTO

Name Schema

name
optional

string

uid
optional

string

4.95. ProductExpressUpdateElementListWsDTO

Name Schema

productExpressUpdateElements
optional

< ProductExpressUpdateElementWsDTO > array

4.96. ProductExpressUpdateElementWsDTO

Name Schema

catalogId
optional

string

catalogVersion
optional

string

code
optional

string

4.97. ProductListWsDTO

Name Schema

catalog
optional

string

currentPage
optional

integer(int32)

products
optional

< ProductWsDTO > array

totalPageCount
optional

integer(int32)

totalProductCount
optional

integer(int32)

version
optional

string

4.98. ProductReferenceListWsDTO

Name Schema

references
optional

< ProductReferenceWsDTO > array

4.99. ProductReferenceWsDTO

Name Schema

description
optional

string

preselected
optional

boolean

quantity
optional

integer(int32)

referenceType
optional

string

target
optional

ProductWsDTO

4.100. ProductSearchPageWsDTO

Name Schema

breadcrumbs
optional

< BreadcrumbWsDTO > array

categoryCode
optional

string

currentQuery
optional

SearchStateWsDTO

facets
optional

< FacetWsDTO > array

freeTextSearch
optional

string

keywordRedirectUrl
optional

string

pagination
optional

PaginationWsDTO

products
optional

< ProductWsDTO > array

sorts
optional

< SortWsDTO > array

spellingSuggestion
optional

SpellingSuggestionWsDTO

4.101. ProductWsDTO

Name Schema

addToCartDisabled
optional

boolean

addToCartDisabledMessage
optional

string

availableForPickup
optional

boolean

averageRating
optional

number(double)

baseOptions
optional

< BaseOptionWsDTO > array

baseProduct
optional

string

bundleTemplates
optional

< BundleTemplateWsDTO > array

categories
optional

< CategoryWsDTO > array

classifications
optional

< ClassificationWsDTO > array

code
optional

string

configurable
optional

boolean

configuratorType
optional

string

defaultCategory
optional

CategoryWsDTO

description
optional

string

futureStocks
optional

< FutureStockWsDTO > array

images
optional

< ImageWsDTO > array

keywords
optional

< string > array

lowestBundlePrice
optional

PriceWsDTO

manufacturer
optional

string

multidimensional
optional

boolean

name
optional

string

numberOfReviews
optional

integer(int32)

potentialPromotions
optional

< PromotionWsDTO > array

price
optional

PriceWsDTO

priceRange
optional

PriceRangeWsDTO

productReferences
optional

< ProductReferenceWsDTO > array

purchasable
optional

boolean

reviews
optional

< ReviewWsDTO > array

soldIndividually
optional

boolean

stock
optional

StockWsDTO

subscriptionTerm
optional

SubscriptionTermWsDTO

summary
optional

string

tags
optional

< string > array

url
optional

string

variantMatrix
optional

< VariantMatrixElementWsDTO > array

variantOptions
optional

< VariantOptionWsDTO > array

variantType
optional

string

volumePrices
optional

< PriceWsDTO > array

volumePricesFlag
optional

boolean

4.102. PromotionListWsDTO

Name Schema

promotions
optional

< PromotionWsDTO > array

4.103. PromotionOrderEntryConsumedWsDTO

Name Schema

adjustedUnitPrice
optional

number(double)

code
optional

string

orderEntryNumber
optional

integer(int32)

quantity
optional

integer(int64)

4.104. PromotionRestrictionWsDTO

Name Schema

description
optional

string

restrictionType
optional

string

4.105. PromotionResultListWsDTO

Name Schema

promotions
optional

< PromotionResultWsDTO > array

4.106. PromotionResultWsDTO

Name Schema

consumedEntries
optional

< PromotionOrderEntryConsumedWsDTO > array

description
optional

string

promotion
optional

PromotionWsDTO

4.107. PromotionWsDTO

Name Schema

code
optional

string

couldFireMessages
optional

< string > array

description
optional

string

enabled
optional

boolean

endDate
optional

string(date-time)

firedMessages
optional

< string > array

priority
optional

integer(int32)

productBanner
optional

ImageWsDTO

promotionGroup
optional

string

promotionType
optional

string

restrictions
optional

< PromotionRestrictionWsDTO > array

startDate
optional

string(date-time)

title
optional

string

4.108. QuoteBindingStateWsDTO

Name Schema

code
optional

string

4.109. QuoteWorkflowStatusWsDTO

Name Schema

code
optional

string

4.110. RegionListWsDTO

Name Schema

regions
optional

< RegionWsDTO > array

4.111. RegionWsDTO

Name Schema

countryIso
optional

string

isocode
optional

string

isocodeShort
optional

string

name
optional

string

4.112. ReviewListWsDTO

Name Schema

reviews
optional

< ReviewWsDTO > array

4.113. ReviewWsDTO

Name Schema

alias
optional

string

comment
optional

string

date
optional

string(date-time)

headline
optional

string

id
optional

string

principal
optional

UserWsDTO

rating
optional

number(double)

4.114. SaveCartResultWsDTO

Name Schema

savedCartData
optional

CartWsDTO

4.115. SearchQueryWsDTO

Name Schema

value
optional

string

4.116. SearchStateWsDTO

Name Schema

query
optional

SearchQueryWsDTO

url
optional

string

4.117. SortWsDTO

Name Schema

code
optional

string

name
optional

string

selected
optional

boolean

4.118. SpecialOpeningDayWsDTO

Name Schema

closed
optional

boolean

closingTime
optional

TimeWsDTO

comment
optional

string

date
optional

string(date-time)

formattedDate
optional

string

name
optional

string

openingTime
optional

TimeWsDTO

4.119. SpellingSuggestionWsDTO

Name Schema

query
optional

string

suggestion
optional

string

4.120. StockWsDTO

Name Schema

stockLevel
optional

integer(int64)

stockLevelStatus
optional

string

4.121. StoreFinderSearchPageWsDTO

Name Schema

boundEastLongitude
optional

number(double)

boundNorthLatitude
optional

number(double)

boundSouthLatitude
optional

number(double)

boundWestLongitude
optional

number(double)

locationText
optional

string

pagination
optional

PaginationWsDTO

sorts
optional

< SortWsDTO > array

sourceLatitude
optional

number(double)

sourceLongitude
optional

number(double)

stores
optional

< PointOfServiceWsDTO > array

4.122. StoreFinderStockSearchPageWsDTO

Name Schema

boundEastLongitude
optional

number(double)

boundNorthLatitude
optional

number(double)

boundSouthLatitude
optional

number(double)

boundWestLongitude
optional

number(double)

locationText
optional

string

pagination
optional

PaginationWsDTO

product
optional

ProductWsDTO

sorts
optional

< SortWsDTO > array

sourceLatitude
optional

number(double)

sourceLongitude
optional

number(double)

stores
optional

< PointOfServiceStockWsDTO > array

4.123. SubscriptionBillingWsDTO

Name Schema

billingDate
optional

string

billingPeriod
optional

string

paymentAmount
optional

string

paymentStatus
optional

string

4.124. SubscriptionTermWsDTO

Name Schema

billingPlan
optional

BillingPlanWsDTO

cancellable
optional

boolean

id
optional

string

name
optional

string

termOfServiceFrequency
optional

TermOfServiceFrequencyWsDTO

termOfServiceNumber
optional

integer(int32)

termOfServiceRenewal
optional

TermOfServiceRenewalWsDTO

4.125. SuggestionListWsDTO

Name Schema

suggestions
optional

< SuggestionWsDTO > array

4.126. SuggestionWsDTO

Name Schema

value
optional

string

4.127. TermOfServiceFrequencyWsDTO

Name Schema

code
optional

string

name
optional

string

4.128. TermOfServiceRenewalWsDTO

Name Schema

code
optional

string

name
optional

string

4.129. TimeWsDTO

Name Schema

formattedHour
optional

string

hour
optional

string(byte)

minute
optional

string(byte)

4.130. TitleListWsDTO

Name Schema

titles
optional

< TitleWsDTO > array

4.131. TitleWsDTO

Name Schema

code
optional

string

name
optional

string

4.132. UserGroupListWsDTO

Name Schema

currentPage
optional

integer(int32)

numberOfPages
optional

integer(int32)

pageSize
optional

integer(int32)

totalNumber
optional

integer(int32)

userGroups
optional

< UserGroupWsDTO > array

4.133. UserGroupWsDTO

Name Schema

members
optional

< PrincipalWsDTO > array

membersCount
optional

integer(int32)

name
optional

string

subGroups
optional

< UserGroupWsDTO > array

uid
optional

string

4.134. UserSignUpWsDTO

Name Schema

firstName
optional

string

lastName
optional

string

password
optional

string

titleCode
optional

string

uid
optional

string

4.135. UserWsDTO

Name Schema

currency
optional

CurrencyWsDTO

customerId
optional

string

deactivationDate
optional

string(date-time)

defaultAddress
optional

AddressWsDTO

displayUid
optional

string

firstName
optional

string

language
optional

LanguageWsDTO

lastName
optional

string

name
optional

string

title
optional

string

titleCode
optional

string

uid
optional

string

4.136. VariantCategoryWsDTO

Name Schema

hasImage
optional

boolean

name
optional

string

priority
optional

integer(int32)

4.137. VariantMatrixElementWsDTO

Name Schema

elements
optional

< VariantMatrixElementWsDTO > array

isLeaf
optional

boolean

parentVariantCategory
optional

VariantCategoryWsDTO

variantOption
optional

VariantOptionWsDTO

variantValueCategory
optional

VariantValueCategoryWsDTO

4.138. VariantOptionQualifierWsDTO

Name Schema

image
optional

ImageWsDTO

name
optional

string

qualifier
optional

string

value
optional

string

4.139. VariantOptionWsDTO

Name Schema

code
optional

string

priceData
optional

PriceWsDTO

stock
optional

StockWsDTO

url
optional

string

variantOptionQualifiers
optional

< VariantOptionQualifierWsDTO > array

4.140. VariantValueCategoryWsDTO

Name Schema

name
optional

string

sequence
optional

integer(int32)

superCategories
optional

< VariantCategoryWsDTO > array

4.141. VoucherListWsDTO

Name Schema

vouchers
optional

< VoucherWsDTO > array

4.142. VoucherWsDTO

Name Schema

appliedValue
optional

PriceWsDTO

code
optional

string

currency
optional

CurrencyWsDTO

description
optional

string

freeShipping
optional

boolean

name
optional

string

value
optional

number(double)

valueFormatted
optional

string

valueString
optional

string

voucherCode
optional

string

4.143. WeekdayOpeningDayWsDTO

Name Schema

closed
optional

boolean

closingTime
optional

TimeWsDTO

openingTime
optional

TimeWsDTO

weekDay
optional

string

4.144. error

Error message

Name Description Schema

errorCode
optional

Error code

string

exceptionMessage
optional

string

language
optional

string

message
optional

Descriptive, human readable error message.

string

position
optional

integer(int32)

reason
optional

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

string

subject
optional

Identifier of the related object e.g. '1'.

string

subjectType
optional

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

string

type
optional

Type of the error e.g. 'LowStockError'.

string

4.145. errorList

List of errors

Name Schema

errors
optional

< error > array

4.146. notificationPreference

Notification preference

Name Description Schema

channel
optional

preference channel

enum (EMAIL, SMS, SITE_MESSAGE)

enabled
optional

if true, the channel is on; if false, the channel is off
Example : false

boolean

value
optional

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
optional

notification preferences

< notificationPreference > array

4.148. pagination

Pagination info

Name Description Schema

count
optional

Number of elements on this page

integer(int32)

hasNext
optional

Indicates if there is next page
Example : false

boolean

hasPrevious
optional

Indicates if there is previous page
Example : false

boolean

page
optional

Current page number

integer(int32)

totalCount
optional

Total number of elements

integer(int64)

totalPages
optional

Total number of pages

integer(int32)

4.149. siteMessage

Site message

Name Description Schema

content
optional

message content

string

link
optional

message link

string

notificationType
optional

notification type used for this message

enum (NOTIFICATION)

readDate
optional

message read date

string(date-time)

richContent
optional

message rich content

string

richTitle
optional

message rich title

string

sentDate
optional

sent date

string(date-time)

title
optional

message title

string

uid
optional

message uid

string

4.150. siteMessageSearchPage

Site message search page

Name Description Schema

messages
optional

site messages

< siteMessage > array

pagination
optional

pagination information

pagination

sorts
optional

sorting information

< sort > array

4.151. sort

Sort option

Name Description Schema

asc
optional

Example : false

boolean

code
optional

string