woocommerce
/
src
/
Blocks
/
Domain
/
Services
/
CheckoutFieldsSchema
/
checkout-document-schema.json
DocumentObject.php
11 months ago
Validation.php
1 year ago
checkout-document-schema.json
11 months ago
json-schema-draft-07.json
1 year ago
checkout-document-schema.json
206 lines
| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "title": "Cart and Checkout Document Object Schema", |
| 4 | "description": "Document object schema for cart, checkout, and customer information, to be used for conditional visibility, requirement, and validation of fields.", |
| 5 | "type": "object", |
| 6 | "properties": { |
| 7 | "cart": { |
| 8 | "type": "object", |
| 9 | "description": "Information about the shopping cart", |
| 10 | "properties": { |
| 11 | "coupons": { |
| 12 | "type": "array", |
| 13 | "description": "List of coupon codes applied to the cart", |
| 14 | "items": { |
| 15 | "type": "string" |
| 16 | } |
| 17 | }, |
| 18 | "shipping_rates": { |
| 19 | "type": "array", |
| 20 | "description": "List of currently selected shipping rates", |
| 21 | "items": { |
| 22 | "type": "string", |
| 23 | "description": "Shipping rate identifier using the full shipping rate ID so method_id:instance_id, for example: flat_rate:1" |
| 24 | } |
| 25 | }, |
| 26 | "items": { |
| 27 | "type": "array", |
| 28 | "description": "List of product IDs in the cart, IDs will be duplicated depending on the quantity of the product in the cart, so if you have 2 of product ID 1, the array will have 2 entries of product ID 1", |
| 29 | "items": { |
| 30 | "type": "integer" |
| 31 | } |
| 32 | }, |
| 33 | "items_type": { |
| 34 | "type": "array", |
| 35 | "description": "Types of items in the cart, for example: simple, variation, subscription, etc.", |
| 36 | "items": { |
| 37 | "type": "string" |
| 38 | } |
| 39 | }, |
| 40 | "items_count": { |
| 41 | "type": "integer", |
| 42 | "description": "Total number of items in the cart", |
| 43 | "minimum": 0 |
| 44 | }, |
| 45 | "items_weight": { |
| 46 | "type": "number", |
| 47 | "description": "Total weight of items in the cart", |
| 48 | "minimum": 0 |
| 49 | }, |
| 50 | "needs_shipping": { |
| 51 | "type": "boolean", |
| 52 | "description": "Whether the items in the cart require shipping" |
| 53 | }, |
| 54 | "prefers_collection": { |
| 55 | "type": "boolean", |
| 56 | "description": "Whether the customer prefers using Local Pickup" |
| 57 | }, |
| 58 | "totals": { |
| 59 | "type": "object", |
| 60 | "description": "Cart totals information", |
| 61 | "properties": { |
| 62 | "total_price": { |
| 63 | "type": "integer", |
| 64 | "description": "Total price of the cart in smallest currency unit (e.g., cents), after applying all discounts, shipping, and taxes" |
| 65 | }, |
| 66 | "total_tax": { |
| 67 | "type": "integer", |
| 68 | "description": "Total tax amount in smallest currency unit (e.g., cents), after applying all discounts, shipping, and taxes" |
| 69 | } |
| 70 | }, |
| 71 | "additionalProperties": false |
| 72 | }, |
| 73 | "extensions": { |
| 74 | "type": "object", |
| 75 | "description": "Additional cart extension data, this is similar to what's passed in Store API's extensions parameter" |
| 76 | } |
| 77 | }, |
| 78 | "additionalProperties": false |
| 79 | }, |
| 80 | "checkout": { |
| 81 | "type": "object", |
| 82 | "description": "Checkout preferences and settings", |
| 83 | "properties": { |
| 84 | "create_account": { |
| 85 | "type": "boolean", |
| 86 | "description": "Whether the customer checked the create account checkbox, this will be false if the customer is logged in, cannot create an account, or forced to create an account." |
| 87 | }, |
| 88 | "customer_note": { |
| 89 | "type": "string", |
| 90 | "description": "Customer's note or special instructions for the order, this will be empty if the customer didn't add a note." |
| 91 | }, |
| 92 | "additional_fields": { |
| 93 | "type": "object", |
| 94 | "description": "Additional checkout fields, limited to the order location.", |
| 95 | "additionalProperties": { |
| 96 | "type": "string" |
| 97 | }, |
| 98 | "patternProperties": { |
| 99 | "^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$": { |
| 100 | "type": "string", |
| 101 | "description": "Custom fields with namespace identifiers" |
| 102 | } |
| 103 | } |
| 104 | }, |
| 105 | "payment_method": { |
| 106 | "type": "string", |
| 107 | "description": "Selected payment method identifier, this will be the payment method ID regardless if the customer selected a saved payment method or new payment method" |
| 108 | } |
| 109 | }, |
| 110 | "additionalProperties": false |
| 111 | }, |
| 112 | "customer": { |
| 113 | "type": "object", |
| 114 | "description": "Customer information", |
| 115 | "properties": { |
| 116 | "id": { |
| 117 | "type": "integer", |
| 118 | "description": "Customer ID, this will be 0 if the customer is not logged in" |
| 119 | }, |
| 120 | "billing_address": { |
| 121 | "$ref": "#/definitions/address", |
| 122 | "description": "Customer's billing address" |
| 123 | }, |
| 124 | "shipping_address": { |
| 125 | "$ref": "#/definitions/address", |
| 126 | "description": "Customer's shipping address" |
| 127 | }, |
| 128 | "additional_fields": { |
| 129 | "type": "object", |
| 130 | "description": "Additional checkout fields, limited to the contact location.", |
| 131 | "additionalProperties": { |
| 132 | "type": "string" |
| 133 | } |
| 134 | }, |
| 135 | "address": { |
| 136 | "$ref": "#/definitions/address", |
| 137 | "description": "This is a dynamic field that will be the billing or shipping address depending on the context of the field being evaluated." |
| 138 | } |
| 139 | }, |
| 140 | "additionalProperties": false |
| 141 | } |
| 142 | }, |
| 143 | "additionalProperties": false, |
| 144 | "definitions": { |
| 145 | "address": { |
| 146 | "type": "object", |
| 147 | "description": "Customer address information", |
| 148 | "properties": { |
| 149 | "first_name": { |
| 150 | "type": "string", |
| 151 | "description": "First name of the recipient" |
| 152 | }, |
| 153 | "last_name": { |
| 154 | "type": "string", |
| 155 | "description": "Last name of the recipient" |
| 156 | }, |
| 157 | "company": { |
| 158 | "type": "string", |
| 159 | "description": "Company name" |
| 160 | }, |
| 161 | "address_1": { |
| 162 | "type": "string", |
| 163 | "description": "Primary address line" |
| 164 | }, |
| 165 | "address_2": { |
| 166 | "type": "string", |
| 167 | "description": "Secondary address line" |
| 168 | }, |
| 169 | "city": { |
| 170 | "type": "string", |
| 171 | "description": "City name" |
| 172 | }, |
| 173 | "state": { |
| 174 | "type": "string", |
| 175 | "description": "State or province, this will be the state code if it's a predefined list, for example: CA, TX, NY, etc, or the field value if it's a freeform state, for example: London." |
| 176 | }, |
| 177 | "postcode": { |
| 178 | "type": "string", |
| 179 | "description": "Postal or ZIP code" |
| 180 | }, |
| 181 | "country": { |
| 182 | "type": "string", |
| 183 | "description": "Country code (e.g., US, UK)" |
| 184 | }, |
| 185 | "email": { |
| 186 | "type": "string", |
| 187 | "description": "Email address" |
| 188 | }, |
| 189 | "phone": { |
| 190 | "type": "string", |
| 191 | "description": "Phone number" |
| 192 | } |
| 193 | }, |
| 194 | "additionalProperties": { |
| 195 | "type": "string", |
| 196 | "description": "Custom fields with namespace identifiers" |
| 197 | }, |
| 198 | "patternProperties": { |
| 199 | "^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$": { |
| 200 | "type": "string", |
| 201 | "description": "Custom fields with namespace identifiers" |
| 202 | } |
| 203 | } |
| 204 | } |
| 205 | } |
| 206 | } |