Номенклатура

Nomenclature - даний метод дозволяє керувати даними про номенклатуру.

Структура моделі

id (number) - Внутрішній ідентифікатор SaleApp

external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API 

sku (string) - Артикул товару

name (string) - Назва товару

cost (number) - Ціна продажу

max_discount (number) - Максимальний відсоток знижки

markdown (number) - Відсоток уцінки товару

promo_percent (number) - Акційний відсоток знижки

promo_end_date (datetime) - Дата закінчення акції на товар

date_entered (datetime) - Дата та час створення

date_update (datetime) - Дата та час останнього редагування

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

id (number) - Внутрішній ідентифікатор SaleApp

external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API

page (number) - Порядковий номер сторінки для отримання посторінкового виводу всіх записів.

На одну сторінку повертається 20 записів. 

Якщо вказано параметр page більше нуля, то параметри id та external_id будуть проігноровані та результатом обробки буде масив усіх записів вказаної сторінки виводу.

Якщо параметр page не вказано або він дорівнює нулю, то пошук буде проведено по параметрам id та external_id. Якщо вказані обидва параметри, то приорітет пошуку буде надано id. Результатом обробки буде об'єкт з даними одного запису.

Параметри GET JSON відповіді

error - Наявність помилок при обробці запиту. true - наявні помилки, false - успішно оброблено 

error_description - Опис наявних помилок в обробці запиту

response - Об'єкт або масив даних моделі при успішному виконанні запиту

all_rows_qty - Кількість усіх записів що зберігаються у системі

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

external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API 

sku (string) - Артикул товару

name (string) - Назва товару

cost (number) - Ціна продажу

max_discount (number) - Максимальний відсоток знижки

markdown (number) - Відсоток уцінки товару

promo_percent (number) - Акційний відсоток знижки

promo_end_date (datetime) - Дата закінчення акції на товар

Всі поля обов`язкові при надсиланні запиту. За результатами успішності виконання запиту, буде створено нову номенклатуру та повернуто у відповіді ідентифікатор створеного запису create_id. 

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

id (number) - Внутрішній ідентифікатор SaleApp

external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API 

sku (string) - Артикул товару

name (string) - Назва товару

cost (number) - Ціна продажу

max_discount (number) - Максимальний відсоток знижки

markdown (number) - Відсоток уцінки товару

promo_percent (number) - Акційний відсоток знижки

promo_end_date (datetime) - Дата закінчення акції на товар

Пошук запису для оновлення проводиться по id або external_id тому для успішності виконання, повинен обов'язково бути вказаний один з цих параметрів. Якщо вказані обидва параметри, то приорітет пошуку буде надано id.

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

id (number) - Внутрішній ідентифікатор SaleApp

external_id (number) - Зовнішній ідентифікатор що був переданий при створенні запису по API

Пошук запису для видалення проводиться по id або external_id тому для успішності виконання, повинен обов'язково бути вказаний один з цих параметрів. Якщо вказані обидва параметри, то приорітет пошуку буде надано id.

Параметри POST PUT DELETE JSON відповіді

error - Наявність помилок при обробці запиту. true - наявні помилки, false - успішно оброблено 

error_description - Опис наявних помилок в обробці запиту

create_id - Ідентифікатор створеного запису (повертається лише при надсиланні POST запиту) 

Приклад використання php

# Приклад php curl запиту з пошуком по id

$post = [
  'method_type' => 'GET',
  'id' => 26
];
$ch = curl_init(".../Nomenclature?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);

# JSON відповідь

{
  "error":"false",
  "error_description":"",
  "response":{
   "id":"26",
   "external_id":"0",
   "sku":"UA22",
   "name":"Ушанка чорна",
   "cost":"456.2",
   "max_discount":"100",
   "markdown":"0",
   "promo_percent":"0",
   "promo_end_date":"0000-00-00",
   "date_entered":"2021-11-16 21:58:42",
   "date_update":"2021-11-19 11:35:43"
  }
}

# Приклад php curl запиту з посторінковим виводом

$post = [
  'method_type' => 'GET',
  'page' => 1
];
$ch = curl_init(".../Nomenclature?secret_key={Ключ}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
$response = curl_exec($ch);
curl_close($ch);

# JSON відповідь

{
  "error":"false",
  "error_description":"",
  "response":[
   {
     "id":"138",
     "external_id":"0",
     "sku":"16FRT",
     "name":"Флешка 16 Гб FRT",
     "cost":"100",
     "max_discount":"5",
     "markdown":"10",
     "promo_percent":"10",
     "promo_end_date":"2022-03-31",
     "date_entered":"2022-01-14 00:32:57",
     "date_update":"2022-03-25 15:27:32"
   },
   {
     "id":"139",
     "external_id":"0",
     "sku":"32FRT",
     "name":"Флешка 32 Гб FRT",
     "cost":"0",
     "max_discount":"100",
     "markdown":"0",
     "promo_percent":"0",
     "promo_end_date":"0000-00-00",
     "date_entered":"2022-01-14 00:32:57",
     "date_update":"2022-01-14 00:32:57"
   },
   ........
  ],
  "all_rows_qty":114
}