Add Payment Binding to Shipment sale.paymentItemShipment.add

Scope: sale

Who can execute the method: administrator

This method adds a payment binding to a shipment.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Field values (detailed description provided below) for creating a payment binding to a shipment in the form of a structure: `fields: { shipmentId: value, paymentId: value, xmlId: 'value' }`

Parameter fields

Required parameters are marked with *

Name `type`	Description
shipmentId* `sale_order_shipment.id`	Shipment identifier
paymentId* `sale_order_payment.id`	Payment identifier
xmlId `string`	External identifier of the record

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"shipmentId":2471,"paymentId":1025,"xmlId":"myXmlId"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paymentitemshipment.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"shipmentId":2471,"paymentId":1025,"xmlId":"myXmlId"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paymentitemshipment.add

try
        {
        	const response = await $b24.callMethod(
        		'sale.paymentitemshipment.add', {
        			fields: {
        				shipmentId: 2471,
        				paymentId: 1025,
        				xmlId: 'myXmlId',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.paymentitemshipment.add',
                    [
                        'fields' => [
                            'shipmentId' => 2471,
                            'paymentId' => 1025,
                            'xmlId'     => 'myXmlId',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Your logic for processing data
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding payment item shipment: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.paymentitemshipment.add', {
                fields: {
                    shipmentId: 2471,
                    paymentId: 1025,
                    xmlId: 'myXmlId',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.paymentitemshipment.add',
            [
                'fields' => [
                    'shipmentId' => 2471,
                    'paymentId' => 1025,
                    'xmlId' => 'myXmlId',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result": {
                "paymentItemShipment": {
                    "dateInsert": "2024-04-15T09:22:26+02:00",
                    "id": 1181,
                    "paymentId": 1025,
                    "shipmentId": 2471,
                    "xmlId": "myXmlId"
                }
            },
            "time": {
                "start": 1713165816.941795,
                "finish": 1713165817.220281,
                "duration": 0.2784857749938965,
                "processing": 0.045699119567871094,
                "date_start": "2024-04-15T10:23:36+02:00",
                "date_finish": "2024-04-15T10:23:37+02:00"
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
paymentItemShipment `sale_payment_item_shipment`	Object with information about the added payment binding to the shipment
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": 201240400003,
            "error_description": "shipment not exists"
        }

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
`201250000001`	An element with the specified field values `shipmentId` and `paymentId` already exists. If it is necessary to change the previously specified external identifier of the binding, use the method sale.paymentitemshipment.update
`201240400002`	Payment not found. Incorrect value of the passed parameter `paymentId`
`201240400003`	Shipment not found. Incorrect value of the passed parameter `shipmentId`
`200040300020`	Insufficient rights to add payment binding to the shipment
`100`	Parameter `fields` is not specified or is empty
`0`	Required fields are not provided
`0`	Other errors (e.g., fatal errors)

Statuses and System Error Codes

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

Overview of Methods

Update Payment Link to Shipment

Add Payment Binding to Shipment sale.paymentItemShipment.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning