@asstio-dev/storefront 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +143 -0
- package/dist/index.d.ts +46 -0
- package/dist/index.js +34 -0
- package/dist/schema.d.ts +1208 -0
- package/package.json +30 -0
- package/src/schema.d.ts +1208 -0
package/src/schema.d.ts
ADDED
|
@@ -0,0 +1,1208 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/v1/categories": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/** Asstio category tree as data (facet source). Not pages. */
|
|
15
|
+
get: operations["GetCategories"];
|
|
16
|
+
put?: never;
|
|
17
|
+
post?: never;
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
24
|
+
"/v1/collections": {
|
|
25
|
+
parameters: {
|
|
26
|
+
query?: never;
|
|
27
|
+
header?: never;
|
|
28
|
+
path?: never;
|
|
29
|
+
cookie?: never;
|
|
30
|
+
};
|
|
31
|
+
/** The collection tree: the shop's list pages, for this market and language. */
|
|
32
|
+
get: operations["GetCollections"];
|
|
33
|
+
put?: never;
|
|
34
|
+
post?: never;
|
|
35
|
+
delete?: never;
|
|
36
|
+
options?: never;
|
|
37
|
+
head?: never;
|
|
38
|
+
patch?: never;
|
|
39
|
+
trace?: never;
|
|
40
|
+
};
|
|
41
|
+
"/v1/collections/{slugOrId}": {
|
|
42
|
+
parameters: {
|
|
43
|
+
query?: never;
|
|
44
|
+
header?: never;
|
|
45
|
+
path?: never;
|
|
46
|
+
cookie?: never;
|
|
47
|
+
};
|
|
48
|
+
/** One collection: itself, its breadcrumb, its children and its product listing (the /products shape). */
|
|
49
|
+
get: operations["GetCollection"];
|
|
50
|
+
put?: never;
|
|
51
|
+
post?: never;
|
|
52
|
+
delete?: never;
|
|
53
|
+
options?: never;
|
|
54
|
+
head?: never;
|
|
55
|
+
patch?: never;
|
|
56
|
+
trace?: never;
|
|
57
|
+
};
|
|
58
|
+
"/v1/products": {
|
|
59
|
+
parameters: {
|
|
60
|
+
query?: never;
|
|
61
|
+
header?: never;
|
|
62
|
+
path?: never;
|
|
63
|
+
cookie?: never;
|
|
64
|
+
};
|
|
65
|
+
/** Search and list products with facets. filter[<key>]=a,b for every facet, including price (min-max) and in-stock (true). */
|
|
66
|
+
get: operations["ListProducts"];
|
|
67
|
+
put?: never;
|
|
68
|
+
post?: never;
|
|
69
|
+
delete?: never;
|
|
70
|
+
options?: never;
|
|
71
|
+
head?: never;
|
|
72
|
+
patch?: never;
|
|
73
|
+
trace?: never;
|
|
74
|
+
};
|
|
75
|
+
"/v1/products/by-sku/{sku}": {
|
|
76
|
+
parameters: {
|
|
77
|
+
query?: never;
|
|
78
|
+
header?: never;
|
|
79
|
+
path?: never;
|
|
80
|
+
cookie?: never;
|
|
81
|
+
};
|
|
82
|
+
/** Look up a product by its own SKU or one of its variants'. matchedVariantId is set on a variant hit. */
|
|
83
|
+
get: operations["GetProductBySku"];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
92
|
+
"/v1/products/{slugOrId}": {
|
|
93
|
+
parameters: {
|
|
94
|
+
query?: never;
|
|
95
|
+
header?: never;
|
|
96
|
+
path?: never;
|
|
97
|
+
cookie?: never;
|
|
98
|
+
};
|
|
99
|
+
/** Product detail by current slug, historical slug or id. redirectTo is set for a historical slug. */
|
|
100
|
+
get: operations["GetProduct"];
|
|
101
|
+
put?: never;
|
|
102
|
+
post?: never;
|
|
103
|
+
delete?: never;
|
|
104
|
+
options?: never;
|
|
105
|
+
head?: never;
|
|
106
|
+
patch?: never;
|
|
107
|
+
trace?: never;
|
|
108
|
+
};
|
|
109
|
+
"/v1/products/{slugOrId}/variants": {
|
|
110
|
+
parameters: {
|
|
111
|
+
query?: never;
|
|
112
|
+
header?: never;
|
|
113
|
+
path?: never;
|
|
114
|
+
cookie?: never;
|
|
115
|
+
};
|
|
116
|
+
/** A product's variants, paged and in the product's order. filter[<axis>]=value narrows; options[].values[].available tells which values the other selections still allow. Use when the product's variants is null. */
|
|
117
|
+
get: operations["ListProductVariants"];
|
|
118
|
+
put?: never;
|
|
119
|
+
post?: never;
|
|
120
|
+
delete?: never;
|
|
121
|
+
options?: never;
|
|
122
|
+
head?: never;
|
|
123
|
+
patch?: never;
|
|
124
|
+
trace?: never;
|
|
125
|
+
};
|
|
126
|
+
"/v1/site": {
|
|
127
|
+
parameters: {
|
|
128
|
+
query?: never;
|
|
129
|
+
header?: never;
|
|
130
|
+
path?: never;
|
|
131
|
+
cookie?: never;
|
|
132
|
+
};
|
|
133
|
+
/** Site bootstrap: markets, URL patterns, config version. */
|
|
134
|
+
get: operations["GetSite"];
|
|
135
|
+
put?: never;
|
|
136
|
+
post?: never;
|
|
137
|
+
delete?: never;
|
|
138
|
+
options?: never;
|
|
139
|
+
head?: never;
|
|
140
|
+
patch?: never;
|
|
141
|
+
trace?: never;
|
|
142
|
+
};
|
|
143
|
+
"/v1/sitemap": {
|
|
144
|
+
parameters: {
|
|
145
|
+
query?: never;
|
|
146
|
+
header?: never;
|
|
147
|
+
path?: never;
|
|
148
|
+
cookie?: never;
|
|
149
|
+
};
|
|
150
|
+
/** Ids, slugs, URLs and lastmod for sitemap.xml and selective revalidation. type=product|collection, ?since= is inclusive. */
|
|
151
|
+
get: operations["GetSitemap"];
|
|
152
|
+
put?: never;
|
|
153
|
+
post?: never;
|
|
154
|
+
delete?: never;
|
|
155
|
+
options?: never;
|
|
156
|
+
head?: never;
|
|
157
|
+
patch?: never;
|
|
158
|
+
trace?: never;
|
|
159
|
+
};
|
|
160
|
+
}
|
|
161
|
+
export type webhooks = Record<string, never>;
|
|
162
|
+
export interface components {
|
|
163
|
+
schemas: {
|
|
164
|
+
AppliedFilterDto: {
|
|
165
|
+
facet: string;
|
|
166
|
+
label: string;
|
|
167
|
+
value: string;
|
|
168
|
+
};
|
|
169
|
+
CategoryNodeDto: {
|
|
170
|
+
children: components["schemas"]["CategoryNodeDto"][];
|
|
171
|
+
id: string;
|
|
172
|
+
name: string;
|
|
173
|
+
/** Format: int32 */
|
|
174
|
+
productCount: number | string;
|
|
175
|
+
};
|
|
176
|
+
CategoryRefDto: {
|
|
177
|
+
id: string;
|
|
178
|
+
name: string;
|
|
179
|
+
pathNames: string[];
|
|
180
|
+
};
|
|
181
|
+
CollectionCrumbDto: {
|
|
182
|
+
id: string;
|
|
183
|
+
name: string;
|
|
184
|
+
path: string;
|
|
185
|
+
slug: string;
|
|
186
|
+
url: string;
|
|
187
|
+
};
|
|
188
|
+
CollectionDto: {
|
|
189
|
+
children: components["schemas"]["CollectionDto"][];
|
|
190
|
+
id: string;
|
|
191
|
+
name: string;
|
|
192
|
+
path: string;
|
|
193
|
+
slug: string;
|
|
194
|
+
url: string;
|
|
195
|
+
};
|
|
196
|
+
CollectionListingResponse: {
|
|
197
|
+
alternateUrls: {
|
|
198
|
+
[key: string]: string;
|
|
199
|
+
};
|
|
200
|
+
breadcrumb: components["schemas"]["CollectionCrumbDto"][];
|
|
201
|
+
collection: components["schemas"]["CollectionDto"];
|
|
202
|
+
listing: components["schemas"]["ListingResponse"];
|
|
203
|
+
};
|
|
204
|
+
CollectionRefDto: {
|
|
205
|
+
id: string;
|
|
206
|
+
name: string;
|
|
207
|
+
path: string;
|
|
208
|
+
slug: string;
|
|
209
|
+
url: string;
|
|
210
|
+
};
|
|
211
|
+
FacetDto: {
|
|
212
|
+
key: string;
|
|
213
|
+
label: string;
|
|
214
|
+
match: string;
|
|
215
|
+
range: null | components["schemas"]["RangeDto"];
|
|
216
|
+
searchable: boolean;
|
|
217
|
+
truncated: boolean;
|
|
218
|
+
type: string;
|
|
219
|
+
values: components["schemas"]["FacetValueDto"][];
|
|
220
|
+
};
|
|
221
|
+
FacetValueDto: {
|
|
222
|
+
children: components["schemas"]["FacetValueDto"][] | null;
|
|
223
|
+
/** Format: int64 */
|
|
224
|
+
count: number | string;
|
|
225
|
+
key: string;
|
|
226
|
+
label: string;
|
|
227
|
+
pinned: boolean;
|
|
228
|
+
selected: boolean;
|
|
229
|
+
swatch: null | components["schemas"]["SwatchDto"];
|
|
230
|
+
};
|
|
231
|
+
ListingResponse: {
|
|
232
|
+
appliedFilters: components["schemas"]["AppliedFilterDto"][];
|
|
233
|
+
facets: components["schemas"]["FacetDto"][];
|
|
234
|
+
items: components["schemas"]["ProductCardDto"][];
|
|
235
|
+
/** Format: int32 */
|
|
236
|
+
page: number | string;
|
|
237
|
+
/** Format: int32 */
|
|
238
|
+
pageSize: number | string;
|
|
239
|
+
queryCorrection: null | string;
|
|
240
|
+
redirect: null | string;
|
|
241
|
+
sort: components["schemas"]["SortDto"];
|
|
242
|
+
/** Format: int64 */
|
|
243
|
+
total: number | string;
|
|
244
|
+
warnings: components["schemas"]["WarningDto"][];
|
|
245
|
+
};
|
|
246
|
+
MarketDto: {
|
|
247
|
+
code: string;
|
|
248
|
+
country: string;
|
|
249
|
+
currency: string;
|
|
250
|
+
language: string;
|
|
251
|
+
urlTemplate: string;
|
|
252
|
+
};
|
|
253
|
+
OptionDto: {
|
|
254
|
+
name: string;
|
|
255
|
+
values: string[];
|
|
256
|
+
};
|
|
257
|
+
PriceDto: {
|
|
258
|
+
amount: string;
|
|
259
|
+
compareAt: null | string;
|
|
260
|
+
currency: string;
|
|
261
|
+
vatIncluded: boolean;
|
|
262
|
+
vatRate: string;
|
|
263
|
+
};
|
|
264
|
+
ProductCardDto: {
|
|
265
|
+
collections: string[];
|
|
266
|
+
id: string;
|
|
267
|
+
inStock: boolean;
|
|
268
|
+
name: string;
|
|
269
|
+
price: null | components["schemas"]["PriceDto"];
|
|
270
|
+
priceVaries: boolean;
|
|
271
|
+
sku: string;
|
|
272
|
+
slug: string;
|
|
273
|
+
/** Format: date-time */
|
|
274
|
+
updatedAt: string;
|
|
275
|
+
url: string;
|
|
276
|
+
};
|
|
277
|
+
ProductDto: {
|
|
278
|
+
alternateUrls: {
|
|
279
|
+
[key: string]: string;
|
|
280
|
+
};
|
|
281
|
+
categories: components["schemas"]["CategoryRefDto"][];
|
|
282
|
+
collections: components["schemas"]["CollectionRefDto"][];
|
|
283
|
+
id: string;
|
|
284
|
+
matchedVariantId: null | string;
|
|
285
|
+
name: string;
|
|
286
|
+
options: components["schemas"]["OptionDto"][];
|
|
287
|
+
redirectTo: null | string;
|
|
288
|
+
seo: components["schemas"]["SeoDto"];
|
|
289
|
+
sku: string;
|
|
290
|
+
slug: string;
|
|
291
|
+
/** Format: date-time */
|
|
292
|
+
updatedAt: string;
|
|
293
|
+
url: string;
|
|
294
|
+
/** Format: int32 */
|
|
295
|
+
variantCount: number | string;
|
|
296
|
+
variants: components["schemas"]["VariantDto"][] | null;
|
|
297
|
+
};
|
|
298
|
+
RangeDto: {
|
|
299
|
+
currency: null | string;
|
|
300
|
+
max: string;
|
|
301
|
+
min: string;
|
|
302
|
+
mode: string;
|
|
303
|
+
selected: null | components["schemas"]["RangeSelectionDto"];
|
|
304
|
+
unit: null | string;
|
|
305
|
+
};
|
|
306
|
+
RangeSelectionDto: {
|
|
307
|
+
max: null | string;
|
|
308
|
+
min: null | string;
|
|
309
|
+
};
|
|
310
|
+
SeoDto: {
|
|
311
|
+
description: null | string;
|
|
312
|
+
title: string;
|
|
313
|
+
};
|
|
314
|
+
SiteDto: {
|
|
315
|
+
code: string;
|
|
316
|
+
configVersion: string;
|
|
317
|
+
defaultMarket: string;
|
|
318
|
+
markets: components["schemas"]["MarketDto"][];
|
|
319
|
+
name: string;
|
|
320
|
+
preview: boolean;
|
|
321
|
+
urlPatterns: components["schemas"]["UrlPatternsDto"];
|
|
322
|
+
};
|
|
323
|
+
SitemapEntryDto: {
|
|
324
|
+
alternateUrls: {
|
|
325
|
+
[key: string]: string;
|
|
326
|
+
};
|
|
327
|
+
id: string;
|
|
328
|
+
slug: string;
|
|
329
|
+
/** Format: date-time */
|
|
330
|
+
updatedAt: string;
|
|
331
|
+
url: string;
|
|
332
|
+
};
|
|
333
|
+
SitemapResponse: {
|
|
334
|
+
items: components["schemas"]["SitemapEntryDto"][];
|
|
335
|
+
/** Format: int32 */
|
|
336
|
+
page: number | string;
|
|
337
|
+
/** Format: int32 */
|
|
338
|
+
pageSize: number | string;
|
|
339
|
+
/** Format: int64 */
|
|
340
|
+
total: number | string;
|
|
341
|
+
type: string;
|
|
342
|
+
};
|
|
343
|
+
SortDto: {
|
|
344
|
+
available: components["schemas"]["SortOptionDto"][];
|
|
345
|
+
selected: string;
|
|
346
|
+
};
|
|
347
|
+
SortOptionDto: {
|
|
348
|
+
key: string;
|
|
349
|
+
label: string;
|
|
350
|
+
};
|
|
351
|
+
/**
|
|
352
|
+
* Problem
|
|
353
|
+
* @description RFC 9457 problem document. Branch on `code`: it is stable, unlike `title` and `detail`.
|
|
354
|
+
*/
|
|
355
|
+
StorefrontProblem: {
|
|
356
|
+
/** @description Stable machine-readable code, e.g. PRODUCT_NOT_FOUND. This is what a storefront branches on. */
|
|
357
|
+
code: string;
|
|
358
|
+
/** @description What went wrong, in prose. */
|
|
359
|
+
detail?: string;
|
|
360
|
+
/**
|
|
361
|
+
* Format: int32
|
|
362
|
+
* @description On RATE_LIMITED: how long to wait before retrying. Mirrors the Retry-After header.
|
|
363
|
+
*/
|
|
364
|
+
retryAfterSeconds?: number;
|
|
365
|
+
/**
|
|
366
|
+
* Format: int32
|
|
367
|
+
* @description The HTTP status code, repeated in the body.
|
|
368
|
+
*/
|
|
369
|
+
status: number;
|
|
370
|
+
/** @description Human-readable summary; not stable, do not branch on it. */
|
|
371
|
+
title?: string;
|
|
372
|
+
/** @description Link to this code's documentation. */
|
|
373
|
+
type?: string;
|
|
374
|
+
};
|
|
375
|
+
SwatchDto: {
|
|
376
|
+
color: null | string;
|
|
377
|
+
imageUrl: null | string;
|
|
378
|
+
};
|
|
379
|
+
UrlPatternsDto: {
|
|
380
|
+
collection: string;
|
|
381
|
+
product: string;
|
|
382
|
+
};
|
|
383
|
+
VariantDto: {
|
|
384
|
+
id: string;
|
|
385
|
+
inStock: boolean;
|
|
386
|
+
price: null | components["schemas"]["PriceDto"];
|
|
387
|
+
selectedOptions: {
|
|
388
|
+
[key: string]: string;
|
|
389
|
+
};
|
|
390
|
+
sku: string;
|
|
391
|
+
stock: string;
|
|
392
|
+
};
|
|
393
|
+
VariantOptionDto: {
|
|
394
|
+
name: string;
|
|
395
|
+
values: components["schemas"]["VariantOptionValueDto"][];
|
|
396
|
+
};
|
|
397
|
+
VariantOptionValueDto: {
|
|
398
|
+
available: boolean;
|
|
399
|
+
value: string;
|
|
400
|
+
};
|
|
401
|
+
VariantPageDto: {
|
|
402
|
+
items: components["schemas"]["VariantDto"][];
|
|
403
|
+
options: components["schemas"]["VariantOptionDto"][];
|
|
404
|
+
/** Format: int32 */
|
|
405
|
+
page: number | string;
|
|
406
|
+
/** Format: int32 */
|
|
407
|
+
pageSize: number | string;
|
|
408
|
+
/** Format: int64 */
|
|
409
|
+
total: number | string;
|
|
410
|
+
};
|
|
411
|
+
WarningDto: {
|
|
412
|
+
code: string;
|
|
413
|
+
message: string;
|
|
414
|
+
redirectTo: null | string;
|
|
415
|
+
};
|
|
416
|
+
};
|
|
417
|
+
responses: never;
|
|
418
|
+
parameters: never;
|
|
419
|
+
requestBodies: never;
|
|
420
|
+
headers: never;
|
|
421
|
+
pathItems: never;
|
|
422
|
+
}
|
|
423
|
+
export type $defs = Record<string, never>;
|
|
424
|
+
export interface operations {
|
|
425
|
+
GetCategories: {
|
|
426
|
+
parameters: {
|
|
427
|
+
query?: never;
|
|
428
|
+
header: {
|
|
429
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
430
|
+
"X-Site-Key": string;
|
|
431
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
432
|
+
"X-Market"?: string;
|
|
433
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
434
|
+
"Accept-Language"?: string;
|
|
435
|
+
};
|
|
436
|
+
path?: never;
|
|
437
|
+
cookie?: never;
|
|
438
|
+
};
|
|
439
|
+
requestBody?: never;
|
|
440
|
+
responses: {
|
|
441
|
+
/** @description OK */
|
|
442
|
+
200: {
|
|
443
|
+
headers: {
|
|
444
|
+
[name: string]: unknown;
|
|
445
|
+
};
|
|
446
|
+
content: {
|
|
447
|
+
"application/json": components["schemas"]["CategoryNodeDto"][];
|
|
448
|
+
};
|
|
449
|
+
};
|
|
450
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
451
|
+
400: {
|
|
452
|
+
headers: {
|
|
453
|
+
[name: string]: unknown;
|
|
454
|
+
};
|
|
455
|
+
content: {
|
|
456
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
457
|
+
};
|
|
458
|
+
};
|
|
459
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
460
|
+
401: {
|
|
461
|
+
headers: {
|
|
462
|
+
[name: string]: unknown;
|
|
463
|
+
};
|
|
464
|
+
content: {
|
|
465
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
466
|
+
};
|
|
467
|
+
};
|
|
468
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
469
|
+
403: {
|
|
470
|
+
headers: {
|
|
471
|
+
[name: string]: unknown;
|
|
472
|
+
};
|
|
473
|
+
content: {
|
|
474
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
475
|
+
};
|
|
476
|
+
};
|
|
477
|
+
/** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
|
|
478
|
+
404: {
|
|
479
|
+
headers: {
|
|
480
|
+
[name: string]: unknown;
|
|
481
|
+
};
|
|
482
|
+
content: {
|
|
483
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
484
|
+
};
|
|
485
|
+
};
|
|
486
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
487
|
+
429: {
|
|
488
|
+
headers: {
|
|
489
|
+
[name: string]: unknown;
|
|
490
|
+
};
|
|
491
|
+
content: {
|
|
492
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
493
|
+
};
|
|
494
|
+
};
|
|
495
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
496
|
+
503: {
|
|
497
|
+
headers: {
|
|
498
|
+
[name: string]: unknown;
|
|
499
|
+
};
|
|
500
|
+
content: {
|
|
501
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
502
|
+
};
|
|
503
|
+
};
|
|
504
|
+
};
|
|
505
|
+
};
|
|
506
|
+
GetCollections: {
|
|
507
|
+
parameters: {
|
|
508
|
+
query?: never;
|
|
509
|
+
header: {
|
|
510
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
511
|
+
"X-Site-Key": string;
|
|
512
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
513
|
+
"X-Market"?: string;
|
|
514
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
515
|
+
"Accept-Language"?: string;
|
|
516
|
+
};
|
|
517
|
+
path?: never;
|
|
518
|
+
cookie?: never;
|
|
519
|
+
};
|
|
520
|
+
requestBody?: never;
|
|
521
|
+
responses: {
|
|
522
|
+
/** @description OK */
|
|
523
|
+
200: {
|
|
524
|
+
headers: {
|
|
525
|
+
[name: string]: unknown;
|
|
526
|
+
};
|
|
527
|
+
content: {
|
|
528
|
+
"application/json": components["schemas"]["CollectionDto"][];
|
|
529
|
+
};
|
|
530
|
+
};
|
|
531
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
532
|
+
400: {
|
|
533
|
+
headers: {
|
|
534
|
+
[name: string]: unknown;
|
|
535
|
+
};
|
|
536
|
+
content: {
|
|
537
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
541
|
+
401: {
|
|
542
|
+
headers: {
|
|
543
|
+
[name: string]: unknown;
|
|
544
|
+
};
|
|
545
|
+
content: {
|
|
546
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
547
|
+
};
|
|
548
|
+
};
|
|
549
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
550
|
+
403: {
|
|
551
|
+
headers: {
|
|
552
|
+
[name: string]: unknown;
|
|
553
|
+
};
|
|
554
|
+
content: {
|
|
555
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
556
|
+
};
|
|
557
|
+
};
|
|
558
|
+
/** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
|
|
559
|
+
404: {
|
|
560
|
+
headers: {
|
|
561
|
+
[name: string]: unknown;
|
|
562
|
+
};
|
|
563
|
+
content: {
|
|
564
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
565
|
+
};
|
|
566
|
+
};
|
|
567
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
568
|
+
429: {
|
|
569
|
+
headers: {
|
|
570
|
+
[name: string]: unknown;
|
|
571
|
+
};
|
|
572
|
+
content: {
|
|
573
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
577
|
+
503: {
|
|
578
|
+
headers: {
|
|
579
|
+
[name: string]: unknown;
|
|
580
|
+
};
|
|
581
|
+
content: {
|
|
582
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
};
|
|
587
|
+
GetCollection: {
|
|
588
|
+
parameters: {
|
|
589
|
+
query?: {
|
|
590
|
+
/** @description Free-text search. Omit to browse rather than search. */
|
|
591
|
+
q?: string;
|
|
592
|
+
/** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 24, max 100). */
|
|
593
|
+
page?: number;
|
|
594
|
+
/** @description Items per page, 1–100. Out of range is a 400 with code INVALID_PAGE. */
|
|
595
|
+
pageSize?: number;
|
|
596
|
+
/** @description Sort key. An unknown one is not refused: it falls back to relevance with a SORT_UNKNOWN warning, because it usually comes from a stale bookmark. */
|
|
597
|
+
sort?: "name_asc" | "newest" | "price_asc" | "price_desc" | "relevance";
|
|
598
|
+
/** @description Facet selection, sent as filter[key]=value. Several values for one facet are comma-separated; price is "min-max" and a boolean facet is "true". An unknown key is dropped with a FILTER_IGNORED warning. */
|
|
599
|
+
filter?: {
|
|
600
|
+
[key: string]: string;
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
header: {
|
|
604
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
605
|
+
"X-Site-Key": string;
|
|
606
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
607
|
+
"X-Market"?: string;
|
|
608
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
609
|
+
"Accept-Language"?: string;
|
|
610
|
+
};
|
|
611
|
+
path: {
|
|
612
|
+
slugOrId: string;
|
|
613
|
+
};
|
|
614
|
+
cookie?: never;
|
|
615
|
+
};
|
|
616
|
+
requestBody?: never;
|
|
617
|
+
responses: {
|
|
618
|
+
/** @description OK */
|
|
619
|
+
200: {
|
|
620
|
+
headers: {
|
|
621
|
+
[name: string]: unknown;
|
|
622
|
+
};
|
|
623
|
+
content: {
|
|
624
|
+
"application/json": components["schemas"]["CollectionListingResponse"];
|
|
625
|
+
};
|
|
626
|
+
};
|
|
627
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
628
|
+
400: {
|
|
629
|
+
headers: {
|
|
630
|
+
[name: string]: unknown;
|
|
631
|
+
};
|
|
632
|
+
content: {
|
|
633
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
634
|
+
};
|
|
635
|
+
};
|
|
636
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
637
|
+
401: {
|
|
638
|
+
headers: {
|
|
639
|
+
[name: string]: unknown;
|
|
640
|
+
};
|
|
641
|
+
content: {
|
|
642
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
643
|
+
};
|
|
644
|
+
};
|
|
645
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
646
|
+
403: {
|
|
647
|
+
headers: {
|
|
648
|
+
[name: string]: unknown;
|
|
649
|
+
};
|
|
650
|
+
content: {
|
|
651
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
652
|
+
};
|
|
653
|
+
};
|
|
654
|
+
/** @description problem+json. COLLECTION_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
|
|
655
|
+
404: {
|
|
656
|
+
headers: {
|
|
657
|
+
[name: string]: unknown;
|
|
658
|
+
};
|
|
659
|
+
content: {
|
|
660
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
661
|
+
};
|
|
662
|
+
};
|
|
663
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
664
|
+
429: {
|
|
665
|
+
headers: {
|
|
666
|
+
[name: string]: unknown;
|
|
667
|
+
};
|
|
668
|
+
content: {
|
|
669
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
670
|
+
};
|
|
671
|
+
};
|
|
672
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
673
|
+
503: {
|
|
674
|
+
headers: {
|
|
675
|
+
[name: string]: unknown;
|
|
676
|
+
};
|
|
677
|
+
content: {
|
|
678
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
679
|
+
};
|
|
680
|
+
};
|
|
681
|
+
};
|
|
682
|
+
};
|
|
683
|
+
ListProducts: {
|
|
684
|
+
parameters: {
|
|
685
|
+
query?: {
|
|
686
|
+
/** @description Free-text search. Omit to browse rather than search. */
|
|
687
|
+
q?: string;
|
|
688
|
+
/** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 24, max 100). */
|
|
689
|
+
page?: number;
|
|
690
|
+
/** @description Items per page, 1–100. Out of range is a 400 with code INVALID_PAGE. */
|
|
691
|
+
pageSize?: number;
|
|
692
|
+
/** @description Sort key. An unknown one is not refused: it falls back to relevance with a SORT_UNKNOWN warning, because it usually comes from a stale bookmark. */
|
|
693
|
+
sort?: "name_asc" | "newest" | "price_asc" | "price_desc" | "relevance";
|
|
694
|
+
/** @description Facet selection, sent as filter[key]=value. Several values for one facet are comma-separated; price is "min-max" and a boolean facet is "true". An unknown key is dropped with a FILTER_IGNORED warning. */
|
|
695
|
+
filter?: {
|
|
696
|
+
[key: string]: string;
|
|
697
|
+
};
|
|
698
|
+
/** @description Narrow to a collection by slug path or id. An unknown one is answered with a COLLECTION_UNKNOWN warning, not a 404. */
|
|
699
|
+
collection?: string;
|
|
700
|
+
};
|
|
701
|
+
header: {
|
|
702
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
703
|
+
"X-Site-Key": string;
|
|
704
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
705
|
+
"X-Market"?: string;
|
|
706
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
707
|
+
"Accept-Language"?: string;
|
|
708
|
+
};
|
|
709
|
+
path?: never;
|
|
710
|
+
cookie?: never;
|
|
711
|
+
};
|
|
712
|
+
requestBody?: never;
|
|
713
|
+
responses: {
|
|
714
|
+
/** @description OK */
|
|
715
|
+
200: {
|
|
716
|
+
headers: {
|
|
717
|
+
[name: string]: unknown;
|
|
718
|
+
};
|
|
719
|
+
content: {
|
|
720
|
+
"application/json": components["schemas"]["ListingResponse"];
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
724
|
+
400: {
|
|
725
|
+
headers: {
|
|
726
|
+
[name: string]: unknown;
|
|
727
|
+
};
|
|
728
|
+
content: {
|
|
729
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
733
|
+
401: {
|
|
734
|
+
headers: {
|
|
735
|
+
[name: string]: unknown;
|
|
736
|
+
};
|
|
737
|
+
content: {
|
|
738
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
739
|
+
};
|
|
740
|
+
};
|
|
741
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
742
|
+
403: {
|
|
743
|
+
headers: {
|
|
744
|
+
[name: string]: unknown;
|
|
745
|
+
};
|
|
746
|
+
content: {
|
|
747
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
748
|
+
};
|
|
749
|
+
};
|
|
750
|
+
/** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
|
|
751
|
+
404: {
|
|
752
|
+
headers: {
|
|
753
|
+
[name: string]: unknown;
|
|
754
|
+
};
|
|
755
|
+
content: {
|
|
756
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
757
|
+
};
|
|
758
|
+
};
|
|
759
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
760
|
+
429: {
|
|
761
|
+
headers: {
|
|
762
|
+
[name: string]: unknown;
|
|
763
|
+
};
|
|
764
|
+
content: {
|
|
765
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
766
|
+
};
|
|
767
|
+
};
|
|
768
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
769
|
+
503: {
|
|
770
|
+
headers: {
|
|
771
|
+
[name: string]: unknown;
|
|
772
|
+
};
|
|
773
|
+
content: {
|
|
774
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
};
|
|
778
|
+
};
|
|
779
|
+
GetProductBySku: {
|
|
780
|
+
parameters: {
|
|
781
|
+
query?: never;
|
|
782
|
+
header: {
|
|
783
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
784
|
+
"X-Site-Key": string;
|
|
785
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
786
|
+
"X-Market"?: string;
|
|
787
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
788
|
+
"Accept-Language"?: string;
|
|
789
|
+
};
|
|
790
|
+
path: {
|
|
791
|
+
sku: string;
|
|
792
|
+
};
|
|
793
|
+
cookie?: never;
|
|
794
|
+
};
|
|
795
|
+
requestBody?: never;
|
|
796
|
+
responses: {
|
|
797
|
+
/** @description OK */
|
|
798
|
+
200: {
|
|
799
|
+
headers: {
|
|
800
|
+
[name: string]: unknown;
|
|
801
|
+
};
|
|
802
|
+
content: {
|
|
803
|
+
"application/json": components["schemas"]["ProductDto"];
|
|
804
|
+
};
|
|
805
|
+
};
|
|
806
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
807
|
+
400: {
|
|
808
|
+
headers: {
|
|
809
|
+
[name: string]: unknown;
|
|
810
|
+
};
|
|
811
|
+
content: {
|
|
812
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
813
|
+
};
|
|
814
|
+
};
|
|
815
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
816
|
+
401: {
|
|
817
|
+
headers: {
|
|
818
|
+
[name: string]: unknown;
|
|
819
|
+
};
|
|
820
|
+
content: {
|
|
821
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
825
|
+
403: {
|
|
826
|
+
headers: {
|
|
827
|
+
[name: string]: unknown;
|
|
828
|
+
};
|
|
829
|
+
content: {
|
|
830
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
/** @description problem+json. PRODUCT_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
|
|
834
|
+
404: {
|
|
835
|
+
headers: {
|
|
836
|
+
[name: string]: unknown;
|
|
837
|
+
};
|
|
838
|
+
content: {
|
|
839
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
843
|
+
429: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content: {
|
|
848
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
852
|
+
503: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content: {
|
|
857
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
};
|
|
861
|
+
};
|
|
862
|
+
GetProduct: {
|
|
863
|
+
parameters: {
|
|
864
|
+
query?: never;
|
|
865
|
+
header: {
|
|
866
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
867
|
+
"X-Site-Key": string;
|
|
868
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
869
|
+
"X-Market"?: string;
|
|
870
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
871
|
+
"Accept-Language"?: string;
|
|
872
|
+
};
|
|
873
|
+
path: {
|
|
874
|
+
slugOrId: string;
|
|
875
|
+
};
|
|
876
|
+
cookie?: never;
|
|
877
|
+
};
|
|
878
|
+
requestBody?: never;
|
|
879
|
+
responses: {
|
|
880
|
+
/** @description OK */
|
|
881
|
+
200: {
|
|
882
|
+
headers: {
|
|
883
|
+
[name: string]: unknown;
|
|
884
|
+
};
|
|
885
|
+
content: {
|
|
886
|
+
"application/json": components["schemas"]["ProductDto"];
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
890
|
+
400: {
|
|
891
|
+
headers: {
|
|
892
|
+
[name: string]: unknown;
|
|
893
|
+
};
|
|
894
|
+
content: {
|
|
895
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
899
|
+
401: {
|
|
900
|
+
headers: {
|
|
901
|
+
[name: string]: unknown;
|
|
902
|
+
};
|
|
903
|
+
content: {
|
|
904
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
905
|
+
};
|
|
906
|
+
};
|
|
907
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
908
|
+
403: {
|
|
909
|
+
headers: {
|
|
910
|
+
[name: string]: unknown;
|
|
911
|
+
};
|
|
912
|
+
content: {
|
|
913
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** @description problem+json. PRODUCT_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
|
|
917
|
+
404: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content: {
|
|
922
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
926
|
+
429: {
|
|
927
|
+
headers: {
|
|
928
|
+
[name: string]: unknown;
|
|
929
|
+
};
|
|
930
|
+
content: {
|
|
931
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
932
|
+
};
|
|
933
|
+
};
|
|
934
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
935
|
+
503: {
|
|
936
|
+
headers: {
|
|
937
|
+
[name: string]: unknown;
|
|
938
|
+
};
|
|
939
|
+
content: {
|
|
940
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
941
|
+
};
|
|
942
|
+
};
|
|
943
|
+
};
|
|
944
|
+
};
|
|
945
|
+
ListProductVariants: {
|
|
946
|
+
parameters: {
|
|
947
|
+
query?: {
|
|
948
|
+
/** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 50, max 100). */
|
|
949
|
+
page?: number;
|
|
950
|
+
/** @description Items per page, 1–100. Out of range is a 400 with code INVALID_PAGE. */
|
|
951
|
+
pageSize?: number;
|
|
952
|
+
/** @description Narrows by option axis: filter[<axis>]=value, one value per axis (no comma-separation). filter[in-stock]=true|false narrows to variants in stock. An axis the product does not have is a 400 (INVALID_FILTER). */
|
|
953
|
+
filter?: {
|
|
954
|
+
[key: string]: string;
|
|
955
|
+
};
|
|
956
|
+
};
|
|
957
|
+
header: {
|
|
958
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
959
|
+
"X-Site-Key": string;
|
|
960
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
961
|
+
"X-Market"?: string;
|
|
962
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
963
|
+
"Accept-Language"?: string;
|
|
964
|
+
};
|
|
965
|
+
path: {
|
|
966
|
+
slugOrId: string;
|
|
967
|
+
};
|
|
968
|
+
cookie?: never;
|
|
969
|
+
};
|
|
970
|
+
requestBody?: never;
|
|
971
|
+
responses: {
|
|
972
|
+
/** @description OK */
|
|
973
|
+
200: {
|
|
974
|
+
headers: {
|
|
975
|
+
[name: string]: unknown;
|
|
976
|
+
};
|
|
977
|
+
content: {
|
|
978
|
+
"application/json": components["schemas"]["VariantPageDto"];
|
|
979
|
+
};
|
|
980
|
+
};
|
|
981
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site), INVALID_PAGE, or INVALID_FILTER (an unknown option axis in filter[], or a non-boolean filter[in-stock]). */
|
|
982
|
+
400: {
|
|
983
|
+
headers: {
|
|
984
|
+
[name: string]: unknown;
|
|
985
|
+
};
|
|
986
|
+
content: {
|
|
987
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
988
|
+
};
|
|
989
|
+
};
|
|
990
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
991
|
+
401: {
|
|
992
|
+
headers: {
|
|
993
|
+
[name: string]: unknown;
|
|
994
|
+
};
|
|
995
|
+
content: {
|
|
996
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
997
|
+
};
|
|
998
|
+
};
|
|
999
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
1000
|
+
403: {
|
|
1001
|
+
headers: {
|
|
1002
|
+
[name: string]: unknown;
|
|
1003
|
+
};
|
|
1004
|
+
content: {
|
|
1005
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1006
|
+
};
|
|
1007
|
+
};
|
|
1008
|
+
/** @description problem+json. PRODUCT_NOT_FOUND, or SITE_INACTIVE when the site itself is not live. */
|
|
1009
|
+
404: {
|
|
1010
|
+
headers: {
|
|
1011
|
+
[name: string]: unknown;
|
|
1012
|
+
};
|
|
1013
|
+
content: {
|
|
1014
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
1018
|
+
429: {
|
|
1019
|
+
headers: {
|
|
1020
|
+
[name: string]: unknown;
|
|
1021
|
+
};
|
|
1022
|
+
content: {
|
|
1023
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1024
|
+
};
|
|
1025
|
+
};
|
|
1026
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
1027
|
+
503: {
|
|
1028
|
+
headers: {
|
|
1029
|
+
[name: string]: unknown;
|
|
1030
|
+
};
|
|
1031
|
+
content: {
|
|
1032
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1033
|
+
};
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
};
|
|
1037
|
+
GetSite: {
|
|
1038
|
+
parameters: {
|
|
1039
|
+
query?: never;
|
|
1040
|
+
header: {
|
|
1041
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
1042
|
+
"X-Site-Key": string;
|
|
1043
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
1044
|
+
"X-Market"?: string;
|
|
1045
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
1046
|
+
"Accept-Language"?: string;
|
|
1047
|
+
};
|
|
1048
|
+
path?: never;
|
|
1049
|
+
cookie?: never;
|
|
1050
|
+
};
|
|
1051
|
+
requestBody?: never;
|
|
1052
|
+
responses: {
|
|
1053
|
+
/** @description OK */
|
|
1054
|
+
200: {
|
|
1055
|
+
headers: {
|
|
1056
|
+
[name: string]: unknown;
|
|
1057
|
+
};
|
|
1058
|
+
content: {
|
|
1059
|
+
"application/json": components["schemas"]["SiteDto"];
|
|
1060
|
+
};
|
|
1061
|
+
};
|
|
1062
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
1063
|
+
400: {
|
|
1064
|
+
headers: {
|
|
1065
|
+
[name: string]: unknown;
|
|
1066
|
+
};
|
|
1067
|
+
content: {
|
|
1068
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1069
|
+
};
|
|
1070
|
+
};
|
|
1071
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
1072
|
+
401: {
|
|
1073
|
+
headers: {
|
|
1074
|
+
[name: string]: unknown;
|
|
1075
|
+
};
|
|
1076
|
+
content: {
|
|
1077
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1078
|
+
};
|
|
1079
|
+
};
|
|
1080
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
1081
|
+
403: {
|
|
1082
|
+
headers: {
|
|
1083
|
+
[name: string]: unknown;
|
|
1084
|
+
};
|
|
1085
|
+
content: {
|
|
1086
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
/** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
|
|
1090
|
+
404: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content: {
|
|
1095
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
1099
|
+
429: {
|
|
1100
|
+
headers: {
|
|
1101
|
+
[name: string]: unknown;
|
|
1102
|
+
};
|
|
1103
|
+
content: {
|
|
1104
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1105
|
+
};
|
|
1106
|
+
};
|
|
1107
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
1108
|
+
503: {
|
|
1109
|
+
headers: {
|
|
1110
|
+
[name: string]: unknown;
|
|
1111
|
+
};
|
|
1112
|
+
content: {
|
|
1113
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
};
|
|
1117
|
+
};
|
|
1118
|
+
GetSitemap: {
|
|
1119
|
+
parameters: {
|
|
1120
|
+
query?: {
|
|
1121
|
+
/** @description Which URLs to list. Defaults to product. */
|
|
1122
|
+
type?: "collection" | "product";
|
|
1123
|
+
/** @description Inclusive ISO-8601 timestamp; only entries changed at or after it. An offset-free value is read as UTC. */
|
|
1124
|
+
since?: string;
|
|
1125
|
+
/** @description 1-based page. page × pageSize must not exceed 10000 (default pageSize 500, max 1000). */
|
|
1126
|
+
page?: number;
|
|
1127
|
+
/** @description Items per page, 1–1000. Out of range is a 400 with code INVALID_PAGE. */
|
|
1128
|
+
pageSize?: number;
|
|
1129
|
+
};
|
|
1130
|
+
header: {
|
|
1131
|
+
/** @description Publishable, preview or secret site key. Required on every request; secret keys are server-side only. */
|
|
1132
|
+
"X-Site-Key": string;
|
|
1133
|
+
/** @description Market code (e.g. "se"). Omit for the site's default market. */
|
|
1134
|
+
"X-Market"?: string;
|
|
1135
|
+
/** @description BCP-47 language tag. Omit to use the market's language. */
|
|
1136
|
+
"Accept-Language"?: string;
|
|
1137
|
+
};
|
|
1138
|
+
path?: never;
|
|
1139
|
+
cookie?: never;
|
|
1140
|
+
};
|
|
1141
|
+
requestBody?: never;
|
|
1142
|
+
responses: {
|
|
1143
|
+
/** @description OK */
|
|
1144
|
+
200: {
|
|
1145
|
+
headers: {
|
|
1146
|
+
[name: string]: unknown;
|
|
1147
|
+
};
|
|
1148
|
+
content: {
|
|
1149
|
+
"application/json": components["schemas"]["SitemapResponse"];
|
|
1150
|
+
};
|
|
1151
|
+
};
|
|
1152
|
+
/** @description problem+json. MARKET_UNKNOWN (no such market on this site) or INVALID_PAGE. */
|
|
1153
|
+
400: {
|
|
1154
|
+
headers: {
|
|
1155
|
+
[name: string]: unknown;
|
|
1156
|
+
};
|
|
1157
|
+
content: {
|
|
1158
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1159
|
+
};
|
|
1160
|
+
};
|
|
1161
|
+
/** @description problem+json. SITE_KEY_MISSING or SITE_KEY_INVALID. */
|
|
1162
|
+
401: {
|
|
1163
|
+
headers: {
|
|
1164
|
+
[name: string]: unknown;
|
|
1165
|
+
};
|
|
1166
|
+
content: {
|
|
1167
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1168
|
+
};
|
|
1169
|
+
};
|
|
1170
|
+
/** @description problem+json. SECRET_KEY_FROM_BROWSER: a secret key was sent from a browser. */
|
|
1171
|
+
403: {
|
|
1172
|
+
headers: {
|
|
1173
|
+
[name: string]: unknown;
|
|
1174
|
+
};
|
|
1175
|
+
content: {
|
|
1176
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1177
|
+
};
|
|
1178
|
+
};
|
|
1179
|
+
/** @description problem+json. SITE_INACTIVE, or NOT_FOUND for an unrouted path. */
|
|
1180
|
+
404: {
|
|
1181
|
+
headers: {
|
|
1182
|
+
[name: string]: unknown;
|
|
1183
|
+
};
|
|
1184
|
+
content: {
|
|
1185
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1186
|
+
};
|
|
1187
|
+
};
|
|
1188
|
+
/** @description problem+json. RATE_LIMITED; retryAfterSeconds and the Retry-After header say how long to wait. */
|
|
1189
|
+
429: {
|
|
1190
|
+
headers: {
|
|
1191
|
+
[name: string]: unknown;
|
|
1192
|
+
};
|
|
1193
|
+
content: {
|
|
1194
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1195
|
+
};
|
|
1196
|
+
};
|
|
1197
|
+
/** @description problem+json. SITE_REGISTRY_WARMING or INDEX_UNAVAILABLE — retry, the request was not wrong. */
|
|
1198
|
+
503: {
|
|
1199
|
+
headers: {
|
|
1200
|
+
[name: string]: unknown;
|
|
1201
|
+
};
|
|
1202
|
+
content: {
|
|
1203
|
+
"application/problem+json": components["schemas"]["StorefrontProblem"];
|
|
1204
|
+
};
|
|
1205
|
+
};
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
}
|