Order with catalog products
The object below is returned directly or within a successful response from the following API requests:
Catalog order object
RefNo
String 2Checkout generates unique reference numbers for all orders (purchases). You can use this parameter to retry authorizations for orders with failed transactions by changing the payment method.
NULL when you place new orders.
ChargebackResolution
String Chargeback status information. Possible values:
OPEN (chargeback is in progress)
WON (chargeback won by you)
LOST (chargeback won by the customer)
ACCEPTED (you agreed to repay the value of the order to the customer)
NONE (no chargeback initiated for the order)
To manage chargeback notifications navigate to Control Panel Dashboard →Integrations → Webhooks and API, and click on the IPN settings tab.
In the General IPN Settings section, under Triggers, make sure to check the boxes next to the following options:
chargeback open (2Checkout sends an IPN when shoppers open a chargeback dispute).
chargeback closed - (2Checkout sends an IPN when the parties involved resolve a chargeback dispute).
Also, check the checkbox next to the CHARGEBACK_RESOLUTION parameter featured in the Response tags area.
ChargebackReasonCode
String
Identifier for the chargeback dispute reason from the 2Checkout system. Empty for orders with no chargeback dispute initiated.
Possible values:
MERCHANDISE_NOT_RECEIVED - Order not fulfilled/not delivered
NOT_AS_DESCRIBED - Product(s) not as described/unfunctional
DUPLICATE_TRANSACTION - Duplicate order
FRAUD / NOT_RECOGNIZED - Fraud/Order not recognized
CREDIT_NOT_PROCESSED - Agreed refund not processed
NOT_RECOGNIZED - New/renewal order not recognized
AUTHORIZATION_PROBLEM - Authorization problem
INFO_REQUEST - Information request
UNKNOWN - Unknown
OrderNo
String The consecutive order number 2Checkout associates with orders and displays in the Order search area of your account.
ExternalReference
String Set external reference identifiers for orders. Enables you to replicate the functionality of the REF parameter included into Buy Links. Maximum 100 characters. If there is a need for longer references, you can apply an md5 hash for any string value, resulting in a 32 characters string. You can verify the hash after the order notification, on the client side.
Status
String
The status of the order:
AUTHRECEIVED – 2Checkout blocks the amount corresponding to the transaction, but the process of collecting funds is incomplete.
PENDING - 2Checkout has yet to block the amount corresponding to the transaction or shoppers used an offline payment method like wire transfer.
COMPLETE – The shopper completed the transaction for the purchase and 2Checkout or you fulfilled the order (when required).
CANCELED – 2Checkout cancels orders for which shoppers fail to transfer funds in due time.
REVERSED – 2Checkout reverses order transactions that never reach the Complete/Finished stage. Shoppers never complete transactions for such purchases.
REFUND – 2Checkout refunds orders only after they reach the Complete/Finished stage and returns the funds collected to shoppers.
ApproveStatus
String
The status of the order resulted from the evaluation by the 2Checkout anti-fraud system or by a member of the anti-fraud department. This status varies for new purchases and for orders requiring customers to make manual payments.
Possible values:
WAITING: The 2Checkout anti-fraud system or a member of the anti-fraud department has yet to approve the order.
OK: The 2Checkout anti-fraud system or a member of the anti-fraud department approved the order.
INVALIDDATA: Shopper-supplied data is invalid – 2Checkout did not approve the order.
FRAUD: The order is fraudulent.
VendorApproveStatus
String
Shows if you approved or not a partner order. Possible values:
OK
WAITING
REJECTED
Language
String ISO 639-1 two-letter code. Language used for the purchase process. Example: “en.”
OrderDate
String Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when customers place their orders.
FinishDate
String Y-m-d H:i:s (2014-05-22 00:12:12) The datetime stamp (in the API time zone defined in cPanel) when the order reach the Complete status.
NULL for order that did not reach the Complete/Finished stage.
Source
String The link source for the sale. Enables you to replicate the functionality of the SRC (separate link identifier) parameter when included into Buy Links. Use the SRC parameter to track sale sources.
Maximum length 255 characters. Cannot be null.
Affiliate
Object Details below.
Affiliate.AffiliateCode
String The unique code of the affiliate who refer orders.
Affiliate.AffiliateSource
String The link source for affiliate referred sales. Similar to the functionality of the SRC (separate link identifier) parameter included into Buy Links, but controlled by the AFFSRC parameter. Affiliates use the AFFSRC parameter to track sale sources for their referrals. Maximum length 255 characters.
Affiliate.AffiliateName
String Affiliate name.
Affiliate.AffiliateUrl
String Affiliate website URL from the Affiliate Details.
HasShipping
Boolean true or false, depending on whether the order requires shipping.
DeliveryFinalized
Boolean true or false, depending on whether product delivery has been completed.
BillingDetails
Object Details below.
BillingDetails.FirstName
String Shopper name.
BillingDetails.LastName
String Shopper surname.
BillingDetails.CountryCode
String Shopper country. ISO 3166 two-letter code.
BillingDetails.State
String The state in the shopper's country. Mandatory when you set the Billing Country to US, Turkey, India and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
BillingDetails.City
String Shopper city.
BillingDetails.Address1
String Shopper address.
BillingDetails.Address2
String Shopper address.
BillingDetails.Zip
String ZIP/ Postal code.
BillingDetails.Email
String Shopper email address.
BillingDetails.Phone
String Shopper phone number. Mandatory when you set Brazil as the Billing Country. Can be NULL.
BillingDetails.Company
String Company name. Can be null for end users. When present, you also need to provide the FiscalCode.
BillingDetails.FiscalCode
String
For companies, it needs to be the VAT ID. 2Checkout will validate the value provided and throw an error if the VAT ID is invalid/incorrect when calling
setPaymentDetails. When present, you also need to provide the Company name.Mandatory when the Billing Country is set to Brazil. For Brazilian customers it represents the Fiscal Code (CPF/CNPJ).
Mandatory when the Billing Country is set to India, and purchase is made by a Company.
Can be null for end users.
DeliveryDetails
Object
Optional. When missing, 2Checkout uses the same details as for the BillingDetails object.
Details below.
DeliveryDetails.FirstName
String Shopper name from the delivery details.
DeliveryDetails.LastName
String Shopper surname from the delivery details.
DeliveryDetails.CountryCode
String Shopper country. ISO 3166 two-letter code from the delivery details.
DeliveryDetails.State
String The state in the shopper's country from the delivery details. Mandatory when you set the Billing Country to US, Turkey and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.
DeliveryDetails.City
String Shopper city from the delivery details.
DeliveryDetails.Address1
String Shopper address from the delivery details.
DeliveryDetails.Address2
String Shopper address from the delivery details.
DeliveryDetails.Zip
String ZIP/ Postal code from the delivery details.
DeliveryDetails.Email
String Shopper email address from the delivery details.
DeliveryDetails.Phone
String Shopper phone number from the delivery details. Mandatory when you set Brazil as the Billing Country. Can be NULL.
DeliveryDetails.Company
String Company name from the delivery details. Can be null for end users. When present, you also need to provide the FiscalCode.
PaymentDetails
Optional (object) Adapt this object to the desired payment method.
PaymentDetails.Type
String
The payment method:
CC (credit/debit card - including local Brazilian cards).
PAYPAL
PAYPAL_EXPRESS
CCNOPCI (credit/debit card for non-PCI certified merchants).
TEST (for test orders).
PREVIOUS_ORDER (place new orders using the reference of a previous order).
EXISTING_PAYMENT_DATA (use a card one of your customers already used to purchase from your account).
WIRE – the placeOrder response includes Wire payment details.
CHECK – the placeOrder response includes Check payment details.
PURCHASEORDER - use for orders with POs.
FREE – for 0 value orders for which you’re not requiring customers to provide payment details.
GOOGLE PAY - the placeOrder response includes the GooglePay payment details in the PaymentMethod object.
APPLEPAY - the placeOrder response includes the ApplePay payment details in the PaymentMethod object.
eCheck/ACH
Stored Credit
PaymentDetails.Currency
String The currency ISO code for the payment - ISO 4217. Example: “usd.”
PaymentDetails.PaymentMethod
Optional (object) Object structure and parameters differ according to payment method selected and API method (placing orders (POST) vs. retrieving order data (GET)). For payments with credit cards, PalPay Express, previous order reference and purchase order use the objects below.
For payments with check and wire, send only the ‘CHECH’ and ‘WIRE’ strings.
null for 0 value orders for which you’re not requiring customers to enter payment details.
PaymentDetails.PaymentMethod.RecurringEnabled
Boolean true or false, depending on whether the shoppers checked the subscription auto-renewal checkbox or not, during the purchase process.
PaymentDetails.PaymentMethod.PaymentDetailsCard
Optional (object) Details below.
PaymentDetails.PaymentMethod.PaymentDetailsCard.CardType
String visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo
PaymentDetails.PaymentMethod.PaymentDetailsCard.FirstDigits
String First four digits of the credit card.
PaymentDetails.PaymentMethod.PaymentDetailsCard.LastDigits
String Last four digits of the credit card.
PaymentDetails.PaymentMethod.PaymentDetailsCard.RecurringEnabled
Boolean true or false, depending whether the order has active recurring options
PaymentDetails.PaymentMethod.PaymentDetailsCard.Vendor3DSReturnURL
String URL to which customers are redirected after a successful 3DS process.
PaymentDetails.PaymentMethod.PaymentDetailsCard.Vendor3DSCancelURL
String URL to which customers are redirected after a failed 3DS process.
PaymentDetails.PaymentMethod.PaymentDetailsCard.InstallementsNumber
Integer Number of installments used for paying the order.
PaymentDetails.PaymentMethod.CheckPaymentDetails
Optional (object) Details below.
PaymentDetails.PaymentMethod.CheckPaymentDetails.Beneficiary
String The beneficiary of the payment.
Can be NULL.
PaymentDetails.PaymentMethod.CheckPaymentDetails.CheckPostalAddress
String The address of the beneficiary.
Can be NULL.
PaymentDetails.PaymentMethod.CheckPaymentDetails.Amount
Float The total costs incurred by the customer for an order.
Can be NULL.
PaymentDetails.PaymentMethod.CheckPaymentDetails.Currency
String The currency ISO code of the order/payment - ISO 4217.
Can be NULL.
PaymentDetails.PaymentMethod.PayPalExpress
Object Details below.
PaymentDetails.PaymentMethod.PayPalExpress.Email
String Email address customers use for their PayPal account.
PaymentDetails.PaymentMethod.PayPalExpress.ReturnURL
String The PayPal Express Checkout redirect URL returned by calling the getPayPalExpressCheckoutRedirectURL method. The return URL is the page on your website to which PayPal redirects your buyer's browser after the buyer logs into PayPal and approves the payment. Typically, this is a secure page (https://...) on your site.
PaymentDetails.PaymentMethod.PayPalExpress.CancelURL
String The cancel URL is the page on your website to which PayPal redirects your buyer's browser if the buyer does not approve the payment. Typically, this is the secure page (https://...) on your site from which you redirected the buyer to PayPal.
PaymentDetails.PaymentMethod.WirePaymentDetails
Object Details below.
PaymentDetails.PaymentMethod.WirePaymentDetails.Amount
Float The total costs customers incur.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.Currency
String The currency ISO code of the order - ISO 4217.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.PaymentReference
String Transaction identifier.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.RoutingNumber
String Identification number assigned to financial institutions.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts
Optional (array of objects) Details below.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.Beneficiary
String The beneficiary of the payment.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankName
String The name of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankCountry
String The country of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankCity
String The city of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAddress
String The address of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccount
String The number for the account in which customers transfer the funds.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccountIban
String The IBAN of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.BankAccountSwiftCode
String The Swift Code of the beneficiary's bank.
Can be NULL.
PaymentDetails.PaymentMethod.WirePaymentDetails.BankAccounts.Currency
String The currency ISO code for the bank account - ISO 4217.
Can be NULL.
PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH
Object Details below.
PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH.AccountHolderName
String Full name of the account holder.
PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH.BankRoutingNumber
String Bank Routing number with fixed 9 digit length.
PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH.AccountNumber
String Account number consisting of up to 17 digits.
PaymentDetails.PaymentMethod.DIRECT_DEBIT_ACH.AccountType
String Possible values are "S" for SAVINGS accounts or "C" for CHECKING accounts.
PaymentDetails.CustomerIP
String Shopper IP.
CustomerDetails
Object
2Checkout populates the parameters of the customer entity with information from the customer whose AvangateCustomerReference or ExternalCustomerReference you send during the purchase.
Details Below.
CustomerDetails.AvangateCustomerReference
Integer System-generated 2Checkout customer reference. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the AV_CUSTOMERID (case sensitive) parameter to buy links. The 2Checkout system generates default customer numerical (integer) IDs (AV_CUSTOMERID) automatically for all orders containing products that feature subscriptions.
CustomerDetails.ExternalCustomerReference
String The external customer reference you control. Aggregate subscriptions under the same Customer account if the products they're associated to are purchased by the same shopper by adding the CUSTOMERID (case sensitive) parameter to buy links.
CustomerDetails.FirstName
String Customer's first name.
CustomerDetails.LastName
String Customer's last name.
CustomerDetails.CountryCode
String Customer's country code (ISO 3166 two-letter code).
CustomerDetails.State
String Customer's state. For example, "Alabama","Alaska","Arizona".
CustomerDetails.City
String Customer's city.
CustomerDetails.Address1
String Customer's address.
CustomerDetails.Address2
String Customer's address.
CustomerDetails.Zip
String Zip code.
CustomerDetails.Email
String Customer's email.
CustomerDetails.Phone
String Customer's phone number.
CustomerDetails.Company
String Company name.
CustomerDetails.FiscalCode
String For companies, it needs to be the VAT ID. 2Checkout validates this values and throws an error if the VAT ID is invalid/incorrect. When present, you need to also provide Company name.
Can be null for end users.
CustomerDetails.Fax
String Customer's fax number.
CustomerDetails.Enabled
Boolean true or false, depending on whether the customer account is active or inactive. An active customer account features at least one Active or Past due subscription.
CustomerDetails.Trial
Boolean true or false, depending on whether the customer account features only trials or also paid subscriptions.
CustomerDetails.Language
String ISO 639-1 two-letter code. Example: “en.”
CustomerDetails.ExistingCards
Array of objects Details below.
CustomerDetails.ExistingCards.TransientToken
Object Populated only when you retrieve customer information by SSOToken.
CustomerDetails.ExistingCards.TransientToken.Token
String Token for the EXISTING_PAYMENT_DATA flow. Use it to charge customers using cards they used in the past for purchases from your 2Checkout account.
CustomerDetails.ExistingCards.CardType
String visa, visaelectron, mastercard, maestro, amex, discover, dankort, cartebleue, jcb, hipercard, elo
CustomerDetails.ExistingCards.LastDigits
String Last four digits of the credit card.
CustomerDetails.ExistingCards.ExpirationMonth
String Card expiration month.
CustomerDetails.ExistingCards.ExpirationYear
String Card expiration year.
CustomerDetails.ExistingCards.NameOnCard
String Card holder name.
Origin
String
2Checkout automatically tracks the source of purchases:
Web – When customers use the desktop version of the 2Checkout shopping cart.
API - When customers use a custom, API-based ordering interface.
Mobile - When customers use the mobile version of the 2Checkout shopping cart.
Automatic Billing – For auto-renewals and trial conversions.
AvangateCommission
Optional (Int) 2Checkout's commission for the order.
OrderFlow
String PURCHASE_ORDER - Sent only when shoppers used Purchase Orders.
REGULAR - Sent in all other cases.
GiftDetails
Optional (object) Contains contact details for the recipient of a gift purchase.
GiftDetails.FirstName
String First name of gift recipient.
GiftDetails.LastName
String Last name of gift recipient.
GiftDetails.Email
String Email of gift recipient. 2Checkout uses this email for the delivery/fulfillment process.
GiftDetails.GiftNote
String Custom text shoppers provide as a message to the gift recipient.
PODetails
Object (optional) Details below.
PODetails.Status
String
PO status. Possible values:
AWAITING_UPLOAD - Awaiting form submission - Waiting for the customer to submit the PO form
TIME_EXPIRED - Expired, form not received - The customer did not submit the PO form
AWAITING_MERCHANT - Awaiting your confirmation - PO approved by 2Checkout, awaiting vendor confirmation
MERCHANT_TIME_EXPIRED - Expired, PO not confirmed - You didn't confirm/reject the PO
AWAITING_MERCHANT - Rejected - You rejected the PO
AWAITING_PAYMENT - Awaiting payment - You approved the PO, waiting for payment
AWAITING_PAYMENT - Expired, not paid - The customer did not complete the PO payment. 2Checkout accepts payments up to 30 days after the PO payment interval expires
NOT_PAID - Canceled, not paid - The customer did not complete the PO payment
NOT_PAID - Canceled by 2Checkout - 2Checkout canceled the PO
NOT_PAID - Canceled via API - You canceled the PO (via API)
PAID - Complete - Customer paid the PO. The order is complete
PODetails.AutoApprove
Boolean TRUE or FALSE, depending on whether you set POs to auto-approve or not.
PODetails.RequireDocumentUpload
Boolean TRUE or FALSE, depending on whether require document upload or not.
PODetails.NetPaymentTerms
Integer The term of net payment in days.
PODetails.CopyPreviousDocuments
Boolean TRUE or FALSE, depending on whether copy documents from previous order or not.
PODetails.PdfFormUrl
String URL of Purchase Order form which needs to be printed, signed and uploaded.
PODetails.InternalPONumber
String Identifier that business customers use internally in their organization to track and manage Purchase Orders (PO). Can be NULL.
ExtraInformation
Optional (object) Details below.
ExtraInformation.PaymentLink
String Can be:
1. The PO doc upload link - If you set AutoApprove as FALSE on the original order and before shoppers upload the PO.
2. Payment link for orders with POs. Business customers can use the PaymentLink to finalize payment for orders with POs. If you set AutoApprove as TRUE on the original order and if 2Checkout and you approve the PO.
PaymentLink
String In scenarios in which an issue blocks the transaction from finalizing, 2Checkout provides a retry link where shopper can complete their purchase by providing new payment details.
PartnerCode
String Partner code you configured for your partner. NULL for eStore orders.
PartnerMargin
Float Partner margin you set for the order. NULL for eStore orders.
PartnerMarginPercent
Float The percentage of the partner margin from the net value of the products ordered, minus the value of any discounts. NULL for eStore orders.
ExtraMargin
Float Extra margin you offer by editing partner orders. NULL for eStore orders.
ExtraMarginPercent
Float The percentage of the extra partner margin from the net value of the products ordered, minus the partner margin and the value of any discounts. NULL for eStore orders.
ExtraDiscount
Float Extra discount you offer by editing partner orders. NULL for eStore orders.
ExtraDiscountPercent
Float The percentage of the partner margin from the net value of the products ordered, minus the value of any coupon discounts. NULL for eStore orders.
LocalTime
String Local shopper time in the following format: Y-m-d H:i:s.
This parameter can impact the fraud score of an order when it's missing, NULL or incorrectly formatted.
TestOrder
Boolean True for test orders. False of regular orders.
Errors
Array of strings Payment gateway processing errors.
Items
Array of objects Details below.
Items.ProductDetails
Object
Items.ProductDetails.Name
String Product name.
Items.ProductDetails.ShortDescription
String Product short description.
Items.ProductDetails.Tangible
Boolean true or false, depending on product delivery type.
Items.ProductDetails.IsDynamic
Boolean
Possible values:
true - dynamic product information
false - catalog products
Items.ProductDetails.ExtraInfo
String The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.
Items.ProductDetails.RenewalStatus
Boolean
true for orders renewing subscriptions.
false for all other orders: new purchases, upgrades.
Items.ProductDetails.DeliveryInformation
Object Details below
Items.ProductDetails.DeliveryInformation.Delivery
String
Possible values:
BY_VENDOR
NO_DELIVERY
BY_AVANGATE
Items.ProductDetails.DeliveryInformation.DownloadFile
Object Information related to the download file.
Items.ProductDetails.DeliveryInformation.DeliveryDescription
String Delivery description.
Items.ProductDetails.DeliveryInformation.CodesDescription
String Description of codes delivered.
Items.ProductDetails.DeliveryInformation.Codes
Array of strings Array with the codes delivered
Items.ProductDetails.Subscriptions.SubscriptionReference
String Unique, system-generated subscription identifier.
Items.ProductDetails.Subscriptions.PurchaseDate
String
The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the 2Checkout system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.
e.g. 2015-08-11 15:18:52
Items.ProductDetails.Subscriptions.SubscriptionStartDate
String Example: 2015-09-29 17:57:59
Items.ProductDetails.Subscriptions.ExpirationDate
String The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings.
Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00.
e.g. 2015-09-11 15:18:52
Items.ProductDetails.Subscriptions.Lifetime
Boolean
true – For non-recurring, evergreen subscriptions.
false – For recurring subscriptions with a specific billing cycle from 7 days to 36 months.
Items.ProductDetails.Subscriptions.Trial
Boolean
true – For trial subscriptions.
false – For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.
Items.ProductDetails.Subscriptions.Enabled
Boolean
true – For active and past due subscriptions.
false – For expired and cancelled subscriptions.
Items.ProductDetails.Subscriptions.RecurringEnabled
Boolean
Items.UpgradeInformation
Object
Items.UpgradeInformation.SubscriptionReference
String Unique, system-generated subscription identifier.
Items.PriceOptions
Array of strings Array of price option codes.
Items.PriceOptions.Code
String Unique code that the 2Checkout system generates or that you set for each pricing options group.
Items.PriceOptions.Required
Boolean
true – you require shoppers to select the price option through the way in which you configured pricing.
false – you do not require shoppers to select the price option.
Items.PriceOptions.Options
Array of strings
The code you set or that the 2Checkout system generates for each price option child inside a pricing options group parent.
Items.Price
Object This object returns the price per unit at order line level.
In the case of trials, the object returns the costs for the trial to full subscription conversion.
Items.Price.UnitNetPrice
Float The value per product unit, excluding sales tax/VAT expressed in the payment currency.
Items.Price.UnitGrossPrice
Float Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Items.Price.UnitVAT
Float Sales tax/VAT per product unit expressed in the payment currency.
Items.Price.UnitDiscount
Float Value of the discount per product unit expressed in the payment currency.
Items.Price.UnitNetDiscountedPrice
Float The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which 2Checkout deducts the unit discount.
Items.Price.UnitGrossDiscountedPrice
Float Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Items.Price.UnitAffiliateCommission
Float Value of the affiliate commission per product unit calculated expressed in the payment currency.
2Checkout deducts discounts from the costs incurred by shoppers before calculating affiliate commissions.
2Checkout does not take into account shipping costs when calculating affiliate commissions.
NULL when 2Checkout does not apply an affiliate commission.
Items.Price.Currency
String
The currency ISO code for the payment - ISO 4217. Example: usd.
Items.Price.NetPrice
Float The value per order line, excluding sales tax/VAT expressed in the payment currency.
Items.Price.GrossPrice
Float Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Items.Price.NetDiscountedPrice
Float The NetPrice value per order line (in the payment currency), excluding sales tax/VAT, from which 2Checkout deducts discounts.
Items.Price.GrossDiscountedPrice
Float
Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Example:
UnitNetPrice: 99
UnitGrossPrice: 120.39
UnitVAT: 21.39
UnitDiscount: 9.9
UnitNetDiscountedPrice: 89.1
UnitGrossDiscountedPrice: 110.49
UnitAffiliateCommission: 22.28
Currency: "usd"
NetPrice: 198
GrossPrice: 240.77
NetDiscountedPrice: 178.2
GrossDiscountedPrice: 220.97
Discount: 19.8
VAT: 42.77
AffiliateCommission: 44.56
Items.Price.Discount
Float Value of the discounts per order line expressed in the payment currency.
Items.Price.VAT
Float Value of sales tax/VAT per order line expressed in the payment currency.
Items.Price.AffiliateCommission
Float Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.
Items.Price.VATPercent
Integer Percentage of the VAT/tax applied to the order.
Items.Price.HandlingFeeNetPrice
Integer Handling fee applied to the NET price configuration.
Items.Price.HandlingFeeGrossPrice
Integer Handling fee applied to the GROSS price configuration.
Items.LineItemReference
String System-generated reference for the product item.
Items.PurchaseType
String
Possible values:
PRODUCT
SHIPPING
TAX
COUPON
Items.Code
String Unique product identifier your control. Max length 256 characters.
Items.Quantity
Integer Number of units
Items.SKU
String SKU identifier.
Items.CrossSell
Object Details below.
Items.CrossSell.ParentCode
String The product code of the master product you set to trigger the campaign.
Items.CrossSell.CampaignCode
String Unique, system-generated identifier for cross-sell campaigns.
Items.Trial
Object Details below.
Items.Trial.Period
Integer The length of the trial subscription lifetime in days.
Items.Trial.GrossPrice
Float Total trial price in the payment currency before 2Checkout deducts any taxes, discounts, etc.
Items.Trial.VAT
Float The total value of taxes for the trial in the payment currency, before 2Checkout deducts any discounts.
Items.Trial.NetPrice
Float Total trial price in the payment currency, not including taxes, before 2Checkout deducts any discounts.
Items.AdditionalFields
Array of objects Details below.
Items.AdditionalFields.Code
String The alpha-numeric characters, underscores and dashes that are set as the field identifier.
Items.AdditionalFields.Text
String Field text visible to shoppers in the cart.
Items.AdditionalFields.Value
String Selected field value.
Items.Promotion
Object Details below.
Items.Promotion.Name
String Promotion name.
Items.Promotion.Description
String Promotion description.
Items.Promotion.StartDate
String The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
Items.Promotion.EndDate
String The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Items.Promotion.MaximumOrdersNumber
Integer
2Checkout only applies the promotion to a maximum number of orders you define.
Can be NULL if you want the promotion to apply to an unlimited number of orders.
Items.Promotion.MaximumQuantity
Integer Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Items.Promotion.InstantDiscount
Boolean The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
Items.Promotion.Coupon
String Promotion coupon/voucher.
Items.Promotion.DiscountLabel
String Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
Items.Promotion.Enabled
String true or false, depending on whether a promotion is active or disabled.
Items.Promotion.Type
String
REGULAR – product/cart line level discounts.
ORDER – quantity discounts.
GLOBAL – order-level discounts.
AFFILIATE – for discounts created by affiliates.
Promotions
Array of objects Details below.
Promotions.Name
String Promotion name.
Promotions.Description
String Promotion description.
Promotions.StartDate
String The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
Promotions.EndDate
String The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Promotions.MaximumOrdersNumber
Integer 2Checkout only applies the promotion to a maximum number of orders you define.
Can be NULL if you want the promotion to apply to an unlimited number of orders.
Promotions.MaximumQuantity
Integer Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Promotions.InstantDiscount
Boolean The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
Promotions.Coupon
String Promotion coupon/voucher.
Promotions.DiscountLabel
String Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
Promotions.Enabled
String true or false, depending on whether a promotion is active or disabled.
Promotions.Type
String
REGULAR – product/cart line level discounts.
ORDER – quantity discounts.
GLOBAL – order-level discounts.
AFFILIATE – for discounts created by affiliates.
AdditionalFields
Array of objects Details below.
AdditionalFields.Code
String The alpha-numeric characters, underscores and dashes that are set as the field identifier.
AdditionalFields.Text
String Field text visible to shoppers in the cart.
AdditionalFields.Value
String Selected field value.
Currency
String The currency ISO code for the payment - ISO 4217. Example: usd.
NetPrice
Float Order value excluding sales tax/VAT expressed in the payment currency.
GrossPrice
Float Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
NetDiscountedPrice
Float The NetPrice order value excluding sales tax/VAT, from which 2Checkout deducts discounts. NetDiscountedPrice is expressed in the payment currency.
GrossDiscountedPrice
Float
Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
For example:
Currency: "usd"
NetPrice: 396
GrossPrice: 486.29
NetDiscountedPrice: 376.2
GrossDiscountedPrice: 466.49
Discount: 19.8
VAT: 90.29
AffiliateCommission: 94.05
Discount
Float Value of the discounts for an order expressed in the payment currency.
VAT
Float Value of sales tax/VAT expressed in the payment currency.
AffiliateCommission
Float Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.
FxRate
Integer Exchange rate used by 2Checkout for converting the order to your payout currency.
FxMarkup
Integer Exchange rate markup for the order.
PayoutCurrency
String The ISO code of your account's payout currency - ISO 4217.
Last updated
Was this helpful?