1. Overview

These services support CDS merchandising functionality.

1.1. Version information

Version : 1.0.0

1.2. License information

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

1.3. URI scheme

Host : localhost:9001
BasePath : /merchandisingcmswebservices

1.4. Tags

  • Strategies : Operations for strategies configured in CDS

1.5. Produces

  • application/json

2. Paths

2.1. List available strategies.

GET /v1/{siteId}/strategies

2.1.1. Description

Retrieves a list of configured strategy objects from CDS Strategy Service.

2.1.2. Parameters

Type Name Description Schema Default

Path

siteId
required

Base site identifier

string

Query

currentPage
optional

Current page number

integer (int32)

0

Query

pageSize
optional

Page size

integer (int32)

10

2.1.3. Responses

HTTP Code Description Schema

200

OK

< string, < Strategy > array > map

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this method

No Content

2.1.4. Produces

  • application/json

2.1.5. Tags

  • Strategies

2.1.6. Security

Type Name Scopes

oauth2

oauth2_client_credentials

basic

oauth2

oauth2_password

basic

2.2. Get Strategy details.

GET /v1/{siteId}/strategies/{id}

2.2.1. Description

Retrieves information about strategy from CDS Strategy Service.

2.2.2. Parameters

Type Name Description Schema

Path

id
required

Strategy identifier

string

Path

siteId
required

Base site identifier

string

2.2.3. Responses

HTTP Code Description Schema

200

OK

Strategy

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden. Have no access to this method

No Content

404

Strategy with given id doesn’t exist

No Content

2.2.4. Produces

  • application/json

2.2.5. Tags

  • Strategies

2.2.6. Security

Type Name Scopes

oauth2

oauth2_client_credentials

basic

oauth2

oauth2_password

basic

3. Definitions

3.1. Strategy

Strategy

Name Description Schema

id
optional

Strategy identifier

string

label
optional

Strategy label

string

4. Security

4.1. oauth2_client_credentials

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

Name

basic

4.2. oauth2_password

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

Name

basic