Transmitting order details
The Merchant can transmit the shopping cart content in his or her payment request in order to display it on PayPal payment pages.
The information below is necessary for benefiting from merchant protection provided by PayPal.
This information can be found in the transaction details in the Merchant Back Office (Shopping cart tab).
- Use optional fields according to your requirements. These fields will be returned with the response and will include the value transmitted in the form.
Field name Description Format Value vads_order_id Order ID Can contain uppercase or lowercase characters, numbers or hyphens ([A-Z] [a-z], 0-9, _, -).
ans..64 E.g.: 2-XQ001 vads_order_info Additional order info ans..255 E.g.: Door code 3125 vads_order_info2 Additional order info ans..255 E.g.: No elevator vads_order_info3 Additional order info ans..255 E.g.: Express vads_nb_products Number of items in the cart n..12 E.g.: 2 vads_product_labelN Item name. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). ans..255 E.g.: vads_product_label0 = "tee-shirt"
vads_product_label1 = "Biscuit"
vads_product_label2 = "sandwich"
vads_product_amountN Price of the item incl. VAT. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). n..12 E.g.: vads_product_amount0 = "1200"
vads_product_amount1 = "800"
vads_product_amount2 = "950"
vads_product_typeN Item type. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). enum E.g.: vads_product_type0 = "CLOTHING_AND_ACCESSORIES"
vads_product_type1 = "FOOD_AND_GROCERY"
vads_product_type2 = "FOOD_AND_GROCERY"
vads_product_refN Item reference. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). an..64 E.g.: vads_product_ref0 = "CAA-25-006"
vads_product_ref1 = "FAG-B5-112"
vads_product_ref2 = "FAG-S9-650"
vads_product_qtyN Item quantity. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.). n..12 E.g.: vads_product_qty0 = "1"
vads_product_qty1 = "2"
vads_product_qty2 = "2"
vads_shipping_amount Shipping fee amount n..12 vads_tax_amount Tax amount for the entire order n..12 vads_insurance_amount Insurance amount for the entire order n..12 - Value the fieldvads_nb_productswhere the number of the articles in the cart. This field becomes mandatory for the shopping cart to be taken into account.
When it is populated, the Shopping cart tab becomes available in the transaction details in the Merchant Back Office.
However, if the other fields beginning withvads_product_are not populated, the tab will not contain any information. For this reason, by populating the fieldvads_nb_products, it becomes mandatory to populate the other fields starting withvads_product_.
- Value the fieldvads_product_amountNwith the amount for the items in the cart, using the smallest currency unit. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
- Value the fieldvads_product_typeNwith the value corresponding to the item type. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
Value Description FOOD_AND_GROCERY Food and grocery AUTOMOTIVE Cars / Moto ENTERTAINMENT Entertainment / Culture HOME_AND_GARDEN Home / Gardening HOME_APPLIANCE Household appliances AUCTION_AND_GROUP_BUYING Auctions / Group purchasing FLOWERS_AND_GIFTS Flowers / Presents COMPUTER_AND_SOFTWARE Computers / Software HEALTH_AND_BEAUTY Health / Beauty SERVICE_FOR_INDIVIDUAL Services for individuals SERVICE_FOR_BUSINESS Services for companies SPORTS Sports CLOTHING_AND_ACCESSORIES Clothes / Accessories TRAVEL Travel HOME_AUDIO_PHOTO_VIDEO Audio / Photo / Video TELEPHONY Telephony - Value the fieldvads_product_labelNwith the label of each article in the cart. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
- Value the fieldvads_product_qtyNwith the quantity of each article in the cart. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
- Value the fieldvads_product_refNwith the reference of each article in the cart. N corresponds to the index of the item (0 for the first one, 1 for the second one, etc.).
- Value the fieldvads_shipping_amountwith the shipping fees amount for the entire order. The amount is expressed in the smallest currency unit.E.g.: 4525 for EUR 45.25.
- Value the fieldvads_tax_amountwith the tax amount for the entire order. The amount is expressed in the smallest currency unit.E.g.: 4525 for EUR 45.25.
- Value the fieldvads_insurance_amountwith the insurance amount for the entire order. The amount is expressed in the smallest currency unit.E.g.: 4525 for EUR 45.25.
- Control the value of the fieldvads_amount. It must correspond to the total amount of the order.
Note:
The applied equation is:
Sum ( vads_product_qty(N) x vads_product_amount(N) ) + vads_shipping_amount + vads_tax_amount + vads_insurance_amount = vads_amount
If the value specified in the vads_amount field is incorrect, your payment form is rejected due to an amount error.