Get the list of shipments sale.shipment.list

Scope: sale

Who can execute the method: administrator

This method retrieves a list of shipments.

Method Parameters

Name
type

Description

select
array

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

filter
object

An object for filtering the selected payment bindings to shipments in the format {"field_1": "value_1", ... "field_N": "value_N"}.

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

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 should not be passed. The search looks for the substring in any position of the string.
  • > — greater than
  • < — less than
  • != — not equal
  • !% — NOT LIKE, substring search. The % symbol in the filter value should not be passed. The search goes from both sides.
  • >= — greater than or equal to
  • <= — less than or equal to
  • =% — LIKE, substring search. The % symbol should 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 in any position
  • %= — LIKE (see description above)
  • !=% — NOT LIKE, substring search. The % symbol should 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 in any position
  • !%= — NOT LIKE (see description above)

order
object

An object for sorting the selected payment bindings to shipments in the format {"field_1": "order_1", ... "field_N": "order_N"}.

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

Possible values for order:

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

start
integer

This parameter is used to manage pagination.

The page size of results is always static: 50 records.

To select the second page of results, you need to pass the value 50. To select the third page of results, the value is 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the desired page number

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","accountNumber","allowDelivery","basePriceDelivery","canceled","comments","companyId","currency","customPriceDelivery","dateAllowDelivery","dateCanceled","dateDeducted","dateInsert","dateMarked","dateResponsibleId","deducted","deliveryDocDate","deliveryDocNum","deliveryId","deliveryName","deliveryXmlId","discountPrice","empAllowDeliveryId","empCanceledId","empDeductedId","empMarkedId","empResponsibleId","externalDelivery","id1c","marked","orderId","priceDelivery","reasonMarked","reasonUndoDeducted","responsibleId","statusId","statusXmlId","system","trackingDescription","trackingLastCheck","trackingNumber","trackingStatus","updated1c","version1c","xmlId"],"filter":{"@orderId":[2069,2070],">=id":2464},"order":{"id":"desc"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.shipment.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","accountNumber","allowDelivery","basePriceDelivery","canceled","comments","companyId","currency","customPriceDelivery","dateAllowDelivery","dateCanceled","dateDeducted","dateInsert","dateMarked","dateResponsibleId","deducted","deliveryDocDate","deliveryDocNum","deliveryId","deliveryName","deliveryXmlId","discountPrice","empAllowDeliveryId","empCanceledId","empDeductedId","empMarkedId","empResponsibleId","externalDelivery","id1c","marked","orderId","priceDelivery","reasonMarked","reasonUndoDeducted","responsibleId","statusId","statusXmlId","system","trackingDescription","trackingLastCheck","trackingNumber","trackingStatus","updated1c","version1c","xmlId"],"filter":{"@orderId":[2069,2070],">=id":2464},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.shipment.list
        
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
        
        try {
          const response = await $b24.callListMethod(
            'sale.shipment.list',
            {
              "select": [
                "id",
                "accountNumber",
                "allowDelivery",
                "basePriceDelivery",
                "canceled",
                "comments",
                "companyId",
                "currency",
                "customPriceDelivery",
                "dateAllowDelivery",
                "dateCanceled",
                "dateDeducted",
                "dateInsert",
                "dateMarked",
                "dateResponsibleId",
                "deducted",
                "deliveryDocDate",
                "deliveryDocNum",
                "deliveryId",
                "deliveryName",
                "deliveryXmlId",
                "discountPrice",
                "empAllowDeliveryId",
                "empCanceledId",
                "empDeductedId",
                "empMarkedId",
                "empResponsibleId",
                "externalDelivery",
                "id1c",
                "marked",
                "orderId",
                "priceDelivery",
                "reasonMarked",
                "reasonUndoDeducted",
                "responsibleId",
                "statusId",
                "statusXmlId",
                "system",
                "trackingDescription",
                "trackingLastCheck",
                "trackingNumber",
                "trackingStatus",
                "updated1c",
                "version1c",
                "xmlId",
              ],
              "filter": {
                ">=id": 2464,
                "@orderId": [2069, 2070],
              },
              "order": {
                "id": "desc",
              }
            },
            (progress) => { console.log('Progress:', progress) }
          );
          const items = response.getData() || [];
          for (const entity of items) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
        
        try {
          const generator = $b24.fetchListMethod('sale.shipment.list', {
            "select": [
              "id",
              "accountNumber",
              "allowDelivery",
              "basePriceDelivery",
              "canceled",
              "comments",
              "companyId",
              "currency",
              "customPriceDelivery",
              "dateAllowDelivery",
              "dateCanceled",
              "dateDeducted",
              "dateInsert",
              "dateMarked",
              "dateResponsibleId",
              "deducted",
              "deliveryDocDate",
              "deliveryDocNum",
              "deliveryId",
              "deliveryName",
              "deliveryXmlId",
              "discountPrice",
              "empAllowDeliveryId",
              "empCanceledId",
              "empDeductedId",
              "empMarkedId",
              "empResponsibleId",
              "externalDelivery",
              "id1c",
              "marked",
              "orderId",
              "priceDelivery",
              "reasonMarked",
              "reasonUndoDeducted",
              "responsibleId",
              "statusId",
              "statusXmlId",
              "system",
              "trackingDescription",
              "trackingLastCheck",
              "trackingNumber",
              "trackingStatus",
              "updated1c",
              "version1c",
              "xmlId",
            ],
            "filter": {
              ">=id": 2464,
              "@orderId": [2069, 2070],
            },
            "order": {
              "id": "desc",
            }
          }, 'id');
          for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity); }
          }
        } catch (error) {
          console.error('Request failed', error);
        }
        
        // callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
        
        try {
          const response = await $b24.callMethod('sale.shipment.list', {
            "select": [
              "id",
              "accountNumber",
              "allowDelivery",
              "basePriceDelivery",
              "canceled",
              "comments",
              "companyId",
              "currency",
              "customPriceDelivery",
              "dateAllowDelivery",
              "dateCanceled",
              "dateDeducted",
              "dateInsert",
              "dateMarked",
              "dateResponsibleId",
              "deducted",
              "deliveryDocDate",
              "deliveryDocNum",
              "deliveryId",
              "deliveryName",
              "deliveryXmlId",
              "discountPrice",
              "empAllowDeliveryId",
              "empCanceledId",
              "empDeductedId",
              "empMarkedId",
              "empResponsibleId",
              "externalDelivery",
              "id1c",
              "marked",
              "orderId",
              "priceDelivery",
              "reasonMarked",
              "reasonUndoDeducted",
              "responsibleId",
              "statusId",
              "statusXmlId",
              "system",
              "trackingDescription",
              "trackingLastCheck",
              "trackingNumber",
              "trackingStatus",
              "updated1c",
              "version1c",
              "xmlId",
            ],
            "filter": {
              ">=id": 2464,
              "@orderId": [2069, 2070],
            },
            "order": {
              "id": "desc",
            }
          }, 0);
          const result = response.getData().result || [];
          for (const entity of result) { console.log('Entity:', entity); }
        } catch (error) {
          console.error('Request failed', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.shipment.list',
                    [
                        'select' => [
                            'id',
                            'accountNumber',
                            'allowDelivery',
                            'basePriceDelivery',
                            'canceled',
                            'comments',
                            'companyId',
                            'currency',
                            'customPriceDelivery',
                            'dateAllowDelivery',
                            'dateCanceled',
                            'dateDeducted',
                            'dateInsert',
                            'dateMarked',
                            'dateResponsibleId',
                            'deducted',
                            'deliveryDocDate',
                            'deliveryDocNum',
                            'deliveryId',
                            'deliveryName',
                            'deliveryXmlId',
                            'discountPrice',
                            'empAllowDeliveryId',
                            'empCanceledId',
                            'empDeductedId',
                            'empMarkedId',
                            'empResponsibleId',
                            'externalDelivery',
                            'id1c',
                            'marked',
                            'orderId',
                            'priceDelivery',
                            'reasonMarked',
                            'reasonUndoDeducted',
                            'responsibleId',
                            'statusId',
                            'statusXmlId',
                            'system',
                            'trackingDescription',
                            'trackingLastCheck',
                            'trackingNumber',
                            'trackingStatus',
                            'updated1c',
                            'version1c',
                            'xmlId',
                        ],
                        'filter' => [
                            '>=id'     => 2464,
                            '@orderId' => [2069, 2070],
                        ],
                        'order'  => [
                            'id' => 'desc',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching shipment list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "sale.shipment.list", {
                "select": [
                    "id",
                    "accountNumber",
                    "allowDelivery",
                    "basePriceDelivery",
                    "canceled",
                    "comments",
                    "companyId",
                    "currency",
                    "customPriceDelivery",
                    "dateAllowDelivery",
                    "dateCanceled",
                    "dateDeducted",
                    "dateInsert",
                    "dateMarked",
                    "dateResponsibleId",
                    "deducted",
                    "deliveryDocDate",
                    "deliveryDocNum",
                    "deliveryId",
                    "deliveryName",
                    "deliveryXmlId",
                    "discountPrice",
                    "empAllowDeliveryId",
                    "empCanceledId",
                    "empDeductedId",
                    "empMarkedId",
                    "empResponsibleId",
                    "externalDelivery",
                    "id1c",
                    "marked",
                    "orderId",
                    "priceDelivery",
                    "reasonMarked",
                    "reasonUndoDeducted",
                    "responsibleId",
                    "statusId",
                    "statusXmlId",
                    "system",
                    "trackingDescription",
                    "trackingLastCheck",
                    "trackingNumber",
                    "trackingStatus",
                    "updated1c",
                    "version1c",
                    "xmlId",
                ],
                "filter": {
                    ">=id": 2464,
                    "@orderId": [2069, 2070],
                },
                "order": {
                    "id": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.shipment.list',
            [
                'select' => [
                    "id",
                    "accountNumber",
                    "allowDelivery",
                    "basePriceDelivery",
                    "canceled",
                    "comments",
                    "companyId",
                    "currency",
                    "customPriceDelivery",
                    "dateAllowDelivery",
                    "dateCanceled",
                    "dateDeducted",
                    "dateInsert",
                    "dateMarked",
                    "dateResponsibleId",
                    "deducted",
                    "deliveryDocDate",
                    "deliveryDocNum",
                    "deliveryId",
                    "deliveryName",
                    "deliveryXmlId",
                    "discountPrice",
                    "empAllowDeliveryId",
                    "empCanceledId",
                    "empDeductedId",
                    "empMarkedId",
                    "empResponsibleId",
                    "externalDelivery",
                    "id1c",
                    "marked",
                    "orderId",
                    "priceDelivery",
                    "reasonMarked",
                    "reasonUndoDeducted",
                    "responsibleId",
                    "statusId",
                    "statusXmlId",
                    "system",
                    "trackingDescription",
                    "trackingLastCheck",
                    "trackingNumber",
                    "trackingStatus",
                    "updated1c",
                    "version1c",
                    "xmlId",
                ],
                'filter' => [
                    ">=id" => 2464,
                    "@orderId" => [2069, 2070],
                ],
                'order' => [
                    "id" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP Status: 200

{
           "result":{
              "shipments":[
                 {
                    "accountNumber":"2070\/2",
                    "allowDelivery":"N",
                    "basePriceDelivery":0,
                    "canceled":"N",
                    "comments":"",
                    "companyId":0,
                    "currency":"USD",
                    "customPriceDelivery":"N",
                    "dateAllowDelivery":null,
                    "dateCanceled":null,
                    "dateDeducted":null,
                    "dateInsert":"2024-04-11T16:59:20+02:00",
                    "dateMarked":null,
                    "dateResponsibleId":"2024-04-11T16:59:20+02:00",
                    "deducted":"N",
                    "deliveryDocDate":null,
                    "deliveryDocNum":"",
                    "deliveryId":1,
                    "deliveryName":"No delivery",
                    "deliveryXmlId":"",
                    "discountPrice":null,
                    "empAllowDeliveryId":null,
                    "empCanceledId":null,
                    "empDeductedId":null,
                    "empMarkedId":null,
                    "empResponsibleId":null,
                    "externalDelivery":"N",
                    "id":2467,
                    "id1c":"",
                    "marked":"N",
                    "orderId":2070,
                    "priceDelivery":0,
                    "reasonMarked":"",
                    "reasonUndoDeducted":"",
                    "responsibleId":0,
                    "statusId":"DN",
                    "statusXmlId":"FFdddd",
                    "system":"N",
                    "trackingDescription":"",
                    "trackingLastCheck":"",
                    "trackingNumber":"",
                    "trackingStatus":"",
                    "updated1c":"N",
                    "version1c":"",
                    "xmlId":"bx_6617fac818ee2"
                 },
                 {
                    "accountNumber":"2069\/2",
                    "allowDelivery":"N",
                    "basePriceDelivery":600,
                    "canceled":"N",
                    "comments":"",
                    "companyId":0,
                    "currency":"USD",
                    "customPriceDelivery":"N",
                    "dateAllowDelivery":null,
                    "dateCanceled":null,
                    "dateDeducted":null,
                    "dateInsert":"2024-04-11T15:05:48+02:00",
                    "dateMarked":null,
                    "dateResponsibleId":"2024-04-11T15:05:48+02:00",
                    "deducted":"N",
                    "deliveryDocDate":null,
                    "deliveryDocNum":"",
                    "deliveryId":2,
                    "deliveryName":"Courier delivery",
                    "deliveryXmlId":"",
                    "discountPrice":null,
                    "empAllowDeliveryId":null,
                    "empCanceledId":null,
                    "empDeductedId":null,
                    "empMarkedId":null,
                    "empResponsibleId":null,
                    "externalDelivery":"N",
                    "id":2465,
                    "id1c":"",
                    "marked":"N",
                    "orderId":2069,
                    "priceDelivery":600,
                    "reasonMarked":"",
                    "reasonUndoDeducted":"",
                    "responsibleId":0,
                    "statusId":"DN",
                    "statusXmlId":"FFdddd",
                    "system":"N",
                    "trackingDescription":"",
                    "trackingLastCheck":"",
                    "trackingNumber":"",
                    "trackingStatus":"",
                    "updated1c":"N",
                    "version1c":"",
                    "xmlId":"bx_6617e02cae2a1"
                 }
              ]
           },
           "total":2,
           "time":{
              "start":1712847615.641893,
              "finish":1712847615.857499,
              "duration":0.2156059741973877,
              "processing":0.02844095230102539,
              "date_start":"2024-04-11T18:00:15+02:00",
              "date_finish":"2024-04-11T18:00:15+02:00"
           }
        }

Returned Data

Name
type

Description

result
object

The root element of the response

shipments
sale_order_shipment[]

An array of objects with information about the selected shipments

total
integer

The total number of records found

time
time

Information about the execution time of the request

Error Handling

HTTP Status: 400

{
           "error":0,
           "error_description":"error"
        }

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
error_description

Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code

Description

200040300010

Insufficient permissions to read shipments

0

Other errors (e.g., fatal errors)

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users

500

PORTAL_DELETED
Portal was deleted

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

Continue Learning

Previous
Get Shipment Field Values
Next
Delete Shipment