Skip to main content
API docs by Redocly

Deprecated promotions Configuration API (1.0.0)

Download OpenAPI specification:Download

License: Open API Specification - OAS

Use this to manage configurations related to promotions in the NewStore platform.

Important: This API is now deprecated and will not be available anymore from August 15th, 2023 onwards.

To manage global exclusion list configuration with new API, check this link.

Promotions configuration

Configuration to set up promotions for use by retailers and SI partners with NewStore.

Get promotion configuration Deprecated

Returns the full configuration object for your business, with the following metadata: Current version and when and by whom the configuration was updated last time.

Authorizations:
newStoreAccessToken
header Parameters
request_id
string
tenant
required
string
user-id
string

Responses

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}

Update promotion configuration Deprecated

Updates current configuration with specified JSON value, returns full configuration object for current tenant.

Important: when setting up products to be excluded from promotions, note that you can only exclude a maximum of 50 products.

Authorizations:
newStoreAccessToken
query Parameters
version
string
header Parameters
request_id
string
tenant
required
string
user-id
string
Request Body schema: application/json

The updated config value

not_discountable_products
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}

Replace promotion configuration Deprecated

Replaces the current configuration with the specified JSON value, and returns the full configuration object for your business.

Important: when setting up products to be excluded from promotions, note that you can only exclude a maximum of 50 products.

Authorizations:
newStoreAccessToken
query Parameters
version
string
header Parameters
request_id
string
tenant
required
string
user-id
string
Request Body schema: application/json

The updated config value

not_discountable_products
Array of strings

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "value": {
    },
  • "version": "string",
  • "updated_at": "2021-12-31T23:59:59Z",
  • "updated_by": "string"
}