QUINCE API. Замовлення

Список методів

Отримання списку замовлень

Назва методу: /api/v2/order/list

Повертає список замовлень. Для навігації використовується номер сторінки page. Розмір сторінки фіксований і дорівнює 100 елементам.

Параметри запиту

Якщо DateFrom і DateTo не передані та немає фільтра Id або DateModifiedFrom, API повертає документи за поточний день. Якщо передати тільки одну з дат DateFrom/DateTo без DateModifiedFrom, API поверне помилку DateFrom and DateTo are required. Поле Status має бути масивом.

Основні поля відповіді

Поля рядків Rows

Приклад запиту

{
  "filter": {
    "DateFrom": "2026-03-01",
    "DateTo": "2026-03-11",
    "Status": [111, 192]
  },
  "page": 1
}

Створення та оновлення замовлень

Назва методу створення: /api/v2/order/add

Назва методу оновлення: /api/v2/order/update

Методи додають або оновлюють замовлення пакетами до 100 елементів.

API підтримує два режими:

Store і Company можуть братися з налаштувань адміністратора за замовчуванням, якщо не передані явно.

Для дат у створенні та оновленні використовуйте формат yyyy-mm-dd або yyyy-mm-dd HH:mm:ss. Якщо передати тільки дату без часу, API додає поточний час сервера.

Параметри для strict: true

Для /api/v2/order/add у strict: true обов’язкові Date, Responsible, Partner, Store, Status, Contract і непорожній масив Rows. Для /api/v2/order/update обов’язковий Id замовлення, а Rows можна не передавати. Якщо під час оновлення у Rows передати Id рядка, рядок буде оновлений. Якщо Id не передати, рядок буде доданий до замовлення.

Параметри рядків для strict: true

Якщо передати PriceWithoutDiscount, треба також передати PercentDiscount, і навпаки. Якщо ці поля не передані, PriceWithoutDiscount дорівнює Price, а PercentDiscount дорівнює 0.

Параметри для strict: false

Для /api/v2/order/add у strict: false обов’язкові NumberOrderSite, Date, Partner.Name, Store.Name, Status.Name, Contract.Name, Contract.Currency і непорожній масив Rows. Для /api/v2/order/update обов’язковий NumberOrderSite, а інші поля можна передавати частково. Якщо під час оновлення передати Partner, треба також передати Contract, і навпаки.

Пошук товару виконується спочатку за Article, якщо він переданий, потім за Name. InformationSource, PaymentOption і ShippingOption у strict: false передаються як об’єкти з полем Name; значення мають існувати у відповідних довідниках.

Основні вкладені поля для strict: false

Формат відповіді

Приклад створення у strict: true

{
  "strict": true,
  "array": [
    {
      "Date": "2026-03-11",
      "Sum": 1000,
      "Partner": 53869,
      "Status": 1397,
      "Contract": 54065,
      "PriceType": 610,
      "Company": 112,
      "Rows": [
        {
          "Product": 89272,
          "Price": 500,
          "Qty": 2,
          "Sum": 1000,
          "RowNo": 1
        }
      ]
    }
  ]
}

Приклад створення у strict: false

{
  "strict": false,
  "search-partner-by": "Email",
  "array": [
    {
      "NumberOrderSite": "api_order_5",
      "Date": "2026-03-11",
      "Sum": 1000,
      "Partner": {
        "Name": "Partner 1",
        "Email": "[email protected]"
      },
      "Contract": {
        "Name": "Основний контракт",
        "Currency": "UAH"
      },
      "Status": {
        "Name": "Новий"
      },
      "PriceType": {
        "Name": "Ціна продажу",
        "Currency": "UAH"
      },
      "Rows": [
        {
          "Product": {
            "Name": "Товар 1",
            "Article": "SKU-1",
            "Unit": "шт",
            "Kind": "P"
          },
          "Price": 500,
          "Qty": 2,
          "Sum": 1000,
          "PriceWithoutDiscount": 500,
          "PercentDiscount": 0,
          "RowNo": 1
        }
      ]
    }
  ]
}