Get Active Promotions

1 min

GET

https://api.upstartcommerce.com/v1/promotion/list/active

This endpoint returns all active promotions by tenant.

Authorized permissions:

promotion.read

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Responses

200

Success-promotion/s returned.

Promotion[]
Description
A promotion, with its rule data, executor, priority and whether it is currently active or archived.
- dataPromotionDatarequired
  Description
  The presentation details of a promotion: its name, description, customer-facing message and media.
  - descriptionstring
  - mediamap<string, MediaValue>
  - messagestringrequired
  - namestringrequired
- executorExecutorrequired
  Description
  This class describes the type of promotion.
  - templateIdstringrequired
    Description
    Unique identifier for a template (e.g. by x get 1 free).
  - configurationobjectrequired
    Description
    The configuration values for the template (e.g. by one get one free, get 10% off).
- idstring
  Description
  Unique identifier for a promotion.
- isActivebooleanrequired
  Default
  false
- isArchivedbooleanrequired
  Default
  false
- priorityintegerrequired
- siteIdsstring[]required
- startDatestring<date-time>required
  Format
  date-time
- stopDatestring<date-time>required
  Format
  date-time
- taxCodestring
  Description
  Tax code used in cart tax calculations.
- excludedPromotionIdsstring[]required
  Description
  Ids of promotions this promotion must never be applied together with. Exclusion is mutual: listing B on A also prevents A from applying once B has applied, and whichever applies first wins. Coupon-gated promotions are evaluated as a batch before automatic ones, so a coupon-gated promotion always beats an automatic one it excludes, whatever their priorities. Within a batch, order is the promotion's category then its priority, with id as a tie-break - so priority decides an excluded pair only when both promotions are coupon-gated or both are automatic.

400The request contained information that the server was unable to process. Appropriate errors are provided in the response body.

ValidationErrorResponse
Description
Error payload returned when a request fails validation, identifying the offending input by name, code and detail.
- namestringrequired
- codestringrequired
- detailstring

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request GET \
     --url https://api.upstartcommerce.com/v1/promotion/list/active \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/promotion/list/active", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/promotion/list/active")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/promotion/list/active"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Success-promotion/s returned.
[
  {
    "data": {
      "description": "",
      "media": "",
      "message": "",
      "name": ""
    },
    "executor": {
      "templateId": "",
      "configuration": {}
    },
    "id": "",
    "isActive": false,
    "isArchived": false,
    "priority": 0,
    "siteIds": [
      ""
    ],
    "startDate": "",
    "stopDate": "",
    "taxCode": "",
    "excludedPromotionIds": [
      ""
    ]
  }
]

400

// The request contained information that the server was unable to process. Appropriate errors are provided in the response body.
{
  "name": "",
  "code": "",
  "detail": ""
}

401

// The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}