Partial shipping

Every order can be captured in full or in parts.

  • Capturing in full means that the full amount of the order is captured by a single capture call. This is usually the case when the customer’s order is delivered in one shipment.
  • Capturing in parts means that the full amount of the order is captured by more than one capture call. This is usually the case when the customer’s order is delivered in more than one shipment.

If, for any reason, you need to ship only some items of an order, you can capture the amount of the invoice corresponding to the shipped items. This capture will reduce the amount available on the order by the captured amount. Since the order amount will have not been used fully, the order will have the state partially shipped.

You can keep creating partial captures until the order amount is completely used. The order will only be marked as shipped once the amount available in the order is completely used and the order has no remaining amount.

Comments

The call is named Create Capture, the resource is named /invoice. This has historical reasons. If a Capture is referenced, the /invoice resource is used.

You will be using the following API calls