Post
/api/v{version}/offers
Security
OAuth
Authorization using OAuth2 with Client Credentials
FlowClient Credentials
Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize
Token URLhttps://identity.eu01.grassfish.com/connect/token
Header parameters
x-correlationToken
string
x-clientId
string
Min length0
Max length128
x-onBehalfOf
string
Min length0
Max length24
api-version
string
Path parameters
version
stringRequired
Body parameters
Array of object
object
offer
object (Contracts.Common.Jsons.Refs.OfferRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
id
string | null
Min length0
Max length128
name
string | null
attributes
Array of object (Contracts.Connect.Parameters.Facts.OfferAttribute) | null
object
attribute
object (Contracts.Common.Jsons.Refs.AttributeRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[
"None",
"Item",
"POSItem",
"ClientLocationPlayer",
"Offer",
"Assortment",
"Record",
"AssortmentItem",
"TreeSchemaLevel"
]
valueType
string
Valid values[
"String",
"Currency",
"Day",
"DateTime",
"Int",
"Float",
"Media",
"DatePeriod",
"Record",
"Bool",
"Slider"
]
attributeFlags
string
Valid values[
"None",
"Mandatory",
"Default",
"Share",
"ValidityPeriod",
"Options",
"Fixed",
"Multi",
"ShowAsListColumn"
]
id
string | null
code
string | null
name
string | null
value
string | null
values
Array of object (Contracts.Connect.Parameters.Facts.OfferAttributeValue) | null
object
value
string | null
doubleValue
number (double) | null
formFieldName
string | null
tag
object (Contracts.Common.Jsons.Refs.TagRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
type
string
Valid values[
"None",
"Profile",
"Zone",
"Whatever",
"MediaFormat",
"Permission",
"Application",
"Cluster",
"ContentType",
"Item",
"POSItem",
"Assortment",
"Record",
"Location",
"Region",
"Offer",
"Customer",
"PlayerFeature",
"AI",
"Media",
"Player",
"LocationRef"
]
media
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
items
Array of object (Contracts.Common.Jsons.Refs.ItemRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
locations
Array of object (Contracts.Common.Jsons.Refs.LocationRefJson) | null
object
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
signTemplateMedia
object (Contracts.Common.Jsons.Refs.MediaRefJson)
Code
string | null
Min length0
Max length24
Id
string | null
Min length0
Max length128
Name
string | null
Min length0
Max length50
library
string
Valid values[
"None",
"BookingMedia",
"Logos",
"OfferMedia",
"ItemImages",
"HtmlTemplates",
"HousingAds",
"BookingCommentFiles",
"Maps",
"PlayerScreenShots",
"ADinQ",
"Facebook",
"PlayoutEntities",
"Instagram",
"WebPages",
"Unsplash",
"Documents",
"FallbackMedia",
"OfferSigns",
"HtmlTemplateSystemFiles",
"ImportDocuments"
]
validFromDate
string (date-time) | null
validToDate
string (date-time) | null
durationSecs
number (double) | null
zones
Array of string | null
string
contentTypes
Array of string | null
string
profiles
Array of string | null
string
clusters
Array of string | null
string
regions
Array of string | null
string
externalCampaignId
string | null
Responses
200
OK
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
boolean
message
string | null
unauthorizedAccess
boolean | null
notFound
boolean | null
correlationToken
string | null
errors
Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null
object
message
string | null
id
string
Valid values[
"InvalidDatePeriodEndDateBeforeStartDate",
"NameAlreadyTaken",
"ExternalIdAlreadyTaken",
"CodeAlreadyTaken"
]
fieldName
string | null
isRequired
boolean | null
isOutOfRange
boolean | null
isTaken
boolean | null
errorCode
string | null
defaultDisplayMessage
string | null
errorCode
string | null
details
object (Contracts.Common.Jsons.Common.ErrorDetailsJson)
message
string | null
defaultDisplayMessage
string | null
offers
Array of object (Contracts.Connect.Results.Facts.ModifyOffersResultMedia) | null
object
code
string | null
Min length0
Max length24
id
string | null
Min length0
Max length128
mediaCode
string | null
Min length0
Max length24
400
Bad Request
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
401
Unauthorized
403
Forbidden
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500
Internal Server Error