OrderInformation object structure

Parameters

Parameter	Type / Description
RefNo	String Order reference number.
OrderNo	String The consecutive order number associated with orders available in the Order search.
ExternalRefNo	String The order reference code (max. 100 chars) provided by the seller. Empty string if missing.
ShopperRefNo	String External shopper identifier.
Status	String The status of the order: AUTHRECEIVED, PENDING, TEST (COMPLETE, CANCELED, REVERSED, REFUND statuses are only returned for the getOrder method).
ApproveStatus	String The status of the order approval as set either automatically by the Avangate system or manually by a member of our anti-fraud department. This status can vary for new purchases or for orders requiring customers to make manual payments. Possible values: WAITING: The order has yet to be approved. OK: The order has been approved. INVALIDDATA: The data supplied by the shopper is invalid. The order was not approved. FRAUD: The order is fraudulent.
Language	String Language used in the cart during the purchase process.
OrderDate	String The timestamp (in the API time zone defined in Control Panel) used when the order was placed. Format: Y-m-d H:i:s (2014-05-22 00:12:12).
FinishDate	String The timestamp (in the API time zone defined in Control Panel) when the order reached the Complete status. NULL if the order is not finalized. Format: Y-m-d H:i:s (2014-05-22 00:12:12).
Source	String The link source for the sales. The SRC parameter used to track every sale point generator.
AutoRenewalChecked	Boolean True or false, depending on whether the subscription auto-renewal checkbox was checked during the purchase process.
HasShipping	Boolean True or false, depending on whether the order required shipping.
BillingDetails	Object Details below.
BillingDetails.Address	String Shopper billing address.
BillingDetails.City	String Shopper city from the billing address.
BillingDetails.Country	String Shopper country from the billing address.
BillingDetails.Email	String Shopper billing email address.
BillingDetails.FirstName	String Shopper billing name.
BillingDetails.LastName	String Shopper billing surname.
BillingDetails.PostalCode	String Postal code from the billing address.
BillingDetails.State	String Shopper billing state. E.g.: "Alabama".
BillingDetails.Company	String Company name. Can be NULL for end users. When present, FiscalCode must also be provided.
BillingDetails.FiscalCode	String Can be null for end users. For companies, it needs to be the VAT ID, which is validated by Avangate. An error will be thrown if the VAT ID is invalid/incorrect when calling setPaymentDetails. When present, Company name must also be provided.
DeliveryDetails	Object Details below.
DeliveryDetails.Address	String Shopper delivery address.
DeliveryDetails.City	String Shopper delivery city.
DeliveryDetails.Country	String Shopper delivery country.
DeliveryDetails.Email	String Shopper email address.
DeliveryDetails.FirstName	String Shopper delivery first name.
DeliveryDetails.LastName	String Shopper delivery last name.
DeliveryDetails.PostalCode	String Shopper delivery postal code.
DeliveryDetails.State	String Shopper delivery state.
DeliveryDetails.Company	String Shopper delivery company. Can be NULL for end users.
PaymentInformation	Object Details below.
PaymentInformation.Type	String The payment method: CC (credit/debit card) TEST (for test orders) PAYPAL WIRE OTHER (payment methods not listed above)
PaymentInformation.Currency	String Payment currency ISO code – ISO 4217.
PaymentInformation.PaymentMethod	Object Details below.
PaymentInformation.PaymentMethod.FirstDigits	String First four credit card digits.
PaymentInformation.PaymentMethod.LastDigits	String Last four credit card digits.
PaymentInformation.PaymentMethod.CardType	String Card type: VISA VISAELECTRON MASTERCARD MAESTRO AMEX
Origin	String Order origin channel: Web API Mobile
Currency	String Order currency.
TotalGeneral	Double Total order value (the costs incurred by the shopper).
TotalWithoutTaxes	Double Total order value without VAT or sales tax.
Taxes	Double VAT or sales tax.
Shipping	Double Shipping costs. NULL if not applicable.
AvangateCommission	Double Avangate order commission.
AffiliateCommission	Double Avangate affiliate commission. NULL if not applicable.
Discount	Double Order discount value. NULL if not applicable.
Products	Array of objects Details below.
Products.Id	Int Unique, system-generated product ID from the Avangate platform.
Products.Code	String The code you can attach to products when configuring, editing or importing them in the Avangate platform.
Products.Name	String Product name.
Products.SKU	String Product SKU.
Products.ExtraInfo	String Additional information text entered when generating buy links or via the INFO[productid]= parameter.
Products.Quanitty	Int Purchase number of products.
Products.PromotionName	String Promotion name.
Products.UnitPrice	Double Price per product unit.
Products.UnitTaxes	Double Taxes per product unit.
Products.UnitDiscount	Double Discount per product unit.
Products.UnitAffiliateCommision	Double Affiliate commission per product unit.
Products.Options	Array of objects Array of product pricing options with the structure detailed below.
Products.Options.OptionText	String The name of the pricing option selected during the purchase process.
Products.Options.OptionValue	String Unique option value code.
Products.Options.OptionalValue	String Unique option value code.
Products.Options.Operator	String ADD or SUBTRACT, depending on whether the option adds or subtracts a specific amount to or from the product price.
Products.Options.Usage	String
Products.Options.Price	String The amount added or subtracted by the pricing options.
Products.Options.GroupName	String Product options group name.
Products.AdditionalFields	Array of objects Array of AdditionalFields information objects with the structure detailed below.
Products.AdditionalFields.FieldText	String Field text visible to shoppers in the cart.
Products.AdditionalFields.FieldValue	String The alpha-numeric characters, underscores and dashes set as the field identifier.
Products.Subscription	Array of objects Array of subscriptions objects with the structure detailed below.
Products.Subscriptions.SubscriptionReference	String Unique, system-generated subscription identifier.
Products.Subscriptions.PurchaseDate	String Purchase date.
Products.Subscriptions.ExpirationDate	String Renewal / expiration date, not considering grace period settings.
Products.Subscriptions.LifeTime	Boolean Subscription duration.
Products.Subscriptions.Trial	Boolean True or false, depending on whether the subscription is a trial.
Products.Subscriptions.Disabled	Boolean True or false, depending on whether the subscription is disabled.
Products.Subscriptions.RecurringEnabled	Boolean True or false, depending on whether the subscription renewal system is enabled.
AdditionalFields	Array of objects Array of AdditionalFields information objects with the structure detailed below.
AdditionalFields.FieldText	String Field text visible to shoppers in the cart.
AdditionalFields.FieldValue	String The alpha-numeric characters, underscores and dashes set as the field identifier.
PartnerCode	String Partner code defined in the Control Panel. NULL for eStore orders.
PartnerMargin	Double Partner margin offered for the order. NULL for eStore orders.
PartnerMarginPercent	Double Partner margin percentage from the net value of the products ordered, minus the value of any discounts. NULL for eStore orders.
ExtraMargin	Double Extra margin offered. NULL for eStore orders.
ExtraMarginPercent	Double Extra partner margin percentage from the net value of the products ordered, minus the partner margin and the value of any discounts. NULL for eStore orders.
ExtraDiscount	Double Extra discount offered. NULL for eStore orders.
ExtraDiscountPercent	Double Partner margin percentage from the net value of the products ordered, minus the value of any coupon discounts. NULL for eStore orders.