You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: api-specs/api/types/product/ProductDraft.raml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ properties:
23
23
description: |
24
24
User-defined unique identifier for the Product.
25
25
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).
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](/../api/import-export/) and the [Merchant Center](/../merchant-center/import-data).
27
27
28
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}$`.
Copy file name to clipboardExpand all lines: api-specs/api/types/product/updates/ProductSetKeyAction.raml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -10,4 +10,4 @@ properties:
10
10
description: |
11
11
Value to set. If empty, any existing value will be removed.
12
12
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}$`.
13
+
To update a Product using the [Import API](/../api/import-export/) and the [Merchant Center](/../merchant-center/import-data), the Product `key` must match the pattern `^[A-Za-z0-9_-]{2,256}$`.
Creates a new import request for Product Variant Patches.
534
-
Returns an [InvalidField](/error#invalidfielderror) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
534
+
Returns an [InvalidField](ctp:import:type:InvalidFieldError) error if the [ProductVariantPatchRequest](ctp:import:type:ProductVariantPatchRequest) contains patches with and without the `product` field set.
Copy file name to clipboardExpand all lines: api-specs/import/types/category-import.raml
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,12 @@ uses:
10
10
types:
11
11
CategoryImport:
12
12
description: |
13
-
The data representation for a Category to be imported that is persisted as a [Category](/../api/projects/categories#category) in the Project.
13
+
The data representation for a Category to be imported that is persisted as a [Category](ctp:api:type:Category) in the Project.
14
14
type: common.ImportResource
15
15
properties:
16
16
key:
17
17
type: string
18
-
description: User-defined unique identifier. If a [Category](/../api/projects/categories#category) with this `key` exists, it will be updated with the imported data.
18
+
description: User-defined unique identifier. If a [Category](ctp:api:type:Category) with this `key` exists, it will be updated with the imported data.
19
19
pattern: ^[A-Za-z0-9_-]+$
20
20
minLength: 2
21
21
maxLength: 256
@@ -35,8 +35,8 @@ types:
35
35
parent?:
36
36
description: |
37
37
Maps to `Category.parent`.
38
-
The Reference to the parent [Category](/../api/projects/categories#category) with which the Category is associated.
39
-
If referenced Category does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Category is created.
38
+
The Reference to the parent [Category](ctp:api:type:Category) with which the Category is associated.
39
+
If referenced Category does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Category is created.
Copy file name to clipboardExpand all lines: api-specs/import/types/common.raml
+9-3Lines changed: 9 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -209,9 +209,14 @@ types:
209
209
properties:
210
210
container: string
211
211
UnresolvedReferences:
212
+
description: References a resource which could not be resolved.
212
213
properties:
213
-
key: string
214
-
typeId: ReferenceType
214
+
key:
215
+
type: string
216
+
description: The `key` of the resource.
217
+
typeId:
218
+
type: ReferenceType
219
+
description: The type of resource.
215
220
MoneyType:
216
221
type: string
217
222
enum:
@@ -245,6 +250,7 @@ types:
245
250
properties:
246
251
value:
247
252
type: TypedMoney
253
+
description: Money value of the discounted price.
248
254
discount:
249
255
description: Reference to a ProductDiscount.
250
256
type: ProductDiscountKeyReference
@@ -344,7 +350,7 @@ types:
344
350
- key-value-document
345
351
ProcessingState:
346
352
description: |
347
-
Every [Import Operation](/import-operation) is assigned one of the following states.
353
+
Every [Import Operation](ctp:import:type:ImportOperation) is assigned one of the following states.
348
354
(annotations.enumDescriptions):
349
355
processing: The initial state assigned if the request payload (JSON structure and fields) meets Import API specifications. The resource import is in progress.
Copy file name to clipboardExpand all lines: api-specs/import/types/customer-import.raml
+98-29Lines changed: 98 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -19,47 +19,116 @@ types:
19
19
ExternalAuth: If set, the `password` field is optional for the Customer.
20
20
CustomerAddress:
21
21
description: |
22
-
Different from Address in that `key` is required and `id` is not supported.
22
+
Different from [Address](/types#address) in that `key` is required and `id` is not supported.
23
23
properties:
24
24
key:
25
25
description: |
26
26
User-defined identifier for the address.
27
27
Must follow the pattern `[a-zA-Z0-9_\-]{2,256}` and must be unique per customer.
28
28
type: string
29
-
title?: string
30
-
salutation?: string
31
-
firstName?: string
32
-
lastName?: string
33
-
streetName?: string
34
-
streetNumber?: string
35
-
additionalStreetInfo?: string
36
-
postalCode?: string
37
-
city?: string
38
-
region?: string
39
-
state?: string
40
-
country: common.CountryCode
41
-
company?: string
42
-
department?: string
43
-
building?: string
44
-
apartment?: string
45
-
pOBox?: string
46
-
phone?: string
47
-
mobile?: string
48
-
email?: string
49
-
fax?: string
50
-
additionalAddressInfo?: string
51
-
externalId?: string
29
+
country:
30
+
type: common.CountryCode
31
+
description: |
32
+
Name of the country.
33
+
title?:
34
+
type: string
35
+
description: |
36
+
Title of the contact, for example 'Dr.'
37
+
salutation?:
38
+
type: string
39
+
description: |
40
+
Salutation of the contact, for example 'Mr.' or 'Ms.'
41
+
firstName?:
42
+
type: string
43
+
description: |
44
+
Given name (first name) of the contact.
45
+
lastName?:
46
+
type: string
47
+
description: |
48
+
Family name (last name) of the contact.
49
+
streetName?:
50
+
type: string
51
+
description: |
52
+
Name of the street.
53
+
streetNumber?:
54
+
type: string
55
+
description: |
56
+
Street number.
57
+
additionalStreetInfo?:
58
+
type: string
59
+
description: |
60
+
Further information on the street address.
61
+
postalCode?:
62
+
type: string
63
+
description: |
64
+
Postal code.
65
+
city?:
66
+
type: string
67
+
description: |
68
+
Name of the city.
69
+
region?:
70
+
type: string
71
+
description: |
72
+
Name of the region.
73
+
state?:
74
+
type: string
75
+
description: |
76
+
Name of the state, for example, Colorado.
77
+
company?:
78
+
type: string
79
+
description: |
80
+
Name of the company.
81
+
department?:
82
+
type: string
83
+
description: |
84
+
Name of the department.
85
+
building?:
86
+
type: string
87
+
description: |
88
+
Number or name of the building.
89
+
apartment?:
90
+
type: string
91
+
description: |
92
+
Number or name of the apartment.
93
+
pOBox?:
94
+
type: string
95
+
description: |
96
+
Post office box number.
97
+
phone?:
98
+
type: string
99
+
description: |
100
+
Phone number of the contact.
101
+
mobile?:
102
+
type: string
103
+
description: |
104
+
Mobile phone number of the contact.
105
+
email?:
106
+
type: string
107
+
description: |
108
+
Email address of the contact.
109
+
fax?:
110
+
type: string
111
+
description: |
112
+
Fax number of the contact.
113
+
additionalAddressInfo?:
114
+
type: string
115
+
description: |
116
+
Further information on the Address.
117
+
externalId?:
118
+
type: string
119
+
description: |
120
+
ID for the contact used in an external system.
52
121
custom?:
53
122
description: Custom Fields for the address.
54
123
type: custom-field.Custom
55
124
CustomerImport:
56
125
description: |
57
-
The data representation for a Customer to be imported that is persisted as a [Customer](/../api/projects/customers#top) in the Project.
126
+
The data representation for a Customer to be imported that is persisted as a [Customer](ctp:api:type:Customer) in the Project.
58
127
type: common.ImportResource
59
128
properties:
60
129
key:
61
130
type: string
62
-
description: User-defined unique identifier. If a [Customer](/../api/projects/customers#customer) with this `key` exists, it will be updated with the imported data.
131
+
description: User-defined unique identifier. If a [Customer](ctp:api:type:Customer) with this `key` exists, it will be updated with the imported data.
63
132
pattern: ^[A-Za-z0-9_-]+$
64
133
minLength: 2
65
134
maxLength: 256
@@ -77,7 +146,7 @@ types:
77
146
type: string
78
147
stores?:
79
148
description: |
80
-
The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary Stores are created.
149
+
The References to the Stores with which the Customer is associated. If referenced Stores do not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary Stores are created.
81
150
type: common.StoreKeyReference[]
82
151
firstName?:
83
152
description: |
@@ -121,8 +190,8 @@ types:
121
190
type: boolean
122
191
customerGroup?:
123
192
description: |
124
-
The Reference to the [CustomerGroup](/../api/projects/customerGroups#customergroup) with which the Customer is associated.
125
-
If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](/import-operation#importoperation) will be set to `unresolved` until the necessary CustomerGroup is created.
193
+
The Reference to the [CustomerGroup](ctp:api:type:CustomerGroup) with which the Customer is associated.
194
+
If referenced CustomerGroup does not exist, the `state` of the [ImportOperation](ctp:import:type:ImportOperation) will be set to `unresolved` until the necessary CustomerGroup is created.
Copy file name to clipboardExpand all lines: api-specs/import/types/discount-code-import.raml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ types:
32
32
description: |
33
33
User-defined unique identifier of the DiscountCode that is used by the customer to apply the discount.
34
34
35
-
The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/error#invalidfieldsupdateerror) error.
35
+
The value cannot be updated. Attempting to update the value will result in an [InvalidFieldsUpdate](/import-export/error#invalidfieldsupdateerror) error.
Copy file name to clipboardExpand all lines: api-specs/import/types/error.raml
+11-7Lines changed: 11 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -34,13 +34,17 @@ types:
34
34
The errors that caused this error response.
35
35
type: ErrorObject[]
36
36
ErrorObject:
37
-
description:
37
+
description: |
38
+
Base representation of an error response containing common fields to all errors.
39
+
40
+
An error response may contain additional fields depending on the type of an error, for example, `attribute` in [DuplicateAttributeValueError](#duplicateattributevalueerror).
38
41
discriminator: code
39
42
properties:
40
43
code:
44
+
description: An error identifier.
41
45
type: string
42
46
message:
43
-
description:
47
+
description:A plain language description of the cause of an error.
44
48
type: string
45
49
AccessDeniedError:
46
50
description: This is the generic error code for access denied. In case of a wrong scope, an [InvalidScopeError](#invalidscopeerror) will be returned.
@@ -58,15 +62,15 @@ types:
58
62
type: ErrorObject
59
63
discriminatorValue: InvalidOperation
60
64
DuplicateAttributeValueError:
61
-
description: The `Unique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated.
65
+
description: The `Unique` [AttributeConstraintEnum](ctp:api:type:AttributeConstraintEnum) was violated.
62
66
type: ErrorObject
63
67
discriminatorValue: DuplicateAttributeValue
64
68
properties:
65
69
attribute:
66
70
description: The attribute in conflict.
67
71
type: product-variant-import.Attribute
68
72
DuplicateAttributeValuesError:
69
-
description: The `CombinationUnique` [AttributeConstraintEnum](/../api/projects/productTypes#attributeconstraintenum) was violated.
73
+
description: The `CombinationUnique` [AttributeConstraintEnum](ctp:api:type:AttributeConstraintEnum) was violated.
70
74
type: ErrorObject
71
75
discriminatorValue: DuplicateAttributeValues
72
76
properties:
@@ -85,8 +89,8 @@ types:
85
89
type: any
86
90
DuplicateVariantValuesError:
87
91
description: |
88
-
The given combination of values of a [Product Variant](/../api/projects/products#productvariant) conflicts with an existing one.
89
-
Every [Product Variant](/../api/projects/products#productvariant) must have a distinct combination of SKU, prices, and custom attribute values.
92
+
The given combination of values of a [Product Variant](ctp:api:type:ProductVariant) conflicts with an existing one.
93
+
Every [Product Variant](ctp:api:type:ProductVariant) must have a distinct combination of SKU, prices, and custom attribute values.
90
94
type: ErrorObject
91
95
discriminatorValue: DuplicateVariantValues
92
96
properties:
@@ -113,7 +117,7 @@ types:
113
117
InvalidFieldError:
114
118
description: |
115
119
A given field is not supported.
116
-
This error occurs, for example, if the field `variants`, which is not supported by [Product Import](/product#productimport), is sent to the Product Import endpoint.
120
+
This error occurs, for example, if the field `variants`, which is not supported by [Product Import](ctp:import:type:ProductImport), is sent to the Product Import endpoint.
![ct-sdks[bot]](https://avatars.githubusercontent.com/u/1084585?v=4&size=40){kind=avatar}
0 commit comments