Data of the goods included in the Price list (XPriceList object)

JSON:

{
  "period": {
    "date_from": 0,
    "date_to": 0
  },
  "price": [
    {
      "category_name": "Чай",
      "children": [
        {
          "category_name": "Грінфілд",
          "children": [
            {
              "category_name": "Листовий ж/б",
              "children": [],
              "prods": [
                {
                  "regions": "Дніпропетровська,Харківська,Сумська,Полтавська",
                  "article": "6181",
                  "name": "Ж/Б Oriental Spirits 125гр.х14п.\"Грінфілд\" Укр",
                  "barcode": "4820022865830",
                  "producer_code": "BP0836",
                  "user_code": "902200010",
                  "unit_weight": "0.4",
                  "box_qty": "14",
                  "box_weight": "5.6",
                  "box_in_layer": "3",
                  "box_in_palette": "9",
                  "palette_weight": "99.18",
                  "unit_id": "8",
                  "stock_balance": "100",
                  "price_without_vat": "66.05",
                  "price_with_vat": "79.26",
                  "vat": "5",
                  "quota": "25",
                  "comment": "Коментар",
                  "is_new": true,
                  "is_promo": false,
                  "is_pickup": true
                }
              ]
            }
          ],
          "prods": []
        }
      ],
      "prods": []
    },
    {
      "category_name": "Кава",
      "children": [
        {
          "category_name": "Жокей",
          "children": [
            {
              "category_name": "Зернову",
              "children": [],
              "prods": [
                {
                  "regions": "Португалія",
                  "article": "7127",
                  "name": "\"Традиційний\"  400х12 зернова кава Жокей Укр",
                  "barcode": "4820022867421",
                  "producer_code": "BP0837",
                  "user_code": "901120000",
                  "unit_weight": "0.321",
                  "box_qty": "12",
                  "box_weight": "3.852",
                  "box_in_layer": "5",
                  "box_in_palette": "10",
                  "palette_weight": "25.75",
                  "unit_id": "8",
                  "stock_balance": "100",
                  "price_without_vat": "80.05",
                  "price_with_vat": "96.06",
                  "vat": "5",
                  "quota": "25",
                  "comment": "Коментар",
                  "is_new": false,
                  "is_promo": false,
                  "is_pickup": false
                },
                {
                  "regions": "Запорізька",
                  "article": "7115",
                  "name": "\"Класичний\"  250х16 зернова кава Жокей Укр",
                  "barcode": "4820022867438",
                  "producer_code": "BP0838",
                  "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",
                  "unit_id": "8",
                  "stock_balance": "100",
                  "price_without_vat": "57.75",
                  "price_with_vat": "69.3",
                  "vat": "5",
                  "quota": "25",
                  "comment": "Коментар",
                  "is_new": false,
                  "is_promo": true,
                  "is_pickup": false
                }
              ]
            }
          ],
          "prods": []
        }
      ],
      "prods": []
    }
  ],
  "distributors": []
}

Table 1 - Parameters description of object XPriceList

Parameter

Mandatory/Optional

Format

Description

Object XPriceList

period

XPriceListPeriod

object; period of validity of product data

price

M

List<XPriceListElement>

array of objects; Price list product data

distributors

List<XPriceListDistributor>

array of objects; data of Buyers (Distributors)

Table 2 - Parameters description of object XPriceListPeriod

Parameter

Mandatory/Optional

Format

Description

Object XPriceListPeriod

date_from

long

start period of validity

date_to

long

end period of validity

Table 3 - Parameters description of object XPriceListElement

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 4 - Parameters description of object XPriceListDistributor

Parameter

Mandatory/Optional

Format

Description

Object XPriceListDistributor

name

String

name of the Buyer (Distributor)

id

long

Buyer (Distributor) ID

gln

String

Buyer (Distributor) GLN

Table 5 - 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