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 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 |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
baseStoreUid |
Base store name |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
catalogId |
Catalog identifier |
string |
|
Path |
catalogVersionId |
Catalog version identifier |
string |
|
Path |
categoryId |
Category identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
type |
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 |
Base site identifier |
string |
|
Path |
countyIsoCode |
An ISO code for a country |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
Body |
userGroup |
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 |
Base site identifier |
string |
|
Query |
currentPage |
Current page number (starts with 0). |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Number of customer group returned in one page. |
integer (int32) |
|
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 |
Base site identifier |
string |
|
Path |
groupId |
Group identifier. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
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 |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Body |
members |
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 |
Base site identifier |
string |
Path |
groupId |
Group identifier. |
string |
Path |
userId |
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
catalog |
The catalog to retrieve products from. The catalog must be provided along with the version. |
string |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
Query |
timestamp |
When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
|
Query |
version |
The catalog version. The catalog version must be provided along with the catalog. |
string |
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
timestamp |
Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000). |
string |
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 |
Base site identifier |
string |
Query |
userId |
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 |
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 |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
code |
Order GUID (Globally Unique Identifier) or order CODE |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
catalog |
Only products from this catalog are returned. Format: catalogId:catalogVersion |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
timestamp |
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 |
Base site identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
|
Query |
searchQueryContext |
The context to be used in the search query. |
string |
|
Query |
sort |
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 |
Base site identifier |
string |
Query |
query |
Serialized query, free text search, facets. The format of a serialized query: freeTextSearch:sort:facetKey1:facetValue1:facetKey2:facetValue2 |
string |
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
max |
Specifies the limit of results. |
integer (int32) |
|
Query |
term |
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Maximum size of returned results. |
integer (int32) |
|
Query |
referenceType |
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
review |
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
maxCount |
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
latitude |
Latitude location parameter. |
number (double) |
|
Query |
location |
Free-text location |
string |
|
Query |
longitude |
Longitude location parameter. |
number (double) |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
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 |
Base site identifier |
string |
Path |
productCode |
Product identifier |
string |
Query |
latitude |
Latitude location parameter. |
number (double) |
Query |
location |
Free-text location |
string |
Query |
longitude |
Longitude location parameter. |
number (double) |
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 |
Base site identifier |
string |
|
Path |
productCode |
Product identifier |
string |
|
Path |
storeName |
Store identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
promotionGroup |
Only promotions from this group are returned |
string |
|
Query |
type |
Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul> |
enum (all, product, order) |
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 |
Base site identifier |
string |
|
Path |
code |
Promotion identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
Body |
resetPassword |
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 |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number (double) |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number (double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number (double) |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number (double) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
|
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 |
Base site identifier |
string |
|
Query |
accuracy |
Accuracy in meters. |
number (double) |
|
Query |
latitude |
Coordinate that specifies the north-south position of a point on the Earth’s surface. |
number (double) |
|
Query |
longitude |
Coordinate that specifies the east-west position of a point on the Earth’s surface. |
number (double) |
|
Query |
query |
Location in natural language i.e. city or country. |
string |
|
Query |
radius |
Radius in meters. Max value: 40075000.0 (Earth’s perimeter). |
number (double) |
|
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 |
Base site identifier |
string |
|
Path |
countryIso |
Country ISO code |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
countryIso |
Country ISO code |
string |
|
Path |
regionIso |
Region ISO code |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
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 |
Base site identifier |
string |
|
Path |
storeId |
Store identifier (currently store name) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
user |
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object |
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 |
Base site identifier |
string |
Path |
userId |
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 |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
user |
User’s object. |
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
address |
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
address |
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 |
Address identifier. |
string |
|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object. |
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 |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
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 |
Address identifier. |
string |
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
address |
Address object |
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
oldCartId |
Anonymous cart GUID. |
string |
|
Query |
toMergeCartGuid |
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 |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
Optional pagination parameter in case of savedCartsOnly == true. Default value 0. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
Optional {@link PaginationData} parameter in case of savedCartsOnly == true. Default value 20. |
integer (int32) |
|
Query |
savedCartsOnly |
Optional parameter. If the parameter is provided and its value is true, only saved carts are returned. |
boolean |
|
Query |
sort |
Optional sort criterion in case of savedCartsOnly == true. No default value. |
string |
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 |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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 |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
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 |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
address |
Request body parameter that contains details such as the customer’s first name (firstName), the customer’s last name (lastName), the customer’s title (titleCode), the 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 |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
addressId |
Address identifier |
string |
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 |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
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. Explicitly clones a cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/clonesavedcart
2.66.1. Description
Explicitly clones a cart.
2.66.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
description |
The description that should be applied to the cloned cart. |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
name |
The name that should be applied to the cloned cart. |
string |
2.66.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.66.4. Consumes
-
application/json
2.66.5. Tags
-
Save Cart
2.66.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.67. Handles the consolidating pickup locations.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate
2.67.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.67.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
storeName |
The name of the store where items will be picked up |
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
-
Extended Carts
2.67.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.68. Get consolidated pickup options.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/consolidate
2.68.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.68.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.68.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.68.4. Tags
-
Extended Carts
2.68.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.69. Get the delivery mode selected for the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
2.69.1. Description
Returns the delivery mode selected for the cart.
2.69.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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
-
Cart Delivery Modes
2.69.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.70. Sets the delivery mode for a cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
2.70.1. Description
Sets the delivery mode with a given identifier for the cart.
2.70.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
deliveryModeId |
Delivery mode identifier (code) |
string |
2.70.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.70.4. Consumes
-
application/json
2.70.5. Tags
-
Cart Delivery Modes
2.70.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.71. Deletes the delivery mode from the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymode
2.71.1. Description
Deletes the delivery mode from the cart.
2.71.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.71.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.71.4. Tags
-
Cart Delivery Modes
2.71.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.72. Get all delivery modes for the current store and delivery address.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/deliverymodes
2.72.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.72.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.72.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.72.4. Tags
-
Cart Delivery Modes
2.72.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.73. Assigns an email to the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/email
2.73.1. Description
Assigns an email to the cart. This step is required to make a guest checkout.
2.73.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
email |
Email of the guest user. It will be used during the checkout process. |
string |
2.73.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.73.4. Consumes
-
application/json
2.73.5. Tags
-
Carts
2.73.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.74. Adds a product to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/entries
2.74.1. Description
Adds a product to the cart.
2.74.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the product code (product.code), the quantity of product (quantity), and the pickup store name (deliveryPointOfService.name). The DTO is in XML or .json format. |
2.74.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.74.4. Consumes
-
application/xml
-
application/json
2.74.5. Tags
-
Cart Entries
2.74.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.75. Get cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries
2.75.1. Description
Returns cart entries.
2.75.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.75.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.75.4. Tags
-
Cart Entries
2.75.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.76. Get the details of the cart entries.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
2.76.1. Description
Returns the details of the cart entries.
2.76.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer (int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.76.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.76.4. Tags
-
Cart Entries
2.76.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.77. Set quantity and store details of a cart entry.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
2.77.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.77.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer (int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
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.77.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.77.4. Consumes
-
application/xml
-
application/json
2.77.5. Tags
-
Cart Entries
2.77.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.78. Deletes cart entry.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entries/{entryNumber}
2.78.1. Description
Deletes cart entry.
2.78.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer (int64) |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.78.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.78.4. Tags
-
Cart Entries
2.78.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.79. Update quantity and store details of a cart entry.
PATCH /{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.
2.79.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryNumber |
The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0). |
integer (int64) |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
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 |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
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. Add a product to a cart entry group.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}
2.80.1. Description
Adds a product to a cart entry group.
2.80.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
entryGroupNumber |
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 |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
entry |
Request body parameter that contains details such as the product code (product.code) and the quantity of product (quantity). |
2.80.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.80.4. Consumes
-
application/json
2.80.5. Tags
-
Cart Entry Groups
2.80.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.81. Delete an entry group.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/entrygroups/{entryGroupNumber}
2.81.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.81.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
entryGroupNumber |
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 |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.81.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.81.4. Tags
-
Cart Entry Groups
2.81.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.82. Flag a cart for deletion.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/flagForDeletion
2.82.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.82.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.82.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.82.4. Consumes
-
application/json
2.82.5. Tags
-
Save Cart
2.82.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.83. Get information needed for create subscription
GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/request
2.83.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.83.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
extendedMerchantCallback |
Define which url should be returned |
boolean |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
responseUrl |
The URL that the payment provider uses to return payment information. Possible values for responseUrl include the following: “orderPage_cancelResponseURL”, “orderPage_declineResponseURL”, and “orderPage_receiptResponseURL”. |
string |
2.83.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.83.4. Tags
-
Extended Carts
2.83.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.84. Handles response from payment provider and create payment details
POST /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
2.84.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.84.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.84.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.84.4. Consumes
-
application/json
2.84.5. Tags
-
Extended Carts
2.84.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.85. Get information about create subscription request results
GET /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
2.85.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.85.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
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. Deletes payment provider response related to cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/payment/sop/response
2.86.1. Description
Deletes the payment provider response related to the specified cart.
2.86.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.86.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.86.4. Tags
-
Extended Carts
2.86.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.87. Defines and assigns details of a new credit card payment to the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
2.87.1. Description
Defines the details of a new credit card, and assigns this payment option to the cart.
2.87.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
paymentDetails |
Request body parameter that contains details such as the name on the card (accountHolderName), the card number (cardNumber), the card type (cardType.code), the month of the expiry date (expiryMonth), the year of the expiry date (expiryYear), whether the payment details should be saved (saved), whether the payment details should be set as default (defaultPaymentInfo), and the billing address (billingAddress.firstName, billingAddress.lastName, billingAddress.titleCode, billingAddress.country.isocode, billingAddress.line1, billingAddress.line2, billingAddress.town, billingAddress.postalCode, billingAddress.region.isocode) The DTO is in XML or .json format. |
2.87.3. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.87.4. Consumes
-
application/xml
-
application/json
2.87.5. Tags
-
Cart Payments
2.87.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.88. Sets credit card payment details for the cart.
PUT /{baseSiteId}/users/{userId}/carts/{cartId}/paymentdetails
2.88.1. Description
Sets credit card payment details for the cart.
2.88.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
paymentDetailsId |
Payment details identifier. |
string |
2.88.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.88.4. Consumes
-
application/json
2.88.5. Tags
-
Cart Payments
2.88.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.89. Enables promotions based on the promotionsId of the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
2.89.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.89.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
promotionId |
Promotion identifier (code) |
string |
2.89.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.89.4. Consumes
-
application/json
2.89.5. Tags
-
Cart Promotions
2.89.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.90. Get information about promotions applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions
2.90.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.90.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.90.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.90.4. Tags
-
Cart Promotions
2.90.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.91. Get information about promotion applied on cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}
2.91.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.91.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
promotionId |
Promotion identifier (code) |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.91.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.91.4. Tags
-
Cart Promotions
2.91.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.92. Disables the promotion based on the promotionsId of the cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/promotions/{promotionId}
2.92.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.92.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
promotionId |
Promotion identifier (code) |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.92.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.92.4. Tags
-
Cart Promotions
2.92.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.93. Restore a saved cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/restoresavedcart
2.93.1. Description
Restore a saved cart.
2.93.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.93.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.93.4. Consumes
-
application/json
2.93.5. Tags
-
Save Cart
2.93.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.94. Explicitly saves a cart.
PATCH /{baseSiteId}/users/{userId}/carts/{cartId}/save
2.94.1. Description
Explicitly saves a cart.
2.94.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
saveCartDescription |
The description that should be applied to the saved cart. |
string |
|
Query |
saveCartName |
The name that should be applied to the saved cart. |
string |
2.94.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.94.4. Consumes
-
application/json
2.94.5. Tags
-
Save Cart
2.94.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.95. Get a saved cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/savedcart
2.95.1. Description
Returns a saved cart for an authenticated user. The cart is identified using the "cartId" parameter.
2.95.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.95.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.95.4. Tags
-
Save Cart
2.95.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.96. Validates the cart
POST /{baseSiteId}/users/{userId}/carts/{cartId}/validate
2.96.1. Description
Runs a cart validation and returns the result.
2.96.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.96.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.96.4. Consumes
-
application/json
2.96.5. Tags
-
Carts
2.96.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.97. Applies a voucher based on the voucherId defined for the cart.
POST /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
2.97.1. Description
Applies a voucher based on the voucherId defined for the cart.
2.97.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
voucherId |
Voucher identifier (code) |
string |
2.97.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.97.4. Consumes
-
application/json
2.97.5. Tags
-
Cart Promotions
2.97.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.98. Get a list of vouchers applied to the cart.
GET /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers
2.98.1. Description
Returns a list of vouchers applied to the cart.
2.98.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.98.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.98.4. Tags
-
Cart Promotions
2.98.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.99. Deletes a voucher defined for the current cart.
DELETE /{baseSiteId}/users/{userId}/carts/{cartId}/vouchers/{voucherId}
2.99.1. Description
Deletes a voucher based on the voucherId defined for the current cart.
2.99.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
cartId |
Cart identifier: cart code for logged in user, cart guid for anonymous user, 'current' for the last modified cart |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Path |
voucherId |
Voucher identifier (code) |
string |
2.99.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.99.4. Tags
-
Cart Promotions
2.99.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.100. A user can give consent.
POST /{baseSiteId}/users/{userId}/consents
2.100.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
consentTemplateId |
Consent template ID. |
string |
Query |
consentTemplateVersion |
Consent template version. |
integer (int32) |
2.100.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.100.3. Consumes
-
application/json
2.100.4. Tags
-
Consents
2.100.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.101. Withdraw the user consent for a given consent code.
DELETE /{baseSiteId}/users/{userId}/consents/{consentCode}
2.101.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.101.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
consentCode |
Consent code. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
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
-
Consents
2.101.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.102. Fetch the list of consents
GET /{baseSiteId}/users/{userId}/consenttemplates
2.102.1. Description
If user has not given or withdrawn consent to any of the template, no given or withdraw date is returned.
2.102.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.102.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.102.4. Tags
-
Consents
2.102.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.103. Fetch the consent.
GET /{baseSiteId}/users/{userId}/consenttemplates/{consentTemplateId}
2.103.1. Description
If user has not given or withdrawn consent to the template, no given or withdraw date is returned.
2.103.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
consentTemplateId |
Consent template id. |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.103.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.103.4. Tags
-
Consents
2.103.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.104. Get all customer groups of a customer.
GET /{baseSiteId}/users/{userId}/customergroups
2.104.1. Description
Returns all customer groups of a customer.
2.104.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
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
-
Users
2.104.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.105. Changes customer’s login name.
PUT /{baseSiteId}/users/{userId}/login
2.105.1. Description
Changes a customer’s login name. Requires the customer’s current password.
2.105.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
newLogin |
Customer’s new login name. Customer login is case insensitive. |
string |
Query |
password |
Customer’s current password. |
string |
2.105.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.105.4. Consumes
-
application/json
2.105.5. Tags
-
Users
2.105.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.106. Notify about successful login.
POST /{baseSiteId}/users/{userId}/loginnotification
2.106.1. Description
Publish notification event about successful login.
2.106.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.106.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.106.4. Consumes
-
application/json
2.106.5. Tags
-
Login Notification
2.106.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.107. Create an order return request.
POST /{baseSiteId}/users/{userId}/orderReturns
2.107.1. Description
Creates an order return request.
2.107.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Body |
returnRequestEntryInputList |
Return request input list for the current order. |
2.107.3. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.107.4. Consumes
-
application/json
2.107.5. Produces
-
application/json
2.107.6. Tags
-
Return Requests
2.107.7. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.108. Gets the user’s return requests history
GET /{baseSiteId}/users/{userId}/orderReturns
2.108.1. Description
Returns order return request data associated with a specified user for a specified base store.
2.108.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
2.108.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.108.4. Produces
-
application/json
2.108.5. Tags
-
Return Requests
2.108.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.109. Get the details of a return request.
GET /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}
2.109.1. Description
Returns specific order return request details based on a specific return request code. The response contains detailed order return request information.
2.109.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
returnRequestCode |
Order return request code |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.109.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.109.4. Produces
-
application/json
2.109.5. Tags
-
Return Requests
2.109.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.110. Updates the order return request.
PATCH /{baseSiteId}/users/{userId}/orderReturns/{returnRequestCode}
2.110.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.110.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
returnRequestCode |
Order return request code |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
returnRequestModification |
Return request modification object. |
2.110.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.110.4. Consumes
-
application/json
2.110.5. Produces
-
application/json
2.110.6. Tags
-
Return Requests
2.110.7. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.111. Place a order.
POST /{baseSiteId}/users/{userId}/orders
2.111.1. Description
Authorizes the cart and places the order. The response contains the new order data.
2.111.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
cartId |
Cart code for logged in user, cart GUID for guest checkout |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.111.3. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.111.4. Consumes
-
application/json
2.111.5. Tags
-
Orders
2.111.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.112. Get order history for user.
GET /{baseSiteId}/users/{userId}/orders
2.112.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.112.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
currentPage |
The current result page requested. |
integer (int32) |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
pageSize |
The number of results returned per page. |
integer (int32) |
|
Query |
sort |
Sorting method applied to the return results. |
string |
|
Query |
statuses |
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
string |
2.112.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.112.4. Tags
-
Orders
2.112.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.113. Get total number of orders.
HEAD /{baseSiteId}/users/{userId}/orders
2.113.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.113.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
statuses |
Filters only certain order statuses. For example, statuses=CANCELLED,CHECKED_VALID would only return orders with status CANCELLED or CHECKED_VALID. |
string |
2.113.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.113.4. Consumes
-
application/json
2.113.5. Tags
-
Orders
2.113.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.114. Get a order.
GET /{baseSiteId}/users/{userId}/orders/{code}
2.114.1. Description
Returns specific order details based on a specific order code. The response contains detailed order information.
2.114.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Order GUID (Globally Unique Identifier) or order CODE |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
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. Cancel an order.
POST /{baseSiteId}/users/{userId}/orders/{code}/cancellation
2.115.1. Description
Cancels an order partially or completely
2.115.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
code |
Order code |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
cancellationRequestEntryInputList |
Cancellation request input list for the current order. |
2.115.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.115.4. Consumes
-
application/json
2.115.5. Produces
-
application/json
2.115.6. Tags
-
Orders
2.115.7. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.116. Changes customer’s password
PUT /{baseSiteId}/users/{userId}/password
2.116.1. Description
Changes customer’s password.
2.116.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Query |
new |
New password. |
string |
Query |
old |
Old password. Required only for ROLE_CUSTOMERGROUP |
string |
2.116.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.116.4. Consumes
-
application/json
2.116.5. Tags
-
Users
2.116.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.117. Get customer’s credit card payment details list.
GET /{baseSiteId}/users/{userId}/paymentdetails
2.117.1. Description
Return customer’s credit card payment details list.
2.117.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
Query |
saved |
Type of payment details. |
boolean |
|
2.117.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.117.4. Tags
-
Payment Details
2.117.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.118. Get customer’s credit card payment details.
GET /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
2.118.1. Description
Returns a customer’s credit card payment details for the specified paymentDetailsId.
2.118.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
paymentDetailsId |
Payment details identifier. |
string |
|
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.118.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.118.4. Tags
-
Payment Details
2.118.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.119. Updates existing customer’s credit card payment info.
PUT /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
2.119.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.119.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object. |
2.119.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.119.4. Consumes
-
application/xml
-
application/json
2.119.5. Tags
-
Payment Details
2.119.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.120. Deletes customer’s credit card payment details.
DELETE /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
2.120.1. Description
Deletes a customer’s credit card payment details based on a specified paymentDetailsId.
2.120.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
2.120.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.120.4. Tags
-
Payment Details
2.120.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.121. Updates existing customer’s credit card payment details.
PATCH /{baseSiteId}/users/{userId}/paymentdetails/{paymentDetailsId}
2.121.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.121.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
Path |
paymentDetailsId |
Payment details identifier. |
string |
Path |
userId |
User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user |
string |
Body |
paymentDetails |
Payment details object |
2.121.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
No Content |
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
2.121.4. Consumes
-
application/xml
-
application/json
2.121.5. Tags
-
Payment Details
2.121.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.122. Get a voucher based on code.
GET /{baseSiteId}/vouchers/{code}
2.122.1. Description
Returns details of a single voucher that is specified by its voucher identification code.
2.122.2. Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
baseSiteId |
Base site identifier |
string |
|
Path |
code |
Voucher identifier (code) |
string |
|
Query |
fields |
Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC, DEFAULT, FULL |
string |
|
2.122.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.122.4. Tags
-
Vouchers
2.122.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 |
Cellphone number |
string |
city |
city |
|
cityDistrict |
city district |
|
companyName |
Company Name |
string |
country |
Country where address is located |
|
defaultAddress |
Boolean flag if address is default |
boolean |
district |
District name |
string |
email |
Email address |
string |
firstName |
First name of the address person |
string |
formattedAddress |
Boolean flag if address is formatted |
string |
id |
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 |
Last name of the address person |
string |
line1 |
First line of the address |
string |
line2 |
Second line of the address |
string |
phone |
Phone number |
string |
postalCode |
Postal code of the address |
string |
region |
Region where address belongs to |
|
shippingAddress |
Boolean flag if address is for shipping |
boolean |
title |
Title of the address person |
string |
titleCode |
Code of the title |
string |
town |
Town, field required |
string |
visibleInAddressBook |
Boolean flag if address is visible in the Address Book |
boolean |
3.2. AddressList
Representation of an Address list
Name | Description | Schema |
---|---|---|
addresses |
List of addresses |
< Address > array |
3.3. AddressValidation
Representation of an Address Validation
Name | Description | Schema |
---|---|---|
decision |
Decision |
string |
errors |
List of errors |
|
suggestedAddresses |
List of suggested addresses |
< Address > array |
3.4. BaseOption
Representation of a Base Ooption
Name | Description | Schema |
---|---|---|
options |
List of all variant options |
< VariantOption > array |
selected |
Variant option selected |
|
variantType |
Variant type of base option |
string |
3.5. BaseSite
Representation of a Base Site
Name | Description | Schema |
---|---|---|
channel |
Channel |
string |
defaultLanguage |
Default language for Basesite |
|
defaultPreviewCatalogId |
Default preview catalog id |
string |
defaultPreviewCategoryCode |
Default preview category code |
string |
defaultPreviewProductCode |
Default preview product code |
string |
locale |
Locale data for Basesite |
string |
name |
Name of Basesite |
string |
stores |
List of Basestores |
< BaseStore > array |
theme |
Theme of Basesite |
string |
uid |
Unique identifier of Basesite |
string |
urlEncodingAttributes |
List of url encoding attributes |
< string > array |
urlPatterns |
List of url patterns |
< string > array |
3.6. BaseSiteList
Representation of a Base Site List
Name | Description | Schema |
---|---|---|
baseSites |
List of basesites |
< BaseSite > array |
3.7. BaseStore
Representation of a Base Store
Name | Description | Schema |
---|---|---|
createReturnProcessCode |
Create return process code |
string |
currencies |
List of currencies |
< Currency > array |
defaultCurrency |
Default currency |
|
defaultDeliveryOrigin |
Point of service being default delivery origin |
|
defaultLanguage |
Default language |
|
deliveryCountries |
List of delivery countries |
< Country > array |
deliveryModes |
List of delivery modes |
|
expressCheckoutEnabled |
Flag specifying whether the express checkout option is enabled |
boolean |
externalTaxEnabled |
Flag defining is external tax is enabled |
boolean |
languages |
List of languages |
< Language > array |
maxRadiusForPosSearch |
Maximum radius for searching point of service |
number (double) |
name |
Base store name |
string |
paymentProvider |
Payment provider |
string |
pointsOfService |
List of points of service |
< PointOfService > array |
submitOrderProcessCode |
Submit order process code |
string |
3.8. Breadcrumb
Representation of a Breadcrumb
Name | Description | Schema |
---|---|---|
facetCode |
Code of the facet |
string |
facetName |
Name of the facet |
string |
facetValueCode |
Value code of the facet |
string |
facetValueName |
Value name of the facet |
string |
removeQuery |
Remove query |
|
truncateQuery |
Truncate query |
3.9. CancellationRequestEntryInput
Representation of a cancellation request entry input for an order
Name | Description | Schema |
---|---|---|
orderEntryNumber |
Order entry number of the cancelled product |
integer (int32) |
quantity |
Quantity of the product which belongs to the order entry and is requested to be cancelled |
integer (int64) |
3.10. CancellationRequestEntryInputList
Representation of a cancellation request entry input list for an order
Name | Description | Schema |
---|---|---|
cancellationRequestEntryInputs |
Cancellation request entry inputs which contain information about the order entries which are requested to be cancelled |
< CancellationRequestEntryInput > array |
3.11. CardType
Representation of a Card Type
Name | Description | Schema |
---|---|---|
code |
Card type code |
string |
name |
Card type name |
string |
3.12. CardTypeList
Representation of a Card Type List
Name | Description | Schema |
---|---|---|
cardTypes |
List of card types |
< CardType > array |
3.13. Cart
Representation of a Cart
Name | Description | Schema |
---|---|---|
appliedOrderPromotions |
List of applied order promotions |
< PromotionResult > array |
appliedProductPromotions |
List of applied product promotions |
< PromotionResult > array |
appliedVouchers |
List of applied vouchers |
< Voucher > array |
calculated |
Flag showing if order is calculated |
boolean |
chinesePaymentInfo |
Chinese payment info |
|
code |
Code number of order |
string |
deliveryAddress |
Delivery address |
|
deliveryCost |
Delivery cost |
|
deliveryItemsQuantity |
Quantity of delivery items |
integer (int64) |
deliveryMode |
Delivery mode information |
|
deliveryOrderGroups |
List of delivery order entries group |
< DeliveryOrderEntryGroup > array |
deliveryTimeSlot |
||
description |
Description of the cart |
string |
entries |
List of order entries |
< OrderEntry > array |
entryGroups |
List of entry groups |
< EntryGroup > array |
expirationTime |
Date of cart expiration time |
string (date-time) |
guid |
Guest user id identifier |
string |
name |
Name of the cart |
string |
net |
Flag stating iv value is net-value |
boolean |
orderDiscounts |
Order discounts |
|
paymentInfo |
Payment information |
|
paymentStatus |
Payment status |
string |
pickupItemsQuantity |
Quantity of pickup items |
integer (int64) |
pickupOrderGroups |
List of pickup order entry group |
< PickupOrderEntryGroup > array |
potentialOrderPromotions |
List of potential order promotions for cart |
< PromotionResult > array |
potentialProductPromotions |
List of potential product promotions for cart |
< PromotionResult > array |
productDiscounts |
Product discounts |
|
saveTime |
Date of saving cart |
string (date-time) |
savedBy |
Information about person who saved cart |
|
site |
Site |
string |
store |
Store |
string |
subTotal |
Subtotal price |
|
taxInvoice |
||
totalDiscounts |
Total discounts |
|
totalItems |
integer (int32) |
|
totalPrice |
Total price value |
|
totalPriceWithTax |
Total price with tax |
|
totalTax |
Total tax price |
|
totalUnitCount |
Total unit count |
integer (int32) |
user |
User information |
3.14. CartList
Representation of a Cart list
Name | Description | Schema |
---|---|---|
carts |
List of carts |
< Cart > array |
3.15. CartModification
Representation of a Cart modification
Name | Description | Schema |
---|---|---|
deliveryModeChanged |
Delivery mode changed |
boolean |
entry |
Order entry |
|
quantity |
Final quantity after cart modification |
integer (int64) |
quantityAdded |
Quantity added with cart modification |
integer (int64) |
statusCode |
Status code of cart modification |
string |
statusMessage |
Status message |
string |
3.16. CartModificationList
Representation of a Cart modification list
Name | Description | Schema |
---|---|---|
cartModifications |
List of cart modifications |
< CartModification > array |
3.17. Catalog
Representation of an Catalog
Name | Description | Schema |
---|---|---|
catalogVersions |
List of versions of catalog |
< CatalogVersion > array |
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string (date-time) |
name |
Name of abstract catalog item |
string |
url |
Url address of abstract catalog item |
string |
3.18. CatalogList
Representation of a Catalog List
Name | Description | Schema |
---|---|---|
catalogs |
List of catalog items |
< Catalog > array |
3.19. CatalogVersion
Representation of a Catalog Version
Name | Description | Schema |
---|---|---|
categories |
List of category hierarchies |
< CategoryHierarchy > array |
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string (date-time) |
name |
Name of abstract catalog item |
string |
url |
Url address of abstract catalog item |
string |
3.20. Category
Representation of a Category
Name | Description | Schema |
---|---|---|
code |
Code of the category |
string |
image |
Category image |
|
name |
Name of the category |
string |
url |
URL of the category |
string |
3.21. CategoryHierarchy
Representation of a Category Hierarchy
Name | Description | Schema |
---|---|---|
id |
Identifier of abstract catalog item |
string |
lastModified |
Date of last modification |
string (date-time) |
name |
Name of abstract catalog item |
string |
subcategories |
List of subcategory hierarchies |
< CategoryHierarchy > array |
url |
Url address of abstract catalog item |
string |
3.22. ChinesePaymentInfo
Chinese payment info
Name | Description | Schema |
---|---|---|
id |
Chinese payment info identifier |
string |
paymentProvider |
Payment provider of Chinese payment info |
string |
paymentProviderLogo |
Logo url of payment provider |
string |
paymentProviderName |
Name of payment provider |
string |
serviceType |
The serviceType which is used for payment and defined in different payment providers |
string |
3.23. City
data object of city
Name | Description | Schema |
---|---|---|
isocode |
ISO 3166-1 alpha-2 standard, e.g.[countryIso]-[regionNumber]-[cityNumber] |
string |
name |
name of city |
string |
3.24. Classification
Representation of a Classification
Name | Description | Schema |
---|---|---|
code |
Code of the classification |
string |
features |
List of features for given classification |
< Feature > array |
name |
Name of the classification |
string |
3.25. ConfigurationInfo
Representation of a Configuration Info
Name | Description | Schema |
---|---|---|
configurationLabel |
Label of configuration info |
string |
configurationValue |
Value of configuration info |
string |
configuratorType |
Type of configuration info |
string |
status |
Status of configuration info |
string |
3.26. Consent
Representation of a Consent
Name | Description | Schema |
---|---|---|
code |
Code of consent |
string |
consentGivenDate |
Date of consenting |
string (date-time) |
consentWithdrawnDate |
Consent withdrawn date |
string (date-time) |
3.27. ConsentTemplate
Representation of a Consent Template
Name | Description | Schema |
---|---|---|
currentConsent |
Current consent |
|
description |
Consent template description |
string |
id |
Consent template identifier |
string |
name |
Consent template name |
string |
version |
Consent template version |
integer (int32) |
3.28. ConsentTemplateList
Representation of a Consent Template List
Name | Description | Schema |
---|---|---|
consentTemplates |
List of consent templates |
< ConsentTemplate > array |
3.29. Consignment
Representation of a Consignment
Name | Description | Schema |
---|---|---|
code |
Consignment code |
string |
deliveryPointOfService |
Delivery point of service |
|
entries |
List of consignment entries |
< ConsignmentEntry > array |
shippingAddress |
Shipping address |
|
status |
Consignment status |
string |
statusDate |
Consignment status date |
string (date-time) |
statusDisplay |
Consignment status display |
string |
trackingID |
Consignment tracking identifier |
string |
3.30. ConsignmentEntry
Representation of a Consignment Entry
Name | Description | Schema |
---|---|---|
orderEntry |
Order entry of Consignment entry |
|
quantity |
Quantity value of Consignment entry |
integer (int64) |
shippedQuantity |
Shipped quantity |
integer (int64) |
3.31. Country
Response body fields which will be returned while fetching the list of countries. The DTO is in XML or .json format
Name | Description | Schema |
---|---|---|
isocode |
Country code in iso format |
string |
name |
Name of the country |
string |
3.32. CountryList
List of countries
Name | Description | Schema |
---|---|---|
countries |
This is the list of Country fields that should be returned in the response body |
< Country > array |
3.33. Currency
Representation of a Currency
Name | Description | Schema |
---|---|---|
active |
Boolean flag whether currency is active |
boolean |
isocode |
Code of the currency in iso format |
string |
name |
Name of the currency |
string |
symbol |
Symbol of the currency |
string |
3.34. CurrencyList
Representation of a Currency List
Name | Description | Schema |
---|---|---|
currencies |
List of currencies |
< Currency > array |
3.35. DeliveryMode
Representation of a Delivery mode
Name | Description | Schema |
---|---|---|
code |
Code of the delivery mode |
string |
deliveryCost |
Cost of the delivery |
|
description |
Description of the delivery mode |
string |
name |
Name of the delivery mode |
string |
3.36. DeliveryModeList
Representation of a Delivery mode list
Name | Description | Schema |
---|---|---|
deliveryModes |
List of delivery modes |
< DeliveryMode > array |
3.37. DeliveryOrderEntryGroup
Representation of a Delivery Order Entry Group
Name | Description | Schema |
---|---|---|
deliveryAddress |
Delivery address for order entry group |
|
entries |
List of order entries |
< OrderEntry > array |
quantity |
Quantity of order entries in a group |
integer (int64) |
totalPriceWithTax |
Total price with tax |
3.38. DeliveryTimeSlot
data type of delivery timeslot
Name | Description | Schema |
---|---|---|
code |
delivery timeslot code |
string |
name |
delivery timeslot name |
string |
3.39. District
data object of district
Name | Description | Schema |
---|---|---|
isocode |
ISO 3166-1 alpha-2 standard, e.g.[countryIso]-[regionNumber]-[cityNumber]-[districtNumber] |
string |
name |
name of district |
string |
3.40. EntryGroup
Representation of an Entry Group
Name | Description | Schema |
---|---|---|
entries |
List of order entries |
< OrderEntry > array |
entryGroupNumber |
Identifier of the entry group |
integer (int32) |
entryGroups |
List of child entry groups |
< EntryGroup > array |
erroneous |
Indicates if the entry group is in an error state |
boolean |
label |
Label for the entry group |
string |
type |
Indicates type of the group, possible values are STANDALONE, CONFIGURABLEBUNDLE or any customer implemented type for any new provider |
string |
3.41. Facet
Representation of a Facet
Name | Description | Schema |
---|---|---|
category |
Flag stating if facet is category facet |
boolean |
multiSelect |
Flag stating if facet is multiSelect |
boolean |
name |
Name of the facet |
string |
priority |
Priority value of the facet |
integer (int32) |
topValues |
List of top facet values |
< FacetValue > array |
values |
List of all facet values |
< FacetValue > array |
visible |
Flag stating if facet is visible |
boolean |
3.42. FacetValue
Representation of a Facet Value
Name | Description | Schema |
---|---|---|
count |
Count of the facet value |
integer (int64) |
name |
Name of the facet value |
string |
query |
Query of the facet value |
|
selected |
Flag stating if facet value is selected |
boolean |
3.43. Feature
Representation of a Feature
Name | Description | Schema |
---|---|---|
code |
Code of the feature |
string |
comparable |
Flag defining it feature is comparable |
boolean |
description |
Description of the feature |
string |
featureUnit |
Feature unit |
|
featureValues |
List of feature values |
< FeatureValue > array |
name |
Name of the feature |
string |
range |
Range number of the reature |
boolean |
type |
Type of the feature |
string |
3.44. FeatureUnit
Representation of a Feature Unit
Name | Description | Schema |
---|---|---|
name |
Name of the feature unit |
string |
symbol |
Symbol of the feature unit |
string |
unitType |
Type of the feature unit |
string |
3.45. FeatureValue
Representation of a Feature Value
Name | Description | Schema |
---|---|---|
value |
Value of the feature |
string |
3.46. FutureStock
Representation of a Future Stock
Name | Description | Schema |
---|---|---|
date |
Date of future stock |
string (date-time) |
formattedDate |
Date of future stock expressed in text value |
string |
stock |
Stock information of future stock |
3.47. GeoPoint
Representation of a GeoPoint
Name | Description | Schema |
---|---|---|
latitude |
Geopoint latitude |
number (double) |
longitude |
Geopoint longitude |
number (double) |
3.48. Image
Representation of an Image
Name | Description | Schema |
---|---|---|
altText |
Tooltip content which is visible while image mouse hovering |
string |
format |
Format of the image, can be zoom, product, thumbnail, store, cartIcon, etc. |
string |
galleryIndex |
Index of the image while displayed in gallery |
integer (int32) |
imageType |
Type of the image, can be PRIMARY or GALLERY |
enum (PRIMARY, GALLERY) |
url |
URL address of the image |
string |
3.49. Language
Representation of a Language
Name | Description | Schema |
---|---|---|
active |
true/false indicator when the language is active |
boolean |
isocode |
iso code of the language |
string |
name |
name of the language |
string |
nativeName |
name the language in native form |
string |
3.50. LanguageList
Lists all available languages (all languages used for a particular store). If the list of languages for a base store is empty, a list of all languages available in the system will be returned
Name | Description | Schema |
---|---|---|
languages |
This is the list of Language fields that should be returned in the response body |
< Language > array |
3.51. MemberList
Representation of a Member List
Name | Description | Schema |
---|---|---|
members |
List of member |
< Principal > array |
3.52. OpeningSchedule
Representation of an Opening schedule
Name | Description | Schema |
---|---|---|
code |
Code of the opening schedule |
string |
name |
Name of the opening schedule |
string |
specialDayOpeningList |
List of special opening days |
< SpecialOpeningDay > array |
weekDayOpeningList |
List of weekday opening days |
< WeekdayOpeningDay > array |
3.53. Order
Representation of an Order
Name | Description | Schema |
---|---|---|
appliedOrderPromotions |
List of applied order promotions |
< PromotionResult > array |
appliedProductPromotions |
List of applied product promotions |
< PromotionResult > array |
appliedVouchers |
List of applied vouchers |
< Voucher > array |
calculated |
Flag showing if order is calculated |
boolean |
cancellable |
Boolean flag showing if order is cancellable |
boolean |
chinesePaymentInfo |
Chinese payment info |
|
code |
Code number of order |
string |
consignments |
List of consignment |
< Consignment > array |
created |
Date of order creation |
string (date-time) |
deliveryAddress |
Delivery address |
|
deliveryCost |
Delivery cost |
|
deliveryItemsQuantity |
Quantity of delivery items |
integer (int64) |
deliveryMode |
Delivery mode information |
|
deliveryOrderGroups |
List of delivery order entries group |
< DeliveryOrderEntryGroup > array |
deliveryStatus |
Order delivery status |
string |
deliveryStatusDisplay |
Order delivery status display |
string |
deliveryTimeSlot |
||
entries |
List of order entries |
< OrderEntry > array |
entryGroups |
List of entry groups |
< EntryGroup > array |
guestCustomer |
Flag showing if customer is Guest customer |
boolean |
guid |
Guest user id identifier |
string |
net |
Flag stating iv value is net-value |
boolean |
orderDiscounts |
Order discounts |
|
paymentInfo |
Payment information |
|
paymentStatus |
Payment status |
string |
pickupItemsQuantity |
Quantity of pickup items |
integer (int64) |
pickupOrderGroups |
List of pickup order entry group |
< PickupOrderEntryGroup > array |
productDiscounts |
Product discounts |
|
returnable |
Boolean flag showing if order is returnable |
boolean |
site |
Site |
string |
status |
Status of order |
string |
statusDisplay |
Status display |
string |
store |
Store |
string |
subTotal |
Subtotal price |
|
taxInvoice |
||
totalDiscounts |
Total discounts |
|
totalItems |
integer (int32) |
|
totalPrice |
Total price value |
|
totalPriceWithTax |
Total price with tax |
|
totalTax |
Total tax price |
|
unconsignedEntries |
List of unconsigned order entries |
< OrderEntry > array |
user |
User information |
3.54. OrderEntry
Representation of an Order entry
Name | Description | Schema |
---|---|---|
basePrice |
Base price of order entry item |
|
cancellableQuantity |
Quantity number of cancellable items in order entry |
integer (int64) |
cancelledItemsPrice |
Total price of cancelled items which belong to the order entry item |
|
configurationInfos |
Configuration info of order entry |
< ConfigurationInfo > array |
deliveryMode |
Delivery mode |
|
deliveryPointOfService |
Point of service associated with order entry |
|
entryNumber |
Entry number of the order entry |
integer (int32) |
product |
Product details of order entry |
|
quantity |
Quantity number of items in order entry |
integer (int64) |
returnableQuantity |
Quantity number of returnable items in order entry |
integer (int64) |
returnedItemsPrice |
Total price of returned items which belong to the order entry item |
|
statusSummaryList |
List of aggregated status information per entry, relevant if the entry is configurable and its configuration contains one or many issues in different severities. Note that configurators typically raise such issues only in case the parent document is changeable. In this case the issues (depending on their severity) need to be fixed before a checkout can be done. This means this segment can be present for a cart entry, for order entries it will always be empty |
< StatusSummary > array |
totalPrice |
Total price of order entry item |
|
updateable |
Flag defining if order entry item is updateable |
boolean |
3.55. OrderEntryList
Representation of an Order entry list consumed
Name | Description | Schema |
---|---|---|
orderEntries |
List of order entries |
< OrderEntry > array |
3.56. OrderHistory
Representation of an Order History
Name | Description | Schema |
---|---|---|
code |
Code of Order History |
string |
guid |
Guest user identifier |
string |
placed |
Date of placing order |
string (date-time) |
status |
Status of Order History |
string |
statusDisplay |
Status display |
string |
total |
Total price |
3.57. OrderHistoryList
Representation of an Order History List
Name | Description | Schema |
---|---|---|
orders |
List of order history items |
< OrderHistory > array |
pagination |
Pagination items |
|
sorts |
List of sorts |
< Sort > array |
3.58. OrderStatusUpdateElement
Representation of an Order Status Update Element
Name | Description | Schema |
---|---|---|
baseSiteId |
BaseSite identifier |
string |
code |
Code of update element of order status |
string |
status |
Status of update element |
string |
3.59. OrderStatusUpdateElementList
Representation of an Order Status Update Element List
Name | Description | Schema |
---|---|---|
orderStatusUpdateElements |
List of order status update elements |
< OrderStatusUpdateElement > array |
3.60. PaymentDetails
Representation of a Payment Details
Name | Description | Schema |
---|---|---|
accountHolderName |
Name of account holder |
string |
billingAddress |
Address details to be considered as billing address |
|
cardNumber |
Payment card number |
string |
cardType |
Type of payment card |
|
defaultPayment |
Flag to mark if payment the default one |
boolean |
expiryMonth |
Month of expiration of payment |
string |
expiryYear |
Year of expiration of payment |
string |
id |
Unique identifier of payment detail |
string |
issueNumber |
Issue number |
string |
saved |
Flag to mark if payment is saved one |
boolean |
startMonth |
Start month from which payment is valid |
string |
startYear |
Start year from which payment is valid |
string |
subscriptionId |
Identifier of subscription |
string |
3.61. PaymentDetailsList
Representation of a Payment details list
Name | Description | Schema |
---|---|---|
payments |
List of payment details |
< PaymentDetails > array |
3.62. PaymentMode
Representation of a Payment Mode
Name | Description | Schema |
---|---|---|
code |
Payment mode code |
string |
description |
Payment mode description |
string |
name |
Payment mode name |
string |
pspLogoUrl |
Logo url of payment mode |
string |
3.63. PaymentModeList
Representation of a Payment Mode List
Name | Description | Schema |
---|---|---|
paymentModes |
List of payment modes |
< PaymentMode > array |
3.64. PaymentRequest
Name | Schema |
---|---|
mappingLabels |
< string, string > map |
parameters |
< string, string > map |
postUrl |
string |
3.65. PickupOrderEntryGroup
Representation of a Pickup Order Entry Group
Name | Description | Schema |
---|---|---|
deliveryPointOfService |
Delivery point of service |
|
distance |
Distance calculated to pickup place |
number (double) |
entries |
List of order entries |
< OrderEntry > array |
quantity |
Quantity of order entries in a group |
integer (int64) |
totalPriceWithTax |
Total price with tax |
3.66. PointOfService
Representation of a Point of service
Name | Description | Schema |
---|---|---|
address |
Address information of point of service |
|
description |
Description of the point of service |
string |
displayName |
Display name of the point of service |
string |
distanceKm |
Distance to the point of service as number value |
number (double) |
features |
List of features for a given point of service |
< string, string > map |
formattedDistance |
Distance to the point of service as text value |
string |
geoPoint |
Geopoint localization info about point of service |
|
mapIcon |
Image associated with the point of service |
|
name |
Name of the point of service |
string |
openingHours |
Opening hours of point of service |
|
storeContent |
Store content of given point of service |
string |
storeImages |
Collection of images associated with a point of service |
< Image > array |
url |
Url address of the point of service |
string |
3.67. PointOfServiceList
Representation of a Point of Service List
Name | Description | Schema |
---|---|---|
pointOfServices |
List of points of service |
< PointOfService > array |
3.68. PointOfServiceStock
Representation of a Point Of Service Stock
Name | Description | Schema |
---|---|---|
address |
Address information of point of service |
|
description |
Description of the point of service |
string |
displayName |
Display name of the point of service |
string |
distanceKm |
Distance to the point of service as number value |
number (double) |
features |
List of features for a given point of service |
< string, string > map |
formattedDistance |
Distance to the point of service as text value |
string |
geoPoint |
Geopoint localization info about point of service |
|
mapIcon |
Image associated with the point of service |
|
name |
Name of the point of service |
string |
openingHours |
Opening hours of point of service |
|
stockInfo |
Stock information about point of service |
|
storeContent |
Store content of given point of service |
string |
storeImages |
Collection of images associated with a point of service |
< Image > array |
url |
Url address of the point of service |
string |
3.69. Price
Representation of a Price
Name | Description | Schema |
---|---|---|
currencyIso |
Currency iso format |
string |
formattedValue |
Value of price formatted |
string |
maxQuantity |
Maximum quantity of the price value |
integer (int64) |
minQuantity |
Minimum quantity of the price value |
integer (int64) |
priceType |
Type of the price |
enum (BUY, FROM) |
value |
Value of price in BigDecimal format |
number |
3.70. PriceRange
Representation of a Price Range
Name | Description | Schema |
---|---|---|
maxPrice |
Maximum value of the Price Range |
|
minPrice |
Minium value of the Price Range |
3.71. Principal
Representation of a Principal webservice DTO used for defining User data types
Name | Description | Schema |
---|---|---|
name |
Name of the user |
string |
uid |
Unique user identifier |
string |
3.72. Product
Representation of a Product
Name | Description | Schema |
---|---|---|
availableForPickup |
Flag defining if product is available for pickup |
boolean |
averageRating |
Rating number of average value |
number (double) |
baseOptions |
List of base options related to the product |
< BaseOption > array |
baseProduct |
Information about base product |
string |
categories |
List of categories product belongs to |
< Category > array |
classifications |
List of classifications related to the product |
< Classification > array |
code |
Code of the product |
string |
configurable |
Flag stating if product is configurable |
boolean |
configuratorType |
Configurator type related to the product |
string |
description |
Description of the product |
string |
futureStocks |
List of future stocks |
< FutureStock > array |
images |
List of images linked to product |
< Image > array |
manufacturer |
Data of product manufacturer |
string |
multidimensional |
Flag stating if product is multidimentional |
boolean |
name |
Name of the product |
string |
numberOfReviews |
Number of reviews associated with the product |
integer (int32) |
potentialPromotions |
List of potential promotions related to the product |
< Promotion > array |
price |
Price of the product |
|
priceRange |
Price range assigned to the product |
|
productReferences |
List of product references |
< ProductReference > array |
purchasable |
Flag defining if product is purchasable |
boolean |
reviews |
List of reviews associated with the product |
< Review > array |
stock |
Stock value of the product |
|
summary |
Product summary |
string |
tags |
Tags associated with the product |
< string > array |
timedAccessPromotion |
||
url |
Url address of the product |
string |
variantMatrix |
List of variant matrixes associated with the product |
< VariantMatrixElement > array |
variantOptions |
List of variant options related to the product |
< VariantOption > array |
variantType |
Variant type of the product |
string |
volumePrices |
List of volume prices |
< Price > array |
volumePricesFlag |
Flag stating if volume price should be displayed |
boolean |
3.73. ProductExpressUpdateElement
Representation of a Product Express Update Element
Name | Description | Schema |
---|---|---|
catalogId |
Catalog identifier |
string |
catalogVersion |
Catalog version |
string |
code |
Code of product express update element |
string |
3.74. ProductExpressUpdateElementList
Representation of a Product Express Update Element List
Name | Description | Schema |
---|---|---|
productExpressUpdateElements |
List of product express update element |
< ProductExpressUpdateElement > array |
3.75. ProductList
Representation of a Product List
Name | Description | Schema |
---|---|---|
catalog |
Catalog of product list |
string |
currentPage |
Number of current page |
integer (int32) |
products |
List of products |
< Product > array |
totalPageCount |
Total page count |
integer (int32) |
totalProductCount |
Total product count |
integer (int32) |
version |
Version of product list |
string |
3.76. ProductReference
Representation of a Product Reference
Name | Description | Schema |
---|---|---|
description |
Reference description |
string |
preselected |
Flag stating if product reference is preselected |
boolean |
quantity |
Reference quantity |
integer (int32) |
referenceType |
Reference type |
string |
target |
Target product |
3.77. ProductReferenceList
Representation of a Product Reference List
Name | Description | Schema |
---|---|---|
references |
List of product references |
< ProductReference > array |
3.78. ProductSearchPage
Representation of a Product Search Page
Name | Description | Schema |
---|---|---|
breadcrumbs |
List of breadcrumbs info |
< Breadcrumb > array |
categoryCode |
Code of category |
string |
currentQuery |
Current query |
|
facets |
List of facets |
< Facet > array |
freeTextSearch |
Free text search |
string |
keywordRedirectUrl |
Redirect url address keyword |
string |
pagination |
Pagination number |
|
products |
List of products |
< Product > array |
sorts |
List of sorts |
< Sort > array |
spellingSuggestion |
Spelling suggestion |
3.79. Promotion
Representation of a Promotion
Name | Description | Schema |
---|---|---|
code |
Code of the promotion |
string |
couldFireMessages |
Message about promotion which is displayed when planning potential promotion. This field has higher priority over promotion description |
< string > array |
description |
Description of the promotion |
string |
enabled |
Boolean flag if promotion is enabled |
boolean |
endDate |
Last date of validity of the promotion |
string (date-time) |
firedMessages |
Message fired while the promotion is active. This is info how much you will get when applying the promotion |
< string > array |
priority |
Priority index as numeric value of the promotion. Higher number means higher priority |
integer (int32) |
productBanner |
Image banner of the promotion |
|
promotionGroup |
Group of the promotion |
string |
promotionType |
Type of the promotion |
string |
restrictions |
List of promotion restrictions |
< PromotionRestriction > array |
startDate |
The initial date of the promotion |
string (date-time) |
title |
Promotion title |
string |
3.80. PromotionList
Representation of a Promotion list
Name | Description | Schema |
---|---|---|
promotions |
List of promotions |
< Promotion > array |
3.81. PromotionOrderEntryConsumed
Representation of a Promotion order entry consumed
Name | Description | Schema |
---|---|---|
adjustedUnitPrice |
Adjusted unit price for promotion order entry |
number (double) |
code |
Order entry code |
string |
orderEntryNumber |
Order entry number |
integer (int32) |
quantity |
Quantity of promotion order entry |
integer (int64) |
3.82. PromotionRestriction
Representation of a Promotion Restriction
Name | Description | Schema |
---|---|---|
description |
Description of the promotion restriction |
string |
restrictionType |
Type of the promotion restriction |
string |
3.83. PromotionResult
Representation of a Promotion result
Name | Description | Schema |
---|---|---|
consumedEntries |
List of promotion order entries consumed |
< PromotionOrderEntryConsumed > array |
description |
Description of promotion result |
string |
promotion |
Promotion information for given promotion result |
3.84. PromotionResultList
Representation of a Promotion result list
Name | Description | Schema |
---|---|---|
promotions |
List of promotion results |
< PromotionResult > array |
3.85. Region
Response body fields which will be returned while fetching the list of country’s regions.
Name | Description | Schema |
---|---|---|
countryIso |
Country code in iso format |
string |
isocode |
Country and Region code in iso format |
string |
isocodeShort |
Region code in short iso form |
string |
name |
Name of the region |
string |
3.86. RegionList
List of Regions
Name | Description | Schema |
---|---|---|
regions |
This is the list of Region fields that should be returned in the response body |
< Region > array |
3.87. ResetPassword
Representation of a Reset Password
Name | Description | Schema |
---|---|---|
newPassword |
new password string which is required to complete process of resetting password |
string |
token |
token value which will be generated as unique string that will be sent with email to allow user for completing reset-password operation |
string |
3.88. ReturnRequest
Representation of a return request for an order
Name | Description | Schema |
---|---|---|
cancellable |
Boolean flag for whether the return request is cancellable |
boolean |
code |
Return request code |
string |
creationTime |
Date of the return request creation |
string (date-time) |
deliveryCost |
Delivery cost |
|
order |
Order related to the return request |
|
refundDeliveryCost |
Boolean flag for whether there is a delivery cost for refund |
boolean |
returnEntries |
Entries of the return request which contains information about the returned product |
< ReturnRequestEntry > array |
returnLabelDownloadUrl |
URL of the return label |
string |
rma |
Return merchandise authorization number |
string |
status |
Status of return request |
string |
subTotal |
Subtotal price |
|
totalPrice |
Total price |
3.89. ReturnRequestEntry
Representation of a return request entry which contains information about the returned product
Name | Description | Schema |
---|---|---|
expectedQuantity |
Quantity which is expected to be returned for this return request entry |
integer (int64) |
orderEntry |
Order entry related to the return request entry |
|
refundAmount |
Refund amount of the entry |
3.90. ReturnRequestEntryInput
Representation of a return request entry input for an order
Name | Description | Schema |
---|---|---|
orderEntryNumber |
Order entry number of the returned product |
integer (int32) |
quantity |
Quantity of the product which belongs to the order entry and is requested to be returned |
integer (int64) |
3.91. ReturnRequestEntryInputList
Representation of a return request entry input list for an order
Name | Description | Schema |
---|---|---|
orderCode |
Code of the order which return request is related to |
string |
returnRequestEntryInputs |
Return request entry inputs which contain information about the order entries which are requested to be returned |
< ReturnRequestEntryInput > array |
3.92. ReturnRequestList
Representation of an Order Return Request List
Name | Description | Schema |
---|---|---|
pagination |
Pagination items |
|
returnRequests |
List of order return requests |
< ReturnRequest > array |
sorts |
List of sorts |
< Sort > array |
3.93. ReturnRequestModification
Representation of modifications for a return request
Name | Description | Schema |
---|---|---|
status |
Status of the return request |
enum (CANCELLING) |
3.94. Review
Representation of a Review
Name | Description | Schema |
---|---|---|
alias |
Alias name for the review |
string |
comment |
Review comment |
string |
date |
Date of the review |
string (date-time) |
headline |
Review headline |
string |
id |
Identifier of review |
string |
principal |
Person related to the review |
|
rating |
Review rating value |
number (double) |
3.95. ReviewList
Representation of a Review List
Name | Description | Schema |
---|---|---|
reviews |
List of reviews |
< Review > array |
3.96. SaveCartResult
Representation of a Save Cart Result
Name | Description | Schema |
---|---|---|
savedCartData |
Cart data information for saved cart |
3.97. SearchQuery
Representation of a Search Query
Name | Description | Schema |
---|---|---|
value |
Value of search query |
string |
3.98. SearchState
Representation of a Search State
Name | Description | Schema |
---|---|---|
query |
Query of search state |
|
url |
Url address of search state |
string |
3.99. Sort
Representation a Sort option
Name | Description | Schema |
---|---|---|
code |
Code of Sort |
string |
name |
Name of Sort |
string |
selected |
Flag stating when Sort is selected |
boolean |
3.100. SpecialOpeningDay
Representation of a special opening day
Name | Description | Schema |
---|---|---|
closed |
Flag stating if special opening day is closed |
boolean |
closingTime |
Closing time of opening day |
|
comment |
Comment field |
string |
date |
Date of special opening day |
string (date-time) |
formattedDate |
Text representation of the date of special opening day |
string |
name |
Name of the special opening day event |
string |
openingTime |
Starting time of opening day |
3.101. SpellingSuggestion
Representation of a Spell Checker Suggestion
Name | Description | Schema |
---|---|---|
query |
Query for spelling suggestion |
string |
suggestion |
Spelling suggestion |
string |
3.102. StatusSummary
Representation of a status summary, an aggregated view on issues for a specific status or severity. These issues are attached to configurations of products or order entries
Name | Description | Schema |
---|---|---|
numberOfIssues |
Number of issues per status |
integer (int32) |
status |
Status or severity indicator, can be one of ERROR, WARNING, INFO or SUCCESS |
string |
3.103. Stock
Representation of a Stock
Name | Description | Schema |
---|---|---|
isValueRounded |
Indicate whether Stock level value is rounded |
boolean |
stockLevel |
Stock level expressed as number |
integer (int64) |
stockLevelStatus |
Status of stock level |
string |
3.104. StoreCount
Representation of a Store Count
Name | Description | Schema |
---|---|---|
count |
Count |
integer (int32) |
isoCode |
Iso code of store |
string |
name |
Name of store count |
string |
storeCountDataList |
List of store counts |
< StoreCount > array |
type |
Type of store count |
string |
3.105. StoreCountList
Representation of a Store Count List
Name | Description | Schema |
---|---|---|
countriesAndRegionsStoreCount |
List of store counts |
< StoreCount > array |
3.106. StoreFinderSearchPage
Representation of a Store finder search page
Name | Description | Schema |
---|---|---|
boundEastLongitude |
Bound east longitude |
number (double) |
boundNorthLatitude |
Bound north latitude |
number (double) |
boundSouthLatitude |
Bound south latitude |
number (double) |
boundWestLongitude |
Bound west longitude |
number (double) |
locationText |
Location text |
string |
pagination |
Pagination |
|
sorts |
List of sortings |
< Sort > array |
sourceLatitude |
Source latitude |
number (double) |
sourceLongitude |
Source longitude |
number (double) |
stores |
List of stores |
< PointOfService > array |
3.107. StoreFinderStockSearchPage
Representation of a Store Finder Stock Search Page
Name | Description | Schema |
---|---|---|
boundEastLongitude |
Bound to east longitude |
number (double) |
boundNorthLatitude |
Bound to north latitude |
number (double) |
boundSouthLatitude |
Bound to south latitude |
number (double) |
boundWestLongitude |
Bound to west longitude |
number (double) |
locationText |
Location text |
string |
pagination |
Pagination |
|
product |
Product |
|
sorts |
List of sorts |
< Sort > array |
sourceLatitude |
Source latitude |
number (double) |
sourceLongitude |
Source longitude |
number (double) |
stores |
List of stores |
< PointOfServiceStock > array |
3.108. Suggestion
Representation of a Suggestion
Name | Description | Schema |
---|---|---|
value |
Suggestion value |
string |
3.109. SuggestionList
Representation of a Suggestion List
Name | Description | Schema |
---|---|---|
suggestions |
List of suggestions |
< Suggestion > array |
3.110. TaxInvoice
data type of tax invoice
Name | Description | Schema |
---|---|---|
recipient |
name of recipient |
string |
recipientType |
recipient type |
string |
taxpayerID |
taxpayer identification number |
string |
3.111. Time
Representation of a Time
Name | Description | Schema |
---|---|---|
formattedHour |
Formatted hour |
string |
hour |
Hour part of the time data |
integer (int32) |
minute |
Minute part of the time data |
integer (int32) |
3.112. Title
Representation of a Title
Name | Description | Schema |
---|---|---|
code |
Title code |
string |
name |
Title name |
string |
3.113. TitleList
Representation of a Title List
Name | Description | Schema |
---|---|---|
titles |
List of titles |
< Title > array |
3.114. User
Representation of an User
Name | Description | Schema |
---|---|---|
currency |
User preferred currency |
|
customerId |
Customer identifier |
string |
deactivationDate |
Deactivation date |
string (date-time) |
defaultAddress |
User address |
|
displayUid |
User identifier |
string |
emailLanguage |
Email Language |
string |
firstName |
User first name |
string |
language |
User preferred language |
|
lastName |
User last name |
string |
mobileNumber |
Mobile Number |
string |
name |
Name of the user |
string |
title |
User title |
string |
titleCode |
User title code |
string |
uid |
Unique user identifier |
string |
3.115. UserGroup
Representation of an User Group
Name | Description | Schema |
---|---|---|
members |
List of members |
< Principal > array |
membersCount |
Number of members |
integer (int32) |
name |
Name of the user |
string |
subGroups |
List of subgroups |
< UserGroup > array |
uid |
Unique user identifier |
string |
3.116. UserGroupList
Representation of an User Group List
Name | Description | Schema |
---|---|---|
currentPage |
Current page |
integer (int32) |
numberOfPages |
Number of pages |
integer (int32) |
pageSize |
Page size |
integer (int32) |
totalNumber |
Total number |
integer (int32) |
userGroups |
List of user groups |
< UserGroup > array |
3.117. UserSignUp
Representation of an UserSignUp. Consists of fields required to register new customer
Name | Description | Schema |
---|---|---|
firstName |
first name of the user |
string |
lastName |
last name of the user |
string |
password |
user password |
string |
titleCode |
string |
|
uid |
user id, unique string required to create new user. It can be email |
string |
3.118. VariantCategory
Representation of a Variant Category
Name | Description | Schema |
---|---|---|
hasImage |
Flag if varian category has image assigned |
boolean |
name |
Variant category name |
string |
priority |
Priority number of variant category |
integer (int32) |
3.119. VariantMatrixElement
Representation of a Variant Matrix Element
Name | Description | Schema |
---|---|---|
elements |
List of elements with the type of variant matrix element |
< VariantMatrixElement > array |
isLeaf |
boolean |
|
parentVariantCategory |
Parent variant category for variant matrix element |
|
variantOption |
Variant option for variant matrix element |
|
variantValueCategory |
Variant value category for variant matrix element |
3.120. VariantOption
Representation of a Variant Option
Name | Description | Schema |
---|---|---|
code |
Code of the variant option |
string |
priceData |
Price data information of the variant option |
|
stock |
Stock value of the variant option |
|
url |
Url address of the variant option |
string |
variantOptionQualifiers |
List of variant option qualifiers |
< VariantOptionQualifier > array |
3.121. VariantOptionQualifier
Representation of a Variant Option Qualifier
Name | Description | Schema |
---|---|---|
image |
Image associated with variant option qualifier |
|
name |
Name of variant option qualifier |
string |
qualifier |
Qualifier |
string |
value |
Value of variant option qualifier |
string |
3.122. VariantValueCategory
Representation of a Variant Value Category
Name | Description | Schema |
---|---|---|
name |
Name of the variant value category |
string |
sequence |
Sequence number of variant value category |
integer (int32) |
superCategories |
Parent category of variant value category |
< VariantCategory > array |
3.123. Voucher
Representation of a Voucher
Name | Description | Schema |
---|---|---|
appliedValue |
Applied value when using this voucher |
|
code |
The identifier of the Voucher. This is the first part of voucher code which holds first 3 letters, like: 123 |
string |
currency |
Currency of the voucher |
|
description |
Description of the voucher |
string |
freeShipping |
Specifies if the order this voucher is applied to is shipped for free (true) or not (false). Defaults to false. |
boolean |
name |
Name of the voucher |
string |
value |
Value of the voucher. Example of such value is: 15.0d |
number (double) |
valueFormatted |
Formatted value of the voucher |
string |
valueString |
The value of the voucher to display. Example: 15.0% |
string |
voucherCode |
Voucher code, is the holder for keeping specific occasional voucher related to business usage. It can be generated and looks like: 123-H8BC-Y3D5-34AL |
string |
3.124. VoucherList
Representation of a Voucher List
Name | Description | Schema |
---|---|---|
vouchers |
List of vouchers |
< Voucher > array |
3.125. WeekdayOpeningDay
Representation of a Weekday Opening Day
Name | Description | Schema |
---|---|---|
closed |
Flag stating if weekday opening day is closed |
boolean |
closingTime |
Closing time of opening day |
|
openingTime |
Starting time of opening day |
|
weekDay |
Text representation of week day opening day |
string |
3.126. deprecatedPagination
Representation of a search results pagination
Name | Description | Schema |
---|---|---|
currentPage |
The current page number. The first page is number zero (0), the second page is number one (1), and so on |
integer (int32) |
pageSize |
The number of results per page. A page may have less results if there are less than a full page of results, only on the last page in the results |
integer (int32) |
sort |
The selected sort code |
string |
totalPages |
The total number of pages. This is the number of pages, each of pageSize, required to display the totalResults. |
integer (int32) |
totalResults |
The total number of matched results across all pages |
integer (int64) |
3.127. error
Error message
Name | Description | Schema |
---|---|---|
errorCode |
Error code |
string |
exceptionMessage |
string |
|
language |
Example : |
string |
message |
Descriptive, human readable error message. |
string |
position |
Example : |
integer (int32) |
reason |
Additional classification specific for each error type e.g. 'noStock'. |
string |
subject |
Identifier of the related object e.g. '1'. |
string |
subjectType |
Type of the object related to the error e.g. 'entry'. |
string |
type |
Type of the error e.g. 'LowStockError'. |
string |
4. Security
4.1. oauth2_Password
Type : oauth2
Flow : password
Token URL : https://{oauth2_url}/authorizationserver/oauth/token
Name |
---|
basic |
4.2. oauth2_client_credentials
Type : oauth2
Flow : application
Token URL : https://{oauth2_url}/authorizationserver/oauth/token
Name |
---|
extended |