Search Coupons
1 min
POST
https://api.upstartcommerce.com/v1/promotion/coupon/search
Header Parameters
- x-upstart-tenantstringrequiredDescription
Body Parameters
- bodySearchCouponsrequiredDescription
- pageintegerrequired
- pageSizeintegerrequired
- couponIdLikestringDescription
- promotionIdsstring[]Description
Responses
200
- object
- dataCouponPaginatedResponse[]
- itemsCoupon[]requiredDescription
- idstringrequiredDescription
- promotionIdstringrequiredDescription
- couponUsagesCouponUsage[]requiredDescription
- siteIdsstring[]requiredDescription
- maxUserUsageinteger
- maxUsageinteger
- pageintegerrequired
- pageSizeintegerrequired
- countintegerrequired
400
- ValidationErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstring
401
- ErrorResponseDescription
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring
curl
curl --request POST \
--url https://api.upstartcommerce.com/v1/promotion/coupon/search \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-upstart-tenant: string' \
--data '{
"page": "",
"pageSize": ""
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");
var raw = JSON.stringify({
"page": "",
"pageSize": ""
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.upstartcommerce.com/v1/promotion/coupon/search", 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/coupon/search")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
"page": "",
"pageSize": ""
})
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.upstartcommerce.com/v1/promotion/coupon/search"
payload = json.dumps({
"page": "",
"pageSize": ""
})
headers = {
'accept': 'application/json',
'content-type': 'application/json',
'x-upstart-tenant': 'string'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
// Success-list of coupons returned.
{
"data": [
{
"items": [
{
"id": "",
"promotionId": "",
"couponUsages": [
{
"siteIds": [
""
],
"maxUserUsage": 0,
"maxUsage": 0
}
]
}
],
"page": 0,
"pageSize": 0,
"count": 0
}
]
}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": ""
}