docs
  1. Storefront Api
  2. Resources
  3. Campaigns
  4. Get A Campaign

Get a campaign

Get a campaign

Path Parameters

ParameterDetails
id
  • required
integer

Query Parameters

ParameterDetails
shopId
integer

Header Parameters

ParameterDetails
X-Shop-Id
integer

Responses

200
Operation successful
application/json
Success
idrequired
integer
keyrequired
string
namerequired
string
descriptionrequired
string
reductionrequired
integer
start_at
string
Example:
2023-01-26T09:30:15+00:00
end_at
string
Example:
2023-01-26T09:30:15+00:00
startsAtrequired
string
Example:
2023-01-26T09:30:15+00:00
endsAtrequired
string
Example:
2023-01-26T09:30:15+00:00
customDatarequired
object
400
Required parameter is missing or invalid.
application/json
Error
401
Authentication credentials are missing or invalid.
application/json
Error
404
Resource was not found.
application/json
Error
429
Rate limit was exceeded.
application/json
Error
GET/v1/campaigns/{id}

Request samples

Response samples

200
default:
Content type: application/json

Last updated: April 02, 2025

Provide Feedback