api яндекс доставка php
Интеграция с помощью API
Примеры использования API
Подробное описание методов вы можете найти в документации API.
Быстро интегрировать магазин с Яндекс.Доставкой
Этот вариант подходит для интеграции небольших магазинов. С помощью него вы получите возможность:
Узнавать возможные способы доставки заказа.
Передавать в систему Яндекс.Доставки данные, необходимые для создания заказа.
Также в личном кабинете Яндекс.Доставки вам понадобится подтверждать заказы, создавать и подтверждать заявки на отгрузку, печатать ярлыки и сопроводительные документы.
SearchDeliveryList — позволяет получить варианты доставки заказа.
Передавать заказы в службы доставки
Вариант дополняет предыдущий и подходит для магазинов, которые обрабатывают от 30 заказов в день. Он позволит вам:
Создавать заказы в системе Яндекс.Доставки.
Отправлять заказы в службы доставки.
Загружать ярлыки для заказов.
Однако создавать заявки на отгрузку, подтверждать отгрузки, печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
ConfirmSenderOrders — позволяет создать заказ в системе Яндекс.Доставки и отправить его в службу доставки.
GetSenderOrderLabel — позволяет получить ярлык заказа в формате PDF или HTML.
Автоматизировать создание заявок на отгрузку
Вариант дополняет предыдущие и позволит вам создавать заявки на забор и самопривоз (в системе Яндекс.Доставки).
Однако редактировать, подтверждать и отменять отгрузки, а также печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
GetDeliveries — позволяет получить список доступных служб доставки.
GetIntervals — позволяет получить доступные временные интервалы для забора.
CreateWithdraw — позволяет создать заявку на забор (если еще нет заявки на ту же дату).
GetDeliveries — позволяет получить список доступных служб доставки.
GetIntervals — позволяет получить доступные временные интервалы для самопривоза.
CreateImport — позволяет создать заявку на самопривоз (если еще нет заявки на ту же дату).
Полностью автоматизировать создание заказа
Вариант дополняет предыдущие и позволит вам:
Подтверждать отгрузку заказов (в системе Яндекс.Доставки).
Загружать сопроводительные документы для заказов.
ConfirmSenderParcels — позволяет подтвердить отгрузку (нужно выполнять строго в день отгрузки).
GetSenderParcelDocs — позволяет получить сопроводительные документы для заказов в отгрузке.
Автоматизировать изменение и отмену заказов
Этот набор методов позволит вам:
Редактировать черновики заказов.
Отменять заказы в своей системе учета и передавать эти данные в систему Яндекс.Доставки.
Отменять заказы и создавать на их основе новые.
UpdateOrder — позволяет изменить черновик заказа. Чтобы изменить уже оформленный заказ, отмените его и создайте новый.
DeleteOrder — позволяет отменить заказ, если отгрузка с ним еще не подтверждена.
Отслеживать статусы заказов
Этот набор методов позволит вам:
Узнавать статусы для всех своих заказов.
Получать историю статусов для одного или нескольких заказов.
Искать заказы с определенными статусами.
GetSenderOrderStatus — позволяет получить текущий статус заказа.
GetSenderOrderStatuses — позволяет получить историю статусов заказа, а также найти заказы с заданными статусами.
SearchSenderOrdersStatuses — позволяет получить историю статусов нескольких заказов, а также найти заказы с заданными статусами.
Получить справочную информацию
Используйте эти методы для получения дополнительной информации:
GetSenderInfo — позволяет получить информацию о магазине из аккаунта в Яндекс.Доставке.
GetRequisiteInfo — позволяет получить реквизиты магазина.
GetWarehouseInfo — позволяет получить информацию о складе магазина.
GetOrderInfo — позволяет получить информацию о заказе.
Получение токена и ключей для работы через API
Чтобы получить идентификационный токен и API-ключи:
В личном кабинете нажмите ссылку Настройки в правом верхнем углу страницы.
Интеграция с помощью API
API Яндекс.Доставки позволяет программно выполнять операции с заказами, доступные в личном кабинете.
Примеры использования API
Быстро интегрировать магазин с Яндекс.Доставкой
Этот вариант подходит для интеграции небольших магазинов. С помощью него вы получите возможность:
Узнавать возможные способы доставки заказа.
Передавать в систему Яндекс.Доставки данные, необходимые для создания заказа.
Также в личном кабинете вам понадобится подтверждать заказы, создавать и подтверждать отгрузки, печатать ярлыки и сопроводительные документы.
Получить правильный адрес можно с помощью запроса Получить составляющие адреса.
Передавать заказы в службы доставки
Вариант дополняет предыдущий и подходит для магазинов, которые обрабатывают от 30 заказов в день. Он позволит вам:
Создавать заказы в системе Яндекс.Доставки.
Отправлять заказы в службы доставки.
Загружать ярлыки для заказов.
Однако создавать и подтверждать отгрузки, печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
Оформить заказ — позволяет создать заказ в системе Яндекс.Доставки и отправить его в службу доставки.
Автоматизировать создание отгрузки
Вариант дополняет предыдущие и позволит вам создавать заявки на забор и самопривоз (в системе Яндекс.Доставки).
Однако редактировать, подтверждать и отменять отгрузки, а также печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
Интеграция с помощью API
Примеры использования API
Подробное описание методов вы можете найти в документации API.
Быстро интегрировать магазин с Яндекс.Доставкой
Этот вариант подходит для интеграции небольших магазинов. С помощью него вы получите возможность:
Узнавать возможные способы доставки заказа.
Передавать в систему Яндекс.Доставки данные, необходимые для создания заказа.
Также в личном кабинете Яндекс.Доставки вам понадобится подтверждать заказы, создавать и подтверждать заявки на отгрузку, печатать ярлыки и сопроводительные документы.
SearchDeliveryList — позволяет получить варианты доставки заказа.
Передавать заказы в службы доставки
Вариант дополняет предыдущий и подходит для магазинов, которые обрабатывают от 30 заказов в день. Он позволит вам:
Создавать заказы в системе Яндекс.Доставки.
Отправлять заказы в службы доставки.
Загружать ярлыки для заказов.
Однако создавать заявки на отгрузку, подтверждать отгрузки, печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
ConfirmSenderOrders — позволяет создать заказ в системе Яндекс.Доставки и отправить его в службу доставки.
GetSenderOrderLabel — позволяет получить ярлык заказа в формате PDF или HTML.
Автоматизировать создание заявок на отгрузку
Вариант дополняет предыдущие и позволит вам создавать заявки на забор и самопривоз (в системе Яндекс.Доставки).
Однако редактировать, подтверждать и отменять отгрузки, а также печатать ярлыки и сопроводительные документы вам понадобится в личном кабинете.
GetDeliveries — позволяет получить список доступных служб доставки.
GetIntervals — позволяет получить доступные временные интервалы для забора.
CreateWithdraw — позволяет создать заявку на забор (если еще нет заявки на ту же дату).
GetDeliveries — позволяет получить список доступных служб доставки.
GetIntervals — позволяет получить доступные временные интервалы для самопривоза.
CreateImport — позволяет создать заявку на самопривоз (если еще нет заявки на ту же дату).
Полностью автоматизировать создание заказа
Вариант дополняет предыдущие и позволит вам:
Подтверждать отгрузку заказов (в системе Яндекс.Доставки).
Загружать сопроводительные документы для заказов.
ConfirmSenderParcels — позволяет подтвердить отгрузку (нужно выполнять строго в день отгрузки).
GetSenderParcelDocs — позволяет получить сопроводительные документы для заказов в отгрузке.
Автоматизировать изменение и отмену заказов
Этот набор методов позволит вам:
Редактировать черновики заказов.
Отменять заказы в своей системе учета и передавать эти данные в систему Яндекс.Доставки.
Отменять заказы и создавать на их основе новые.
UpdateOrder — позволяет изменить черновик заказа. Чтобы изменить уже оформленный заказ, отмените его и создайте новый.
DeleteOrder — позволяет отменить заказ, если отгрузка с ним еще не подтверждена.
Отслеживать статусы заказов
Этот набор методов позволит вам:
Узнавать статусы для всех своих заказов.
Получать историю статусов для одного или нескольких заказов.
Искать заказы с определенными статусами.
GetSenderOrderStatus — позволяет получить текущий статус заказа.
GetSenderOrderStatuses — позволяет получить историю статусов заказа, а также найти заказы с заданными статусами.
SearchSenderOrdersStatuses — позволяет получить историю статусов нескольких заказов, а также найти заказы с заданными статусами.
Получить справочную информацию
Используйте эти методы для получения дополнительной информации:
GetSenderInfo — позволяет получить информацию о магазине из аккаунта в Яндекс.Доставке.
GetRequisiteInfo — позволяет получить реквизиты магазина.
GetWarehouseInfo — позволяет получить информацию о складе магазина.
GetOrderInfo — позволяет получить информацию о заказе.
Получение токена и ключей для работы через API
Чтобы получить идентификационный токен и API-ключи:
В личном кабинете нажмите ссылку Настройки в правом верхнем углу страницы.
Условия использования сервиса «API Яндекс.Доставка»
Общество с ограниченной ответственностью «ЯНДЕКС», ОГРН: 1027700229193 (далее — Яндекс) предлагает Пользователю использовать сервис «API Яндекс.Доставка» на условиях, изложенных в настоящем документе (далее — «Условия»).
1. Общие условия
1.1. Термины и определения
Пользователь — заказчик услуг «Яндекс.Доставка», надлежащим образом подключенный к системе «Яндекс.Доставка», как указано на странице https://yandex.ru/support/delivery/connecting/how-to-connect.xml.
Сервис — сервис «API Яндекс.Доставка», представляющий собой интерфейс программирования, который предоставляет возможность автоматизировать обработку пользовательских заказов, а также автоматически создавать и отправлять в систему «Яндекс.Доставки» заказы (заявки) на доставку.
API-Ключ — уникальный идентификатор, выдаваемый Пользователю, позволяющий получить доступ к функциям Сервиса со своего сайта (-ов).
Данные — сведения, поступающие от Сервиса, включая, но не ограничиваясь:
автозаполнение адреса доставки в момент оформления Покупателем заказа в Интернет-магазине;
предоставление Покупателю информация о доступных вариантах доставки;
автоматические создание и отправка заказа на доставку;
статусы заказов на доставку;
ярлыки и сопроводительные документы к заказу на доставку.
Покупатель – физическое или юридическое лицо, заключившее или намеревающееся заключить с Пользователем договор купли-продажи товара.
1.2. Использование Пользователем Сервиса регулируется настоящими Условиями, Общими условиями оказания услуг «Яндекс.Доставка», размещенными по адресу: https://yandex.ru/legal/delivery_terms_of_service, а также следующими документами Яндекса:
Пользовательским соглашением сервисов Яндекса, размещенным по адресу: https://yandex.by/legal/rules;
Лицензией на использование поисковой системы Яндекса, размещенной по адресу: https://yandex.by/legal/termsofuse;
Политикой конфиденциальности, размещенной по адресу: https://yandex.by/legal/confidential.
1.3. Начиная использовать Сервис или его отдельные функции, в том числе получив API-ключ, зарегистрировавшись на Сервисе, разместив код Сервиса на своем сайте или воспользовавшись любой другой функциональной возможностью, предоставляемой Сервисом, Пользователь принимает настоящие Условия, а также условия всех указанных в п. 1.2 Условий документов, в полном объеме, без всяких оговорок и исключений, и обязуется соблюдать их. Использование Сервиса на иных условиях, чем условия указанных документов, возможно только по предварительному письменному согласию Яндекса. В случае несогласия Пользователя с какими-либо из условий указанных документов, Пользователь не вправе использовать Сервис.
1.4. Пользователь самостоятельно несет ответственность за соблюдение им Законодательства при использовании Сервиса. Везде по тексту настоящих Условий, если явно не указано иное, под термином «Законодательство» понимается любое применимое законодательство, включая как законодательство Российской Федерации, так и законодательство места пребывания Пользователя или места совершения им юридически значимых действий в соответствии с настоящими Условиями. Если использование Пользователем какой-либо возможности, предоставляемой Сервисом, нарушает Законодательство, Пользователь обязуется воздержаться от использования Сервиса.
1.5. К настоящим Условиям и отношениям между Яндексом и Пользователем, возникающим в связи с использованием Сервиса, подлежит применению право Российской Федерации.
2. Условия использования Сервиса
2.1. Для получения доступа к Сервису Пользователь обязан зарегистрироваться по установленной форме и получить API-Ключ. Яндекс вправе по своему усмотрению отказать в доступе к Сервису без объяснения причин. Пользователь не имеет права использовать любые программы, устройства или иные средства, позволяющие получить API-Ключ автоматическим путем или иным образом с нарушением процедуры, установленной Яндексом.
2.2. Требования к Интернет-магазину. Интернет-магазин, в котором используется Сервис, не должен нарушать Законодательство или права и законные интересы третьих лиц, а также содержать вредоносные программы (или не должен сам по себе являться вредоносной программой); вмешиваться в работу Сервиса, отрицательно влияя на функциональность Сервиса; кэшировать Данные; Пользователь самостоятельно несет ответственность перед третьими лицами за содержание Интернет-магазина и использование Сервиса для Интернет-магазина. Помимо вышеперечисленного Интернет-магазин должен соответствовать требованиям, указанным на странице: https://yandex.ru/support/delivery-3/register.html#register__rules.
2.3. Пользователь может использовать данные и функции, полученные при помощи Сервиса, только в рамках функциональности, предоставляемой Сервисом.
2.4. При использовании Сервиса Пользователь обязан обеспечить указание на технологию Яндекса путем размещения в непосредственной близости от выводимых Данных логотипа Яндекса. При использовании Сервиса пользователь не имеет права удалять, скрывать или модифицировать любые содержащиеся в Сервисе или полученных с его помощью данных товарные знаки, логотипы, ссылки или иные указания на Яндекс или иных лиц, равно как и любые другие уведомления и/или информацию, передаваемые Сервисом.
2.5. Пользователь не имеет права изменять, декомпилировать и/или каким-либо образом модифицировать программный код, полученный посредством Сервиса.
2.6. Услуги оказываются только Заказчикам, Интернет-магазины которых удовлетворяют требованиям, изложенным в документе «Условия подключения», размещённом по адресу: https://yandex.ru/support/delivery-3/register.html#register__rules.
2.7. Пользователь не имеет права использовать Сервис для интеграции с Интернет-магазинами, если такое использование влечет нарушение Законодательства, документов, указанных в п. 1.2 Условий, и/или прав и законных интересов третьих лиц.
2.8. Пользователь настоящим уведомлен и соглашается, что Сервис может получать данные о заказах и контактную информацию о Покупателях, и предоставлять их Яндексу для передачи службам доставки.
2.9. Яндекс оставляет за собой право изменять, исправлять или обновлять Сервис в любой момент, без предварительного уведомления Пользователя. При выпуске очередной стабильной версии Яндекс сообщает о её выпуске на веб-страницах Сервиса. После выпуска новой версии Сервиса Яндекс не гарантирует стабильность и продолжительность работы его устаревших версий. Пользователь, не согласный использовать обновленную версию Сервиса, может либо продолжать на свой страх и риск использовать устаревшую версию Сервиса, либо прекратить использование Сервиса, удалив соответствующий код с сайта (-ов) Пользователя.
2.10. Яндекс имеет право по собственному усмотрению прекратить или приостановить доступ Пользователя к Сервису без уведомления и без объяснения причин, в частности, в случае нарушения Пользователем требований настоящих Условий.
3. Интеллектуальные права
3.1. Исключительное право на Сервис принадлежит Яндексу. Исключительные права на Данные принадлежат Яндексу или иным правообладателям. Настоящие Условия не дают Пользователю каких-либо прав на использование Сервиса или Данных помимо тех возможностей, которые предоставляются непосредственно в интерфейсе Сервиса в соответствии с настоящими Условиями.
3.2. Используя Сервис, Пользователь предоставляет Яндексу право использовать логотип, товарный знак и/или фирменное наименование Пользователя и/или сайта Пользователя в информационных, рекламных и маркетинговых целях без необходимости получения дополнительного согласия Пользователя и без выплаты ему какого-либо вознаграждения за такое использование.
4. Отказ от ответственности
4.1. Сервис (включая Данные) предоставляется Яндексом «как есть». Яндекс не гарантирует соответствие Сервиса и Данных целям и ожиданиям Пользователя, бесперебойную и безошибочную работу Сервиса в целом и отдельных его компонентов и/или функций, а также не гарантирует достоверность, точность, полноту и своевременность Данных. Яндекс не гарантирует бесперебойную и безошибочную работу сторонних программных продуктов и решений (в т.ч. библиотек), рекомендованных при использовании Сервиса в технических условиях и иной документации, связанной с его использованием.
4.2. Пользователь самостоятельно и в полном объёме несёт ответственность за использование и сохранность своего API-Ключа. Пользователь не имеет права получать API-Ключ для третьих лиц, передавать или предоставлять его третьим лицам. Яндекс не несёт ответственности за несанкционированное использование API-Ключа третьими лицами. Все действия, совершенные на Сервисе с использованием принадлежащего Пользователю API-Ключа, считаются совершенными Пользователем.
5. Заключительные положения
5.1. Яндекс имеет право без уведомления по собственному усмотрению прекратить или приостановить доступ Пользователя к Сервису или к отдельным его функциям с использованием его учетной записи и/или API-ключа, без объяснения причин, в том числе, в случае нарушения Пользователем требований настоящих Условий.
5.2. Все вопросы и претензии, связанные с использованием/невозможностью использования Сервиса, должны направляться через форму обратной связи, размещенной на странице поддержки в личном кабинете системы «Яндекс.Доставка».
5.3. Яндекс вправе в любое время без уведомления Пользователя изменять текст настоящих Условий. Действующая редакция настоящих Условий размещается по адресу: https://yandex.by/legal/delivery_api_terms_of_service. Новая редакция Условий вступает в силу с момента ее размещения в сети Интернет по указанному в настоящем абзаце адресу. Продолжение использования Сервиса после изменения Условий считается согласием с их новой редакцией. Пользователь обязан прекратить использование Сервиса, в случае если Яндексом были внесены какие-либо изменения в настоящие Условия, с которыми Пользователь не согласен.
Дата публикации: «01» сентября 2021 года.
Обработка заказов
С помощью партнерского API вы можете обрабатывать заказы, поступающие от пользователей Маркета. Процесс обработки заказов предполагает обмен данными между Маркетом и магазином.
Если при работе через API у вас возникнут неполадки, вы можете обработать заказы вручную в личном кабинете.
Порядок взаимодействия через API при обработке заказов
Когда покупатель начинает оформление заказа, магазину поступает запрос POST /cart с целью актуализации данных по наличию товаров, доставке и т. п. Ответ магазина должен содержать актуальные данные.
Когда покупатель завершает оформление заказа, на стороне Маркета формируется заказ со статусом RESERVED (зарезервирован), а магазину поступает запрос POST /order/accept на принятие заказа.
Магазин должен отправить ответ с подтверждением принятия заказа ( \»accepted\»: true ) или с отказом от заказа ( \»accepted\»: false ).
Маркет отправляет магазину данные о статусе заказа. Статус зависит от способа оплаты.
Оплата при оформлении
Маркет отправляет магазину запрос POST /order/status со статусом заказа UNPAID (не оплачен). У покупателя есть 30 минут, чтобы оплатить заказ. После оплаты Маркет отправляет магазину запрос POST /order/status со статусом заказа PROCESSING (обрабатывается) — магазин может обрабатывать заказ. Если заказ не оплачен в течение 30 минут, Маркет отправляет магазину запрос POST /order/status со статусом заказа CANCELLED (отменен).
Оплата при получении
Маркет отправляет магазину запрос POST /order/status со статусом заказа PROCESSING (обрабатывается) — магазин может обрабатывать заказ.
Магазин готовит заказ к отправке покупателю.
Если в заказе есть товары, подлежащие маркировке в системе «Честный ЗНАК» (из определенных категорий товаров), при сборке заказа магазин должен отправить запрос PUT /campaigns/
На данном этапе магазин может изменить дату доставки (например, если он не успевает подготовить заказ в срок или пользователь попросил перенести доставку) или отменить заказ (например, если товар отсутствует на складе или был поврежден при упаковке).
После отгрузки магазин может изменить дату доставки (например, если служба доставки не успевает доставить заказ в срок или пользователь попросил перенести доставку) или отменить заказ (например, если служба доставки не может доставить заказ).
Если служба доставки присваивает посылкам трек‑номера, отправьте запрос POST /campaigns/
Вы можете использовать запрос, чтобы повысить лояльность покупателей. Если они могут узнать, на каком этапе доставки находятся их заказы, доверие покупателей к вашему магазину может возрасти.
Магазин может отслеживать дальнейшие изменения статуса заказа через партнерский API, запрашивая информацию об этом заказе или обо всех заказах. Подробнее см. в разделе Запрос информации о заказах.
Изменение даты доставки
Если вы не можете доставить заказ в заявленный срок или покупатель попросил вас перенести доставку, отправьте запрос PUT /campaigns/
Изменение состава заказа
Отмена заказа магазином
Причины отмены заказа
Отмена заказа покупателем
Покупатель может отменить заказ в течение его обработки или доставки. Если заказ еще обрабатывается (имеет статус PROCESSING ), вам не нужно подтверждать отмену заказа — он будет отменен автоматически.
Если заказ уже передан службе доставки (принимает статус DELIVERY или PICKUP ) и пользователь отменил его, вы получите уведомление от Маркета с помощью запроса POST /order/cancellation/notify.
Вы можете предупредить службу доставки об отмене заказа в течение 48 часов. Если служба узнала об отмене до передачи заказа покупателю, подтвердите отмену с помощью запроса PUT /campaigns/
Если в течение 48 часов вы не подтвердите или отклоните отмену, заказ будет отменен автоматически.
Резервирование товаров на складе
Запрос информации о заказах
В любой момент магазин может получить актуальную информацию как о конкретном заказе, так и обо всех своих заказах, оформленных на Маркете. Чтобы получить эти данные, магазину необходимо выполнить запрос GET /campaigns/