Skip to content

Commit be31ccd

Browse files
ORDERS-7170 update customer_locale description in doc (#1045)
update customer_locale description in doc <!-- Ticket number or summary of work --> # [ORDERS-7179](https://bigcommercecloud.atlassian.net/browse/ORDERS-7170) ## What changed? <!-- Provide a bulleted list in the present tense --> * since we support new format of customer locale validation, so update customer_locale description for the supported format in doc ## Release notes draft <!-- Provide an entry for the release notes using simple, conversational language. Don't be too technical. Explain how the change will benefit the merchant and link to the feature. Examples: * The newly-released [X feature] is now available to use. Now, you’ll be able to [perform Y action]. * We're happy to announce [X feature], which can help you [perform Y action]. * [X feature] helps you to create [Y response] using the [Z query parameter]. Now, you can deliver [ex, localized shopping experiences for your customers]. * Fixed a bug in the [X endpoint]. Now the [Y field] will appear when you click [Z option]. --> <img width="782" height="530" alt="Screenshot 2025-08-15 at 10 33 23 am" src="https://github.com/user-attachments/assets/f07ec4b1-1f10-46ce-be80-f37f4110fd23" /> ## Anything else? <!-- Add related PRs, salient notes, additional ticket numbers, etc. --> ping @bigcommerce/team-orders
1 parent 5de1b84 commit be31ccd

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

reference/orders.v2.oas2.yml

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ paths:
113113
114114
> #### Note
115115
> * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing.
116-
116+
117117
summary: Update an Order
118118
tags:
119119
- Orders
@@ -386,7 +386,7 @@ paths:
386386
> #### Note
387387
> * If historical orders processed on another eCommerce platform are being migrated to BigCommerce, supply the `external_source` field with the code **M-MIG**. This code will exclude the historical orders from the store’s GMV/order count, which factors into pricing.
388388
389-
389+
390390
summary: Create an Order
391391
tags:
392392
- Orders
@@ -4158,8 +4158,13 @@ components:
41584158
type: string
41594159
customer_locale:
41604160
type: string
4161-
example: en
4162-
description: The customer’s locale.
4161+
example: en, asa, en-US, es-419
4162+
description: |
4163+
The customer’s locale. The supported formats are:
4164+
- 2-char lowercase characters. e.g., `en`
4165+
- 3-char lowercase characters. e.g., `asa`
4166+
- 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-` in the middle. e.g., `en-US`
4167+
- 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in the middle. e.g., `es-419`
41634168
external_order_id:
41644169
type: string
41654170
example: external-order-id
@@ -4876,8 +4881,13 @@ components:
48764881
type: string
48774882
customer_locale:
48784883
type: string
4879-
example: en
4880-
description: The customer’s locale.
4884+
example: en, asa, en-US, es-419
4885+
description: |
4886+
The customer’s locale. The supported formats are:
4887+
- 2-char lowercase characters. e.g., `en`
4888+
- 3-char lowercase characters. e.g., `asa`
4889+
- 5-char the language code is 2 lowercase characters and the region code is 2 uppercase characters, with `-` in the middle. e.g., `en-US`
4890+
- 6-char the language code is 2 lowercase character and the region code is three digit number, with `-` in the middle. e.g., `es-419`
48814891
external_order_id:
48824892
type: string
48834893
nullable: true

0 commit comments

Comments
 (0)