Order object

Unique, system-generated, order reference number.

Do not include it when placing new orders or send it as NULL.

The link source for the sales. 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.

GrossDiscountedPrice

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

VAT

AffiliateCommission

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.

Specify the date time stamp when the subscription becomes active. Format 2016-07-02 22:22:22 (YYYY-MM-DD HH:mm:ss). Available for JSON-RPC and REST.

Send empty or NULL to activate subscriptions on the same date when customers purchase them.

You can exclude HH:mm:ss when sending the date and include only YYYY-MM-DD. In this case, 2Checkout uses 00:00:01. Default time zone GMT+02:00.

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.

• REGULAR – product/cart line level discounts.
• ORDER – quantity discounts.
• GLOBAL – order-level discounts.

Optional (string) – Required for US, Brazil, India and Romania

The state in the shopper's country. Mandatory when you set the Billing Country to US, Brazil, India and Romania. Use case insensitive utf8 strings for the full name, or just the two letter code.

• 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 you set Brazil as the Billing Country. For Brazilian customers it represents the Fiscal Code (CPF/CNPJ).

• Mandatory when you set India as Billing Country, and purchase is made by a Company.

• Can be NULL for end users.

The payment method:

• CC (credit/debit card - including local Brazilian cards).
• ENCRYPTED_PAYMENT_DATA (client-side encryption)
• 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.
• WE_CHAT_PAY (for WeChat payments).
• IDEAL (for iDEAL payments).
• PURCHASEORDER - use for orders with POs.
• FREE – for 0 value orders for which you’re not requiring customers to provide payment details.

Object structure and parameters differ according to payment method selected and API method (placing orders (POST) vs. retrieving order data (GET)).

NULL for 0 value orders for which you’re not requiring customers to enter payment details.

true – shopper checks the auto-renewal checkbox and 2Checkout charges subscription renewals using a recurring billing process.

false – shopper doesn’t check the auto-renewal checkbox.

The interval of time in seconds in which shoppers enter their name in the HolderName field. An abnormally short interval is usually a red flag for fraud attempts.

Can be NULL, but not a negative number.

The interval of time in seconds in which shopper enter their card number in the CardNumber field. An abnormally short interval is usually a red flag for fraud attempts.

Can be NULL, but not a negative number.

Order reference a previous purchase which reached the Approved/Complete status. You can use order for which customers paid with credit/debit cards or with PayPal. The status of order should be AUTHRECEIVED or COMPLETE.

Check the validity of references with the isValidOrderReference method.

The 2Checkout system blocks you from using references for fraudulent or potentially fraudulent orders.

TRUE - requires activation of the PO AutoApprove package (If the package is inactive 2Checkout returns an error). Please contact 2Checkout. When AutoApprove is TRUE, 2Checkout no longer requires that business customers upload a PO document. As such, PO orders are automatically approved for your account, without a PO doc. 2Checkout sets the PURCHASE_PENDING status for auto-approved PO orders.

FALSE - Default. Send this if the PO AUtoApprove package is not available for your account. 2Checkout uses the same flow as cart purchases with Purchase Orders for business customers placing orders with POs via API. This means that customers receive the same emails as if they made the purchase using the cart and need to update the PO document, which is reviewed by 2Checkout and that you need to approve. 2Checkout sets the AVAITING_UPLOAD status for POs andUnfinished for their orders.

Can be NULL.

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.