Get a list of delivery services sale.delivery.getlist

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: sale

Who can execute the method: CRM administrator

The method sale.delivery.getlist retrieves a list of delivery services.

Method Parameters

Required parameters are marked with *

Name
type

Description

SELECT
array

An array containing the list of fields to select (see fields of the object sale_delivery_service).

If not provided or an empty array is passed, all available fields of delivery services will be selected.

FILTER
object

An object for filtering the selected delivery services in the format {"field_1": "value_1", ... "field_N": "value_N"}.

Possible values for field correspond to the fields of the object sale_delivery_service.

An additional prefix can be assigned to the key to specify the filter behavior. Possible prefix values:

  • = — equals (works with arrays as well)
  • % — LIKE, substring search. The % symbol in the filter value does not need to be passed. The search looks for the substring at any position in the string.
  • > — greater than
  • < — less than
  • != — not equal
  • !% — NOT LIKE, substring search. The % symbol in the filter value does not need to be passed. The search goes from both sides.
  • >= — greater than or equal to
  • <= — less than or equal to
  • =% — LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values starting with "mol"
    • "%mol" — searching for values ending with "mol"
    • "%mol%" — searching for values where "mol" can be at any position
  • %= — LIKE (see description above)
  • !=% — NOT LIKE, substring search. The % symbol needs to be passed in the value. Examples:
    • "mol%" — searching for values not starting with "mol"
    • "%mol" — searching for values not ending with "mol"
    • "%mol%" — searching for values where the substring "mol" is not present at any position
  • !%= — NOT LIKE (see description above)

ORDER
object

An object for sorting the selected delivery services in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the object sale_delivery_service.

Possible values for order:

  • asc — in ascending order
  • desc — in descending order

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PARENT_ID","NAME","ACTIVE","DESCRIPTION","SORT","CURRENCY"],"FILTER":{"@ID":[196,197,198]},"ORDER":{"SORT":"ASC","ID":"DESC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.delivery.getlist
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"SELECT":["ID","PARENT_ID","NAME","ACTIVE","DESCRIPTION","SORT","CURRENCY"],"FILTER":{"@ID":[196,197,198]},"ORDER":{"SORT":"ASC","ID":"DESC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.delivery.getlist
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        // Shape of each DeliveryService returned in result[]
        type DeliveryService = {
          ID: number
          PARENT_ID: number | null
          NAME: string
          ACTIVE: string
          DESCRIPTION: string
          SORT: number
          CURRENCY: string
        }
        
        try {
          // sale.delivery.getlist returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<DeliveryService[]>({
            method: 'sale.delivery.getlist',
            params: {
              SELECT: ['ID', 'PARENT_ID', 'NAME', 'ACTIVE', 'DESCRIPTION', 'SORT', 'CURRENCY'],
              FILTER: {
                '@ID': [196, 197, 198],
              },
              ORDER: {
                SORT: 'ASC',
                ID: 'DESC',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Delivery services (%d):', result.length, result)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function getDeliveryList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // sale.delivery.getlist returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'sale.delivery.getlist',
                params: {
                  SELECT: ['ID', 'PARENT_ID', 'NAME', 'ACTIVE', 'DESCRIPTION', 'SORT', 'CURRENCY'],
                  FILTER: {
                    '@ID': [196, 197, 198],
                  },
                  ORDER: {
                    SORT: 'ASC',
                    ID: 'DESC',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Delivery services (%d):', result.length, result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getDeliveryList)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.sale.delivery.getlist(
                select=[
                    "ID",
                    "PARENT_ID",
                    "NAME",
                    "ACTIVE",
                    "DESCRIPTION",
                    "SORT",
                    "CURRENCY",
                ],
                filter={
                    "@ID": [
                        196,
                        197,
                        198,
                    ],
                },
                order={
                    "SORT": "ASC",
                    "ID": "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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.delivery.getlist',
                    [
                        'SELECT' => [
                            "ID",
                            "PARENT_ID",
                            "NAME",
                            "ACTIVE",
                            "DESCRIPTION",
                            "SORT",
                            "CURRENCY",
                        ],
                        'FILTER' => [
                            '@ID' => [196, 197, 198],
                        ],
                        'ORDER' => [
                            'SORT' => "ASC",
                            'ID'   => "DESC",
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting delivery list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.delivery.getlist', {
                SELECT: [
                    "ID",
                    "PARENT_ID",
                    "NAME",
                    "ACTIVE",
                    "DESCRIPTION",
                    "SORT",
                    "CURRENCY",
                ],
                FILTER: {
                    "@ID": [196, 197, 198],
                },
                ORDER: {
                    SORT: "ASC",
                    ID: "DESC",
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.delivery.getlist',
            [
                'SELECT' => [
                    "ID",
                    "PARENT_ID",
                    "NAME",
                    "ACTIVE",
                    "DESCRIPTION",
                    "SORT",
                    "CURRENCY",
                ],
                'FILTER' => [
                    "@ID" => [196, 197, 198],
                ],
                'ORDER' => [
                    "SORT" => "ASC",
                    "ID" => "DESC",
                ]
            ]
        );
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "sale.delivery.getlist", b24.Params{
        	"SELECT": []string{"ID", "PARENT_ID", "NAME", "ACTIVE", "DESCRIPTION", "SORT", "CURRENCY"},
        	"FILTER": b24.Params{
        		"@ID": []int{196, 197, 198},
        	},
        	"ORDER": b24.Params{
        		"SORT": "ASC",
        		"ID":   "DESC",
        	},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("sale.delivery.getlist: %w", err)
        }
        
        var items []struct {
        	Name        string `json:"NAME"`
        	Active      string `json:"ACTIVE"`
        	Description string `json:"DESCRIPTION"`
        	Currency    string `json:"CURRENCY"`
        	ID          b24.ID `json:"ID"`
        	ParentID    b24.ID `json:"PARENT_ID"`
        }
        if err := json.Unmarshal(res.Result, &items); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.Name, it.Active)
        }
        

Response Handling

HTTP status: 200

{
            "result":[
                {
                    "NAME":"Cargo",
                    "ACTIVE":"Y",
                    "DESCRIPTION":"Cargo Delivery",
                    "CURRENCY":"USD",
                    "ID":198,
                    "PARENT_ID":196,
                    "SORT":500
                },
                {
                    "NAME":"Taxi",
                    "ACTIVE":"Y",
                    "DESCRIPTION":"Taxi Delivery",
                    "CURRENCY":"USD",
                    "ID":197,
                    "PARENT_ID":196,
                    "SORT":500
                },
                {
                    "NAME":"Uber Taxi",
                    "ACTIVE":"Y",
                    "DESCRIPTION":"Uber Taxi Description",
                    "CURRENCY":"USD",
                    "ID":196,
                    "PARENT_ID":null,
                    "SORT":500
                }
            ],
            "time":{
                "start":1714141661.751638,
                "finish":1714141661.945714,
                "duration":0.1940760612487793,
                "processing":0.013057947158813477,
                "date_start":"2024-04-26T17:27:41+02:00",
                "date_finish":"2024-04-26T17:27:41+02:00"
            }
        }
        

Returned Data

Name
type

Description

result
sale_delivery_service[]

An array of objects containing information about the selected delivery services

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400, 403

{
           "error":"ACCESS_DENIED",
           "error_description":"Access denied!"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Status

ERROR_CHECK_FAILURE

Validation error of incoming parameters (details in the error description)

400

ACCESS_DENIED

Insufficient rights to retrieve the list of delivery services

403

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

The REST API is available only on commercial plans. 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