Linking Payments to Shipments in the Online Store: Overview of Methods

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

Connection of Payment Linking to Shipments with Other ObjectsConnection 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.

Overview of MethodsOverview of Methods

Scope: sale

Who can execute the methods: administrator

Method	Description
sale.paymentItemShipment.add	Adds a payment link to a shipment
sale.paymentItemShipment.update	Modifies the payment link to a shipment
sale.paymentItemShipment.get	Returns the values of the payment link fields for a shipment by its ID
sale.paymentItemShipment.list	Returns a list of payment links to shipments based on a filter
sale.paymentItemShipment.delete	Deletes the payment link to a shipment
sale.paymentItemShipment.getFields	Returns the fields of the payment link to a shipment