Linking Payments to Shipments in the Online Store: Overview of Methods
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.
An order can include multiple products that need to be shipped in parts, meaning as several independent shipments. To allocate payments among shipments, use the linking of payments to shipments.
Quick navigation: all methods
User documentation: Payment Systems for Online Stores
Connection of Payment Linking to Shipments with Other Objects
Shipments. Specify the ID of the paid shipment. You can obtain a list of shipment IDs using the method sale.shipment.list.
Payments. Specify the ID of the payment that needs to be linked to the shipment. You can obtain a list of payment IDs using the method sale.payment.list.
How to Get Started
- Retrieve the payment ID using sale.payment.list.
- Retrieve the shipment ID using sale.shipment.list.
- Create a binding using sale.paymentItemShipment.add.
- Check the binding using sale.paymentItemShipment.get or sale.paymentItemShipment.list.
- If necessary, update the binding using sale.paymentItemShipment.update.
Overview of Methods
Scope:
saleWho can execute the methods: administrator
|
Method |
Description |
|
Adds a payment link to a shipment |
|
|
Modifies the payment link to a shipment |
|
|
Returns the values of the payment link fields for a shipment by its ID |
|
|
Returns a list of payment links to shipments based on a filter |
|
|
Deletes the payment link to a shipment |
|
|
Returns the fields of the payment link to a shipment |