Details of the commodity position of the Price List (XPriceListElement object)

JSON:

{
  "category_name": "Кава",
  "children": [
    {
      "category_name": "Жокей",
      "children": [
        {
          "category_name": "Зернову",
          "children": [],
          "prods": [
            {
              "article": "7115",
              "name": "\"Класичний\"  250х16 зернова кава Жокей Укр",
              "barcode": "4820022867438",
              "producer_code": "BP08333",
              "user_code": "901120000",
              "unit_weight": "1.2",
              "box_qty": "16",
              "box_weight": "19.2",
              "box_in_layer": "4",
              "box_in_palette": "8",
              "palette_weight": "78.65",
              "id": 11,
              "producer_id": 13200791,
              "product_id": 150,
              "unit_id": 8,
              "stock_balance": 100,
              "price_without_vat": 57.75,
              "price_with_vat": 69.3,
              "date_to": 0,
              "date_from": 0,
              "date_changed": 1648049515,
              "vat": 5,
              "quota": 25,
              "comment": "Коментар",
              "is_new": false,
              "is_promo": true,
              "is_surcharge": false,
              "is_pickup": false,
              "regions": "Запорізька"
            }
          ]
        }
      ],
      "prods": []
    }
  ],
  "prods": []
}

Table 1 - Parameters description

Parameter

Mandatory/Optional

Format

Description

Object XPriceListElement

category_id

O

long

identifier

  • for Distribution service: line / category / subcategory

  • for Have Product service: category / group / subgroup

category_name

M

String

name

  • for Distribution service: line / category / subcategory

  • for Have Product service: category / group / subgroup

children

O/M

List<XPriceListElement>

array of objects;

  • for Distribution service: category / subcategory data

  • for Have Product service: group / subgroup data

prods

M

List<XPriceListProduct>

array of objects; product data

Table 2 - Parameters description of object XPriceListProduct

Parameter

Mandatory/Optional

Format

Description

Object XPriceListProduct

group_id

long

group ID

article

M

String

article

name

M

String

the name of the product

barcode

M

String

barcode

user_code

O

String

УКТ ЗЕД code

unit_weight

O

String

unit weight, kg

box_qty

M

String

units in a box

box_weight

O

String

box weight, kg

box_in_layer

O

String

number of boxes in a layer, pcs.

box_in_palette

O

String

number of boxes per pallet, pcs.

palette_weight

O

String

pallet weight, kg

producer_code

O

String

Seller (Manufacturer) Code

min_order_qty

O

float (10.3)

Minimum order quantity

regions

M

String

region / countries of availability of the goods (list of names through a comma)

id

long

item identifier

date_created

long

the date the product was created

date_changed

long

date of changes in product data

producer_id

long

Seller ID

product_id

long

product identifier

unit_id

O

long

unit identifier; valid values:

  • 2 - kilogram;

  • 8 - piece

price_without_vat

M

Double

unit price without VAT, UAH

vat

O

int

VAT rate,%

price_with_vat

O

Double

unit price including VAT, UAH

date_from

long

period from

date_to

long

period of validity

stock_balance

O

Double

balance

comment

O

String

comments

quota

O

Double

quota to order

is_promo

O

boolean

«Novelty!» mark

is_new

O

boolean

«Action!» mark

is_public

O

boolean

«Public!» mark

is_surcharge

O

boolean

«Surcharge!» mark

is_pickup

O

boolean

«In-pickup!» mark