Orders

id

integer · readOnly

cinemaId

integer | null · readOnly

userId

integer | null · readOnly

email

string | null · readOnly

priceNet

integer | null · readOnly

priceTotal

integer | null · readOnly

state

string | null · readOnly

createdDatetime

string | null · readOnly

invoiceId

integer | null · readOnly

invoiceRef

string | null · readOnly

cartUuid

string | null · readOnly

array | null · readOnly

Full price breakdown with all adjustments

client

string | null · readOnly

Get an order

GET

https://api.cineamo.com

/orders/{orderId}

Returns a Order object by its Id.

Get an order › path Parameters

orderId

integer · required

Get an order › Responses

Order details

id

integer · readOnly

cinemaId

integer | null · readOnly

userId

integer | null · readOnly

email

string | null · readOnly

priceNet

integer | null · readOnly

priceTotal

integer | null · readOnly

state

string | null · readOnly

createdDatetime

string | null · readOnly

invoiceId

integer | null · readOnly

invoiceRef

string | null · readOnly

cartUuid

string | null · readOnly

array | null · readOnly

Full price breakdown with all adjustments

client

string | null · readOnly

Update an order

PATCH

https://api.cineamo.com

/orders/{orderId}

Updates a Order. It returns the updated Order object.

Update an order › path Parameters

orderId

integer · required

Update an order › Request Body

id

integer · readOnly

cinemaId

integer | null · readOnly

userId

integer | null · readOnly

email

string | null · readOnly

priceNet

integer | null · readOnly

priceTotal

integer | null · readOnly

state

string | null · readOnly

createdDatetime

string | null · readOnly

invoiceId

integer | null · readOnly

invoiceRef

string | null · readOnly

cartUuid

string | null · readOnly

array | null · readOnly

Full price breakdown with all adjustments

client

string | null · readOnly

Update an order › Responses

Order was updated

id

integer · readOnly

cinemaId

integer | null · readOnly

userId

integer | null · readOnly

email

string | null · readOnly

priceNet

integer | null · readOnly

priceTotal

integer | null · readOnly

state

string | null · readOnly

createdDatetime

string | null · readOnly

invoiceId

integer | null · readOnly

invoiceRef

string | null · readOnly

cartUuid

string | null · readOnly

array | null · readOnly

Full price breakdown with all adjustments

client

string | null · readOnly

PATCH/orders/{orderId}

curl https://api.cineamo.com/orders/:orderId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaId": 1,
  "userId": 1,
  "email": "some-email@cineamo.test",
  "priceNet": 1,
  "priceTotal": 1,
  "state": "pending",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "invoiceId": 1,
  "invoiceRef": "pi_1A2bC3DeF4ghIJkL5mno6PqR",
  "cartUuid": "00000000-0000-0000-0000-000000000000",
  "priceBreakdown": [
    {
      "type": "tax",
      "label": "VAT 19%",
      "amount": 380
    }
  ],
  "client": "web"
}'

Example Request Body

{
  "id": 1,
  "cinemaId": 1,
  "userId": 1,
  "email": "some-email@cineamo.test",
  "priceNet": 1,
  "priceTotal": 1,
  "state": "pending",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "invoiceId": 1,
  "invoiceRef": "pi_1A2bC3DeF4ghIJkL5mno6PqR",
  "cartUuid": "00000000-0000-0000-0000-000000000000",
  "priceBreakdown": [
    {
      "type": "tax",
      "label": "VAT 19%",
      "amount": 380
    }
  ],
  "client": "web"
}

json

Example Responses

{
  "id": 1,
  "cinemaId": 1,
  "userId": 1,
  "email": "some-email@cineamo.test",
  "priceNet": 1,
  "priceTotal": 1,
  "state": "pending",
  "createdDatetime": "2022-04-11T04:11:22Z",
  "invoiceId": 1,
  "invoiceRef": "pi_1A2bC3DeF4ghIJkL5mno6PqR",
  "cartUuid": "00000000-0000-0000-0000-000000000000",
  "priceBreakdown": [
    {
      "type": "tax",
      "label": "VAT 19%",
      "amount": 380
    }
  ],
  "client": "web"
}

json

application/json

Get an order item

GET

https://api.cineamo.com

/order-items/{orderItemId}

Returns a OrderItem object by its Id.

Get an order item › path Parameters

orderItemId

integer · required

Get an order item › Responses

OrderItem details

OrderItem

id

integer · readOnly

quantity

integer · readOnly

productId

integer · readOnly

amountNet

integer | null · readOnly

amount

integer | null · readOnly

orderId

integer | null · readOnly

productSnapshot

object | null · readOnly

List order requests

GET

https://api.cineamo.com

/order-requests

Returns a list of order requests.

List order requests › Responses

200

Order request list

No data returned

Get an order request

GET

https://api.cineamo.com

/order-request/{orderRequestId"}

Returns the requested order request.

Get an order request › path Parameters

orderRequestId

string · required

Get an order request › Responses

OrderRequest details

No data returned

List order request bank accounts

GET

https://api.cineamo.com

/order-request-bank-accounts

Returns a list of OrderRequestBankAccount objects.

List order request bank accounts › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

orderRequestId

integer

List order request bank accounts › Responses

OrderRequestBankAccount list

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

Create an order request bank account

POST

https://api.cineamo.com

/order-request-bank-accounts

Creates a OrderRequestBankAccount. It returns the OrderRequestBankAccount object.

Create an order request bank account › Request Body

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

Create an order request bank account › Responses

OrderRequestBankAccount was created

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

POST/order-request-bank-accounts

curl https://api.cineamo.com/order-request-bank-accounts \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}'

Example Request Body

{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

Example Responses

{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

application/json

Get an order request bank account

GET

https://api.cineamo.com

/order-request-bank-accounts/{orderRequestBankAccountId}

Returns a OrderRequestBankAccount object by its Id.

Get an order request bank account › path Parameters

orderRequestBankAccountId

string · required

Get an order request bank account › Responses

OrderRequestBankAccount details

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

Delete an order request bank account

DELETE

https://api.cineamo.com

/order-request-bank-accounts/{orderRequestBankAccountId}

Deletes a OrderRequestBankAccount. It returns an empty response.

Delete an order request bank account › path Parameters

orderRequestBankAccountId

string · required

Delete an order request bank account › Responses

OrderRequestBankAccount was deleted

No data returned

Update an order request bank account

PATCH

https://api.cineamo.com

/order-request-bank-accounts/{orderRequestBankAccountId}

Updates a OrderRequestBankAccount. It returns the updated OrderRequestBankAccount object.

Update an order request bank account › path Parameters

orderRequestBankAccountId

string · required

Update an order request bank account › Request Body

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

Update an order request bank account › Responses

OrderRequestBankAccount was updated

readOnly · required

id

integer | null · readOnly

EG1600100099000010052142810

string · readOnly

bic

string · readOnly

bankName

string · readOnly

accountOwner

string · readOnly

isSepaMandat

boolean | null · readOnly

PATCH/order-request-bank-accounts/{orderRequestBankAccountId}

curl https://api.cineamo.com/order-request-bank-accounts/:orderRequestBankAccountId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}'

Example Request Body

{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

Example Responses

{
  "id": 1,
  "EG1600100099000010052142810": "iban",
  "bic": "98754200001",
  "bankName": "HSBC",
  "accountOwner": "default-account-owner",
  "isSepaMandat": false,
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

application/json

List order request cinemas

GET

https://api.cineamo.com

/order-request-cinemas

Returns a list of OrderRequestCinema objects.

List order request cinemas › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List order request cinemas › Responses

Order request cinema list

cinemaName

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

contactPerson

string · readOnly · required

readOnly · required

id

integer | null · readOnly

cinemaRoomCount

integer | null · readOnly

readOnly

GET/order-request-cinemas

curl https://api.cineamo.com/order-request-cinemas

Example Responses

{
  "id": 1,
  "cinemaName": "Cinema Stuttgart",
  "street": "Robert-Bosch-Plat 1",
  "postalCode": "70174",
  "city": "Stuttgart",
  "contactPerson": "Peter Pan",
  "cinemaRoomCount": 10,
  "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"
    }
  },
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

application/json

Create an order request cinema

POST

https://api.cineamo.com

/order-request-cinemas

Creates a OrderRequestCinema. It returns the OrderRequestCinema object.

Create an order request cinema › Request Body

cinemaName

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

contactPerson

string · readOnly · required

readOnly · required

id

integer | null · readOnly

cinemaRoomCount

integer | null · readOnly

readOnly

Create an order request cinema › Responses

OrderRequestCinema was created

cinemaName

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

contactPerson

string · readOnly · required

readOnly · required

id

integer | null · readOnly

cinemaRoomCount

integer | null · readOnly

readOnly

POST/order-request-cinemas

curl https://api.cineamo.com/order-request-cinemas \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "cinemaName": "Cinema Stuttgart",
  "street": "Robert-Bosch-Plat 1",
  "postalCode": "70174",
  "city": "Stuttgart",
  "contactPerson": "Peter Pan",
  "cinemaRoomCount": 10,
  "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"
    }
  },
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}'

Example Request Body

{
  "id": 1,
  "cinemaName": "Cinema Stuttgart",
  "street": "Robert-Bosch-Plat 1",
  "postalCode": "70174",
  "city": "Stuttgart",
  "contactPerson": "Peter Pan",
  "cinemaRoomCount": 10,
  "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"
    }
  },
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

Example Responses

{
  "id": 1,
  "cinemaName": "Cinema Stuttgart",
  "street": "Robert-Bosch-Plat 1",
  "postalCode": "70174",
  "city": "Stuttgart",
  "contactPerson": "Peter Pan",
  "cinemaRoomCount": 10,
  "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"
    }
  },
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

application/json

Get an order request cinema

GET

https://api.cineamo.com

/order-request-cinemas/{orderRequestCinemaId}

Returns a OrderRequestCinema object by its Id.

Get an order request cinema › path Parameters

orderRequestCinemaId

string · required

Get an order request cinema › Responses

OrderRequestCinema details

cinemaName

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

contactPerson

string · readOnly · required

readOnly · required

id

integer | null · readOnly

cinemaRoomCount

integer | null · readOnly

readOnly

GET/order-request-cinemas/{orderRequestCinemaId}

curl https://api.cineamo.com/order-request-cinemas/:orderRequestCinemaId

Example Responses

{
  "id": 1,
  "cinemaName": "Cinema Stuttgart",
  "street": "Robert-Bosch-Plat 1",
  "postalCode": "70174",
  "city": "Stuttgart",
  "contactPerson": "Peter Pan",
  "cinemaRoomCount": 10,
  "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"
    }
  },
  "orderRequest": {
    "id": 0,
    "email": "email",
    "firmName": "firmName",
    "streetNumber": "streetNumber",
    "city": "city",
    "postalCode": "postalCode",
    "contactPerson": "contactPerson",
    "plan": 0,
    "paymentMethod": "paymentMethod",
    "voucher": "voucher",
    "createdDatetime": "createdDatetime"
  }
}

json

application/json

Delete an order request cinema

DELETE

https://api.cineamo.com

/order-request-cinemas/{orderRequestCinemaId}

Deletes a OrderRequestCinema. It returns an empty response.

Delete an order request cinema › path Parameters

orderRequestCinemaId

string · required

Delete an order request cinema › Responses

OrderRequestCinema was deleted

No data returned

Update an order request cinema

PATCH

https://api.cineamo.com

/order-request-cinemas/{orderRequestCinemaId}

Updates a OrderRequestCinema. It returns the updated OrderRequestCinema object.

Update an order request cinema › path Parameters

orderRequestCinemaId

string · required

Update an order request cinema › Request Body

cinemaName

string · readOnly · required

street

string · readOnly · required

postalCode

string · readOnly · required

city

string · readOnly · required

contactPerson

string · readOnly · required

readOnly · required

id

integer | null · readOnly

cinemaRoomCount

integer | null · readOnly

readOnly

Update an order request cinema › Responses

OrderRequestCinema was updated