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

Get a campaign

Get a campaign

Rate Limit: 1000 Max attempts within 1 minute.

Path Parameters

ParameterDetails
shopKey
  • required
string
Example:
ms
campaignId
  • required
integer

Query Parameters

ParameterDetails
with
Array of strings
string
Enum:
customData

Responses

200
Campaign
application/json
Success
id
integer
Example:
1
namerequired
string
Example:
My Campaign
description
string
Example:
My first campaign.
countryCodesrequired
Array of string
reduction
number
Example:
10.45
startAtrequired
string
Example:
2021-01-23T11%3A30%3A58%2B00%3A00
endAtrequired
string
Example:
2021-09-23T11%3A30%3A58%2B00%3A00
campaignKey
string
Example:
05f962c8-857b-462a-bea2-54e2bfecf729
null
401
Unauthorized
application/json
Error
404
Not Found
application/json
Error
GET/shops/{shopKey}/campaigns/{campaignId}

Request samples

Response samples

200
Complete Product:
Content type: application/json

Last updated: June 19, 2024

Provide Feedback