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

* docs: clarify ISO format for province codes * regenerate
2025-04-24 15:44:35 +03:00
1 parent cb16f79b8f
commit 97daa5a41c
@@ -39,6 +39,12 @@ A service zone is represented by the [ServiceZone data model](/references/fulfil

 A service zone can have multiple geographical zones, each represented by the [GeoZone data model](/references/fulfillment/models/GeoZone). It holds location-related details to narrow down supported areas, such as country, city, or province code.

+<Note title="Tip">
+
+The province code is always in lower-case and in [ISO 3166-2 format](https://en.wikipedia.org/wiki/ISO_3166-2).
+
+</Note>
+
 ---

 ## Shipping Profile
@@ -26,6 +26,12 @@ For example, a fulfillment provider may have a shipping option that can be used

 Service zones can be more restrictive, such as restricting to certain cities or province codes.

+<Note title="Tip">
+
+The province code is always in lower-case and in [ISO 3166-2 format](https://en.wikipedia.org/wiki/ISO_3166-2).
+
+</Note>
+
 ![A diagram showcasing the relation between shipping options, service zones, and geo zones](https://res.cloudinary.com/dza7lstvk/image/upload/v1712331186/Medusa%20Resources/shipping-option-service-zone-city_m5sxod.jpg)

 ---
@@ -56,7 +56,7 @@ You also must pass at least one of the following query parameters to retrieve an
        `province`
      </Table.Cell>
      <Table.Cell>
-        The province, which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
+        The lower-case [ISO 3166-2 province code](https://en.wikipedia.org/wiki/ISO_3166-2), which can be taken from a customer's address. This parameter helps further narrowing down the taxes applied on a the product variant's prices.
      </Table.Cell>
    </Table.Row>
    <Table.Row>