/v23.1/Promotions
  • 05 Jun 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

/v23.1/Promotions

  • Dark
    Light
  • PDF

Article summary

Get
/v23.1/Promotions
Security
HTTP
Type Bearer

Please enter a valid token

Query parameters
CountryId
integer (int32)
CountryIdOrUnassigned
integer (int32)
StoreTypeId
integer (int32)
StoreTypeIdOrUnassigned
integer (int32)
PromotionProfileId
integer (int32)
PromotionProfileIdOrUnassigned
integer (int32)
Code
string
ExternalCode
string
Description
string
DateFrom
string (date-time)
DateTo
string (date-time)
IsIgnoredPromotionsOnly
string
Valid values[ "All", "Yes", "No" ]
IsActiveOnly
string
Valid values[ "All", "Yes", "No" ]
IsActiveAndFutureOnly
string
Valid values[ "All", "Yes", "No" ]
ItemId
integer (int32)
IncludeItemId
integer (int32)
ExcludeItemId
integer (int32)
ModifiedSinceDateTime
string (date-time)
Responses
200

Success

Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
countryId
integer (int32)
storeTypeId
integer (int32)
promotionProfileId
integer (int32)
code
string
externalCode
string
description
string
dateFrom
string (date-time)
dateTo
string (date-time)
isIgnorePromotion
boolean
Default"False"
isLocked
boolean
Default"False"
isDerived
boolean
Default"False"
storeTypeDescription
string
countryDescription
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
countryId
integer (int32)
storeTypeId
integer (int32)
promotionProfileId
integer (int32)
code
string
externalCode
string
description
string
dateFrom
string (date-time)
dateTo
string (date-time)
isIgnorePromotion
boolean
Default"False"
isLocked
boolean
Default"False"
isDerived
boolean
Default"False"
storeTypeDescription
string
countryDescription
string
Array of object
object
itemId
integer (int32)
createdByUserId
integer (int32)
createdDateTime
string (date-time)
lastModifiedByUserId
integer (int32)
lastModifiedDateTime
string (date-time)
organizationId
integer (int32)
companyId
integer (int32)
countryId
integer (int32)
storeTypeId
integer (int32)
promotionProfileId
integer (int32)
code
string
externalCode
string
description
string
dateFrom
string (date-time)
dateTo
string (date-time)
isIgnorePromotion
boolean
Default"False"
isLocked
boolean
Default"False"
isDerived
boolean
Default"False"
storeTypeDescription
string
countryDescription
string
401

Unauthorized

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
403

Forbidden

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
404

Not Found

object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string
object
type
string
message
string
stackTrace
string

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.