Обновляет персональные данные покупателей в билетах

Request

POST

/order-update

Body

application/json
{
    "id": 0,
    "customer": {
        "firstName": "string",
        "lastName": "string",
        "email": "string",
        "phone": "string",
        "birthDate": "string"
    },
    "tickets": {
        "id": 0,
        "visitor": {
            "name": "string",
            "surname": "string",
            "middle_name": "string",
            "user_id": "string"
        }
    }
}

Name

Description

customer

Type: Customer

Информация о покупателе.

id

Type: integer<int32>

Идентификатор заказа у партнера.

tickets

Type: PersonalDataTicket

Список идентификаторов билетов с персональными данными посетителя.

Customer

Name

Description

birthDate

Type: string

Дата рождения клиента в формате yyyy-MM-dd.

email

Type: string

Электронная почта клиента.

firstName

Type: string

Имя клиента.

lastName

Type: string

Фамилия клиента.

phone

Type: string

Телефон клиента.

PersonalDataTicket

Name

Description

id

Type: integer<int32>

Идентификатор билета в базе данных.

visitor

Type: Visitor

Данные клиента по билету.

Visitor

Name

Description

middle_name

Type: string

Отчество клиента.

name

Type: string

Имя клиента.

surname

Type: string

Фамилия клиента.

user_id

Type: string

Идентификатор клиента .

Responses

200 OK

OK

Body

application/json
{
    "id": "string",
    "status": "UNDEFINED_ORDER_STATUS",
    "sum": {
        "price": {
            "value": "string",
            "currencyCode": "string"
        },
        "fee": {
            "value": "string",
            "currencyCode": "string"
        },
        "total": {
            "value": "string",
            "currencyCode": "string"
        }
    },
    "orderNumber": "string",
    "sessionTime": {
        "sessionStart": "2022-12-29T18:02:01Z",
        "sessionEnd": "2022-12-29T18:02:01Z",
        "type": "ON_TIME",
        "timezone": "string"
    },
    "codeWord": "string",
    "tickets": [
        {
            "id": "string",
            "barcode": "string",
            "admission": false,
            "levelId": "string",
            "levelName": "string",
            "categoryId": "string",
            "categoryName": "string",
            "row": "string",
            "place": "string",
            "pdfUrl": "string",
            "barcodeType": "UNDEFINED_BARCODE_TYPE",
            "organizerInfo": "string",
            "vat": "UNDEFINED_VAT",
            "categoryDescription": "string"
        }
    ],
    "attachmentType": "UNDEFINED_ATTACHMENT_TYPE",
    "partnerComment": "string",
    "organizerInfo": "string",
    "specificFields": {},
    "additional": {},
    "barcode": "string"
}

Name

Description

additional

Type: object

Служебное поле.

attachmentType

Type: AttachmentType

Количество бланков (вложений), которые нужно печатать для заказа.

Default: UNDEFINED_ATTACHMENT_TYPE

Enum: UNDEFINED_ATTACHMENT_TYPE, NONE, ORDER, TICKETS

barcode

Type: string

Баркод, который нужно напечатать на бланке заказа.
Необходим, если тип вложения ORDER и баркод должен отличаться от order_number.
Для заказов с типом вложения TICKETS и NONE это поле заполнять не нужно.

codeWord

Type: string

Кодовое слово.

id

Type: string

Идентификатор заказа.

orderNumber

Type: string

Номер заказа. Обязательное поле для подтвержденных заказов.

organizerInfo

Type: string

Информация об организаторе. Обязательное поле для заказов с типом вложения ORDER.

partnerComment

Type: string

Произвольный комментарий партнера.

sessionTime

Type: SessionTime

Время сеанса.

specificFields

Type: object

[additional]

Type: string

Служебное поле.

status

Type: OrderStatus

Статус заказа.

Default: UNDEFINED_ORDER_STATUS

Enum: UNDEFINED_ORDER_STATUS, CREATED, RESERVED, CANCELLED, BOOKED, APPROVED

sum

Type: Cost

Общая стоимость заказа.

tickets

Type: SoldTicket[]

Список билетов в заказе. Обязательное поле для подтвержденных заказов с типом вложения TICKETS.

AttachmentType

  • UNDEFINED_ATTACHMENT_TYPE: Тип вложений в заказ не определен.
  • NONE: В заказе нет вложений.
  • ORDER: Бланк вложений создается на заказ целиком.
  • TICKETS: Бланк вложений создается на каждый билет.

Type

Description

AttachmentType

Default: UNDEFINED_ATTACHMENT_TYPE

Enum: UNDEFINED_ATTACHMENT_TYPE, NONE, ORDER, TICKETS

SessionTime

Name

Description

sessionEnd

Type: string<date-time>

Время конца сеанса в формате времени ISO8601.

sessionStart

Type: string<date-time>

Время начала сеанса в формате времени ISO8601.

timezone

Type: string

Временная зона, в формате tz database. Например: Europe/Moscow, Asia/Yekaterinburg.

type

Type: SessionType

Тип сеанса.

Default: ON_TIME

Enum: ON_TIME, ALL_DAY

OrderStatus

  • UNDEFINED_ORDER_STATUS: Статус заказа не определен.
  • CREATED: Заказ создан.
  • RESERVED: Заказ забронирован.
  • CANCELLED: Заказ отменен.
  • BOOKED: Заказ забронирован на долгий период для последующего выкупа в кассе.
  • APPROVED: Заказ подтвержден.

Type

Description

OrderStatus

Default: UNDEFINED_ORDER_STATUS

Enum: UNDEFINED_ORDER_STATUS, CREATED, RESERVED, CANCELLED, BOOKED, APPROVED

Cost

Name

Description

fee

Type: Money

Сервисный сбор.

price

Type: Money

Номинальная стоимость.

total

Type: Money

Общая стоимость с учетом сервисного сбора и промокода.

SoldTicket

Name

Description

admission

Type: boolean<boolean>

Указывает, что на уровне нет привязки к местам. True — для уровня без мест, false — для уровня с местами.
Значение по умолчанию — false.

barcode

Type: string

Баркод. Обязателен для заказа в статусе APPROVED.

barcodeType

Type: BarcodeType

Тип баркода.

Default: UNDEFINED_BARCODE_TYPE

Enum: UNDEFINED_BARCODE_TYPE, EAN_13, QR_CODE, CODE_128, INTERLEAVED_2_OF_5, PDF_417

categoryDescription

Type: string

Описание ценовой категории в базе данных.

categoryId

Type: string

Идентификатор ценовой категории в базе данных. Обязателеное поле для уровня без мест.

categoryName

Type: string

Название ценовой категории в базе данных. Обязательное поле для уровня без мест.

id

Type: string

Идентификатор билета в базе данных.

levelId

Type: string

Идентификатор уровня в базе данных.

levelName

Type: string

Название уровня.

organizerInfo

Type: string

Информация об организаторе события. Обязательное поле для заказа в статусе APPROVED.

pdfUrl

Type: string

Ссылка, по которой можно скачать партнерский бланк билета в формате pdf.

place

Type: string

Место. Обязательное поле для уровня с местами.

row

Type: string

Ряд. Обязательное поле для уровня с местами.

vat

Type: Vat

Тип НДС.

Default: UNDEFINED_VAT

Enum: UNDEFINED_VAT, VAT_NONE, VAT_0, VAT_10, VAT_12, VAT_18, VAT_10_110, VAT_12_112, VAT_18_118

SessionType

  • ON_TIME: Мероприятие происходит в указанное время. Значение по умолчанию.
  • ALL_DAY: Мероприятие длится весь день.

Type

Description

SessionType

Default: ON_TIME

Enum: ON_TIME, ALL_DAY

Money

Name

Description

currencyCode

Type: string

Код валюты согласно ISO 4217, например RUB, USD, EUR.

value

Type: string<int64>

Сумма в минимальной единице валюты. Например, для рубля — копейки, для доллара — центы.

BarcodeType

  • UNDEFINED_BARCODE_TYPE: Тип используемого штрих-кода не определен.
  • EAN_13: EAN_13.
  • QR_CODE: QR-Code.
  • CODE_128: Code128.
  • INTERLEAVED_2_OF_5: Interleaved2of5 (ITF).
  • PDF_417: PDF_417.

Type

Description

BarcodeType

Default: UNDEFINED_BARCODE_TYPE

Enum: UNDEFINED_BARCODE_TYPE, EAN_13, QR_CODE, CODE_128, INTERLEAVED_2_OF_5, PDF_417

Vat

  • UNDEFINED_VAT: Размер НДС не определен.
  • VAT_NONE: Без НДС.
  • VAT_0: НДС 0%.
  • VAT_10: НДС 10%.
  • VAT_12: НДС 12%.
  • VAT_18: НДС 18%.
  • VAT_10_110: НДС 10%/110%.
  • VAT_12_112: НДС 12%/112%.
  • VAT_18_118: НДС 18%/118%.

Type

Description

Vat

Default: UNDEFINED_VAT

Enum: UNDEFINED_VAT, VAT_NONE, VAT_0, VAT_10, VAT_12, VAT_18, VAT_10_110, VAT_12_112, VAT_18_118

No longer supported, please use an alternative and newer version.