docs: clarify ISO format for province codes (#12282)

* docs: clarify ISO format for province codes

* regenerate
This commit is contained in:
Shahed Nasser
2025-04-24 15:44:35 +03:00
committed by GitHub
parent cb16f79b8f
commit 97daa5a41c
39 changed files with 14830 additions and 14654 deletions
@@ -654,12 +654,16 @@
* description: "Storefront guide: How to show product variants' prices with taxes."
* - name: province
* in: query
* description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* required: false
* schema:
* type: string
* title: province
* description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* description: The lower-case ISO 3166-2 province code the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* - name: sales_channel_id
* in: query
* required: false
@@ -55,12 +55,16 @@
* description: The country code the product is being viewed from. This is required if you're retrieving product variant prices with taxes.
* - name: province
* in: query
* description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* required: false
* schema:
* type: string
* title: province
* description: The province the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* description: The lower-case ISO 3166-2 province code the product is being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* - name: cart_id
* in: query
* description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
@@ -76,7 +76,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code
@@ -137,7 +141,7 @@
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "province": "us-ca",
* "postal_code": "{value}",
* "address_name": "{value}"
* }'
@@ -82,7 +82,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's ISO 3166-2 province code. Must be lower-case.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* postal_code:
* type: string
* title: postal_code