Skip to main content
API docs by Redocly

Promotions configuration API (1.0.0)

Download OpenAPI specification:Download

E-mail: team-checkout@newstore.com

Use this API to manage configurations related to promotions set up for your business in the NewStore platform.

Currently, you can use this API to configure a list of products that will be excluded from promotions globally across your business. For more information, see the configuration guide.

Promotions configuration

Get promotions configuration

Retrieves the current configuration for promotions set up for your business.

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 promotions configuration

Updates the current configuration for promotions set up for your business.

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 promotions configuration

Replaces or creates a new configuration for promotions set up for your business.

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"
}