Заказы

Операции с заказами

Получить список заказов

get

Возвращает список физических заказов текущего пользователя с пагинацией

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Query parameters

lastOrderIdstringOptional

ID последнего заказа для курсорной пагинации

limitinteger · max: 50Optional

Количество записей на страницу (максимум 50)

Default: 50

pageintegerOptional

Номер страницы

Default: 1

Responses

200

Успешный ответ

application/json

400

Некорректный запрос (неверный статус)

application/json

401

Неавторизован (неверный API ключ)

application/json

get

/physical/orders

HTTPcURLJavaScriptPython

GET /api/v1/physical/orders HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "rows": [
    {
      "id": 12345,
      "status": "pending",
      "created": "2024-01-15T10:30:00Z",
      "fullName": "Иван Иванов",
      "email": "[email protected]",
      "phone": "[phone]",
      "telegramID": 123456789,
      "address": {
        "countryIso2": "RU",
        "countryIso3": "RUS"
      },
      "locality": "Москва",
      "fullAddress": "Россия, Москва, ул. Пушкина, д. 10, кв. 5",
      "customerNote": "Домофон не работает, позвонить на телефон",
      "items": [
        {
          "id": 567,
          "price": 1500,
          "quantity": 2,
          "currency": "rub",
          "name": "Футболка с принтом",
          "attributes": {
            "size": "L",
            "color": "Черный"
          }
        }
      ],
      "deliveryCost": 250.5,
      "currency": "rub"
    }
  ],
  "meta": {
    "total": 125,
    "offset": 1,
    "limit": 50
  }
}

Получить детали заказа

get

Возвращает подробную информацию о конкретном заказе

Authorizations

ApiKeyAuth

Api-KeystringRequired

API ключ для аутентификации.

Path parameters

idintegerRequired

ID заказа

Responses

200

Успешный ответ

application/json

idintegerRequired

Уникальный идентификатор заказа

Example: 12345

statusstring · enumRequired

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

Example: pendingPossible values:

createdstring · date-timeRequired

Дата и время создания заказа

Example: 2024-01-15T10:30:00Z

fullNamestringRequired

Полное имя получателя

Example: Иван Иванов

emailstring · emailRequired

Email получателя

Example: [email protected]

phonestringRequired

Телефон получателя

Example: [phone]

telegramIDinteger · int64Required

Telegram ID покупателя

Example: 123456789

localitystringRequired

Населенный пункт

Example: Москва

fullAddressstringRequired

Полный адрес доставки

Example: Россия, Москва, ул. Пушкина, д. 10, кв. 5

customerNotestringRequired

Примечание от покупателя

Example: Домофон не работает, позвонить на телефон

deliveryCostnumber · floatRequired

Стоимость доставки

Example: 250.5

currencystringRequired

Валюта заказа

Example: rub

400

Некорректный запрос (не указан ID заказа)

application/json

401

Неавторизован (неверный API ключ)

application/json

404

Заказ не найден

application/json

get

/physical/orders/{id}

HTTPcURLJavaScriptPython

GET /api/v1/physical/orders/{id} HTTP/1.1
Host: tribute.tg
Api-Key: YOUR_API_KEY
Accept: */*

{
  "id": 12345,
  "status": "pending",
  "created": "2024-01-15T10:30:00Z",
  "fullName": "Иван Иванов",
  "email": "[email protected]",
  "phone": "[phone]",
  "telegramID": 123456789,
  "address": {
    "countryIso2": "RU",
    "countryIso3": "RUS"
  },
  "locality": "Москва",
  "fullAddress": "Россия, Москва, ул. Пушкина, д. 10, кв. 5",
  "customerNote": "Домофон не работает, позвонить на телефон",
  "items": [
    {
      "id": 567,
      "price": 1500,
      "quantity": 2,
      "currency": "rub",
      "name": "Футболка с принтом",
      "attributes": {
        "size": "L",
        "color": "Черный"
      }
    }
  ],
  "deliveryCost": 250.5,
  "currency": "rub"
}