Skip to main content
knowledgecenter.avangate.com

OrderInformation object structure

Member

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.

 

Address

String

 

 

Shopper billing address.

 

City

String

 

 

Shopper city from the billing address.

 

Country

String

 

 

Shopper country from the billing address.

 

Email

String

 

 

Shopper billing email address.

 

FirstName

String

 

 

Shopper billing name.

 

LastName

String

 

 

Shopper billing surname.

 

PostalCode

String

 

 

Postal code from the billing address.

 

State

String

 

 

Shopper billing state. E.g.: "Alabama".

 

Company

String

 

 

Company name. Can be NULL for end users. When present, FiscalCode must also be provided.

 

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.

 

Address

String

 

 

Shopper delivery address.

 

City

String

 

 

Shopper delivery city.

 

Country

String

 

 

Shopper delivery country.

 

Email

String

 

 

Shopper email address.

 

FirstName

String

 

 

Shopper delivery first name.

 

LastName

String

 

 

Shopper delivery last name.

 

PostalCode

String

 

 

Shopper delivery postal code.

 

State

String

 

 

Shopper delivery state.

 

Company

String

 

 

Shopper delivery company. Can be NULL for end users.

PaymentInformation

Object

 

Details below.

 

Type

String

 

 

The payment method:

  • CC (credit/debit card)
  • TEST (for test orders)
  • PAYPAL
  • WIRE
  • OTHER (payment methods not listed above)

 

Currency

String

 

 

Payment currency ISO code – ISO 4217.

 

PaymentMethod

Object

 

 

Details below.

 

 

FirstDigits

String

 

 

 

First four credit card digits.

 

 

LastDigits

String

 

 

 

Last four credit card digits.

 

 

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.

 

Id

Int

 

 

Unique, system-generated product ID from the Avangate platform.

 

Code

String

 

 

The code you can attach to products when configuring, editing or importing them in the Avangate platform.

 

Name

String

 

 

Product name.

 

SKU

String

 

 

Product SKU.

 

ExtraInfo

String

 

 

Additional information text entered when generating buy links or via the INFO[productid]= parameter.

 

Quantity

Int

 

 

Purchase number of products.

 

PromotionName

String

 

 

Promotion name.

 

UnitPrice

Double

 

 

Price per product unit.

 

UnitTaxes

Double

 

 

Taxes per product unit.

 

UnitDiscount

Double

 

 

Discount per product unit.

 

UnitAffiliateCommision

Double

 

 

Affiliate commission per product unit.

 

Options

Array of objects

 

 

Array of product pricing options with the structure detailed below.

 

 

OptionText

String

 

 

 

The name of the pricing option selected during the purchase process.

 

 

OptionValue

String

 

 

 

Unique option value code.

 

 

OptionalValue

String

 

 

 

Unique option value code.

 

 

Operator

String

 

 

 

ADD or SUBTRACT, depending on whether the option adds or subtracts a specific amount to or from the product price.

 

 

Usage

String

 

 

 

 

 

 

Price

String

 

 

 

The amount added or subtracted by the pricing options.

 

 

GroupName

String

 

 

 

Product options group name.

 

AdditionalFields

Array of objects

 

 

Array of AdditionalFields information objects with the structure detailed below.

 

 

FieldText

String

 

 

 

Field text visible to shoppers in the cart.

 

 

FieldValue

String

 

 

 

The alpha-numeric characters, underscores and dashes set as the field identifier.

 

Subscriptions

Array of objects

 

 

Array of subscriptions objects with the structure detailed below.

 

 

SubscriptionReference

String

 

 

 

Unique, system-generated subscription identifier.

 

 

PurchaseDate

String

 

 

 

Purchase date.

 

 

ExpirationDate

String

 

 

 

Renewal/expiration date, not considering grace period settings.

 

 

Lifetime

Boolean

 

 

 

Subscription duration.

 

 

Trial

Boolean

 

 

 

TRUE or FALSE depending on whether the subscription is a trial.

 

 

Disabled

Boolean

 

 

 

TRUE or FALSE depending on whether the subscription is disabled.

 

 

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.

 

FieldText

String

 

 

Field text visible to shoppers in the cart.

 

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.