woocommerce/woocommerce-paypal-payments
2
0
Fork 0
mirror of https://github.com/woocommerce/woocommerce-paypal-payments.git synced 2025-08-30 05:00:51 +08:00
Code Issues Projects Packages Wiki Activity Actions 18

Create an API function for adding tracking info.

Browse source 
This function retrieves the PayPal capture ID associated with the given WooCommerce order, creates a shipment instance, and sends it to the PayPal Order Tracking API.
If tracking information for the given tracking number already exists, it will be updated; otherwise, it will be added as new tracking information.
This commit is contained in:
Narek Zakarian 2025-08-11 19:58:22 +04:00
parent 2ec6daca38
commit 9ed0c49bc9
No known key found for this signature in database
GPG key ID: 07AFD7E7A9C164A7
1 changed files with 50 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

50
api/order-functions.php
View file

@ -17,12 +17,16 @@ use RuntimeException;
use WC_Order;
use WooCommerce\PayPalCommerce\ApiClient\Endpoint\OrderEndpoint;
use WooCommerce\PayPalCommerce\ApiClient\Entity\Order;
use WooCommerce\PayPalCommerce\OrderTracking\Endpoint\OrderTrackingEndpoint;
use WooCommerce\PayPalCommerce\OrderTracking\Shipment\ShipmentFactoryInterface;
use WooCommerce\PayPalCommerce\OrderTracking\Shipment\ShipmentInterface;
use WooCommerce\PayPalCommerce\PPCP;
use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
use WooCommerce\PayPalCommerce\WcGateway\Helper\RefundFeesUpdater;
use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor;
use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;
use \WooCommerce\PayPalCommerce\WcGateway\Processor\TransactionIdHandlingTrait;
/**
* Returns the PayPal order.
@ -159,3 +163,49 @@ function ppcp_update_order_refund_fees( WC_Order $wc_order ): void {
assert( $updater instanceof RefundFeesUpdater );
$updater->update( $wc_order );
}
/**
* Creates or updates PayPal order tracking information for a WooCommerce order.
*
* Retrieves the PayPal capture ID associated with the given WooCommerce order,
* creates a shipment instance, and sends it to the PayPal Order Tracking API.
* If tracking information for the given tracking number already exists, it will
* be updated; otherwise, it will be added as new tracking information.
*
* @param WC_Order $wc_order WooCommerce order instance to attach tracking to.
* @param string $tracking_number Tracking number provided by the carrier.
* @param string $carrier Name of the shipping carrier (must be PayPal-approved).
* @param string $status Shipment status (must be PayPal-approved). Defaults to 'SHIPPED'.
*
* @see https://developer.paypal.com/docs/tracking/reference/carriers/ List of PayPal-approved carriers.
* @see https://developer.paypal.com/docs/tracking/reference/shipping-status/ List of PayPal-approved shipment statuses.
*
* @return void
*/
function ppcp_create_order_tracking( WC_Order $wc_order, string $tracking_number, string $carrier, string $status = 'SHIPPED' ): void {
$shipment_factory = PPCP::container()->get( 'order-tracking.shipment.factory' );
assert( $shipment_factory instanceof ShipmentFactoryInterface );
$endpoint = PPCP::container()->get( 'order-tracking.endpoint.controller' );
assert( $endpoint instanceof OrderTrackingEndpoint );
$paypal_order = ppcp_get_paypal_order( $wc_order );
$capture_id = TransactionIdHandlingTrait::get_paypal_order_transaction_id( $paypal_order );
$wc_order_id = $wc_order->get_id();
$ppcp_shipment = $shipment_factory->create_shipment(
$wc_order_id,
$capture_id,
$tracking_number,
$status,
'OTHER',
$carrier,
array()
);
$tracking_information = $endpoint->get_tracking_information( $wc_order_id, $tracking_number );
$tracking_information
? $endpoint->update_tracking_information( $ppcp_shipment, $wc_order_id )
: $endpoint->add_tracking_information( $ppcp_shipment, $wc_order_id );
}