Agreements

Отримати угоду по ідентифікатору

Метод повертає дані по угоді.

get/agreements/{id}

Path parameters

idinteger required

Ідентифікатор угоди

Response

Успішна відповідь

idinteger

Ідентифікатор

titlestring

Назва

created_atstring

Дата та час створення

updated_atstring

Дата та час оновлення

marketplace_created_atstring

Дата та час створення на платформі (Rozetka/Prom/Allo/F.ua/Hubber/Хорошоп)

totalnumber

Загальна сума

commentstring

Коментар

importantboolean

Важливо

discountnumber

Знижка

discount_kind'percent_discount' | 'absolute_discount'

Тип знижки (відсоток чи сума)

result'archived' | 'successful' | 'failed'

Результат угоди (тільки для архівних угод)

products_total_as_totalboolean

Сума товарів дорівнює сумі угоди

custom_fieldsobject

Example response

{
  "id": 1,
  "title": "#725 - Замовлення з сайту",
  "total": 500,
  "stage": {
    "name": "В роботі"
  },
  "main_responsible": {
    "id": 1,
    "name": "Прізвище Імʼя По батькові"
  },
  "client": {
    "id": 1,
    "person": "Прізвище Імʼя По батькові",
    "email": "pib@example.com",
    "lead": false,
    "phones": [
      "+380000000001"
    ],
    "custom_fields": {
      "Адреса": "Ужгород-1"
    }
  },
  "deliveries": [
    {
      "ttn": 2032323123123,
      "status_description": "Видано кінцевому користувачу"
    }
  ],
  "jobs": [
    {
      "id": 1,
      "sku": 129,
      "title": "Книга English is Easy",
      "discount": 0,
      "amount": 2,
      "price": 123.12,
      "cost": 99.99,
      "total": 246.24,
      "custom_fields": {
        "Палітурка": "Жорстка"
      }
    }
  ],
  "custom_fields": {
    "Тип оплати": "При отриманні",
    "Тип доставки": "Нова Пошта"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.