Skip to main content

Promotions Configuration (1.0)

Download OpenAPI specification:Download

Use this API to manage promotions configurations in NewStore, such as retrieving, updating or deleting the global exclusion lists.

GET Global Exclusion List

Use this method to retrieve global exclusion list.

header Parameters
tenant
required
string
Example: test-tenant

The test tenant name.

user-id
required
string
Example: test-userid

The test user ID.

Responses

Response samples

Content type
application/json
{
  • "tenant": "dodici",
  • "ids": [
    ],
  • "createdAt": "2023-05-16T09:52:27.824Z",
  • "createdBy": "25dd570161b05f0cae353a56757f8495",
  • "updatedAt": "2023-05-19T17:42:49.309Z",
  • "updatedBy": "25dd570161b05f0cae353a56757f8495"
}

Update Global Exclusion List

Use this method to update global exclusion list.

header Parameters
tenant
required
string
Example: test-tenant

The test tenant name.

user-id
required
string
Example: test-userid

The test user ID.

Request Body schema: application/json
ids
Array of strings

A list of global excluded products.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "tenant": "dodici",
  • "ids": [
    ],
  • "createdAt": "2023-05-16T09:52:27.824Z",
  • "createdBy": "25dd570161b05f0cae353a56757f8495",
  • "updatedAt": "2023-05-19T17:42:49.309Z",
  • "updatedBy": "25dd570161b05f0cae353a56757f8495"
}

Delete Global Exclusion List

Use this method to delete global exclusion list.

header Parameters
tenant
required
string
Example: test-tenant

The test tenant name.

user-id
required
string
Example: test-userid

The test user ID.

Responses