asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts
+11 -3
View File
@@ -110,13 +110,21 @@
* oneOf:
* - type: string
* title: province
* description: Filter by a province.
* description: Filter by an 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
* - type: array
* description: Filter by provinces.
* description: Filter by ISO 3166-2 provinces.
* items:
* type: string
* title: province
* description: A province code.
* description: A 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
* - name: postal_code
* in: query
* required: false
www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts
+11 -3
View File
@@ -133,13 +133,21 @@
* oneOf:
* - type: string
* title: province_code
* description: Filter by a province code.
* description: Filter by a 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
* - type: array
* description: Filter by province codes.
* description: Filter by ISO 3166-2 province codes.
* items:
* type: string
* title: province_code
* description: A province code.
* description: A ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* - type: object
* description: Apply filters on the province code.
* properties:
www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts
+6 -2
View File
@@ -94,7 +94,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
@@ -151,7 +155,7 @@
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "province": "us-ca",
* "postal_code": "{value}",
* "phone": "{value}",
* "metadata": {}
www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts
+5 -1
View File
@@ -100,7 +100,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
www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts
+10 -2
View File
@@ -107,7 +107,11 @@
* province:
* type: string
* title: province
* description: The billing address's province.
* description: The billing 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
@@ -166,7 +170,11 @@
* province:
* type: string
* title: province
* description: The shipping address's province.
* description: The shipping 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
www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts
+15 -3
View File
@@ -88,7 +88,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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
* - type: object
* description: A city geo zone
* required:
@@ -113,7 +117,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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
* city:
* type: string
* title: city
@@ -143,7 +151,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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
* city:
* type: string
* title: city
www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+15 -3
View File
@@ -96,7 +96,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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
* id:
* type: string
* title: id
@@ -129,7 +133,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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
* id:
* type: string
* title: id
@@ -163,7 +171,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone'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_expression:
* type: object
* description: The geo zone's postal expression or ZIP code.
www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts
+1 -1
View File
@@ -79,7 +79,7 @@
* "address_2": "{value}",
* "city": "{value}",
* "country_code": "{value}",
* "province": "{value}",
* "province": "us-ca",
* "postal_code": "{value}",
* "metadata": {}
* },
www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts
+2 -2
View File
@@ -42,7 +42,7 @@
*
* sdk.admin.taxRegion.create({
* country_code: "us",
* province_code: "ca",
* province_code: "us-ca",
* default_tax_rate: {
* code: "VAT",
* name: "VAT",
@@ -61,7 +61,7 @@
* -H 'Content-Type: application/json' \
* --data-raw '{
* "country_code": "{value}",
* "province_code": "{value}",
* "province_code": "us-ca",
* "parent_id": "{value}",
* "metadata": {}
* }'
www/utils/generated/oas-output/operations/store/get_store_products.ts
+6 -2
View File
@@ -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
www/utils/generated/oas-output/operations/store/get_store_products_[id].ts
+6 -2
View File
@@ -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.
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts
+6 -2
View File
@@ -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}"
* }'
www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts
+5 -1
View File
@@ -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
www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts
+5 -1
View File
@@ -60,7 +60,11 @@
* province:
* type: string
* title: province
* description: The delivery address's province.
* description: The delivery 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
www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts
+5 -1
View File
@@ -14,7 +14,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region'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
* parent_id:
* type: string
* title: parent_id
www/utils/generated/oas-output/schemas/AdminCustomerAddress.ts
+5 -1
View File
@@ -75,7 +75,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/AdminFulfillmentAddress.ts
+5 -1
View File
@@ -60,7 +60,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/AdminGeoZone.ts
+5 -1
View File
@@ -33,7 +33,11 @@
* province_code:
* type: string
* title: province_code
* description: The geo zone's province code.
* description: The geo zone's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* city:
* type: string
* title: city
www/utils/generated/oas-output/schemas/AdminOrderAddress.ts
+5 -1
View File
@@ -55,7 +55,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/AdminStockLocationAddress.ts
+5 -1
View File
@@ -40,7 +40,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* required:
* - id
* - address_1
www/utils/generated/oas-output/schemas/AdminTaxRegion.ts
+5 -1
View File
@@ -29,7 +29,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region's lower-case ISO 3166-2 province code.
* example: "us-ca"
* externalDocs:
* url: https://en.wikipedia.org/wiki/ISO_3166-2
* description: Learn more about ISO 3166-2
* metadata:
* type: object
* description: The tax region's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminUpdateDraftOrder.ts
+10 -2
View File
@@ -49,7 +49,11 @@
* province:
* type: string
* title: province
* description: The shipping address's province.
* description: The shipping 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
@@ -97,7 +101,11 @@
* province:
* type: string
* title: province
* description: The billing address's province.
* description: The billing 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
www/utils/generated/oas-output/schemas/AdminUpdateOrder.ts
+10 -2
View File
@@ -49,7 +49,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
@@ -97,7 +101,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
www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts
+5 -1
View File
@@ -47,7 +47,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
* address_id:
* type: string
* title: address_id
www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts
+5 -1
View File
@@ -7,7 +7,11 @@
* province_code:
* type: string
* title: province_code
* description: The tax region's province code.
* description: The tax region'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
* metadata:
* type: object
* description: The tax region's metadata, can hold custom key-value pairs.
www/utils/generated/oas-output/schemas/AdminUpsertStockLocationAddress.ts
+5 -1
View File
@@ -39,7 +39,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
*
*/
www/utils/generated/oas-output/schemas/BaseOrderAddress.ts
+5 -1
View File
@@ -53,7 +53,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/CreateAddress.ts
+5 -1
View File
@@ -40,7 +40,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
www/utils/generated/oas-output/schemas/OrderAddress.ts
+5 -1
View File
@@ -52,7 +52,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/StoreCartAddress.ts
+5 -1
View File
@@ -52,7 +52,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts
+5 -1
View File
@@ -75,7 +75,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/StoreOrderAddress.ts
+5 -1
View File
@@ -55,7 +55,11 @@
* province:
* type: string
* title: province
* description: The address's province.
* description: The address's lower-case ISO 3166-2 province code.
* 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
www/utils/generated/oas-output/schemas/UpdateAddress.ts
+5 -1
View File
@@ -46,7 +46,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