@usequeek/app-sdk 0.6.2 → 0.7.1

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.
Files changed (107) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +340 -337
  3. package/dist/app-auth.d.ts +1 -2
  4. package/dist/app-auth.js +1 -2
  5. package/dist/auth-fetch.d.ts +12 -1
  6. package/dist/auth-fetch.js +13 -2
  7. package/dist/background.d.ts +9 -1
  8. package/dist/background.js +9 -1
  9. package/dist/browser.d.ts +1 -2
  10. package/dist/browser.js +1 -2
  11. package/dist/client.d.ts +130 -7
  12. package/dist/client.js +198 -41
  13. package/dist/collected.d.ts +0 -1
  14. package/dist/collected.js +0 -1
  15. package/dist/crypto.d.ts +11 -1
  16. package/dist/crypto.js +22 -7
  17. package/dist/delivery.d.ts +18 -1
  18. package/dist/delivery.js +26 -17
  19. package/dist/frame.d.ts +0 -1
  20. package/dist/frame.js +0 -1
  21. package/dist/handoff.d.ts +0 -1
  22. package/dist/handoff.js +0 -1
  23. package/dist/hono.d.ts +0 -1
  24. package/dist/hono.js +0 -1
  25. package/dist/index.d.ts +1 -2
  26. package/dist/index.js +1 -2
  27. package/dist/install-handlers.d.ts +22 -2
  28. package/dist/install-handlers.js +37 -7
  29. package/dist/logger.d.ts +7 -1
  30. package/dist/logger.js +7 -1
  31. package/dist/merchant-schema.d.ts +1193 -345
  32. package/dist/merchant-schema.js +0 -1
  33. package/dist/proxy.d.ts +2 -3
  34. package/dist/proxy.js +4 -5
  35. package/dist/react.d.ts +9 -1
  36. package/dist/react.js +10 -2
  37. package/dist/resync.d.ts +11 -1
  38. package/dist/resync.js +18 -16
  39. package/dist/scopes.d.ts +14 -1
  40. package/dist/scopes.js +18 -17
  41. package/dist/server.d.ts +0 -1
  42. package/dist/server.js +0 -1
  43. package/dist/session.d.ts +20 -1
  44. package/dist/session.js +20 -1
  45. package/dist/signatures.d.ts +26 -1
  46. package/dist/signatures.js +29 -3
  47. package/dist/store.d.ts +6 -1
  48. package/dist/store.js +0 -1
  49. package/dist/theme.d.ts +0 -1
  50. package/dist/theme.js +0 -1
  51. package/dist/tokens.d.ts +9 -1
  52. package/dist/tokens.js +23 -47
  53. package/dist/webhooks.d.ts +28 -3
  54. package/dist/webhooks.js +25 -7
  55. package/package.json +18 -2
  56. package/dist/app-auth.d.ts.map +0 -1
  57. package/dist/app-auth.js.map +0 -1
  58. package/dist/auth-fetch.d.ts.map +0 -1
  59. package/dist/auth-fetch.js.map +0 -1
  60. package/dist/background.d.ts.map +0 -1
  61. package/dist/background.js.map +0 -1
  62. package/dist/browser.d.ts.map +0 -1
  63. package/dist/browser.js.map +0 -1
  64. package/dist/client.d.ts.map +0 -1
  65. package/dist/client.js.map +0 -1
  66. package/dist/collected.d.ts.map +0 -1
  67. package/dist/collected.js.map +0 -1
  68. package/dist/crypto.d.ts.map +0 -1
  69. package/dist/crypto.js.map +0 -1
  70. package/dist/delivery.d.ts.map +0 -1
  71. package/dist/delivery.js.map +0 -1
  72. package/dist/frame.d.ts.map +0 -1
  73. package/dist/frame.js.map +0 -1
  74. package/dist/handoff.d.ts.map +0 -1
  75. package/dist/handoff.js.map +0 -1
  76. package/dist/hono.d.ts.map +0 -1
  77. package/dist/hono.js.map +0 -1
  78. package/dist/index.d.ts.map +0 -1
  79. package/dist/index.js.map +0 -1
  80. package/dist/install-handlers.d.ts.map +0 -1
  81. package/dist/install-handlers.js.map +0 -1
  82. package/dist/logger.d.ts.map +0 -1
  83. package/dist/logger.js.map +0 -1
  84. package/dist/merchant-schema.d.ts.map +0 -1
  85. package/dist/merchant-schema.js.map +0 -1
  86. package/dist/proxy.d.ts.map +0 -1
  87. package/dist/proxy.js.map +0 -1
  88. package/dist/react.d.ts.map +0 -1
  89. package/dist/react.js.map +0 -1
  90. package/dist/resync.d.ts.map +0 -1
  91. package/dist/resync.js.map +0 -1
  92. package/dist/scopes.d.ts.map +0 -1
  93. package/dist/scopes.js.map +0 -1
  94. package/dist/server.d.ts.map +0 -1
  95. package/dist/server.js.map +0 -1
  96. package/dist/session.d.ts.map +0 -1
  97. package/dist/session.js.map +0 -1
  98. package/dist/signatures.d.ts.map +0 -1
  99. package/dist/signatures.js.map +0 -1
  100. package/dist/store.d.ts.map +0 -1
  101. package/dist/store.js.map +0 -1
  102. package/dist/theme.d.ts.map +0 -1
  103. package/dist/theme.js.map +0 -1
  104. package/dist/tokens.d.ts.map +0 -1
  105. package/dist/tokens.js.map +0 -1
  106. package/dist/webhooks.d.ts.map +0 -1
  107. package/dist/webhooks.js.map +0 -1
@@ -1007,7 +1007,7 @@ export interface paths {
1007
1007
  * List orders
1008
1008
  * @description Requires scope `merchant-orders-read`.
1009
1009
  *
1010
- * Lists the store’s orders using the same base object as orders/* webhooks; recorded payment transactions and Queek wallet-refund rows are present only with merchant-orders-read (webhooks include them only for active installations granted that scope). Order status, shipment, import, rider-assignment and patch responses do not include those finance arrays. Same filtering and search as the dashboard table with cursor pagination (`limit` + `starting_after`, `has_more`/`next_cursor`). `publication` scopes the list to one of the calling installation’s channel publications (p_id or key; human keys use p_id and need the publications-read permission, without it the filter answers 404). `custom_channel` scopes the list to one hand-recorded or third-party channel name (e.g. glovo, chowdeck, instagram) and combines with the other filters. Optional `updated_after` walks order rows changed after a timestamp, oldest change first; start each poll five minutes before the previous poll start, deduplicate ids, keep filters fixed and walk sequentially. With `updated_after`, `sort_by`, `sort_order`, `page` and `per_page` return 422; a cursor is bound to the same timestamp and filters. Item/property, shipment, metafield or customer-profile changes and deleted orders may be missed; long-running changes may appear late. The filter time is not returned and may differ from `updated_at`; this is not a snapshot or deletion feed. Provider-side, vendor-collected, offline and manual-review refunds without a recorded Queek refund row are omitted.
1010
+ * Lists the store’s orders using the same base object as orders/* webhooks; recorded payment transactions and Queek wallet-refund rows are present only with merchant-orders-read (webhooks include them only for active installations granted that scope). Order status, shipment, import, rider-assignment and patch responses do not include those finance arrays. Same filtering and search as the dashboard table with cursor pagination (`limit` + `starting_after`, `has_more`/`next_cursor`). `publication` scopes the list to one of the calling installation’s channel publications (p_id or key; human keys use p_id and need the publications-read permission, without it the filter answers 404). `custom_channel` scopes the list to one hand-recorded or third-party channel name (for example `physical_sale` or `others`) and combines with the other filters. Optional `updated_after` walks order rows changed after a timestamp, oldest change first; start each poll five minutes before the previous poll start, deduplicate ids, keep filters fixed and walk sequentially. With `updated_after`, `sort_by`, `sort_order`, `page` and `per_page` return 422; a cursor is bound to the same timestamp and filters. Item/property, shipment, metafield or customer-profile changes and deleted orders may be missed; long-running changes may appear late. The filter time is not returned and may differ from `updated_at`; this is not a snapshot or deletion feed. Provider-side, vendor-collected, offline and manual-review refunds without a recorded Queek refund row are omitted.
1011
1011
  */
1012
1012
  get: operations["orders.list"];
1013
1013
  put?: never;
@@ -1059,7 +1059,7 @@ export interface paths {
1059
1059
  * Import an order from a sales channel
1060
1060
  * @description Requires scope `merchant-orders-import`.
1061
1061
  *
1062
- * Records an order already charged by an outside platform: each item names its `product` (p_id, UUID or slug of this store) and, for a variant, its `variant` (p_id or UUID of a variant belonging to that product) — the old single `ref` is refused; totals are stored as charged with no commission, and a re-sent order returns the same record. The authenticated app installation supplies source attribution; apps other than the established Chowdeck and Glovo integrations omit `channel`, which is rejected if supplied. Chowdeck and Glovo keep their existing `channel` request contract. The customer (name + phone) becomes the order’s `shipping_address` recipient, readable only with merchant-customers-contact-read like every contact — never `metadata`. Answers the order object orders/* webhooks send. Generic app installations derive source from the authenticated installation and omit `channel`; supplying it is a 422. An installed app with slug `chowdeck` or `glovo` must send its matching legacy `channel`; mismatches are 422. Human-key legacy imports still require `channel` and may choose either slug. Those slugs are not reserved.
1062
+ * Records an order already charged by an outside platform: each item names its `product` (p_id, UUID or slug of this store) and, for a variant, its `variant` (p_id or UUID of a variant belonging to that product) — the old single `ref` is refused; totals are stored as charged with no commission, and a re-sent order returns the same record. The authenticated app installation supplies source attribution; only an installed legacy marketplace app sends `channel`, and it must match its own app slug; any other app omits it, and a supplied value is rejected. The customer (name + phone) becomes the order’s `shipping_address` recipient, readable only with merchant-customers-contact-read like every contact — never `metadata`. Answers the order object orders/* webhooks send. Generic app installations derive source from the authenticated installation and omit `channel`; supplying it is a 422. An installed legacy marketplace app must send the `channel` slug matching its own app slug; mismatches are 422. Human-key legacy imports still require `channel` and may choose either slug. Those slugs are not reserved.
1063
1063
  */
1064
1064
  post: operations["orders.import"];
1065
1065
  delete?: never;
@@ -2081,8 +2081,10 @@ export interface components {
2081
2081
  schemas: {
2082
2082
  /** AddonGroupResource */
2083
2083
  AddonGroupResource: {
2084
+ /** @description Unique identifier of this object. */
2084
2085
  id: number;
2085
2086
  uid: string;
2087
+ /** @description Display title. */
2086
2088
  title: string;
2087
2089
  type: string;
2088
2090
  required: boolean;
@@ -2097,9 +2099,13 @@ export interface components {
2097
2099
  };
2098
2100
  /** AddonItemResource */
2099
2101
  AddonItemResource: {
2102
+ /** @description Unique identifier of this object. */
2100
2103
  id: number;
2101
2104
  uid: string;
2105
+ /** @description Display name. */
2102
2106
  name: string;
2107
+ /** @description ISO-4217 currency code of the amounts on this object. */
2108
+ currency: string;
2103
2109
  price: string;
2104
2110
  in_stock: boolean;
2105
2111
  is_pack: boolean;
@@ -2116,29 +2122,42 @@ export interface components {
2116
2122
  reason: string;
2117
2123
  };
2118
2124
  /** Collection */
2119
- "App.Http.Resources.Api.CollectionResource": {
2125
+ Collection: {
2126
+ /** @description Unique identifier of this object. */
2120
2127
  id: number;
2121
2128
  uid: string;
2129
+ /** @description Display name. */
2122
2130
  name: string;
2131
+ /** @description URL-safe handle of this object. */
2123
2132
  slug: string;
2133
+ /** @description Descriptive text. */
2124
2134
  description: string;
2125
2135
  image: string;
2126
2136
  logo: string;
2127
2137
  featured: boolean;
2138
+ /** @description Sort position within the parent list. */
2128
2139
  position: number | null;
2129
2140
  collection_mode: string | null;
2130
2141
  parent_uid: string | null;
2131
2142
  products_count: number | null;
2132
2143
  children: unknown[];
2133
- /** Format: date-time */
2144
+ /**
2145
+ * Format: date-time
2146
+ * @description When this object was created (ISO-8601 timestamp).
2147
+ */
2134
2148
  created_at: string | null;
2135
- /** Format: date-time */
2149
+ /**
2150
+ * Format: date-time
2151
+ * @description When this object was last changed (ISO-8601 timestamp).
2152
+ */
2136
2153
  updated_at: string | null;
2137
2154
  };
2138
2155
  /** OrderItem */
2139
- "App.Http.Resources.Customer.OrderItemResource": {
2156
+ OrderItem: {
2157
+ /** @description Unique identifier of this object. */
2140
2158
  id: string;
2141
2159
  quantity: string;
2160
+ /** @description Display title. */
2142
2161
  title: string;
2143
2162
  variant_id: string;
2144
2163
  variant_title: string;
@@ -2147,21 +2166,26 @@ export interface components {
2147
2166
  };
2148
2167
  variant_media: {
2149
2168
  image: string | null;
2169
+ /** @description URL of the video. */
2150
2170
  video_url: string | null;
2151
2171
  /** @enum {string} */
2152
2172
  source: "variant" | "product";
2153
2173
  } | null;
2174
+ /** @description ISO-4217 currency code of the amounts on this object. */
2154
2175
  currency: string;
2155
- total_price: number | null;
2156
- sale_price: number | null;
2157
- unit_price: number | null;
2158
- base_unit_price: number | null;
2176
+ total_price: string | null;
2177
+ sale_price: string | null;
2178
+ unit_price: string | null;
2179
+ base_unit_price: string | null;
2159
2180
  is_backorder: boolean;
2160
2181
  backorder_ready_date: string | null;
2161
- discounted_amount?: number | null;
2162
- /** Format: date-time */
2182
+ discounted_amount?: string | null;
2183
+ /**
2184
+ * Format: date-time
2185
+ * @description When this object was created (ISO-8601 timestamp).
2186
+ */
2163
2187
  created_at: string;
2164
- addons: unknown;
2188
+ addons: unknown[] | null;
2165
2189
  /**
2166
2190
  * @description Per-line checkout properties. Always present as an object so
2167
2191
  * dashboard chips and the shopper page never branch on absence.
@@ -2171,42 +2195,53 @@ export interface components {
2171
2195
  properties: string;
2172
2196
  };
2173
2197
  /** Product */
2174
- "App.Http.Resources.Customer.ProductResource": unknown[] | {
2198
+ Product: unknown[] | {
2175
2199
  shop_id: string;
2200
+ /** @description Unique identifier of this object. */
2176
2201
  id: string;
2202
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
2177
2203
  p_id: string;
2204
+ /** @description Display title. */
2178
2205
  title: string | null;
2206
+ /** @description URL-safe handle of this object. */
2179
2207
  slug: string;
2208
+ /** @description Short summary text. */
2180
2209
  excerpt: string | null;
2210
+ /** @description Descriptive text. */
2181
2211
  description: string | null;
2182
2212
  image: string | null;
2183
2213
  thumbnail_image: string | null;
2214
+ /** @description URL of the video. */
2184
2215
  video_url: string | null;
2185
2216
  video_poster_url: string | null;
2186
2217
  type: unknown;
2187
2218
  commerce_mode: string;
2219
+ /** @description ISO-4217 currency code of the amounts on this object. */
2188
2220
  currency: string;
2189
- price: number;
2190
- discount_price: string;
2191
- compare_at_price: number | null;
2221
+ price: string | null;
2222
+ discount_price: string | null;
2223
+ compare_at_price: string | null;
2192
2224
  is_price_from: boolean;
2193
2225
  price_range: {
2194
- min: number;
2195
- max: number;
2226
+ min: string;
2227
+ max: string;
2196
2228
  } | null;
2197
2229
  has_variants: boolean;
2198
2230
  has_addons: string;
2199
2231
  tax_inclusive: boolean;
2200
2232
  discount: {
2233
+ /** @description Unique identifier of this object. */
2201
2234
  id: string | null;
2235
+ /** @description Display title. */
2202
2236
  title: string | null;
2203
2237
  type: string | null;
2204
- value: number | null;
2205
- amount: number | null;
2206
- final_price: number | null;
2238
+ value: string | null;
2239
+ amount: string | null;
2240
+ final_price: string | null;
2241
+ /** @description URL of the image. */
2207
2242
  image_url: string | null;
2208
2243
  } | null;
2209
- discounts: string;
2244
+ discounts: unknown[];
2210
2245
  media: {
2211
2246
  thumbnail: string | null;
2212
2247
  image: string | null;
@@ -2229,19 +2264,25 @@ export interface components {
2229
2264
  [key: string]: unknown;
2230
2265
  } | null;
2231
2266
  images: ({
2267
+ /** @description Unique identifier of this object. */
2232
2268
  id: number;
2269
+ /** @description Public URL. */
2233
2270
  url: string;
2234
2271
  alt: unknown;
2235
2272
  variants: string;
2236
2273
  } | null | {
2274
+ /** @description Unique identifier of this object. */
2237
2275
  id: number | null;
2276
+ /** @description Public URL. */
2238
2277
  url: string | null;
2239
2278
  alt: unknown;
2240
2279
  variants: null;
2241
2280
  })[] | null;
2242
2281
  };
2243
2282
  inventory: unknown[];
2244
- variant_summary: string | null;
2283
+ variant_summary: {
2284
+ [key: string]: unknown;
2285
+ } | null;
2245
2286
  variants_count: unknown;
2246
2287
  rating: number;
2247
2288
  review_count: number;
@@ -2253,29 +2294,39 @@ export interface components {
2253
2294
  };
2254
2295
  /**
2255
2296
  * @description Vendor-defined typed fields, keyed `namespace.key`. `{}` for a store
2256
- * that has defined none, which costs no query (MetafieldPresenter).
2297
+ * that has defined none, which costs no query.
2257
2298
  * Free-form `metadata` is deliberately NOT here: it is an
2258
2299
  * integrator's private bookkeeping and stays on the merchant API.
2259
2300
  * Client surface: draft entries and storefront-hidden definitions
2260
- * are omitted from reference values (MetafieldPresenter).
2301
+ * are omitted from reference values.
2261
2302
  */
2262
2303
  metafields: string;
2263
- /** Format: date-time */
2304
+ /**
2305
+ * Format: date-time
2306
+ * @description When this object was created (ISO-8601 timestamp).
2307
+ */
2264
2308
  created_at: string | null;
2265
- /** Format: date-time */
2309
+ /**
2310
+ * Format: date-time
2311
+ * @description When this object was last changed (ISO-8601 timestamp).
2312
+ */
2266
2313
  updated_at: string | null;
2267
2314
  shop: unknown[];
2315
+ /** @description Barcode of the item, when set. */
2268
2316
  barcode: string;
2269
2317
  };
2270
2318
  /** Order */
2271
- "App.Http.Resources.OrderResource": {
2319
+ Order: {
2272
2320
  0: Record<string, never>;
2321
+ /** @description Unique identifier of this object. */
2273
2322
  id: string;
2323
+ /** @description Display title. */
2274
2324
  title: string | null;
2325
+ /** @description ISO-4217 currency code of the amounts on this object. */
2275
2326
  currency: string;
2276
- total_price: number | null;
2277
- delivery_fee: number | null;
2278
- grand_total: number | null;
2327
+ total_price: string | null;
2328
+ delivery_fee: string | null;
2329
+ grand_total: string | null;
2279
2330
  payment_status: string;
2280
2331
  transaction_id: string | null;
2281
2332
  is_verified: boolean | null;
@@ -2295,7 +2346,9 @@ export interface components {
2295
2346
  * id, name and section, as shown in the table picker.
2296
2347
  */
2297
2348
  table: {
2349
+ /** @description Unique identifier of this object. */
2298
2350
  id: string;
2351
+ /** @description Display name. */
2299
2352
  name: string;
2300
2353
  section: string | null;
2301
2354
  } | Record<string, never>;
@@ -2305,11 +2358,15 @@ export interface components {
2305
2358
  ready_window: {
2306
2359
  from: string | null;
2307
2360
  to: string | null;
2361
+ /** @description Display label. */
2308
2362
  label: string;
2309
2363
  } | null | Record<string, never>;
2310
2364
  vendor: {
2365
+ /** @description Unique identifier of this object. */
2311
2366
  id: string;
2367
+ /** @description Display name. */
2312
2368
  name: string;
2369
+ /** @description URL-safe handle of this object. */
2313
2370
  slug: string;
2314
2371
  logo: string | null;
2315
2372
  /**
@@ -2319,7 +2376,9 @@ export interface components {
2319
2376
  * also show them on rider/dispatch flows.
2320
2377
  */
2321
2378
  address: string | null;
2379
+ /** @description Phone number. */
2322
2380
  phone: string | null;
2381
+ /** @description Email address. */
2323
2382
  email: string | null;
2324
2383
  map_lat: string | null;
2325
2384
  map_lng: string | null;
@@ -2329,8 +2388,8 @@ export interface components {
2329
2388
  vendor_timeline: unknown[];
2330
2389
  vendor_note: string | null;
2331
2390
  rider_note: string | null;
2332
- shopforme_fee: number | null;
2333
- service_fee: number | null;
2391
+ shopforme_fee: string | null;
2392
+ service_fee: string | null;
2334
2393
  delivery_pin: string | null | Record<string, never>;
2335
2394
  delivery_pins: unknown[] | null | Record<string, never>;
2336
2395
  is_confirmed: boolean;
@@ -2343,9 +2402,15 @@ export interface components {
2343
2402
  started_at: string | null;
2344
2403
  /** Format: date-time */
2345
2404
  completed_at: string | null;
2346
- /** Format: date-time */
2405
+ /**
2406
+ * Format: date-time
2407
+ * @description When this object was created (ISO-8601 timestamp).
2408
+ */
2347
2409
  created_at: string;
2348
- /** Format: date-time */
2410
+ /**
2411
+ * Format: date-time
2412
+ * @description When this object was last changed (ISO-8601 timestamp).
2413
+ */
2349
2414
  updated_at: string;
2350
2415
  status_label: string;
2351
2416
  status_img: string;
@@ -2358,10 +2423,14 @@ export interface components {
2358
2423
  */
2359
2424
  items: components["schemas"]["OrderItemResource"][] | Record<string, never>;
2360
2425
  created_by: {
2426
+ /** @description Unique identifier of this object. */
2361
2427
  id: string;
2428
+ /** @description Display name. */
2362
2429
  name: string;
2363
2430
  avatar: string | null;
2431
+ /** @description Phone number. */
2364
2432
  phone: string;
2433
+ /** @description Email address. */
2365
2434
  email: string;
2366
2435
  } | Record<string, never>;
2367
2436
  rider: components["schemas"]["UserItemResource"];
@@ -2375,7 +2444,10 @@ export interface components {
2375
2444
  /** @enum {string} */
2376
2445
  viewer_type: "customer" | "vendor" | "rider" | "admin";
2377
2446
  amount_summary: {
2378
- /** @constant */
2447
+ /**
2448
+ * @description Display title.
2449
+ * @constant
2450
+ */
2379
2451
  title: "Order Summary";
2380
2452
  /** @constant */
2381
2453
  view: "rider";
@@ -2383,21 +2455,30 @@ export interface components {
2383
2455
  {
2384
2456
  /** @constant */
2385
2457
  key: "rider_fee";
2386
- /** @constant */
2458
+ /**
2459
+ * @description Display label.
2460
+ * @constant
2461
+ */
2387
2462
  label: "Rider Fee";
2388
2463
  /** @constant */
2389
2464
  type: "total";
2390
- amount: number | null;
2465
+ amount: string | null;
2391
2466
  }
2392
2467
  ];
2393
2468
  } | {
2394
- /** @constant */
2469
+ /**
2470
+ * @description Display title.
2471
+ * @constant
2472
+ */
2395
2473
  title: "Order Summary";
2396
2474
  /** @constant */
2397
2475
  view: "vendor";
2398
2476
  items: unknown[];
2399
2477
  } | {
2400
- /** @constant */
2478
+ /**
2479
+ * @description Display title.
2480
+ * @constant
2481
+ */
2401
2482
  title: "Order Summary";
2402
2483
  /** @constant */
2403
2484
  view: "customer";
@@ -2410,12 +2491,15 @@ export interface components {
2410
2491
  * Every other surface keeps reading it exactly as before.
2411
2492
  */
2412
2493
  0: Record<string, never>;
2494
+ /** @description Unique identifier of this object. */
2413
2495
  id: string;
2496
+ /** @description Display title. */
2414
2497
  title: string | null;
2498
+ /** @description ISO-4217 currency code of the amounts on this object. */
2415
2499
  currency: string;
2416
- total_price: number | null;
2417
- delivery_fee: number | null;
2418
- grand_total: number | null;
2500
+ total_price: string | null;
2501
+ delivery_fee: string | null;
2502
+ grand_total: string | null;
2419
2503
  payment_status: string;
2420
2504
  transaction_id: string | null;
2421
2505
  is_verified: boolean | null;
@@ -2435,7 +2519,9 @@ export interface components {
2435
2519
  * id, name and section, as shown in the table picker.
2436
2520
  */
2437
2521
  table: {
2522
+ /** @description Unique identifier of this object. */
2438
2523
  id: string;
2524
+ /** @description Display name. */
2439
2525
  name: string;
2440
2526
  section: string | null;
2441
2527
  } | Record<string, never>;
@@ -2445,11 +2531,15 @@ export interface components {
2445
2531
  ready_window: {
2446
2532
  from: string | null;
2447
2533
  to: string | null;
2534
+ /** @description Display label. */
2448
2535
  label: string;
2449
2536
  } | null | Record<string, never>;
2450
2537
  vendor: {
2538
+ /** @description Unique identifier of this object. */
2451
2539
  id: string;
2540
+ /** @description Display name. */
2452
2541
  name: string;
2542
+ /** @description URL-safe handle of this object. */
2453
2543
  slug: string;
2454
2544
  logo: string | null;
2455
2545
  /**
@@ -2459,7 +2549,9 @@ export interface components {
2459
2549
  * also show them on rider/dispatch flows.
2460
2550
  */
2461
2551
  address: string | null;
2552
+ /** @description Phone number. */
2462
2553
  phone: string | null;
2554
+ /** @description Email address. */
2463
2555
  email: string | null;
2464
2556
  map_lat: string | null;
2465
2557
  map_lng: string | null;
@@ -2469,8 +2561,8 @@ export interface components {
2469
2561
  vendor_timeline: unknown[];
2470
2562
  vendor_note: string | null;
2471
2563
  rider_note: string | null;
2472
- shopforme_fee: number | null;
2473
- service_fee: number | null;
2564
+ shopforme_fee: string | null;
2565
+ service_fee: string | null;
2474
2566
  delivery_pin: string | null | Record<string, never>;
2475
2567
  delivery_pins: unknown[] | null | Record<string, never>;
2476
2568
  is_confirmed: boolean;
@@ -2483,9 +2575,15 @@ export interface components {
2483
2575
  started_at: string | null;
2484
2576
  /** Format: date-time */
2485
2577
  completed_at: string | null;
2486
- /** Format: date-time */
2578
+ /**
2579
+ * Format: date-time
2580
+ * @description When this object was created (ISO-8601 timestamp).
2581
+ */
2487
2582
  created_at: string;
2488
- /** Format: date-time */
2583
+ /**
2584
+ * Format: date-time
2585
+ * @description When this object was last changed (ISO-8601 timestamp).
2586
+ */
2489
2587
  updated_at: string;
2490
2588
  };
2491
2589
  /** App collected record update input */
@@ -2498,15 +2596,22 @@ export interface components {
2498
2596
  };
2499
2597
  /** AppMediaResource */
2500
2598
  AppMediaResource: {
2599
+ /** @description Unique identifier of this object. */
2501
2600
  id: number;
2601
+ /** @description Public URL. */
2502
2602
  url: string;
2503
2603
  thumbnail_url: string;
2504
2604
  variants: string;
2505
2605
  mime_type: string;
2506
2606
  size: number;
2607
+ /** @description Width in pixels. */
2507
2608
  width: number | null;
2609
+ /** @description Height in pixels. */
2508
2610
  height: number | null;
2509
- /** Format: date-time */
2611
+ /**
2612
+ * Format: date-time
2613
+ * @description When this object was created (ISO-8601 timestamp).
2614
+ */
2510
2615
  created_at: string;
2511
2616
  };
2512
2617
  /**
@@ -2543,6 +2648,7 @@ export interface components {
2543
2648
  };
2544
2649
  /** BankResource */
2545
2650
  BankResource: {
2651
+ /** @description Unique identifier of this object. */
2546
2652
  id: string;
2547
2653
  account_number: string;
2548
2654
  account_name: string;
@@ -2551,9 +2657,13 @@ export interface components {
2551
2657
  };
2552
2658
  /** BlogCategoryResource */
2553
2659
  BlogCategoryResource: {
2660
+ /** @description Unique identifier of this object. */
2554
2661
  id: string;
2662
+ /** @description Display name. */
2555
2663
  name: string;
2664
+ /** @description URL-safe handle of this object. */
2556
2665
  slug: string;
2666
+ /** @description Sort position within the parent list. */
2557
2667
  position: number;
2558
2668
  posts_count?: number;
2559
2669
  };
@@ -2562,7 +2672,9 @@ export interface components {
2562
2672
  /** Format: uuid */
2563
2673
  vendor_id: string;
2564
2674
  collections: {
2675
+ /** @description Display name. */
2565
2676
  name: string;
2677
+ /** @description Descriptive text. */
2566
2678
  description?: string | null;
2567
2679
  /** @enum {string|null} */
2568
2680
  collection_mode?: "manual" | "smart" | null;
@@ -2586,20 +2698,36 @@ export interface components {
2586
2698
  };
2587
2699
  /** CartResource */
2588
2700
  CartResource: {
2701
+ /** @description Unique identifier of this object. */
2589
2702
  id: string;
2590
2703
  cart_id: string;
2591
2704
  item_id: string;
2705
+ /** @description Display title. */
2592
2706
  title: string;
2593
2707
  variant_id: string | null;
2594
- price: number | null;
2708
+ /** @description ISO-4217 currency code of the amounts on this object. */
2709
+ currency: string;
2710
+ price: string | null;
2595
2711
  quantity: string;
2596
- selectedAddons: string | string[];
2597
- subtotal: number | null;
2598
- product: components["schemas"]["App.Http.Resources.Customer.ProductResource"];
2712
+ selectedAddons: string | {
2713
+ [key: string]: ({
2714
+ price: string | null;
2715
+ } & {
2716
+ [key: string]: unknown;
2717
+ }) | string;
2718
+ };
2719
+ subtotal: string | null;
2720
+ product: components["schemas"]["Product"];
2599
2721
  vendor: components["schemas"]["VendorItemResource"];
2600
- /** Format: date-time */
2722
+ /**
2723
+ * Format: date-time
2724
+ * @description When this object was created (ISO-8601 timestamp).
2725
+ */
2601
2726
  created_at: string;
2602
- /** Format: date-time */
2727
+ /**
2728
+ * Format: date-time
2729
+ * @description When this object was last changed (ISO-8601 timestamp).
2730
+ */
2603
2731
  updated_at: string;
2604
2732
  } | {
2605
2733
  /**
@@ -2609,43 +2737,57 @@ export interface components {
2609
2737
  * that is the token the storefront can adopt.
2610
2738
  */
2611
2739
  0: Record<string, never>;
2740
+ /** @description Unique identifier of this object. */
2612
2741
  id: string;
2613
2742
  vendor_id: string;
2614
2743
  vendor: components["schemas"]["VendorItemResource"];
2744
+ /** @description ISO-4217 currency code of the amounts on this object. */
2745
+ currency: string;
2615
2746
  cart_items: unknown[];
2616
- total_price: number | null;
2747
+ total_price: string | null;
2617
2748
  source: string;
2618
2749
  promo_codes: string | string[];
2619
2750
  is_valid: string;
2620
2751
  validation_errors: string | string[];
2621
2752
  /** Format: date-time */
2622
2753
  last_validated_at: string | null;
2623
- /** Format: date-time */
2754
+ /**
2755
+ * Format: date-time
2756
+ * @description When this object was created (ISO-8601 timestamp).
2757
+ */
2624
2758
  created_at: string | null;
2625
- /** Format: date-time */
2759
+ /**
2760
+ * Format: date-time
2761
+ * @description When this object was last changed (ISO-8601 timestamp).
2762
+ */
2626
2763
  updated_at: string | null;
2627
2764
  discounts: {
2628
2765
  [key: string]: {
2629
- amount_applied: number | null;
2766
+ amount_applied: string | null;
2630
2767
  } & {
2631
2768
  [key: string]: unknown;
2632
2769
  };
2633
2770
  };
2634
- subtotal: number | null;
2635
- discount_total: number | null;
2636
- total_after_discounts: number | null;
2771
+ subtotal: string | null;
2772
+ discount_total: string | null;
2773
+ total_after_discounts: string | null;
2637
2774
  };
2638
2775
  /** ClientAuthUserResource */
2639
2776
  ClientAuthUserResource: {
2777
+ /** @description Unique identifier of this object. */
2640
2778
  id: string;
2779
+ /** @description Display name. */
2641
2780
  name: string;
2781
+ /** @description Email address. */
2642
2782
  email: string | null;
2783
+ /** @description Phone number. */
2643
2784
  phone: string | null;
2644
2785
  avatar: string | null;
2645
2786
  country: string | null;
2646
2787
  state: string | null;
2647
2788
  region: string | null;
2648
2789
  city: string | null;
2790
+ /** @description Postal address. */
2649
2791
  address: string | null;
2650
2792
  map_lat: string | null;
2651
2793
  map_lng: string | null;
@@ -2653,7 +2795,7 @@ export interface components {
2653
2795
  /**
2654
2796
  * @description Whether this rider may actually open the storefront rider console —
2655
2797
  * is_rider alone is not enough, a vendor approval path must have
2656
- * stamped rider_approved_at (see EnsureClientRider). The storefront
2798
+ * stamped rider_approved_at. The storefront
2657
2799
  * shows a "pending approval" state when is_rider && ! rider_approved.
2658
2800
  */
2659
2801
  rider_approved: boolean;
@@ -2675,7 +2817,9 @@ export interface components {
2675
2817
  */
2676
2818
  CollectedDefinitionRequest: {
2677
2819
  type: string;
2820
+ /** @description Display name. */
2678
2821
  name: string;
2822
+ /** @description Descriptive text. */
2679
2823
  description?: string | null;
2680
2824
  display_field: string;
2681
2825
  storefront_visible?: boolean | null;
@@ -2687,6 +2831,7 @@ export interface components {
2687
2831
  has_pages?: boolean | null;
2688
2832
  fields: {
2689
2833
  key?: string;
2834
+ /** @description Display name. */
2690
2835
  name?: string;
2691
2836
  /** @enum {string} */
2692
2837
  type?: "single_line_text" | "multi_line_text" | "integer" | "decimal" | "boolean" | "date" | "url" | "json" | "media_id" | "list.single_line_text" | "list.multi_line_text" | "list.integer" | "list.decimal" | "list.boolean" | "list.date" | "list.url" | "list.media_id";
@@ -2702,17 +2847,27 @@ export interface components {
2702
2847
  };
2703
2848
  /** CollectedRecordResource */
2704
2849
  CollectedRecordResource: {
2850
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
2705
2851
  p_id: number;
2706
2852
  definition_p_id?: number;
2707
2853
  type?: string | null;
2708
2854
  status: string | "new";
2709
2855
  source: string | null;
2710
- /** Format: date-time */
2856
+ /**
2857
+ * Format: date-time
2858
+ * @description When this was submitted (ISO-8601 timestamp).
2859
+ */
2711
2860
  submitted_at: string;
2712
2861
  values: string;
2713
- /** Format: date-time */
2862
+ /**
2863
+ * Format: date-time
2864
+ * @description When this object was created (ISO-8601 timestamp).
2865
+ */
2714
2866
  created_at: string;
2715
- /** Format: date-time */
2867
+ /**
2868
+ * Format: date-time
2869
+ * @description When this object was last changed (ISO-8601 timestamp).
2870
+ */
2716
2871
  updated_at: string;
2717
2872
  };
2718
2873
  /**
@@ -2744,9 +2899,13 @@ export interface components {
2744
2899
  };
2745
2900
  /** CollectionResource */
2746
2901
  CollectionResource: {
2902
+ /** @description Unique identifier of this object. */
2747
2903
  id: string;
2904
+ /** @description Display name. */
2748
2905
  name: string;
2906
+ /** @description URL-safe handle of this object. */
2749
2907
  slug: string;
2908
+ /** @description Descriptive text. */
2750
2909
  description: string | null;
2751
2910
  image: string;
2752
2911
  /**
@@ -2770,11 +2929,16 @@ export interface components {
2770
2929
  };
2771
2930
  /** CouponResource */
2772
2931
  CouponResource: {
2932
+ /** @description Unique identifier of this object. */
2773
2933
  id: string;
2774
2934
  code: string;
2935
+ /** @description Display title. */
2775
2936
  title: string;
2937
+ /** @description Descriptive text. */
2776
2938
  description: string;
2777
2939
  discount_type: string;
2940
+ /** @description ISO-4217 currency code of the amounts on this object. */
2941
+ currency: string;
2778
2942
  discount_value: string;
2779
2943
  applies_to: string;
2780
2944
  target_product_ids: unknown[];
@@ -2785,26 +2949,38 @@ export interface components {
2785
2949
  usage_limit: number | null;
2786
2950
  usage_limit_per_user: number | null;
2787
2951
  used_count: number;
2952
+ /** @description Whether this object is active. */
2788
2953
  is_active: boolean;
2789
2954
  is_valid: boolean;
2790
2955
  is_expired: boolean;
2956
+ /** @description URL of the image. */
2791
2957
  image_url: string;
2792
2958
  /** Format: date-time */
2793
2959
  starts_at: string | null;
2794
2960
  /** Format: date-time */
2795
2961
  expires_at: string | null;
2796
- /** Format: date-time */
2962
+ /**
2963
+ * Format: date-time
2964
+ * @description When this object was created (ISO-8601 timestamp).
2965
+ */
2797
2966
  created_at: string | null;
2798
- /** Format: date-time */
2967
+ /**
2968
+ * Format: date-time
2969
+ * @description When this object was last changed (ISO-8601 timestamp).
2970
+ */
2799
2971
  updated_at: string | null;
2800
2972
  };
2801
2973
  /** CustomerAddressResource */
2802
2974
  CustomerAddressResource: {
2975
+ /** @description Unique identifier of this object. */
2803
2976
  id: string;
2977
+ /** @description Display label. */
2804
2978
  label: string | null;
2979
+ /** @description Postal address. */
2805
2980
  address: string;
2806
2981
  lat: number;
2807
2982
  lng: number;
2983
+ /** @description ISO-3166 country code. */
2808
2984
  country_code: string | null;
2809
2985
  state: string | null;
2810
2986
  city: string | null;
@@ -2815,36 +2991,57 @@ export interface components {
2815
2991
  };
2816
2992
  /** CustomerResource */
2817
2993
  CustomerResource: {
2994
+ /** @description Unique identifier of this object. */
2818
2995
  id: number;
2819
2996
  uid: string;
2997
+ /** @description Display name. */
2820
2998
  name: string | null;
2999
+ /** @description Email address. */
2821
3000
  email: string | null;
3001
+ /** @description Phone number. */
2822
3002
  phone: string | null;
2823
3003
  avatar: string;
2824
- /** Format: date-time */
3004
+ /**
3005
+ * Format: date-time
3006
+ * @description When this object was created (ISO-8601 timestamp).
3007
+ */
2825
3008
  created_at: string | null;
2826
- /** Format: date-time */
3009
+ /**
3010
+ * Format: date-time
3011
+ * @description When this object was last changed (ISO-8601 timestamp).
3012
+ */
2827
3013
  updated_at: string | null;
2828
3014
  };
2829
3015
  /** CustomerWishlistItemResource */
2830
3016
  CustomerWishlistItemResource: {
2831
- /** Format: date-time */
3017
+ /**
3018
+ * Format: date-time
3019
+ * @description When this object was created (ISO-8601 timestamp).
3020
+ */
2832
3021
  created_at: string | null;
2833
3022
  product: unknown[];
2834
3023
  variant: {
3024
+ /** @description Unique identifier of this object. */
2835
3025
  id: string;
3026
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
2836
3027
  p_id: number;
3028
+ /** @description Display title. */
2837
3029
  title: string;
2838
3030
  option_values: string;
2839
3031
  } | null;
2840
3032
  };
2841
3033
  /** DiscountResource */
2842
3034
  DiscountResource: {
3035
+ /** @description Unique identifier of this object. */
2843
3036
  id: string;
2844
3037
  reference: string;
3038
+ /** @description Display title. */
2845
3039
  title: string;
3040
+ /** @description Descriptive text. */
2846
3041
  description: string;
2847
3042
  type: string;
3043
+ /** @description ISO-4217 currency code of the amounts on this object. */
3044
+ currency: string;
2848
3045
  value: string;
2849
3046
  product_ids: unknown[];
2850
3047
  category_ids: unknown[];
@@ -2858,24 +3055,39 @@ export interface components {
2858
3055
  auto_apply: boolean;
2859
3056
  /** @enum {string} */
2860
3057
  status: "active" | "inactive";
3058
+ /** @description Whether this object is active. */
2861
3059
  is_active: boolean;
2862
3060
  is_published: boolean;
3061
+ /** @description URL of the image. */
2863
3062
  image_url: string;
2864
3063
  valid_from: string | null;
2865
3064
  valid_until: string | null;
2866
- /** Format: date-time */
3065
+ /**
3066
+ * Format: date-time
3067
+ * @description When this object was published (ISO-8601 timestamp).
3068
+ */
2867
3069
  published_at: string | null;
2868
- /** Format: date-time */
3070
+ /**
3071
+ * Format: date-time
3072
+ * @description When this object was created (ISO-8601 timestamp).
3073
+ */
2869
3074
  created_at: string | null;
2870
- /** Format: date-time */
3075
+ /**
3076
+ * Format: date-time
3077
+ * @description When this object was last changed (ISO-8601 timestamp).
3078
+ */
2871
3079
  updated_at: string | null;
2872
3080
  };
2873
3081
  /** FollowerResource */
2874
3082
  FollowerResource: {
3083
+ /** @description Unique identifier of this object. */
2875
3084
  id: string;
2876
3085
  customer_id: number | null;
3086
+ /** @description Display name. */
2877
3087
  name: string | null;
3088
+ /** @description Email address. */
2878
3089
  email: string | null;
3090
+ /** @description Phone number. */
2879
3091
  phone: string | null;
2880
3092
  avatar: string | null;
2881
3093
  shared_contact: boolean;
@@ -2892,12 +3104,20 @@ export interface components {
2892
3104
  source_review_id: string;
2893
3105
  product: string;
2894
3106
  rating: number;
3107
+ /** @description Display title. */
2895
3108
  title: string | null;
3109
+ /** @description Descriptive text. */
2896
3110
  description: string | null;
2897
3111
  author_display_name: string | null;
2898
- /** Format: date-time */
3112
+ /**
3113
+ * Format: date-time
3114
+ * @description When this was submitted (ISO-8601 timestamp).
3115
+ */
2899
3116
  submitted_at: string;
2900
- /** Format: date-time */
3117
+ /**
3118
+ * Format: date-time
3119
+ * @description When this object was last edited (ISO-8601 timestamp).
3120
+ */
2901
3121
  edited_at: string | null;
2902
3122
  media: string[] | null;
2903
3123
  user_id?: string;
@@ -2907,7 +3127,10 @@ export interface components {
2907
3127
  source?: string;
2908
3128
  status?: string;
2909
3129
  is_verified_purchase?: string;
2910
- /** Format: date-time */
3130
+ /**
3131
+ * Format: date-time
3132
+ * @description When this object was created (ISO-8601 timestamp).
3133
+ */
2911
3134
  created_at?: string;
2912
3135
  }[];
2913
3136
  };
@@ -2932,7 +3155,7 @@ export interface components {
2932
3155
  */
2933
3156
  ImportThirdPartyOrderRequest: {
2934
3157
  /**
2935
- * @description Optional for generic app installations, which derive source from the authenticated app and must omit this field. An installed Chowdeck or Glovo app must send its matching legacy slug. A generic app supplying this field, or a legacy app sending the other slug, receives 422. Human-key legacy imports still require this field and may send either slug.
3158
+ * @description Optional for generic app installations, which derive source from the authenticated app and must omit this field. An installed legacy marketplace app must send its matching slug. A generic app supplying this field, or a legacy app sending the other slug, receives 422. Human-key legacy imports still require this field and may send either slug.
2936
3159
  * @enum {string}
2937
3160
  */
2938
3161
  channel?: "chowdeck" | "glovo";
@@ -2946,7 +3169,9 @@ export interface components {
2946
3169
  /** Format: date-time */
2947
3170
  placed_at: string;
2948
3171
  customer: {
3172
+ /** @description Display name. */
2949
3173
  name: string;
3174
+ /** @description Phone number. */
2950
3175
  phone: string;
2951
3176
  };
2952
3177
  items: {
@@ -2976,10 +3201,13 @@ export interface components {
2976
3201
  /** InventoryLevelResource */
2977
3202
  InventoryLevelResource: {
2978
3203
  product: {
3204
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
2979
3205
  p_id: number;
3206
+ /** @description URL-safe handle of this object. */
2980
3207
  slug: string | null;
2981
3208
  };
2982
3209
  variant: {
3210
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
2983
3211
  p_id: number;
2984
3212
  } | null;
2985
3213
  quantity: number;
@@ -3007,6 +3235,7 @@ export interface components {
3007
3235
  * non-numeric ref resolves to nothing (never a Postgres cast 500).
3008
3236
  */
3009
3237
  MerchantAddonGroupRequest: {
3238
+ /** @description Display title. */
3010
3239
  title: string;
3011
3240
  required?: boolean;
3012
3241
  min?: number | null;
@@ -3018,9 +3247,11 @@ export interface components {
3018
3247
  * detaches only the addressable members the entries name.
3019
3248
  */
3020
3249
  items: {
3250
+ /** @description Unique identifier of this object. */
3021
3251
  id?: string;
3252
+ /** @description Display name. */
3022
3253
  name: string;
3023
- price?: number;
3254
+ price?: string;
3024
3255
  is_pack?: boolean;
3025
3256
  }[];
3026
3257
  };
@@ -3035,7 +3266,7 @@ export interface components {
3035
3266
  /** MerchantCollectedRecord */
3036
3267
  MerchantCollectedRecord: components["schemas"]["CollectedRecordResource"];
3037
3268
  /** MerchantCollection */
3038
- MerchantCollection: components["schemas"]["App.Http.Resources.Api.CollectionResource"];
3269
+ MerchantCollection: components["schemas"]["Collection"];
3039
3270
  /** MerchantCoupon */
3040
3271
  MerchantCoupon: components["schemas"]["CouponResource"];
3041
3272
  /** MerchantCustomer */
@@ -3051,16 +3282,27 @@ export interface components {
3051
3282
  author_display_name: string;
3052
3283
  product_p_id: string | null;
3053
3284
  rating: number;
3285
+ /** @description Display title. */
3054
3286
  title: string;
3287
+ /** @description Descriptive text. */
3055
3288
  description: string;
3056
3289
  media: string | string[];
3057
3290
  status: string;
3058
3291
  is_verified_purchase: boolean;
3059
- /** Format: date-time */
3292
+ /**
3293
+ * Format: date-time
3294
+ * @description When this was submitted (ISO-8601 timestamp).
3295
+ */
3060
3296
  submitted_at: string;
3061
- /** Format: date-time */
3297
+ /**
3298
+ * Format: date-time
3299
+ * @description When this object was created (ISO-8601 timestamp).
3300
+ */
3062
3301
  created_at: string;
3063
- /** Format: date-time */
3302
+ /**
3303
+ * Format: date-time
3304
+ * @description When this object was last edited (ISO-8601 timestamp).
3305
+ */
3064
3306
  edited_at: string;
3065
3307
  };
3066
3308
  /** MerchantImportedReview */
@@ -3097,8 +3339,11 @@ export interface components {
3097
3339
  MerchantInventoryLevels: components["schemas"]["MerchantInventoryLevelsResource"];
3098
3340
  /** MerchantInventoryLevelsResource */
3099
3341
  MerchantInventoryLevelsResource: {
3342
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
3100
3343
  p_id: number;
3344
+ /** @description URL-safe handle of this object. */
3101
3345
  slug: string;
3346
+ /** @description Barcode of the item, when set. */
3102
3347
  barcode: string;
3103
3348
  stock: number;
3104
3349
  effective_tracking: string;
@@ -3133,13 +3378,11 @@ export interface components {
3133
3378
  * Shipping zone input
3134
3379
  * @description POST shipping-zones / PUT shipping-zones/{zone} on the merchant API.
3135
3380
  *
3136
- * Zone rules match the dashboard's, except the rates: this API speaks money as
3137
- * decimal strings in the currency's major unit ("1500.00", or a number) — the
3138
- * same shape a zone read returns, so a read round-trips into a write. Values
3139
- * are stored in the currency's minor unit; the dashboard sends minor-unit
3140
- * integers directly.
3381
+ * Same zone rules and money rates as the dashboard zone write: major-unit decimal strings or numbers,
3382
+ * the shape a read returns. This request only adds the row's scope gate.
3141
3383
  */
3142
3384
  MerchantShippingZoneRequest: {
3385
+ /** @description Display name. */
3143
3386
  name: string;
3144
3387
  /** @enum {string} */
3145
3388
  zone_type: "local" | "national" | "international";
@@ -3165,18 +3408,28 @@ export interface components {
3165
3408
  * normalised to a URL-safe slug only when it arrives as a string.
3166
3409
  */
3167
3410
  MerchantStorePostRequest: {
3411
+ /** @description Display title. */
3168
3412
  title: string;
3413
+ /** @description URL-safe handle of this object. */
3169
3414
  slug?: string | null;
3170
3415
  body?: string | null;
3416
+ /** @description Short summary text. */
3171
3417
  excerpt?: string | null;
3418
+ /** @description URL of the cover image. */
3172
3419
  cover_image_url?: string | null;
3173
3420
  /** @enum {string|null} */
3174
3421
  status?: "draft" | "published" | null;
3175
- /** Format: date-time */
3422
+ /**
3423
+ * Format: date-time
3424
+ * @description When this object was published (ISO-8601 timestamp).
3425
+ */
3176
3426
  published_at?: string | null;
3427
+ /** @description Free-form tags attached to this object. */
3177
3428
  tags?: string[] | null;
3178
3429
  seo: {
3430
+ /** @description Display title. */
3179
3431
  title?: string | null;
3432
+ /** @description Descriptive text. */
3180
3433
  description?: string | null;
3181
3434
  /** Format: uri */
3182
3435
  og_image?: string | null;
@@ -3198,18 +3451,28 @@ export interface components {
3198
3451
  * the scoped unique ignores the resolved row.
3199
3452
  */
3200
3453
  MerchantUpdatePostRequest: {
3454
+ /** @description Display title. */
3201
3455
  title?: string;
3456
+ /** @description URL-safe handle of this object. */
3202
3457
  slug?: string | null;
3203
3458
  body?: string | null;
3459
+ /** @description Short summary text. */
3204
3460
  excerpt?: string | null;
3461
+ /** @description URL of the cover image. */
3205
3462
  cover_image_url?: string | null;
3206
3463
  /** @enum {string} */
3207
3464
  status?: "draft" | "published";
3208
- /** Format: date-time */
3465
+ /**
3466
+ * Format: date-time
3467
+ * @description When this object was published (ISO-8601 timestamp).
3468
+ */
3209
3469
  published_at?: string | null;
3470
+ /** @description Free-form tags attached to this object. */
3210
3471
  tags?: string[] | null;
3211
3472
  seo: {
3473
+ /** @description Display title. */
3212
3474
  title?: string | null;
3475
+ /** @description Descriptive text. */
3213
3476
  description?: string | null;
3214
3477
  /** Format: uri */
3215
3478
  og_image?: string | null;
@@ -3237,6 +3500,7 @@ export interface components {
3237
3500
  MetafieldDefinitionRequest: {
3238
3501
  /** @enum {string} */
3239
3502
  owner_type: "product" | "order";
3503
+ /** @description Namespace the key belongs to. */
3240
3504
  namespace: string;
3241
3505
  key: string;
3242
3506
  /** @enum {string} */
@@ -3244,7 +3508,9 @@ export interface components {
3244
3508
  storefront_visible?: boolean | null;
3245
3509
  pinned?: boolean | null;
3246
3510
  pinned_position?: number | null;
3511
+ /** @description Display name. */
3247
3512
  name?: string | null;
3513
+ /** @description Descriptive text. */
3248
3514
  description?: string | null;
3249
3515
  validations?: {
3250
3516
  min?: string | null;
@@ -3256,21 +3522,31 @@ export interface components {
3256
3522
  };
3257
3523
  /** MetafieldDefinitionResource */
3258
3524
  MetafieldDefinitionResource: {
3525
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
3259
3526
  p_id: number;
3260
3527
  handle: string;
3261
3528
  owner_type: string;
3529
+ /** @description Namespace the key belongs to. */
3262
3530
  namespace: string;
3263
3531
  key: string;
3264
3532
  type: string;
3265
3533
  storefront_visible: boolean;
3266
3534
  pinned: boolean;
3267
3535
  pinned_position: number | null;
3536
+ /** @description Display name. */
3268
3537
  name: string;
3538
+ /** @description Descriptive text. */
3269
3539
  description: string;
3270
3540
  validations: string;
3271
- /** Format: date-time */
3541
+ /**
3542
+ * Format: date-time
3543
+ * @description When this object was created (ISO-8601 timestamp).
3544
+ */
3272
3545
  created_at: string;
3273
- /** Format: date-time */
3546
+ /**
3547
+ * Format: date-time
3548
+ * @description When this object was last changed (ISO-8601 timestamp).
3549
+ */
3274
3550
  updated_at: string;
3275
3551
  };
3276
3552
  /**
@@ -3294,7 +3570,9 @@ export interface components {
3294
3570
  */
3295
3571
  MetaobjectDefinitionRequest: {
3296
3572
  type: string;
3573
+ /** @description Display name. */
3297
3574
  name: string;
3575
+ /** @description Descriptive text. */
3298
3576
  description?: string | null;
3299
3577
  display_field: string;
3300
3578
  storefront_visible?: boolean | null;
@@ -3306,6 +3584,7 @@ export interface components {
3306
3584
  has_pages?: boolean | null;
3307
3585
  fields: {
3308
3586
  key?: string;
3587
+ /** @description Display name. */
3309
3588
  name?: string;
3310
3589
  /** @enum {string} */
3311
3590
  type?: "single_line_text" | "multi_line_text" | "integer" | "decimal" | "boolean" | "date" | "url" | "json" | "media_id" | "list.single_line_text" | "list.multi_line_text" | "list.integer" | "list.decimal" | "list.boolean" | "list.date" | "list.url" | "list.media_id";
@@ -3324,9 +3603,12 @@ export interface components {
3324
3603
  };
3325
3604
  /** MetaobjectDefinitionResource */
3326
3605
  MetaobjectDefinitionResource: {
3606
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
3327
3607
  p_id: number;
3328
3608
  type: string;
3609
+ /** @description Display name. */
3329
3610
  name: string;
3611
+ /** @description Descriptive text. */
3330
3612
  description: string;
3331
3613
  display_field: string;
3332
3614
  storefront_visible: boolean;
@@ -3347,9 +3629,15 @@ export interface components {
3347
3629
  * responses never carry it.
3348
3630
  */
3349
3631
  records_count?: number | null;
3350
- /** Format: date-time */
3632
+ /**
3633
+ * Format: date-time
3634
+ * @description When this object was created (ISO-8601 timestamp).
3635
+ */
3351
3636
  created_at: string;
3352
- /** Format: date-time */
3637
+ /**
3638
+ * Format: date-time
3639
+ * @description When this object was last changed (ISO-8601 timestamp).
3640
+ */
3353
3641
  updated_at: string;
3354
3642
  };
3355
3643
  /**
@@ -3373,8 +3661,10 @@ export interface components {
3373
3661
  };
3374
3662
  /** OrderItemResource */
3375
3663
  OrderItemResource: {
3664
+ /** @description Unique identifier of this object. */
3376
3665
  id: string;
3377
3666
  quantity: number;
3667
+ /** @description Display title. */
3378
3668
  title: string | null;
3379
3669
  variant_id: string | null;
3380
3670
  variant_title: string | null;
@@ -3383,21 +3673,26 @@ export interface components {
3383
3673
  };
3384
3674
  variant_media: {
3385
3675
  image: string | null;
3676
+ /** @description URL of the video. */
3386
3677
  video_url: string | null;
3387
3678
  /** @enum {string} */
3388
3679
  source: "variant" | "product";
3389
3680
  } | null;
3681
+ /** @description ISO-4217 currency code of the amounts on this object. */
3390
3682
  currency: string;
3391
- total_price: number | null;
3392
- sale_price: number | null;
3393
- unit_price: number | null;
3394
- base_unit_price: number | null;
3683
+ total_price: string | null;
3684
+ sale_price: string | null;
3685
+ unit_price: string | null;
3686
+ base_unit_price: string | null;
3395
3687
  is_backorder: boolean;
3396
3688
  backorder_ready_date: string | null;
3397
- discounted_amount?: number | null;
3398
- /** Format: date-time */
3689
+ discounted_amount?: string | null;
3690
+ /**
3691
+ * Format: date-time
3692
+ * @description When this object was created (ISO-8601 timestamp).
3693
+ */
3399
3694
  created_at: string | null;
3400
- addons: unknown;
3695
+ addons: unknown[] | null;
3401
3696
  /**
3402
3697
  * @description Per-line checkout properties. Always present as an object so
3403
3698
  * dashboard chips and the shopper page never branch on absence.
@@ -3408,6 +3703,7 @@ export interface components {
3408
3703
  };
3409
3704
  /** OrderResource */
3410
3705
  OrderResource: {
3706
+ /** @description Unique identifier of this object. */
3411
3707
  id: number;
3412
3708
  uid: string;
3413
3709
  order_number: string;
@@ -3455,16 +3751,23 @@ export interface components {
3455
3751
  tax_total: string;
3456
3752
  total: string;
3457
3753
  customer: {
3754
+ /** @description Unique identifier of this object. */
3458
3755
  id: number;
3756
+ /** @description Display name. */
3459
3757
  name: string | null;
3758
+ /** @description Email address. */
3460
3759
  email: string | null;
3760
+ /** @description Phone number. */
3461
3761
  phone: string | null;
3462
3762
  } | null;
3463
3763
  shipping_address: {
3764
+ /** @description Postal address. */
3464
3765
  address: string | null;
3465
3766
  latitude: number | null;
3466
3767
  longitude: number | null;
3768
+ /** @description Display name. */
3467
3769
  name: string | null;
3770
+ /** @description Phone number. */
3468
3771
  phone: string | null;
3469
3772
  } | null;
3470
3773
  shipment: {
@@ -3480,9 +3783,11 @@ export interface components {
3480
3783
  delivered_at: string | null;
3481
3784
  } | null;
3482
3785
  line_items: {
3786
+ /** @description Unique identifier of this object. */
3483
3787
  id: string;
3484
3788
  product_id: number | null;
3485
3789
  product_uid: string | null;
3790
+ /** @description Display title. */
3486
3791
  title: string;
3487
3792
  variant_title: string;
3488
3793
  quantity: number;
@@ -3506,9 +3811,15 @@ export interface components {
3506
3811
  */
3507
3812
  metafields: string;
3508
3813
  metadata: string;
3509
- /** Format: date-time */
3814
+ /**
3815
+ * Format: date-time
3816
+ * @description When this object was created (ISO-8601 timestamp).
3817
+ */
3510
3818
  created_at: string | null;
3511
- /** Format: date-time */
3819
+ /**
3820
+ * Format: date-time
3821
+ * @description When this object was last changed (ISO-8601 timestamp).
3822
+ */
3512
3823
  updated_at: string | null;
3513
3824
  /** Format: date-time */
3514
3825
  fulfilled_at: string | null;
@@ -3523,59 +3834,87 @@ export interface components {
3523
3834
  };
3524
3835
  /** PostResource */
3525
3836
  PostResource: {
3837
+ /** @description Unique identifier of this object. */
3526
3838
  id: string;
3527
3839
  parent_id: string | null;
3528
3840
  blog_category_ids: string | string[];
3529
3841
  type: string;
3530
3842
  template: string;
3843
+ /** @description URL-safe handle of this object. */
3531
3844
  slug: string;
3845
+ /** @description Display title. */
3532
3846
  title: string;
3533
3847
  content: string;
3848
+ /** @description Short summary text. */
3534
3849
  excerpt: string;
3850
+ /** @description URL of the cover image. */
3535
3851
  cover_image_url: string;
3536
3852
  status: string;
3537
3853
  tags: string | string[];
3538
3854
  seo: string | string[];
3855
+ /** @description Sort position within the parent list. */
3539
3856
  position: number;
3540
3857
  is_home: boolean;
3541
3858
  chrome: string;
3542
3859
  show_page_title: boolean;
3543
- /** Format: date-time */
3860
+ /**
3861
+ * Format: date-time
3862
+ * @description When this object was published (ISO-8601 timestamp).
3863
+ */
3544
3864
  published_at: string | null;
3545
- /** Format: date-time */
3865
+ /**
3866
+ * Format: date-time
3867
+ * @description When this object was created (ISO-8601 timestamp).
3868
+ */
3546
3869
  created_at: string | null;
3547
- /** Format: date-time */
3870
+ /**
3871
+ * Format: date-time
3872
+ * @description When this object was last changed (ISO-8601 timestamp).
3873
+ */
3548
3874
  updated_at: string | null;
3549
3875
  };
3550
3876
  /** ProductImageResource */
3551
3877
  ProductImageResource: {
3878
+ /** @description Unique identifier of this object. */
3552
3879
  id: number | null;
3553
3880
  is_primary: string;
3554
3881
  position: string;
3882
+ /** @description Public URL. */
3555
3883
  url: string;
3556
3884
  alt: string | null;
3885
+ /** @description Width in pixels. */
3557
3886
  width: number | null;
3887
+ /** @description Height in pixels. */
3558
3888
  height: number | null;
3559
3889
  variants: string;
3560
3890
  };
3561
3891
  /** ProductQuestionResource */
3562
3892
  ProductQuestionResource: {
3893
+ /** @description Unique identifier of this object. */
3563
3894
  id: string;
3564
3895
  question: string;
3565
3896
  answer: string;
3566
3897
  status: string;
3567
- /** Format: date-time */
3898
+ /**
3899
+ * Format: date-time
3900
+ * @description When this object was created (ISO-8601 timestamp).
3901
+ */
3568
3902
  created_at: string;
3569
3903
  /** Format: date-time */
3570
3904
  answered_at: string;
3571
3905
  user?: {
3906
+ /** @description Unique identifier of this object. */
3572
3907
  id: string;
3908
+ /** @description Display name. */
3573
3909
  name: string;
3574
3910
  avatar: string;
3575
3911
  };
3576
3912
  product?: {
3913
+ /** @description Unique identifier of this object. */
3577
3914
  id: string;
3915
+ /** @description URL-safe handle of this object. */
3578
3916
  slug: string;
3917
+ /** @description Display title. */
3579
3918
  title: string;
3580
3919
  thumbnail: string;
3581
3920
  } | null;
@@ -3583,6 +3922,7 @@ export interface components {
3583
3922
  /** Product input */
3584
3923
  ProductRequest: {
3585
3924
  metafields?: {
3925
+ /** @description Namespace the key belongs to. */
3586
3926
  namespace?: string;
3587
3927
  key?: string;
3588
3928
  value?: string | null;
@@ -3593,10 +3933,12 @@ export interface components {
3593
3933
  * it can carry are size and count.
3594
3934
  */
3595
3935
  metadata?: (string | null)[] | null;
3936
+ /** @description Display title. */
3596
3937
  title: string;
3597
3938
  /** @description Update only: the merchant chose a new URL slug when renaming. Never empty, never a duplicate. */
3598
3939
  slug?: string;
3599
3940
  stock?: number | null;
3941
+ /** @description Whether stock is tracked for this item. */
3600
3942
  track_inventory?: boolean | null;
3601
3943
  in_stock?: boolean | null;
3602
3944
  service_id?: string | null;
@@ -3608,7 +3950,9 @@ export interface components {
3608
3950
  is_backorder?: boolean | null;
3609
3951
  /** Format: date-time */
3610
3952
  backorder_ready_date?: string | null;
3953
+ /** @description Descriptive text. */
3611
3954
  description?: string | null;
3955
+ /** @description Short summary text. */
3612
3956
  excerpt?: string | null;
3613
3957
  /**
3614
3958
  * Format: binary
@@ -3616,36 +3960,47 @@ export interface components {
3616
3960
  */
3617
3961
  image_file?: string;
3618
3962
  image_media_id?: number | null;
3963
+ /** @description Free-form tags attached to this object. */
3619
3964
  tags?: string[] | null;
3620
3965
  featured?: string | null;
3621
3966
  min_qty?: string | null;
3622
3967
  max_qty?: string | null;
3968
+ /** @description Weight of the item. */
3623
3969
  weight?: number | null;
3624
3970
  unit?: string | null;
3625
3971
  collection_ids?: string[] | null;
3626
- categories?: string[] | null;
3627
- collection_category_ids?: string[] | null;
3628
3972
  variations?: string[] | null;
3629
3973
  has_variants?: boolean;
3630
3974
  variants?: {
3631
- /** Format: uuid */
3975
+ /**
3976
+ * Format: uuid
3977
+ * @description Unique identifier of this object.
3978
+ */
3632
3979
  id?: string | null;
3980
+ /** @description Stock-keeping unit assigned by the store. */
3633
3981
  sku?: string | null;
3982
+ /** @description Barcode of the item, when set. */
3634
3983
  barcode?: string | null;
3984
+ /** @description Display title. */
3635
3985
  title?: string;
3636
3986
  option_values?: string[];
3637
3987
  price?: number;
3638
3988
  compare_at_price?: number | null;
3639
3989
  stock?: number | null;
3990
+ /** @description Whether stock is tracked for this item. */
3640
3991
  track_inventory?: boolean | null;
3992
+ /** @description Whether this object is active. */
3641
3993
  is_active?: boolean | null;
3994
+ /** @description Weight of the item. */
3642
3995
  weight?: number | null;
3996
+ /** @description Sort position within the parent list. */
3643
3997
  position?: number | null;
3644
3998
  is_backorder?: boolean | null;
3645
3999
  /** Format: date-time */
3646
4000
  backorder_ready_date?: string | null;
3647
4001
  }[];
3648
4002
  cost_price?: number | null;
4003
+ /** @description ISO-4217 currency code of the amounts on this object. */
3649
4004
  currency?: string | null;
3650
4005
  is_digital?: boolean | null;
3651
4006
  is_pos?: boolean | null;
@@ -3668,8 +4023,12 @@ export interface components {
3668
4023
  sku?: string | null;
3669
4024
  compare_at_price?: number | null;
3670
4025
  images?: string | null;
4026
+ /** @description URL of the image. */
3671
4027
  image_url?: string | null;
3672
- /** Format: uri */
4028
+ /**
4029
+ * Format: uri
4030
+ * @description URL of the video.
4031
+ */
3673
4032
  video_url?: string | null;
3674
4033
  /**
3675
4034
  * Format: binary
@@ -3703,11 +4062,16 @@ export interface components {
3703
4062
  };
3704
4063
  /** ProductResource */
3705
4064
  ProductResource: {
4065
+ /** @description Unique identifier of this object. */
3706
4066
  id: number;
3707
4067
  uid: string;
4068
+ /** @description Display title. */
3708
4069
  title: string;
4070
+ /** @description URL-safe handle of this object. */
3709
4071
  slug: string;
4072
+ /** @description Short summary text. */
3710
4073
  excerpt: string | null;
4074
+ /** @description Descriptive text. */
3711
4075
  description: string;
3712
4076
  /** @enum {string} */
3713
4077
  status: "active" | "out_of_stock" | "draft" | "archived";
@@ -3716,11 +4080,16 @@ export interface components {
3716
4080
  price: string;
3717
4081
  storefront_price: string;
3718
4082
  storefront_compare_at_price: string | null;
4083
+ /** @description Public URL. */
3719
4084
  url: string | null;
4085
+ /** @description ISO-4217 currency code of the amounts on this object. */
3720
4086
  currency: string;
4087
+ /** @description Stock-keeping unit assigned by the store. */
3721
4088
  sku: string;
4089
+ /** @description Barcode of the item, when set. */
3722
4090
  barcode: string;
3723
4091
  stock: number | null;
4092
+ /** @description Whether stock is tracked for this item. */
3724
4093
  track_inventory: boolean;
3725
4094
  is_digital: boolean;
3726
4095
  has_variants: boolean;
@@ -3750,9 +4119,15 @@ export interface components {
3750
4119
  */
3751
4120
  metafields: string;
3752
4121
  metadata: string;
3753
- /** Format: date-time */
4122
+ /**
4123
+ * Format: date-time
4124
+ * @description When this object was created (ISO-8601 timestamp).
4125
+ */
3754
4126
  created_at: string | null;
3755
- /** Format: date-time */
4127
+ /**
4128
+ * Format: date-time
4129
+ * @description When this object was last changed (ISO-8601 timestamp).
4130
+ */
3756
4131
  updated_at: string | null;
3757
4132
  /** Format: date-time */
3758
4133
  deleted_at: string | null;
@@ -3761,6 +4136,7 @@ export interface components {
3761
4136
  /** @description The channel id. */
3762
4137
  id: number;
3763
4138
  key: string;
4139
+ /** @description Display name. */
3764
4140
  name: string;
3765
4141
  }[];
3766
4142
  } & {
@@ -3768,9 +4144,12 @@ export interface components {
3768
4144
  };
3769
4145
  /** ProductReviewResource */
3770
4146
  ProductReviewResource: {
4147
+ /** @description Unique identifier of this object. */
3771
4148
  id: string;
3772
4149
  rating: number;
4150
+ /** @description Display title. */
3773
4151
  title: string;
4152
+ /** @description Descriptive text. */
3774
4153
  description: string;
3775
4154
  media: string | string[];
3776
4155
  vendor_response: string;
@@ -3778,62 +4157,101 @@ export interface components {
3778
4157
  vendor_response_at: string;
3779
4158
  status: string;
3780
4159
  is_verified_purchase: boolean;
3781
- /** Format: date-time */
4160
+ /**
4161
+ * Format: date-time
4162
+ * @description When this object was created (ISO-8601 timestamp).
4163
+ */
3782
4164
  created_at: string;
3783
- /** Format: date-time */
4165
+ /**
4166
+ * Format: date-time
4167
+ * @description When this object was last changed (ISO-8601 timestamp).
4168
+ */
3784
4169
  updated_at: string;
3785
- /** Format: date-time */
4170
+ /**
4171
+ * Format: date-time
4172
+ * @description When this object was last edited (ISO-8601 timestamp).
4173
+ */
3786
4174
  edited_at: string;
3787
- /** Format: date-time */
4175
+ /**
4176
+ * Format: date-time
4177
+ * @description When this was submitted (ISO-8601 timestamp).
4178
+ */
3788
4179
  submitted_at: string;
3789
4180
  source: string | null;
3790
4181
  author_display_name: string;
3791
4182
  user?: string;
3792
4183
  product?: {
4184
+ /** @description Unique identifier of this object. */
3793
4185
  id: string;
4186
+ /** @description URL-safe handle of this object. */
3794
4187
  slug: string;
4188
+ /** @description Display title. */
3795
4189
  title: string;
3796
4190
  thumbnail: string;
3797
4191
  };
3798
4192
  };
3799
4193
  /** ProductVariantResource */
3800
4194
  ProductVariantResource: {
4195
+ /** @description Unique identifier of this object. */
3801
4196
  id: number;
3802
4197
  uid: string;
4198
+ /** @description Stock-keeping unit assigned by the store. */
3803
4199
  sku: string;
4200
+ /** @description Barcode of the item, when set. */
3804
4201
  barcode: string;
4202
+ /** @description Display title. */
3805
4203
  title: string;
3806
4204
  option_values: string;
4205
+ /** @description ISO-4217 currency code of the amounts on this object. */
4206
+ currency: string;
3807
4207
  price: string;
3808
4208
  storefront_price: string;
3809
4209
  storefront_compare_at_price: string | null;
4210
+ /** @description Public URL. */
3810
4211
  url: string | null;
3811
4212
  compare_at_price: string | null;
3812
4213
  stock: number;
4214
+ /** @description Whether stock is tracked for this item. */
3813
4215
  track_inventory: boolean;
3814
4216
  /**
3815
4217
  * @description Product-level flag, inherited read-only: variants carry no
3816
4218
  * is_digital column, so a missing parent reads false, never throws.
3817
4219
  */
3818
4220
  is_digital: boolean;
4221
+ /** @description Whether this object is active. */
3819
4222
  is_active: boolean;
3820
4223
  is_backorder: boolean;
3821
4224
  backorder_ready_date: string | null;
4225
+ /** @description Weight of the item. */
3822
4226
  weight: number | null;
4227
+ /** @description Sort position within the parent list. */
3823
4228
  position: number;
3824
- /** Format: date-time */
4229
+ /**
4230
+ * Format: date-time
4231
+ * @description When this object was created (ISO-8601 timestamp).
4232
+ */
3825
4233
  created_at: string | null;
3826
- /** Format: date-time */
4234
+ /**
4235
+ * Format: date-time
4236
+ * @description When this object was last changed (ISO-8601 timestamp).
4237
+ */
3827
4238
  updated_at: string | null;
3828
4239
  };
3829
4240
  /** PromotionResource */
3830
4241
  PromotionResource: {
4242
+ /** @description Unique identifier of this object. */
3831
4243
  id: string;
4244
+ /** @description Display title. */
3832
4245
  title: string;
4246
+ /** @description Descriptive text. */
3833
4247
  description: string;
4248
+ /** @description URL of the image. */
3834
4249
  image_url: string;
3835
4250
  type: string;
3836
- value: number;
4251
+ /** @description ISO-4217 currency code of the amounts on this object. */
4252
+ currency: string;
4253
+ /** @description A percentage when `type` is percentage, an amount in `currency` otherwise. */
4254
+ value: string | null;
3837
4255
  priority: number;
3838
4256
  valid_from: string | null;
3839
4257
  valid_until: string | null;
@@ -3843,12 +4261,17 @@ export interface components {
3843
4261
  };
3844
4262
  /** PublicationResource */
3845
4263
  PublicationResource: {
4264
+ /** @description Unique identifier of this object. */
3846
4265
  id: number;
3847
4266
  key: string;
4267
+ /** @description Display name. */
3848
4268
  name: string;
3849
4269
  kind: string;
3850
4270
  status: string;
3851
- /** Format: date-time */
4271
+ /**
4272
+ * Format: date-time
4273
+ * @description When this object was created (ISO-8601 timestamp).
4274
+ */
3852
4275
  created_at: string | null;
3853
4276
  };
3854
4277
  /** @description The error envelope every error body answers. Switch on `error.code`, never on the message. The additive legacy-compatibility top-level keys some surfaces emit beside it (`error_code`, `message`, and — on non-reissued surfaces only — `request_id`, `doc_url`) are documented separately under `QueekLegacyErrorKeys`, which no operation references. */
@@ -3904,13 +4327,13 @@ export interface components {
3904
4327
  /** QueekStoreMetaobject */
3905
4328
  QueekStoreMetaobject: components["schemas"]["MetaobjectResource"];
3906
4329
  /** QueekStoreOrder */
3907
- QueekStoreOrder: components["schemas"]["App.Http.Resources.OrderResource"];
4330
+ QueekStoreOrder: components["schemas"]["Order"];
3908
4331
  /** QueekStoreOrderItem */
3909
- QueekStoreOrderItem: components["schemas"]["App.Http.Resources.Customer.OrderItemResource"];
4332
+ QueekStoreOrderItem: components["schemas"]["OrderItem"];
3910
4333
  /** QueekStorePage */
3911
4334
  QueekStorePage: components["schemas"]["StorePageResource"];
3912
4335
  /** QueekStoreProduct */
3913
- QueekStoreProduct: components["schemas"]["App.Http.Resources.Customer.ProductResource"];
4336
+ QueekStoreProduct: components["schemas"]["Product"];
3914
4337
  /** QueekStorePromotion */
3915
4338
  QueekStorePromotion: components["schemas"]["PromotionResource"];
3916
4339
  /** QueekStoreQuestion */
@@ -3940,6 +4363,7 @@ export interface components {
3940
4363
  };
3941
4364
  /** QueekWebhookCustomerEmailMarketingConsentPayload */
3942
4365
  QueekWebhookCustomerEmailMarketingConsentPayload: {
4366
+ /** @description Unique identifier of this object. */
3943
4367
  id: number;
3944
4368
  email_marketing_consent: {
3945
4369
  /** @enum {string} */
@@ -3988,6 +4412,7 @@ export interface components {
3988
4412
  };
3989
4413
  /** QueekWebhookCustomerSmsMarketingConsentPayload */
3990
4414
  QueekWebhookCustomerSmsMarketingConsentPayload: {
4415
+ /** @description Unique identifier of this object. */
3991
4416
  id: number;
3992
4417
  sms_marketing_consent: {
3993
4418
  /** @enum {string} */
@@ -4083,6 +4508,7 @@ export interface components {
4083
4508
  * be digits only.
4084
4509
  */
4085
4510
  RegisterPublicationRequest: {
4511
+ /** @description Display name. */
4086
4512
  name: string;
4087
4513
  key: string;
4088
4514
  };
@@ -4110,27 +4536,42 @@ export interface components {
4110
4536
  };
4111
4537
  /** ReviewsBlockItemResource */
4112
4538
  ReviewsBlockItemResource: {
4539
+ /** @description Unique identifier of this object. */
4113
4540
  id: string;
4114
4541
  rating: number;
4542
+ /** @description Display title. */
4115
4543
  title: string;
4544
+ /** @description Descriptive text. */
4116
4545
  description: string;
4117
4546
  media: string | string[];
4118
4547
  vendor_response: string;
4119
4548
  /** Format: date-time */
4120
4549
  vendor_response_at: string;
4121
4550
  is_verified_purchase: boolean;
4122
- /** Format: date-time */
4551
+ /**
4552
+ * Format: date-time
4553
+ * @description When this object was created (ISO-8601 timestamp).
4554
+ */
4123
4555
  created_at: string;
4124
- /** Format: date-time */
4556
+ /**
4557
+ * Format: date-time
4558
+ * @description When this object was last edited (ISO-8601 timestamp).
4559
+ */
4125
4560
  edited_at: string;
4126
- /** Format: date-time */
4561
+ /**
4562
+ * Format: date-time
4563
+ * @description When this was submitted (ISO-8601 timestamp).
4564
+ */
4127
4565
  submitted_at: string;
4128
4566
  source: string | null;
4129
4567
  author_display_name: string;
4130
4568
  user?: string;
4131
4569
  product?: {
4570
+ /** @description Unique identifier of this object. */
4132
4571
  id: string;
4572
+ /** @description URL-safe handle of this object. */
4133
4573
  slug: string;
4574
+ /** @description Display title. */
4134
4575
  title: string;
4135
4576
  thumbnail: string;
4136
4577
  };
@@ -4150,6 +4591,7 @@ export interface components {
4150
4591
  SendAppAlertRequest: {
4151
4592
  /** @enum {string} */
4152
4593
  severity: "info" | "warning" | "error";
4594
+ /** @description Display title. */
4153
4595
  title: string;
4154
4596
  message: string;
4155
4597
  dedupe_key?: string | null;
@@ -4157,32 +4599,39 @@ export interface components {
4157
4599
  };
4158
4600
  /** ShippingZoneResource */
4159
4601
  ShippingZoneResource: {
4602
+ /** @description Unique identifier of this object. */
4160
4603
  id: string;
4604
+ /** @description Display name. */
4161
4605
  name: string;
4162
4606
  zone_type: string;
4163
4607
  countries: unknown[];
4164
4608
  state_ids: unknown[];
4165
4609
  area_ids: unknown[];
4166
- /**
4167
- * @description Vendor chain, never the silent platform default: loaded relation first,
4168
- * then the cache-backed lookup (zero DB queries on a warm cache).
4169
- */
4610
+ /** @description ISO-4217 currency code of the amounts on this object. */
4170
4611
  currency: string;
4171
- base_rate: string;
4612
+ base_rate: string | null;
4172
4613
  per_kg_rate: string | null;
4173
4614
  min_weight_kg: string | null;
4174
4615
  max_weight_kg: string | null;
4175
4616
  min_days: number;
4176
4617
  max_days: number;
4177
4618
  active: boolean;
4619
+ /** @description Sort position within the parent list. */
4178
4620
  position: number;
4179
- /** Format: date-time */
4621
+ /**
4622
+ * Format: date-time
4623
+ * @description When this object was created (ISO-8601 timestamp).
4624
+ */
4180
4625
  created_at: string | null;
4181
- /** Format: date-time */
4626
+ /**
4627
+ * Format: date-time
4628
+ * @description When this object was last changed (ISO-8601 timestamp).
4629
+ */
4182
4630
  updated_at: string | null;
4183
4631
  };
4184
4632
  /** StockAdjustmentResource */
4185
4633
  StockAdjustmentResource: {
4634
+ /** @description Unique identifier of this object. */
4186
4635
  id: string;
4187
4636
  type: string;
4188
4637
  quantity_before: number;
@@ -4192,27 +4641,37 @@ export interface components {
4192
4641
  reason_code: string | null;
4193
4642
  scope: string;
4194
4643
  product: {
4644
+ /** @description Unique identifier of this object. */
4195
4645
  id: number;
4196
4646
  uid: string;
4647
+ /** @description Display title. */
4197
4648
  title: string;
4649
+ /** @description URL-safe handle of this object. */
4198
4650
  slug: string;
4199
4651
  } | null;
4200
4652
  variant: {
4201
4653
  uid: string;
4654
+ /** @description Display title. */
4202
4655
  title: string;
4203
4656
  option_values: string;
4204
4657
  } | null;
4205
4658
  order: {
4659
+ /** @description Unique identifier of this object. */
4206
4660
  id: number;
4207
4661
  uid: string;
4208
4662
  } | null;
4209
4663
  shortfall: string;
4210
- /** Format: date-time */
4664
+ /**
4665
+ * Format: date-time
4666
+ * @description When this object was created (ISO-8601 timestamp).
4667
+ */
4211
4668
  created_at: string | null;
4212
4669
  };
4213
4670
  /** Store coupon input */
4214
4671
  StoreCouponRequest: {
4672
+ /** @description Display title. */
4215
4673
  title: string;
4674
+ /** @description Descriptive text. */
4216
4675
  description?: string | null;
4217
4676
  code?: string | null;
4218
4677
  /** @enum {string} */
@@ -4232,7 +4691,9 @@ export interface components {
4232
4691
  };
4233
4692
  /** Store discount input */
4234
4693
  StoreDiscountRequest: {
4694
+ /** @description Display title. */
4235
4695
  title: string;
4696
+ /** @description Descriptive text. */
4236
4697
  description?: string | null;
4237
4698
  /** @enum {string} */
4238
4699
  type: "percentage" | "fixed";
@@ -4247,6 +4708,7 @@ export interface components {
4247
4708
  taxonomy_category_ids?: string[] | null;
4248
4709
  collection_category_ids?: string[] | null;
4249
4710
  attributes?: {
4711
+ /** @description Display name. */
4250
4712
  name?: string;
4251
4713
  /** @enum {string} */
4252
4714
  operator?: "eq" | "equals" | "contains" | "includes";
@@ -4269,16 +4731,21 @@ export interface components {
4269
4731
  valid_from?: string | null;
4270
4732
  /** Format: date-time */
4271
4733
  valid_until?: string | null;
4734
+ /** @description Whether this object is active. */
4272
4735
  is_active?: boolean;
4273
4736
  is_published?: boolean;
4274
4737
  auto_apply?: boolean;
4275
- /** Format: uri */
4738
+ /**
4739
+ * Format: uri
4740
+ * @description URL of the image.
4741
+ */
4276
4742
  image_url?: string | null;
4277
4743
  settings?: string[] | null;
4278
4744
  };
4279
4745
  /** StoreLocaleResource */
4280
4746
  StoreLocaleResource: {
4281
4747
  locale: string;
4748
+ /** @description Display name. */
4282
4749
  name: string;
4283
4750
  native_name: string;
4284
4751
  is_primary: boolean;
@@ -4290,10 +4757,13 @@ export interface components {
4290
4757
  };
4291
4758
  /** StorePageResource */
4292
4759
  StorePageResource: {
4760
+ /** @description Unique identifier of this object. */
4293
4761
  id: string;
4294
4762
  type: string;
4295
4763
  template: string;
4764
+ /** @description URL-safe handle of this object. */
4296
4765
  slug: string;
4766
+ /** @description Display title. */
4297
4767
  title: string;
4298
4768
  /**
4299
4769
  * @description Self-heal on serve: run stored blocks through the canonical
@@ -4306,7 +4776,9 @@ export interface components {
4306
4776
  */
4307
4777
  content: string | string[];
4308
4778
  media_index: string;
4779
+ /** @description Short summary text. */
4309
4780
  excerpt: string | null;
4781
+ /** @description URL of the cover image. */
4310
4782
  cover_image_url: string;
4311
4783
  cover_image_variants: string | null;
4312
4784
  tags: string | string[];
@@ -4314,6 +4786,7 @@ export interface components {
4314
4786
  blog_categories: string | string[];
4315
4787
  reading_time: number;
4316
4788
  author?: {
4789
+ /** @description Display name. */
4317
4790
  name: string;
4318
4791
  avatar_url: string;
4319
4792
  } | null;
@@ -4321,12 +4794,22 @@ export interface components {
4321
4794
  chrome: string;
4322
4795
  show_page_title: boolean;
4323
4796
  status: string;
4797
+ /** @description Sort position within the parent list. */
4324
4798
  position: number;
4325
- /** Format: date-time */
4799
+ /**
4800
+ * Format: date-time
4801
+ * @description When this object was published (ISO-8601 timestamp).
4802
+ */
4326
4803
  published_at: string | null;
4327
- /** Format: date-time */
4804
+ /**
4805
+ * Format: date-time
4806
+ * @description When this object was created (ISO-8601 timestamp).
4807
+ */
4328
4808
  created_at: string | null;
4329
- /** Format: date-time */
4809
+ /**
4810
+ * Format: date-time
4811
+ * @description When this object was last changed (ISO-8601 timestamp).
4812
+ */
4330
4813
  updated_at: string | null;
4331
4814
  };
4332
4815
  /**
@@ -4338,7 +4821,10 @@ export interface components {
4338
4821
  */
4339
4822
  StoreProductImageRequest: {
4340
4823
  media_id?: number | null;
4341
- /** Format: uri */
4824
+ /**
4825
+ * Format: uri
4826
+ * @description Public URL.
4827
+ */
4342
4828
  url?: string | null;
4343
4829
  primary?: boolean;
4344
4830
  };
@@ -4349,12 +4835,16 @@ export interface components {
4349
4835
  */
4350
4836
  StoreProductVariantRequest: {
4351
4837
  option_values: string[];
4838
+ /** @description Stock-keeping unit assigned by the store. */
4352
4839
  sku?: string | null;
4840
+ /** @description Barcode of the item, when set. */
4353
4841
  barcode?: string | null;
4354
4842
  price: number;
4355
4843
  compare_at_price?: number | null;
4356
4844
  stock?: number;
4845
+ /** @description Whether stock is tracked for this item. */
4357
4846
  track_inventory?: boolean;
4847
+ /** @description Whether this object is active. */
4358
4848
  is_active?: boolean;
4359
4849
  is_backorder?: boolean;
4360
4850
  /**
@@ -4362,7 +4852,9 @@ export interface components {
4362
4852
  * @description No `sometimes`: required_if must still fire when the date is omitted.
4363
4853
  */
4364
4854
  backorder_ready_date?: string | null;
4855
+ /** @description Weight of the item. */
4365
4856
  weight?: number | null;
4857
+ /** @description Sort position within the parent list. */
4366
4858
  position?: number;
4367
4859
  };
4368
4860
  /** StoreResource */
@@ -4485,9 +4977,12 @@ export interface components {
4485
4977
  };
4486
4978
  /** TeamDirectoryResource */
4487
4979
  TeamDirectoryResource: {
4980
+ /** @description Unique identifier of this object. */
4488
4981
  id: number;
4982
+ /** @description Display name. */
4489
4983
  name: string | null;
4490
4984
  role_names: string;
4985
+ /** @description Whether this object is active. */
4491
4986
  is_active: boolean;
4492
4987
  };
4493
4988
  /**
@@ -4509,6 +5004,7 @@ export interface components {
4509
5004
  status: "incomplete" | "complete";
4510
5005
  items: {
4511
5006
  key: string;
5007
+ /** @description Display label. */
4512
5008
  label: string;
4513
5009
  value: string;
4514
5010
  sensitive: boolean;
@@ -4552,12 +5048,16 @@ export interface components {
4552
5048
  */
4553
5049
  UpdateProductVariantRequest: {
4554
5050
  option_values?: string[];
5051
+ /** @description Stock-keeping unit assigned by the store. */
4555
5052
  sku?: string | null;
5053
+ /** @description Barcode of the item, when set. */
4556
5054
  barcode?: string | null;
4557
5055
  price?: number;
4558
5056
  compare_at_price?: number | null;
4559
5057
  stock?: number;
5058
+ /** @description Whether stock is tracked for this item. */
4560
5059
  track_inventory?: boolean;
5060
+ /** @description Whether this object is active. */
4561
5061
  is_active?: boolean;
4562
5062
  is_backorder?: boolean;
4563
5063
  /**
@@ -4565,7 +5065,9 @@ export interface components {
4565
5065
  * @description No `sometimes`: required_if must still fire when the date is omitted.
4566
5066
  */
4567
5067
  backorder_ready_date?: string | null;
5068
+ /** @description Weight of the item. */
4568
5069
  weight?: number | null;
5070
+ /** @description Sort position within the parent list. */
4569
5071
  position?: number;
4570
5072
  };
4571
5073
  /**
@@ -4625,18 +5127,24 @@ export interface components {
4625
5127
  };
4626
5128
  /** UserItemResource */
4627
5129
  UserItemResource: {
5130
+ /** @description Unique identifier of this object. */
4628
5131
  id: string;
4629
5132
  username: string;
4630
5133
  first_name: string | null;
4631
5134
  last_name: string | null;
5135
+ /** @description Display name. */
4632
5136
  name: string | null;
5137
+ /** @description Email address. */
4633
5138
  email: string | null;
5139
+ /** @description Phone number. */
4634
5140
  phone: string | null;
5141
+ /** @description ISO-3166 country code. */
4635
5142
  country_code: string | null;
4636
5143
  phone_code: string | null;
4637
5144
  avatar: string;
4638
5145
  map_lat: number;
4639
5146
  map_lng: number;
5147
+ /** @description Postal address. */
4640
5148
  address: string | null;
4641
5149
  status: string;
4642
5150
  roles?: string;
@@ -4650,15 +5158,17 @@ export interface components {
4650
5158
  };
4651
5159
  /** VendorItemResource */
4652
5160
  VendorItemResource: {
5161
+ /** @description Unique identifier of this object. */
4653
5162
  id: string;
5163
+ /** @description Display name. */
4654
5164
  name: string;
4655
5165
  distance: string;
4656
5166
  delivery_info: {
4657
5167
  is_free_delivery: boolean;
4658
- delivery_fee: number | null;
4659
- delivery_fee_value: number | null;
4660
- min_order: number;
4661
- min_order_fee: number;
5168
+ delivery_fee: string | null;
5169
+ delivery_fee_value: string | null;
5170
+ min_order: string | null;
5171
+ min_order_fee: string | null;
4662
5172
  /** @constant */
4663
5173
  d_p_value: 1.5;
4664
5174
  /**
@@ -4676,6 +5186,7 @@ export interface components {
4676
5186
  disable_delivery_msg?: "We dont have any available rider close to your location at the moment, please check back later";
4677
5187
  };
4678
5188
  notice: string[];
5189
+ /** @description URL-safe handle of this object. */
4679
5190
  slug: string;
4680
5191
  service: string;
4681
5192
  /**
@@ -4692,7 +5203,9 @@ export interface components {
4692
5203
  area: string;
4693
5204
  banner: string | null;
4694
5205
  support_phone: string;
5206
+ /** @description Phone number. */
4695
5207
  phone: string;
5208
+ /** @description ISO-3166 country code. */
4696
5209
  country_code: string;
4697
5210
  phone_code: string;
4698
5211
  support_email: string;
@@ -4707,13 +5220,14 @@ export interface components {
4707
5220
  rating: number;
4708
5221
  rating_count: number;
4709
5222
  short_description: string;
5223
+ /** @description Postal address. */
4710
5224
  address: string;
4711
5225
  open_time: string | null;
4712
5226
  close_time: string | null;
4713
5227
  service_type: string;
4714
5228
  landmark: string;
4715
5229
  region_id: string;
4716
- min_order_price: number | null;
5230
+ min_order_price: string | null;
4717
5231
  };
4718
5232
  /**
4719
5233
  * Vendor order extension input
@@ -4740,6 +5254,7 @@ export interface components {
4740
5254
  */
4741
5255
  VendorOrderExtensionRequest: {
4742
5256
  metafields?: {
5257
+ /** @description Namespace the key belongs to. */
4743
5258
  namespace?: string;
4744
5259
  key?: string;
4745
5260
  value?: string | null;
@@ -4770,8 +5285,11 @@ export interface components {
4770
5285
  };
4771
5286
  /** VendorProfileResource */
4772
5287
  VendorProfileResource: {
5288
+ /** @description Unique identifier of this object. */
4773
5289
  id: string;
5290
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
4774
5291
  p_id: number;
5292
+ /** @description Display name. */
4775
5293
  name: string;
4776
5294
  brand_id: string;
4777
5295
  status: string;
@@ -4781,24 +5299,32 @@ export interface components {
4781
5299
  logo_media_id: number | null;
4782
5300
  banner_media_id: number | null;
4783
5301
  logo_media?: {
5302
+ /** @description Unique identifier of this object. */
4784
5303
  id: number;
5304
+ /** @description Public URL. */
4785
5305
  url: string;
4786
5306
  thumbnail_url: string;
4787
5307
  mime_type: string;
4788
5308
  aggregate_type: string;
4789
5309
  size: number | null;
5310
+ /** @description Width in pixels. */
4790
5311
  width: number | null;
5312
+ /** @description Height in pixels. */
4791
5313
  height: number | null;
4792
5314
  duration_seconds: number | null;
4793
5315
  } | null;
4794
5316
  banner_media?: {
5317
+ /** @description Unique identifier of this object. */
4795
5318
  id: number;
5319
+ /** @description Public URL. */
4796
5320
  url: string;
4797
5321
  thumbnail_url: string;
4798
5322
  mime_type: string;
4799
5323
  aggregate_type: string;
4800
5324
  size: number | null;
5325
+ /** @description Width in pixels. */
4801
5326
  width: number | null;
5327
+ /** @description Height in pixels. */
4802
5328
  height: number | null;
4803
5329
  duration_seconds: number | null;
4804
5330
  } | null;
@@ -4806,10 +5332,13 @@ export interface components {
4806
5332
  value: number;
4807
5333
  count: number;
4808
5334
  };
5335
+ /** @description ISO-4217 currency code of the amounts on this object. */
5336
+ currency: string;
4809
5337
  commission: number;
4810
5338
  store_details: {
4811
5339
  support_phone: string;
4812
5340
  support_email: string;
5341
+ /** @description Postal address. */
4813
5342
  address: string;
4814
5343
  landmark: string;
4815
5344
  map_coordinates: {
@@ -4817,7 +5346,7 @@ export interface components {
4817
5346
  lng: number;
4818
5347
  };
4819
5348
  region: string | null;
4820
- minimum_order_price: number;
5349
+ minimum_order_price: string | null;
4821
5350
  service_type: string;
4822
5351
  };
4823
5352
  operating_hours: {
@@ -4857,7 +5386,7 @@ export interface components {
4857
5386
  instore_order_commission: number;
4858
5387
  service_charge: {
4859
5388
  percent: number;
4860
- cap: number;
5389
+ cap: string | null;
4861
5390
  };
4862
5391
  risk_level: string | "Not assessed";
4863
5392
  };
@@ -4868,28 +5397,40 @@ export interface components {
4868
5397
  */
4869
5398
  management: {
4870
5399
  owner: {
5400
+ /** @description Unique identifier of this object. */
4871
5401
  id: string;
5402
+ /** @description Display name. */
4872
5403
  name: string;
4873
5404
  } | string;
4874
5405
  manager: {
5406
+ /** @description Unique identifier of this object. */
4875
5407
  id: string;
5408
+ /** @description Display name. */
4876
5409
  name: string;
4877
5410
  } | string | "Not assigned";
4878
5411
  onboarded_by: {
5412
+ /** @description Unique identifier of this object. */
4879
5413
  id: string;
5414
+ /** @description Display name. */
4880
5415
  name: string;
4881
5416
  } | string | null;
4882
5417
  };
4883
5418
  bank_account: components["schemas"]["BankResource"] | null;
4884
5419
  wallet: {
5420
+ /** @description ISO-4217 currency code of the amounts on this object. */
5421
+ currency: string;
4885
5422
  balance: string | null;
4886
- balance_val: number | null;
5423
+ balance_val: string | null;
4887
5424
  total_withdrawal: string | null;
4888
5425
  };
4889
5426
  qr_codes: [
4890
5427
  {
4891
- /** @constant */
5428
+ /**
5429
+ * @description Display name.
5430
+ * @constant
5431
+ */
4892
5432
  name: "in_store_qrcode";
5433
+ /** @description Public URL. */
4893
5434
  url: string | null;
4894
5435
  qrcode: string;
4895
5436
  }
@@ -4902,12 +5443,14 @@ export interface components {
4902
5443
  };
4903
5444
  /** VendorResource */
4904
5445
  VendorResource: {
5446
+ /** @description Unique identifier of this object. */
4905
5447
  id: string;
5448
+ /** @description Display name. */
4906
5449
  name: string;
4907
5450
  distance: number;
4908
5451
  distance_text: string;
4909
5452
  delivery_info: {
4910
- delivery_fee: number | null;
5453
+ delivery_fee: string | null;
4911
5454
  delivery_time: string;
4912
5455
  pickup_enabled: boolean;
4913
5456
  /** @constant */
@@ -4926,6 +5469,7 @@ export interface components {
4926
5469
  service_type: string;
4927
5470
  commerce_mode: string | "quick";
4928
5471
  notice: string[];
5472
+ /** @description URL-safe handle of this object. */
4929
5473
  slug: string;
4930
5474
  service: string;
4931
5475
  logo: string | null;
@@ -4945,6 +5489,7 @@ export interface components {
4945
5489
  area: string | null;
4946
5490
  landmark?: string | null;
4947
5491
  support_phone?: string | null;
5492
+ /** @description ISO-3166 country code. */
4948
5493
  country_code?: string | null;
4949
5494
  phone_code?: string | null;
4950
5495
  support_email?: string | null;
@@ -4952,7 +5497,7 @@ export interface components {
4952
5497
  short_description?: string | null;
4953
5498
  disable_order?: boolean;
4954
5499
  region_id?: string | null;
4955
- min_order_price?: number | null;
5500
+ min_order_price?: string | null;
4956
5501
  /**
4957
5502
  * @description A sandbox store is publicly reachable at `{slug}-test`; the storefront
4958
5503
  * keeps it out of crawlers and AI discovery (robots, sitemap, agents.md).
@@ -4969,11 +5514,14 @@ export interface components {
4969
5514
  password_required?: boolean;
4970
5515
  indexable?: boolean;
4971
5516
  is_closed: boolean;
5517
+ /** @description ISO-4217 currency code of the amounts on this object. */
4972
5518
  currency: string;
4973
5519
  storefront_url?: string | null;
4974
5520
  checkout_url?: string | null;
4975
5521
  contact?: {
5522
+ /** @description Phone number. */
4976
5523
  phone: string | null;
5524
+ /** @description Email address. */
4977
5525
  email: string | null;
4978
5526
  whatsapp: string | null;
4979
5527
  };
@@ -4986,26 +5534,31 @@ export interface components {
4986
5534
  };
4987
5535
  /** WalletResource */
4988
5536
  WalletResource: {
4989
- balance: number | null;
4990
- balance_value: string;
5537
+ /** @description ISO-4217 currency code of the amounts on this object. */
5538
+ currency: string;
5539
+ balance: string | null;
5540
+ /** @description Display name. */
4991
5541
  name: string | null;
4992
5542
  account_number: string | null;
4993
5543
  account_name: string | null;
4994
5544
  account_provider: string | null;
5545
+ } & {
5546
+ [key: string]: unknown;
4995
5547
  };
4996
- /** @description Additive legacy-compatibility top-level keys the runtime still emits on error bodies — never a replacement for `error.*`, which is the contract. `error_code` and `message` ride top-level on helper-produced refusals; `request_id` and `doc_url` ride top-level ONLY on non-reissued controller-helper bodies (storefront, client, developer and dashboard surfaces) — merchant routes reissue refusals, so there they live inside `error` and the `X-Request-Id` header. Handler-produced bodies keep their own top-level keys with `error` stapled beside them. Not referenced by any operation response: new integrations switch on `error.code`. */
5548
+ /** @description Additive legacy-compatibility top-level keys the runtime still emits on error bodies — never a replacement for `error.*`, which is the contract. `error_code` and `message` ride top-level on the refusals the platform itself raises; `request_id` and `doc_url` ride top-level ONLY on storefront, client, developer and dashboard error bodies — merchant routes reissue refusals, so there they live inside `error` and the `X-Request-Id` header. Some bodies keep their own top-level keys with `error` added beside them. Not referenced by any operation response: new integrations switch on `error.code`. */
4997
5549
  QueekLegacyErrorKeys: {
4998
- /** @description Top-level mirror of `error.code` on helper-produced refusals (shared controller error helpers, client-auth handler branches). */
5550
+ /** @description Top-level mirror of `error.code` on the refusals the platform itself raises (including the storefront sign-in branches). */
4999
5551
  error_code?: string;
5000
- /** @description Top-level mirror of `error.message` on the same helper-produced refusals as `error_code`. */
5552
+ /** @description Top-level mirror of `error.message` on the same refusals as `error_code`. */
5001
5553
  message?: string;
5002
- /** @description Top-level mirror of `error.request_id` ONLY on non-reissued controller-helper bodies. Always a string when present. */
5554
+ /** @description Top-level mirror of `error.request_id` ONLY on storefront, client, developer and dashboard error bodies. Always a string when present. */
5003
5555
  request_id?: string;
5004
- /** @description Top-level mirror of `error.doc_url`, same per-producer scope as top-level `request_id`: non-reissued controller-helper bodies only. */
5556
+ /** @description Top-level mirror of `error.doc_url`, present on the same bodies as top-level `request_id`. */
5005
5557
  doc_url?: string;
5006
5558
  };
5007
5559
  /** @description One vendor metaobject entry with timestamps. `fields` carries the values keyed by field key. */
5008
5560
  MerchantMetaobject: {
5561
+ /** @description Short, stable integer identifier of this object, the human-readable counterpart of its UUID. */
5009
5562
  p_id: number;
5010
5563
  type: string;
5011
5564
  handle: string;
@@ -5015,9 +5568,15 @@ export interface components {
5015
5568
  fields: {
5016
5569
  [key: string]: unknown;
5017
5570
  };
5018
- /** Format: date-time */
5571
+ /**
5572
+ * Format: date-time
5573
+ * @description When this object was created (ISO-8601 timestamp).
5574
+ */
5019
5575
  created_at: string;
5020
- /** Format: date-time */
5576
+ /**
5577
+ * Format: date-time
5578
+ * @description When this object was last changed (ISO-8601 timestamp).
5579
+ */
5021
5580
  updated_at: string;
5022
5581
  };
5023
5582
  /** @description The updated publication beside the per-ref outcomes of one PATCH call. */
@@ -5056,60 +5615,7 @@ export interface components {
5056
5615
  last_posted_at: string;
5057
5616
  };
5058
5617
  };
5059
- responses: {
5060
- /** @description Unauthenticated */
5061
- AuthenticationException: {
5062
- headers: {
5063
- [name: string]: unknown;
5064
- };
5065
- content: {
5066
- "application/json": {
5067
- /** @description Error overview. */
5068
- message: string;
5069
- };
5070
- };
5071
- };
5072
- /** @description Validation error */
5073
- ValidationException: {
5074
- headers: {
5075
- [name: string]: unknown;
5076
- };
5077
- content: {
5078
- "application/json": {
5079
- /** @description Errors overview. */
5080
- message: string;
5081
- /** @description A detailed description of each field that failed validation. */
5082
- errors: {
5083
- [key: string]: string[];
5084
- };
5085
- };
5086
- };
5087
- };
5088
- /** @description Authorization error */
5089
- AuthorizationException: {
5090
- headers: {
5091
- [name: string]: unknown;
5092
- };
5093
- content: {
5094
- "application/json": {
5095
- /** @description Error overview. */
5096
- message: string;
5097
- };
5098
- };
5099
- };
5100
- /** @description Not found */
5101
- ModelNotFoundException: {
5102
- headers: {
5103
- [name: string]: unknown;
5104
- };
5105
- content: {
5106
- "application/json": {
5107
- /** @description Error overview. */
5108
- message: string;
5109
- };
5110
- };
5111
- };
5112
- };
5618
+ responses: never;
5113
5619
  parameters: never;
5114
5620
  requestBodies: never;
5115
5621
  headers: never;
@@ -5120,8 +5626,12 @@ export interface operations {
5120
5626
  "addons.list": {
5121
5627
  parameters: {
5122
5628
  query?: {
5123
- /** @example 2 */
5629
+ /**
5630
+ * @description Maximum number of items to return in one page.
5631
+ * @example 2
5632
+ */
5124
5633
  limit?: number | null;
5634
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
5125
5635
  starting_after?: string | null;
5126
5636
  };
5127
5637
  header: {
@@ -5162,6 +5672,7 @@ export interface operations {
5162
5672
  * "id": 44101,
5163
5673
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c01",
5164
5674
  * "name": "Grilled Chicken",
5675
+ * "currency": "NGN",
5165
5676
  * "price": "1500.00",
5166
5677
  * "in_stock": true,
5167
5678
  * "is_pack": false,
@@ -5171,6 +5682,7 @@ export interface operations {
5171
5682
  * "id": 44102,
5172
5683
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c02",
5173
5684
  * "name": "Fried Plantain",
5685
+ * "currency": "NGN",
5174
5686
  * "price": "800.00",
5175
5687
  * "in_stock": true,
5176
5688
  * "is_pack": false,
@@ -5343,6 +5855,7 @@ export interface operations {
5343
5855
  * "id": 44101,
5344
5856
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c01",
5345
5857
  * "name": "Grilled Chicken",
5858
+ * "currency": "NGN",
5346
5859
  * "price": "1500.00",
5347
5860
  * "in_stock": true,
5348
5861
  * "is_pack": false,
@@ -5352,6 +5865,7 @@ export interface operations {
5352
5865
  * "id": 44102,
5353
5866
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c02",
5354
5867
  * "name": "Fried Plantain",
5868
+ * "currency": "NGN",
5355
5869
  * "price": "800.00",
5356
5870
  * "in_stock": true,
5357
5871
  * "is_pack": false,
@@ -5487,7 +6001,10 @@ export interface operations {
5487
6001
  "X-Request-Id"?: string;
5488
6002
  };
5489
6003
  path: {
5490
- /** @example 9101 */
6004
+ /**
6005
+ * @description Identifier of the add-on group, as returned by the Merchant API.
6006
+ * @example 9101
6007
+ */
5491
6008
  group: string;
5492
6009
  };
5493
6010
  cookie?: never;
@@ -5519,6 +6036,7 @@ export interface operations {
5519
6036
  * "id": 44101,
5520
6037
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c01",
5521
6038
  * "name": "Grilled Chicken",
6039
+ * "currency": "NGN",
5522
6040
  * "price": "1500.00",
5523
6041
  * "in_stock": true,
5524
6042
  * "is_pack": false,
@@ -5528,6 +6046,7 @@ export interface operations {
5528
6046
  * "id": 44102,
5529
6047
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c02",
5530
6048
  * "name": "Fried Plantain",
6049
+ * "currency": "NGN",
5531
6050
  * "price": "800.00",
5532
6051
  * "in_stock": true,
5533
6052
  * "is_pack": false,
@@ -5640,7 +6159,10 @@ export interface operations {
5640
6159
  "Idempotency-Key"?: string;
5641
6160
  };
5642
6161
  path: {
5643
- /** @example 9101 */
6162
+ /**
6163
+ * @description Identifier of the add-on group, as returned by the Merchant API.
6164
+ * @example 9101
6165
+ */
5644
6166
  group: string;
5645
6167
  };
5646
6168
  cookie?: never;
@@ -5793,7 +6315,10 @@ export interface operations {
5793
6315
  "Idempotency-Key"?: string;
5794
6316
  };
5795
6317
  path: {
5796
- /** @example 9101 */
6318
+ /**
6319
+ * @description Identifier of the add-on group, as returned by the Merchant API.
6320
+ * @example 9101
6321
+ */
5797
6322
  group: string;
5798
6323
  };
5799
6324
  cookie?: never;
@@ -5843,6 +6368,7 @@ export interface operations {
5843
6368
  * "id": 44101,
5844
6369
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c01",
5845
6370
  * "name": "Grilled Chicken",
6371
+ * "currency": "NGN",
5846
6372
  * "price": "1500.00",
5847
6373
  * "in_stock": true,
5848
6374
  * "is_pack": false,
@@ -5852,6 +6378,7 @@ export interface operations {
5852
6378
  * "id": 44102,
5853
6379
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c02",
5854
6380
  * "name": "Fried Plantain",
6381
+ * "currency": "NGN",
5855
6382
  * "price": "800.00",
5856
6383
  * "in_stock": true,
5857
6384
  * "is_pack": false,
@@ -6008,7 +6535,10 @@ export interface operations {
6008
6535
  "Idempotency-Key"?: string;
6009
6536
  };
6010
6537
  path: {
6011
- /** @example 20417 */
6538
+ /**
6539
+ * @description Identifier of the product, as returned by the Merchant API.
6540
+ * @example 20417
6541
+ */
6012
6542
  product: string;
6013
6543
  };
6014
6544
  cookie?: never;
@@ -6055,6 +6585,7 @@ export interface operations {
6055
6585
  * "id": 44201,
6056
6586
  * "uid": "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4c11",
6057
6587
  * "name": "Gift Box",
6588
+ * "currency": "NGN",
6058
6589
  * "price": "2500.00",
6059
6590
  * "in_stock": true,
6060
6591
  * "is_pack": false,
@@ -6222,9 +6753,15 @@ export interface operations {
6222
6753
  "Idempotency-Key"?: string;
6223
6754
  };
6224
6755
  path: {
6225
- /** @example 20417 */
6756
+ /**
6757
+ * @description Identifier of the product, as returned by the Merchant API.
6758
+ * @example 20417
6759
+ */
6226
6760
  product: string;
6227
- /** @example 9101 */
6761
+ /**
6762
+ * @description Identifier of the add-on group, as returned by the Merchant API.
6763
+ * @example 9101
6764
+ */
6228
6765
  group: string;
6229
6766
  };
6230
6767
  cookie?: never;
@@ -6551,11 +7088,11 @@ export interface operations {
6551
7088
  * "items": [
6552
7089
  * {
6553
7090
  * "key": "webhook_url",
6554
- * "label": "Chowdeck webhook URL",
6555
- * "value": "https://apps.usequeek.com/chowdeck/hooks/1095",
7091
+ * "label": "Example Kitchen webhook URL",
7092
+ * "value": "https://apps.usequeek.com/example-channel/hooks/1095",
6556
7093
  * "sensitive": false,
6557
7094
  * "copyable": true,
6558
- * "instructions": "Paste this into Chowdeck Vendor Portal → Settings → Webhooks."
7095
+ * "instructions": "Paste this into the Example Kitchen vendor portal → Settings → Webhooks."
6559
7096
  * }
6560
7097
  * ]
6561
7098
  * }
@@ -6579,11 +7116,11 @@ export interface operations {
6579
7116
  * "items": [
6580
7117
  * {
6581
7118
  * "key": "webhook_url",
6582
- * "label": "Chowdeck webhook URL",
6583
- * "value": "https://apps.usequeek.com/chowdeck/hooks/1095",
7119
+ * "label": "Example Kitchen webhook URL",
7120
+ * "value": "https://apps.usequeek.com/example-channel/hooks/1095",
6584
7121
  * "sensitive": false,
6585
7122
  * "copyable": true,
6586
- * "instructions": "Paste this into Chowdeck Vendor Portal → Settings → Webhooks."
7123
+ * "instructions": "Paste this into the Example Kitchen vendor portal → Settings → Webhooks."
6587
7124
  * }
6588
7125
  * ],
6589
7126
  * "updated_at": "2026-09-24T12:00:00+01:00"
@@ -6726,8 +7263,8 @@ export interface operations {
6726
7263
  /**
6727
7264
  * @example {
6728
7265
  * "severity": "warning",
6729
- * "title": "Chowdeck menu out of sync",
6730
- * "message": "Two items on Chowdeck no longer match a product in your store. Open the app to relink them.",
7266
+ * "title": "Example Kitchen menu out of sync",
7267
+ * "message": "Two items on Example Kitchen no longer match a product in your store. Open the app to relink them.",
6731
7268
  * "dedupe_key": "menu-sync-1095"
6732
7269
  * }
6733
7270
  */
@@ -7036,8 +7573,12 @@ export interface operations {
7036
7573
  "app.collected_definitions_list": {
7037
7574
  parameters: {
7038
7575
  query?: {
7039
- /** @example 2 */
7576
+ /**
7577
+ * @description Maximum number of items to return in one page.
7578
+ * @example 2
7579
+ */
7040
7580
  limit?: number | null;
7581
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
7041
7582
  starting_after?: string | null;
7042
7583
  };
7043
7584
  header: {
@@ -7419,7 +7960,10 @@ export interface operations {
7419
7960
  "Idempotency-Key"?: string;
7420
7961
  };
7421
7962
  path: {
7422
- /** @example 74 */
7963
+ /**
7964
+ * @description Identifier of the definition, as returned by the Merchant API.
7965
+ * @example 74
7966
+ */
7423
7967
  definition: string;
7424
7968
  };
7425
7969
  cookie?: never;
@@ -7617,12 +8161,19 @@ export interface operations {
7617
8161
  query?: {
7618
8162
  /** @example 74 */
7619
8163
  definition?: string;
7620
- /** @example 2 */
8164
+ /**
8165
+ * @description Maximum number of items to return in one page.
8166
+ * @example 2
8167
+ */
7621
8168
  limit?: number | null;
7622
- /** @example WzEsIjAyNTRiNDZlMWU2YTIxZmM3M2ZiZTVkMTQ1NTk5MDM4OGFjYzFmNWRkNzY3ZDY1OWM2YmJkOTIwNzliZjU3MWEiLCJleUp6ZFdKdGFYUjBaV1JmWVhRaU9pSXlNREkyTFRBNUxUSTBJREUxT2pJd09qQXdJaXdpY0Y5cFpDSTZOVFV6TUN3aVgzQnZhVzUwYzFSdlRtVjRkRWwwWlcxeklqcDBjblZsZlEiXQ */
8169
+ /**
8170
+ * @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true.
8171
+ * @example WzEsIjAyNTRiNDZlMWU2YTIxZmM3M2ZiZTVkMTQ1NTk5MDM4OGFjYzFmNWRkNzY3ZDY1OWM2YmJkOTIwNzliZjU3MWEiLCJleUp6ZFdKdGFYUjBaV1JmWVhRaU9pSXlNREkyTFRBNUxUSTBJREUxT2pJd09qQXdJaXdpY0Y5cFpDSTZOVFV6TUN3aVgzQnZhVzUwYzFSdlRtVjRkRWwwWlcxeklqcDBjblZsZlEiXQ
8172
+ */
7623
8173
  starting_after?: string | null;
7624
8174
  /** @example new */
7625
8175
  status?: components["schemas"]["CollectedRecordStatus"] | null;
8176
+ /** @description Free-text filter: only items matching this text are returned. */
7626
8177
  search?: string | null;
7627
8178
  };
7628
8179
  header: {
@@ -7940,7 +8491,10 @@ export interface operations {
7940
8491
  "X-Request-Id"?: string;
7941
8492
  };
7942
8493
  path: {
7943
- /** @example 5530 */
8494
+ /**
8495
+ * @description Identifier of the metaobject record, as returned by the Merchant API.
8496
+ * @example 5530
8497
+ */
7944
8498
  record: string;
7945
8499
  };
7946
8500
  cookie?: never;
@@ -8076,7 +8630,10 @@ export interface operations {
8076
8630
  "Idempotency-Key"?: string;
8077
8631
  };
8078
8632
  path: {
8079
- /** @example 5530 */
8633
+ /**
8634
+ * @description Identifier of the metaobject record, as returned by the Merchant API.
8635
+ * @example 5530
8636
+ */
8080
8637
  record: string;
8081
8638
  };
8082
8639
  cookie?: never;
@@ -8257,14 +8814,23 @@ export interface operations {
8257
8814
  "collections.list": {
8258
8815
  parameters: {
8259
8816
  query?: {
8260
- /** @example 2 */
8817
+ /**
8818
+ * @description Maximum number of items to return in one page.
8819
+ * @example 2
8820
+ */
8261
8821
  limit?: number | null;
8262
- /** @example eyJpZCI6MzEwOSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ */
8822
+ /**
8823
+ * @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true.
8824
+ * @example eyJpZCI6MzEwOSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ
8825
+ */
8263
8826
  starting_after?: string | null;
8264
8827
  /** @example all */
8265
8828
  collection_mode?: string | null;
8829
+ /** @description Free-text filter: only items matching this text are returned. */
8266
8830
  search?: string | null;
8831
+ /** @description Field to sort the list by. */
8267
8832
  sort_by?: string | null;
8833
+ /** @description Sort direction. One of `asc`, `desc`. */
8268
8834
  sort_order?: "asc" | "desc" | null;
8269
8835
  publication?: string | null;
8270
8836
  };
@@ -8627,7 +9193,10 @@ export interface operations {
8627
9193
  "Idempotency-Key"?: string;
8628
9194
  };
8629
9195
  path: {
8630
- /** @example 3108 */
9196
+ /**
9197
+ * @description Identifier of the collection, as returned by the Merchant API.
9198
+ * @example 3108
9199
+ */
8631
9200
  collection: string;
8632
9201
  };
8633
9202
  cookie?: never;
@@ -8807,7 +9376,10 @@ export interface operations {
8807
9376
  "Idempotency-Key"?: string;
8808
9377
  };
8809
9378
  path: {
8810
- /** @example 3108 */
9379
+ /**
9380
+ * @description Identifier of the collection, as returned by the Merchant API.
9381
+ * @example 3108
9382
+ */
8811
9383
  collection: string;
8812
9384
  };
8813
9385
  cookie?: never;
@@ -8976,11 +9548,19 @@ export interface operations {
8976
9548
  "posts.list": {
8977
9549
  parameters: {
8978
9550
  query?: {
8979
- /** @example 2 */
9551
+ /**
9552
+ * @description Maximum number of items to return in one page.
9553
+ * @example 2
9554
+ */
8980
9555
  limit?: number | null;
9556
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
8981
9557
  starting_after?: string | null;
9558
+ /** @description One of `page`, `post`, `gallery`. */
8982
9559
  type?: "page" | "post" | "gallery" | null;
8983
- /** @example published */
9560
+ /**
9561
+ * @description One of `draft`, `published`.
9562
+ * @example published
9563
+ */
8984
9564
  status?: "draft" | "published" | null;
8985
9565
  };
8986
9566
  header: {
@@ -9378,7 +9958,10 @@ export interface operations {
9378
9958
  "X-Request-Id"?: string;
9379
9959
  };
9380
9960
  path: {
9381
- /** @example how-we-smoke-our-party-jollof */
9961
+ /**
9962
+ * @description Identifier of the post, as returned by the Merchant API.
9963
+ * @example how-we-smoke-our-party-jollof
9964
+ */
9382
9965
  post: string;
9383
9966
  };
9384
9967
  cookie?: never;
@@ -9532,7 +10115,10 @@ export interface operations {
9532
10115
  "Idempotency-Key"?: string;
9533
10116
  };
9534
10117
  path: {
9535
- /** @example how-we-smoke-our-party-jollof */
10118
+ /**
10119
+ * @description Identifier of the post, as returned by the Merchant API.
10120
+ * @example how-we-smoke-our-party-jollof
10121
+ */
9536
10122
  post: string;
9537
10123
  };
9538
10124
  cookie?: never;
@@ -9745,7 +10331,10 @@ export interface operations {
9745
10331
  "Idempotency-Key"?: string;
9746
10332
  };
9747
10333
  path: {
9748
- /** @example how-we-smoke-our-party-jollof */
10334
+ /**
10335
+ * @description Identifier of the post, as returned by the Merchant API.
10336
+ * @example how-we-smoke-our-party-jollof
10337
+ */
9749
10338
  post: string;
9750
10339
  };
9751
10340
  cookie?: never;
@@ -9883,13 +10472,18 @@ export interface operations {
9883
10472
  "coupons.list": {
9884
10473
  parameters: {
9885
10474
  query?: {
9886
- /** @example 1 */
10475
+ /**
10476
+ * @description Maximum number of items to return in one page.
10477
+ * @example 1
10478
+ */
9887
10479
  limit?: number | null;
10480
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
9888
10481
  starting_after?: string | null;
9889
10482
  /** @example percentage */
9890
10483
  discount_type?: string | null;
9891
10484
  /** @example active */
9892
10485
  status?: string | null;
10486
+ /** @description Free-text filter: only items matching this text are returned. */
9893
10487
  search?: string | null;
9894
10488
  };
9895
10489
  header: {
@@ -9920,6 +10514,7 @@ export interface operations {
9920
10514
  * "title": "Lekki Launch 10% Off",
9921
10515
  * "description": "10% off your first order from our Lekki kitchen.",
9922
10516
  * "discount_type": "percentage",
10517
+ * "currency": "NGN",
9923
10518
  * "discount_value": "10.00",
9924
10519
  * "applies_to": "all_products",
9925
10520
  * "target_product_ids": [],
@@ -10085,6 +10680,7 @@ export interface operations {
10085
10680
  * "title": "Lekki Launch 10% Off",
10086
10681
  * "description": "10% off your first order from our Lekki kitchen.",
10087
10682
  * "discount_type": "percentage",
10683
+ * "currency": "NGN",
10088
10684
  * "discount_value": "10.00",
10089
10685
  * "applies_to": "all_products",
10090
10686
  * "target_product_ids": [],
@@ -10221,17 +10817,30 @@ export interface operations {
10221
10817
  "customers.list": {
10222
10818
  parameters: {
10223
10819
  query?: {
10224
- /** @example 2 */
10820
+ /**
10821
+ * @description Maximum number of items to return in one page.
10822
+ * @example 2
10823
+ */
10225
10824
  limit?: number | null;
10825
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
10226
10826
  starting_after?: string | null;
10227
10827
  from_date?: string | null;
10228
10828
  to_date?: string | null;
10829
+ /** @description One of `today`, `this_week`, `this_month`. */
10229
10830
  date_range?: "today" | "this_week" | "this_month" | null;
10831
+ /** @description One of `campaign`. */
10230
10832
  audience?: "campaign" | null;
10833
+ /** @description Free-text filter: only items matching this text are returned. */
10231
10834
  search?: string | null;
10232
- /** @example created_at */
10835
+ /**
10836
+ * @description Field to sort the list by. One of `created_at`, `updated_at`, `joined_date`, `name`, `email`, `phone`, `p_id`, `customer_orders_count`.
10837
+ * @example created_at
10838
+ */
10233
10839
  sort_by?: "created_at" | "updated_at" | "joined_date" | "name" | "email" | "phone" | "p_id" | "customer_orders_count" | null;
10234
- /** @example desc */
10840
+ /**
10841
+ * @description Sort direction. One of `asc`, `desc`.
10842
+ * @example desc
10843
+ */
10235
10844
  sort_order?: "asc" | "desc" | null;
10236
10845
  };
10237
10846
  header: {
@@ -10393,9 +11002,14 @@ export interface operations {
10393
11002
  "customers.list_followers": {
10394
11003
  parameters: {
10395
11004
  query?: {
10396
- /** @example 2 */
11005
+ /**
11006
+ * @description Maximum number of items to return in one page.
11007
+ * @example 2
11008
+ */
10397
11009
  limit?: number | null;
11010
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
10398
11011
  starting_after?: string | null;
11012
+ /** @description Free-text filter: only items matching this text are returned. */
10399
11013
  search?: string | null;
10400
11014
  };
10401
11015
  header: {
@@ -10551,7 +11165,10 @@ export interface operations {
10551
11165
  "X-Request-Id"?: string;
10552
11166
  };
10553
11167
  path: {
10554
- /** @example 90341 */
11168
+ /**
11169
+ * @description Identifier of the customer, as returned by the Merchant API.
11170
+ * @example 90341
11171
+ */
10555
11172
  customer: string;
10556
11173
  };
10557
11174
  cookie?: never;
@@ -10691,7 +11308,10 @@ export interface operations {
10691
11308
  "Idempotency-Key"?: string;
10692
11309
  };
10693
11310
  path: {
10694
- /** @example 90341 */
11311
+ /**
11312
+ * @description Identifier of the customer, as returned by the Merchant API.
11313
+ * @example 90341
11314
+ */
10695
11315
  customer: string;
10696
11316
  };
10697
11317
  cookie?: never;
@@ -10870,7 +11490,10 @@ export interface operations {
10870
11490
  "Idempotency-Key"?: string;
10871
11491
  };
10872
11492
  path: {
10873
- /** @example 90341 */
11493
+ /**
11494
+ * @description Identifier of the customer, as returned by the Merchant API.
11495
+ * @example 90341
11496
+ */
10874
11497
  customer: string;
10875
11498
  };
10876
11499
  cookie?: never;
@@ -11053,9 +11676,15 @@ export interface operations {
11053
11676
  "customers.list_wishlist_items": {
11054
11677
  parameters: {
11055
11678
  query?: {
11056
- /** @example 2 */
11679
+ /**
11680
+ * @description Maximum number of items to return in one page.
11681
+ * @example 2
11682
+ */
11057
11683
  limit?: number | null;
11058
- /** @example eyJjdXN0b21lcl93aXNobGlzdF9pdGVtcy5jcmVhdGVkX2F0IjoiMjAyNi0wOS0yNCAxMjowMDowMCIsImN1c3RvbWVyX3dpc2hsaXN0X2l0ZW1zLmlkIjoiMDE5YTFkNTItM2M4ZS03ZjQxLWIwZDItNmEzZTljMWY0YjI4IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ */
11684
+ /**
11685
+ * @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true.
11686
+ * @example eyJjdXN0b21lcl93aXNobGlzdF9pdGVtcy5jcmVhdGVkX2F0IjoiMjAyNi0wOS0yNCAxMjowMDowMCIsImN1c3RvbWVyX3dpc2hsaXN0X2l0ZW1zLmlkIjoiMDE5YTFkNTItM2M4ZS03ZjQxLWIwZDItNmEzZTljMWY0YjI4IiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ
11687
+ */
11059
11688
  starting_after?: string | null;
11060
11689
  };
11061
11690
  header: {
@@ -11068,7 +11697,10 @@ export interface operations {
11068
11697
  "X-Request-Id"?: string;
11069
11698
  };
11070
11699
  path: {
11071
- /** @example 90341 */
11700
+ /**
11701
+ * @description Identifier of the customer, as returned by the Merchant API.
11702
+ * @example 90341
11703
+ */
11072
11704
  customer: string;
11073
11705
  };
11074
11706
  cookie?: never;
@@ -11100,13 +11732,13 @@ export interface operations {
11100
11732
  * "type": null,
11101
11733
  * "commerce_mode": "shop",
11102
11734
  * "currency": "NGN",
11103
- * "price": 2875,
11104
- * "discount_price": 2875,
11735
+ * "price": "2875.00",
11736
+ * "discount_price": "2875.00",
11105
11737
  * "compare_at_price": null,
11106
11738
  * "is_price_from": true,
11107
11739
  * "price_range": {
11108
- * "min": 2875,
11109
- * "max": 4830
11740
+ * "min": "2875.00",
11741
+ * "max": "4830.00"
11110
11742
  * },
11111
11743
  * "has_variants": true,
11112
11744
  * "has_addons": false,
@@ -11203,8 +11835,8 @@ export interface operations {
11203
11835
  * },
11204
11836
  * "variant_summary": {
11205
11837
  * "count": 2,
11206
- * "min_price": 2875,
11207
- * "max_price": 4830,
11838
+ * "min_price": "2875.00",
11839
+ * "max_price": "4830.00",
11208
11840
  * "total_stock": 60,
11209
11841
  * "tracks_inventory": true,
11210
11842
  * "in_stock": true
@@ -11277,9 +11909,9 @@ export interface operations {
11277
11909
  * "option_values": {
11278
11910
  * "Size": "50cl"
11279
11911
  * },
11280
- * "price": 2875,
11281
- * "discount_price": 2875,
11282
- * "discount_amount": 0,
11912
+ * "price": "2875.00",
11913
+ * "discount_price": "2875.00",
11914
+ * "discount_amount": "0.00",
11283
11915
  * "has_discount": false,
11284
11916
  * "compare_at_price": null,
11285
11917
  * "stock": 36,
@@ -11375,9 +12007,9 @@ export interface operations {
11375
12007
  * "option_values": {
11376
12008
  * "Size": "1 litre"
11377
12009
  * },
11378
- * "price": 4830,
11379
- * "discount_price": 4830,
11380
- * "discount_amount": 0,
12010
+ * "price": "4830.00",
12011
+ * "discount_price": "4830.00",
12012
+ * "discount_amount": "0.00",
11381
12013
  * "has_discount": false,
11382
12014
  * "compare_at_price": null,
11383
12015
  * "stock": 24,
@@ -11619,14 +12251,24 @@ export interface operations {
11619
12251
  "discounts.list": {
11620
12252
  parameters: {
11621
12253
  query?: {
11622
- /** @example 2 */
12254
+ /**
12255
+ * @description Maximum number of items to return in one page.
12256
+ * @example 2
12257
+ */
11623
12258
  limit?: number | null;
12259
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
11624
12260
  starting_after?: string | null;
12261
+ /** @description One of `percentage`, `fixed`. */
11625
12262
  type?: "percentage" | "fixed" | null;
11626
- /** @example active */
12263
+ /**
12264
+ * @description One of `active`, `inactive`.
12265
+ * @example active
12266
+ */
11627
12267
  status?: "active" | "inactive" | null;
11628
12268
  is_published?: boolean | null;
12269
+ /** @description Free-text filter: only items matching this text are returned. */
11629
12270
  search?: string | null;
12271
+ /** @description One of `all`, `discount`, `promotion`. */
11630
12272
  campaign_type?: "all" | "discount" | "promotion" | null;
11631
12273
  };
11632
12274
  header: {
@@ -11657,6 +12299,7 @@ export interface operations {
11657
12299
  * "title": "Detty December ₦2,000 Off",
11658
12300
  * "description": "₦2,000 off party packs through December.",
11659
12301
  * "type": "fixed",
12302
+ * "currency": "NGN",
11660
12303
  * "value": "2000.00",
11661
12304
  * "product_ids": [
11662
12305
  * "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4b21"
@@ -11686,6 +12329,7 @@ export interface operations {
11686
12329
  * "title": "Party Pack Season 10% Off",
11687
12330
  * "description": "10% off every party pack until the end of the year.",
11688
12331
  * "type": "percentage",
12332
+ * "currency": "NGN",
11689
12333
  * "value": "10.00",
11690
12334
  * "product_ids": [],
11691
12335
  * "category_ids": [
@@ -11862,6 +12506,7 @@ export interface operations {
11862
12506
  * "title": "Detty December ₦2,000 Off",
11863
12507
  * "description": "₦2,000 off party packs through December.",
11864
12508
  * "type": "fixed",
12509
+ * "currency": "NGN",
11865
12510
  * "value": "2000.00",
11866
12511
  * "product_ids": [
11867
12512
  * "019a1d52-3c8e-7f41-b0d2-6a3e9c1f4b21"
@@ -12011,7 +12656,10 @@ export interface operations {
12011
12656
  "X-Request-Id"?: string;
12012
12657
  };
12013
12658
  path: {
12014
- /** @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01 */
12659
+ /**
12660
+ * @description Identifier of the discount, as returned by the Merchant API.
12661
+ * @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01
12662
+ */
12015
12663
  discount: string;
12016
12664
  };
12017
12665
  cookie?: never;
@@ -12033,6 +12681,7 @@ export interface operations {
12033
12681
  * "title": "Party Pack Season 10% Off",
12034
12682
  * "description": "10% off every party pack until the end of the year.",
12035
12683
  * "type": "percentage",
12684
+ * "currency": "NGN",
12036
12685
  * "value": "10.00",
12037
12686
  * "product_ids": [],
12038
12687
  * "category_ids": [
@@ -12159,7 +12808,10 @@ export interface operations {
12159
12808
  "Idempotency-Key"?: string;
12160
12809
  };
12161
12810
  path: {
12162
- /** @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01 */
12811
+ /**
12812
+ * @description Identifier of the discount, as returned by the Merchant API.
12813
+ * @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01
12814
+ */
12163
12815
  discount: string;
12164
12816
  };
12165
12817
  cookie?: never;
@@ -12303,7 +12955,10 @@ export interface operations {
12303
12955
  "Idempotency-Key"?: string;
12304
12956
  };
12305
12957
  path: {
12306
- /** @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01 */
12958
+ /**
12959
+ * @description Identifier of the discount, as returned by the Merchant API.
12960
+ * @example 019a2e90-7a1b-7c2d-9e3f-4a5b6c7d8e01
12961
+ */
12307
12962
  discount: string;
12308
12963
  };
12309
12964
  cookie?: never;
@@ -12435,8 +13090,12 @@ export interface operations {
12435
13090
  "files.list": {
12436
13091
  parameters: {
12437
13092
  query?: {
12438
- /** @example 10 */
13093
+ /**
13094
+ * @description Maximum number of items to return in one page.
13095
+ * @example 10
13096
+ */
12439
13097
  limit?: number | null;
13098
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
12440
13099
  starting_after?: string | null;
12441
13100
  };
12442
13101
  header: {
@@ -12851,8 +13510,12 @@ export interface operations {
12851
13510
  "images.list": {
12852
13511
  parameters: {
12853
13512
  query?: {
12854
- /** @example 2 */
13513
+ /**
13514
+ * @description Maximum number of items to return in one page.
13515
+ * @example 2
13516
+ */
12855
13517
  limit?: number | null;
13518
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
12856
13519
  starting_after?: string | null;
12857
13520
  };
12858
13521
  header: {
@@ -12865,7 +13528,10 @@ export interface operations {
12865
13528
  "X-Request-Id"?: string;
12866
13529
  };
12867
13530
  path: {
12868
- /** @example 20417 */
13531
+ /**
13532
+ * @description Identifier of the product, as returned by the Merchant API.
13533
+ * @example 20417
13534
+ */
12869
13535
  product: string;
12870
13536
  };
12871
13537
  cookie?: never;
@@ -13092,7 +13758,10 @@ export interface operations {
13092
13758
  "Idempotency-Key"?: string;
13093
13759
  };
13094
13760
  path: {
13095
- /** @example 20417 */
13761
+ /**
13762
+ * @description Identifier of the product, as returned by the Merchant API.
13763
+ * @example 20417
13764
+ */
13096
13765
  product: string;
13097
13766
  };
13098
13767
  cookie?: never;
@@ -13366,9 +14035,15 @@ export interface operations {
13366
14035
  "Idempotency-Key"?: string;
13367
14036
  };
13368
14037
  path: {
13369
- /** @example 20417 */
14038
+ /**
14039
+ * @description Identifier of the product, as returned by the Merchant API.
14040
+ * @example 20417
14041
+ */
13370
14042
  product: string;
13371
- /** @example 88215 */
14043
+ /**
14044
+ * @description Identifier of the product image, as returned by the Merchant API.
14045
+ * @example 88215
14046
+ */
13372
14047
  image: string;
13373
14048
  };
13374
14049
  cookie?: never;
@@ -13512,9 +14187,15 @@ export interface operations {
13512
14187
  "Idempotency-Key"?: string;
13513
14188
  };
13514
14189
  path: {
13515
- /** @example 20417 */
14190
+ /**
14191
+ * @description Identifier of the product, as returned by the Merchant API.
14192
+ * @example 20417
14193
+ */
13516
14194
  product: string;
13517
- /** @example 88214 */
14195
+ /**
14196
+ * @description Identifier of the product image, as returned by the Merchant API.
14197
+ * @example 88214
14198
+ */
13518
14199
  image: string;
13519
14200
  };
13520
14201
  cookie?: never;
@@ -13818,10 +14499,17 @@ export interface operations {
13818
14499
  "inventory.levels": {
13819
14500
  parameters: {
13820
14501
  query?: {
13821
- /** @example 2 */
14502
+ /**
14503
+ * @description Maximum number of items to return in one page.
14504
+ * @example 2
14505
+ */
13822
14506
  limit?: number | null;
13823
- /** @example eyJwX2lkIjoyMDQxNywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ */
14507
+ /**
14508
+ * @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true.
14509
+ * @example eyJwX2lkIjoyMDQxNywiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ
14510
+ */
13824
14511
  starting_after?: string | null;
14512
+ /** @description Only items belonging to this product. */
13825
14513
  product?: string;
13826
14514
  barcode?: string;
13827
14515
  };
@@ -14162,8 +14850,12 @@ export interface operations {
14162
14850
  "inventory.history": {
14163
14851
  parameters: {
14164
14852
  query?: {
14165
- /** @example 2 */
14853
+ /**
14854
+ * @description Maximum number of items to return in one page.
14855
+ * @example 2
14856
+ */
14166
14857
  limit?: number | null;
14858
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
14167
14859
  starting_after?: string | null;
14168
14860
  type?: string | null;
14169
14861
  };
@@ -14177,7 +14869,10 @@ export interface operations {
14177
14869
  "X-Request-Id"?: string;
14178
14870
  };
14179
14871
  path: {
14180
- /** @example 20417 */
14872
+ /**
14873
+ * @description Identifier of the product, as returned by the Merchant API.
14874
+ * @example 20417
14875
+ */
14181
14876
  product: string;
14182
14877
  };
14183
14878
  cookie?: never;
@@ -14359,8 +15054,12 @@ export interface operations {
14359
15054
  "inventory.list_adjustments": {
14360
15055
  parameters: {
14361
15056
  query?: {
14362
- /** @example 2 */
15057
+ /**
15058
+ * @description Maximum number of items to return in one page.
15059
+ * @example 2
15060
+ */
14363
15061
  limit?: number | null;
15062
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
14364
15063
  starting_after?: string | null;
14365
15064
  type?: string | null;
14366
15065
  product_id?: string | null;
@@ -14742,8 +15441,12 @@ export interface operations {
14742
15441
  "metafields.list_definitions": {
14743
15442
  parameters: {
14744
15443
  query?: {
14745
- /** @example 2 */
15444
+ /**
15445
+ * @description Maximum number of items to return in one page.
15446
+ * @example 2
15447
+ */
14746
15448
  limit?: number | null;
15449
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
14747
15450
  starting_after?: string | null;
14748
15451
  owner_type?: string | null;
14749
15452
  };
@@ -15098,8 +15801,12 @@ export interface operations {
15098
15801
  "metaobjects.list_definitions": {
15099
15802
  parameters: {
15100
15803
  query?: {
15101
- /** @example 2 */
15804
+ /**
15805
+ * @description Maximum number of items to return in one page.
15806
+ * @example 2
15807
+ */
15102
15808
  limit?: number | null;
15809
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
15103
15810
  starting_after?: string | null;
15104
15811
  };
15105
15812
  header: {
@@ -15477,13 +16184,18 @@ export interface operations {
15477
16184
  "metaobjects.list": {
15478
16185
  parameters: {
15479
16186
  query?: {
15480
- /** @example 2 */
16187
+ /**
16188
+ * @description Maximum number of items to return in one page.
16189
+ * @example 2
16190
+ */
15481
16191
  limit?: number | null;
16192
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
15482
16193
  starting_after?: string | null;
15483
16194
  /** @example chef */
15484
16195
  type?: string | null;
15485
16196
  /** @example active */
15486
16197
  status?: string | null;
16198
+ /** @description Free-text filter: only items matching this text are returned. */
15487
16199
  search?: string | null;
15488
16200
  };
15489
16201
  header: {
@@ -15808,27 +16520,41 @@ export interface operations {
15808
16520
  "orders.list": {
15809
16521
  parameters: {
15810
16522
  query?: {
15811
- /** @example paid */
16523
+ /**
16524
+ * @description One of `paid`, `unpaid`, `refunded`, `partial`, `pending`, `awaiting_confirmation`.
16525
+ * @example paid
16526
+ */
15812
16527
  payment_status?: "paid" | "unpaid" | "refunded" | "partial" | "pending" | "awaiting_confirmation" | null;
15813
- /** @example delivery */
16528
+ /**
16529
+ * @description One of `delivery`, `pickup`, `instore`, `shipping`.
16530
+ * @example delivery
16531
+ */
15814
16532
  delivery_method?: "delivery" | "pickup" | "instore" | "shipping" | null;
15815
16533
  registry_id?: string | null;
15816
16534
  "metafield[]"?: string[] | null;
15817
16535
  /** @description Only orders attributed to this sales channel: a channel id, or an app key's own channel key. Unknown channel 404, archived 410. */
15818
16536
  publication?: string | null;
15819
16537
  /**
15820
- * @description One hand-recorded or third-party channel name (CustomOrderChannel);
15821
- * ANDs with ?channel= (e.g. channel=third_party narrows the
15822
- * platform, this picks the name). Shared with the Merchant API
15823
- * list, which pages the same rows — see its spec entry.
16538
+ * @description One hand-recorded or third-party channel name; combines with
16539
+ * ?channel= (channel=third_party narrows the platform, this picks
16540
+ * the name). The Merchant API list pages the same rows.
15824
16541
  */
15825
16542
  custom_channel?: "physical_sale" | "instagram" | "whatsapp" | "facebook" | "flutterwave" | "jiji" | "jumia" | "konga" | "tiktok" | "glovo" | "chowdeck" | "paystack" | "snapchat" | "x_twitter" | "others" | null;
16543
+ /** @description Field to sort the list by. One of `created_at`, `updated_at`, `status`, `payment_status`, `total`. */
15826
16544
  sort_by?: "created_at" | "updated_at" | "status" | "payment_status" | "total" | null;
16545
+ /** @description Sort direction. One of `asc`, `desc`. */
15827
16546
  sort_order?: "asc" | "desc" | null;
15828
- /** @example 2 */
16547
+ /**
16548
+ * @description Maximum number of items to return in one page.
16549
+ * @example 2
16550
+ */
15829
16551
  limit?: number | null;
16552
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
15830
16553
  starting_after?: string | null;
15831
- /** @example 2026-10-03T11:55:00Z */
16554
+ /**
16555
+ * @description Only items changed after this ISO-8601 timestamp.
16556
+ * @example 2026-10-03T11:55:00Z
16557
+ */
15832
16558
  updated_after?: string;
15833
16559
  };
15834
16560
  header: {
@@ -16117,7 +16843,10 @@ export interface operations {
16117
16843
  "X-Request-Id"?: string;
16118
16844
  };
16119
16845
  path: {
16120
- /** @example 58213 */
16846
+ /**
16847
+ * @description Identifier of the order, as returned by the Merchant API.
16848
+ * @example 58213
16849
+ */
16121
16850
  order: string;
16122
16851
  };
16123
16852
  cookie?: never;
@@ -16320,7 +17049,10 @@ export interface operations {
16320
17049
  "Idempotency-Key"?: string;
16321
17050
  };
16322
17051
  path: {
16323
- /** @example 58213 */
17052
+ /**
17053
+ * @description Identifier of the order, as returned by the Merchant API.
17054
+ * @example 58213
17055
+ */
16324
17056
  order: string;
16325
17057
  };
16326
17058
  cookie?: never;
@@ -16854,7 +17586,10 @@ export interface operations {
16854
17586
  "Idempotency-Key"?: string;
16855
17587
  };
16856
17588
  path: {
16857
- /** @example 58213 */
17589
+ /**
17590
+ * @description Identifier of the order, as returned by the Merchant API.
17591
+ * @example 58213
17592
+ */
16858
17593
  order: string;
16859
17594
  };
16860
17595
  cookie?: never;
@@ -17086,7 +17821,10 @@ export interface operations {
17086
17821
  "Idempotency-Key"?: string;
17087
17822
  };
17088
17823
  path: {
17089
- /** @example 58213 */
17824
+ /**
17825
+ * @description Identifier of the order, as returned by the Merchant API.
17826
+ * @example 58213
17827
+ */
17090
17828
  order: string;
17091
17829
  };
17092
17830
  cookie?: never;
@@ -17318,7 +18056,10 @@ export interface operations {
17318
18056
  "Idempotency-Key"?: string;
17319
18057
  };
17320
18058
  path: {
17321
- /** @example 58190 */
18059
+ /**
18060
+ * @description Identifier of the order, as returned by the Merchant API.
18061
+ * @example 58190
18062
+ */
17322
18063
  order: string;
17323
18064
  };
17324
18065
  cookie?: never;
@@ -17547,8 +18288,12 @@ export interface operations {
17547
18288
  "payouts.list": {
17548
18289
  parameters: {
17549
18290
  query?: {
17550
- /** @example 10 */
18291
+ /**
18292
+ * @description Maximum number of items to return in one page.
18293
+ * @example 10
18294
+ */
17551
18295
  limit?: number | null;
18296
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
17552
18297
  starting_after?: string | null;
17553
18298
  };
17554
18299
  header: {
@@ -17691,7 +18436,10 @@ export interface operations {
17691
18436
  "X-Request-Id"?: string;
17692
18437
  };
17693
18438
  path: {
17694
- /** @example 2026-09-24 */
18439
+ /**
18440
+ * @description Identifier of the payout, as returned by the Merchant API.
18441
+ * @example 2026-09-24
18442
+ */
17695
18443
  payout: string;
17696
18444
  };
17697
18445
  cookie?: never;
@@ -17818,11 +18566,18 @@ export interface operations {
17818
18566
  "products.list": {
17819
18567
  parameters: {
17820
18568
  query?: {
17821
- /** @example 2 */
18569
+ /**
18570
+ * @description Maximum number of items to return in one page.
18571
+ * @example 2
18572
+ */
17822
18573
  limit?: number | null;
18574
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
17823
18575
  starting_after?: string | null;
18576
+ /** @description Field to sort the list by. One of `created_at`, `updated_at`, `title`, `price`, `stock`, `published`. */
17824
18577
  sort_by?: "created_at" | "updated_at" | "title" | "price" | "stock" | "published" | null;
18578
+ /** @description Sort direction. */
17825
18579
  sort_order?: string | null;
18580
+ /** @description Free-text filter: only items matching this text are returned. */
17826
18581
  search?: string | null;
17827
18582
  category_id?: string | null;
17828
18583
  taxonomy_category_id?: string | null;
@@ -17834,10 +18589,15 @@ export interface operations {
17834
18589
  channel?: string | null;
17835
18590
  /** @description Only products published to this sales channel: a channel id, or an app key's own channel key. Unknown channel 404, archived 410. */
17836
18591
  publication?: string | null;
18592
+ /** @description One of `0`, `1`, `true`, `false`. */
17837
18593
  is_marketplace?: "0" | "1" | "true" | "false" | null;
18594
+ /** @description One of `0`, `1`, `true`, `false`. */
17838
18595
  is_wholesale?: "0" | "1" | "true" | "false" | null;
17839
18596
  "metafield[]"?: string[] | null;
17840
- /** @example 2026-10-03T11:55:00Z */
18597
+ /**
18598
+ * @description Only items changed after this ISO-8601 timestamp.
18599
+ * @example 2026-10-03T11:55:00Z
18600
+ */
17841
18601
  updated_after?: string;
17842
18602
  };
17843
18603
  header: {
@@ -17896,6 +18656,7 @@ export interface operations {
17896
18656
  * "option_values": {
17897
18657
  * "Size": "50cl"
17898
18658
  * },
18659
+ * "currency": "NGN",
17899
18660
  * "price": "2500.00",
17900
18661
  * "storefront_price": "2500.00",
17901
18662
  * "storefront_compare_at_price": null,
@@ -17921,6 +18682,7 @@ export interface operations {
17921
18682
  * "option_values": {
17922
18683
  * "Size": "1 litre"
17923
18684
  * },
18685
+ * "currency": "NGN",
17924
18686
  * "price": "4200.00",
17925
18687
  * "storefront_price": "4200.00",
17926
18688
  * "storefront_compare_at_price": null,
@@ -18217,10 +18979,6 @@ export interface operations {
18217
18979
  "multipart/form-data": components["schemas"]["ProductRequest"] & {
18218
18980
  /** @description The vendor's own collection ids (max 50), the same for every store type; optional on create. On update omit or send null to keep the current collections, send [] to clear them. Each id must be one of your own active manual collections: a global, another store's, trashed or smart collection is a 422. */
18219
18981
  collection_ids?: string[];
18220
- /** @description DEPRECATED alias of collection_ids, accepted for a limited window and ignored when collection_ids is sent. Validated under its own key. */
18221
- categories?: string[];
18222
- /** @description DEPRECATED alias of collection_ids, accepted for a limited window and ignored when collection_ids is sent. Validated under its own key. */
18223
- collection_category_ids?: string[];
18224
18982
  /** @description Accepted and ignored: the marketplace taxonomy is never vendor-facing, so this key has no effect (marketplace placement is assigned automatically). Any value is accepted so older clients keep working. */
18225
18983
  taxonomy_category_id?: string;
18226
18984
  /** @description Accepted and ignored: the marketplace taxonomy is never vendor-facing, so this key has no effect (marketplace placement is assigned automatically). Any value is accepted so older clients keep working. */
@@ -18437,16 +19195,25 @@ export interface operations {
18437
19195
  query?: {
18438
19196
  /** @example jollof */
18439
19197
  keyword?: string | null;
18440
- /** @example 1 */
19198
+ /**
19199
+ * @description One of `0`, `1`, `true`, `false`.
19200
+ * @example 1
19201
+ */
18441
19202
  in_stock?: "0" | "1" | "true" | "false" | null;
18442
19203
  /**
18443
19204
  * @description The dot is part of the handle (namespace.key), not a nested path, so
18444
19205
  * each handle and value is validated on the map as a whole.
18445
19206
  */
18446
19207
  "metafield[]"?: string[] | null;
18447
- /** @example latest */
19208
+ /**
19209
+ * @description One of `latest`, `popular`, `price_low`, `price_high`.
19210
+ * @example latest
19211
+ */
18448
19212
  sort?: "latest" | "popular" | "price_low" | "price_high" | null;
18449
- /** @example 2 */
19213
+ /**
19214
+ * @description Maximum number of items to return in one page.
19215
+ * @example 2
19216
+ */
18450
19217
  limit?: number | null;
18451
19218
  /** @description The cursor is an opaque signed token; pass it back unchanged. */
18452
19219
  starting_after?: string | null;
@@ -18507,6 +19274,7 @@ export interface operations {
18507
19274
  * "option_values": {
18508
19275
  * "Size": "50cl"
18509
19276
  * },
19277
+ * "currency": "NGN",
18510
19278
  * "price": "2500.00",
18511
19279
  * "storefront_price": "2500.00",
18512
19280
  * "storefront_compare_at_price": null,
@@ -18532,6 +19300,7 @@ export interface operations {
18532
19300
  * "option_values": {
18533
19301
  * "Size": "1 litre"
18534
19302
  * },
19303
+ * "currency": "NGN",
18535
19304
  * "price": "4200.00",
18536
19305
  * "storefront_price": "4200.00",
18537
19306
  * "storefront_compare_at_price": null,
@@ -18796,7 +19565,10 @@ export interface operations {
18796
19565
  "X-Request-Id"?: string;
18797
19566
  };
18798
19567
  path: {
18799
- /** @example 20417 */
19568
+ /**
19569
+ * @description Identifier of the product, as returned by the Merchant API.
19570
+ * @example 20417
19571
+ */
18800
19572
  product: string;
18801
19573
  };
18802
19574
  cookie?: never;
@@ -19002,7 +19774,10 @@ export interface operations {
19002
19774
  "Idempotency-Key"?: string;
19003
19775
  };
19004
19776
  path: {
19005
- /** @example 20417 */
19777
+ /**
19778
+ * @description Identifier of the product, as returned by the Merchant API.
19779
+ * @example 20417
19780
+ */
19006
19781
  product: string;
19007
19782
  };
19008
19783
  cookie?: never;
@@ -19026,10 +19801,6 @@ export interface operations {
19026
19801
  "multipart/form-data": components["schemas"]["ProductRequest"] & {
19027
19802
  /** @description The vendor's own collection ids (max 50), the same for every store type; optional on create. On update omit or send null to keep the current collections, send [] to clear them. Each id must be one of your own active manual collections: a global, another store's, trashed or smart collection is a 422. */
19028
19803
  collection_ids?: string[];
19029
- /** @description DEPRECATED alias of collection_ids, accepted for a limited window and ignored when collection_ids is sent. Validated under its own key. */
19030
- categories?: string[];
19031
- /** @description DEPRECATED alias of collection_ids, accepted for a limited window and ignored when collection_ids is sent. Validated under its own key. */
19032
- collection_category_ids?: string[];
19033
19804
  /** @description Accepted and ignored: the marketplace taxonomy is never vendor-facing, so this key has no effect (marketplace placement is assigned automatically). Any value is accepted so older clients keep working. */
19034
19805
  taxonomy_category_id?: string;
19035
19806
  /** @description Accepted and ignored: the marketplace taxonomy is never vendor-facing, so this key has no effect (marketplace placement is assigned automatically). Any value is accepted so older clients keep working. */
@@ -19281,7 +20052,10 @@ export interface operations {
19281
20052
  "Idempotency-Key"?: string;
19282
20053
  };
19283
20054
  path: {
19284
- /** @example 20417 */
20055
+ /**
20056
+ * @description Identifier of the product, as returned by the Merchant API.
20057
+ * @example 20417
20058
+ */
19285
20059
  product: string;
19286
20060
  };
19287
20061
  cookie?: never;
@@ -19592,8 +20366,12 @@ export interface operations {
19592
20366
  "publications.list": {
19593
20367
  parameters: {
19594
20368
  query?: {
19595
- /** @example 2 */
20369
+ /**
20370
+ * @description Maximum number of items to return in one page.
20371
+ * @example 2
20372
+ */
19596
20373
  limit?: number | null;
20374
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
19597
20375
  starting_after?: string | null;
19598
20376
  };
19599
20377
  header: {
@@ -19896,7 +20674,10 @@ export interface operations {
19896
20674
  "Idempotency-Key"?: string;
19897
20675
  };
19898
20676
  path: {
19899
- /** @example 1001 */
20677
+ /**
20678
+ * @description Identifier of the publication, as returned by the Merchant API.
20679
+ * @example 1001
20680
+ */
19900
20681
  publication: string;
19901
20682
  };
19902
20683
  cookie?: never;
@@ -20091,12 +20872,22 @@ export interface operations {
20091
20872
  "reviews.list_imported": {
20092
20873
  parameters: {
20093
20874
  query?: {
20094
- /** @example 2 */
20875
+ /**
20876
+ * @description Maximum number of items to return in one page.
20877
+ * @example 2
20878
+ */
20095
20879
  limit?: number | null;
20096
- /** @example eyJjcmVhdGVkX2F0IjoiMjAyNi0xMC0wMyAwOTowMDowMCIsImlkIjoiMDE5YTFkNTItM2M4ZS03ZjQxLWIwZDItNmEzZTljMWY0YjIxIiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ */
20880
+ /**
20881
+ * @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true.
20882
+ * @example eyJjcmVhdGVkX2F0IjoiMjAyNi0xMC0wMyAwOTowMDowMCIsImlkIjoiMDE5YTFkNTItM2M4ZS03ZjQxLWIwZDItNmEzZTljMWY0YjIxIiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ
20883
+ */
20097
20884
  starting_after?: string | null;
20885
+ /** @description Only items belonging to this product. */
20098
20886
  product?: string;
20099
- /** @example pending */
20887
+ /**
20888
+ * @description One of `pending`, `approved`, `rejected`.
20889
+ * @example pending
20890
+ */
20100
20891
  status?: "pending" | "approved" | "rejected";
20101
20892
  };
20102
20893
  header: {
@@ -20122,8 +20913,8 @@ export interface operations {
20122
20913
  * @example {
20123
20914
  * "data": [
20124
20915
  * {
20125
- * "source_review_id": "chowdeck-review-2026-0042",
20126
- * "source": "chowdeck",
20916
+ * "source_review_id": "example-channel-review-2026-0042",
20917
+ * "source": "example-channel",
20127
20918
  * "author_display_name": "Ifeoma Adebayo",
20128
20919
  * "product_p_id": 20417,
20129
20920
  * "rating": 5,
@@ -20255,7 +21046,7 @@ export interface operations {
20255
21046
  * @example {
20256
21047
  * "reviews": [
20257
21048
  * {
20258
- * "source_review_id": "chowdeck-review-2026-0042",
21049
+ * "source_review_id": "example-channel-review-2026-0042",
20259
21050
  * "product": "20417",
20260
21051
  * "rating": 5,
20261
21052
  * "title": "Fresh and delicious",
@@ -20285,7 +21076,7 @@ export interface operations {
20285
21076
  * "data": {
20286
21077
  * "results": [
20287
21078
  * {
20288
- * "source_review_id": "chowdeck-review-2026-0042",
21079
+ * "source_review_id": "example-channel-review-2026-0042",
20289
21080
  * "result": "imported",
20290
21081
  * "status": "pending",
20291
21082
  * "product_p_id": 20417
@@ -20410,8 +21201,12 @@ export interface operations {
20410
21201
  "shipping_zones.list": {
20411
21202
  parameters: {
20412
21203
  query?: {
20413
- /** @example 2 */
21204
+ /**
21205
+ * @description Maximum number of items to return in one page.
21206
+ * @example 2
21207
+ */
20414
21208
  limit?: number | null;
21209
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
20415
21210
  starting_after?: string | null;
20416
21211
  };
20417
21212
  header: {
@@ -20774,7 +21569,10 @@ export interface operations {
20774
21569
  "Idempotency-Key"?: string;
20775
21570
  };
20776
21571
  path: {
20777
- /** @example 019a2c5d-3e4f-7a5b-8c6d-7e8f9a0b1c21 */
21572
+ /**
21573
+ * @description Identifier of the shipping zone, as returned by the Merchant API.
21574
+ * @example 019a2c5d-3e4f-7a5b-8c6d-7e8f9a0b1c21
21575
+ */
20778
21576
  zone: string;
20779
21577
  };
20780
21578
  cookie?: never;
@@ -21165,9 +21963,14 @@ export interface operations {
21165
21963
  "team.list": {
21166
21964
  parameters: {
21167
21965
  query?: {
21168
- /** @example 2 */
21966
+ /**
21967
+ * @description Maximum number of items to return in one page.
21968
+ * @example 2
21969
+ */
21169
21970
  limit?: number | null;
21971
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
21170
21972
  starting_after?: string | null;
21973
+ /** @description Free-text filter: only items matching this text are returned. */
21171
21974
  search?: string | null;
21172
21975
  };
21173
21976
  header: {
@@ -21626,7 +22429,10 @@ export interface operations {
21626
22429
  "Idempotency-Key"?: string;
21627
22430
  };
21628
22431
  path: {
21629
- /** @example de */
22432
+ /**
22433
+ * @description Identifier of the locale, as returned by the Merchant API.
22434
+ * @example de
22435
+ */
21630
22436
  locale: string;
21631
22437
  };
21632
22438
  cookie?: never;
@@ -21773,7 +22579,10 @@ export interface operations {
21773
22579
  "Idempotency-Key"?: string;
21774
22580
  };
21775
22581
  path: {
21776
- /** @example fr */
22582
+ /**
22583
+ * @description Identifier of the locale, as returned by the Merchant API.
22584
+ * @example fr
22585
+ */
21777
22586
  locale: string;
21778
22587
  };
21779
22588
  cookie?: never;
@@ -21965,7 +22774,10 @@ export interface operations {
21965
22774
  "Idempotency-Key"?: string;
21966
22775
  };
21967
22776
  path: {
21968
- /** @example fr */
22777
+ /**
22778
+ * @description Identifier of the locale, as returned by the Merchant API.
22779
+ * @example fr
22780
+ */
21969
22781
  locale: string;
21970
22782
  };
21971
22783
  cookie?: never;
@@ -22129,10 +22941,17 @@ export interface operations {
22129
22941
  "translatable_resources.list": {
22130
22942
  parameters: {
22131
22943
  query: {
22132
- /** @example 2 */
22944
+ /**
22945
+ * @description Maximum number of items to return in one page.
22946
+ * @example 2
22947
+ */
22133
22948
  limit?: number | null;
22949
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
22134
22950
  starting_after?: string | null;
22135
- /** @example product */
22951
+ /**
22952
+ * @description One of `product`, `product_variation`, `product_variation_item`, `collection`, `category`, `page`, `post`, `menu`, `theme_string`.
22953
+ * @example product
22954
+ */
22136
22955
  type: "product" | "product_variation" | "product_variation_item" | "collection" | "category" | "page" | "post" | "menu" | "theme_string";
22137
22956
  };
22138
22957
  header: {
@@ -22317,7 +23136,10 @@ export interface operations {
22317
23136
  "translatable_resources.retrieve": {
22318
23137
  parameters: {
22319
23138
  query?: {
22320
- /** @example fr */
23139
+ /**
23140
+ * @description One of `en`, `fr`, `es`, `pt`, `pt-BR`, `de`, `it`, `nl`, `pl`, `ru`, `uk`, `tr`, `ar`, `ur`, `fa`, `he`, `hi`, `ja`, `ko`, `zh-CN`, `zh-TW`, `id`, `ms`, `vi`, `th`, `tl`, `sw`, `ha`, `yo`, `ig`, `pcm`.
23141
+ * @example fr
23142
+ */
22321
23143
  locale?: "en" | "fr" | "es" | "pt" | "pt-BR" | "de" | "it" | "nl" | "pl" | "ru" | "uk" | "tr" | "ar" | "ur" | "fa" | "he" | "hi" | "ja" | "ko" | "zh-CN" | "zh-TW" | "id" | "ms" | "vi" | "th" | "tl" | "sw" | "ha" | "yo" | "ig" | "pcm" | null;
22322
23144
  };
22323
23145
  header: {
@@ -22706,6 +23528,7 @@ export interface operations {
22706
23528
  "translations.delete": {
22707
23529
  parameters: {
22708
23530
  query?: {
23531
+ /** @description One of `en`, `fr`, `es`, `pt`, `pt-BR`, `de`, `it`, `nl`, `pl`, `ru`, `uk`, `tr`, `ar`, `ur`, `fa`, `he`, `hi`, `ja`, `ko`, `zh-CN`, `zh-TW`, `id`, `ms`, `vi`, `th`, `tl`, `sw`, `ha`, `yo`, `ig`, `pcm`. */
22709
23532
  "locales[]"?: "en" | "fr" | "es" | "pt" | "pt-BR" | "de" | "it" | "nl" | "pl" | "ru" | "uk" | "tr" | "ar" | "ur" | "fa" | "he" | "hi" | "ja" | "ko" | "zh-CN" | "zh-TW" | "id" | "ms" | "vi" | "th" | "tl" | "sw" | "ha" | "yo" | "ig" | "pcm";
22710
23533
  "keys[]"?: string[];
22711
23534
  };
@@ -22886,8 +23709,12 @@ export interface operations {
22886
23709
  "variants.list": {
22887
23710
  parameters: {
22888
23711
  query?: {
22889
- /** @example 2 */
23712
+ /**
23713
+ * @description Maximum number of items to return in one page.
23714
+ * @example 2
23715
+ */
22890
23716
  limit?: number | null;
23717
+ /** @description Cursor for the next page: pass `next_cursor` from the previous response unchanged. Keep walking while `has_more` is true. */
22891
23718
  starting_after?: string | null;
22892
23719
  };
22893
23720
  header: {
@@ -22900,7 +23727,10 @@ export interface operations {
22900
23727
  "X-Request-Id"?: string;
22901
23728
  };
22902
23729
  path: {
22903
- /** @example 20418 */
23730
+ /**
23731
+ * @description Identifier of the product, as returned by the Merchant API.
23732
+ * @example 20418
23733
+ */
22904
23734
  product: string;
22905
23735
  };
22906
23736
  cookie?: never;
@@ -22924,6 +23754,7 @@ export interface operations {
22924
23754
  * "option_values": {
22925
23755
  * "Size": "50cl"
22926
23756
  * },
23757
+ * "currency": "NGN",
22927
23758
  * "price": "2500.00",
22928
23759
  * "storefront_price": "2500.00",
22929
23760
  * "storefront_compare_at_price": null,
@@ -22949,6 +23780,7 @@ export interface operations {
22949
23780
  * "option_values": {
22950
23781
  * "Size": "1 litre"
22951
23782
  * },
23783
+ * "currency": "NGN",
22952
23784
  * "price": "4200.00",
22953
23785
  * "storefront_price": "4200.00",
22954
23786
  * "storefront_compare_at_price": null,
@@ -23098,7 +23930,10 @@ export interface operations {
23098
23930
  "Idempotency-Key"?: string;
23099
23931
  };
23100
23932
  path: {
23101
- /** @example 20418 */
23933
+ /**
23934
+ * @description Identifier of the product, as returned by the Merchant API.
23935
+ * @example 20418
23936
+ */
23102
23937
  product: string;
23103
23938
  };
23104
23939
  cookie?: never;
@@ -23140,6 +23975,7 @@ export interface operations {
23140
23975
  * "option_values": {
23141
23976
  * "Size": "1 litre"
23142
23977
  * },
23978
+ * "currency": "NGN",
23143
23979
  * "price": "4200.00",
23144
23980
  * "storefront_price": "4200.00",
23145
23981
  * "storefront_compare_at_price": null,
@@ -23305,9 +24141,15 @@ export interface operations {
23305
24141
  "Idempotency-Key"?: string;
23306
24142
  };
23307
24143
  path: {
23308
- /** @example 20418 */
24144
+ /**
24145
+ * @description Identifier of the product, as returned by the Merchant API.
24146
+ * @example 20418
24147
+ */
23309
24148
  product: string;
23310
- /** @example 7731 */
24149
+ /**
24150
+ * @description Identifier of the variant, as returned by the Merchant API.
24151
+ * @example 7731
24152
+ */
23311
24153
  variant: string;
23312
24154
  };
23313
24155
  cookie?: never;
@@ -23452,9 +24294,15 @@ export interface operations {
23452
24294
  "Idempotency-Key"?: string;
23453
24295
  };
23454
24296
  path: {
23455
- /** @example 20418 */
24297
+ /**
24298
+ * @description Identifier of the product, as returned by the Merchant API.
24299
+ * @example 20418
24300
+ */
23456
24301
  product: string;
23457
- /** @example 7732 */
24302
+ /**
24303
+ * @description Identifier of the variant, as returned by the Merchant API.
24304
+ * @example 7732
24305
+ */
23458
24306
  variant: string;
23459
24307
  };
23460
24308
  cookie?: never;
@@ -23489,6 +24337,7 @@ export interface operations {
23489
24337
  * "option_values": {
23490
24338
  * "Size": "1 litre"
23491
24339
  * },
24340
+ * "currency": "NGN",
23492
24341
  * "price": "4200.00",
23493
24342
  * "storefront_price": "4200.00",
23494
24343
  * "storefront_compare_at_price": null,
@@ -24036,4 +24885,3 @@ export interface operations {
24036
24885
  };
24037
24886
  };
24038
24887
  }
24039
- //# sourceMappingURL=merchant-schema.d.ts.map