Name | Use | Comment |
retval | result code | 0 - request sent |
retdesc | decryption of the request execution code | |
product | product characteristics | attribute icon - presence of a “sale”, “new”, “top” tag |
product\id | item id | |
product\id_prev | ID of the previous item in the category | |
product\id_next | ID of the next item in the category | |
product\name | item name | |
product\price | price | |
product\currency | price currency | |
product\url | URL of Item | |
product\info | product description | |
product\add_info | additional information about the product | |
product\release_date | product release date | for products of the “preorder” type |
product\agency_fee | agent commission | |
product\agency_sum | agent commission | |
product\agency_id | agent ID | |
product\collection | type of item | book - e-book | digi - digital product | pins - pin codes | soft - software | unit - non-fixed price item |
product\propertygood | content of the item | 1 - universal, 2 - unique |
product\is_available | product availability | 0 - the product is out of stock 1 - the product is in stock |
product\show_rest | visibility of the quantity | 0 - hiding 1 - no hiding, the value in the parameter num_in_stock |
product\num_in_stock | the quantity of products available for purchase | To get this information, you need to either pass the owner token or enable showing the remainder in the product settings. This parameter is inaccessible by default. see description of input parameter token. |
product\num_in_lock | number of items reserved for payment | |
product\prices | main price indicators | Applicable only for products with a fixed price (collection != Unit). Calculate the unit cost of a non-fixed price item (collection == unit) using this API method . |
product\prices\initial | base price | |
product\prices\initial\currency | currency | |
product\prices\initial\price | price | |
product\prices\default | primary payment method price | |
product\prices\default\currency | currency | |
product\prices\default\price | price | |
product\payment_methods | methods of payment | |
product\payment_methods\name | payment method | |
product\payment_methods\currencies | currency list | |
product\payment_methods\currencies\currency | currency | |
product\payment_methods\currencies\code | three-character payment method code | |
product\payment_methods\currencies\price | price | |
product\payment_methods\currencies\limit | payment method restrictions (if any) | |
product\payment_methods\currencies\limit\min | minimum payment | |
product\payment_methods\currencies\limit\max | maximum payment | |
product\payment_methods\currencies\limit\currency | currency | |
product\prices_unit | price of a unique item with a non-fixed price | |
product\prices_unit\unit_name | unit name | |
product\prices_unit\unit_amount | item unit | |
product\prices_unit\unit_amount_desc | item unit | |
product\prices_unit\unit_currency | currency | |
product\prices_unit\unit_cnt | quantity | |
product\prices_unit\unit_cnt_min | minimum purchase is | |
product\prices_unit\unit_cnt_max | maximum purchase is | |
product\prices_unit\unit_cnt_desc | info | |
product\prices_unit\unit_fixed | fixed values for the number of units | |
product\prices_unit\unit_only_int | whole number only (not fractional) | |
product\preview_imgs | thumbnail image parameters | |
product\preview_imgs\id | id | |
product\preview_imgs\url | the URL of the real image | |
product\preview_imgs\width | the width of the image in pixels | |
product\preview_imgs\height | the height of the image in pixels | |
product\preview_videos | preview video parameters | |
product\preview_videos\type | the video type | youtube or vimeo |
product\preview_videos\id | id | |
product\preview_videos\preview | the video preview image | |
product\preview_imgs | thumbnail image parameters | attribute cnt - the number of images |
product\preview_imgs\preview_img | image parameters | attribute id |
product\preview_imgs\preview_img\img_small | URL of small image | attribute width-the width of the image in pixels the height attribute – height of the image in pixels |
product\preview_imgs\preview_img\img_real | the URL of the real image | attribute width-the width of the image in pixels the height attribute – height of the image in pixels |
product\preview_videos | preview video parameters | attribute cnt - the number of videos |
product\preview_videos\preview_video\video_type | the video type | youtube or vimeo |
product\preview_videos\preview_video\video_id | id | |
product\preview_videos\preview_video\video_preview | the video preview image | |
product\type | type of item | text - product as a text file – product as a file |
product\text | product parameters (“text” product type) | |
product\text\date | the date of publishing | format: DD.MM.YYYY h:mm:ss |
product\text\size | number of symbols | |
product\file | product options (type of item file) | |
product\file\date | the date of publishing | format: DD.MM.YYYY h:mm:ss |
product\file\size | file size (bytes) | |
product\file\name | file name | |
product\file\trial | the URL of the trial version of the product | |
product\category_id | category id | To get this information, you need to pass the value of the seller_id input parameter. |
product\breadcrumbs | the path to the category | To get this information, you need to pass the value of the seller_id input parameter. |
product\breadcrumbs\id | category id | |
product\breadcrumbs\name | category name | |
product\breadcrumbs\products_cnt | number of items of category | |
product\categories | the path to the category | To get this information, you need to pass the value of the seller_id input parameter. |
product\categories\category | the category list | attribute cnt - number of items of category |
product\categories\category\id | category id | |
product\categories\category\name | category name | |
product\categories\category\category | the category list | attribute cnt - number of items of category |
product\discounts | parameters of discounts for regular customers | |
product\discounts\discount | discount parameters | |
product\discounts\discount\summa | the threshold value for the purchase amount | |
product\discounts\discount\percent | discount percentage | |
product\units | for products with a free price or a “pay as much as you want” model | |
product\units\desc | unit name | |
product\units\price | price per unit | |
product\units\discounts | discount depending on the volume of purchases of unit products | |
product\units\discounts\discount\cnt | threshold volume of purchase units | |
product\units\discounts\discount\desc | threshold volume of purchase units in text | |
product\units\discounts\discount\percent | discount percentage | |
product\units\discounts\discount\price | price | |
product\present | present | |
product\present\id | present ID | |
product\present\name | present name | |
product\gift_commiss | the percentage of the value of the goods allocated to the gift | |
product\options | product parameters that the buyer defines on the payment form (if they are defined) | |
product\options\option | model of the product parameter | |
product\options\option\name | the system id of the parameter | |
product\options\option\label | the text name of the parameter | |
product\options\option\comment | the description (tip) of the parameter | |
product\options\option\type | parameter type | (textarea | checkbox | text | radio | select) |
product\options\option\separate_content | indication of separate content by product parameter variant | 0 | 1 |
product\options\option\required | the sign of compulsoriness for parameter definition by the buyer | |
product\options\option\modifier_visible | hide price modifier | |
product\options\option\variants | a set of limited variants of parameter values (for checkbox, radio, select types) | |
product\options\option\variants\variant | an option | |
product\options\option\variants\variant\value | option value | |
product\options\option\variants\variant\text | option label | |
product\options\option\variants\variant\default | is option selected by default | |
product\options\option\variants\variant\modify | change in the price of goods when choosing this option | |
product\options\option\variants\variant\modify_type | type of price change (currency, if absolute value or %, if percentage change) | % | USD | RUB | EUR | UAH |
product\options\option\variants\variant\modify_value | price change value (in modify_type units) | |
product\options\option\variants\variant\modify_value_default | price change value in primary payment method | |
product\options\option\variants\variant\num_in_stock | the quantity of products available for purchase; relevant if separate content by product parameter variant is set | To get this information, you need to either pass the owner token or enable showing the remainder in the product settings. This parameter is inaccessible by default. see description of input parameter token. |
product\options\option\variants\variant\visible | visibility | 1 - not hidden otherwise - hidden |
product\options_check | indicator of the enabled option "before paying, send the parameters to my server to be checked” (defined in product Parameters) | 0 | 1 |
product\statistics | product statistics parameters | |
product\statistics\sales | the number of sales | int; -1 means completely hidden |
product\statistics\sales_hidden | display mode of sales number | 0 - sales are visible 1 - sales are hidden (real number of sales > sales) |
product\statistics\refunds | number of refunds | -1 means completely hidden |
product\statistics\refunds_hidden | refunds number display mode | 0 - refunds are visible 1 - refunds are hidden (real number or refunds > refunds) |
product\statistics\good_reviews | the number of positive reviews | int; -1 means completely hidden |
product\statistics\good_reviews_hidden | display mode of the number of good responses | 0 - good reviews are visible 1 - good reviews are hidden (real number or good reviews > good_reviews) |
product\statistics\bad_reviews | the number of negative reviews | int; -1 means completely hidden |
product\statistics\bad_reviews_hidden | display mode of the number of bad responses | 0 - bad reviews are visible 1 - bad reviews are hidden (real number or bad reviews > bad_reviews) |
product\seller | seller | |
product\seller\id | seller ID | |
product\seller\name | present if not passed as a request parameter | |
product\sale_info | sale information | |
product\sale_info\common_base_price | base price before sale | |
product\sale_info\common_price_usd | price before sale. currency: USD | |
product\sale_info\common_price_rub | price before sale. currency: RUB | |
product\sale_info\common_price_eur | price before sale. currency: EUR | |
product\sale_info\common_price_uah | price before sale. currency: UAH | |
product\sale_info\sale_end | sale expiration date | |
product\sale_info\sale_percent | discount percent | |