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 : /rest/v2

1.4. Tags

  • Address : Address Controller

  • B2B Carts : B 2 B Carts Controller

  • B2B Categories : B 2 B Categories Controller

  • B2B Cost Centers : B 2 B Cost Centers Controller

  • B2B Miscs : B 2 B Miscs Controller

  • B2B Orders : B 2 B Orders Controller

  • B2B Products : B 2 B Products Controller

  • B2B Users : B 2 B Users Controller

  • Base Sites : Base Sites Controller

  • Base Stores : Base Stores Controller

  • Budget Management : Budget Management 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

  • Order Approval Permission Types : Order Approval Permission Types Controller

  • Order Approval Permissions : Order Approval Permissions Controller

  • Order Approvals : Order Approvals Controller

  • Orders : Orders Controller

  • Organizational Unit Customer Management : Org Customer Management Controller

  • Organizational Unit Management : Org Units Controller

  • Organizational Unit User Groups : Org Unit User Groups Controller

  • Payment Details : Payment Details Controller

  • Payment Modes : Payment Modes Controller

  • Products : Products Controller

  • Promotions : Promotions Controller

  • Quotes : Quote Controller

  • Replenishment Order : Replenishment Order Controller

  • Return Requests : Order Returns Controller

  • Save Cart : Save Cart Controller

  • Stores : Stores Controller

  • Users : Users Controller

  • Vouchers : Vouchers Controller

1.5. Produces

  • application/xml

  • application/json

2. Paths

2.1. Get all base sites.

GET /basesites

2.1.1. Description

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

2.1.2. Parameters

Type Name Description Schema Default

Query

fields
optional

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

string

"DEFAULT"

2.1.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.1.4. Tags

  • Base Sites

2.1.5. Security

Type Name

oauth2

oauth2

2.2. Get a base store.

GET /{baseSiteId}/basestores/{baseStoreUid}

2.2.1. Description

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

2.2.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

baseStoreUid
required

Base store name

string

Query

fields
optional

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

string

"DEFAULT"

2.2.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.2.4. Tags

  • Base Stores

2.2.5. Security

Type Name

oauth2

oauth2

2.3. Get a list of supported payment card types.

GET /{baseSiteId}/cardtypes

2.3.1. Description

Lists supported payment card types.

2.3.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.3.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.3.4. Tags

  • Miscs

2.3.5. Security

Type Name

oauth2

oauth2

2.4. Get a list of catalogs

GET /{baseSiteId}/catalogs

2.4.1. Description

Returns all catalogs with versions defined for the base store.

2.4.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.4.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.4.4. Tags

  • Catalogs

2.4.5. Security

Type Name

oauth2

oauth2

2.5. Get a catalog

GET /{baseSiteId}/catalogs/{catalogId}

2.5.1. Description

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

2.5.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.5.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.5.4. Tags

  • Catalogs

2.5.5. Security

Type Name

oauth2

oauth2

2.6. Get information about catalog version

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

2.6.1. Description

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

2.6.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.6.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.6.4. Tags

  • Catalogs

2.6.5. Security

Type Name

oauth2

oauth2

2.7. Get information about catagory in a catalog version

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

2.7.1. Description

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

2.7.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

catalogId
required

Catalog identifier

string

Path

catalogVersionId
required

Catalog version identifier

string

Path

categoryId
required

Category identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.7.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.7.4. Tags

  • Catalogs

2.7.5. Security

Type Name

oauth2

oauth2

2.8. Gets a list of products under a specific category

GET /{baseSiteId}/categories/{categoryId}/products

2.8.1. Description

Returns a list of products in the specified category.

2.8.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

categoryId
required

The category ID

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

query
optional

Serialized query in format: freeTextSearch: sort: facetKey1: facetValue1: facetKey2: facetValue2

string

Query

sort
optional

Sorting method applied to the display search results.

string

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

  • B2B Categories

2.8.5. Security

Type Name

oauth2

oauth2

2.9. Create a new cost center.

POST /{baseSiteId}/costcenters

2.9.1. Description

Creates a new cost center.

2.9.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

Body

costCenter
required

Cost center object.

2.9.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.9.4. Consumes

  • application/json

2.9.5. Produces

  • application/json

2.9.6. Tags

  • B2B Cost Centers

2.9.7. Security

Type Name

oauth2

oauth2

2.10. Get active cost centers.

GET /{baseSiteId}/costcenters

2.10.1. Description

Returns the list of all active cost centers.

2.10.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.10.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.10.4. Tags

  • B2B Cost Centers

2.10.5. Security

Type Name

oauth2

oauth2

2.11. Get a cost center.

GET /{baseSiteId}/costcenters/{costCenterCode}

2.11.1. Description

Returns a specific cost center based on specific code. The response contains detailed cost center information.

2.11.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

fields
optional

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

string

"DEFAULT"

2.11.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.11.4. Tags

  • B2B Cost Centers

2.11.5. Security

Type Name

oauth2

oauth2

2.12. Update a cost center.

PATCH /{baseSiteId}/costcenters/{costCenterCode}

2.12.1. Description

Updates a cost center. Only attributes provided in the request body will be changed.

2.12.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

fields
optional

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

string

"DEFAULT"

Body

costCenter
required

Cost center object.

2.12.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.12.4. Consumes

  • application/json

2.12.5. Produces

  • application/json

2.12.6. Tags

  • B2B Cost Centers

2.12.7. Security

Type Name

oauth2

oauth2

2.13. Add a budget to a specific cost center.

POST /{baseSiteId}/costcenters/{costCenterCode}/budgets

2.13.1. Description

Adds a budget to a specific cost center.

2.13.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Identifier of the cost center to which the budget will be added.

string

Query

budgetCode
required

The budget which will be added to a specific cost center.

string

Query

fields
optional

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

string

"DEFAULT"

2.13.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.13.4. Consumes

  • application/json

2.13.5. Produces

  • application/json

2.13.6. Tags

  • B2B Cost Centers

2.13.7. Security

Type Name

oauth2

oauth2

2.14. Get all budgets and select budgets which belong to a specific cost center.

GET /{baseSiteId}/costcenters/{costCenterCode}/budgets

2.14.1. Description

Returns the list of all budgets, where those budgets, which belong to a specific cost center, are selected.

2.14.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

costCenterCode
required

Cost center identifier.

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

sort
optional

Sorting method applied to the return results.

string

2.14.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.14.4. Produces

  • application/json

2.14.5. Tags

  • B2B Cost Centers

2.14.6. Security

Type Name

oauth2

oauth2

2.15. Remove a budget from a specific cost center.

DELETE /{baseSiteId}/costcenters/{costCenterCode}/budgets/{budgetCode}

2.15.1. Description

Removes a budget from a specific cost center.

2.15.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

The budget which will be removed from a specific cost center.

string

Path

costCenterCode
required

Identifier of the cost center from which the budget will be removed.

string

Query

fields
optional

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

string

"DEFAULT"

2.15.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.15.4. Produces

  • application/json

2.15.5. Tags

  • B2B Cost Centers

2.15.6. Security

Type Name

oauth2

oauth2

2.16. Get cost centers.

GET /{baseSiteId}/costcentersall

2.16.1. Description

Returns the list of all cost centers.

2.16.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

sort
optional

Sorting method applied to the return results.

string

2.16.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.16.4. Produces

  • application/json

2.16.5. Tags

  • B2B Cost Centers

2.16.6. Security

Type Name

oauth2

oauth2

2.17. Get a list of countries.

GET /{baseSiteId}/countries

2.17.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.17.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

Query

type
optional

The type of countries.

enum (SHIPPING, BILLING)

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

  • Countries

2.17.5. Security

Type Name

oauth2

oauth2

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

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

2.18.1. Description

Lists all regions.

2.18.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countyIsoCode
required

An ISO code for a country

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Countries

2.18.5. Security

Type Name

oauth2

oauth2

2.19. Get a list of available currencies.

GET /{baseSiteId}/currencies

2.19.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.19.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Miscs

2.19.5. Security

Type Name

oauth2

oauth2

2.20. Creates a new customer group.

POST /{baseSiteId}/customergroups

2.20.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.20.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Body

userGroup
required

User group object with id and name.

2.20.3. Responses

HTTP Code Description Schema

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.20.4. Consumes

  • application/xml

  • application/json

2.20.5. Tags

  • Customer Groups

2.20.6. Security

Type Name

oauth2

oauth2

2.21. Get all subgroups of a customergroup.

GET /{baseSiteId}/customergroups

2.21.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.21.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

Current page number (starts with 0).

integer (int32)

0

Query

fields
optional

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

string

"BASIC"

Query

pageSize
optional

Number of customer group returned in one page.

integer (int32)

20

2.21.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.21.4. Tags

  • Customer Groups

2.21.5. Security

Type Name

oauth2

oauth2

2.22. Get a specific customer group.

GET /{baseSiteId}/customergroups/{groupId}

2.22.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.22.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Query

fields
optional

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

string

"BASIC"

2.22.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.22.4. Tags

  • Customer Groups

2.22.5. Security

Type Name

oauth2

oauth2

2.23. Sets members for a user group.

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

2.23.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.23.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to set for customer group.

2.23.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.23.4. Consumes

  • application/xml

  • application/json

2.23.5. Tags

  • Customer Groups

2.23.6. Security

Type Name

oauth2

oauth2

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

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

2.24.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.24.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Body

members
required

List of users to assign to customer group.

2.24.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.24.4. Consumes

  • application/xml

  • application/json

2.24.5. Tags

  • Customer Groups

2.24.6. Security

Type Name

oauth2

oauth2

2.25. Deletes a user from a customer group.

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

2.25.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.25.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

groupId
required

Group identifier.

string

Path

userId
required

User identifier.

string

2.25.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.25.4. Tags

  • Customer Groups

2.25.5. Security

Type Name

oauth2

oauth2

2.26. Get a list of shipping countries.

GET /{baseSiteId}/deliverycountries
Caution

operation.deprecated

2.26.1. Description

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

2.26.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Miscs

2.26.5. Security

Type Name

oauth2

oauth2

2.27. Get a list of product exports.

GET /{baseSiteId}/export/products

2.27.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.27.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalog
optional

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

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

timestamp
optional

When this parameter is set, only products modified after the given time will be returned. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).

string

Query

version
optional

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

string

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

  • Export

2.27.5. Security

Type Name

oauth2

oauth2

2.28. Get a list of orders with status updates.

GET /{baseSiteId}/feeds/orders/statusfeed

2.28.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.28.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

Query

timestamp
required

Only items newer than the given parameter are retrieved. This parameter should be in ISO-8601 format (for example, 2018-01-09T16:28:45+0000).

string

2.28.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.28.4. Tags

  • Feeds

2.28.5. Security

Type Name

oauth2

oauth2

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

POST /{baseSiteId}/forgottenpasswordtokens

2.29.1. Description

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

2.29.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Query

userId
required

Customer’s user id. Customer user id is case insensitive.

string

2.29.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.29.4. Consumes

  • application/json

2.29.5. Tags

  • Forgotten Passwords

2.29.6. Security

Type Name

oauth2

oauth2

2.30. Verify the decision of the Merchant

POST /{baseSiteId}/integration/merchant_callback

2.30.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.30.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

2.30.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.30.4. Consumes

  • application/json

2.30.5. Tags

  • Merchant Callback

2.30.6. Security

Type Name

oauth2

oauth2

2.31. Verify the decision of the Merchant for a cart

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

2.31.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.31.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

2.31.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.31.4. Consumes

  • application/json

2.31.5. Tags

  • Merchant Callback

2.31.6. Security

Type Name

oauth2

oauth2

2.32. Get a list of available languages.

GET /{baseSiteId}/languages

2.32.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.32.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.32.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.32.4. Tags

  • Miscs

2.32.5. Security

Type Name

oauth2

oauth2

2.33. Get order approval permission types.

GET /{baseSiteId}/orderApprovalPermissionTypes

2.33.1. Description

Returns the list of order approval permission types.

2.33.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.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. Produces

  • application/json

2.33.5. Tags

  • Order Approval Permission Types

2.33.6. Security

Type Name

oauth2

oauth2

2.34. Get a order.

GET /{baseSiteId}/orders/{code}

2.34.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.34.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Order GUID (Globally Unique Identifier) or order CODE

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Orders

2.34.5. Security

Type Name

oauth2

oauth2

2.35. Returns a product.

GET /{baseSiteId}/orgProducts/{productCode}

2.35.1. Description

Returns a product, based on the specified product code.

2.35.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

The product code

string

Query

fields
optional

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

string

"DEFAULT"

2.35.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.35.4. Tags

  • B2B Products

2.35.5. Security

Type Name

oauth2

oauth2

2.36. Get a B2B user profile

GET /{baseSiteId}/orgUsers/{userId}

2.36.1. Description

Returns a B2B user profile.

2.36.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • B2B Users

2.36.5. Security

Type Name

oauth2

oauth2

2.37. Create a cart based on a previous order

POST /{baseSiteId}/orgUsers/{userId}/cartFromOrder

2.37.1. Description

Returns a list of modification applied to the new cart compared to original. e.g lower quantity was added

2.37.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

enum (BASIC, DEFAULT, FULL)

"DEFAULT"

Query

orderCode
required

The order code

string

2.37.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.37.4. Consumes

  • application/json

2.37.5. Tags

  • B2B Orders

2.37.6. Security

Type Name

oauth2

oauth2

2.38. Sets the delivery address for the checkout cart.

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

2.38.1. Description

Sets the delivery address for the checkout cart.

2.38.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

addressId
required

The id of the address.

string

Query

fields
optional

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

string

"DEFAULT"

2.38.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.38.4. Consumes

  • application/json

2.38.5. Tags

  • B2B Carts

2.38.6. Security

Type Name

oauth2

oauth2

2.39. Adds more quantity to the cart of specific products

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

2.39.1. Description

Updates the details of specified products in the cart, based either on the product code or the entryNumber.

2.39.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entries
optional

List of entries containing the amount to add and the product code or the entryNumber.

2.39.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.39.4. Consumes

  • application/json

2.39.5. Tags

  • B2B Carts

2.39.6. Security

Type Name

oauth2

oauth2

2.40. Updates the quantity for specific products in the cart

PUT /{baseSiteId}/orgUsers/{userId}/carts/{cartId}/entries/

2.40.1. Description

Creates the specified products in the cart, or overwrites the details of existing products in the cart, based either on the product code or the entryNumber. For existing products, attributes not provided in the request body will be defined again (set to null or default).

2.40.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entries
optional

List of entries containing the amount to add and the product code or the entryNumber.

2.40.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.40.4. Consumes

  • application/json

2.40.5. Tags

  • B2B Carts

2.40.6. Security

Type Name

oauth2

oauth2

2.41. Places a B2B Order.

POST /{baseSiteId}/orgUsers/{userId}/orders

2.41.1. Description

Places a B2B Order. By default the payment type is ACCOUNT. Please set payment type to CARD if placing an order using credit card.

2.41.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

cartId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

termsChecked
required

Whether terms were accepted or not.

boolean

2.41.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.41.4. Consumes

  • application/json

2.41.5. Tags

  • B2B Orders

2.41.6. Security

Type Name

oauth2

oauth2

2.42. Creates an Order and schedules Replenishment.

POST /{baseSiteId}/orgUsers/{userId}/replenishmentOrders

2.42.1. Description

Creates an Order and schedules Replenishment. By default the payment type is ACCOUNT. Please set payment type to CARD if placing an order using credit card.

2.42.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

cartId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

termsChecked
required

Whether terms were accepted or not.

boolean

Body

scheduleReplenishmentForm
required

Schedule replenishment form object.

2.42.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.42.4. Consumes

  • application/json

2.42.5. Produces

  • application/json

2.42.6. Tags

  • B2B Orders

2.42.7. Security

Type Name

oauth2

oauth2

2.43. Gets all available payment modes.

GET /{baseSiteId}/paymentmodes

2.43.1. Description

Gets all payment modes defined for the base store.

2.43.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Payment Modes

2.43.5. Security

Type Name

oauth2

oauth2

2.44. Returns a list of the available payment types.

GET /{baseSiteId}/paymenttypes

2.44.1. Description

Returns a list of the available payment types in the B2B checkout process.

2.44.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

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

  • B2B Miscs

2.44.5. Security

Type Name

oauth2

oauth2

2.45. Get products added to the express update feed.

GET /{baseSiteId}/products/expressupdate

2.45.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.45.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

catalog
optional

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

timestamp
required

Only items newer than the given parameter are retrieved from the queue. This parameter should be in ISO-8601 format.

string

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

  • Products

2.45.5. Security

Type Name

oauth2

oauth2

2.46. Get a list of products and additional data

GET /{baseSiteId}/products/search

2.46.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.46.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

query
optional

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

string

Query

searchQueryContext
optional

The context to be used in the search query.

string

Query

sort
optional

Sorting method applied to the return results.

string

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

  • Products

2.46.5. Security

Type Name

oauth2

oauth2

2.47. Get a header with total number of products.

HEAD /{baseSiteId}/products/search

2.47.1. Description

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

2.47.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Query

query
optional

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

string

2.47.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.47.4. Consumes

  • application/json

2.47.5. Tags

  • Products

2.47.6. Security

Type Name

oauth2

oauth2

2.48. Get a list of available suggestions

GET /{baseSiteId}/products/suggestions

2.48.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.48.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

Query

max
optional

Specifies the limit of results.

integer (int32)

10

Query

term
required

Specified term

string

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

  • Products

2.48.5. Security

Type Name

oauth2

oauth2

2.49. Get product details.

GET /{baseSiteId}/products/{productCode}

2.49.1. Description

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

2.49.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.49.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.49.4. Tags

  • Products

2.49.5. Security

Type Name

oauth2

oauth2

2.50. Get a product reference

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

2.50.1. Description

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

2.50.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

Maximum size of returned results.

integer (int32)

2147483647

Query

referenceType
optional

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

string

2.50.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.50.4. Tags

  • Products

2.50.5. Security

Type Name

oauth2

oauth2

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

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

2.51.1. Description

Creates a new customer review as an anonymous user.

2.51.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

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

string

"DEFAULT"

Body

review
required

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

2.51.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.51.4. Consumes

  • application/xml

  • application/json

2.51.5. Tags

  • Products

2.51.6. Security

Type Name

oauth2

oauth2

2.52. Get reviews for a product

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

2.52.1. Description

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

2.52.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

fields
optional

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

string

"DEFAULT"

Query

maxCount
optional

Maximum count of reviews

integer (int32)

2.52.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.52.4. Tags

  • Products

2.52.5. Security

Type Name

oauth2

oauth2

2.53. Get a product’s stock level.

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

2.53.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.53.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

latitude
optional

Latitude location parameter.

number (double)

Query

location
optional

Free-text location

string

Query

longitude
optional

Longitude location parameter.

number (double)

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

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

  • Products

2.53.5. Security

Type Name

oauth2

oauth2

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

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

2.54.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.54.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Query

latitude
optional

Latitude location parameter.

number (double)

Query

location
optional

Free-text location

string

Query

longitude
optional

Longitude location parameter.

number (double)

2.54.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.54.4. Consumes

  • application/json

2.54.5. Tags

  • Products

2.54.6. Security

Type Name

oauth2

oauth2

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

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

2.55.1. Description

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

2.55.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

productCode
required

Product identifier

string

Path

storeName
required

Store identifier

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Products

2.55.5. Security

Type Name

oauth2

oauth2

2.56. Get a list of promotions.

GET /{baseSiteId}/promotions

2.56.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.56.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"BASIC"

Query

promotionGroup
optional

Only promotions from this group are returned

string

Query

type
required

Defines what type of promotions should be returned. Values supported for that parameter are: <ul><li>all: All available promotions are returned</li><li>product: Only product promotions are returned</li><li>order: Only order promotions are returned</li></ul>

enum (all, product, order)

2.56.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.56.4. Tags

  • Promotions

2.56.5. Security

Type Name

oauth2

oauth2

2.57. Get a promotion based on code

GET /{baseSiteId}/promotions/{code}

2.57.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.57.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

code
required

Promotion identifier (code)

string

Query

fields
optional

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

string

"BASIC"

2.57.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.57.4. Tags

  • Promotions

2.57.5. Security

Type Name

oauth2

oauth2

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

POST /{baseSiteId}/resetpassword

2.58.1. Description

Reset password after customer’s clicked forgotten password link.

2.58.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Body

resetPassword
required

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

2.58.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.58.4. Consumes

  • application/xml

  • application/json

2.58.5. Tags

  • Forgotten Passwords

2.58.6. Security

Type Name

oauth2

oauth2

2.59. Get a list of store locations

GET /{baseSiteId}/stores

2.59.1. Description

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

2.59.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number (double)

0.0

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

latitude
optional

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

number (double)

Query

longitude
optional

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

number (double)

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

query
optional

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

string

Query

radius
optional

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

number (double)

100000.0

Query

sort
optional

Sorting method applied to the return results.

string

"asc"

2.59.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.59.4. Tags

  • Stores

2.59.5. Security

Type Name

oauth2

oauth2

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

HEAD /{baseSiteId}/stores

2.60.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.60.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

accuracy
optional

Accuracy in meters.

number (double)

0.0

Query

latitude
optional

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

number (double)

Query

longitude
optional

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

number (double)

Query

query
optional

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

string

Query

radius
optional

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

number (double)

100000.0

2.60.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.60.4. Consumes

  • application/json

2.60.5. Tags

  • Stores

2.60.6. Security

Type Name

oauth2

oauth2

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

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

2.61.1. Description

Lists all store locations that are in the specified country.

2.61.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Stores

2.61.5. Security

Type Name

oauth2

oauth2

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

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

2.62.1. Description

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

2.62.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

countryIso
required

Country ISO code

string

Path

regionIso
required

Region ISO code

string

Query

fields
optional

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

string

"DEFAULT"

2.62.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.62.4. Tags

  • Stores

2.62.5. Security

Type Name

oauth2

oauth2

2.63. Gets a store location count per country and regions

GET /{baseSiteId}/stores/storescounts

2.63.1. Description

Returns store counts in countries and regions

2.63.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

2.63.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.63.4. Tags

  • Stores

2.63.5. Security

Type Name

oauth2

oauth2

2.64. Get a store location

GET /{baseSiteId}/stores/{storeId}

2.64.1. Description

Returns store location based on its unique name.

2.64.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

storeId
required

Store identifier (currently store name)

string

Query

fields
optional

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

string

"DEFAULT"

2.64.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.64.4. Tags

  • Stores

2.64.5. Security

Type Name

oauth2

oauth2

2.65. Get a list of all localized titles.

GET /{baseSiteId}/titles

2.65.1. Description

Lists all localized titles.

2.65.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

2.65.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.65.4. Tags

  • Miscs

2.65.5. Security

Type Name

oauth2

oauth2

2.66. Registers a customer

POST /{baseSiteId}/users

2.66.1. Description

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

2.66.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Query

fields
optional

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

string

"DEFAULT"

Body

user
required

User’s object.

2.66.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.66.4. Consumes

  • application/xml

  • application/json

2.66.5. Tags

  • Users

2.66.6. Security

Type Name

oauth2

oauth2

2.67. Get customer profile

GET /{baseSiteId}/users/{userId}

2.67.1. Description

Returns customer profile.

2.67.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.67.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.67.4. Tags

  • Users

2.67.5. Security

Type Name

oauth2

oauth2

2.68. Updates customer profile

PUT /{baseSiteId}/users/{userId}

2.68.1. Description

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

2.68.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Body

user
required

User’s object

2.68.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.68.4. Consumes

  • application/xml

  • application/json

2.68.5. Tags

  • Users

2.68.6. Security

Type Name

oauth2

oauth2

2.69. Delete customer profile.

DELETE /{baseSiteId}/users/{userId}

2.69.1. Description

Removes customer profile.

2.69.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

2.69.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.69.4. Tags

  • Users

2.69.5. Security

Type Name

oauth2

oauth2

2.70. Updates customer profile

PATCH /{baseSiteId}/users/{userId}

2.70.1. Description

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

2.70.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Body

user
required

User’s object.

2.70.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.70.4. Consumes

  • application/xml

  • application/json

2.70.5. Tags

  • Users

2.70.6. Security

Type Name

oauth2

oauth2

2.71. Creates a new address.

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

2.71.1. Description

Creates a new address.

2.71.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

address
required

Address object.

2.71.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.71.4. Consumes

  • application/xml

  • application/json

2.71.5. Tags

  • Address

2.71.6. Security

Type Name

oauth2

oauth2

2.72. Get customer’s addresses

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

2.72.1. Description

Returns customer’s addresses.

2.72.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Address

2.72.5. Security

Type Name

oauth2

oauth2

2.73. Verifies address.

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

2.73.1. Description

Verifies address.

2.73.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

address
required

Address object.

2.73.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.73.4. Consumes

  • application/xml

  • application/json

2.73.5. Tags

  • Address

2.73.6. Security

Type Name

oauth2

oauth2

2.74. Get info about address

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

2.74.1. Description

Returns detailed information about address with a given id.

2.74.2. Parameters

Type Name Description Schema Default

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.74.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.74.4. Tags

  • Address

2.74.5. Security

Type Name

oauth2

oauth2

2.75. Updates the address

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

2.75.1. Description

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

2.75.2. Parameters

Type Name Description Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Body

address
required

Address object.

2.75.3. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.75.4. Consumes

  • application/xml

  • application/json

2.75.5. Tags

  • Address

2.75.6. Security

Type Name

oauth2

oauth2

2.76. Delete customer’s address.

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

2.76.1. Description

Removes customer’s address.

2.76.2. Parameters

Type Name Description Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

2.76.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.76.4. Tags

  • Address

2.76.5. Security

Type Name

oauth2

oauth2

2.77. Updates the address

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

2.77.1. Description

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

2.77.2. Parameters

Type Name Description Schema

Path

addressId
required

Address identifier.

string

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Body

address
required

Address object

2.77.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.77.4. Consumes

  • application/xml

  • application/json

2.77.5. Tags

  • Address

2.77.6. Security

Type Name

oauth2

oauth2

2.78. Get available organizational unit nodes.

GET /{baseSiteId}/users/{userId}/availableOrgUnitNodes

2.78.1. Description

Returns list of available organizational unit nodes.

2.78.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.78.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.78.4. Produces

  • application/json

2.78.5. Tags

  • Organizational Unit Management

2.78.6. Security

Type Name

oauth2

oauth2

2.79. Creates a new budget

POST /{baseSiteId}/users/{userId}/budgets

2.79.1. Description

Creates a new budget.

2.79.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

budget
required

Budget

2.79.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.79.4. Consumes

  • application/json

2.79.5. Produces

  • application/json

2.79.6. Tags

  • Budget Management

2.79.7. Security

Type Name

oauth2

oauth2

2.80. Gets the list of budgets for a specified base store

GET /{baseSiteId}/users/{userId}/budgets

2.80.1. Description

Returns the list of budgets accessible to a specified user for a specified base store. The response can display the results across multiple pages, if required.

2.80.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

currentPage
optional

The current result page requested.

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

The number of results returned per page.

integer (int32)

20

Query

sort
optional

Sorting method applied to the returned results.

string

"code"

2.80.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.80.4. Produces

  • application/json

2.80.5. Tags

  • Budget Management

2.80.6. Security

Type Name

oauth2

oauth2

2.81. Gets specific budget details accessible to a specified user for a specified base store based on budget code

GET /{baseSiteId}/users/{userId}/budgets/{budgetCode}

2.81.1. Description

Returns specific budget details accessible to a specified user for a specified base store based on budget code. The response contains detailed order information.

2.81.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

Budget GUID (Globally Unique Identifier) or budget CODE.

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.81.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.81.4. Produces

  • application/json

2.81.5. Tags

  • Budget Management

2.81.6. Security

Type Name

oauth2

oauth2

2.82. Updates the budget

PATCH /{baseSiteId}/users/{userId}/budgets/{budgetCode}

2.82.1. Description

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

2.82.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

budgetCode
required

Budget GUID (Globally Unique Identifier) or budget CODE.

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

budget
required

Budget.

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

  • application/json

2.82.6. Tags

  • Budget Management

2.82.7. Security

Type Name

oauth2

oauth2

2.83. Creates or restore a cart for a user.

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

2.83.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.83.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

oldCartId
optional

Anonymous cart GUID.

string

Query

toMergeCartGuid
optional

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

string

2.83.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.83.4. Consumes

  • application/json

2.83.5. Tags

  • Carts

2.83.6. Security

Type Name

oauth2

oauth2

2.84. Get all customer carts.

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

2.84.1. Description

Lists all customer carts.

2.84.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

currentPage
optional

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

integer (int32)

0

Query

fields
optional

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

string

"DEFAULT"

Query

pageSize
optional

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

integer (int32)

20

Query

savedCartsOnly
optional

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

boolean

"false"

Query

sort
optional

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

string

2.84.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.84.4. Tags

  • Carts

2.84.5. Security

Type Name

oauth2

oauth2

2.85. Gets the current cart.

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

2.85.1. Description

Gets the current cart.

2.85.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • B2B Carts

2.85.5. Security

Type Name

oauth2

oauth2

2.86. Get a cart with a given identifier.

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

2.86.1. Description

Returns the cart with a given identifier.

2.86.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.86.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.86.4. Tags

  • Carts

2.86.5. Security

Type Name

oauth2

oauth2

2.87. Deletes a cart with a given cart id.

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

2.87.1. Description

Deletes a cart with a given cart id.

2.87.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

2.87.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.87.4. Tags

  • Carts

2.87.5. Security

Type Name

oauth2

oauth2

2.88. Creates a delivery address for the cart.

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

2.88.1. Description

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

2.88.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

address
required

Request body parameter that contains details such as the customer’s first name (firstName), the customer’s last name (lastName), the customer’s title (titleCode), the customer’s phone (phone), the country (country.isocode), the first part of the address (line1), the second part of the address (line2), the town (town), the postal code (postalCode), and the region (region.isocode).

The DTO is in XML or .json format.

2.88.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.88.4. Consumes

  • application/xml

  • application/json

2.88.5. Tags

  • Cart Addresses

2.88.6. Security

Type Name

oauth2

oauth2

2.89. Sets a delivery address for the cart.

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

2.89.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.89.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

addressId
required

Address identifier

string

2.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 Addresses

2.89.6. Security

Type Name

oauth2

oauth2

2.90. Deletes the delivery address from the cart.

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

2.90.1. Description

Deletes the delivery address from the cart.

2.90.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

2.90.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.90.4. Tags

  • Cart Addresses

2.90.5. Security

Type Name

oauth2

oauth2

2.91. Explicitly clones a cart.

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

2.91.1. Description

Explicitly clones a cart.

2.91.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

description
optional

The description that should be applied to the cloned cart.

string

Query

fields
optional

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

string

"DEFAULT"

Query

name
optional

The name that should be applied to the cloned cart.

string

2.91.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.91.4. Consumes

  • application/json

2.91.5. Tags

  • Save Cart

2.91.6. Security

Type Name

oauth2

oauth2

2.92. Handles the consolidating pickup locations.

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

2.92.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.92.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

storeName
required

The name of the store where items will be picked up

string

2.92.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.92.4. Consumes

  • application/json

2.92.5. Tags

  • Extended Carts

2.92.6. Security

Type Name

oauth2

oauth2

2.93. Get consolidated pickup options.

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

2.93.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.93.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.93.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.93.4. Tags

  • Extended Carts

2.93.5. Security

Type Name

oauth2

oauth2

2.94. Sets the cost center for the checkout cart.

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

2.94.1. Description

Sets the cost center for the checkout cart.

2.94.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

costCenterId
required

The id of the cost center.

string

Query

fields
optional

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

string

"DEFAULT"

2.94.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.94.4. Consumes

  • application/json

2.94.5. Tags

  • B2B Carts

2.94.6. Security

Type Name

oauth2

oauth2

2.95. Get the delivery mode selected for the cart.

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

2.95.1. Description

Returns the delivery mode selected for the cart.

2.95.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.95.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.95.4. Tags

  • Cart Delivery Modes

2.95.5. Security

Type Name

oauth2

oauth2

2.96. Sets the delivery mode for a cart.

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

2.96.1. Description

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

2.96.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

deliveryModeId
required

Delivery mode identifier (code)

string

2.96.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.96.4. Consumes

  • application/json

2.96.5. Tags

  • Cart Delivery Modes

2.96.6. Security

Type Name

oauth2

oauth2

2.97. Deletes the delivery mode from the cart.

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

2.97.1. Description

Deletes the delivery mode from the cart.

2.97.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

2.97.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.97.4. Tags

  • Cart Delivery Modes

2.97.5. Security

Type Name

oauth2

oauth2

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

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

2.98.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.98.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.98.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.98.4. Tags

  • Cart Delivery Modes

2.98.5. Security

Type Name

oauth2

oauth2

2.99. Assigns an email to the cart.

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

2.99.1. Description

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

2.99.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

email
required

Email of the guest user. It will be used during the checkout process.

string

2.99.3. Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.99.4. Consumes

  • application/json

2.99.5. Tags

  • Carts

2.99.6. Security

Type Name

oauth2

oauth2

2.100. Adds a product to the cart.

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

2.100.1. Description

Adds a product to the cart.

2.100.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entry
required

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

The DTO is in XML or .json format.

2.100.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.100.4. Consumes

  • application/xml

  • application/json

2.100.5. Tags

  • Cart Entries

2.100.6. Security

Type Name

oauth2

oauth2

2.101. Get cart entries.

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

2.101.1. Description

Returns cart entries.

2.101.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.101.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.101.4. Tags

  • Cart Entries

2.101.5. Security

Type Name

oauth2

oauth2

2.102. Get the details of the cart entries.

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

2.102.1. Description

Returns the details of the cart entries.

2.102.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer (int64)

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Cart Entries

2.102.5. Security

Type Name

oauth2

oauth2

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

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

2.103.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.103.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer (int64)

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entry
required

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

The DTO is in XML or .json format.

2.103.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.103.4. Consumes

  • application/xml

  • application/json

2.103.5. Tags

  • Cart Entries

2.103.6. Security

Type Name

oauth2

oauth2

2.104. Deletes cart entry.

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

2.104.1. Description

Deletes cart entry.

2.104.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer (int64)

Path

userId
required

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

string

2.104.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.104.4. Tags

  • Cart Entries

2.104.5. Security

Type Name

oauth2

oauth2

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

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

2.105.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.105.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryNumber
required

The entry number. Each entry in a cart has an entry number. Cart entries are numbered in ascending order, starting with zero (0).

integer (int64)

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entry
required

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

The DTO is in XML or .json format.

2.105.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.105.4. Consumes

  • application/xml

  • application/json

2.105.5. Tags

  • Cart Entries

2.105.6. Security

Type Name

oauth2

oauth2

2.106. Add a product to a cart entry group.

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

2.106.1. Description

Adds a product to a cart entry group.

2.106.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryGroupNumber
required

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

integer (int32)

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

entry
required

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

2.106.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.106.4. Consumes

  • application/json

2.106.5. Tags

  • Cart Entry Groups

2.106.6. Security

Type Name

oauth2

oauth2

2.107. Delete an entry group.

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

2.107.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.107.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

entryGroupNumber
required

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

integer (int32)

Path

userId
required

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

string

2.107.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.107.4. Tags

  • Cart Entry Groups

2.107.5. Security

Type Name

oauth2

oauth2

2.108. Flag a cart for deletion.

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

2.108.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.108.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.108.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.108.4. Consumes

  • application/json

2.108.5. Tags

  • Save Cart

2.108.6. Security

Type Name

oauth2

oauth2

2.109. Get information needed for create subscription

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

2.109.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.109.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

extendedMerchantCallback
optional

Define which url should be returned

boolean

"false"

Query

fields
optional

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

string

"DEFAULT"

Query

responseUrl
required

The URL that the payment provider uses to return payment information. Possible values for responseUrl include the following: “orderPage_cancelResponseURL”, “orderPage_declineResponseURL”, and “orderPage_receiptResponseURL”.

string

2.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. Tags

  • Extended Carts

2.109.5. Security

Type Name

oauth2

oauth2

2.110. Handles response from payment provider and create payment details

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

2.110.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.110.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.110.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.110.4. Consumes

  • application/json

2.110.5. Tags

  • Extended Carts

2.110.6. Security

Type Name

oauth2

oauth2

2.111. Get information about create subscription request results

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

2.111.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.111.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.111.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.111.4. Tags

  • Extended Carts

2.111.5. Security

Type Name

oauth2

oauth2

2.112. Deletes payment provider response related to cart.

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

2.112.1. Description

Deletes the payment provider response related to the specified cart.

2.112.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

2.112.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.112.4. Tags

  • Extended Carts

2.112.5. Security

Type Name

oauth2

oauth2

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

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

2.113.1. Description

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

2.113.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Body

paymentDetails
required

Request body parameter that contains details such as the name on the card (accountHolderName), the card number (cardNumber), the card type (cardType.code), the month of the expiry date (expiryMonth), the year of the expiry date (expiryYear), whether the payment details should be saved (saved), whether the payment details should be set as default (defaultPaymentInfo), and the billing address (billingAddress.firstName, billingAddress.lastName, billingAddress.titleCode, billingAddress.country.isocode, billingAddress.line1, billingAddress.line2, billingAddress.town, billingAddress.postalCode, billingAddress.region.isocode)

The DTO is in XML or .json format.

2.113.3. Responses

HTTP Code Description Schema

201

Created

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.113.4. Consumes

  • application/xml

  • application/json

2.113.5. Tags

  • Cart Payments

2.113.6. Security

Type Name

oauth2

oauth2

2.114. Sets credit card payment details for the cart.

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

2.114.1. Description

Sets credit card payment details for the cart.

2.114.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

paymentDetailsId
required

Payment details identifier.

string

2.114.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.114.4. Consumes

  • application/json

2.114.5. Tags

  • Cart Payments

2.114.6. Security

Type Name

oauth2

oauth2

2.115. Set the payment type for the checkout cart

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

2.115.1. Description

Sets the payment type for the checkout cart. If the purchaseOrderNumber is not null, the purchaseOrderNumber is also assigned to the cart.

2.115.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

paymentType
required

Payment type choice (between card and account).

string

Query

purchaseOrderNumber
optional

Purchase order number to assign to the checkout cart.

string

2.115.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.115.4. Consumes

  • application/json

2.115.5. Tags

  • B2B Carts

2.115.6. Security

Type Name

oauth2

oauth2

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

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

2.116.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.116.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

promotionId
required

Promotion identifier (code)

string

2.116.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.116.4. Consumes

  • application/json

2.116.5. Tags

  • Cart Promotions

2.116.6. Security

Type Name

oauth2

oauth2

2.117. Get information about promotions applied on cart.

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

2.117.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.117.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Cart Promotions

2.117.5. Security

Type Name

oauth2

oauth2

2.118. Get information about promotion applied on cart.

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

2.118.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.118.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Cart Promotions

2.118.5. Security

Type Name

oauth2

oauth2

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

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

2.119.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.119.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

promotionId
required

Promotion identifier (code)

string

Path

userId
required

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

string

2.119.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.119.4. Tags

  • Cart Promotions

2.119.5. Security

Type Name

oauth2

oauth2

2.120. Restore a saved cart.

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

2.120.1. Description

Restore a saved cart.

2.120.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.120.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.120.4. Consumes

  • application/json

2.120.5. Tags

  • Save Cart

2.120.6. Security

Type Name

oauth2

oauth2

2.121. Explicitly saves a cart.

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

2.121.1. Description

Explicitly saves a cart.

2.121.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

Query

saveCartDescription
optional

The description that should be applied to the saved cart.

string

Query

saveCartName
optional

The name that should be applied to the saved cart.

string

2.121.3. Responses

HTTP Code Description Schema

200

OK

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.121.4. Consumes

  • application/json

2.121.5. Tags

  • Save Cart

2.121.6. Security

Type Name

oauth2

oauth2

2.122. Get a saved cart.

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

2.122.1. Description

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

2.122.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

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

  • Save Cart

2.122.5. Security

Type Name

oauth2

oauth2

2.123. Validates the cart

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

2.123.1. Description

Runs a cart validation and returns the result.

2.123.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.123.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.123.4. Consumes

  • application/json

2.123.5. Tags

  • Carts

2.123.6. Security

Type Name

oauth2

oauth2

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

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

2.124.1. Description

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

2.124.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

voucherId
required

Voucher identifier (code)

string

2.124.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.124.4. Consumes

  • application/json

2.124.5. Tags

  • Cart Promotions

2.124.6. Security

Type Name

oauth2

oauth2

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

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

2.125.1. Description

Returns a list of vouchers applied to the cart.

2.125.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.125.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.125.4. Tags

  • Cart Promotions

2.125.5. Security

Type Name

oauth2

oauth2

2.126. Deletes a voucher defined for the current cart.

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

2.126.1. Description

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

2.126.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

cartId
required

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

string

Path

userId
required

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

string

Path

voucherId
required

Voucher identifier (code)

string

2.126.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.126.4. Tags

  • Cart Promotions

2.126.5. Security

Type Name

oauth2

oauth2

2.127. A user can give consent.

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

2.127.1. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

consentTemplateId
required

Consent template ID.

string

Query

consentTemplateVersion
required

Consent template version.

integer (int32)

2.127.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.127.3. Consumes

  • application/json

2.127.4. Tags

  • Consents

2.127.5. Security

Type Name

oauth2

oauth2

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

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

2.128.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.128.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

consentCode
required

Consent code.

string

Path

userId
required

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

string

2.128.3. Responses

HTTP Code Description Schema

200

OK

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

2.128.4. Tags

  • Consents

2.128.5. Security

Type Name

oauth2

oauth2

2.129. Fetch the list of consents

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

2.129.1. Description

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

2.129.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.129.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.129.4. Tags

  • Consents

2.129.5. Security

Type Name

oauth2

oauth2

2.130. Fetch the consent.

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

2.130.1. Description

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

2.130.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

consentTemplateId
required

Consent template id.

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.130.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.130.4. Tags

  • Consents

2.130.5. Security

Type Name

oauth2

oauth2

2.131. Get all customer groups of a customer.

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

2.131.1. Description

Returns all customer groups of a customer.

2.131.2. Parameters

Type Name Description Schema Default

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

fields
optional

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

string

"DEFAULT"

2.131.3. Responses

HTTP Code Description Schema

200

OK

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

2.131.4. Tags

  • Users

2.131.5. Security

Type Name

oauth2

oauth2

2.132. Changes customer’s login name.

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

2.132.1. Description

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

2.132.2. Parameters

Type Name Description Schema

Path

baseSiteId
required

Base site identifier

string

Path

userId
required

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

string

Query

newLogin
required

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

string

Query

password
required

Customer’s current password.

string

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