1. Overview

These services manage all of the common commerce functionality, and also include customizations from installed AddOns. The implementing extension is called commercewebservices.

1.1. Version information

Version : 2.0

1.2. License information

License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null

1.3. URI scheme

Host : localhost:9001
BasePath : /occ/v2

1.4. Tags

  • Address : Address Controller

  • Base Sites : Base Sites Controller

  • Base Stores : Base Stores Controller

  • Carts : Carts Controller

  • Catalogs : Catalogs Controller

  • Consents : Consents Controller

  • Countries : Countries Controller

  • Customer Groups : Customer Groups Controller

  • Export : Export Controller

  • Extended Carts : Extended Carts Controller

  • Feeds : Feeds Controller

  • Forgotten Passwords : Forgotten Passwords Controller

  • Login Notification : Login Notification Controller

  • Merchant Callback : Merchant Callback Controller

  • Miscs : Miscs Controller

  • Orders : Orders Controller

  • Payment Details : Payment Details Controller

  • Payment Modes : Payment Modes Controller

  • Products : Products Controller

  • Promotions : Promotions Controller

  • Return Requests : Order Returns Controller

  • Save Cart : Save Cart Controller

  • Stores : Stores Controller

  • Users : Users Controller

  • Vouchers : Vouchers Controller

1.5. 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Address object.

Address
Responses
HTTP Code Description Schema

201

Created

Address

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

AddressList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

address
required

Address object.

Address
Responses
HTTP Code Description Schema

200

OK

AddressValidation

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Address

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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.

Address
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

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

Address
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.2. Base Sites

Base Sites Controller

3.2.1. Get all base sites.

GET /basesites
Description

Get all base sites with corresponding base stores details in FULL mode.

Parameters
Type Name Description Schema Default

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

BaseSiteList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.3. Base Stores

Base Stores Controller

3.3.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

BaseStore

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4. Carts

Carts Controller

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

Cart

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

CartList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Cart

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.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 customer’s phone (phone), 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.

Address
Responses
HTTP Code Description Schema

201

Created

Address

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.7. Deletes the delivery address from the cart.

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

Deletes 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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

DeliveryMode

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.10. Deletes the delivery mode from the cart.

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

Deletes 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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

DeliveryModeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

OrderEntry
Responses
HTTP Code Description Schema

200

OK

CartModification

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

OrderEntryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

OrderEntry

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

OrderEntry
Responses
HTTP Code Description Schema

200

OK

CartModification

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

OrderEntry
Responses
HTTP Code Description Schema

200

OK

CartModification

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

PaymentDetails
Responses
HTTP Code Description Schema

201

Created

PaymentDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

PromotionResultList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.23. Get information about promotion 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

PromotionResultList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

VoucherList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.4.27. Deletes a voucher defined for the current cart.

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

Deletes 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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5. Catalogs

Catalogs Controller

3.5.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CatalogList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Catalog

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CatalogVersion

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.5.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CategoryHierarchy

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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
required

Consent template ID.

string

Query

consentTemplateVersion
required

Consent template version.

integer(int32)
Responses
HTTP Code Description Schema

200

OK

ConsentTemplate

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • 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

Consent 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
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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

ConsentTemplateList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

ConsentTemplate

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

type
optional

The type of countries.

enum (SHIPPING, BILLING)
Responses
HTTP Code Description Schema

200

OK

CountryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

RegionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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.

UserGroup
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

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. Examples: BASIC, DEFAULT, FULL

string

"BASIC"

Query

pageSize
optional

Number of customer group returned in one page.

integer(int32)

"20"
Responses
HTTP Code Description Schema

200

OK

UserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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. Examples: BASIC, DEFAULT, FULL

string

"BASIC"
Responses
HTTP Code Description Schema

200

OK

UserGroup

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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.

MemberList
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

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.

MemberList
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.8.6. Deletes a user from a customer group.

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

Deletes 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
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. Examples: BASIC, DEFAULT, FULL

string

"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

ProductList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

storeName
required

The name of the store where items will be picked up

string
Responses
HTTP Code Description Schema

200

OK

CartModificationList

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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. Examples: BASIC, DEFAULT, FULL

string

"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

PaymentRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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 “acceleratorocc 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PaymentDetails

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • 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 “acceleratorocc 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PaymentDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.11. Feeds

Feeds Controller

3.11.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. Examples: BASIC, DEFAULT, FULL

string

"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

OrderStatusUpdateElementList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.12. Forgotten Passwords

Forgotten Passwords Controller

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.12.2. Reset password after customer’s clicked forgotten password link.

POST /{baseSiteId}/resetpassword
Description

Reset password after customer’s clicked forgotten password link.

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Body

resetPassword
required

Request body parameter that contains details such as token and new password

ResetPassword
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/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.13. Login Notification

Login Notification Controller

3.13.1. Notify about successful login.

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

Publish notification event about successful login.

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

201

Created

No Content

202

Accepted

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.14. Merchant Callback

Merchant Callback Controller

3.14.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 “acceleratorocc 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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.14.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 “acceleratorocc 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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.15. Miscs

Miscs Controller

3.15.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CardTypeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.15.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CurrencyList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.15.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

CountryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.15.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

LanguageList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.15.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

TitleList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.16. Orders

Orders Controller

3.16.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Order

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.16.2. Place 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

201

Created

Order

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.16.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. Examples: BASIC, DEFAULT, FULL

string

"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

OrderHistoryList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.16.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Order

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.16.6. Cancel an order.

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

Cancels an order partially or completely

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Order code

string

Path

userId
required

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

string

Body

cancellationRequestEntryInputList
required

Cancellation request input list for the current order.

CancellationRequestEntryInputList
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/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.17. Payment Details

Payment Details Controller

3.17.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

saved
optional

Type of payment details.

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

PaymentDetailsList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.17.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PaymentDetails

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

PaymentDetails
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.17.4. Deletes customer’s credit card payment details.

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

Deletes 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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

PaymentDetails
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.18. Payment Modes

Payment Modes Controller

3.18.1. Gets all available payment modes.

GET /{baseSiteId}/paymentmodes
Description

Gets all payment modes 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PaymentModeList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19. Products

Products Controller

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"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

ProductExpressUpdateElementList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

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

The context to be used in the search query.

string

Query

sort
optional

Sorting method applied to the return results.

string
Responses
HTTP Code Description Schema

200

OK

ProductSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

max
optional

Specifies the limit of results.

integer(int32)

"10"

Query

term
required

Specified term

string
Responses
HTTP Code Description Schema

200

OK

SuggestionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Product

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

pageSize
optional

Maximum size of returned results.

integer(int32)

"2147483647"

Query

referenceType
optional

Comma-separated list of reference types according to enum ProductReferenceTypeEnum. If not specified, all types of product references will be used.

string
Responses
HTTP Code Description Schema

200

OK

ProductReferenceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

review
required

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

Review
Responses
HTTP Code Description Schema

201

Created

Review

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

maxCount
optional

Maximum count of reviews

integer(int32)
Responses
HTTP Code Description Schema

200

OK

ReviewList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"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

StoreFinderStockSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.19.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

Stock

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.20. Promotions

Promotions Controller

3.20.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. Examples: BASIC, DEFAULT, FULL

string

"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

PromotionList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.20.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. Examples: BASIC, DEFAULT, FULL

string

"BASIC"
Responses
HTTP Code Description Schema

200

OK

Promotion

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.21. Return Requests

Order Returns Controller

3.21.1. Create an order return request.

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

Creates an order return 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

returnRequestEntryInputList
required

Return request input list for the current order.

ReturnRequestEntryInputList
Responses
HTTP Code Description Schema

201

Created

ReturnRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.21.2. Gets the user’s return requests history

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

Returns order return request data associated with a specified user for 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

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. Examples: BASIC, DEFAULT, FULL

string

"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
Responses
HTTP Code Description Schema

200

OK

ReturnRequestList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.21.3. Get the details of a return request.

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

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

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

returnRequestCode
required

Order return request 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

ReturnRequest

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.21.4. Updates the order return request.

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

Updates the order return request. Only cancellation of the request is supported by setting the attribute status to CANCELLING. Cancellation of the return request cannot be reverted

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

returnRequestCode
required

Order return request code

string

Path

userId
required

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

string

Body

returnRequestModification
required

Return request modification object.

ReturnRequestModification
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/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22. Save Cart

Save Cart Controller

3.22.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Query

name
optional

The name that should be applied to the cloned cart.

string
Responses
HTTP Code Description Schema

200

OK

SaveCartResult

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

SaveCartResult

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

SaveCartResult

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.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. Examples: BASIC, DEFAULT, FULL

string

"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

SaveCartResult

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content
Consumes

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.22.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

SaveCartResult

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23. Stores

Stores Controller

3.23.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. Examples: BASIC, DEFAULT, FULL

string

"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

StoreFinderSearchPage

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.3. Get a list of store locations for a given country

GET /{baseSiteId}/stores/country/{countryIso}
Description

Lists all store locations that are in the specified country.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.4. Get a list of store locations for a given country and region

GET /{baseSiteId}/stores/country/{countryIso}/region/{regionIso}
Description

Lists all store locations that are in the specified country and region.

Parameters
Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Path

regionIso
required

Region ISO code

string

Query

fields
optional

Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PointOfServiceList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.5. Gets a store location count per country and regions

GET /{baseSiteId}/stores/storescounts
Description

Returns store counts in countries and regions

Parameters
Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string
Responses
HTTP Code Description Schema

200

OK

StoreCountList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.23.6. 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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

PointOfService

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.24. Users

Users Controller

3.24.1. Registers a customer

POST /{baseSiteId}/users
Description

Registers a customer. Requires the following parameters: login, password, firstName, lastName, titleCode.

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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"

Body

user
required

User’s object.

UserSignUp
Responses
HTTP Code Description Schema

201

Created

User

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Consumes

  • application/xml

  • application/json

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.24.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

User

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

User
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.24.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
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

User
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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.24.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. Examples: BASIC, DEFAULT, FULL

string

"DEFAULT"
Responses
HTTP Code Description Schema

200

OK

UserGroupList

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

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

Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

3.25. Vouchers

Vouchers Controller

3.25.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. Examples: BASIC, DEFAULT, FULL

string

"BASIC"
Responses
HTTP Code Description Schema

200

OK

Voucher

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content
Security
Type Name

oauth2

oauth2_Password

oauth2

oauth2_client_credentials

4. Definitions

4.1. Address

Request body fields required and optional to operate on address data. The DTO is in XML or .json format

Name Description Schema

cellphone
optional

Cellphone number

string

companyName
optional

Company Name

string

country
optional

Country where address is located

Country

defaultAddress
optional

Boolean flag if address is default

boolean

district
optional

District name

string

email
optional

Email address

string

firstName
required

First name of the address person

string

formattedAddress
optional

Boolean flag if address is formatted

string

id
optional

Unique id value of the address which is optional while creating new address. While performing other address operations this value is the key

string

lastName
required

Last name of the address person

string

line1
required

First line of the address

string

line2
optional

Second line of the address

string

phone
optional

Phone number

string

postalCode
required

Postal code of the address

string

region
optional

Region where address belongs to

Region

shippingAddress
optional

Boolean flag if address is for shipping

boolean

title
optional

Title of the address person

string

titleCode
required

Code of the title

string

town
required

Town, field required

string

visibleInAddressBook
optional

Boolean flag if address is visible in the Address Book

boolean

4.2. AddressList

Representation of an Address list

Name Description Schema

addresses
optional

List of addresses

< Address > array

4.3. AddressValidation

Representation of an Address Validation

Name Description Schema

decision
optional

Decision

string

errors
optional

List of errors

errorList

suggestedAddresses
optional

List of suggested addresses

< Address > array

4.4. BaseOption

Representation of a Base Ooption

Name Description Schema

options
optional

List of all variant options

< VariantOption > array

selected
optional

Variant option selected

VariantOption

variantType
optional

Variant type of base option

string

4.5. BaseSite

Representation of a Base Site

Name Description Schema

channel
optional

Channel

string

defaultLanguage
optional

Default language for Basesite

Language

defaultPreviewCatalogId
optional

Default preview catalog id

string

defaultPreviewCategoryCode
optional

Default preview category code

string

defaultPreviewProductCode
optional

Default preview product code

string

locale
optional

Locale data for Basesite

string

name
optional

Name of Basesite

string

stores
optional

List of Basestores

< BaseStore > array

theme
optional

Theme of Basesite

string

uid
optional

Unique identifier of Basesite

string

urlEncodingAttributes
optional

List of url encoding attributes

< string > array

urlPatterns
optional

List of url patterns

< string > array

4.6. BaseSiteList

Representation of a Base Site List

Name Description Schema

baseSites
optional

List of basesites

< BaseSite > array

4.7. BaseStore

Representation of a Base Store

Name Description Schema

createReturnProcessCode
optional

Create return process code

string

currencies
optional

List of currencies

< Currency > array

defaultCurrency
optional

Default currency

Currency

defaultDeliveryOrigin
optional

Point of service being default delivery origin

PointOfService

defaultLanguage
optional

Default language

Language

deliveryCountries
optional

List of delivery countries

< Country > array

deliveryModes
optional

List of delivery modes

DeliveryModeList

expressCheckoutEnabled
optional

Flag specifying whether the express checkout option is enabled

boolean

externalTaxEnabled
optional

Flag defining is external tax is enabled

boolean

languages
optional

List of languages

< Language > array

maxRadiusForPosSearch
optional

Maximum radius for searching point of service

number(double)

name
optional

Base store name

string

paymentProvider
optional

Payment provider

string

pointsOfService
optional

List of points of service

< PointOfService > array

submitOrderProcessCode
optional

Submit order process code

string

4.8. Breadcrumb

Representation of a Breadcrumb

Name Description Schema

facetCode
optional

Code of the facet

string

facetName
optional

Name of the facet

string

facetValueCode
optional

Value code of the facet

string

facetValueName
optional

Value name of the facet

string

removeQuery
optional

Remove query

SearchState

truncateQuery
optional

Truncate query

SearchState

4.9. CancellationRequestEntryInput

Representation of a cancellation request entry input for an order

Name Description Schema

orderEntryNumber
required

Order entry number of the cancelled product
Example : 1

integer(int32)

quantity
required

Quantity of the product which belongs to the order entry and is requested to be cancelled
Example : 5

integer(int64)

4.10. CancellationRequestEntryInputList

Representation of a cancellation request entry input list for an order

Name Description Schema

cancellationRequestEntryInputs
required

Cancellation request entry inputs which contain information about the order entries which are requested to be cancelled

< CancellationRequestEntryInput > array

4.11. CardType

Representation of a Card Type

Name Description Schema

code
optional

Card type code

string

name
optional

Card type name

string

4.12. CardTypeList

Representation of a Card Type List

Name Description Schema

cardTypes
optional

List of card types

< CardType > array

4.13. Cart

Representation of a Cart

Name Description Schema

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

code
optional

Code number of order

string

deliveryAddress
optional

Delivery address

Address

deliveryCost
optional

Delivery cost

Price

deliveryItemsQuantity
optional

Quantity of delivery items

integer(int64)

deliveryMode
optional

Delivery mode information

DeliveryMode

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

description
optional

Description of the cart

string

entries
optional

List of order entries

< OrderEntry > array

expirationTime
optional

Date of cart expiration time

string(date-time)

guid
optional

Guest user id identifier

string

name
optional

Name of the cart

string

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

Price

paymentInfo
optional

Payment information

PaymentDetails

pickupItemsQuantity
optional

Quantity of pickup items

integer(int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

potentialOrderPromotions
optional

List of potential order promotions for cart

< PromotionResult > array

potentialProductPromotions
optional

List of potential product promotions for cart

< PromotionResult > array

productDiscounts
optional

Product discounts

Price

saveTime
optional

Date of saving cart

string(date-time)

savedBy
optional

Information about person who saved cart

Principal

site
optional

Site

string

store
optional

Store

string

subTotal
optional

Subtotal price

Price

totalDiscounts
optional

Total discounts

Price

totalItems
optional

integer(int32)

totalPrice
optional

Total price value

Price

totalPriceWithTax
optional

Total price with tax

Price

totalTax
optional

Total tax price

Price

totalUnitCount
optional

Total unit count

integer(int32)

user
optional

User information

Principal

4.14. CartList

Representation of a Cart list

Name Description Schema

carts
optional

List of carts

< Cart > array

4.15. CartModification

Representation of a Cart modification

Name Description Schema

deliveryModeChanged
optional

Delivery mode changed

boolean

entry
optional

Order entry

OrderEntry

quantity
optional

Final quantity after cart modification

integer(int64)

quantityAdded
optional

Quantity added with cart modification

integer(int64)

statusCode
optional

Status code of cart modification

string

statusMessage
optional

Status message

string

4.16. CartModificationList

Representation of a Cart modification list

Name Description Schema

cartModifications
optional

List of cart modifications

< CartModification > array

4.17. Catalog

Representation of an Catalog

Name Description Schema

catalogVersions
optional

List of versions of catalog

< CatalogVersion > array

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

url
optional

Url address of abstract catalog item

string

4.18. CatalogList

Representation of a Catalog List

Name Description Schema

catalogs
optional

List of catalog items

< Catalog > array

4.19. CatalogVersion

Representation of a Catalog Version

Name Description Schema

categories
optional

List of category hierarchies

< CategoryHierarchy > array

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

url
optional

Url address of abstract catalog item

string

4.20. Category

Representation of a Category

Name Description Schema

code
optional

Code of the category

string

image
optional

Category image

Image

name
optional

Name of the category

string

url
optional

URL of the category

string

4.21. CategoryHierarchy

Representation of a Category Hierarchy

Name Description Schema

id
optional

Identifier of abstract catalog item

string

lastModified
optional

Date of last modification

string(date-time)

name
optional

Name of abstract catalog item

string

subcategories
optional

List of subcategory hierarchies

< CategoryHierarchy > array

url
optional

Url address of abstract catalog item

string

4.22. Classification

Representation of a Classification

Name Description Schema

code
optional

Code of the classification

string

features
optional

List of features for given classification

< Feature > array

name
optional

Name of the classification

string

4.23. ConfigurationInfo

Representation of a Configuration Info

Name Description Schema

configurationLabel
optional

Label of configuration info

string

configurationValue
optional

Value of configuration info

string

configuratorType
optional

Type of configuration info

string

status
optional

Status of configuration info

string

4.24. Consent

Representation of a Consent

Name Description Schema

code
optional

Code of consent

string

consentGivenDate
optional

Date of consenting

string(date-time)

consentWithdrawnDate
optional

Consent withdrawn date

string(date-time)

4.25. ConsentTemplate

Representation of a Consent Template

Name Description Schema

currentConsent
optional

Current consent

Consent

description
optional

Consent template description

string

id
optional

Consent template identifier

string

name
optional

Consent template name

string

version
optional

Consent template version

integer(int32)

4.26. ConsentTemplateList

Representation of a Consent Template List

Name Description Schema

consentTemplates
optional

List of consent templates

< ConsentTemplate > array

4.27. Consignment

Representation of a Consignment

Name Description Schema

code
optional

Consignment code

string

deliveryMode
optional

DeliveryMode

deliveryPointOfService
optional

Delivery point of service

PointOfService

entries
optional

List of consignment entries

< ConsignmentEntry > array

orderCode
optional

string

packagingInfo
optional

PackagingInfo

shippingAddress
optional

Shipping address

Address

shippingDate
optional

string(date-time)

status
optional

Consignment status

string

statusDate
optional

Consignment status date

string(date-time)

statusDisplay
optional

Consignment status display

string

trackingID
optional

Consignment tracking identifier

string

warehouseCode
optional

string

4.28. ConsignmentEntry

Representation of a Consignment Entry

Name Description Schema

orderEntry
optional

Order entry of Consignment entry

OrderEntry

quantity
optional

Quantity value of Consignment entry

integer(int64)

quantityDeclined
optional

integer(int64)

quantityPending
optional

integer(int64)

quantityShipped
optional

integer(int64)

shippedQuantity
optional

Shipped quantity

integer(int64)

4.29. Country

Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format

Name Description Schema

isocode
optional

Country code in iso format

string

name
optional

Name of the country

string

4.30. CountryList

List of countries

Name Description Schema

countries
optional

This is the list of Country fields that should be returned in the response body

< Country > array

4.31. Currency

Representation of a Currency

Name Description Schema

active
optional

Boolean flag whether currency is active

boolean

isocode
optional

Code of the currency in iso format

string

name
optional

Name of the currency

string

symbol
optional

Symbol of the currency

string

4.32. CurrencyList

Representation of a Currency List

Name Description Schema

currencies
optional

List of currencies

< Currency > array

4.33. DeliveryMode

Representation of a Delivery mode

Name Description Schema

code
optional

Code of the delivery mode

string

deliveryCost
optional

Cost of the delivery

Price

description
optional

Description of the delivery mode

string

name
optional

Name of the delivery mode

string

4.34. DeliveryModeList

Representation of a Delivery mode list

Name Description Schema

deliveryModes
optional

List of delivery modes

< DeliveryMode > array

4.35. DeliveryOrderEntryGroup

Representation of a Delivery Order Entry Group

Name Description Schema

deliveryAddress
optional

Delivery address for order entry group

Address

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer(int64)

totalPriceWithTax
optional

Total price with tax

Price

4.36. Facet

Representation of a Facet

Name Description Schema

category
optional

Flag stating if facet is category facet

boolean

multiSelect
optional

Flag stating if facet is multiSelect

boolean

name
optional

Name of the facet

string

priority
optional

Priority value of the facet

integer(int32)

topValues
optional

List of top facet values

< FacetValue > array

values
optional

List of all facet values

< FacetValue > array

visible
optional

Flag stating if facet is visible

boolean

4.37. FacetValue

Representation of a Facet Value

Name Description Schema

count
optional

Count of the facet value

integer(int64)

name
optional

Name of the facet value

string

query
optional

Query of the facet value

SearchState

selected
optional

Flag stating if facet value is selected

boolean

4.38. Feature

Representation of a Feature

Name Description Schema

code
optional

Code of the feature

string

comparable
optional

Flag defining it feature is comparable

boolean

description
optional

Description of the feature

string

featureUnit
optional

Feature unit

FeatureUnit

featureValues
optional

List of feature values

< FeatureValue > array

name
optional

Name of the feature

string

range
optional

Range number of the reature

boolean

type
optional

Type of the feature

string

4.39. FeatureUnit

Representation of a Feature Unit

Name Description Schema

name
optional

Name of the feature unit

string

symbol
optional

Symbol of the feature unit

string

unitType
optional

Type of the feature unit

string

4.40. FeatureValue

Representation of a Feature Value

Name Description Schema

value
optional

Value of the feature

string

4.41. FutureStock

Representation of a Future Stock

Name Description Schema

date
optional

Date of future stock

string(date-time)

formattedDate
optional

Date of future stock expressed in text value

string

stock
optional

Stock information of future stock

Stock

4.42. GeoPoint

Representation of a GeoPoint

Name Description Schema

latitude
optional

Geopoint latitude

number(double)

longitude
optional

Geopoint longitude

number(double)

4.43. Image

Representation of an Image

Name Description Schema

altText
optional

Tooltip content which is visible while image mouse hovering

string

format
optional

Format of the image, can be zoom, product, thumbnail, store, cartIcon, etc.

string

galleryIndex
optional

Index of the image while displayed in gallery

integer(int32)

imageType
optional

Type of the image, can be PRIMARY or GALLERY

enum (PRIMARY, GALLERY)

url
optional

URL address of the image

string

4.44. Language

Representation of a Language

Name Description Schema

active
optional

true/false indicator when the language is active

boolean

isocode
optional

iso code of the language

string

name
optional

name of the language

string

nativeName
optional

name the language in native form

string

4.45. LanguageList

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

Name Description Schema

languages
optional

This is the list of Language fields that should be returned in the response body

< Language > array

4.46. MemberList

Representation of a Member List

Name Description Schema

members
optional

List of member

< Principal > array

4.47. OpeningSchedule

Representation of an Opening schedule

Name Description Schema

code
optional

Code of the opening schedule

string

name
optional

Name of the opening schedule

string

specialDayOpeningList
optional

List of special opening days

< SpecialOpeningDay > array

weekDayOpeningList
optional

List of weekday opening days

< WeekdayOpeningDay > array

4.48. Order

Representation of an Order

Name Description Schema

appliedOrderPromotions
optional

List of applied order promotions

< PromotionResult > array

appliedProductPromotions
optional

List of applied product promotions

< PromotionResult > array

appliedVouchers
optional

List of applied vouchers

< Voucher > array

calculated
optional

Flag showing if order is calculated

boolean

cancellable
optional

Boolean flag showing if order is cancellable
Example : true

boolean

code
optional

Code number of order

string

consignments
optional

List of consignment

< Consignment > array

created
optional

Date of order creation

string(date-time)

deliveryAddress
optional

Delivery address

Address

deliveryCost
optional

Delivery cost

Price

deliveryItemsQuantity
optional

Quantity of delivery items

integer(int64)

deliveryMode
optional

Delivery mode information

DeliveryMode

deliveryOrderGroups
optional

List of delivery order entries group

< DeliveryOrderEntryGroup > array

deliveryStatus
optional

Order delivery status

string

deliveryStatusDisplay
optional

Order delivery status display

string

entries
optional

List of order entries

< OrderEntry > array

guestCustomer
optional

Flag showing if customer is Guest customer

boolean

guid
optional

Guest user id identifier

string

net
optional

Flag stating iv value is net-value

boolean

orderDiscounts
optional

Order discounts

Price

paymentAddress
optional

Address

paymentInfo
optional

Payment information

PaymentDetails

pickupItemsQuantity
optional

Quantity of pickup items

integer(int64)

pickupOrderGroups
optional

List of pickup order entry group

< PickupOrderEntryGroup > array

productDiscounts
optional

Product discounts

Price

returnable
optional

Boolean flag showing if order is returnable
Example : true

boolean

site
optional

Site

string

status
optional

Status of order

string

statusDisplay
optional

Status display

string

store
optional

Store

string

subTotal
optional

Subtotal price

Price

totalDiscounts
optional

Total discounts

Price

totalItems
optional

integer(int32)

totalPrice
optional

Total price value

Price

totalPriceWithTax
optional

Total price with tax

Price

totalTax
optional

Total tax price

Price

unconsignedEntries
optional

List of unconsigned order entries

< OrderEntry > array

user
optional

User information

Principal

4.49. OrderEntry

Representation of an Order entry

Name Description Schema

basePrice
optional

Base price of order entry item

Price

cancellableQuantity
optional

Quantity number of cancellable items in order entry
Example : 5

integer(int64)

cancelledItemsPrice
optional

Total price of cancelled items which belong to the order entry item

Price

configurationInfos
optional

Configuration info of order entry

< ConfigurationInfo > array

deliveryMode
optional

Delivery mode

DeliveryMode

deliveryPointOfService
optional

Point of service associated with order entry

PointOfService

entryNumber
optional

Entry number of the order entry

integer(int32)

product
optional

Product details of order entry

Product

quantity
optional

Quantity number of items in order entry

integer(int64)

quantityAllocated
optional

integer(int64)

quantityCancelled
optional

integer(int64)

quantityPending
optional

integer(int64)

quantityReturned
optional

integer(int64)

quantityShipped
optional

integer(int64)

quantityUnallocated
optional

integer(int64)

returnableQuantity
optional

Quantity number of returnable items in order entry
Example : 5

integer(int64)

returnedItemsPrice
optional

Total price of returned items which belong to the order entry item

Price

statusSummaryList
optional

List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty

< StatusSummary > array

totalPrice
optional

Total price of order entry item

Price

updateable
optional

Flag defining if order entry item is updateable

boolean

url
optional

string

4.50. OrderEntryList

Representation of an Order entry list consumed

Name Description Schema

orderEntries
optional

List of order entries

< OrderEntry > array

4.51. OrderHistory

Representation of an Order History

Name Description Schema

code
optional

Code of Order History

string

guid
optional

Guest user identifier

string

placed
optional

Date of placing order

string(date-time)

status
optional

Status of Order History

string

statusDisplay
optional

Status display

string

total
optional

Total price

Price

4.52. OrderHistoryList

Representation of an Order History List

Name Description Schema

orders
optional

List of order history items

< OrderHistory > array

pagination
optional

Pagination items

deprecatedPagination

sorts
optional

List of sorts

< Sort > array

4.53. OrderStatusUpdateElement

Representation of an Order Status Update Element

Name Description Schema

baseSiteId
optional

BaseSite identifier

string

code
optional

Code of update element of order status

string

status
optional

Status of update element

string

4.54. OrderStatusUpdateElementList

Representation of an Order Status Update Element List

Name Description Schema

orderStatusUpdateElements
optional

List of order status update elements

< OrderStatusUpdateElement > array

4.55. PackagingInfo

Name Schema

dimensionUnit
optional

string

grossWeight
optional

string

height
optional

string

insuredValue
optional

string

length
optional

string

weightUnit
optional

string

width
optional

string

4.56. PaymentDetails

Representation of a Payment Details

Name Description Schema

accountHolderName
optional

Name of account holder

string

billingAddress
optional

Address details to be considered as billing address

Address

cardNumber
optional

Payment card number

string

cardType
optional

Type of payment card

CardType

defaultPayment
optional

Flag to mark if payment the default one

boolean

expiryMonth
optional

Month of expiration of payment

string

expiryYear
optional

Year of expiration of payment

string

id
optional

Unique identifier of payment detail

string

issueNumber
optional

Issue number

string

saved
optional

Flag to mark if payment is saved one

boolean

startMonth
optional

Start month from which payment is valid

string

startYear
optional

Start year from which payment is valid

string

subscriptionId
optional

Identifier of subscription

string

4.57. PaymentDetailsList

Representation of a Payment details list

Name Description Schema

payments
optional

List of payment details

< PaymentDetails > array

4.58. PaymentMode

Representation of a Payment Mode

Name Description Schema

code
optional

Payment mode code

string

description
optional

Payment mode description

string

name
optional

Payment mode name

string

4.59. PaymentModeList

Representation of a Payment Mode List

Name Description Schema

paymentModes
optional

List of payment modes

< PaymentMode > array

4.60. PaymentRequest

Name Schema

mappingLabels
optional

< string, string > map

parameters
optional

< string, string > map

postUrl
optional

string

4.61. PickupOrderEntryGroup

Representation of a Pickup Order Entry Group

Name Description Schema

deliveryPointOfService
optional

Delivery point of service

PointOfService

distance
optional

Distance calculated to pickup place

number(double)

entries
optional

List of order entries

< OrderEntry > array

quantity
optional

Quantity of order entries in a group

integer(int64)

totalPriceWithTax
optional

Total price with tax

Price

4.62. PointOfService

Representation of a Point of service

Name Description Schema

address
optional

Address information of point of service

Address

description
optional

Description of the point of service

string

displayName
optional

Display name of the point of service

string

distanceKm
optional

Distance to the point of service as number value

number(double)

features
optional

List of features for a given point of service

< string, string > map

formattedDistance
optional

Distance to the point of service as text value

string

geoPoint
optional

Geopoint localization info about point of service

GeoPoint

mapIcon
optional

Image associated with the point of service

Image

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

OpeningSchedule

storeContent
optional

Store content of given point of service

string

storeImages
optional

Collection of images associated with a point of service

< Image > array

url
optional

Url address of the point of service

string

warehouseCodes
optional

< string > array

4.63. PointOfServiceList

Representation of a Point of Service List

Name Description Schema

pointOfServices
optional

List of points of service

< PointOfService > array

4.64. PointOfServiceStock

Representation of a Point Of Service Stock

Name Description Schema

address
optional

Address information of point of service

Address

description
optional

Description of the point of service

string

displayName
optional

Display name of the point of service

string

distanceKm
optional

Distance to the point of service as number value

number(double)

features
optional

List of features for a given point of service

< string, string > map

formattedDistance
optional

Distance to the point of service as text value

string

geoPoint
optional

Geopoint localization info about point of service

GeoPoint

mapIcon
optional

Image associated with the point of service

Image

name
optional

Name of the point of service

string

openingHours
optional

Opening hours of point of service

OpeningSchedule

stockInfo
optional

Stock information about point of service

Stock

storeContent
optional

Store content of given point of service

string

storeImages
optional

Collection of images associated with a point of service

< Image > array

url
optional

Url address of the point of service

string

warehouseCodes
optional

< string > array

4.65. Price

Representation of a Price

Name Description Schema

currencyIso
optional

Currency iso format

string

formattedValue
optional

Value of price formatted

string

maxQuantity
optional

Maximum quantity of the price value

integer(int64)

minQuantity
optional

Minimum quantity of the price value

integer(int64)

priceType
optional

Type of the price

enum (BUY, FROM)

value
optional

Value of price in BigDecimal format

number

4.66. PriceRange

Representation of a Price Range

Name Description Schema

maxPrice
optional

Maximum value of the Price Range

Price

minPrice
optional

Minium value of the Price Range

Price

4.67. Principal

Representation of a Principal webservice DTO used for defining User data types

Name Description Schema

name
optional

Name of the user

string

uid
optional

Unique user identifier

string

4.68. Product

Representation of a Product

Name Description Schema

availableForPickup
optional

Flag defining if product is available for pickup

boolean

averageRating
optional

Rating number of average value

number(double)

baseOptions
optional

List of base options related to the product

< BaseOption > array

baseProduct
optional

Information about base product

string

categories
optional

List of categories product belongs to

< Category > array

classifications
optional

List of classifications related to the product

< Classification > array

code
optional

Code of the product

string

configurable
optional

Flag stating if product is configurable

boolean

configuratorType
optional

Configurator type related to the product

string

description
optional

Description of the product

string

futureStocks
optional

List of future stocks

< FutureStock > array

images
optional

List of images linked to product

< Image > array

manufacturer
optional

Data of product manufacturer

string

multidimensional
optional

Flag stating if product is multidimentional

boolean

name
optional

Name of the product

string

numberOfReviews
optional

Number of reviews associated with the product

integer(int32)

potentialPromotions
optional

List of potential promotions related to the product

< Promotion > array

price
optional

Price of the product

Price

priceRange
optional

Price range assigned to the product

PriceRange

productReferences
optional

List of product references

< ProductReference > array

purchasable
optional

Flag defining if product is purchasable

boolean

reviews
optional

List of reviews associated with the product

< Review > array

stock
optional

Stock value of the product

Stock

summary
optional

Product summary

string

tags
optional

Tags associated with the product

< string > array

url
optional

Url address of the product

string

variantMatrix
optional

List of variant matrixes associated with the product

< VariantMatrixElement > array

variantOptions
optional

List of variant options related to the product

< VariantOption > array

variantType
optional

Variant type of the product

string

volumePrices
optional

List of volume prices

< Price > array

volumePricesFlag
optional

Flag stating if volume price should be displayed

boolean

4.69. ProductExpressUpdateElement

Representation of a Product Express Update Element

Name Description Schema

catalogId
optional

Catalog identifier

string

catalogVersion
optional

Catalog version

string

code
optional

Code of product express update element

string

4.70. ProductExpressUpdateElementList

Representation of a Product Express Update Element List

Name Description Schema

productExpressUpdateElements
optional

List of product express update element

< ProductExpressUpdateElement > array

4.71. ProductList

Representation of a Product List

Name Description Schema

catalog
optional

Catalog of product list

string

currentPage
optional

Number of current page

integer(int32)

products
optional

List of products

< Product > array

totalPageCount
optional

Total page count

integer(int32)

totalProductCount
optional

Total product count

integer(int32)

version
optional

Version of product list

string

4.72. ProductReference

Representation of a Product Reference

Name Description Schema

description
optional

Reference description

string

preselected
optional

Flag stating if product reference is preselected

boolean

quantity
optional

Reference quantity

integer(int32)

referenceType
optional

Reference type

string

target
optional

Target product

Product

4.73. ProductReferenceList

Representation of a Product Reference List

Name Description Schema

references
optional

List of product references

< ProductReference > array

4.74. ProductSearchPage

Representation of a Product Search Page

Name Description Schema

breadcrumbs
optional

List of breadcrumbs info

< Breadcrumb > array

categoryCode
optional

Code of category

string

currentQuery
optional

Current query

SearchState

facets
optional

List of facets

< Facet > array

freeTextSearch
optional

Free text search

string

keywordRedirectUrl
optional

Redirect url address keyword

string

pagination
optional

Pagination number

deprecatedPagination

products
optional

List of products

< Product > array

sorts
optional

List of sorts

< Sort > array

spellingSuggestion
optional

Spelling suggestion

SpellingSuggestion

4.75. Promotion

Representation of a Promotion

Name Description Schema

code
optional

Code of the promotion

string

couldFireMessages
optional

Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description

< string > array

description
optional

Description of the promotion

string

enabled
optional

Boolean flag if promotion is enabled

boolean

endDate
optional

Last date of validity of the promotion

string(date-time)

firedMessages
optional

Message fired while the promotion is active. This is info how much you will get when applying the promotion

< string > array

priority
optional

Priority index as numeric value of the promotion. Higher number means higher priority

integer(int32)

productBanner
optional

Image banner of the promotion

Image

promotionGroup
optional

Group of the promotion

string

promotionType
optional

Type of the promotion

string

restrictions
optional

List of promotion restrictions

< PromotionRestriction > array

startDate
optional

The initial date of the promotion

string(date-time)

title
optional

Promotion title

string

4.76. PromotionList

Representation of a Promotion list

Name Description Schema

promotions
optional

List of promotions

< Promotion > array

4.77. PromotionOrderEntryConsumed

Representation of a Promotion order entry consumed

Name Description Schema

adjustedUnitPrice
optional

Adjusted unit price for promotion order entry

number(double)

code
optional

Order entry code

string

orderEntryNumber
optional

Order entry number

integer(int32)

quantity
optional

Quantity of promotion order entry

integer(int64)

4.78. PromotionRestriction

Representation of a Promotion Restriction

Name Description Schema

description
optional

Description of the promotion restriction

string

restrictionType
optional

Type of the promotion restriction

string

4.79. PromotionResult

Representation of a Promotion result

Name Description Schema

consumedEntries
optional

List of promotion order entries consumed

< PromotionOrderEntryConsumed > array

description
optional

Description of promotion result

string

promotion
optional

Promotion information for given promotion result

Promotion

4.80. PromotionResultList

Representation of a Promotion result list

Name Description Schema

promotions
optional

List of promotion results

< PromotionResult > array

4.81. Region

Response body fields which will be returned while fetching the list of country’s regions.

Name Description Schema

countryIso
optional

Country code in iso format

string

isocode
optional

Country and Region code in iso format

string

isocodeShort
optional

Region code in short iso form

string

name
optional

Name of the region

string

4.82. RegionList

List of Regions

Name Description Schema

regions
optional

This is the list of Region fields that should be returned in the response body

< Region > array

4.83. ResetPassword

Representation of a Reset Password

Name Description Schema

newPassword
required

new password string which is required to complete process of resetting password

string

token
required

token value which will be generated as unique string that will be sent with email to allow user for completing reset-password operation

string

4.84. ReturnRequest

Representation of a return request for an order

Name Description Schema

cancellable
optional

Boolean flag for whether the return request is cancellable
Example : true

boolean

code
optional

Return request code
Example : "00000001"

string

creationTime
optional

Date of the return request creation
Example : "2020-12-31T09:00:00+0000"

string(date-time)

deliveryCost
optional

Delivery cost

Price

order
optional

Order related to the return request

Order

refundDeliveryCost
optional

Boolean flag for whether there is a delivery cost for refund
Example : false

boolean

returnEntries
optional

Entries of the return request which contains information about the returned product

< ReturnRequestEntry > array

returnLabelDownloadUrl
optional

URL of the return label

string

rma
optional

Return merchandise authorization number
Example : "00000001"

string

status
optional

Status of return request

string

subTotal
optional

Subtotal price

Price

totalPrice
optional

Total price

Price

4.85. ReturnRequestEntry

Representation of a return request entry which contains information about the returned product

Name Description Schema

expectedQuantity
optional

Quantity which is expected to be returned for this return request entry
Example : 5

integer(int64)

orderEntry
optional

Order entry related to the return request entry

OrderEntry

refundAmount
optional

Refund amount of the entry

Price

4.86. ReturnRequestEntryInput

Representation of a return request entry input for an order

Name Description Schema

orderEntryNumber
required

Order entry number of the returned product
Example : 1

integer(int32)

quantity
required

Quantity of the product which belongs to the order entry and is requested to be returned
Example : 5

integer(int64)

4.87. ReturnRequestEntryInputList

Representation of a return request entry input list for an order

Name Description Schema

orderCode
required

Code of the order which return request is related to
Example : "00000001"

string

returnRequestEntryInputs
required

Return request entry inputs which contain information about the order entries which are requested to be returned

< ReturnRequestEntryInput > array

4.88. ReturnRequestList

Representation of an Order Return Request List

Name Description Schema

pagination
optional

Pagination items

deprecatedPagination

returnRequests
optional

List of order return requests

< ReturnRequest > array

sorts
optional

List of sorts

< Sort > array

4.89. ReturnRequestModification

Representation of modifications for a return request

Name Description Schema

status
optional

Status of the return request

enum (CANCELLING)

4.90. Review

Representation of a Review

Name Description Schema

alias
optional

Alias name for the review

string

comment
optional

Review comment

string

date
optional

Date of the review

string(date-time)

headline
optional

Review headline

string

id
optional

Identifier of review

string

principal
optional

Person related to the review

User

rating
optional

Review rating value

number(double)

4.91. ReviewList

Representation of a Review List

Name Description Schema

reviews
optional

List of reviews

< Review > array

4.92. SaveCartResult

Representation of a Save Cart Result

Name Description Schema

savedCartData
optional

Cart data information for saved cart

Cart

4.93. SearchQuery

Representation of a Search Query

Name Description Schema

value
optional

Value of search query

string

4.94. SearchState

Representation of a Search State

Name Description Schema

query
optional

Query of search state

SearchQuery

url
optional

Url address of search state

string

4.95. Sort

Representation a Sort option

Name Description Schema

code
optional

Code of Sort

string

name
optional

Name of Sort

string

selected
optional

Flag stating when Sort is selected

boolean

4.96. SpecialOpeningDay

Representation of a special opening day

Name Description Schema

closed
optional

Flag stating if special opening day is closed

boolean

closingTime
optional

Closing time of opening day

Time

comment
optional

Comment field

string

date
optional

Date of special opening day

string(date-time)

formattedDate
optional

Text representation of the date of special opening day

string

name
optional

Name of the special opening day event

string

openingTime
optional

Starting time of opening day

Time

4.97. SpellingSuggestion

Representation of a Spell Checker Suggestion

Name Description Schema

query
optional

Query for spelling suggestion

string

suggestion
optional

Spelling suggestion

string

4.98. StatusSummary

Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries

Name Description Schema

numberOfIssues
optional

Number of issues per status
Example : 3

integer(int32)

status
optional

Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS
Example : "ERROR"

string

4.99. Stock

Representation of a Stock

Name Description Schema

isValueRounded
optional

Indicate whether Stock level value is rounded

boolean

stockLevel
optional

Stock level expressed as number

integer(int64)

stockLevelStatus
optional

Status of stock level

string

4.100. StoreCount

Representation of a Store Count

Name Description Schema

count
optional

Count

integer(int32)

isoCode
optional

Iso code of store

string

name
optional

Name of store count

string

storeCountDataList
optional

List of store counts

< StoreCount > array

type
optional

Type of store count

string

4.101. StoreCountList

Representation of a Store Count List

Name Description Schema

countriesAndRegionsStoreCount
optional

List of store counts

< StoreCount > array

4.102. StoreFinderSearchPage

Representation of a Store finder search page

Name Description Schema

boundEastLongitude
optional

Bound east longitude

number(double)

boundNorthLatitude
optional

Bound north latitude

number(double)

boundSouthLatitude
optional

Bound south latitude

number(double)

boundWestLongitude
optional

Bound west longitude

number(double)

locationText
optional

Location text

string

pagination
optional

Pagination

deprecatedPagination

sorts
optional

List of sortings

< Sort > array

sourceLatitude
optional

Source latitude

number(double)

sourceLongitude
optional

Source longitude

number(double)

stores
optional

List of stores

< PointOfService > array

4.103. StoreFinderStockSearchPage

Representation of a Store Finder Stock Search Page

Name Description Schema

boundEastLongitude
optional

Bound to east longitude

number(double)

boundNorthLatitude
optional

Bound to north latitude

number(double)

boundSouthLatitude
optional

Bound to south latitude

number(double)

boundWestLongitude
optional

Bound to west longitude

number(double)

locationText
optional

Location text

string

pagination
optional

Pagination

deprecatedPagination

product
optional

Product

Product

sorts
optional

List of sorts

< Sort > array

sourceLatitude
optional

Source latitude

number(double)

sourceLongitude
optional

Source longitude

number(double)

stores
optional

List of stores

< PointOfServiceStock > array

4.104. Suggestion

Representation of a Suggestion

Name Description Schema

value
optional

Suggestion value

string

4.105. SuggestionList

Representation of a Suggestion List

Name Description Schema

suggestions
optional

List of suggestions

< Suggestion > array

4.106. Time

Representation of a Time

Name Description Schema

formattedHour
optional

Formatted hour

string

hour
optional

Hour part of the time data
Minimum value : -128
Maximum value : 127

integer(int32)

minute
optional

Minute part of the time data
Minimum value : -128
Maximum value : 127

integer(int32)

4.107. Title

Representation of a Title

Name Description Schema

code
optional

Title code

string

name
optional

Title name

string

4.108. TitleList

Representation of a Title List

Name Description Schema

titles
optional

List of titles

< Title > array

4.109. User

Representation of an User

Name Description Schema

currency
optional

User preferred currency

Currency

customerId
optional

Customer identifier

string

deactivationDate
optional

Deactivation date

string(date-time)

defaultAddress
optional

User address

Address

displayUid
optional

User identifier

string

firstName
optional

User first name

string

language
optional

User preferred language

Language

lastName
optional

User last name

string

name
optional

Name of the user

string

title
optional

User title

string

titleCode
optional

User title code

string

uid
optional

Unique user identifier

string

4.110. UserGroup

Representation of an User Group

Name Description Schema

members
optional

List of members

< Principal > array

membersCount
optional

Number of members

integer(int32)

name
optional

Name of the user

string

subGroups
optional

List of subgroups

< UserGroup > array

uid
optional

Unique user identifier

string

4.111. UserGroupList

Representation of an User Group List

Name Description Schema

currentPage
optional

Current page

integer(int32)

numberOfPages
optional

Number of pages

integer(int32)

pageSize
optional

Page size

integer(int32)

totalNumber
optional

Total number

integer(int32)

userGroups
optional

List of user groups

< UserGroup > array

4.112. UserSignUp

Representation of an UserSignUp. Consists of fields required to register new customer

Name Description Schema

firstName
required

first name of the user

string

lastName
required

last name of the user

string

password
required

user password

string

titleCode
optional

string

uid
required

user id, unique string required to create new user. It can be email

string

4.113. VariantCategory

Representation of a Variant Category

Name Description Schema

hasImage
optional

Flag if varian category has image assigned

boolean

name
optional

Variant category name

string

priority
optional

Priority number of variant category

integer(int32)

4.114. VariantMatrixElement

Representation of a Variant Matrix Element

Name Description Schema

elements
optional

List of elements with the type of variant matrix element

< VariantMatrixElement > array

isLeaf
optional

boolean

parentVariantCategory
optional

Parent variant category for variant matrix element

VariantCategory

variantOption
optional

Variant option for variant matrix element

VariantOption

variantValueCategory
optional

Variant value category for variant matrix element

VariantValueCategory

4.115. VariantOption

Representation of a Variant Option

Name Description Schema

code
optional

Code of the variant option

string

priceData
optional

Price data information of the variant option

Price

stock
optional

Stock value of the variant option

Stock

url
optional

Url address of the variant option

string

variantOptionQualifiers
optional

List of variant option qualifiers

< VariantOptionQualifier > array

4.116. VariantOptionQualifier

Representation of a Variant Option Qualifier

Name Description Schema

image
optional

Image associated with variant option qualifier

Image

name
optional

Name of variant option qualifier

string

qualifier
optional

Qualifier

string

value
optional

Value of variant option qualifier

string

4.117. VariantValueCategory

Representation of a Variant Value Category

Name Description Schema

name
optional

Name of the variant value category

string

sequence
optional

Sequence number of variant value category

integer(int32)

superCategories
optional

Parent category of variant value category

< VariantCategory > array

4.118. Voucher

Representation of a Voucher

Name Description Schema

appliedValue
optional

Applied value when using this voucher

Price

code
optional

The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123

string

currency
optional

Currency of the voucher

Currency

description
optional

Description of the voucher

string

freeShipping
optional

Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false.

boolean

name
optional

Name of the voucher

string

value
optional

Value of the voucher. Example of such value is: 15.0d

number(double)

valueFormatted
optional

Formatted value of the voucher

string

valueString
optional

The value of the voucher to display. Example: 15.0%

string

voucherCode
optional

Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL

string

4.119. VoucherList

Representation of a Voucher List

Name Description Schema

vouchers
optional

List of vouchers

< Voucher > array

4.120. WeekdayOpeningDay

Representation of a Weekday Opening Day

Name Description Schema

closed
optional

Flag stating if weekday opening day is closed

boolean

closingTime
optional

Closing time of opening day

Time

openingTime
optional

Starting time of opening day

Time

weekDay
optional

Text representation of week day opening day

string

4.121. deprecatedPagination

Representation of a search results pagination

Name Description Schema

currentPage
optional

The current page number. The first page is number zero (0), the second page is number one (1), and so on

integer(int32)

pageSize
optional

The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results

integer(int32)

sort
optional

The selected sort code

string

totalPages
optional

The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults.

integer(int32)

totalResults
optional

The total number of matched results across all pages

integer(int64)

4.122. error

Error message

Name Description Schema

errorCode
optional

Error code

string

exceptionMessage
optional

string

language
optional

Example : "English"

string

message
optional

Descriptive, human readable error message.

string

position
optional

Example : 1

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.123. errorList

List of errors

Name Schema

errors
optional

< error > array