Tax Registration
Cart tax registration schema
Gets the corresponding JSON Schema for attaching tax registrations to a cart. For schema definition, please refer to JSON Schema Specification for more information.
Notes: Below path has been deprecated.
GET /carts/{cartId}/tax-registrations/schema
get/v1/shoppers/me/carts/active/tax-registrations/schema
Query parameters
apiKeystring
The client identifier used to authorize the request. You must specify either an apiKey or token.
tokenstring
The customer's ID. You must specify either an apiKey or token.
Response
Successful response.
Example response
{
"oneOf": [
{
"type": "object",
"title": "Business",
"properties": {
"customerType": {
"type": "string",
"readOnly": true,
"enum": [
"B"
]
},
"taxRegistrations": {
"type": "array",
"title": "Tax Registrations",
"minItems": 1,
"maxItems": 1,
"items": [
{
"$ref": "#/definitions/UK_VAT"
}
]
},
"companyId": {
"type": "string"
},
"siteId": {
"type": "string"
}
}
}
],
"definitions": {
"{TAX_KEY}": {
"type": "string",
"properties": {
"key": {
"type": "string",
"readOnly": true,
"enum": [
"UK_VAT"
]
},
"value": {
"type": "string",
"title": "VAT Number",
"description": "Please enter your VAT number including the two letter country code and without any punctuation marks or spaces such as GB123456789 or GB123456789012.",
"pattern": "^[Gg]{1}[Bb]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}$,^[Gg]{1}[Bb]{1}[A-Za-z]{1}[A-Za-z]{1}[0-9]{1}[0-9]{1}[0-9]{1}$,^[Gg]{1}[Bb]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}[0-9]{1}$"
}
}
}
}
}