Retrieve orders without partner invoice

Overview

Use this method to list all orders that have yet to be included in a partner invoice.

Requirements

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

Parameters

Parameters	Type/Description
sessionID	Required (String)
	Session identifier, output of the Login method. An exception is thrown if the values are incorrect.

Response

Parameters	Type/Description
RefNo	String
	The unique, system-generated identifier of a partner order.
Status	String
	Order status. Possible values: CANCELED, REFUND, TEST, REJECTED, COMPLETE, SUSPECT, AWAITING_PAYMENT, PENDING_APPROVAL, DELIVERY_NEEDS_INFO.
OrderLockReason	StringArray
	The reason why the order is blocked in a certain status. For AWAITING_PAYMENT order status, the OrderLockReason can be: UNPAID_PROFORMA, NOT_ENOUGH_CREDIT For order status DELIVERY_NEEDS_INFO, the OrderLockReason can be: REQUIRED_END_USER_INFORMATION, REQUIRED_RESELLER_INFORMATION, REQUIRED_VENDOR_DELIVERY_CONFIRMATION Can be NULL.
ProformaNumber	String
	The unique number of the partner invoice associated with this order. Can be NULL.
TotalAmount	double
	The total value of the order, including tax, but excluding partner margins and discounts.
Currency	String
	The order currency ISO code.
TotalSubbscriptionsNumber	Int
	The total number of subscriptions generated for the products included in the order. Can be NULL, if subscriptions have yet to be generated for an order.

Request

<?php

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

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'getOrdersWithoutProforma',
'params' => array($sessionID)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

Errors

Error	Description
INVALID_PARTNER	No partner is set.
NO_ORDERS	There are no orders without partner invoice.