Skip to content

Commit 8e5c10a

Browse files
committed
Updated API from documentation release
1 parent c8c2455 commit 8e5c10a

File tree

6 files changed

+12
-2
lines changed

6 files changed

+12
-2
lines changed

api-specs/api/types/category/CategoryDraft.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ properties:
5555
type: string
5656
description: |
5757
User-defined unique identifier for the Category.
58+
59+
This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Categories with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).
5860
pattern: ^[A-Za-z0-9_-]+$
5961
minLength: 2
6062
maxLength: 256

api-specs/api/types/customer/CustomerDraft.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ properties:
88
description: |
99
User-defined unique identifier for the Customer.
1010
The `key` field is preferred over `customerNumber` as it is mutable and provides more flexibility.
11+
12+
This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Customers with the [Import API](/../import-export/).
1113
pattern: ^[A-Za-z0-9_-]+$
1214
minLength: 2
1315
maxLength: 256

api-specs/api/types/discount-code/DiscountCodeDraft.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ properties:
77
type: string
88
description: |-
99
User-defined unique identifier for the DiscountCode.
10+
11+
This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Discount Codes with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).
1012
pattern: ^[A-Za-z0-9_-]+$
1113
minLength: 2
1214
maxLength: 256

api-specs/api/types/inventory/InventoryEntryDraft.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ properties:
1111
type: string
1212
description: |
1313
User-defined unique identifier for the InventoryEntry.
14+
15+
This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing InventoryEntries with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).
1416
pattern: ^[A-Za-z0-9_-]+$
1517
minLength: 2
1618
maxLength: 256

api-specs/api/types/product/ProductDraft.raml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ properties:
2323
description: |
2424
User-defined unique identifier for the Product.
2525
26-
To update a Product using the [Import API](/../import-export/product), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
26+
This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data).
27+
28+
To update a Product using the Import API or Merchant Center, the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
2729
description?:
2830
type: LocalizedString
2931
description: |

api-specs/api/types/product/updates/ProductSetKeyAction.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ properties:
1010
description: |
1111
Value to set. If empty, any existing value will be removed.
1212
13-
To update a Product using the [Import API](/../import-export/product), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
13+
To update a Product using the [Import API](/../import-export/) and the [Merchant Center](/../merchant-center/import-data), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.

0 commit comments

Comments
 (0)