Mark orders as shipped

Last updated: 25-Sep-2019

Rate this article:

Overview

Use markShipped to programmatically confirm the delivery of an order with physical products.

Requirements

You can confirm the shipment only for orders with tangible products. You cannot mark as shipped orders that are no longer authorized (have been reversed).

Parameters

Parameters	Type/Description
RefNo	String / Required
	The system-generated order reference.
TrackingNumber	String / Optional
	Tracking number that customers can use for checking the delivery of their products.
Comment	String / Optional
	Additional information displayed in the delivery confirmation email sent to end-users.
StopCustomerNotification	Boolean / Optional
	Possible values: TRUE - to send a notice informing customers of product shipment. FALSE - will not trigger a customer notification

Request

require('PATH_TO_AUTH');

$RefNo = "789527422";
$TrackingNumber = '921840912';
$StopCustomerNotification = 1;
$Comment = "We send this note to confirm the shipment of your products.";


try {
    $markOrderAsShipped = $client->markShipped($sessionID, $RefNo, $TrackingNumber, $StopCustomerNotification, $Comment);
}
catch (SoapFault $e) {
    echo "OrderShipped: " . $e->getMessage();
    exit;
}
var_dump("OrderShipped", $markOrderAsShipped);

Response

boolean

Rate this article: