SNARTA

info@snarta.com

+7 499 677-22-98

Товары

Свойства товара

id - идентификатор товара

  • Строка до 64 символов
  • Обязательно к заполнению

category_id - идентификатор категории

  • Строка до 64 символов
  • Обязательно к заполнению

name - наименование товара

  • Строка до 64 символов
  • Обязательно к заполнению

status - статус товара

  • Натуральное число
  • Обязательно к заполнению
  • Допустимые значения:
    • 0 - Присуствует в каталоге
    • 1 - Снят с продажи

quantum - квант заказываемого количества

  • Натуральное число
  • Обязательно к заполнению
  • Максимальное значение - 2147483647

qty_min - миниальноe количество для заказа

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию - 0
  • Минимальное значение - 0
  • Максимальное значение - 2147483647

qty_max - максимальное количество для заказа

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию - 0
  • Минимальное значение - 0
  • Максимальное значение - 2147483647

weight - вес одной единицы товара в граммах

  • Натуральное число
  • Обязательно к заполнению
  • Максимальное значение - 2147483647

weight_price - вес товара в граммах за который назначается цена

  • Натуральное число
  • Обязательно к заполнению
  • Минимальное значение - 0
  • Максимальное значение - 2147483647

shelf_life - срок годности товара в сутках

  • Натуральное число
  • Значение по-умолчанию — 0
  • Минимальное значение - 0
  • Максимальное значение - 32767

ingredients - состав продукта

  • Строка
  • Значение по-умолчанию — пустая строка

description - описание товара

  • Строка
  • Значение по-умолчанию — пустая строка

sku - артикул товара

  • Строка до 32 символов
  • Опциональный параметр

qty_on_hand - количество товара на складе

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — не указано (поле отсутствует в ответе)
  • Минимальное значение - 0

Примеры

{
  "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
  "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
  "name": "Хлеб для завтрака тостовый",
  "status": 0,
  "quantum": 1,
  "qty_min": 4,
  "qty_on_hand": 120,
  "weight": 450,
  "weight_price": 0,
  "shelf_life": 10,
  "ingredients": "мука высшего сорта, вода, дрожжи, соль",
  "description": "Тостовый хлеб для завтрака со злаками",
  "sku": "HLEB-TOST-450"
}

Показать список товаров

GET /v2/items

Параметры URL

page — номер страницы результатов запроса

  • Натуральное число
  • Опциональный параметр
  • Значение по-умолчанию — 1

Пример запроса

curl --request GET \
  --url https://api.snarta.com/v2/items \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'
curl --request GET \
  --url 'https://api.snarta.com/v2/items?page=3' \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

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

{
  "items": [
    {
      "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
      "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
      "name": "Хлеб для завтрака тостовый",
      "status": 0,
      "quantum": 1,
      "qty_min": 4,
      "qty_on_hand": 120,
      "weight": 450,
      "weight_price": 0,
      "shelf_life": 10,
      "ingredients": "мука высшего сорта, вода, дрожжи, соль",
      "description": "Тостовый хлеб для завтрака со злаками",
      "sku": "HLEB-TOST-450"
    },
    {
      "id": "f870cee1-8d4c-4a96-bea9-4aefd573064b",
      "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
      "name": "Булочка с вишневым вареньем",
      "status": 0,
      "quantum": 1,
      "qty_min": 4,
      "weight": 60,
      "weight_price": 0,
      "shelf_life": 12,
      "ingredients": "",
      "description": ""
    }    
  ]
}

Показать товар

GET /v2/items/[id]

Параметры URL

id — идентификатор товара

  • Строка до 64 символов
  • Обязательно к заполнению

Пример запроса

curl --request GET \
  --url https://api.snarta.com/v2/items/620e888a-fa0f-4081-ae68-562a6cd6d940 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

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

{
  "item": [
    {
      "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
      "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
      "name": "Хлеб для завтрака тостовый",
      "status": 0,
      "quantum": 1,
      "qty_min": 4,
      "qty_on_hand": 120,
      "weight": 450,
      "weight_price": 0,
      "shelf_life": 10,
      "ingredients": "мука высшего сорта, вода, дрожжи, соль",
      "description": "Тостовый хлеб для завтрака со злаками",
      "sku": "HLEB-TOST-450"
    }    
  ]
}

Ответы с ошибкой

{}

Создать товар

POST /v2/items

Пример запроса

curl --request POST \
  --url https://api.snarta.com/v2/items \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
  "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
  "name": "Хлеб для завтрака тостовый",
  "status": 0,
  "quantum": 1,
  "qty_min": 4,
  "qty_max": 20,
  "qty_on_hand": 120,
  "weight": 450,
  "weight_price": 0,
  "shelf_life": 10,
  "ingredients": "мука высшего сорта, вода, дрожжи, соль",
  "description": "Тостовый хлеб для завтрака со злаками",
  "sku": "HLEB-TOST-450"
}'

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

{
  "item": {
    "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
    "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
    "name": "Хлеб для завтрака тостовый",
    "status": 0,
    "quantum": 1,
    "qty_min": 4,
    "qty_max": 20,
    "qty_on_hand": 120,
    "weight": 450,
    "weight_price": 0,
    "shelf_life": 10,
    "ingredients": "мука высшего сорта, вода, дрожжи, соль",
    "description": "Тостовый хлеб для завтрака со злаками",
    "sku": "HLEB-TOST-450"
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.", 
  "name": "The name must be a string."
}
{
  "id": "Duplicate value."
}

Изменить товар

PUT /v2/items/[id]

Параметры URL

id — идентификатор товара

  • Строка до 64 символов
  • Обязательно к заполнению

Пример запроса

curl --request PUT \
  --url https://api.snarta.com/v2/items/620e888a-fa0f-4081-ae68-562a6cd6d940 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
  "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
  "name": "Хлеб для завтрака тостовый",
  "status": 0,
  "quantum": 1,
  "qty_min": 4,
  "qty_max": 20,
  "qty_on_hand": 120,
  "weight": 450,
  "weight_price": 0,
  "shelf_life": 10,
  "ingredients": "мука высшего сорта, вода, дрожжи, соль",
  "description": "Тостовый хлеб для завтрака со злаками",
  "sku": "HLEB-TOST-450"
}'

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

{
  "item": {
    "id": "620e888a-fa0f-4081-ae68-562a6cd6d940",
    "category_id": "73d978e0-2a2b-4b06-acb9-9591f08a842d",
    "name": "Хлеб для завтрака тостовый",
    "status": 0,
    "quantum": 1,
    "qty_min": 4,
    "qty_max": 20,
    "qty_on_hand": 120,
    "weight": 450,
    "weight_price": 0,
    "shelf_life": 10,
    "ingredients": "мука высшего сорта, вода, дрожжи, соль",
    "description": "Тостовый хлеб для завтрака со злаками",
    "sku": "HLEB-TOST-450"
  }
}

Ответы с ошибкой

{
  "id": "The id field is required.",
  "name": "The name must be a string."
}
{}