Get List of Margins v 3.0 catalog.extra.list

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: catalog

Who can execute the method: a user with the "View product catalog", "Edit selling price", or "Manage mark-ups" access permission

The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.

The catalog.extra.list method returns a list of markups with filtering, sorting, and pagination.

Method Parameters

Name
type

Description

select
array

An array of markup fields to return in the response.

Available fields:

  • id — markup identifier
  • name — markup name
  • percentage — markup value in percent

The ["*"] value is not supported.

Default: all fields

filter
array

A filter in the REST 3.0 format: an array of conditions in the form ["field", "operator", "value"]. You can filter by all fields from select.

The syntax and operators are described in the REST 3.0 overview

order
object

Sorting in the {"field": "direction"} format. You can sort by all fields from select.

Possible direction values:

  • ASC — ascending
  • DESC — descending

The direction is case-insensitive.

Default: {"id": "ASC"}

pagination
object

Pagination object. Object structure description

Parameter pagination

Name
type

Description

limit
integer

Number of markups per page. Values greater than 1000 are reduced to 1000. Zero, a negative value, or a non-numeric value causes an error.

Default: 50

page
integer

Page number, starting from 1. The offset is calculated as (page - 1) × limit. Zero and a negative value return the first page.

If page is passed, the offset parameter is ignored

offset
integer

Number of markups to skip from the beginning of the list. A negative value causes an error.

Default: 0

The response does not contain the total number of markups. If a page returns fewer records than specified in limit, it is the last page.

Code Examples

How to Use Examples in Documentation

The new API call differs by adding the /api/ segment to the request URL:

https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.extra.list

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","percentage"],"filter":[["percentage",">",0]],"order":{"percentage":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.extra.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","name","percentage"],"filter":[["percentage",">",0]],"order":{"percentage":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.extra.list
        
import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type Extra = {
          id: number
          name: string
          percentage: number
        }
        
        type ExtraListResult = {
          items: Extra[]
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ExtraListResult>({
            method: 'catalog.extra.list',
            params: {
              select: ['id', 'name', 'percentage'],
              filter: [
                ['percentage', '>', 0],
              ],
              order: {
                percentage: 'desc',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Extras:', result.items)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function listExtras() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.extra.list',
                params: {
                  select: ['id', 'name', 'percentage'],
                  filter: [
                    ['percentage', '>', 0],
                  ],
                  order: {
                    percentage: 'desc',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Extras:', result.items)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', listExtras)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.extra.list(
                select=["id", "name", "percentage"],
                filter=[
                    ["percentage", ">", 0],
                ],
                order={
                    "percentage": "desc",
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected error: {error}")
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.extra.list',
                    [
                        'select' => ['id', 'name', 'percentage'],
                        'filter' => [
                            ['percentage', '>', 0],
                        ],
                        'order' => [
                            'percentage' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error: ' . $e->getMessage();
        }
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

BX24.callMethod(
            'catalog.extra.list',
            {
                select: ['id', 'name', 'percentage'],
                filter: [
                    ['percentage', '>', 0],
                ],
                order: {
                    percentage: 'desc',
                },
            },
            result => {
                if (result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );
        

SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.extra.list',
            [
                'select' => ['id', 'name', 'percentage'],
                'filter' => [
                    ['percentage', '>', 0],
                ],
                'order' => [
                    'percentage' => 'desc',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "catalog.extra.list", b24.Params{
        	"select": []string{"id", "name", "percentage"},
        	"filter": []any{
        		[]any{"percentage", ">", 0},
        	},
        	"order":  b24.Params{
        		"percentage": "desc",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.extra.list: %w", err)
        }
        
        var result struct {
        	Items []struct {
        		ID         int     `json:"id"`
        		Name       string  `json:"name"`
        		Percentage float64 `json:"percentage"`
        	} `json:"items"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parsing the response: %w", err)
        }
        for _, item := range result.Items {
        	fmt.Println(item.ID, item.Name, item.Percentage)
        }
        

Response Handling

HTTP status: 200

{
            "result": {
                "items": [
                    {
                        "id": 1,
                        "name": "Markup1",
                        "percentage": 10
                    }
                ]
            },
            "time": {
                "start": 1792668104,
                "finish": 1792668104.106381,
                "duration": 0.10638093948364258,
                "processing": 0,
                "date_start": "2026-10-22T14:21:44+02:00",
                "date_finish": "2026-10-22T14:21:44+02:00",
                "operating_reset_at": 1792668660,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with the response data

result.items
array

Array of markups on the page. Element field description

time
time

Information about the request execution time

Items Element

The set of fields depends on select.

Name
type

Description

id
integer

Markup identifier

name
string

Markup name, up to 50 characters

percentage
double

Markup value in percent

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION",
                "message": "Unknown field \"foo\" found in entity \"ExtraDto\"."
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field

Error description

How to Fix

#FIELD#

This request requires data type #TYPE# in field #FIELD#

Pass a value of the required type in the filter, for example a number for percentage

Filter Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Field

Error description

How to Fix

filter

Invalid filter Unknown filter condition

Pass filter as an array of conditions, for example [["percentage",">",0]]

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Field

Error description

How to Fix

filter

Unknown filter operator #OPERATOR#

Use the operators from the REST 3.0 overview

Sorting Errors

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Field

Error description

How to Fix

order

Invalid sort order #ORDER#

Pass order as an object, for example {"id":"ASC"}, with the ASC or DESC direction

Pagination Error

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Field

Error description

How to Fix

pagination

Incorrect pagination parameter value: #PAGINATION#

Pass a positive number in limit and a non-negative number in offset

Unknown Field Errors

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

select, filter, order

Unknown field #FIELD# found in entity ExtraDto

Use only the id, name, and percentage fields

Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION

Field

Error description

How to Fix

select

Invalid field in select: #SELECT#

Pass select as an array of strings, for example ["id"]

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field

Error description

How to Fix

-

Access denied

Make sure the user has the "View product catalog", "Edit selling price", or "Manage mark-ups" access permission

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning