Retrieve order status information

Overview

Get information about an existing order.

Requirements

This method requires you to set a specific partner using setPartner.

Parameters

Parameter	Type/Description
sessionID	Required (string)
	Session identifier, which is the output of the Login method. An exception is thrown if the values are incorrect.
productId	Required (integer)
	Unique product identifier from the 2Checkout system.
pricingListCode	Required (string)
	The unique identifier of a partner price list.
quantity	Optional (integer)
	Defines the amount of product units to be ordered. If no quantity info is provided, the minimum available number of units is included in the order. If the quantity provided is not available for purchase, such as in the case of volume discounts, en error message is displayed. When NULL, quantity = 1 is added automatically.
priceOptions	Optional (StringArray)
	Array of price options codes. If no price options info is provided, the default, required pricing options of the product are ordered. These identifiers mark the individual options inside pricing options configuration groups. Can be NULL.

Parameters

Parameters	Type/Description
sessionID	Required (String)
	Session identifier, which is the output of the Login method. An exception is thrown if the values are incorrect.
refNo	Required (String)
	The unique, system-generated identifier of a partner order.

Response

Parameters	Type/Description
Order	Object

Request

<?php

require('PATH_TO_AUTH'); // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/02Authentication
require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner

$refNo = 'YOUR_ORDER_REFERENCE'

try {
    $Order= $client->getOrderStatus($sessionID, $refNo);
} catch (SoapFault $e) {
    echo "Orderinfo: " . $e->getMessage();
    exit;
}
var_dump ("Orderinfo", $Order);

Errors

Error	Description
INVALID_PARTNER	No partner is set.
INVALID_REFERENCE	The provided order reference is invalid.