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

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 : hostname
BasePath : /occ/v2

1.4. Tags

  • Address : Address Controller

  • Base Sites : Base Sites Controller

  • Base Stores : Base Stores Controller

  • Cart Addresses : Cart Addresses Controller

  • Cart Delivery Modes : Cart Delivery Modes Controller

  • Cart Entries : Cart Entries Controller

  • Cart Entry Groups : Cart Entry Groups Controller

  • Cart Payments : Cart Payments Controller

  • Cart Promotions : Cart Promotions 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 Info : Payment Info 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. Paths

2.1. Get all base sites.

GET /basesites

2.1.1. Description

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

2.1.2. 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"

2.1.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.4. Tags

  • Base Sites

2.1.5. Security

Type Name

oauth2

oauth2

2.2. Get a base store.

GET /{baseSiteId}/basestores/{baseStoreUid}

2.2.1. Description

Returns details of a specific base store based on its identifier. The response contains detailed base store information.

2.2.2. 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"

2.2.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.4. Tags

  • Base Stores

2.2.5. Security

Type Name

oauth2

oauth2

2.3. Get a list of supported payment card types.

GET /{baseSiteId}/cardtypes

2.3.1. Description

Lists supported payment card types.

2.3.2. 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"

2.3.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.4. Tags

  • Miscs

2.3.5. Security

Type Name

oauth2

oauth2

2.4. Get a list of catalogs

GET /{baseSiteId}/catalogs

2.4.1. Description

Returns all catalogs with versions defined for the base store.

2.4.2. 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"

2.4.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4.4. Tags

  • Catalogs

2.4.5. Security

Type Name

oauth2

oauth2

2.5. Get a catalog

GET /{baseSiteId}/catalogs/{catalogId}

2.5.1. Description

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

2.5.2. 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"

2.5.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.5.4. Tags

  • Catalogs

2.5.5. Security

Type Name

oauth2

oauth2

2.6. Get information about catalog version

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

2.6.1. Description

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

2.6.2. 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"

2.6.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.6.4. Tags

  • Catalogs

2.6.5. Security

Type Name

oauth2

oauth2

2.7. Get information about catagory in a catalog version

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

2.7.1. Description

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

2.7.2. 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"

2.7.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.7.4. Tags

  • Catalogs

2.7.5. Security

Type Name

oauth2

oauth2

2.8. Get a list of countries.

GET /{baseSiteId}/countries

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

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

2.8.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.8.4. Tags

  • Countries

2.8.5. Security

Type Name

oauth2

oauth2

2.9. Fetch the list of regions for the provided country.

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

2.9.1. Description

Lists all regions.

2.9.2. 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"

2.9.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.9.4. Tags

  • Countries

2.9.5. Security

Type Name

oauth2

oauth2

2.10. Get a list of available currencies.

GET /{baseSiteId}/currencies

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

2.10.2. 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"

2.10.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.10.4. Tags

  • Miscs

2.10.5. Security

Type Name

oauth2

oauth2

2.11. Creates a new customer group.

POST /{baseSiteId}/customergroups

2.11.1. 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”.

2.11.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Body

userGroup
required

User group object with id and name.

2.11.3. Responses

HTTP Code Description Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.11.4. Consumes

  • application/xml

  • application/json

2.11.5. Tags

  • Customer Groups

2.11.6. Security

Type Name

oauth2

oauth2

2.12. Get all subgroups of a customergroup.

GET /{baseSiteId}/customergroups

2.12.1. 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”.

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

2.12.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.12.4. Tags

  • Customer Groups

2.12.5. Security

Type Name

oauth2

oauth2

2.13. Get a specific customer group.

GET /{baseSiteId}/customergroups/{groupId}

2.13.1. 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”.

2.13.2. 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"

2.13.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.13.4. Tags

  • Customer Groups

2.13.5. Security

Type Name

oauth2

oauth2

2.14. Sets members for a user group.

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

2.14.1. 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”.

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

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

2.14.4. Consumes

  • application/xml

  • application/json

2.14.5. Tags

  • Customer Groups

2.14.6. Security

Type Name

oauth2

oauth2

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

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

2.15.1. 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”.

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

2.15.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.15.4. Consumes

  • application/xml

  • application/json

2.15.5. Tags

  • Customer Groups

2.15.6. Security

Type Name

oauth2

oauth2

2.16. Deletes a user from a customer group.

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

2.16.1. 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”.

2.16.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Path

userId
required

User identifier.

string

2.16.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.16.4. Tags

  • Customer Groups

2.16.5. Security

Type Name

oauth2

oauth2

2.17. Get a list of shipping countries.

GET /{baseSiteId}/deliverycountries
Caution

operation.deprecated

2.17.1. Description

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

2.17.2. 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"

2.17.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.17.4. Tags

  • Miscs

2.17.5. Security

Type Name

oauth2

oauth2

2.18. Get a list of product exports.

GET /{baseSiteId}/export/products

2.18.1. Description

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

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

2.18.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.18.4. Tags

  • Export

2.18.5. Security

Type Name

oauth2

oauth2

2.19. Get a list of orders with status updates.

GET /{baseSiteId}/feeds/orders/statusfeed

2.19.1. Description

Returns the orders that have changed status. Returns only the elements from the current baseSite that have been updated after the provided timestamp.

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

2.19.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.19.4. Tags

  • Feeds

2.19.5. Security

Type Name

oauth2

oauth2

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

POST /{baseSiteId}/forgottenpasswordtokens

2.20.1. Description

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

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

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

2.20.4. Consumes

  • application/json

2.20.5. Tags

  • Forgotten Passwords

2.20.6. Security

Type Name

oauth2

oauth2

2.21. Verify the decision of the Merchant

POST /{baseSiteId}/integration/merchant_callback

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

2.21.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

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

2.21.4. Consumes

  • application/json

2.21.5. Tags

  • Merchant Callback

2.21.6. Security

Type Name

oauth2

oauth2

2.22. Verify the decision of the Merchant for a cart

POST /{baseSiteId}/integration/users/{userId}/carts/{cartId}/payment/sop/response

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

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

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

2.22.4. Consumes

  • application/json

2.22.5. Tags

  • Merchant Callback

2.22.6. Security

Type Name

oauth2

oauth2

2.23. Get a list of available languages.

GET /{baseSiteId}/languages

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

2.23.2. 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"

2.23.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.23.4. Tags

  • Miscs

2.23.5. Security

Type Name

oauth2

oauth2

2.24. Get a order.

GET /{baseSiteId}/orders/{code}

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

2.24.2. 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"

2.24.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.24.4. Tags

  • Orders

2.24.5. Security

Type Name

oauth2

oauth2

2.25. Gets all available payment modes.

GET /{baseSiteId}/paymentmodes

2.25.1. Description

Gets all payment modes defined for the base store.

2.25.2. 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"

2.25.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.25.4. Tags

  • Payment Modes

2.25.5. Security

Type Name

oauth2

oauth2

2.26. Get products added to the express update feed.

GET /{baseSiteId}/products/expressupdate

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

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

2.26.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.26.4. Tags

  • Products

2.26.5. Security

Type Name

oauth2

oauth2

2.27. Get a list of products and additional data

GET /{baseSiteId}/products/search

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

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

2.27.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.27.4. Tags

  • Products

2.27.5. Security

Type Name

oauth2

oauth2

2.28. Get a header with total number of products.

HEAD /{baseSiteId}/products/search

2.28.1. Description

In the response header, the "x-total-count" indicates the total number of products satisfying a query.

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

2.28.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.28.4. Consumes

  • application/json

2.28.5. Tags

  • Products

2.28.6. Security

Type Name

oauth2

oauth2

2.29. Get a list of available suggestions

GET /{baseSiteId}/products/suggestions

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

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

2.29.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.29.4. Tags

  • Products

2.29.5. Security

Type Name

oauth2

oauth2

2.30. Get product details.

GET /{baseSiteId}/products/{productCode}

2.30.1. Description

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

2.30.2. 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"

2.30.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.30.4. Tags

  • Products

2.30.5. Security

Type Name

oauth2

oauth2

2.31. Get a product reference

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

2.31.1. Description

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

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

2.31.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.31.4. Tags

  • Products

2.31.5. Security

Type Name

oauth2

oauth2

2.32. Creates a new customer review as an anonymous user.

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

2.32.1. Description

Creates a new customer review as an anonymous user.

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

2.32.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.32.4. Consumes

  • application/xml

  • application/json

2.32.5. Tags

  • Products

2.32.6. Security

Type Name

oauth2

oauth2

2.33. Get reviews for a product

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

2.33.1. Description

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

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

2.33.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.33.4. Tags

  • Products

2.33.5. Security

Type Name

oauth2

oauth2

2.34. Get a product’s stock level.

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

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

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

2.34.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.34.4. Tags

  • Products

2.34.5. Security

Type Name

oauth2

oauth2

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

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

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

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

2.35.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.35.4. Consumes

  • application/json

2.35.5. Tags

  • Products

2.35.6. Security

Type Name

oauth2

oauth2

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

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

2.36.1. Description

Returns a product’s stock level for a particular store (in other words, for a particular point of sale).

2.36.2. 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"

2.36.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.36.4. Tags

  • Products

2.36.5. Security

Type Name

oauth2

oauth2

2.37. Get a list of promotions.

GET /{baseSiteId}/promotions

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

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

2.37.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.37.4. Tags

  • Promotions

2.37.5. Security

Type Name

oauth2

oauth2

2.38. Get a promotion based on code

GET /{baseSiteId}/promotions/{code}

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

2.38.2. 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"

2.38.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.38.4. Tags

  • Promotions

2.38.5. Security

Type Name

oauth2

oauth2

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

POST /{baseSiteId}/resetpassword

2.39.1. Description

Reset password after customer’s clicked forgotten password link.

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

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

2.39.4. Consumes

  • application/xml

  • application/json

2.39.5. Tags

  • Forgotten Passwords

2.39.6. Security

Type Name

oauth2

oauth2

2.40. Get a list of store locations

GET /{baseSiteId}/stores

2.40.1. Description

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

2.40.2. 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"

2.40.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.40.4. Tags

  • Stores

2.40.5. Security

Type Name

oauth2

oauth2

2.41. Get a header with the number of store locations.

HEAD /{baseSiteId}/stores

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

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

2.41.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.41.4. Consumes

  • application/json

2.41.5. Tags

  • Stores

2.41.6. Security

Type Name

oauth2

oauth2

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

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

2.42.1. Description

Lists all store locations that are in the specified country.

2.42.2. 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"

2.42.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.42.4. Tags

  • Stores

2.42.5. Security

Type Name

oauth2

oauth2

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

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

2.43.1. Description

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

2.43.2. 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"

2.43.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.43.4. Tags

  • Stores

2.43.5. Security

Type Name

oauth2

oauth2

2.44. Gets a store location count per country and regions

GET /{baseSiteId}/stores/storescounts

2.44.1. Description

Returns store counts in countries and regions

2.44.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

2.44.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.44.4. Tags

  • Stores

2.44.5. Security

Type Name

oauth2

oauth2

2.45. Get a store location

GET /{baseSiteId}/stores/{storeId}

2.45.1. Description

Returns store location based on its unique name.

2.45.2. 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"

2.45.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.45.4. Tags

  • Stores

2.45.5. Security

Type Name

oauth2

oauth2

2.46. Get a list of all localized titles.

GET /{baseSiteId}/titles

2.46.1. Description

Lists all localized titles.

2.46.2. 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"

2.46.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.46.4. Tags

  • Miscs

2.46.5. Security

Type Name

oauth2

oauth2

2.47. Registers a customer

POST /{baseSiteId}/users

2.47.1. Description

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

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

2.47.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.47.4. Consumes

  • application/xml

  • application/json

2.47.5. Tags

  • Users

2.47.6. Security

Type Name

oauth2

oauth2

2.48. Get customer profile

GET /{baseSiteId}/users/{userId}

2.48.1. Description

Returns customer profile.

2.48.2. 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"

2.48.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.48.4. Tags

  • Users

2.48.5. Security

Type Name

oauth2

oauth2

2.49. Updates customer profile

PUT /{baseSiteId}/users/{userId}

2.49.1. Description

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

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

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

2.49.4. Consumes

  • application/xml

  • application/json

2.49.5. Tags

  • Users

2.49.6. Security

Type Name

oauth2

oauth2

2.50. Delete customer profile.

DELETE /{baseSiteId}/users/{userId}

2.50.1. Description

Removes customer profile.

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

2.50.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.50.4. Tags

  • Users

2.50.5. Security

Type Name

oauth2

oauth2

2.51. Updates customer profile

PATCH /{baseSiteId}/users/{userId}

2.51.1. Description

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

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

2.51.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.51.4. Consumes

  • application/xml

  • application/json

2.51.5. Tags

  • Users

2.51.6. Security

Type Name

oauth2

oauth2

2.52. Creates a new address.

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

2.52.1. Description

Creates a new address.

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

2.52.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.52.4. Consumes

  • application/xml

  • application/json

2.52.5. Tags

  • Address

2.52.6. Security

Type Name

oauth2

oauth2

2.53. Get customer’s addresses

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

2.53.1. Description

Returns customer’s addresses.

2.53.2. 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"

2.53.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.53.4. Tags

  • Address

2.53.5. Security

Type Name

oauth2

oauth2

2.54. Verifies address.

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

2.54.1. Description

Verifies address.

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

2.54.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.54.4. Consumes

  • application/xml

  • application/json

2.54.5. Tags

  • Address

2.54.6. Security

Type Name

oauth2

oauth2

2.55. Get info about address

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

2.55.1. Description

Returns detailed information about address with a given id.

2.55.2. 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"

2.55.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.55.4. Tags

  • Address

2.55.5. Security

Type Name

oauth2

oauth2

2.56. Updates the address

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

2.56.1. Description

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

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

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

2.56.4. Consumes

  • application/xml

  • application/json

2.56.5. Tags

  • Address

2.56.6. Security

Type Name

oauth2

oauth2

2.57. Delete customer’s address.

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

2.57.1. Description

Removes customer’s address.

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

2.57.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.57.4. Tags

  • Address

2.57.5. Security

Type Name

oauth2

oauth2

2.58. Updates the address

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

2.58.1. Description

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

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

2.58.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.58.4. Consumes

  • application/xml

  • application/json

2.58.5. Tags

  • Address

2.58.6. Security

Type Name

oauth2

oauth2

2.59. Creates or restore a cart for a user.

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

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

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

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

2.59.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.59.4. Consumes

  • application/json

2.59.5. Tags

  • Carts

2.59.6. Security

Type Name

oauth2

oauth2

2.60. Get all customer carts.

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

2.60.1. Description

Lists all customer carts.

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

string

"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

2.60.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.60.4. Tags

  • Carts

2.60.5. Security

Type Name

oauth2

oauth2

2.61. Get a cart with a given identifier.

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

2.61.1. Description

Returns the cart with a given identifier.

2.61.2. 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"

2.61.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.61.4. Tags

  • Carts

2.61.5. Security

Type Name

oauth2

oauth2

2.62. Deletes a cart with a given cart id.

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

2.62.1. Description

Deletes a cart with a given cart id.

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

2.62.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.62.4. Tags

  • Carts

2.62.5. Security

Type Name

oauth2

oauth2

2.63. Creates a delivery address for the cart.

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

2.63.1. Description

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

2.63.2. 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"

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.

2.63.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.63.4. Consumes

  • application/xml

  • application/json

2.63.5. Tags

  • Cart Addresses

2.63.6. Security

Type Name

oauth2

oauth2

2.64. Sets a delivery address for the cart.

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

2.64.1. Description

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

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

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

2.64.4. Consumes

  • application/json

2.64.5. Tags

  • Cart Addresses

2.64.6. Security

Type Name

oauth2

oauth2

2.65. Deletes the delivery address from the cart.

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

2.65.1. Description

Deletes the delivery address from the cart.

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

2.65.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.65.4. Tags

  • Cart Addresses

2.65.5. Security

Type Name

oauth2

oauth2

2.66. Updates Chinese payment info for a cart.

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

2.66.1. Description

Updates Chinese payment info for a cart.

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

paymentModeCode
required

Payment mode code which is used to set payment provider in Chinese payment info.

string

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

2.66.4. Consumes

  • application/json

2.66.5. Tags

  • Payment Info

2.66.6. Security

Type Name

oauth2

oauth2

2.67. Explicitly clones a cart.

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

2.67.1. Description

Explicitly clones a cart.

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

2.67.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.67.4. Consumes

  • application/json

2.67.5. Tags

  • Save Cart

2.67.6. Security

Type Name

oauth2

oauth2

2.68. Handles the consolidating pickup locations.

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

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

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

2.68.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.68.4. Consumes

  • application/json

2.68.5. Tags

  • Extended Carts

2.68.6. Security

Type Name

oauth2

oauth2

2.69. Get consolidated pickup options.

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

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

2.69.2. 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"

2.69.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.69.4. Tags

  • Extended Carts

2.69.5. Security

Type Name

oauth2

oauth2

2.70. Creates an order which is specific for China.

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

2.70.1. Description

The check out process is different in China and it needs to create order first and not to trigger order process.

2.70.2. 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"

2.70.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.70.4. Consumes

  • application/json

2.70.5. Tags

  • Payment Info

2.70.6. Security

Type Name

oauth2

oauth2

2.71. Get the delivery mode selected for the cart.

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

2.71.1. Description

Returns the delivery mode selected for the cart.

2.71.2. 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"

2.71.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.71.4. Tags

  • Cart Delivery Modes

2.71.5. Security

Type Name

oauth2

oauth2

2.72. Sets the delivery mode for a cart.

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

2.72.1. Description

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

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

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

2.72.4. Consumes

  • application/json

2.72.5. Tags

  • Cart Delivery Modes

2.72.6. Security

Type Name

oauth2

oauth2

2.73. Deletes the delivery mode from the cart.

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

2.73.1. Description

Deletes the delivery mode from the cart.

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

2.73.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.73.4. Tags

  • Cart Delivery Modes

2.73.5. Security

Type Name

oauth2

oauth2

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

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

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

2.74.2. 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"

2.74.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.74.4. Tags

  • Cart Delivery Modes

2.74.5. Security

Type Name

oauth2

oauth2

2.75. Assigns an email to the cart.

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

2.75.1. Description

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

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

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

2.75.4. Consumes

  • application/json

2.75.5. Tags

  • Carts

2.75.6. Security

Type Name

oauth2

oauth2

2.76. Adds a product to the cart.

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

2.76.1. Description

Adds a product to the cart.

2.76.2. 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"

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.

2.76.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.76.4. Consumes

  • application/xml

  • application/json

2.76.5. Tags

  • Cart Entries

2.76.6. Security

Type Name

oauth2

oauth2

2.77. Get cart entries.

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

2.77.1. Description

Returns cart entries.

2.77.2. 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"

2.77.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.77.4. Tags

  • Cart Entries

2.77.5. Security

Type Name

oauth2

oauth2

2.78. Get the details of the cart entries.

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

2.78.1. Description

Returns the details of the cart entries.

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

string

"DEFAULT"

2.78.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.78.4. Tags

  • Cart Entries

2.78.5. Security

Type Name

oauth2

oauth2

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

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

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

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

string

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

2.79.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.79.4. Consumes

  • application/xml

  • application/json

2.79.5. Tags

  • Cart Entries

2.79.6. Security

Type Name

oauth2

oauth2

2.80. Deletes cart entry.

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

2.80.1. Description

Deletes cart entry.

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

2.80.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.80.4. Tags

  • Cart Entries

2.80.5. Security

Type Name

oauth2

oauth2

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

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

2.81.1. Description

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

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

string

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

2.81.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.81.4. Consumes

  • application/xml

  • application/json

2.81.5. Tags

  • Cart Entries

2.81.6. Security

Type Name

oauth2

oauth2

2.82. Add a product to a cart entry group.

POST /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}

2.82.1. Description

Adds a product to a cart entry group.

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

entryGroupNumber
required

Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.

integer (int32)

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

entry
required

Request body parameter that contains details such as the product code (product.code) and the quantity of product (quantity).

2.82.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.82.4. Consumes

  • application/json

2.82.5. Tags

  • Cart Entry Groups

2.82.6. Security

Type Name

oauth2

oauth2

2.83. Delete an entry group.

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

2.83.1. Description

Removes an entry group from an associated cart. The entry group is identified by an entryGroupNumber. The cart is identified by the cartId.

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

entryGroupNumber
required

Each entry group in a cart has a specific entry group number. Entry group numbers are integers starting at one. They are defined in ascending order.

integer (int32)

Path

userId
required

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

string

2.83.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.83.4. Tags

  • Cart Entry Groups

2.83.5. Security

Type Name

oauth2

oauth2

2.84. Flag a cart for deletion.

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

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

2.84.2. 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"

2.84.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.84.4. Consumes

  • application/json

2.84.5. Tags

  • Save Cart

2.84.6. Security

Type Name

oauth2

oauth2

2.85. Get information needed for create subscription

GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/request

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

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

2.85.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.85.4. Tags

  • Extended Carts

2.85.5. Security

Type Name

oauth2

oauth2

2.86. Handles response from payment provider and create payment details

POST /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response

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

2.86.2. 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"

2.86.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.86.4. Consumes

  • application/json

2.86.5. Tags

  • Extended Carts

2.86.6. Security

Type Name

oauth2

oauth2

2.87. Get information about create subscription request results

GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response

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

2.87.2. 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"

2.87.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.87.4. Tags

  • Extended Carts

2.87.5. Security

Type Name

oauth2

oauth2

2.88. Deletes payment provider response related to cart.

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

2.88.1. Description

Deletes the payment provider response related to the specified cart.

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

2.88.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.88.4. Tags

  • Extended Carts

2.88.5. Security

Type Name

oauth2

oauth2

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

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

2.89.1. Description

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

2.89.2. 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"

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.

2.89.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.89.4. Consumes

  • application/xml

  • application/json

2.89.5. Tags

  • Cart Payments

2.89.6. Security

Type Name

oauth2

oauth2

2.90. Sets credit card payment details for the cart.

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

2.90.1. Description

Sets credit card payment details for the cart.

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

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

2.90.4. Consumes

  • application/json

2.90.5. Tags

  • Cart Payments

2.90.6. Security

Type Name

oauth2

oauth2

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

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

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

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

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

2.91.4. Consumes

  • application/json

2.91.5. Tags

  • Cart Promotions

2.91.6. Security

Type Name

oauth2

oauth2

2.92. Get information about promotions applied on cart.

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

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

2.92.2. 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"

2.92.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.92.4. Tags

  • Cart Promotions

2.92.5. Security

Type Name

oauth2

oauth2

2.93. Get information about promotion applied on cart.

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

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

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

string

"DEFAULT"

2.93.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.93.4. Tags

  • Cart Promotions

2.93.5. Security

Type Name

oauth2

oauth2

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

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

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

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

2.94.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.94.4. Tags

  • Cart Promotions

2.94.5. Security

Type Name

oauth2

oauth2

2.95. Restore a saved cart.

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

2.95.1. Description

Restore a saved cart.

2.95.2. 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"

2.95.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.95.4. Consumes

  • application/json

2.95.5. Tags

  • Save Cart

2.95.6. Security

Type Name

oauth2

oauth2

2.96. Explicitly saves a cart.

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

2.96.1. Description

Explicitly saves a cart.

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

2.96.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.96.4. Consumes

  • application/json

2.96.5. Tags

  • Save Cart

2.96.6. Security

Type Name

oauth2

oauth2

2.97. Get a saved cart.

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

2.97.1. Description

Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.

2.97.2. 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"

2.97.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.97.4. Tags

  • Save Cart

2.97.5. Security

Type Name

oauth2

oauth2

2.98. Validates the cart

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

2.98.1. Description

Runs a cart validation and returns the result.

2.98.2. 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"

2.98.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.98.4. Consumes

  • application/json

2.98.5. Tags

  • Carts

2.98.6. Security

Type Name

oauth2

oauth2

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

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

2.99.1. Description

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

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

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

2.99.4. Consumes

  • application/json

2.99.5. Tags

  • Cart Promotions

2.99.6. Security

Type Name

oauth2

oauth2

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

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

2.100.1. Description

Returns a list of vouchers applied to the cart.

2.100.2. 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"

2.100.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.100.4. Tags

  • Cart Promotions

2.100.5. Security

Type Name

oauth2

oauth2

2.101. Deletes a voucher defined for the current cart.

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

2.101.1. Description

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

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

2.101.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.101.4. Tags

  • Cart Promotions

2.101.5. Security

Type Name

oauth2

oauth2

2.102. A user can give consent.

POST /{baseSiteId}/users/{userId}/consents

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

2.102.2. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.102.3. Consumes

  • application/json

2.102.4. Tags

  • Consents

2.102.5. Security

Type Name

oauth2

oauth2

2.103. Withdraw the user consent for a given consent code.

DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}

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

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

2.103.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.103.4. Tags

  • Consents

2.103.5. Security

Type Name

oauth2

oauth2

2.104. Fetch the list of consents

GET /{baseSiteId}/users/{userId}/consenttemplates

2.104.1. Description

If user has not given or withdrawn consent to any of the template, no given or withdraw date is returned.

2.104.2. 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"

2.104.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.104.4. Tags

  • Consents

2.104.5. Security

Type Name

oauth2

oauth2

2.105. Fetch the consent.

GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}

2.105.1. Description

If user has not given or withdrawn consent to the template, no given or withdraw date is returned.

2.105.2. 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"

2.105.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.105.4. Tags

  • Consents

2.105.5. Security

Type Name

oauth2

oauth2

2.106. Get all customer groups of a customer.

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

2.106.1. Description

Returns all customer groups of a customer.

2.106.2. 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"

2.106.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.106.4. Tags

  • Users

2.106.5. Security

Type Name

oauth2

oauth2

2.107. Changes customer’s login name.

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

2.107.1. Description

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

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

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

2.107.4. Consumes

  • application/json

2.107.5. Tags

  • Users

2.107.6. Security

Type Name

oauth2

oauth2

2.108. Notify about successful login.

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

2.108.1. Description

Publish notification event about successful login.

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

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

2.108.4. Consumes

  • application/json

2.108.5. Tags

  • Login Notification

2.108.6. Security

Type Name

oauth2

oauth2

2.109. Create an order return request.

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

2.109.1. Description

Creates an order return request.

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

2.109.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.109.4. Consumes

  • application/json

2.109.5. Produces

  • application/json

2.109.6. Tags

  • Return Requests

2.109.7. Security

Type Name

oauth2

oauth2

2.110. Gets the user’s return requests history

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

2.110.1. Description

Returns order return request data associated with a specified user for a specified base store.

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

2.110.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.110.4. Produces

  • application/json

2.110.5. Tags

  • Return Requests

2.110.6. Security

Type Name

oauth2

oauth2

2.111. Get the details of a return request.

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

2.111.1. Description

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

2.111.2. 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"

2.111.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.111.4. Produces

  • application/json

2.111.5. Tags

  • Return Requests

2.111.6. Security

Type Name

oauth2

oauth2

2.112. Updates the order return request.

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

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

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

2.112.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.112.4. Consumes

  • application/json

2.112.5. Produces

  • application/json

2.112.6. Tags

  • Return Requests

2.112.7. Security

Type Name

oauth2

oauth2

2.113. Place a order.

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

2.113.1. Description

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

2.113.2. 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"

2.113.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.113.4. Consumes

  • application/json

2.113.5. Tags

  • Orders

2.113.6. Security

Type Name

oauth2

oauth2

2.114. Get order history for user.

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

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

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

2.114.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.114.4. Tags

  • Orders

2.114.5. Security

Type Name

oauth2

oauth2

2.115. Get total number of orders.

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

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

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

2.115.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.115.4. Consumes

  • application/json

2.115.5. Tags

  • Orders

2.115.6. Security

Type Name

oauth2

oauth2

2.116. Get a order.

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

2.116.1. Description

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

2.116.2. 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"

2.116.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.116.4. Tags

  • Orders

2.116.5. Security

Type Name

oauth2

oauth2

2.117. Cancel an order.

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

2.117.1. Description

Cancels an order partially or completely

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

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

2.117.4. Consumes

  • application/json

2.117.5. Produces

  • application/json

2.117.6. Tags

  • Orders

2.117.7. Security

Type Name

oauth2

oauth2

2.118. Creates Chinese payment request data base on the Chinese payment info which is set in cart.

POST /{baseSiteId}/users/{userId}/orders/{orderCode}/payment/request

2.118.1. Description

Creates Chinese payment request data base on the Chinese payment info which is set in cart.

2.118.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

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

2.118.3. Responses

HTTP Code Description Schema

200

OK

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.118.4. Consumes

  • application/json

2.118.5. Tags

  • Payment Info

2.118.6. Security

Type Name

oauth2

oauth2

2.119. Changes customer’s password

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

2.119.1. Description

Changes customer’s password.

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

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

2.119.4. Consumes

  • application/json

2.119.5. Tags

  • Users

2.119.6. Security

Type Name

oauth2

oauth2

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

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

2.120.1. Description

Return customer’s credit card payment details list.

2.120.2. 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"

2.120.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.120.4. Tags

  • Payment Details

2.120.5. Security

Type Name

oauth2

oauth2

2.121. Get customer’s credit card payment details.

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

2.121.1. Description

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

2.121.2. 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"

2.121.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.121.4. Tags

  • Payment Details

2.121.5. Security

Type Name

oauth2

oauth2

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

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

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

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

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

2.122.4. Consumes

  • application/xml

  • application/json

2.122.5. Tags

  • Payment Details

2.122.6. Security

Type Name

oauth2

oauth2

2.123. Deletes customer’s credit card payment details.

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

2.123.1. Description

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

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

2.123.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.123.4. Tags

  • Payment Details

2.123.5. Security

Type Name

oauth2

oauth2

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

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

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

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

2.124.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.124.4. Consumes

  • application/xml

  • application/json

2.124.5. Tags

  • Payment Details

2.124.6. Security

Type Name

oauth2

oauth2

2.125. Get a voucher based on code.

GET /{baseSiteId}/vouchers/{code}

2.125.1. Description

Returns details of a single voucher that is specified by its voucher identification code.

2.125.2. 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"

2.125.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.125.4. Tags

  • Vouchers

2.125.5. Security

Type Name

oauth2

oauth2

3. Definitions

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

city
optional

city

cityDistrict
optional

city district

companyName
optional

Company Name

string

country
optional

Country where address is located

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

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

3.2. AddressList

Representation of an Address list

Name Description Schema

addresses
optional

List of addresses

< Address > array

3.3. AddressValidation

Representation of an Address Validation

Name Description Schema

decision
optional

Decision

string

errors
optional

List of errors

suggestedAddresses
optional

List of suggested addresses

< Address > array

3.4. BaseOption

Representation of a Base Ooption

Name Description Schema

options
optional

List of all variant options

< VariantOption > array

selected
optional

Variant option selected

variantType
optional

Variant type of base option

string

3.5. BaseSite

Representation of a Base Site

Name Description Schema

channel
optional

Channel

string

defaultLanguage
optional

Default language for Basesite

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

3.6. BaseSiteList

Representation of a Base Site List

Name Description Schema

baseSites
optional

List of basesites

< BaseSite > array

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

defaultDeliveryOrigin
optional

Point of service being default delivery origin

defaultLanguage
optional

Default language

deliveryCountries
optional

List of delivery countries

< Country > array

deliveryModes
optional

List of delivery modes

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

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

truncateQuery
optional

Truncate query

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

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

3.11. CardType

Representation of a Card Type

Name Description Schema

code
optional

Card type code

string

name
optional

Card type name

string

3.12. CardTypeList

Representation of a Card Type List

Name Description Schema

cardTypes
optional

List of card types

< CardType > array

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

chinesePaymentInfo
optional

Chinese payment info

code
optional

Code number of order

string

deliveryAddress
optional

Delivery address

deliveryCost
optional

Delivery cost

deliveryItemsQuantity
optional

Quantity of delivery items

integer (int64)

deliveryMode
optional

Delivery mode information

deliveryOrderGroups
optional

List of delivery order entries group

deliveryTimeSlot
optional

description
optional

Description of the cart

string

entries
optional

List of order entries

< OrderEntry > array

entryGroups
optional

List of entry groups

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

paymentInfo
optional

Payment information

paymentStatus
optional

Payment status
Example : "PAID"

string

pickupItemsQuantity
optional

Quantity of pickup items

integer (int64)

pickupOrderGroups
optional

List of pickup order entry group

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

saveTime
optional

Date of saving cart

string (date-time)

savedBy
optional

Information about person who saved cart

site
optional

Site

string

store
optional

Store

string

subTotal
optional

Subtotal price

taxInvoice
optional

totalDiscounts
optional

Total discounts

totalItems
optional

integer (int32)

totalPrice
optional

Total price value

totalPriceWithTax
optional

Total price with tax

totalTax
optional

Total tax price

totalUnitCount
optional

Total unit count

integer (int32)

user
optional

User information

3.14. CartList

Representation of a Cart list

Name Description Schema

carts
optional

List of carts

< Cart > array

3.15. CartModification

Representation of a Cart modification

Name Description Schema

deliveryModeChanged
optional

Delivery mode changed

boolean

entry
optional

Order entry

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

3.16. CartModificationList

Representation of a Cart modification list

Name Description Schema

cartModifications
optional

List of cart modifications

< CartModification > array

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

3.18. CatalogList

Representation of a Catalog List

Name Description Schema

catalogs
optional

List of catalog items

< Catalog > array

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

3.20. Category

Representation of a Category

Name Description Schema