Заказы партнера (referral orders)

Получение данных

Для получения данных о заказах, созданных с вашим партнерским индентификатором, надо:

  1. Авторизоваться для получения доступа к REST API

  2. Вызвать метод для просмотра заказов партнера: https://experience.tripster.ru/api/partners/{partner_id}/experienceorders/, где {partner_id} — ваш партнерский идентификатор

Промышленное использование

Для синхронизации заказов со своей системой необходимо:

  1. Получайте данные в JSON. Вызывайте метод просмотра заказов с параметром format=json

  2. Запоминайте дату последней проверки заказов

    1. При вызове метода просмотра заказов запоминать у себя в БД дату последнего получения данных

    2. Вызывайте метод просмотра заказов с GET-параметром updated_after в формате %Y-%m-%d. Передавайте туда дату последней проверки заказов, чтобы получить в выдаче только те заказы, которые появились или были изменений начиная с этой даты - (Можно также использовать в запросе время последнего обновления. Формат iso8601. Пример 2021-01-26T11:31:26 или 2021-01-26 11:31:26).

  3. Загружайте данные постранично. Используйте ссылку из next для постраничной навигации по списку, ссылка уже будет содержать все необходимые для запроса параметры

Параметры запроса

  1. format=json

  2. updated_after=%Y-%m-%d. 

Структура ответа

Пример ответа API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 { "count": 42889, "next": "https://experience.tripster.ru/api/partners/somepartner/experienceorders/?page=2", "previous": null, "results": [ { "id": 123456, "partnerorder_id": "123abc4d", "price": null, "profit": null, "currency": "RUB", "description": "Музеи Ватикана и собор Святого Петра", "city": "Rome", "country": { "name_en": "Italy", "iso_code": "IT" }, "status": "processing", "updated_at": "2019-06-20 09:37:33", "created_at": "2019-06-20 09:37:33", "start_at": "2019-06-22 11:30:00", "partner": "somepartner", "subpartner": "161gavf7a5v7ajb8-12345", "utm_marks": { "content": null, "source": "somepartner", "term": null, "medium": "link", "campaign": "affiliates" } }, { "id": 123457, "partnerorder_id": "123abc4f", "price": 15000.0, "profit": 1200.0, "currency": "RUB", "description": "Фантастические виды соляной шахты «Величка»", "city": "Krakow", "country": { "name_en": "Poland", "iso_code": "PL" }, "status": "paid", "updated_at": "2019-06-20 09:16:10", "created_at": "2019-06-20 09:14:38", "start_at": "2019-06-20 13:00:00", "partner": "somepartner", "subpartner": "vashlv8asv67273ghj-12345", "utm_marks": { "content": null, "source": "somepartner", "term": null, "medium": "link", "campaign": "affiliates" } } ] }

Описание ответа

Параметр

Описание

Тип

Параметр

Описание

Тип

id

Числовой идентификатор заказа

Число

partnerorder_id

Строковый идентификатор заказов

Строка

price

Полная стоимость экскурсии, в статусах "processing", "cancelled" равен null

Float

profit

Вознаграждение партнера, в статусах "processing", "cancelled" равен null

Float

currency

Валюта, в которой указаны price и profit, в текущей версии API всегда RUB

Строка

description

Название экскурсии

Строка, до 1024 символов

city

Название города экскурсии на английском

Строка, до 32 знаков

country

Объект, содержащий информацию о стране

Объект

country.name_en

Название страны на английском

Строка

country.iso_code

iso код страны

Строка

status

Возможные варианты: "processing" — ожидает оплаты, "cancelled" — отменен, "paid" — оплачен

Строка

updated_at

Дата обновления информации по заказу

Дата/время в формате %Y-%m-%d H24:MM:SS

created_at

Дата создания заказа

Дата/время в формате %Y-%m-%d H24:MM:SS

start_at

Дата начала экскурсии, в статусах "processing", "cancelled" может быть null

Дата/время в формате %Y-%m-%d H24:MM:SS

partner

Партнерский идентификатор, берется из параметра exp_partner партнёрских ссылок

Строка, до 64 символов

subpartner

Берется из параметра exp_subpartner партнёрских ссылок. Может использоваться для хранения идентификатора партнёра 2-ого уровня, а также click_id или других идентификаторов

Строка, до 64 символов

utm_marks

Объект, содержащий utm-метки

Объект

utm_marks.content

Берется из параметра utm_content партнёрских ссылок

Строка, до 64 символов

utm_marks.source

Берется из параметра utm_source партнёрских ссылок

Строка, до 64 символов

utm_marks.term

Берется из параметра utm_term партнёрских ссылок

Строка, до 64 символов

utm_marks.medium

Берется из параметра utm_medium партнёрских ссылок

Строка, до 64 символов

utm_marks.campaign

Берется из параметра utm_campaign партнёрских ссылок

Строка, до 64 символов