Deals

Server

Deals and deal templates.

List deals

GET

https://api.cineamo.com

/deals

Returns a list of Deal objects.

List deals › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

cinemaId

integer

cinemas

string

cinemaIds

string

cinemaChainIds

integer[]

favoriteUserId

integer

category

string

activeDatetime

string

longitude

number

latitude

number

distance

number

(in meters)

List deals › Responses

200

A list of Deal objects

Deal[]

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

GET/deals

curl https://api.cineamo.com/deals

Example Responses

[
  {
    "id": 1,
    "title": "Some Deal",
    "description": "Some deal description",
    "category": "category",
    "createdDatetime": "2022-04-11T04:11:22Z",
    "startDatetime": "2022-04-11T04:11:22Z",
    "endDatetime": "2022-04-11T04:11:22Z",
    "slug": "some-deal-name",
    "imageUrl": "imageUrl",
    "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
    "isNotificationEnabled": "true",
    "isScheduledNotificationEnabled": "true",
    "showDatetime": "2022-04-11T04:11:22Z",
    "cinema": {
      "id": 1,
      "name": "some cinema name",
      "shortName": "short name",
      "slug": "some-cinema-name",
      "description": "description",
      "phone": "012345678910",
      "street": "Some Street",
      "postalCode": "12345",
      "city": "Sim City",
      "state": "Some State",
      "stateAbbr": "SS",
      "country": "Germany",
      "countryCode": "DE",
      "currencyCode": "EUR",
      "longitude": "10.070198",
      "latitude": "49.778145",
      "distance": 0,
      "profileImageRef": "00000000-0000-0000-0000-000000000000",
      "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
      "logoImageRef": "00000000-0000-0000-0000-000000000000",
      "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
      "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
      "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
      "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
      "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
      "primaryColor": "primaryColor",
      "instagramLink": "instagramLink",
      "facebookLink": "facebookLink",
      "ticketSystemId": "ticketSystemId",
      "ticketSystem": "ticketSystem",
      "email": "some@email.com",
      "isActive": "true",
      "cinemaConfigurationId": 1,
      "cinemaConfiguration": {
        "id": 1,
        "minimalInitialEventVisitor": 0,
        "requestTimeoutAnswer": 0,
        "isCatering": "true",
        "ticketSystem": "ticketSystem",
        "ticketSystemId": "ticketSystemId",
        "ticketUrlTemplate": "ticketUrlTemplate",
        "facebookAccessToken": "facebookAccessToken",
        "hasMarketingAssistantBooked": "true",
        "visitorThreshold1": 0,
        "visitorThreshold2": 0,
        "isPublicRequestAvailable": "true",
        "isProgramSuggestionEnabled": "true",
        "isPrivateBookingEnabled": "true",
        "isActive": "true",
        "isPrivateBookingPartner": "true",
        "isOnlineTicketingAvailable": "true",
        "isOnlineTicketingEnabled": "true",
        "onlineTicketing": "{}",
        "isKOSCustomer": "true",
        "isInterestSystemActivated": "true",
        "isGiftCardRedemptionEnabled": "false",
        "isWebsiteCustomer": "true",
        "websiteConfiguration": "{}",
        "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
        "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
        "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
        "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
        "domain": "domain",
        "pulseTenantId": "pulseTenantId"
      },
      "showtimesUpdated": "showtimesUpdated",
      "isFavorite": "true",
      "hasMarketingAssistantBooked": "true",
      "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
      "metricCustomersCount": 1,
      "metricCompareCustomersCount": 1,
      "metricCustomersTotalCount": 1,
      "cinemaChainId": 1,
      "cinemaCompanyId": 1,
      "cityId": 1,
      "openingHoursCustomText": {
        "deu": "German translation",
        "gsw": "Swiss German translation"
      }
    },
    "qrCode": {
      "id": 1,
      "imageUrl": "imageUrl",
      "imageRef": "00000000-0000-0000-0000-000000000000"
    },
    "count": 30,
    "maxProduct": 30,
    "price": "5.99",
    "regularPrice": "5.99",
    "total": "3.99",
    "finalPrice": "3.99",
    "products": [
      0
    ]
  }
]

json

application/json

Create a deal

POST

https://api.cineamo.com

/deals

Creates a Deal. It returns the Deal object.

Create a deal › Request Body

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

Create a deal › Responses

Deal was created

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

POST/deals

curl https://api.cineamo.com/deals \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}'

Example Request Body

{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}

json

Example Responses

{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}

json

application/json

Get a deal

GET

https://api.cineamo.com

/deals/{dealId}

Returns a Deal object by its ID.

Get a deal › path Parameters

dealId

integer · required

Get a deal › Responses

Deal details

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

GET/deals/{dealId}

curl https://api.cineamo.com/deals/:dealId

Example Responses

{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}

json

application/json

Delete a deal

DELETE

https://api.cineamo.com

/deals/{dealId}

Deletes a Deal. It returns an empty response.

Delete a deal › path Parameters

dealId

integer · required

Delete a deal › Responses

Deal was deleted

No data returned

Update a deal

PATCH

https://api.cineamo.com

/deals/{dealId}

Updates a Deal. It returns the updated Deal object.

Update a deal › path Parameters

dealId

integer · required

Update a deal › Request Body

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

Update a deal › Responses

200

Deal was updated

Deal

id

integer | null · readOnly

title

string | null · readOnly

description

string | null · readOnly

category

string | null · readOnly

createdDatetime

string | null · readOnly

startDatetime

string | null · readOnly

endDatetime

string | null · readOnly

slug

string | null · readOnly

imageUrl

string | null · readOnly

lastNotificationSendDatetime

string | null · readOnly

isNotificationEnabled

boolean · readOnly

isScheduledNotificationEnabled

boolean · readOnly

showDatetime

string | null · readOnly

readOnly

count

integer | null · readOnly

maxProduct

integer | null · readOnly

regularPrice

integer | null · readOnly

finalPrice

integer | null · readOnly

products

array | null · readOnly

PATCH/deals/{dealId}

curl https://api.cineamo.com/deals/:dealId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}'

Example Request Body

{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}

json

Example Responses

{
  "id": 1,
  "title": "Some Deal",
  "description": "Some deal description",
  "category": "category",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "startDatetime": "2022-04-11T04:11:22Z",
  "endDatetime": "2022-04-11T04:11:22Z",
  "slug": "some-deal-name",
  "imageUrl": "imageUrl",
  "lastNotificationSendDatetime": "2022-04-11T04:11:22Z",
  "isNotificationEnabled": "true",
  "isScheduledNotificationEnabled": "true",
  "showDatetime": "2022-04-11T04:11:22Z",
  "cinema": {
    "id": 1,
    "name": "some cinema name",
    "shortName": "short name",
    "slug": "some-cinema-name",
    "description": "description",
    "phone": "012345678910",
    "street": "Some Street",
    "postalCode": "12345",
    "city": "Sim City",
    "state": "Some State",
    "stateAbbr": "SS",
    "country": "Germany",
    "countryCode": "DE",
    "currencyCode": "EUR",
    "longitude": "10.070198",
    "latitude": "49.778145",
    "distance": 0,
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-profile",
    "logoImageRef": "00000000-0000-0000-0000-000000000000",
    "logoImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-logo",
    "logoWideImageRef": "00000000-0000-0000-0000-000000000000",
    "logoWideImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-wide-logo",
    "priceTablePdfRef": "00000000-0000-0000-0000-000000000000",
    "priceTablePdfUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/cinema-price-table",
    "primaryColor": "primaryColor",
    "instagramLink": "instagramLink",
    "facebookLink": "facebookLink",
    "ticketSystemId": "ticketSystemId",
    "ticketSystem": "ticketSystem",
    "email": "some@email.com",
    "isActive": "true",
    "cinemaConfigurationId": 1,
    "cinemaConfiguration": {
      "id": 1,
      "minimalInitialEventVisitor": 0,
      "requestTimeoutAnswer": 0,
      "isCatering": "true",
      "ticketSystem": "ticketSystem",
      "ticketSystemId": "ticketSystemId",
      "ticketUrlTemplate": "ticketUrlTemplate",
      "facebookAccessToken": "facebookAccessToken",
      "hasMarketingAssistantBooked": "true",
      "visitorThreshold1": 0,
      "visitorThreshold2": 0,
      "isPublicRequestAvailable": "true",
      "isProgramSuggestionEnabled": "true",
      "isPrivateBookingEnabled": "true",
      "isActive": "true",
      "isPrivateBookingPartner": "true",
      "isOnlineTicketingAvailable": "true",
      "isOnlineTicketingEnabled": "true",
      "onlineTicketing": "{}",
      "isKOSCustomer": "true",
      "isInterestSystemActivated": "true",
      "isGiftCardRedemptionEnabled": "false",
      "isWebsiteCustomer": "true",
      "websiteConfiguration": "{}",
      "ticketUrlTemplateIosAppendix": "ticketUrlTemplateIosAppendix",
      "ticketUrlTemplateAndroidAppendix": "ticketUrlTemplateAndroidAppendix",
      "ticketUrlTemplateWebAppendix": "ticketUrlTemplateWebAppendix",
      "ticketUrlTemplateCinemaWebsiteAppendix": "ticketUrlTemplateCinemaWebsiteAppendix",
      "domain": "domain",
      "pulseTenantId": "pulseTenantId"
    },
    "showtimesUpdated": "showtimesUpdated",
    "isFavorite": "true",
    "hasMarketingAssistantBooked": "true",
    "cineamoTrailerConfirmedDatetime": "2022-04-11T04:11:22Z",
    "metricCustomersCount": 1,
    "metricCompareCustomersCount": 1,
    "metricCustomersTotalCount": 1,
    "cinemaChainId": 1,
    "cinemaCompanyId": 1,
    "cityId": 1,
    "openingHoursCustomText": {
      "deu": "German translation",
      "gsw": "Swiss German translation"
    }
  },
  "qrCode": {
    "id": 1,
    "imageUrl": "imageUrl",
    "imageRef": "00000000-0000-0000-0000-000000000000"
  },
  "count": 30,
  "maxProduct": 30,
  "price": "5.99",
  "regularPrice": "5.99",
  "total": "3.99",
  "finalPrice": "3.99",
  "products": [
    0
  ]
}

json

application/json

List deal templates

GET

https://api.cineamo.com

/deal-templates

Returns a list of deal templates objects.

List deal templates › Responses

200

DealTemplate list

No data returned

Create a deal template

POST

https://api.cineamo.com

/deal-templates

Creates a deal template. Returns the created deal template.

Create a deal template › Request Body

DealTemplate

id

integer | null

title

string | null

Create a deal template › Responses

Deal template was created

DealTemplate

id

integer | null

title

string | null

Get a deal template

GET

https://api.cineamo.com

/deal-templates/{dealTemplateId}

Returns the requested deal template.

Get a deal template › path Parameters

dealTemplateId

string · required

Get a deal template › Responses

DealTemplate details

No data returned

Delete a deal template

DELETE

https://api.cineamo.com

/deal-templates/{dealTemplateId}

Deletes a deal template. Returns an empty response.

Delete a deal template › path Parameters

dealTemplateId

string · required

Delete a deal template › Responses

DealTemplate was deleted

No data returned

Update a deal template

PATCH

https://api.cineamo.com

/deal-templates/{dealTemplateId}

Updates a deal template. Returns the updated deal template.

Update a deal template › path Parameters

dealTemplateId

string · required

Update a deal template › Request Body

DealTemplate

id

integer | null

title

string | null

Update a deal template › Responses

DealTemplate was updated

DealTemplate

id

integer | null

title

string | null

Advertising Distributors