Экспорты
Экспорт заказов и позиций заказов
Общий контракт постановки задачи экспорта
Общий контракт постановки задачи экспорта описан здесь
Контракт экспорта заказов и позиций заказов
Во входных параметрах можно указать даты за которые Mindbox вернет изменения заказа в формате UTC. Тогда в выгрузку попадут только заказы, действия которых были изменены в заданный период.
JSONPOST https://api.mindbox.ru/v3/operations/sync?endpointId={endpointId}&operation={operation} Accept: application/json Content-Type: application/json Authorization: SecretKey {Секретный ключ} { "exportId": "<Идентификатор экспорта>", "sinceDateTimeUtc": "<Дата и время самого раннего изменения заказа (UTC, YYYY-MM-DD hh:mm)>", "tillDateTimeUtc": "<Дата и время самого позднего изменения заказа невключительно (UTC, YYYY-MM-DD hh:mm)>", "exportOutput": { "type": "<Тип выгрузки FTP/SFTP>", "directory": "<Папка для выгрузки экспорта>", "credentials": { "userName": "<Логин пользователя>", "password": "<Пароль>", "sshPrivateKey": "<Приватный SSH ключ закодированный в Base64>" }, "server": { "url": "<URL сервера>", "port": "<Порт сервера>" } } }
Ответ экспорта заказов и позиций заказов
JSON{ "status": "<Результат выполнения запроса: Success в случае успеха, ValidationError в случае ошибки пользователя, ProtocolError в случае ошибки интеграции, InternalServerError в случае недоступности сервера.>", "exportId": "<Идентификатор экспорта, который нужно передать в следующем запросе>", "isDuplicate": "<Вызван повторный запрос экспорта. Экспорт с аналогичными настройками уже формируется>", "exportResult": { "processingStatus": "<Статус готовности файла>", "cancellationReason": "<Причина отмены экспорта>", "urls": [ "<Ссылка на файл с результатом>" ] } }
Файл экспорта заказов и позиций заказов
JSON{ "orders": [ { "deliveryCost": "<Стоимость доставки>", "totalPrice": "<Стоимость заказа с учетом скидок>", "ids": { "externalId": "<Внешний идентификатор заказа>" }, "firstAction": { "dateTimeUtc": "<Дата и время оформления заказа по UTC>", "ids": { "mindboxId": "<Идентификатор Mindbox>" }, "channel": { "name": "<Имя точки контакта>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор точки контакта>" } } }, "customFields": { "customField1": "Дополнительное поле заказа" }, "customer": { "email": "<Адрес электронной почты>", "mobilePhone": "<Номер мобильного телефона>", "pendingEmail": "<Адрес электронной почты, ожидающий подтверждения после смены>", "pendingMobilePhone": "<Номер мобильного телефона, ожидающий подтверждения после смены>", "ids": { "externalId": "<Внешний идентификатор клиента>" } }, "area": { "ids": { "externalId": "<Идентификатор географической зоны клиента>" } }, "transaction": { "ids": { "externalId": "<Идентификатор транзакции>" } }, "appliedPromotions": [ { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "amount": "<Размер скидки или бонуса примененной промоакции>", "expirationDateTimeUtc": "<Дата сгорания баллов>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "balanceType": { "name": "<Название балльного счёта>", "ids": { "systemName": "<Системное имя балльного счёта>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] } ], "lines": [ { "quantity": "<Количество единиц продукта>", "basePricePerItem": "<Базовая цена продукта за единицу продукта>", "priceOfLine": "<Конечная цена за линию чека>", "number": "<Номер позиции заказа>", "id": "<Идентификатор позиции заказа>", "product": { "name": "<Техническое название продукта>", "ids": { "externalId": "<Внешний Id продукта>" } }, "giftCard": { "amount": "<Номинал>", "status": { "ids": { "systemName": "<Системное имя статуса карты>" } } }, "customFields": { "customField1": "<Дополнительное поле линии>" }, "status": { "ids": { "externalId": "<Идентификатор статуса позиции заказа>" } }, "appliedPromotions": [ { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "amount": "<Размер скидки или бонуса примененной промоакции>", "expirationDateTimeUtc": "<Дата сгорания баллов>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "balanceType": { "name": "<Название балльного счёта>", "ids": { "systemName": "<Системное имя балльного счёта>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] } ] }, { "quantity": "<Количество единиц продукта>", "basePricePerItem": "<Базовая цена продукта за единицу продукта>", "priceOfLine": "<Конечная цена за линию чека>", "number": "<Номер позиции заказа>", "id": "<Идентификатор позиции заказа>", "product": { "name": "<Техническое название продукта>", "ids": { "externalId": "<Внешний Id продукта>" } }, "giftCard": { "amount": "<Номинал>", "status": { "ids": { "systemName": "<Системное имя статуса карты>" } } }, "customFields": { "coolness": "<Крутость>", "ntcn": "<Ntcn>", "test123": "<test123>" }, "status": { "ids": { "externalId": "<Идентификатор статуса позиции заказа>" } }, "appliedPromotions": [ { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "amount": "<Размер скидки или бонуса примененной промоакции>", "expirationDateTimeUtc": "<Дата сгорания баллов>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "balanceType": { "name": "<Название балльного счёта>", "ids": { "systemName": "<Системное имя балльного счёта>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "spentBonusPointsAmount": "<Использованное количество баллов примененной промоакции>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "balanceType": { "name": "<Название балльного счёта>", "ids": { "systemName": "<Системное имя балльного счёта>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "amount": "<Размер скидки или бонуса примененной промоакции>", "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } } }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "groupingKey": "<Ключ группировки примененных акций>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "issuedCoupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } }, "limits": [ { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } }, { "type": "<Способ агрегации (по акции, по клиенту)>", "untilDateTimeUtc": "<Дата завершения срока действия лимита>", "amount": { "type": "<Тип значения лимита (количество применений, размер скидки)>", "value": "<Значение лимита>" }, "used": { "usageServiceStatus": "<Использование лимита>", "amount": "<Использование лимита>" } } ] }, { "type": "<Тип примененной промоакции>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } }, "coupon": { "ids": { "code": "<Промокод>" }, "pool": { "name": "<Наименование пула промокодов>", "description": "<Описание пула промокодов>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор пула промокодов>" } } } }, { "type": "<Тип примененной промоакции>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } } }, { "type": "<Тип примененной промоакции>", "amount": "<Размер скидки или бонуса примененной промоакции>", "promotion": { "name": "<Наименование промоакции>", "type": "<Тип промоакции>", "ids": { "mindboxId": "<Идентификатор Mindbox>", "externalId": "<Внешний идентификатор промоакции>" } } } ] } ], "bonusPointsInfoPerBalanceType": [ { "spentAmount": "Сумма потраченных баллов с конкретного балльного счета за заказ на настоящий момент времени", "earnedAmount": "Сумма начисленных баллов на конкретный балльный счет за заказ на настоящий момент времени", "balanceType": { "name": "Название балльного счёта", "ids": { "systemName": "<Системное имя балльного счёта>" } } } ], "payments": [ { "type": "<Тип платежа>", "id": "<Идентификатор платежа>", "amount": "<Размер платежа, примененного к заказу>", "creditCard": { "hash": "<Хеш банковской карты>" } }, { "type": "<Тип платежа>", "id": "<Идентификатор платежа>", "amount": "<Размер платежа, примененного к заказу>", "creditCard": { "hash": "<Хеш банковской карты>" } } ] } ] }
В узле bonusPointsInfoPerBalanceType выводятся только ненулевые суммарные списания и начисления по каждому из затронутых в промоакции балльных счетов.
Если в одном из действий по заказу на балльный счет были произведены начисления или списания, которые в процессе обновления заказа отменились (например, в случае возврата позиции), балльный счет не будет выводиться в данном узле с нулевыми списаниями и начислениями по нему.
В appliedPromotions в узле type указывается тип примененной промоакции.
Если с примененной промоакцией связан промокод, он вернется в ответе. При использовании внешних промокодов, процессинг которых не на стороне Майндбокс, узел promotion будет отсутствовать.
Поддерживаются следующие типы:
- discount — скидка, может применяться только к позиции заказа
- deliveryDiscount — скидка, может применяться только на заказ
- earnedBonusPoints — начисление бонусных баллов за заказов
- spentBonusPoints — списание бонусных баллов для оплаты заказа
- issuedCoupon — выданный купон за заказ
- message — сообщение покупателю
Last modified on