LogoLogo
Shopper APIs reference
Shopper APIs reference
  • Shopper APIs reference
  • OAuth
    • Tokens
    • Access tokens
  • Shoppers
    • Shoppers
    • Addresses
    • Payment options
  • Browse (product discovery)
    • Categories
    • Products
    • Product variations
    • Pricing
    • Inventory status
    • Financing
    • Offers
    • Purchase plan
    • Find a purchase plan
    • Authorize a purchase plan
  • Cart
    • Apply a shopper to a cart
    • Line items
    • Billing address
    • Shipping address
    • Payment methods
    • Shipping options
    • Web checkout
    • Submit a cart
    • Apply or detach payment methods
    • Apply a shipping option
    • Carts
    • Cart offers
    • API trigger offer
    • Resume cart
    • Third-party subscription engine
    • Tax registration
    • Price override
  • Orders
    • Orders
    • Order lookup
    • Order address
    • Returns
  • Subscriptions
    • Manage a subscription
    • Manage the subscription's renewal plan
    • Immediate midterm change
    • Payment
    • Address
    • Orders
    • Pending actions
    • Retrieve subscriptions
    • Subscription billing and shipping addresses
Powered by GitBook
On this page
  1. Cart

Tax registration

PreviousThird-party subscription engineNextPrice override

Last updated 4 months ago

Remove tax registration on cart

delete

Remove the tax regitrations data from customer's cart.

Query parameters
tokenstringRequired

Authorized or anonymous token for a customer.

Responses
204
Successful response.
409
* vat-exemption-failure
application/json
delete
DELETE /v1/shoppers/me/carts/active/tax-registrations HTTP/1.1
Host: api.digitalriver.com
Accept: */*

No content

  • GETGet cart tax registrations
  • POSTUpdate tax registration on cart
  • DELETERemove tax registration on cart

Get cart tax registrations

get

Gets all tax regitrations data to the customer's cart.

Notes: Below path has been deprecated.
GET /carts/{cartId}/tax-registrations

Query parameters
apiKeystringOptional

The client identifier used to authorize the request. You must specify either an apiKey or a token.

tokenstringOptional

Authorized or anonymous token for a customer. You must specify either an apiKey or a token.

Responses
200
Successful response.
application/json
409
* ip-address-restriction-error
application/json
get
GET /v1/shoppers/me/carts/active/tax-registrations HTTP/1.1
Host: api.digitalriver.com
Accept: */*
[
  {
    "key": "UK_VAT",
    "value": "GB698588737"
  }
]

Update tax registration on cart

post

Updates the tax regitrations data to the customer's cart.

Notes: Below path has been deprecated.
POST /carts/{cartId}/tax-registrations

Query parameters
tokenstringRequired

Authorized or anonymous token for a customer.

Body
keystringOptional

Tax Registration Key

Example: UK_VAT
valuestringOptional

Tax ID value

Example: GB698588737
Responses
200
Successful response.
application/json
400
* missing-information * missing-customer-type * missing-tax-registrations
application/json
409
* vat-exemption-failure * invalid-customer-type * missing-tax-identification * invalid-tax-identification
application/json
post
POST /v1/shoppers/me/carts/active/tax-registrations HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  {
    "key": "UK_VAT",
    "value": "GB698588737"
  }
]
[
  {
    "key": "UK_VAT",
    "value": "GB698588737"
  }
]