diff --git a/source/includes/wp-api-v3/_taxes.md b/source/includes/wp-api-v3/_taxes.md index e4b9eee..7990049 100644 --- a/source/includes/wp-api-v3/_taxes.md +++ b/source/includes/wp-api-v3/_taxes.md @@ -9,8 +9,10 @@ The taxes API allows you to create, view, update, and delete individual tax rate | `id` | integer | Unique identifier for the resource. read-only | | `country` | string | Country ISO 3166 code. See [ISO 3166 Codes (Countries)](http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html) for more details | | `state` | string | State code. | -| `postcode` | string | Postcode/ZIP. | -| `city` | string | City name. | +| `postcode` | string | Postcode/ZIP, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, `postcodes` should be used instead. | +| `city` | string | City name, it doesn't support multiple values. Deprecated as of WooCommerce 5.3, `postcodes` should be used instead. | +| `postcodes`| string[] | Postcodes/ZIPs. Introduced in WooCommerce 5.3. | +| `cities` | string[] | City names. Introduced in WooCommerce 5.3. | | `rate` | string | Tax rate. | | `name` | string | Tax rate name. | | `priority` | integer | Tax priority. Only 1 matching rate per priority will be used. To define multiple tax rates for a single area you need to specify a different priority per rate. Default is `1`. | @@ -39,6 +41,8 @@ curl -X POST https://example.com/wp-json/wc/v3/taxes \ -d '{ "country": "US", "state": "AL", + "cities": ["Alpine", "Brookside", "Cardiff"], + "postcodes": ["35014", "35036", "35041"], "rate": "4", "name": "State Tax", "shipping": false @@ -49,6 +53,8 @@ curl -X POST https://example.com/wp-json/wc/v3/taxes \ const data = { country: "US", state: "AL", + cities: ["Alpine", "Brookside", "Cardiff"], + postcodes: ["35014", "35036", "35041"], rate: "4", name: "State Tax", shipping: false @@ -68,6 +74,8 @@ WooCommerce.post("taxes", data) $data = [ 'country' => 'US', 'state' => 'AL', + 'cities' => ['Alpine', 'Brookside', 'Cardiff'], + 'postcodes' => ['35014', '35036', '35041'], 'rate' => '4', 'name' => 'State Tax', 'shipping' => false @@ -81,6 +89,8 @@ print_r($woocommerce->post('taxes', $data)); data = { "country": "US", "state": "AL", + "cities": ["Alpine", "Brookside", "Cardiff"], + "postcodes": ["35014", "35036", "35041"], "rate": "4", "name": "State Tax", "shipping": False @@ -93,6 +103,8 @@ print(wcapi.post("taxes", data).json()) data = { country: "US", state: "AL", + cities: ["Alpine", "Brookside", "Cardiff"], + postcodes: ["35014", "35036", "35041"], rate: "4", name: "State Tax", shipping: false @@ -108,8 +120,18 @@ woocommerce.post("taxes", data).parsed_response "id": 72, "country": "US", "state": "AL", - "postcode": "", - "city": "", + "postcode": "35041", + "city": "Cardiff", + "postcodes": [ + "35014", + "35036", + "35041" + ], + "cities": [ + "Alpine", + "Brookside", + "Cardiff" + ], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -177,8 +199,18 @@ woocommerce.get("taxes/72").parsed_response "id": 72, "country": "US", "state": "AL", - "postcode": "", - "city": "", + "postcode": "35041", + "city": "Cardiff", + "postcodes": [ + "35014", + "35036", + "35041" + ], + "cities": [ + "Alpine", + "Brookside", + "Cardiff" + ], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -249,8 +281,18 @@ woocommerce.get("taxes").parsed_response "id": 72, "country": "US", "state": "AL", - "postcode": "", - "city": "", + "postcode": "35041", + "city": "Cardiff", + "postcodes": [ + "35014", + "35036", + "35041" + ], + "cities": [ + "Alpine", + "Brookside", + "Cardiff" + ], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -277,6 +319,8 @@ woocommerce.get("taxes").parsed_response "state": "AZ", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.6000", "name": "State Tax", "priority": 0, @@ -303,6 +347,8 @@ woocommerce.get("taxes").parsed_response "state": "AR", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.5000", "name": "State Tax", "priority": 0, @@ -329,6 +375,8 @@ woocommerce.get("taxes").parsed_response "state": "CA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.5000", "name": "State Tax", "priority": 0, @@ -355,6 +403,8 @@ woocommerce.get("taxes").parsed_response "state": "CO", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "2.9000", "name": "State Tax", "priority": 0, @@ -381,6 +431,8 @@ woocommerce.get("taxes").parsed_response "state": "CT", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.3500", "name": "State Tax", "priority": 0, @@ -407,6 +459,8 @@ woocommerce.get("taxes").parsed_response "state": "DC", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.7500", "name": "State Tax", "priority": 0, @@ -433,6 +487,8 @@ woocommerce.get("taxes").parsed_response "state": "FL", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -459,6 +515,8 @@ woocommerce.get("taxes").parsed_response "state": "GA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -485,6 +543,8 @@ woocommerce.get("taxes").parsed_response "state": "GU", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -517,8 +577,8 @@ woocommerce.get("taxes").parsed_response | `per_page` | integer | Maximum number of items to be returned in result set. | | `offset` | integer | Offset the result set by a specific number of items. | | `order` | string | Order sort attribute ascending or descending. Default is `asc`. Options: `asc` and `desc`. | -| `orderby` | string | Sort collection by object attribute. Default is `name`. Options: `id`, `include`, `name`, `slug`, `term_group`, `description` and `count`. | -| `class` | string | Sort by tax class. | +| `orderby` | string | Sort collection by object attribute. Default is `order`. Options: `id`, `order` and `priority`. | +| `class` | string | Retrieve only tax rates of this Tax class. | ## Update a tax rate ## @@ -589,8 +649,18 @@ woocommerce.put("taxes/72", data).parsed_response "id": 72, "country": "US", "state": "AL", - "postcode": "", - "city": "", + "postcode": "35041", + "city": "Cardiff", + "postcodes": [ + "35014", + "35036", + "35041" + ], + "cities": [ + "Alpine", + "Brookside", + "Cardiff" + ], "rate": "4.0000", "name": "US Tax", "priority": 0, @@ -662,8 +732,18 @@ woocommerce.delete("taxes/72", force: true).parsed_response "id": 72, "country": "US", "state": "AL", - "postcode": "", - "city": "", + "postcode": "35041", + "city": "Cardiff", + "postcodes": [ + "35014", + "35036", + "35041" + ], + "cities": [ + "Alpine", + "Brookside", + "Cardiff" + ], "rate": "4.0000", "name": "US Tax", "priority": 0, @@ -2696,6 +2776,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "AL", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -2722,6 +2804,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "AZ", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.6000", "name": "State Tax", "priority": 0, @@ -2748,6 +2832,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "AR", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.5000", "name": "State Tax", "priority": 0, @@ -2774,6 +2860,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "CA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.5000", "name": "State Tax", "priority": 0, @@ -2800,6 +2888,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "CO", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "2.9000", "name": "State Tax", "priority": 0, @@ -2826,6 +2916,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "CT", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.3500", "name": "State Tax", "priority": 0, @@ -2852,6 +2944,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "DC", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.7500", "name": "State Tax", "priority": 0, @@ -2878,6 +2972,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "FL", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -2904,6 +3000,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "GA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -2930,6 +3028,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "GU", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -2956,6 +3056,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "HI", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -2982,6 +3084,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "ID", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3008,6 +3112,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "IL", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.2500", "name": "State Tax", "priority": 0, @@ -3034,6 +3140,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "IN", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.0000", "name": "State Tax", "priority": 0, @@ -3060,6 +3168,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "IA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3086,6 +3196,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "KS", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.1500", "name": "State Tax", "priority": 0, @@ -3112,6 +3224,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "KY", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3138,6 +3252,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "LA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -3164,6 +3280,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "ME", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.5000", "name": "State Tax", "priority": 0, @@ -3190,6 +3308,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MD", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3216,6 +3336,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.2500", "name": "State Tax", "priority": 0, @@ -3242,6 +3364,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MI", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3268,6 +3392,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MN", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.8750", "name": "State Tax", "priority": 0, @@ -3294,6 +3420,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MS", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.0000", "name": "State Tax", "priority": 0, @@ -3320,6 +3448,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "MO", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.2250", "name": "State Tax", "priority": 0, @@ -3346,6 +3476,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NE", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.5000", "name": "State Tax", "priority": 0, @@ -3372,6 +3504,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NV", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.8500", "name": "State Tax", "priority": 0, @@ -3398,6 +3532,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NJ", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.0000", "name": "State Tax", "priority": 0, @@ -3424,6 +3560,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NM", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.1250", "name": "State Tax", "priority": 0, @@ -3450,6 +3588,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NY", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -3476,6 +3616,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "NC", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.7500", "name": "State Tax", "priority": 0, @@ -3502,6 +3644,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "ND", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.0000", "name": "State Tax", "priority": 0, @@ -3528,6 +3672,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "OH", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.7500", "name": "State Tax", "priority": 0, @@ -3554,6 +3700,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "OK", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.5000", "name": "State Tax", "priority": 0, @@ -3580,6 +3728,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "PA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3606,6 +3756,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "PR", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3632,6 +3784,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "RI", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.0000", "name": "State Tax", "priority": 0, @@ -3658,6 +3812,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "SC", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3684,6 +3840,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "SD", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0, @@ -3710,6 +3868,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "TN", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "7.0000", "name": "State Tax", "priority": 0, @@ -3736,6 +3896,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "TX", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.2500", "name": "State Tax", "priority": 0, @@ -3762,6 +3924,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "UT", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.9500", "name": "State Tax", "priority": 0, @@ -3788,6 +3952,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "VT", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3814,6 +3980,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "VA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.3000", "name": "State Tax", "priority": 0, @@ -3840,6 +4008,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "WA", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.5000", "name": "State Tax", "priority": 0, @@ -3866,6 +4036,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "WV", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "6.0000", "name": "State Tax", "priority": 0, @@ -3892,6 +4064,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "WI", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "5.0000", "name": "State Tax", "priority": 0, @@ -3918,6 +4092,8 @@ woocommerce.post("taxes/batch", data).parsed_response "state": "WY", "postcode": "", "city": "", + "postcodes": [], + "cities": [], "rate": "4.0000", "name": "State Tax", "priority": 0,