Ship to Multiple Addresses

Shipping to multiple addresses allows shoppers to send items within an order to different destinations, or to use a combination of fulfillment methods for the items, such as direct ship, in-store pickup, or gift card (digital) delivery. For example, assume a shopper creates an order with the following items:

If your site has multiple shipments enabled, the shopper could choose to pick up the vacuum cleaner and mop at a local store, ship the decorative mirror to their home address, and ship the bedding set to their child's address as a gift.

Feature Limitations

The ability to ship items within the same order to multiple addresses is currently in an early development phase. Because of this, the feature has the following limitations:

Effect on Orders

Sites that support multiple shipments create orders based on shipment groupings. Direct ship items going to the same destination are grouped within their own order, and all in-store pickup and gift card items are grouped into the first order created (which can include direct ship items). For example, take an order where a shopper purchases six items. Items A and B are direct ship items to different destinations, Items C and D are in-store pickup items, and Items E and F are gift cards. In this case, two orders will be created, as follows:

Order 1

Order 2

Effect on Discounts

Because of the effect on orders, discounts are also affected for sites that support multiple shipments. Specifically, order-level discounts apply at the shipment level that results from the new order breakdown. It is very important to consider whether discounts should apply to orders that contain multiple shipments.

There is a new checkbox when you create discounts (Discount will not apply on multi ship orders in the Discount Limitations section). This checkbox disables the discount on any orders that contain multiple shipments.

Note:  Certain discounts should never apply to orders that contain multiple shipments. For example, consider a discount that takes $10 off shipping on orders of $100 or more. On a site that has multiple shipments enabled, a shopper can purchase three items collectively worth over $100, and then choose to ship each item to a unique address. If there was only one destination to ship to, this discount would have taken $10 off shipping one time, but because there are three shipments, the discount will take $10 off three times. In this case, you would want to use the checkbox to disable such a discount on orders that contain multiple shipments.

Effect on Fraud Check

Fraud checks run on each order created after the shopper submits their checkout. For example, if an order with multiple shipments results in three orders generated, fraud checks run on all three orders individually.

Enable Multiple Shipments

Enabling multiple shipments requires a combination of theme work and configuration in Admin.

Note:  After you enable multiple shipments, you cannot easily disable it. Enabling multiple shipments requires changes to your theme that are not backwards-compatible with your storefront if you later decide to disable multiple shipments. You would have to revert all the changes to your theme before being able to disable the feature.

Update Your Theme

Ask your theme developer to make the required changes to your theme to enable this feature, as detailed in the GitHub pull request.

Enable Multiple Shipments in Admin

After updating your theme, enable this feature in your Admin general settings. This feature applies at the site level.

  1. Go to System > Settings > General.
  2. Select the site you want to enable multiple shipments for.
  3. Use the context switcher to view the Storefront settings.
  4. Enable Ship to Multiple Addresses.

View Multiple Shipments

After you enable this feature, shoppers or CSRs can create orders with items shipping to different addresses or using different shipping methods. You can view how the order items are split by viewing the Order details page for the appropriate order:

Note:  For the time being, orders that take advantage of this feature become read only in Admin. You cannot edit order details for orders that contain multiple shipments.
  1. Go to Main > Fulfillment > Orders.
  2. View an order (note that one checkout can result in multiple orders, as detailed in the Orders section of this topic).
  3. Use the context switcher to view the Fulfillment tab. The order items are arranged by Direct Ship Items, In-store Pickup, or Gift Cards, as shown in the following screenshot:

Use the Multiple Shipments API

To learn about using the API to manage multiple shipments, refer to the Multiple Shipments API Guide.

 

Shared Payments

The Shared Payment feature expands on the Ship to Multiple Addresses feature. It enables shoppers to checkout with items going to multiple shipping destinations without needing to specify multiple methods of payment. It also adds some changes to payment processing to help CSRs to better understand and manage payments for orders that use the Ship to Multiple Addresses feature.

Major Changes / Terminology

The following sections describes concepts and terms needed to understand the changes introduced in this feature:

Checkouts and Checkout-level Actions

A “checkout” refers to an order ID that tracks the multiple orders created when a shopper checks out using Ship to Multiple addresses. Checkouts are also referred to as parent orders, and the orders they track are referred to as child orders. Any payment actions or API calls that act on the parent order are referred to as checkout-level actions.

Shared Payment

With this feature, Kibo eCommerce now supports sharing payments between multiple orders in a checkout.

No-op Voids

A no-op void is a void in which the system marks that order’s portion of a shared payment as voided but does not call the payment gateway. This enables you to void a payment without closing the payment authorization for that credit card, allowing you to capture a payment for a different order.

Support for Third Party Payments

Kibo eCommerce now supports Paypal and Pay with Amazon as payment methods for orders using Ship to Multiple Addresses. To enable these payment methods for shoppers, you will need to use Paypal version 2.0.1 or later and Pay with Amazon version 2.0.0 or later. Additionally, enabling Pay with Amazon requires changes to your core theme. Ask your theme developer to make the changes outlined in the github pull request.

Authorizing and Capturing on Order Placement

Kibo eCommerce now supports authorization and capture of credit cards on order placement for tenants that have Ship to Multiple Addresses enabled.

To enable this option:

  1. Navigate to System > Settings > Payment Types.

  2. Under the Credit Cards tab, under the Order Processing section, select Authorize And Capture On Order Placement.

  3. Select Save.

Use Cases

View Transaction History Across Child Orders

Since a payment may be shared and acted upon from a checkout or one of its child orders, the payment's transaction history now includes a From field that indicates where each interaction took place.

For example, the screenshot below shows the transaction history for an order labeled Order 537, which is a child order of Order 536. Since the payment for Order 537 was authorized on Order 536 (at the checkout level), that interaction is included on the transaction history for Order 537.

Using Shared Payments via the API

Capture Payment at the Checkout Level

You can capture payment at the checkout level using the following resources in the Kibo eCommerce API:

POST api/commerce/checkouts/{checkoutId}/payments/actions

You can use this API to create a payment at the checkout level.

POST api/commerce/checkouts/{checkoutId}/payments/{paymentId}/actions

You can use this API to process a payment at the checkout level.

Subpayments

Checkouts track interactions between child orders and a payment method using the subpayments field. The subpayments field indicates how much of a payment was applied to a child order.

Limitations on Shared Payments API

Payment Action Behaviors

This section describes key behaviors and options for all payment types.

Processing Credit Cards

The following table describes the payment actions available for credit card payments, along with the possible statuses for each.

Possible Actions

Possible States/Statuses

• Create

• Authorize

• Capture

• AuthAndCapture

• Decline

• Credit

• Void

• Rollback

• New

• Authorized

• Collected

• Declined

• Credited

• Voided

Limitations on Payment Capture

Kibo eCommerce does not currently support multiple payment captures per credit card payment. For example, if a shopper submits a parent order and

If you capture payment from a credit card for one of the orders in the shopper’s checkout, the payment authorization for that credit card closes and you will need to authorize a new payment if you have no other payment methods specified.

Voiding Payments at Order Level

If you void a credit card payment for a single order within a checkout, the system performs a no-op void for that order.

Voiding Orders at Checkout Level

If you perform a void at the checkout level, all orders will be voided as a no-op void except for the last order. The last order will be voided normally, which means it will both void the payment and call the payment gateway. The payment gateway then closes the payment authorization for that credit card.

Note: When voiding all orders in a Multiple Shipments checkout, the system displays $0 voided for any orders that were no-op voided. This is because the final void on the last order voids the full amount authorized for the payment.

Processing Checks

The following table describes the payment actions available for check payments, along with the possible statuses for each.

Possible Actions

Possible States/Statuses

• Create

• Authorize

• Capture

• AuthAndCapture

• Decline

• Credit

• Void

• Rollback

• New

• Authorized

• Collected

• Declined

• Credited

• Voided

Capturing Payment

You can capture payments from a check across multiple orders, but you can only capture one payment per order from the same check.

Processing Store Credit

The following table describes the payment actions available for store credit payments, along with the possible statuses for each.

Possible Actions

Possible States/Statuses

• Create

• Authorize

• Capture

• AuthAndCapture

• Decline

• Credit

• Void

• Rollback

• New

• Authorized

• Collected

• Declined

• Credited

• Voided

Automatic Capture

The system automatically captures store credit payments per order.

Processing Purchase Orders

The following table describes the payment actions available for purchase order payments, along with the possible statuses for each.

Possible Actions

Possible States/Statuses

• Create

• Authorize

• Capture

• AuthAndCapture

• Decline

• Credit

• Void

• Rollback

• New

• Authorized

• Collected

• Declined

• Credited

• Voided

Limitations on Checkout Level Payment Actions

You can only run the RequestPayment, AuthorizePayment, and InvoicePayment actions at the checkout level for purchase orders.

Capturing Payment for Purchase Orders

You can capture multiple payments from purchase orders per order. However, once you capture payment at the order level, the system will not allow you to capture payment at the checkout level for the checkout containing that order.

Voiding Payment for an Individual Order

If you void a payment for an individual order, the system returns an amount equal to that order’s payment to the shopper’s purchase order balance.

Other Payment Action Information

For more information on payment actions, refer to the Payment Processing guide.

Rollup Payment Status Updates

The processing of rollup payment status for orders has changed to be more consistent. The following list describes the different rollup payment statuses and when they display for an order:

Paid

This status displays when the order has items and the net collected amount equals the order total amount.

Unpaid

This status displays when the net collected is $0 and there are no active payments. Active payments include payments that have a status of Authorized, Invoiced, PaymentRequested, or Pending.

Pending

This status displays when the net collected is neither $0 nor equal to the order total, or there is an active payment.

Credited

This status displays only for cancelled orders and indicates that all payments have been voided or credited, and at least one payment has been credited.

Voided

This status displays only for cancelled orders and indicates that all payments have been voided.

Note: Even if you do not have Ship to Multiple Addresses enabled, these changes to rollup payment status will still appear on your tenant.