Detecting a pickup order

A pickup order ships to the Commerce store location. No flag is stored on the order; the plugin recognizes one by comparing the shipping address to that location.

In PHP#

isCustomerPickup() on the checkout service answers for any order. It returns false whenever Offer pickup at the store location is off. A module can use it to leave carrier rates off a pickup order, here with Postie:

<?php

namespace modules\site;

use craft\commerce\elements\Order;
use fostercommerce\fostercheckout\FosterCheckout;
use verbb\postie\events\ModifyShippingMethodsEvent;
use verbb\postie\services\Service as PostieService;
use yii\base\Event;

Event::on(
    PostieService::class,
    PostieService::EVENT_BEFORE_REGISTER_SHIPPING_METHODS,
    static function (ModifyShippingMethodsEvent $modifyShippingMethodsEvent): void {
        $order = $modifyShippingMethodsEvent->order;

        if ($order instanceof Order && FosterCheckout::getInstance()?->getCheckout()->isCustomerPickup($order)) {
            $modifyShippingMethodsEvent->shippingMethods = [];
        }
    }
);

In Twig#

{% if craft.fostercheckout.isCustomerPickup(cart) %}
    <p>Collect this order from our warehouse.</p>
{% endif %}

In the cart response#

The single-page checkout’s cart JSON carries the same answer as fosterCheckout.customerPickup, alongside the shipping methods and totals.

See the user guide for turning pickup on and pricing it.