Retrieve orders without partner invoice
Last updated: 29-Sep-2021
Rate this article:
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
Parameters | Type/Description |
---|---|
Order information | Object |
Request Sample
<?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));
Response sample
{
"RefNo": "112579424",
"OrderNo": 3167,
"ExternalReference": null,
"ShopperRefNo": null,
"Status": "PENDING",
"ApproveStatus": "WAITING",
"VendorApproveStatus": "OK",
"MerchantCode": "CHAOSGRO",
"Language": "en",
"OrderDate": "2020-01-17 12:53:47",
"FinishDate": null,
"Source": null,
"AffiliateSource": null,
"AffiliateId": null,
"AffiliateName": null,
"AffiliateUrl": null,
"RecurringEnabled": false,
"HasShipping": false,
"BillingDetails": {
"FiscalCode": null,
"TaxOffice": null,
"Phone": "830-485-6136",
"FirstName": "Iron",
"LastName": "Man",
"Company": "Stark Industries",
"Email": "anastasiya.nikolova@chaosgroup.com",
"Address1": "411 Farland Avenue",
"Address2": null,
"City": "Victoria",
"Zip": "77901",
"CountryCode": "us",
"State": "Texas"
},
"DeliveryDetails": {
"Phone": "830-485-6136",
"FirstName": "Iron",
"LastName": "Man",
"Company": "Stark Industries",
"Email": "anastasiya.nikolova@chaosgroup.com",
"Address1": "411 Farland Avenue",
"Address2": null,
"City": "Victoria",
"Zip": "77901",
"CountryCode": "us",
"State": "Texas"
},
"PaymentDetails": {
"Type": "OTHER",
"Currency": "usd",
"PaymentMethod": null,
"CustomerIP": "212.91.166.163"
},
"DeliveryInformation": {
"ShippingMethod": {
"Code": null,
"TrackingUrl": null,
"TrackingNumber": null,
"Comment": null
}
},
"CustomerDetails": null,
"Origin": "Web",
"AvangateCommission": 0,
"OrderFlow": "REGULAR",
"GiftDetails": null,
"PODetails": null,
"ExtraInformation": null,
"PartnerCode": "HBVQ99623329",
"PartnerMargin": 2478,
"PartnerMarginPercent": 20,
"ExtraMargin": 0,
"ExtraMarginPercent": 0,
"ExtraDiscount": 0,
"ExtraDiscountPercent": 0,
"LocalTime": null,
"TestOrder": false,
"FxRate": 1,
"FxMarkup": 0,
"PayoutCurrency": "USD",
"DeliveryFinalized": false,
"Errors": null,
"Items": [
{
"ProductDetails": {
"Name": "V-Ray Next for 3ds Max - Perpetual",
"ShortDescription": "",
"Tangible": false,
"IsDynamic": false,
"ExtraInfo": null,
"RenewalStatus": false,
"Subscriptions": [
{
"SubscriptionReference": "1E26F2D686",
"PurchaseDate": "2020-01-17 12:53:48",
"SubscriptionStartDate": "2020-01-17 12:53:48",
"ExpirationDate": null,
"Lifetime": true,
"Trial": false,
"Enabled": true,
"RecurringEnabled": false
},
{
"SubscriptionReference": "F978B4AFDF",
"PurchaseDate": "2020-01-17 12:53:48",
"SubscriptionStartDate": "2020-01-17 12:53:48",
"ExpirationDate": null,
"Lifetime": true,
"Trial": false,
"Enabled": true,
"RecurringEnabled": false
}
],
"DeliveryInformation": {
"Delivery": "NO_DELIVERY",
"DownloadFile": null,
"DeliveryDescription": "",
"CodesDescription": "",
"Codes": []
}
},
"PriceOptions": [],
"Price": {
"UnitNetPrice": 590,
"UnitGrossPrice": 628.94,
"UnitVAT": 38.94,
"UnitDiscount": 118,
"UnitNetDiscountedPrice": 472,
"UnitGrossDiscountedPrice": 510.94,
"UnitAffiliateCommission": 0,
"ItemUnitNetPrice": null,
"ItemUnitGrossPrice": null,
"ItemNetPrice": null,
"ItemGrossPrice": null,
"VATPercent": 8.25,
"HandlingFeeNetPrice": 0,
"HandlingFeeGrossPrice": 0,
"Currency": "usd",
"NetPrice": 7080,
"GrossPrice": 7547.28,
"NetDiscountedPrice": 5664,
"GrossDiscountedPrice": 6131.28,
"Discount": 1416,
"VAT": 467.28,
"AffiliateCommission": 0
},
"LineItemReference": "c790705c387a71545271367303e38e3ffd1b1055",
"PurchaseType": null,
"Code": "VR04MXPESCL001",
"ExternalReference": "",
"Quantity": 12,
"SKU": null,
"CrossSell": null,
"Trial": null,
"AdditionalFields": null,
"Promotion": null,
"RecurringOptions": null,
"SubscriptionStartDate": null
},
{
"ProductDetails": {
"Name": "V-Ray Next for 3ds Max - Perpetual",
"ShortDescription": "",
"Tangible": false,
"IsDynamic": false,
"ExtraInfo": null,
"RenewalStatus": false,
"Subscriptions": [
{
"SubscriptionReference": "1E26F2D686",
"PurchaseDate": "2020-01-17 12:53:48",
"SubscriptionStartDate": "2020-01-17 12:53:48",
"ExpirationDate": null,
"Lifetime": true,
"Trial": false,
"Enabled": true,
"RecurringEnabled": false
},
{
"SubscriptionReference": "F978B4AFDF",
"PurchaseDate": "2020-01-17 12:53:48",
"SubscriptionStartDate": "2020-01-17 12:53:48",
"ExpirationDate": null,
"Lifetime": true,
"Trial": false,
"Enabled": true,
"RecurringEnabled": false
}
],
"DeliveryInformation": {
"Delivery": "NO_DELIVERY",
"DownloadFile": null,
"DeliveryDescription": "",
"CodesDescription": "",
"Codes": []
}
},
"PriceOptions": [],
"Price": {
"UnitNetPrice": 590,
"UnitGrossPrice": 628.94,
"UnitVAT": 38.94,
"UnitDiscount": 118,
"UnitNetDiscountedPrice": 472,
"UnitGrossDiscountedPrice": 510.94,
"UnitAffiliateCommission": 0,
"ItemUnitNetPrice": null,
"ItemUnitGrossPrice": null,
"ItemNetPrice": null,
"ItemGrossPrice": null,
"VATPercent": 8.25,
"HandlingFeeNetPrice": 0,
"HandlingFeeGrossPrice": 0,
"Currency": "usd",
"NetPrice": 5310,
"GrossPrice": 5660.46,
"NetDiscountedPrice": 4248,
"GrossDiscountedPrice": 4598.46,
"Discount": 1062,
"VAT": 350.46,
"AffiliateCommission": 0
},
"LineItemReference": "ec426fce2d07bc279654b295b97644997a5c524d",
"PurchaseType": null,
"Code": "VR04MXPESCL001",
"ExternalReference": "",
"Quantity": 9,
"SKU": null,
"CrossSell": null,
"Trial": null,
"AdditionalFields": null,
"Promotion": null,
"RecurringOptions": null,
"SubscriptionStartDate": null
}
],
"Promotions": [],
"AdditionalFields": null,
"CustomParameters": null,
"Currency": "usd",
"NetPrice": 12390,
"GrossPrice": 13207.74,
"NetDiscountedPrice": 9912,
"GrossDiscountedPrice": 10729.74,
"Discount": 2478,
"VAT": 817.74,
"AffiliateCommission": 0
}
Errors
Error | Description |
---|---|
INVALID_PARTNER |
No partner is set. |
NO_ORDERS |
There are no orders without partner invoice. |
Rate this article: