Shipments in the Online Store: Overview of Methods
Shipments allow you to see which products have been sent, in what quantities, and when. This helps manage delivery statuses. An order can be shipped in parts, meaning as several independent shipments. Each shipment has its own delivery service, status, and contents.
Quick navigation: all methods
Connection of Shipments with Other Objects
Order. Create or modify an order using the methods sale.order.*.
Delivery Services. Create or modify a delivery service using the methods sale.delivery.*.
Statuses. Specify the delivery status identifier. Use one of the default statuses or create a new status using the method sale.status.add.
Shipment Item Table. Add or modify items in the shipment using the methods sale.shipmentitem.*.
Shipment Properties. If there are multiple shipments in the order, create shipment properties using the methods sale.shipmentproperty.*. For example, if there are three books in the order that need to be sent to different addresses. To specify the address for each shipment, create shipment properties.
Linking Payments to Shipments. Specify which shipments have been paid for. Use the methods sale.paymentItemShipment.*.
Overview of Methods
Scope:
saleWho can perform the methods: administrator
|
Method |
Description |
|
Adds a shipment |
|
|
Modifies a shipment |
|
|
Returns values of all shipment fields |
|
|
Returns a list of shipments |
|
|
Deletes a shipment |
|
|
Returns available shipment fields |