Выдача промокода

Описание метода

Осуществляется с помощью POST-запроса. Название операции и набор принимаемых полей настраиваются в системе Майндбокс. Подробней про вызов метода можно прочитать здесь.

Выдача промокода - запрос
POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpoint={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}&{transactionId}={Id транзакции в вашей системе}

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey {Секретный ключ, обязательность уточнить у менеджера}

<operation>
    <customer>
        <ids>
            <webSiteUserId>{Идентификатор клиента}</webSiteUserId>
        </ids>
    </customer>
    <promoCode>
        <ids>
            <value>{Значение промокода}</value>
        </ids>
        <pool>
            <ids>
                <externalId>{Внешний идентификатор}</externalId>
            </ids>
        </pool>
        <availableFromDateTimeUtc>{Дата, с которой доступен промокод в формате YYYY-MM-DD hh:mm:ss.fff}</availableFromDateTimeUtc>
        <availableTillDateTimeUtc>{Дата, до которой доступен промомкод в формате YYYY-MM-DD hh:mm:ss.fff }</availableTillDateTimeUtc>
    </promoCode>
    <executionDateTimeUtc>{Дата и время привязки промокода (для выполнения запроса задним числом)}</executionDateTimeUtc>
</operation>

Параметр transactionId используется только для асинхронных вызовов. Подробнее в статье.
Обязательность узлов promoCode/ids и promoCode/pool зависит от настроек шага операции:

Выдача промокода - ответ
<result>
	<status>{Результат выполнения запроса: Success в случае успеха, ValidationError в случае ошибки пользователя, ProtocolError в случае ошибки интеграции, InternalServerError в случае недоступности сервера.}</status>
	<promoCode>
		<issueStatus>{Статус выдачи}</issueStatus>
		<ids>
			<mindboxId>{Идентификатор промокода}</mindboxId>
			<value>{Значение промокода}</value>
		</ids>
		<pool>
			<ids>
				<externalId>{Внешний идентификатор}</externalId>
			</ids>
			<name>{Имя}</name>
			<description>{Описание}</description>
		</pool>
		<availableFromDateTimeUtc>{Дата, с которой доступен промокод в формате YYYY-MM-DD hh:mm:ss.fff}</availableFromDateTimeUtc>
		<availableTillDateTimeUtc>{Дата, до которой доступен промомкод в формате YYYY-MM-DD hh:mm:ss.fff }</availableTillDateTimeUtc>
		<isUsed>{Погашен ли промокод, значение true или false}</isUsed>
		<usedPointOfContact>
			<ids>
				<externalId>{Внешний инденнтификатор}</externalId>
			</ids>
			<name>{Название точки контакта}</name>
		</usedPointOfContact>
		<usedDateTimeUtc>{Дата гашения промокода в формате YYYY-MM-DD hh:mm:ss.fff}</usedDateTimeUtc>
		<issuedPointOfContact>
			<ids>
				<externalId>{Внешний инденнтификатор}</externalId>
			</ids>
			<name>{Название точки контакта}</name>
		</issuedPointOfContact>
		<issuedDateTimeUtc>{Дата выдачи промокода в формате YYYY-MM-DD hh:mm:ss.fff}</issuedDateTimeUtc>
		<blockedDateTimeUtc>{Дата блокировки промокода в формате YYYY-MM-DD hh:mm:ss.fff}</blockedDateTimeUtc>
	</promoCode>
</result>