Capturing the Terms of Sale (TOS) acceptance
Learn how to add a TOS acceptance.
You capture when a customer accepts the TOS. The following requests allow a customer to accept the TOS from the cart:
- Submit Cart:
POST /v1/shoppers/me/carts/active/submit-cart - Update or Create Cart:
POST /v1/shoppers/me/carts/active
You can use a DigitalRiver object provided by DigitalRiver.js to create the TOS required by Digital River.
If you want the customer to accept the TOS, you need to add the
termsOfSalesAcceptance parameter when you create the Cart. Parameter | Description |
|---|---|
termsOfSalesAcceptance | The Terms of Sale Acceptance. The enumerated values are true or false. |
Create a Cart object with a
POST request:Request body
201 Created response
{
"cart": {
"ipAddress": "10.24.2.28"
"termsOfSalesAcceptance": "true"
}
}
A
201 Created response returns a Cart object:{
"uri": "https://api.digitalriver.com/v1/shoppers/me/carts/active",
"paymentMethods": {},
"applyPaymentMethod": {},
"submitCart": {},
"webCheckout": {},
"id": "47278010023",
"lineItems": {},
"totalItemsInCart": "1",
"businessEntityCode": "DR_INC-ENTITY",
"termsOfSalesAcceptance":"true"
"billingAddress": {},
"shippingAddress": {},
"payment": {},
"shippingOptions": {},
"pricing": {}
}
How a user accepts the TOS depends on which option you selected when you configured Terms of Sale Acceptance on the Checkout tab under Configure Site Settings in Global Commerce.
If you chose Shopper passively accepts terms through order submission, the customer accepts the TOS when they submit the order. Digital River requires this setting when we are the Reseller of Record.
If you chose Shopper actively accepts terms before completing the purchase, the customer must click the checkbox to accept the TOS. Sites based in the EU require this setting.
Choose No Acceptance Required if your site does not require the customer to accept the TOS.