@wix/stores 1.0.134 → 1.0.136

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 (235) hide show
  1. package/build/cjs/context.d.ts +5 -5
  2. package/build/cjs/context.js +5 -5
  3. package/build/cjs/context.js.map +1 -1
  4. package/build/cjs/index.d.ts +5 -6
  5. package/build/cjs/index.js +6 -7
  6. package/build/cjs/index.js.map +1 -1
  7. package/build/cjs/meta.d.ts +5 -6
  8. package/build/cjs/meta.js +6 -7
  9. package/build/cjs/meta.js.map +1 -1
  10. package/build/es/context.d.ts +5 -5
  11. package/build/es/context.js +5 -5
  12. package/build/es/context.js.map +1 -1
  13. package/build/es/index.d.ts +5 -6
  14. package/build/es/index.js +5 -6
  15. package/build/es/index.js.map +1 -1
  16. package/build/es/meta.d.ts +5 -6
  17. package/build/es/meta.js +5 -6
  18. package/build/es/meta.js.map +1 -1
  19. package/package.json +15 -9
  20. package/build/cjs/index.typings.d.ts +0 -6
  21. package/build/cjs/index.typings.js +0 -33
  22. package/build/cjs/index.typings.js.map +0 -1
  23. package/build/cjs/src/platform-v1-wishlist.context.d.ts +0 -3
  24. package/build/cjs/src/platform-v1-wishlist.context.js +0 -22
  25. package/build/cjs/src/platform-v1-wishlist.context.js.map +0 -1
  26. package/build/cjs/src/platform-v1-wishlist.http.d.ts +0 -3
  27. package/build/cjs/src/platform-v1-wishlist.http.js +0 -91
  28. package/build/cjs/src/platform-v1-wishlist.http.js.map +0 -1
  29. package/build/cjs/src/platform-v1-wishlist.meta.d.ts +0 -13
  30. package/build/cjs/src/platform-v1-wishlist.meta.js +0 -47
  31. package/build/cjs/src/platform-v1-wishlist.meta.js.map +0 -1
  32. package/build/cjs/src/platform-v1-wishlist.public.d.ts +0 -15
  33. package/build/cjs/src/platform-v1-wishlist.public.js +0 -12
  34. package/build/cjs/src/platform-v1-wishlist.public.js.map +0 -1
  35. package/build/cjs/src/platform-v1-wishlist.types.d.ts +0 -104
  36. package/build/cjs/src/platform-v1-wishlist.types.js +0 -3
  37. package/build/cjs/src/platform-v1-wishlist.types.js.map +0 -1
  38. package/build/cjs/src/platform-v1-wishlist.universal.d.ts +0 -121
  39. package/build/cjs/src/platform-v1-wishlist.universal.js +0 -106
  40. package/build/cjs/src/platform-v1-wishlist.universal.js.map +0 -1
  41. package/build/cjs/src/stores-catalog-v1-collection.context.d.ts +0 -5
  42. package/build/cjs/src/stores-catalog-v1-collection.context.js +0 -56
  43. package/build/cjs/src/stores-catalog-v1-collection.context.js.map +0 -1
  44. package/build/cjs/src/stores-catalog-v1-collection.http.d.ts +0 -10
  45. package/build/cjs/src/stores-catalog-v1-collection.http.js +0 -110
  46. package/build/cjs/src/stores-catalog-v1-collection.http.js.map +0 -1
  47. package/build/cjs/src/stores-catalog-v1-collection.meta.d.ts +0 -19
  48. package/build/cjs/src/stores-catalog-v1-collection.meta.js +0 -85
  49. package/build/cjs/src/stores-catalog-v1-collection.meta.js.map +0 -1
  50. package/build/cjs/src/stores-catalog-v1-collection.public.d.ts +0 -59
  51. package/build/cjs/src/stores-catalog-v1-collection.public.js +0 -27
  52. package/build/cjs/src/stores-catalog-v1-collection.public.js.map +0 -1
  53. package/build/cjs/src/stores-catalog-v1-collection.types.d.ts +0 -414
  54. package/build/cjs/src/stores-catalog-v1-collection.types.js +0 -18
  55. package/build/cjs/src/stores-catalog-v1-collection.types.js.map +0 -1
  56. package/build/cjs/src/stores-catalog-v1-collection.universal.d.ts +0 -452
  57. package/build/cjs/src/stores-catalog-v1-collection.universal.js +0 -225
  58. package/build/cjs/src/stores-catalog-v1-collection.universal.js.map +0 -1
  59. package/build/cjs/src/stores-catalog-v1-product.context.d.ts +0 -35
  60. package/build/cjs/src/stores-catalog-v1-product.context.js +0 -566
  61. package/build/cjs/src/stores-catalog-v1-product.context.js.map +0 -1
  62. package/build/cjs/src/stores-catalog-v1-product.http.d.ts +0 -89
  63. package/build/cjs/src/stores-catalog-v1-product.http.js +0 -1716
  64. package/build/cjs/src/stores-catalog-v1-product.http.js.map +0 -1
  65. package/build/cjs/src/stores-catalog-v1-product.meta.d.ts +0 -95
  66. package/build/cjs/src/stores-catalog-v1-product.meta.js +0 -655
  67. package/build/cjs/src/stores-catalog-v1-product.meta.js.map +0 -1
  68. package/build/cjs/src/stores-catalog-v1-product.public.d.ts +0 -1216
  69. package/build/cjs/src/stores-catalog-v1-product.public.js +0 -221
  70. package/build/cjs/src/stores-catalog-v1-product.public.js.map +0 -1
  71. package/build/cjs/src/stores-catalog-v1-product.types.d.ts +0 -4235
  72. package/build/cjs/src/stores-catalog-v1-product.types.js +0 -78
  73. package/build/cjs/src/stores-catalog-v1-product.types.js.map +0 -1
  74. package/build/cjs/src/stores-catalog-v1-product.universal.d.ts +0 -5074
  75. package/build/cjs/src/stores-catalog-v1-product.universal.js +0 -2220
  76. package/build/cjs/src/stores-catalog-v1-product.universal.js.map +0 -1
  77. package/build/cjs/src/stores-v1-abandoned-cart.http.d.ts +0 -6
  78. package/build/cjs/src/stores-v1-abandoned-cart.http.js +0 -103
  79. package/build/cjs/src/stores-v1-abandoned-cart.http.js.map +0 -1
  80. package/build/cjs/src/stores-v1-abandoned-cart.meta.d.ts +0 -16
  81. package/build/cjs/src/stores-v1-abandoned-cart.meta.js +0 -66
  82. package/build/cjs/src/stores-v1-abandoned-cart.meta.js.map +0 -1
  83. package/build/cjs/src/stores-v1-abandoned-cart.public.d.ts +0 -19
  84. package/build/cjs/src/stores-v1-abandoned-cart.public.js +0 -22
  85. package/build/cjs/src/stores-v1-abandoned-cart.public.js.map +0 -1
  86. package/build/cjs/src/stores-v1-abandoned-cart.types.d.ts +0 -216
  87. package/build/cjs/src/stores-v1-abandoned-cart.types.js +0 -30
  88. package/build/cjs/src/stores-v1-abandoned-cart.types.js.map +0 -1
  89. package/build/cjs/src/stores-v1-abandoned-cart.universal.d.ts +0 -246
  90. package/build/cjs/src/stores-v1-abandoned-cart.universal.js +0 -189
  91. package/build/cjs/src/stores-v1-abandoned-cart.universal.js.map +0 -1
  92. package/build/cjs/src/stores-v1-subscription-option.context.d.ts +0 -14
  93. package/build/cjs/src/stores-v1-subscription-option.context.js +0 -209
  94. package/build/cjs/src/stores-v1-subscription-option.context.js.map +0 -1
  95. package/build/cjs/src/stores-v1-subscription-option.http.d.ts +0 -128
  96. package/build/cjs/src/stores-v1-subscription-option.http.js +0 -466
  97. package/build/cjs/src/stores-v1-subscription-option.http.js.map +0 -1
  98. package/build/cjs/src/stores-v1-subscription-option.meta.d.ts +0 -40
  99. package/build/cjs/src/stores-v1-subscription-option.meta.js +0 -258
  100. package/build/cjs/src/stores-v1-subscription-option.meta.js.map +0 -1
  101. package/build/cjs/src/stores-v1-subscription-option.public.d.ts +0 -46
  102. package/build/cjs/src/stores-v1-subscription-option.public.js +0 -81
  103. package/build/cjs/src/stores-v1-subscription-option.public.js.map +0 -1
  104. package/build/cjs/src/stores-v1-subscription-option.types.d.ts +0 -351
  105. package/build/cjs/src/stores-v1-subscription-option.types.js +0 -20
  106. package/build/cjs/src/stores-v1-subscription-option.types.js.map +0 -1
  107. package/build/cjs/src/stores-v1-subscription-option.universal.d.ts +0 -646
  108. package/build/cjs/src/stores-v1-subscription-option.universal.js +0 -893
  109. package/build/cjs/src/stores-v1-subscription-option.universal.js.map +0 -1
  110. package/build/cjs/src/stores-v2-inventory.context.d.ts +0 -7
  111. package/build/cjs/src/stores-v2-inventory.context.js +0 -90
  112. package/build/cjs/src/stores-v2-inventory.context.js.map +0 -1
  113. package/build/cjs/src/stores-v2-inventory.http.d.ts +0 -31
  114. package/build/cjs/src/stores-v2-inventory.http.js +0 -289
  115. package/build/cjs/src/stores-v2-inventory.http.js.map +0 -1
  116. package/build/cjs/src/stores-v2-inventory.meta.d.ts +0 -21
  117. package/build/cjs/src/stores-v2-inventory.meta.js +0 -125
  118. package/build/cjs/src/stores-v2-inventory.meta.js.map +0 -1
  119. package/build/cjs/src/stores-v2-inventory.public.d.ts +0 -13
  120. package/build/cjs/src/stores-v2-inventory.public.js +0 -41
  121. package/build/cjs/src/stores-v2-inventory.public.js.map +0 -1
  122. package/build/cjs/src/stores-v2-inventory.types.d.ts +0 -283
  123. package/build/cjs/src/stores-v2-inventory.types.js +0 -11
  124. package/build/cjs/src/stores-v2-inventory.types.js.map +0 -1
  125. package/build/cjs/src/stores-v2-inventory.universal.d.ts +0 -425
  126. package/build/cjs/src/stores-v2-inventory.universal.js +0 -382
  127. package/build/cjs/src/stores-v2-inventory.universal.js.map +0 -1
  128. package/build/es/index.typings.d.ts +0 -6
  129. package/build/es/index.typings.js +0 -7
  130. package/build/es/index.typings.js.map +0 -1
  131. package/build/es/src/platform-v1-wishlist.context.d.ts +0 -3
  132. package/build/es/src/platform-v1-wishlist.context.js +0 -18
  133. package/build/es/src/platform-v1-wishlist.context.js.map +0 -1
  134. package/build/es/src/platform-v1-wishlist.http.d.ts +0 -3
  135. package/build/es/src/platform-v1-wishlist.http.js +0 -87
  136. package/build/es/src/platform-v1-wishlist.http.js.map +0 -1
  137. package/build/es/src/platform-v1-wishlist.meta.d.ts +0 -13
  138. package/build/es/src/platform-v1-wishlist.meta.js +0 -20
  139. package/build/es/src/platform-v1-wishlist.meta.js.map +0 -1
  140. package/build/es/src/platform-v1-wishlist.public.d.ts +0 -15
  141. package/build/es/src/platform-v1-wishlist.public.js +0 -8
  142. package/build/es/src/platform-v1-wishlist.public.js.map +0 -1
  143. package/build/es/src/platform-v1-wishlist.types.d.ts +0 -104
  144. package/build/es/src/platform-v1-wishlist.types.js +0 -2
  145. package/build/es/src/platform-v1-wishlist.types.js.map +0 -1
  146. package/build/es/src/platform-v1-wishlist.universal.d.ts +0 -121
  147. package/build/es/src/platform-v1-wishlist.universal.js +0 -79
  148. package/build/es/src/platform-v1-wishlist.universal.js.map +0 -1
  149. package/build/es/src/stores-catalog-v1-collection.context.d.ts +0 -5
  150. package/build/es/src/stores-catalog-v1-collection.context.js +0 -50
  151. package/build/es/src/stores-catalog-v1-collection.context.js.map +0 -1
  152. package/build/es/src/stores-catalog-v1-collection.http.d.ts +0 -10
  153. package/build/es/src/stores-catalog-v1-collection.http.js +0 -104
  154. package/build/es/src/stores-catalog-v1-collection.http.js.map +0 -1
  155. package/build/es/src/stores-catalog-v1-collection.meta.d.ts +0 -19
  156. package/build/es/src/stores-catalog-v1-collection.meta.js +0 -56
  157. package/build/es/src/stores-catalog-v1-collection.meta.js.map +0 -1
  158. package/build/es/src/stores-catalog-v1-collection.public.d.ts +0 -59
  159. package/build/es/src/stores-catalog-v1-collection.public.js +0 -19
  160. package/build/es/src/stores-catalog-v1-collection.public.js.map +0 -1
  161. package/build/es/src/stores-catalog-v1-collection.types.d.ts +0 -414
  162. package/build/es/src/stores-catalog-v1-collection.types.js +0 -15
  163. package/build/es/src/stores-catalog-v1-collection.types.js.map +0 -1
  164. package/build/es/src/stores-catalog-v1-collection.universal.d.ts +0 -452
  165. package/build/es/src/stores-catalog-v1-collection.universal.js +0 -196
  166. package/build/es/src/stores-catalog-v1-collection.universal.js.map +0 -1
  167. package/build/es/src/stores-catalog-v1-product.context.d.ts +0 -35
  168. package/build/es/src/stores-catalog-v1-product.context.js +0 -530
  169. package/build/es/src/stores-catalog-v1-product.context.js.map +0 -1
  170. package/build/es/src/stores-catalog-v1-product.http.d.ts +0 -89
  171. package/build/es/src/stores-catalog-v1-product.http.js +0 -1680
  172. package/build/es/src/stores-catalog-v1-product.http.js.map +0 -1
  173. package/build/es/src/stores-catalog-v1-product.meta.d.ts +0 -95
  174. package/build/es/src/stores-catalog-v1-product.meta.js +0 -596
  175. package/build/es/src/stores-catalog-v1-product.meta.js.map +0 -1
  176. package/build/es/src/stores-catalog-v1-product.public.d.ts +0 -1216
  177. package/build/es/src/stores-catalog-v1-product.public.js +0 -170
  178. package/build/es/src/stores-catalog-v1-product.public.js.map +0 -1
  179. package/build/es/src/stores-catalog-v1-product.types.d.ts +0 -4235
  180. package/build/es/src/stores-catalog-v1-product.types.js +0 -75
  181. package/build/es/src/stores-catalog-v1-product.types.js.map +0 -1
  182. package/build/es/src/stores-catalog-v1-product.universal.d.ts +0 -5074
  183. package/build/es/src/stores-catalog-v1-product.universal.js +0 -2161
  184. package/build/es/src/stores-catalog-v1-product.universal.js.map +0 -1
  185. package/build/es/src/stores-v1-abandoned-cart.http.d.ts +0 -6
  186. package/build/es/src/stores-v1-abandoned-cart.http.js +0 -98
  187. package/build/es/src/stores-v1-abandoned-cart.http.js.map +0 -1
  188. package/build/es/src/stores-v1-abandoned-cart.meta.d.ts +0 -16
  189. package/build/es/src/stores-v1-abandoned-cart.meta.js +0 -38
  190. package/build/es/src/stores-v1-abandoned-cart.meta.js.map +0 -1
  191. package/build/es/src/stores-v1-abandoned-cart.public.d.ts +0 -19
  192. package/build/es/src/stores-v1-abandoned-cart.public.js +0 -14
  193. package/build/es/src/stores-v1-abandoned-cart.public.js.map +0 -1
  194. package/build/es/src/stores-v1-abandoned-cart.types.d.ts +0 -216
  195. package/build/es/src/stores-v1-abandoned-cart.types.js +0 -27
  196. package/build/es/src/stores-v1-abandoned-cart.types.js.map +0 -1
  197. package/build/es/src/stores-v1-abandoned-cart.universal.d.ts +0 -246
  198. package/build/es/src/stores-v1-abandoned-cart.universal.js +0 -161
  199. package/build/es/src/stores-v1-abandoned-cart.universal.js.map +0 -1
  200. package/build/es/src/stores-v1-subscription-option.context.d.ts +0 -14
  201. package/build/es/src/stores-v1-subscription-option.context.js +0 -194
  202. package/build/es/src/stores-v1-subscription-option.context.js.map +0 -1
  203. package/build/es/src/stores-v1-subscription-option.http.d.ts +0 -128
  204. package/build/es/src/stores-v1-subscription-option.http.js +0 -451
  205. package/build/es/src/stores-v1-subscription-option.http.js.map +0 -1
  206. package/build/es/src/stores-v1-subscription-option.meta.d.ts +0 -40
  207. package/build/es/src/stores-v1-subscription-option.meta.js +0 -220
  208. package/build/es/src/stores-v1-subscription-option.meta.js.map +0 -1
  209. package/build/es/src/stores-v1-subscription-option.public.d.ts +0 -46
  210. package/build/es/src/stores-v1-subscription-option.public.js +0 -64
  211. package/build/es/src/stores-v1-subscription-option.public.js.map +0 -1
  212. package/build/es/src/stores-v1-subscription-option.types.d.ts +0 -351
  213. package/build/es/src/stores-v1-subscription-option.types.js +0 -17
  214. package/build/es/src/stores-v1-subscription-option.types.js.map +0 -1
  215. package/build/es/src/stores-v1-subscription-option.universal.d.ts +0 -646
  216. package/build/es/src/stores-v1-subscription-option.universal.js +0 -855
  217. package/build/es/src/stores-v1-subscription-option.universal.js.map +0 -1
  218. package/build/es/src/stores-v2-inventory.context.d.ts +0 -7
  219. package/build/es/src/stores-v2-inventory.context.js +0 -82
  220. package/build/es/src/stores-v2-inventory.context.js.map +0 -1
  221. package/build/es/src/stores-v2-inventory.http.d.ts +0 -31
  222. package/build/es/src/stores-v2-inventory.http.js +0 -281
  223. package/build/es/src/stores-v2-inventory.http.js.map +0 -1
  224. package/build/es/src/stores-v2-inventory.meta.d.ts +0 -21
  225. package/build/es/src/stores-v2-inventory.meta.js +0 -94
  226. package/build/es/src/stores-v2-inventory.meta.js.map +0 -1
  227. package/build/es/src/stores-v2-inventory.public.d.ts +0 -13
  228. package/build/es/src/stores-v2-inventory.public.js +0 -30
  229. package/build/es/src/stores-v2-inventory.public.js.map +0 -1
  230. package/build/es/src/stores-v2-inventory.types.d.ts +0 -283
  231. package/build/es/src/stores-v2-inventory.types.js +0 -8
  232. package/build/es/src/stores-v2-inventory.types.js.map +0 -1
  233. package/build/es/src/stores-v2-inventory.universal.d.ts +0 -425
  234. package/build/es/src/stores-v2-inventory.universal.js +0 -351
  235. package/build/es/src/stores-v2-inventory.universal.js.map +0 -1
@@ -1,4235 +0,0 @@
1
- export interface Product {
2
- /**
3
- * Product ID (generated automatically by the catalog).
4
- * @readonly
5
- */
6
- id?: string;
7
- /**
8
- * Product name.
9
- *
10
- * Min: 1 character
11
- * Max: 80 characters
12
- */
13
- name?: string | null;
14
- /** A friendly URL name (generated automatically by the catalog when a product is created), can be updated. */
15
- slug?: string;
16
- /** Whether the product is visible to site visitors. */
17
- visible?: boolean | null;
18
- /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
19
- productType?: ProductType;
20
- /** Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text). */
21
- description?: string | null;
22
- /** Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty. */
23
- sku?: string | null;
24
- /** Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty. */
25
- weight?: number | null;
26
- /**
27
- * Product weight range. The minimum and maximum weights of all the variants.
28
- * @readonly
29
- */
30
- weightRange?: NumericPropertyRange;
31
- /**
32
- * Product inventory status (in future this will be writable via Inventory API).
33
- * @readonly
34
- */
35
- stock?: Stock;
36
- /**
37
- * Deprecated (use `priceData` instead).
38
- * @readonly
39
- */
40
- price?: PriceData;
41
- /** Price data. */
42
- priceData?: PriceData;
43
- /**
44
- * Price data, converted to the currency specified in request header.
45
- * @readonly
46
- */
47
- convertedPriceData?: PriceData;
48
- /**
49
- * Product price range. The minimum and maximum prices of all the variants.
50
- * @readonly
51
- */
52
- priceRange?: NumericPropertyRange;
53
- /** Cost and profit data. */
54
- costAndProfitData?: CostAndProfitData;
55
- /**
56
- * Product cost range. The minimum and maximum costs of all the variants.
57
- * @readonly
58
- */
59
- costRange?: NumericPropertyRange;
60
- /** Price per unit data. */
61
- pricePerUnitData?: PricePerUnitData;
62
- /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
63
- additionalInfoSections?: AdditionalInfoSection[];
64
- /**
65
- * Deprecated (use `ribbon` instead).
66
- * @readonly
67
- */
68
- ribbons?: Ribbon[];
69
- /**
70
- * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
71
- * @readonly
72
- */
73
- media?: Media;
74
- /**
75
- * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
76
- * @readonly
77
- */
78
- customTextFields?: CustomTextField[];
79
- /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
80
- manageVariants?: boolean | null;
81
- /** Options for this product. */
82
- productOptions?: ProductOption[];
83
- /**
84
- * Product page URL for this product (generated automatically by the server).
85
- * @readonly
86
- */
87
- productPageUrl?: PageUrl;
88
- /**
89
- * Product’s unique numeric ID (assigned in ascending order).
90
- * Primarily used for sorting and filtering when crawling all products.
91
- * @readonly
92
- */
93
- numericId?: string;
94
- /**
95
- * Inventory item ID - ID referencing the inventory system.
96
- * @readonly
97
- */
98
- inventoryItemId?: string;
99
- /** Discount deducted from the product's original price. */
100
- discount?: Discount;
101
- /**
102
- * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
103
- * @readonly
104
- */
105
- collectionIds?: string[];
106
- /**
107
- * Product variants, will be provided if the the request was sent with the includeVariants flag.
108
- * @readonly
109
- */
110
- variants?: Variant[];
111
- /**
112
- * Date and time the product was last updated.
113
- * @readonly
114
- */
115
- lastUpdated?: Date;
116
- /**
117
- * Date and time the product was created.
118
- * @readonly
119
- */
120
- createdDate?: Date;
121
- /** Custom SEO data for the product. */
122
- seoData?: SeoSchema;
123
- /** Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out". */
124
- ribbon?: string | null;
125
- /** Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores). */
126
- brand?: string | null;
127
- }
128
- export declare enum ProductType {
129
- unspecified_product_type = "unspecified_product_type",
130
- physical = "physical",
131
- digital = "digital"
132
- }
133
- export interface NumericPropertyRange {
134
- /** Minimum value. */
135
- minValue?: number;
136
- /** Maximum value. */
137
- maxValue?: number;
138
- }
139
- export interface Stock {
140
- /** Whether inventory is being tracked */
141
- trackInventory?: boolean;
142
- /** Quantity currently left in inventory */
143
- quantity?: number | null;
144
- /**
145
- * Whether the product is currently in stock (relevant only when tracking manually)
146
- * Deprecated (use `inventoryStatus` instead)
147
- */
148
- inStock?: boolean;
149
- /**
150
- * The current status of the inventory
151
- * + `IN_STOCK` - In stock
152
- * + `OUT_OF_STOCK` - Not in stock
153
- * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
154
- */
155
- inventoryStatus?: InventoryStatus;
156
- }
157
- export declare enum InventoryStatus {
158
- IN_STOCK = "IN_STOCK",
159
- OUT_OF_STOCK = "OUT_OF_STOCK",
160
- PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
161
- }
162
- export interface PriceData {
163
- /**
164
- * Product price currency
165
- * @readonly
166
- */
167
- currency?: string;
168
- /** Product price */
169
- price?: number | null;
170
- /**
171
- * Discounted product price (if no discounted price is set, the product price is returned)
172
- * @readonly
173
- */
174
- discountedPrice?: number;
175
- /**
176
- * The product price and discounted price, formatted with the currency
177
- * @readonly
178
- */
179
- formatted?: FormattedPrice;
180
- /**
181
- * Price per unit
182
- * @readonly
183
- */
184
- pricePerUnit?: number | null;
185
- }
186
- export interface FormattedPrice {
187
- /** Product price formatted with the currency */
188
- price?: string;
189
- /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
190
- discountedPrice?: string;
191
- /**
192
- * Price per unit
193
- * @readonly
194
- */
195
- pricePerUnit?: string | null;
196
- }
197
- export interface CostAndProfitData {
198
- /** Item cost. */
199
- itemCost?: number | null;
200
- /**
201
- * Item cost formatted with currency symbol.
202
- * @readonly
203
- */
204
- formattedItemCost?: string;
205
- /**
206
- * Profit. Calculated by reducing `cost` from `discounted_price`.
207
- * @readonly
208
- */
209
- profit?: number;
210
- /**
211
- * Profit formatted with currency symbol.
212
- * @readonly
213
- */
214
- formattedProfit?: string;
215
- /**
216
- * Profit Margin. Calculated by dividing `profit` by `discounted_price`.
217
- * The result is rounded to 4 decimal places.
218
- * @readonly
219
- */
220
- profitMargin?: number;
221
- }
222
- export interface PricePerUnitData {
223
- /** Total quantity */
224
- totalQuantity?: number;
225
- /** Total measurement unit */
226
- totalMeasurementUnit?: MeasurementUnit;
227
- /** Base quantity */
228
- baseQuantity?: number;
229
- /** Base measurement unit */
230
- baseMeasurementUnit?: MeasurementUnit;
231
- }
232
- export declare enum MeasurementUnit {
233
- UNSPECIFIED = "UNSPECIFIED",
234
- ML = "ML",
235
- CL = "CL",
236
- L = "L",
237
- CBM = "CBM",
238
- MG = "MG",
239
- G = "G",
240
- KG = "KG",
241
- MM = "MM",
242
- CM = "CM",
243
- M = "M",
244
- SQM = "SQM",
245
- OZ = "OZ",
246
- LB = "LB",
247
- FLOZ = "FLOZ",
248
- PT = "PT",
249
- QT = "QT",
250
- GAL = "GAL",
251
- IN = "IN",
252
- FT = "FT",
253
- YD = "YD",
254
- SQFT = "SQFT"
255
- }
256
- export interface AdditionalInfoSection {
257
- /** Product info section title */
258
- title?: string;
259
- /** Product info section description */
260
- description?: string;
261
- }
262
- export interface Ribbon {
263
- /** Ribbon text */
264
- text?: string;
265
- }
266
- export interface Media {
267
- /** Primary media (image, video etc) associated with this product. */
268
- mainMedia?: MediaItem;
269
- /** Media (images, videos etc) associated with this product. */
270
- items?: MediaItem[];
271
- }
272
- export interface MediaItem extends MediaItemItemOneOf {
273
- /** Image data (URL, size). */
274
- image?: MediaItemUrlAndSize;
275
- /** Video data (URL, size). */
276
- video?: MediaItemVideo;
277
- /** Media item thumbnail details. */
278
- thumbnail?: MediaItemUrlAndSize;
279
- /** Media item type (image, video, etc.). */
280
- mediaType?: MediaItemType;
281
- /** Media item title. */
282
- title?: string;
283
- /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
284
- id?: string;
285
- }
286
- /** @oneof */
287
- export interface MediaItemItemOneOf {
288
- /** Image data (URL, size). */
289
- image?: MediaItemUrlAndSize;
290
- /** Video data (URL, size). */
291
- video?: MediaItemVideo;
292
- }
293
- export interface MediaItemUrlAndSize {
294
- /** Media item URL. */
295
- url?: string;
296
- /** Media item width. */
297
- width?: number;
298
- /** Media item height. */
299
- height?: number;
300
- /** Media format (mp4, png, etc.). */
301
- format?: string | null;
302
- /** Alt text. This text will be shown in case the image is not available. */
303
- altText?: string | null;
304
- }
305
- export declare enum MediaItemType {
306
- unspecified_media_item_type = "unspecified_media_item_type",
307
- image = "image",
308
- video = "video",
309
- audio = "audio",
310
- document = "document",
311
- zip = "zip"
312
- }
313
- export interface MediaItemVideo {
314
- /** Data (URL, size) about each resolution for which this video is available. */
315
- files?: MediaItemUrlAndSize[];
316
- /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
317
- stillFrameMediaId?: string;
318
- }
319
- export interface CustomTextField {
320
- /** Text box title */
321
- title?: string;
322
- /** Text box input max length */
323
- maxLength?: number;
324
- /** Whether this text box is mandatory */
325
- mandatory?: boolean;
326
- }
327
- export interface ProductOption {
328
- /**
329
- * Option type - color or other(drop down)
330
- * @readonly
331
- */
332
- optionType?: OptionType;
333
- /** Option name. */
334
- name?: string;
335
- /** Choices available for this option. */
336
- choices?: Choice[];
337
- }
338
- export declare enum OptionType {
339
- unspecified_option_type = "unspecified_option_type",
340
- drop_down = "drop_down",
341
- color = "color"
342
- }
343
- export interface Choice {
344
- /** Choice value. */
345
- value?: string;
346
- /** Choice description. */
347
- description?: string;
348
- /**
349
- * Media items (images, videos) associated with this choice
350
- * @readonly
351
- */
352
- media?: Media;
353
- /**
354
- * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
355
- * @readonly
356
- */
357
- inStock?: boolean;
358
- /**
359
- * Based on the customer’s choices, which (if any) variants that include the selected choices are visible
360
- * @readonly
361
- */
362
- visible?: boolean;
363
- }
364
- export interface PageUrl {
365
- /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
366
- base?: string;
367
- /** Path to the product page - e.g /product-page/a-product. */
368
- path?: string;
369
- }
370
- export interface Discount {
371
- /**
372
- * Discount type:
373
- * + `"AMOUNT"`
374
- * + `"PERCENT"`
375
- */
376
- type?: DiscountType;
377
- /** Discount value */
378
- value?: number;
379
- }
380
- export declare enum DiscountType {
381
- UNDEFINED = "UNDEFINED",
382
- /** No discount */
383
- NONE = "NONE",
384
- AMOUNT = "AMOUNT",
385
- PERCENT = "PERCENT"
386
- }
387
- export interface Variant {
388
- /** Requested Variant ID */
389
- id?: string;
390
- /** Specific choices within a selection, as option-choice key-value pairs */
391
- choices?: Record<string, string>;
392
- variant?: VariantDataWithNoStock;
393
- /**
394
- * Variant inventory status.
395
- * @readonly
396
- */
397
- stock?: VariantStock;
398
- }
399
- export interface VariantDataWithNoStock {
400
- /** Variant price. */
401
- priceData?: PriceData;
402
- /**
403
- * Variant price data, converted to currency requested in header.
404
- * @readonly
405
- */
406
- convertedPriceData?: PriceData;
407
- /** Cost and profit data. */
408
- costAndProfitData?: CostAndProfitData;
409
- /** Variant weight. */
410
- weight?: number;
411
- /** Variant SKU (stock keeping unit). */
412
- sku?: string;
413
- /** Whether the variant is visible to customers. */
414
- visible?: boolean;
415
- }
416
- export interface VariantStock {
417
- /** Whether inventory is being tracked. */
418
- trackQuantity?: boolean;
419
- /** Quantity currently left in inventory. */
420
- quantity?: number | null;
421
- /** Whether the product is currently in stock (relevant only when tracking manually). */
422
- inStock?: boolean;
423
- }
424
- /**
425
- * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
426
- * The search engines use this information for ranking purposes, or to display snippets in the search results.
427
- * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
428
- */
429
- export interface SeoSchema {
430
- /** SEO tag information. */
431
- tags?: Tag[];
432
- /** SEO general settings. */
433
- settings?: Settings;
434
- }
435
- export interface Keyword {
436
- /** Keyword value. */
437
- term?: string;
438
- /** Whether the keyword is the main focus keyword. */
439
- isMain?: boolean;
440
- }
441
- export interface Tag {
442
- /**
443
- * SEO tag type.
444
- *
445
- *
446
- * Supported values: `title`, `meta`, `script`, `link`.
447
- */
448
- type?: string;
449
- /**
450
- * A `{'key':'value'}` pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
451
- * For example: `{'name': 'description', 'content': 'the description itself'}`.
452
- */
453
- props?: Record<string, any> | null;
454
- /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
455
- meta?: Record<string, any> | null;
456
- /** SEO tag inner content. For example, `<title> inner content </title>`. */
457
- children?: string;
458
- /** Whether the tag is a custom tag. */
459
- custom?: boolean;
460
- /** Whether the tag is disabled. */
461
- disabled?: boolean;
462
- }
463
- export interface Settings {
464
- /**
465
- * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
466
- *
467
- *
468
- * Default: `false` (Auto Redirect is enabled.)
469
- */
470
- preventAutoRedirect?: boolean;
471
- /** User-selected keyword terms for a specific page. */
472
- keywords?: Keyword[];
473
- }
474
- export interface SecuredMedia {
475
- /** Media ID in Wix Media Manager. */
476
- id?: string;
477
- /** Original filename. */
478
- fileName?: string;
479
- /** File type. */
480
- fileType?: FileType;
481
- }
482
- export declare enum FileType {
483
- UNSPECIFIED = "UNSPECIFIED",
484
- SECURE_PICTURE = "SECURE_PICTURE",
485
- SECURE_VIDEO = "SECURE_VIDEO",
486
- SECURE_DOCUMENT = "SECURE_DOCUMENT",
487
- SECURE_MUSIC = "SECURE_MUSIC",
488
- SECURE_ARCHIVE = "SECURE_ARCHIVE"
489
- }
490
- export interface CreateProductRequest {
491
- /** Product information. */
492
- product?: Product;
493
- }
494
- export interface CreateProductResponse {
495
- product?: Product;
496
- }
497
- export interface CreateProductPlatformizedRequest {
498
- /** Product information. */
499
- product?: Product;
500
- }
501
- export interface CreateProductPlatformizedResponse {
502
- product?: Product;
503
- }
504
- export interface CreateDigitalProductRequest {
505
- /** Product information. */
506
- product?: Product;
507
- }
508
- export interface CreateDigitalProductResponse {
509
- /** Created product. */
510
- product?: Product;
511
- }
512
- export interface UpdateProductRequest {
513
- product: Product;
514
- }
515
- export interface UpdateProductResponse {
516
- product?: Product;
517
- }
518
- export interface UpdateProductPlatformizedRequest {
519
- product: Product;
520
- }
521
- export interface UpdateProductPlatformizedResponse {
522
- product?: Product;
523
- }
524
- export interface DeleteProductRequest {
525
- /** ID of the product to delete. */
526
- id: string;
527
- }
528
- export interface DeleteProductResponse {
529
- }
530
- export interface DeleteProductPlatformizedRequest {
531
- /** ID of the product to delete. */
532
- id: string;
533
- }
534
- export interface DeleteProductPlatformizedResponse {
535
- }
536
- export interface BulkDeleteProductsRequest {
537
- /** IDs of the products to be deleted. */
538
- ids?: string[];
539
- }
540
- export interface BulkDeleteProductsResponse {
541
- }
542
- export interface UpdateVariantsRequest {
543
- /** ID of the product with managed variants. */
544
- id: string;
545
- /** Variant info to update. */
546
- variants?: VariantOverride[];
547
- }
548
- export interface VariantOverride {
549
- /** The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (Not relevant when passing variant IDs) */
550
- choices?: Record<string, string>;
551
- /**
552
- * List of variant IDs
553
- * (Not relevant when passing choices)
554
- */
555
- variantIds?: string[];
556
- /** Variant price */
557
- price?: number | null;
558
- /** Variant cost of goods */
559
- cost?: number | null;
560
- /** Variant weight */
561
- weight?: number | null;
562
- /** Variant SKU (stock keeping unit) */
563
- sku?: string | null;
564
- /** Whether the variant is visible to customers */
565
- visible?: boolean | null;
566
- }
567
- export interface UpdateVariantsResponse {
568
- /** List of the product's variants. */
569
- variants?: Variant[];
570
- }
571
- export interface ResetAllVariantDataRequest {
572
- /** Product ID. */
573
- id: string;
574
- }
575
- export interface ResetAllVariantDataResponse {
576
- }
577
- export interface AddProductsToCollectionRequest {
578
- /** Collection ID. */
579
- id: string;
580
- /** IDs of the products to add to the collection, separated by commas. */
581
- productIds?: string[];
582
- }
583
- export interface AddProductsToCollectionResponse {
584
- }
585
- export interface RemoveProductsFromCollectionRequest {
586
- /** Collection ID. */
587
- id: string;
588
- /** IDs of the products to remove from the collection. */
589
- productIds: string[];
590
- }
591
- export interface RemoveProductsFromCollectionResponse {
592
- }
593
- export interface AddProductMediaRequest {
594
- /** Product ID. */
595
- id: string;
596
- /** Sources of media items already uploaded to the Wix site. */
597
- media?: MediaDataForWrite[];
598
- }
599
- export interface MediaDataForWrite extends MediaDataForWriteMediaSourceOneOf {
600
- /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
601
- mediaId?: string;
602
- /** Media external URL (for new media items). */
603
- url?: string;
604
- /**
605
- * Assign this media item to a specific product choice.
606
- * Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them).
607
- * You may clear existing media from choices with the [Remove Product Media From Choices](/catalog/products/remove-product-media-from-choices).
608
- */
609
- choice?: OptionAndChoice;
610
- }
611
- /** @oneof */
612
- export interface MediaDataForWriteMediaSourceOneOf {
613
- /** Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response. */
614
- mediaId?: string;
615
- /** Media external URL (for new media items). */
616
- url?: string;
617
- }
618
- export interface OptionAndChoice {
619
- /** Option to add the media to. */
620
- option?: string;
621
- /** Choice to add the media to. */
622
- choice?: string;
623
- }
624
- export interface AddProductMediaResponse {
625
- }
626
- export interface RemoveProductMediaRequest {
627
- /** Product ID. */
628
- id: string;
629
- /** List of media IDs to remove. Pass an empty array to delete all media items for the product. */
630
- mediaIds?: string[];
631
- }
632
- export interface RemoveProductMediaResponse {
633
- }
634
- export interface AddProductMediaToChoicesRequest {
635
- /** Product ID. */
636
- id: string;
637
- /** Product media items and the choices to add the media to. */
638
- media?: MediaAssignmentToChoice[];
639
- }
640
- export interface MediaAssignmentToChoice {
641
- /** Option name. */
642
- option?: string;
643
- /** Choice name. */
644
- choice?: string;
645
- /** Media IDs (available via the Query Product endpoint). */
646
- mediaIds?: string[];
647
- }
648
- export interface AddProductMediaToChoicesResponse {
649
- }
650
- export interface RemoveProductMediaFromChoicesRequest {
651
- /** Product ID from whose choices to remove media items. */
652
- id: string;
653
- /** Media to remove from choices. If an empty array is passed, all media will be removed from all choices for the given product. */
654
- media?: MediaAssignmentToChoice[];
655
- }
656
- export interface RemoveProductMediaFromChoicesResponse {
657
- }
658
- export interface DeleteProductOptionsRequest {
659
- /** ID of the product with options to delete. */
660
- id: string;
661
- }
662
- export interface DeleteProductOptionsResponse {
663
- }
664
- export interface SetCustomFieldsRequest {
665
- /** Product ID. */
666
- id?: string;
667
- /** Custom field that will be added, if a custom field with the same name already exists, the value of the custom field will be overridden. */
668
- customFields?: Record<string, any>;
669
- }
670
- export interface SetCustomFieldsResponse {
671
- }
672
- export interface RemoveCustomFieldsRequest {
673
- /** Product ID. */
674
- id?: string;
675
- /** Custom fields to be removed (by name). */
676
- names?: string[];
677
- }
678
- export interface RemoveCustomFieldsResponse {
679
- }
680
- export interface RemoveProductBrandRequest {
681
- /** Product ID. */
682
- id: string;
683
- }
684
- export interface RemoveProductBrandResponse {
685
- }
686
- export interface BulkSetCustomFieldsRequest {
687
- /** Filter string. */
688
- filter?: string | null;
689
- /** Custom field that will be added, if a custom field with same name already exists, the value of the custom field will be overridden. */
690
- customFields?: Record<string, any>;
691
- }
692
- export interface BulkSetCustomFieldsResponse {
693
- }
694
- export interface BulkRemoveCustomFieldsRequest {
695
- /** Filter string. */
696
- filter?: string | null;
697
- /** Custom fields names. */
698
- names?: string[];
699
- }
700
- export interface BulkRemoveCustomFieldsResponse {
701
- }
702
- export interface CreateCollectionRequest {
703
- /** Collection info. */
704
- collection: Collection;
705
- }
706
- export interface Collection {
707
- /**
708
- * Collection ID (generated automatically by the catalog).
709
- * @readonly
710
- */
711
- id?: string | null;
712
- /** Collection name. */
713
- name?: string | null;
714
- /**
715
- * Media items (images, videos etc) associated with this collection. Read only.
716
- * @readonly
717
- */
718
- media?: Media;
719
- /**
720
- * Number of products in the collection. Read only.
721
- * @readonly
722
- */
723
- numberOfProducts?: number;
724
- /** Collection description. */
725
- description?: string | null;
726
- /** Collection slug. */
727
- slug?: string | null;
728
- /** Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`. */
729
- visible?: boolean | null;
730
- }
731
- export interface CreateCollectionResponse {
732
- /** Collection. */
733
- collection?: Collection;
734
- }
735
- export interface UpdateCollectionRequest {
736
- /** Collection info. */
737
- collection: Collection;
738
- }
739
- export interface UpdateCollectionResponse {
740
- /** Updated collection. */
741
- collection?: Collection;
742
- }
743
- export interface DeleteCollectionRequest {
744
- /** ID of the collection to delete. */
745
- id: string;
746
- }
747
- export interface DeleteCollectionResponse {
748
- }
749
- export interface RemoveProductRibbonRequest {
750
- /** Product ID. */
751
- id: string;
752
- }
753
- export interface RemoveProductRibbonResponse {
754
- }
755
- export interface BulkUpdateProductsRequest {
756
- /** Product IDs. */
757
- ids: string[];
758
- /** Field to update. */
759
- set?: SetValue;
760
- }
761
- export interface SetValue extends SetValueValueOneOf {
762
- /**
763
- * Set product price.
764
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
765
- * variant prices will be calculated according to the set product price.
766
- * If variant price is negative after setting new price, the update will fail.
767
- */
768
- price?: number;
769
- /**
770
- * Set product cost of goods.
771
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
772
- * cost of goods will be set per variant.
773
- */
774
- cost?: number;
775
- /**
776
- * Set product weight.
777
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
778
- * weight will be set per variant.
779
- */
780
- weight?: number;
781
- /** Set product ribbon. Pass empty string to remove existing ribbon. */
782
- ribbon?: string;
783
- /** Set product brand. Pass empty string to remove existing brand. */
784
- brand?: string;
785
- }
786
- /** @oneof */
787
- export interface SetValueValueOneOf {
788
- /**
789
- * Set product price.
790
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
791
- * variant prices will be calculated according to the set product price.
792
- * If variant price is negative after setting new price, the update will fail.
793
- */
794
- price?: number;
795
- /**
796
- * Set product cost of goods.
797
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
798
- * cost of goods will be set per variant.
799
- */
800
- cost?: number;
801
- /**
802
- * Set product weight.
803
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
804
- * weight will be set per variant.
805
- */
806
- weight?: number;
807
- /** Set product ribbon. Pass empty string to remove existing ribbon. */
808
- ribbon?: string;
809
- /** Set product brand. Pass empty string to remove existing brand. */
810
- brand?: string;
811
- }
812
- export interface BulkUpdateProductsResponse {
813
- /** Bulk action results. */
814
- results?: BulkProductResult[];
815
- /** Bulk action metadata. */
816
- bulkActionMetadata?: BulkActionMetadata;
817
- }
818
- export interface BulkProductResult {
819
- /** Item metadata. */
820
- itemMetadata?: ItemMetadata;
821
- }
822
- export interface ItemMetadata {
823
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
824
- id?: string | null;
825
- /** Index of the item within the request array. Allows for correlation between request and response items. */
826
- originalIndex?: number;
827
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
828
- success?: boolean;
829
- /** Details about the error in case of failure. */
830
- error?: ApplicationError;
831
- }
832
- export interface ApplicationError {
833
- /** Error code. */
834
- code?: string;
835
- /** Description of the error. */
836
- description?: string;
837
- /** Data related to the error. */
838
- data?: Record<string, any> | null;
839
- }
840
- export interface BulkActionMetadata {
841
- /** Number of items that were successfully processed. */
842
- totalSuccesses?: number;
843
- /** Number of items that couldn't be processed. */
844
- totalFailures?: number;
845
- /** Number of failures without details because detailed failure threshold was exceeded. */
846
- undetailedFailures?: number;
847
- }
848
- export interface BulkUpdateProductsByFilterSyncRequest {
849
- /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */
850
- filter?: Record<string, any> | null;
851
- /** The field to update. */
852
- set?: SetValue;
853
- }
854
- export interface BulkUpdateProductsByFilterSyncResponse {
855
- /** Items updated by bulk action. */
856
- results?: BulkProductResult[];
857
- /** Bulk action metadata. */
858
- bulkActionMetadata?: BulkActionMetadata;
859
- }
860
- export interface AllowedProductsCountLimitExceededErrorData {
861
- /** Total number of products */
862
- totalCount?: number;
863
- }
864
- export interface BulkAdjustProductPropertiesRequest {
865
- /** Product IDs. */
866
- ids: string[];
867
- /** Numerical property to adjust. */
868
- adjust?: AdjustValue;
869
- }
870
- export interface AdjustValue extends AdjustValueValueOneOf {
871
- /**
872
- * Adjust product price.
873
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
874
- * variants prices will be calculated according to the adjusted price.
875
- * If variant price is negative after the adjustment, the update will fail.
876
- */
877
- price?: PropertyAdjustmentData;
878
- /**
879
- * Adjust product cost of goods.
880
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
881
- * cost of goods will be adjusted per variant.
882
- */
883
- cost?: PropertyAdjustmentData;
884
- /**
885
- * Adjust product weight.
886
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
887
- * weight will be adjusted per variant.
888
- */
889
- weight?: PropertyAdjustmentData;
890
- }
891
- /** @oneof */
892
- export interface AdjustValueValueOneOf {
893
- /**
894
- * Adjust product price.
895
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
896
- * variants prices will be calculated according to the adjusted price.
897
- * If variant price is negative after the adjustment, the update will fail.
898
- */
899
- price?: PropertyAdjustmentData;
900
- /**
901
- * Adjust product cost of goods.
902
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
903
- * cost of goods will be adjusted per variant.
904
- */
905
- cost?: PropertyAdjustmentData;
906
- /**
907
- * Adjust product weight.
908
- * If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled,
909
- * weight will be adjusted per variant.
910
- */
911
- weight?: PropertyAdjustmentData;
912
- }
913
- export interface PropertyAdjustmentData extends PropertyAdjustmentDataByOneOf {
914
- /** Adjust by percentage. */
915
- percentage?: PercentageData;
916
- /** Adjust by amount. */
917
- amount?: number;
918
- }
919
- /** @oneof */
920
- export interface PropertyAdjustmentDataByOneOf {
921
- /** Adjust by percentage. */
922
- percentage?: PercentageData;
923
- /** Adjust by amount. */
924
- amount?: number;
925
- }
926
- export interface PercentageData {
927
- /**
928
- * If `true`, result will be rounded to the nearest whole number.
929
- * If `false`, result will be rounded to 2 places after the decimal point.
930
- */
931
- roundToInt?: boolean;
932
- /**
933
- * Percentage value, as a whole number (integer) between `-100` and `1000`.
934
- *
935
- * For example:
936
- * + Pass `100` to increase value by 100% (multiply original value by 2).
937
- * + Pass `1000` to increase value by 1000% (multiply original value by 10).
938
- * + Pass `-50` to decrease value by 50% (original value is halved).
939
- */
940
- rate?: number;
941
- }
942
- export interface BulkAdjustProductPropertiesResponse {
943
- /** Bulk action results. */
944
- results?: BulkProductResult[];
945
- /** Bulk action metadata. */
946
- bulkActionMetadata?: BulkActionMetadata;
947
- }
948
- export interface BulkAdjustProductPropertiesByFilterSyncRequest {
949
- /** Filter object. Learn more about supported filters [here](https://bo.wix.com/wix-docs/rest/stores/stores-catalog/filter-and-sort). */
950
- filter?: Record<string, any> | null;
951
- /** Numerical property to adjust. */
952
- adjust?: AdjustValue;
953
- }
954
- export interface BulkAdjustProductPropertiesByFilterSyncResponse {
955
- /** Items updated by bulk action. */
956
- results?: BulkProductResult[];
957
- /** Bulk action metadata. */
958
- bulkActionMetadata?: BulkActionMetadata;
959
- }
960
- export interface ReCloneStoreRequest {
961
- /** Description of value */
962
- metasiteId?: string | null;
963
- originalMetasiteId?: string | null;
964
- }
965
- export interface ReCloneStoreResponse {
966
- }
967
- export interface V1CreateProductPlatformizedRequest {
968
- /** Product information. */
969
- product?: Product;
970
- }
971
- export interface V1CreateProductPlatformizedResponse {
972
- product?: Product;
973
- }
974
- export interface V1UpdateProductPlatformizedRequest {
975
- product: Product;
976
- }
977
- export interface V1UpdateProductPlatformizedResponse {
978
- product?: Product;
979
- }
980
- export interface V1DeleteProductPlatformizedRequest {
981
- /** ID of the product to delete. */
982
- id: string;
983
- }
984
- export interface V1DeleteProductPlatformizedResponse {
985
- }
986
- export interface ProductCreated {
987
- /** Product ID (generated automatically by the catalog). */
988
- productId?: string;
989
- /** Product name. */
990
- name?: string;
991
- /** Product price. */
992
- price?: PriceData;
993
- /** Whether the product is visible to customers. */
994
- visible?: boolean;
995
- /** Media items (images, videos, etc.) associated with this product. */
996
- media?: Media;
997
- /** Product stock keeping unit (SKU). If variants are being managed, this will be empty. */
998
- sku?: string;
999
- /** Product page URL for this product (generated automatically by the server). */
1000
- productPageUrl?: PageUrl;
1001
- /** Product brand. */
1002
- brand?: string | null;
1003
- /** Cost and profit data */
1004
- costAndProfitData?: CostAndProfitData;
1005
- }
1006
- export interface ProductChanged {
1007
- /** Product ID. */
1008
- productId?: string;
1009
- /** List of product fields that were changed. */
1010
- changedFields?: string[];
1011
- }
1012
- export interface ProductDeleted {
1013
- /** ID of the product that was deleted. */
1014
- productId?: string;
1015
- }
1016
- export interface CollectionCreated {
1017
- /** Collection ID (generated automatically by the catalog). */
1018
- collection_Id?: string;
1019
- /** Collection name. */
1020
- name?: string;
1021
- /** Media items (images, videos, etc.) associated with this collection. */
1022
- media?: Media;
1023
- /** Collection slug */
1024
- slug?: string;
1025
- /** Collection visible status */
1026
- visible?: boolean;
1027
- }
1028
- export interface CollectionChanged {
1029
- /** Collection ID (generated automatically by the catalog). */
1030
- collection_Id?: string;
1031
- /** List of collection fields that were changed. */
1032
- changedFields?: string[];
1033
- }
1034
- export interface CollectionDeleted {
1035
- /** ID of the collection that was deleted. */
1036
- collection_Id?: string;
1037
- }
1038
- export interface VariantsChanged {
1039
- /** Product ID. */
1040
- productId?: string;
1041
- /** List of variants that were changed. */
1042
- variants?: VariantChanged[];
1043
- }
1044
- export interface VariantChanged {
1045
- /** Variant ID. */
1046
- variantId?: string;
1047
- choices?: Record<string, string>;
1048
- /** List of variant fields that were changed. */
1049
- changedFields?: string[];
1050
- }
1051
- export interface QueryProductsRequest {
1052
- query?: Query;
1053
- /** Whether variants should be included in the response. */
1054
- includeVariants?: boolean;
1055
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
1056
- includeHiddenProducts?: boolean;
1057
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
1058
- includeMerchantSpecificData?: boolean;
1059
- }
1060
- export interface Query {
1061
- paging?: Paging;
1062
- /** Filter string */
1063
- filter?: string | null;
1064
- /** Sort string */
1065
- sort?: string | null;
1066
- }
1067
- export interface Paging {
1068
- /** Amount of items to load per page */
1069
- limit?: number | null;
1070
- /** Number of items to skip in the display (relevant for all pages after the first) */
1071
- offset?: number | null;
1072
- }
1073
- export interface QueryProductsResponse {
1074
- products?: Product[];
1075
- metadata?: PagingMetadata;
1076
- totalResults?: number;
1077
- }
1078
- export interface PagingMetadata {
1079
- /** Amount of items to load per page */
1080
- items?: number;
1081
- /** Number of items to skip in the display (relevant for all pages after the first) */
1082
- offset?: number;
1083
- }
1084
- export interface QueryProductsPlatformizedRequest {
1085
- query?: PlatformQuery;
1086
- }
1087
- export interface PlatformQuery extends PlatformQueryPagingMethodOneOf {
1088
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
1089
- paging?: PlatformPaging;
1090
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
1091
- cursorPaging?: CursorPaging;
1092
- /** Filter object. */
1093
- filter?: Record<string, any> | null;
1094
- /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
1095
- sort?: Sorting[];
1096
- }
1097
- /** @oneof */
1098
- export interface PlatformQueryPagingMethodOneOf {
1099
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
1100
- paging?: PlatformPaging;
1101
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
1102
- cursorPaging?: CursorPaging;
1103
- }
1104
- export interface Sorting {
1105
- /** Name of the field to sort by. */
1106
- fieldName?: string;
1107
- /** Sort order. */
1108
- order?: SortOrder;
1109
- }
1110
- export declare enum SortOrder {
1111
- ASC = "ASC",
1112
- DESC = "DESC"
1113
- }
1114
- export interface PlatformPaging {
1115
- /** Number of items to load. */
1116
- limit?: number | null;
1117
- /** Number of items to skip in the current sort order. */
1118
- offset?: number | null;
1119
- }
1120
- export interface CursorPaging {
1121
- /** Maximum number of items to return in the results. */
1122
- limit?: number | null;
1123
- /**
1124
- * Pointer to the next or previous page in the list of results.
1125
- *
1126
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
1127
- * Not relevant for the first request.
1128
- */
1129
- cursor?: string | null;
1130
- }
1131
- export interface QueryProductsPlatformizedResponse {
1132
- products?: Product[];
1133
- metadata?: PlatformPagingMetadata;
1134
- }
1135
- export interface PlatformPagingMetadata {
1136
- /** The number of items returned in this response. */
1137
- count?: number | null;
1138
- /** The offset which was requested. Returned if offset paging was used. */
1139
- offset?: number | null;
1140
- /** The total number of items that match the query. Returned if offset paging was used. */
1141
- total?: number | null;
1142
- /** Cursors to navigate through result pages. Returned if cursor paging was used. */
1143
- cursors?: Cursors;
1144
- }
1145
- export interface Cursors {
1146
- /** Cursor string pointing to the next page in the list of results. */
1147
- next?: string | null;
1148
- /** Cursor pointing to the previous page in the list of results. */
1149
- prev?: string | null;
1150
- }
1151
- export interface QueryProductsWithBigPageLimitRequest {
1152
- query?: QueryWithBigPageLimit;
1153
- /** Whether variants should be included in the response. */
1154
- includeVariants?: boolean;
1155
- /** Whether hidden products should be included in the response. Requires permissions to manage products. */
1156
- includeHiddenProducts?: boolean;
1157
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
1158
- includeMerchantSpecificData?: boolean;
1159
- }
1160
- export interface QueryWithBigPageLimit {
1161
- paging?: PagingWithBigLimit;
1162
- /** Filter string */
1163
- filter?: string | null;
1164
- /** Sort string */
1165
- sort?: string | null;
1166
- }
1167
- export interface PagingWithBigLimit {
1168
- /** Amount of items to load per page */
1169
- limit?: number | null;
1170
- /** Number of items to skip in the display (relevant for all pages after the first) */
1171
- offset?: number | null;
1172
- }
1173
- export interface GetProductsRequest {
1174
- /** Requested product IDs. */
1175
- ids?: string[];
1176
- }
1177
- export interface GetProductsResponse {
1178
- products?: Product[];
1179
- }
1180
- export interface GetProductRequest {
1181
- /** Requested product ID. */
1182
- id: string;
1183
- /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
1184
- includeMerchantSpecificData?: boolean;
1185
- }
1186
- export interface GetProductResponse {
1187
- /** Requested product data. */
1188
- product?: Product;
1189
- }
1190
- export interface GetProductPlatformizedRequest {
1191
- /** Requested product ID. */
1192
- id: string;
1193
- /** Whether merchant specific data, such as cost and profit data, should be included in the response. Requires permissions to manage products. */
1194
- includeMerchantSpecificData?: boolean;
1195
- }
1196
- export interface GetProductPlatformizedResponse {
1197
- /** Requested product data. */
1198
- product?: Product;
1199
- }
1200
- export interface QueryCollectionsRequest {
1201
- /** Query options. */
1202
- query?: Query;
1203
- /** Whether number of products should be included in the response. */
1204
- includeNumberOfProducts?: boolean;
1205
- /** Wether to include collection description in the response. When `false` is passed, `collection.description` will return null. */
1206
- includeDescription?: boolean;
1207
- }
1208
- export interface QueryCollectionsResponse {
1209
- /** List of collections. */
1210
- collections?: Collection[];
1211
- /** Details on the paged set of results returned. */
1212
- metadata?: PagingMetadata;
1213
- /** Total number of results returned. */
1214
- totalResults?: number;
1215
- }
1216
- export interface QueryCollectionsPlatformizedRequest {
1217
- query?: PlatformQuery;
1218
- }
1219
- export interface QueryCollectionsPlatformizedResponse {
1220
- collections?: Collection[];
1221
- metadata?: PlatformPagingMetadata;
1222
- }
1223
- export interface GetCollectionRequest {
1224
- /** Requested collection ID. */
1225
- id?: string;
1226
- /**
1227
- * Whether to return the `collection.numberOfProducts` field in the response.
1228
- * Defaults to `false`, in which case the value of `collection.numberOfProducts` will be `0`.
1229
- */
1230
- includeNumberOfProducts?: boolean;
1231
- }
1232
- export interface GetCollectionResponse {
1233
- /** The requested collection. */
1234
- collection?: Collection;
1235
- }
1236
- export interface GetCollectionBySlugRequest {
1237
- /** Slug of the collection to retrieve. */
1238
- slug: string;
1239
- }
1240
- export interface GetCollectionBySlugResponse {
1241
- /** The requested collection. */
1242
- collection?: Collection;
1243
- }
1244
- export interface ProductOptionsAvailabilityRequest {
1245
- /** Requested product ID. */
1246
- id: string;
1247
- /** Array containing the selected options. For example, `["color": "Blue", "size": "Large"]`. */
1248
- options?: Record<string, string>;
1249
- }
1250
- export interface ProductOptionsAvailabilityResponse {
1251
- /** Variant information, given that all the choices were provided. */
1252
- selectedVariant?: VariantData;
1253
- /** Information about media items (images, videos, etc.) associated with this choice. */
1254
- media?: Media;
1255
- /** Options information (color, size, etc.) for this product, with the inventory and visibility fields updated based on the provided choices. */
1256
- productOptions?: ProductOption[];
1257
- /** Whether all the selected choices result in a visible, in-stock variant. */
1258
- availableForPurchase?: boolean;
1259
- }
1260
- export interface VariantData {
1261
- /** Variant price. */
1262
- price?: PriceData;
1263
- /**
1264
- * Variant price data converted to currency provided in header.
1265
- * @readonly
1266
- */
1267
- convertedPriceData?: PriceData;
1268
- /** Variant weight. */
1269
- weight?: number | null;
1270
- /** Variant SKU (stock keeping unit). */
1271
- sku?: string;
1272
- /** Quantity currently in inventory (relevant only when tracking by inventory). */
1273
- quantity?: number | null;
1274
- /** Whether the product is currently in stock (relevant only when tracking manually). */
1275
- inStock?: boolean;
1276
- /** Whether the variant is visible to customers. */
1277
- visible?: boolean;
1278
- }
1279
- export interface QueryProductVariantsRequest {
1280
- /** Requested product ID. */
1281
- id: string;
1282
- /**
1283
- * The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice).
1284
- * You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (not relevant when passing variant IDs).
1285
- */
1286
- choices?: Record<string, string>;
1287
- /** List of variant IDs (not relevant when passing choices). */
1288
- variantIds?: string[];
1289
- paging?: Paging;
1290
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
1291
- includeMerchantSpecificData?: boolean;
1292
- }
1293
- export interface QueryProductVariantsResponse {
1294
- /** List of variants based on the specified filters and sorting. */
1295
- variants?: Variant[];
1296
- metadata?: PagingMetadata;
1297
- totalResults?: number;
1298
- }
1299
- export interface QueryStoreVariantsRequest {
1300
- /** Query options. */
1301
- query?: PlatformQuery;
1302
- }
1303
- export interface QueryStoreVariantsResponse {
1304
- /** List of variants based on the specified filters and sorting. */
1305
- variants?: StoreVariant[];
1306
- /** Details on the paged set of results returned. */
1307
- metadata?: PlatformPagingMetadata;
1308
- }
1309
- export interface StoreVariant {
1310
- /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */
1311
- id?: string;
1312
- /** Variant ID. */
1313
- variantId?: string;
1314
- /** Product ID. */
1315
- productId?: string;
1316
- /** Variant name. */
1317
- variantName?: string;
1318
- /** Product name. */
1319
- productName?: string;
1320
- /** Whether the variant is managed or represents a product. */
1321
- managedVariant?: boolean;
1322
- /** Variant SKU (stock keeping unit). */
1323
- sku?: string;
1324
- /** Variant inventory status. */
1325
- stock?: VariantStock;
1326
- /** The selected options of this variant. For example, `{"Color": "Blue", "Size": "Large"}`. */
1327
- choices?: Record<string, string>;
1328
- /** Collections that include this variant. */
1329
- collectionIds?: string[];
1330
- /**
1331
- * Media items (images, videos) associated with this variant.
1332
- * @readonly
1333
- */
1334
- media?: PlatformMedia;
1335
- /** Preorder information. */
1336
- preorderInfo?: PreorderInfo;
1337
- }
1338
- export interface PlatformMedia extends PlatformMediaMediaOneOf {
1339
- image?: Image;
1340
- video?: VideoV2;
1341
- }
1342
- /** @oneof */
1343
- export interface PlatformMediaMediaOneOf {
1344
- image?: Image;
1345
- video?: VideoV2;
1346
- }
1347
- export interface Image {
1348
- /** WixMedia image ID. */
1349
- id?: string;
1350
- /** Image URL. */
1351
- url?: string;
1352
- /**
1353
- * Original image height.
1354
- * @readonly
1355
- */
1356
- height?: number;
1357
- /**
1358
- * Original image width.
1359
- * @readonly
1360
- */
1361
- width?: number;
1362
- /** Image alt text. */
1363
- altText?: string | null;
1364
- /**
1365
- * Image filename.
1366
- * @readonly
1367
- */
1368
- filename?: string | null;
1369
- }
1370
- export interface VideoV2 {
1371
- /** WixMedia ID. */
1372
- id?: string;
1373
- /**
1374
- * Available resolutions for the video, starting with the optimal resolution.
1375
- * @readonly
1376
- */
1377
- resolutions?: VideoResolution[];
1378
- /**
1379
- * Video filename.
1380
- * @readonly
1381
- */
1382
- filename?: string | null;
1383
- }
1384
- export interface VideoResolution {
1385
- /** Video URL. */
1386
- url?: string;
1387
- /** Video height. */
1388
- height?: number;
1389
- /** Video width. */
1390
- width?: number;
1391
- /** Video format for example, mp4, hls. */
1392
- format?: string;
1393
- }
1394
- export interface PreorderInfo {
1395
- /** Whether the item is available for preorder. */
1396
- enabled?: boolean;
1397
- /** A message the buyer will see when the item is out of stock and preorder is enabled. */
1398
- message?: string | null;
1399
- /** Number of products that can be preordered after stock reaches zero. */
1400
- limit?: number | null;
1401
- }
1402
- export interface QueryStoreVariantsWithBigLimitRequest {
1403
- /** Query options. */
1404
- query?: UnlimitedPlatformQuery;
1405
- }
1406
- /**
1407
- * Don't use it unless you have to and know what you do. Prefer PlatformQuery other than this.
1408
- * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
1409
- */
1410
- export interface UnlimitedPlatformQuery extends UnlimitedPlatformQueryPagingMethodOneOf {
1411
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
1412
- paging?: UnlimitedPlatformPaging;
1413
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
1414
- cursorPaging?: UnlimitedPlatformCursorPaging;
1415
- /** Filter object. */
1416
- filter?: Record<string, any> | null;
1417
- /** Sorting options. For example, `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]`. */
1418
- sort?: Sorting[];
1419
- }
1420
- /** @oneof */
1421
- export interface UnlimitedPlatformQueryPagingMethodOneOf {
1422
- /** Pointer to page of results using offset. Cannot be used together with `cursorPaging`. */
1423
- paging?: UnlimitedPlatformPaging;
1424
- /** Cursor pointing to page of results. Cannot be used together with `paging`. `cursorPaging.cursor` can not be used together with `filter` or `sort`. */
1425
- cursorPaging?: UnlimitedPlatformCursorPaging;
1426
- }
1427
- /**
1428
- * Don't use it unless you have to and know what you do. Prefer PlatformPaging or wix.common.Paging other than this.
1429
- * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
1430
- */
1431
- export interface UnlimitedPlatformPaging {
1432
- /** Number of items to load. */
1433
- limit?: number | null;
1434
- /** Number of items to skip in the current sort order. */
1435
- offset?: number | null;
1436
- }
1437
- /**
1438
- * Don't use it unless you have to and know what you do. Prefer PlatformCursorPaging or wix.common.CursorPaging other than this.
1439
- * It doesn't have max validation for limit but we still MUST have it so implement required validation in your code.
1440
- */
1441
- export interface UnlimitedPlatformCursorPaging {
1442
- /**
1443
- * The number of items to load.
1444
- * Cursor token returned in the query response. To be used on the next query request, but not the first query request.
1445
- */
1446
- limit?: number | null;
1447
- /** Cursor returned in last query response. Should not be provided on first page request */
1448
- cursor?: string | null;
1449
- }
1450
- export interface GetStoreVariantRequest {
1451
- /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen. For example, `{productId}-{variantId}`. */
1452
- id: string;
1453
- }
1454
- export interface GetStoreVariantResponse {
1455
- /** The requested store variant. */
1456
- variant?: StoreVariant;
1457
- }
1458
- export interface QueryCustomFieldsRequest {
1459
- /** Requested product ID. */
1460
- id?: string;
1461
- /** Requested field names. */
1462
- names?: string[];
1463
- }
1464
- export interface QueryCustomFieldsResponse {
1465
- customFields?: Record<string, any>;
1466
- }
1467
- export interface BulkQueryCustomFieldsRequest {
1468
- /** Filter string. */
1469
- query?: Query;
1470
- /** Requested field names. */
1471
- names?: string[];
1472
- }
1473
- export interface BulkQueryCustomFieldsResponse {
1474
- /** ProductId to Custom Fields Map packed in container. */
1475
- productIdToCustomFields?: Record<string, CustomFieldsContainer>;
1476
- metadata?: PagingMetadata;
1477
- totalResults?: number;
1478
- }
1479
- export interface CustomFieldsContainer {
1480
- customFields?: Record<string, any>;
1481
- }
1482
- export interface AggregateProductsRequest {
1483
- /** Filter applied to original data */
1484
- filter?: Record<string, any> | null;
1485
- /** This is an object defining aggregation itself */
1486
- aggregation?: Record<string, any> | null;
1487
- /** Whether hidden products should be considered. Requires permissions to manage products. */
1488
- includeHiddenProducts?: boolean;
1489
- /** Whether merchant specific data should be included in the response. Requires permissions to manage products. */
1490
- includeMerchantSpecificData?: boolean;
1491
- }
1492
- export interface AggregateProductsResponse {
1493
- aggregates?: Record<string, any> | null;
1494
- }
1495
- export interface CreateProductResponseNonNullableFields {
1496
- product?: {
1497
- id: string;
1498
- slug: string;
1499
- productType: ProductType;
1500
- weightRange?: {
1501
- minValue: number;
1502
- maxValue: number;
1503
- };
1504
- stock?: {
1505
- trackInventory: boolean;
1506
- inStock: boolean;
1507
- inventoryStatus: InventoryStatus;
1508
- };
1509
- price?: {
1510
- currency: string;
1511
- discountedPrice: number;
1512
- formatted?: {
1513
- price: string;
1514
- discountedPrice: string;
1515
- };
1516
- };
1517
- priceData?: {
1518
- currency: string;
1519
- discountedPrice: number;
1520
- formatted?: {
1521
- price: string;
1522
- discountedPrice: string;
1523
- };
1524
- };
1525
- convertedPriceData?: {
1526
- currency: string;
1527
- discountedPrice: number;
1528
- formatted?: {
1529
- price: string;
1530
- discountedPrice: string;
1531
- };
1532
- };
1533
- priceRange?: {
1534
- minValue: number;
1535
- maxValue: number;
1536
- };
1537
- costAndProfitData?: {
1538
- formattedItemCost: string;
1539
- profit: number;
1540
- formattedProfit: string;
1541
- profitMargin: number;
1542
- };
1543
- costRange?: {
1544
- minValue: number;
1545
- maxValue: number;
1546
- };
1547
- pricePerUnitData?: {
1548
- totalQuantity: number;
1549
- totalMeasurementUnit: MeasurementUnit;
1550
- baseQuantity: number;
1551
- baseMeasurementUnit: MeasurementUnit;
1552
- };
1553
- additionalInfoSections: {
1554
- title: string;
1555
- description: string;
1556
- }[];
1557
- ribbons: {
1558
- text: string;
1559
- }[];
1560
- media?: {
1561
- mainMedia?: {
1562
- image?: {
1563
- url: string;
1564
- width: number;
1565
- height: number;
1566
- };
1567
- video?: {
1568
- files: {
1569
- url: string;
1570
- width: number;
1571
- height: number;
1572
- }[];
1573
- stillFrameMediaId: string;
1574
- };
1575
- thumbnail?: {
1576
- url: string;
1577
- width: number;
1578
- height: number;
1579
- };
1580
- mediaType: MediaItemType;
1581
- title: string;
1582
- id: string;
1583
- };
1584
- items: {
1585
- image?: {
1586
- url: string;
1587
- width: number;
1588
- height: number;
1589
- };
1590
- video?: {
1591
- files: {
1592
- url: string;
1593
- width: number;
1594
- height: number;
1595
- }[];
1596
- stillFrameMediaId: string;
1597
- };
1598
- thumbnail?: {
1599
- url: string;
1600
- width: number;
1601
- height: number;
1602
- };
1603
- mediaType: MediaItemType;
1604
- title: string;
1605
- id: string;
1606
- }[];
1607
- };
1608
- customTextFields: {
1609
- title: string;
1610
- maxLength: number;
1611
- mandatory: boolean;
1612
- }[];
1613
- productOptions: {
1614
- optionType: OptionType;
1615
- name: string;
1616
- choices: {
1617
- value: string;
1618
- description: string;
1619
- media?: {
1620
- mainMedia?: {
1621
- image?: {
1622
- url: string;
1623
- width: number;
1624
- height: number;
1625
- };
1626
- video?: {
1627
- files: {
1628
- url: string;
1629
- width: number;
1630
- height: number;
1631
- }[];
1632
- stillFrameMediaId: string;
1633
- };
1634
- thumbnail?: {
1635
- url: string;
1636
- width: number;
1637
- height: number;
1638
- };
1639
- mediaType: MediaItemType;
1640
- title: string;
1641
- id: string;
1642
- };
1643
- items: {
1644
- image?: {
1645
- url: string;
1646
- width: number;
1647
- height: number;
1648
- };
1649
- video?: {
1650
- files: {
1651
- url: string;
1652
- width: number;
1653
- height: number;
1654
- }[];
1655
- stillFrameMediaId: string;
1656
- };
1657
- thumbnail?: {
1658
- url: string;
1659
- width: number;
1660
- height: number;
1661
- };
1662
- mediaType: MediaItemType;
1663
- title: string;
1664
- id: string;
1665
- }[];
1666
- };
1667
- inStock: boolean;
1668
- visible: boolean;
1669
- }[];
1670
- }[];
1671
- productPageUrl?: {
1672
- base: string;
1673
- path: string;
1674
- };
1675
- numericId: string;
1676
- inventoryItemId: string;
1677
- discount?: {
1678
- type: DiscountType;
1679
- value: number;
1680
- };
1681
- collectionIds: string[];
1682
- variants: {
1683
- id: string;
1684
- variant?: {
1685
- priceData?: {
1686
- currency: string;
1687
- discountedPrice: number;
1688
- formatted?: {
1689
- price: string;
1690
- discountedPrice: string;
1691
- };
1692
- };
1693
- convertedPriceData?: {
1694
- currency: string;
1695
- discountedPrice: number;
1696
- formatted?: {
1697
- price: string;
1698
- discountedPrice: string;
1699
- };
1700
- };
1701
- costAndProfitData?: {
1702
- formattedItemCost: string;
1703
- profit: number;
1704
- formattedProfit: string;
1705
- profitMargin: number;
1706
- };
1707
- weight: number;
1708
- sku: string;
1709
- visible: boolean;
1710
- };
1711
- stock?: {
1712
- trackQuantity: boolean;
1713
- inStock: boolean;
1714
- };
1715
- }[];
1716
- seoData?: {
1717
- tags: {
1718
- type: string;
1719
- children: string;
1720
- custom: boolean;
1721
- disabled: boolean;
1722
- }[];
1723
- settings?: {
1724
- preventAutoRedirect: boolean;
1725
- keywords: {
1726
- term: string;
1727
- isMain: boolean;
1728
- }[];
1729
- };
1730
- };
1731
- exportProductId: string;
1732
- digitalFile?: {
1733
- id: string;
1734
- fileName: string;
1735
- fileType: FileType;
1736
- };
1737
- };
1738
- }
1739
- export interface CreateProductPlatformizedResponseNonNullableFields {
1740
- product?: {
1741
- id: string;
1742
- slug: string;
1743
- productType: ProductType;
1744
- weightRange?: {
1745
- minValue: number;
1746
- maxValue: number;
1747
- };
1748
- stock?: {
1749
- trackInventory: boolean;
1750
- inStock: boolean;
1751
- inventoryStatus: InventoryStatus;
1752
- };
1753
- price?: {
1754
- currency: string;
1755
- discountedPrice: number;
1756
- formatted?: {
1757
- price: string;
1758
- discountedPrice: string;
1759
- };
1760
- };
1761
- priceData?: {
1762
- currency: string;
1763
- discountedPrice: number;
1764
- formatted?: {
1765
- price: string;
1766
- discountedPrice: string;
1767
- };
1768
- };
1769
- convertedPriceData?: {
1770
- currency: string;
1771
- discountedPrice: number;
1772
- formatted?: {
1773
- price: string;
1774
- discountedPrice: string;
1775
- };
1776
- };
1777
- priceRange?: {
1778
- minValue: number;
1779
- maxValue: number;
1780
- };
1781
- costAndProfitData?: {
1782
- formattedItemCost: string;
1783
- profit: number;
1784
- formattedProfit: string;
1785
- profitMargin: number;
1786
- };
1787
- costRange?: {
1788
- minValue: number;
1789
- maxValue: number;
1790
- };
1791
- pricePerUnitData?: {
1792
- totalQuantity: number;
1793
- totalMeasurementUnit: MeasurementUnit;
1794
- baseQuantity: number;
1795
- baseMeasurementUnit: MeasurementUnit;
1796
- };
1797
- additionalInfoSections: {
1798
- title: string;
1799
- description: string;
1800
- }[];
1801
- ribbons: {
1802
- text: string;
1803
- }[];
1804
- media?: {
1805
- mainMedia?: {
1806
- image?: {
1807
- url: string;
1808
- width: number;
1809
- height: number;
1810
- };
1811
- video?: {
1812
- files: {
1813
- url: string;
1814
- width: number;
1815
- height: number;
1816
- }[];
1817
- stillFrameMediaId: string;
1818
- };
1819
- thumbnail?: {
1820
- url: string;
1821
- width: number;
1822
- height: number;
1823
- };
1824
- mediaType: MediaItemType;
1825
- title: string;
1826
- id: string;
1827
- };
1828
- items: {
1829
- image?: {
1830
- url: string;
1831
- width: number;
1832
- height: number;
1833
- };
1834
- video?: {
1835
- files: {
1836
- url: string;
1837
- width: number;
1838
- height: number;
1839
- }[];
1840
- stillFrameMediaId: string;
1841
- };
1842
- thumbnail?: {
1843
- url: string;
1844
- width: number;
1845
- height: number;
1846
- };
1847
- mediaType: MediaItemType;
1848
- title: string;
1849
- id: string;
1850
- }[];
1851
- };
1852
- customTextFields: {
1853
- title: string;
1854
- maxLength: number;
1855
- mandatory: boolean;
1856
- }[];
1857
- productOptions: {
1858
- optionType: OptionType;
1859
- name: string;
1860
- choices: {
1861
- value: string;
1862
- description: string;
1863
- media?: {
1864
- mainMedia?: {
1865
- image?: {
1866
- url: string;
1867
- width: number;
1868
- height: number;
1869
- };
1870
- video?: {
1871
- files: {
1872
- url: string;
1873
- width: number;
1874
- height: number;
1875
- }[];
1876
- stillFrameMediaId: string;
1877
- };
1878
- thumbnail?: {
1879
- url: string;
1880
- width: number;
1881
- height: number;
1882
- };
1883
- mediaType: MediaItemType;
1884
- title: string;
1885
- id: string;
1886
- };
1887
- items: {
1888
- image?: {
1889
- url: string;
1890
- width: number;
1891
- height: number;
1892
- };
1893
- video?: {
1894
- files: {
1895
- url: string;
1896
- width: number;
1897
- height: number;
1898
- }[];
1899
- stillFrameMediaId: string;
1900
- };
1901
- thumbnail?: {
1902
- url: string;
1903
- width: number;
1904
- height: number;
1905
- };
1906
- mediaType: MediaItemType;
1907
- title: string;
1908
- id: string;
1909
- }[];
1910
- };
1911
- inStock: boolean;
1912
- visible: boolean;
1913
- }[];
1914
- }[];
1915
- productPageUrl?: {
1916
- base: string;
1917
- path: string;
1918
- };
1919
- numericId: string;
1920
- inventoryItemId: string;
1921
- discount?: {
1922
- type: DiscountType;
1923
- value: number;
1924
- };
1925
- collectionIds: string[];
1926
- variants: {
1927
- id: string;
1928
- variant?: {
1929
- priceData?: {
1930
- currency: string;
1931
- discountedPrice: number;
1932
- formatted?: {
1933
- price: string;
1934
- discountedPrice: string;
1935
- };
1936
- };
1937
- convertedPriceData?: {
1938
- currency: string;
1939
- discountedPrice: number;
1940
- formatted?: {
1941
- price: string;
1942
- discountedPrice: string;
1943
- };
1944
- };
1945
- costAndProfitData?: {
1946
- formattedItemCost: string;
1947
- profit: number;
1948
- formattedProfit: string;
1949
- profitMargin: number;
1950
- };
1951
- weight: number;
1952
- sku: string;
1953
- visible: boolean;
1954
- };
1955
- stock?: {
1956
- trackQuantity: boolean;
1957
- inStock: boolean;
1958
- };
1959
- }[];
1960
- seoData?: {
1961
- tags: {
1962
- type: string;
1963
- children: string;
1964
- custom: boolean;
1965
- disabled: boolean;
1966
- }[];
1967
- settings?: {
1968
- preventAutoRedirect: boolean;
1969
- keywords: {
1970
- term: string;
1971
- isMain: boolean;
1972
- }[];
1973
- };
1974
- };
1975
- exportProductId: string;
1976
- digitalFile?: {
1977
- id: string;
1978
- fileName: string;
1979
- fileType: FileType;
1980
- };
1981
- };
1982
- }
1983
- export interface UpdateProductResponseNonNullableFields {
1984
- product?: {
1985
- id: string;
1986
- slug: string;
1987
- productType: ProductType;
1988
- weightRange?: {
1989
- minValue: number;
1990
- maxValue: number;
1991
- };
1992
- stock?: {
1993
- trackInventory: boolean;
1994
- inStock: boolean;
1995
- inventoryStatus: InventoryStatus;
1996
- };
1997
- price?: {
1998
- currency: string;
1999
- discountedPrice: number;
2000
- formatted?: {
2001
- price: string;
2002
- discountedPrice: string;
2003
- };
2004
- };
2005
- priceData?: {
2006
- currency: string;
2007
- discountedPrice: number;
2008
- formatted?: {
2009
- price: string;
2010
- discountedPrice: string;
2011
- };
2012
- };
2013
- convertedPriceData?: {
2014
- currency: string;
2015
- discountedPrice: number;
2016
- formatted?: {
2017
- price: string;
2018
- discountedPrice: string;
2019
- };
2020
- };
2021
- priceRange?: {
2022
- minValue: number;
2023
- maxValue: number;
2024
- };
2025
- costAndProfitData?: {
2026
- formattedItemCost: string;
2027
- profit: number;
2028
- formattedProfit: string;
2029
- profitMargin: number;
2030
- };
2031
- costRange?: {
2032
- minValue: number;
2033
- maxValue: number;
2034
- };
2035
- pricePerUnitData?: {
2036
- totalQuantity: number;
2037
- totalMeasurementUnit: MeasurementUnit;
2038
- baseQuantity: number;
2039
- baseMeasurementUnit: MeasurementUnit;
2040
- };
2041
- additionalInfoSections: {
2042
- title: string;
2043
- description: string;
2044
- }[];
2045
- ribbons: {
2046
- text: string;
2047
- }[];
2048
- media?: {
2049
- mainMedia?: {
2050
- image?: {
2051
- url: string;
2052
- width: number;
2053
- height: number;
2054
- };
2055
- video?: {
2056
- files: {
2057
- url: string;
2058
- width: number;
2059
- height: number;
2060
- }[];
2061
- stillFrameMediaId: string;
2062
- };
2063
- thumbnail?: {
2064
- url: string;
2065
- width: number;
2066
- height: number;
2067
- };
2068
- mediaType: MediaItemType;
2069
- title: string;
2070
- id: string;
2071
- };
2072
- items: {
2073
- image?: {
2074
- url: string;
2075
- width: number;
2076
- height: number;
2077
- };
2078
- video?: {
2079
- files: {
2080
- url: string;
2081
- width: number;
2082
- height: number;
2083
- }[];
2084
- stillFrameMediaId: string;
2085
- };
2086
- thumbnail?: {
2087
- url: string;
2088
- width: number;
2089
- height: number;
2090
- };
2091
- mediaType: MediaItemType;
2092
- title: string;
2093
- id: string;
2094
- }[];
2095
- };
2096
- customTextFields: {
2097
- title: string;
2098
- maxLength: number;
2099
- mandatory: boolean;
2100
- }[];
2101
- productOptions: {
2102
- optionType: OptionType;
2103
- name: string;
2104
- choices: {
2105
- value: string;
2106
- description: string;
2107
- media?: {
2108
- mainMedia?: {
2109
- image?: {
2110
- url: string;
2111
- width: number;
2112
- height: number;
2113
- };
2114
- video?: {
2115
- files: {
2116
- url: string;
2117
- width: number;
2118
- height: number;
2119
- }[];
2120
- stillFrameMediaId: string;
2121
- };
2122
- thumbnail?: {
2123
- url: string;
2124
- width: number;
2125
- height: number;
2126
- };
2127
- mediaType: MediaItemType;
2128
- title: string;
2129
- id: string;
2130
- };
2131
- items: {
2132
- image?: {
2133
- url: string;
2134
- width: number;
2135
- height: number;
2136
- };
2137
- video?: {
2138
- files: {
2139
- url: string;
2140
- width: number;
2141
- height: number;
2142
- }[];
2143
- stillFrameMediaId: string;
2144
- };
2145
- thumbnail?: {
2146
- url: string;
2147
- width: number;
2148
- height: number;
2149
- };
2150
- mediaType: MediaItemType;
2151
- title: string;
2152
- id: string;
2153
- }[];
2154
- };
2155
- inStock: boolean;
2156
- visible: boolean;
2157
- }[];
2158
- }[];
2159
- productPageUrl?: {
2160
- base: string;
2161
- path: string;
2162
- };
2163
- numericId: string;
2164
- inventoryItemId: string;
2165
- discount?: {
2166
- type: DiscountType;
2167
- value: number;
2168
- };
2169
- collectionIds: string[];
2170
- variants: {
2171
- id: string;
2172
- variant?: {
2173
- priceData?: {
2174
- currency: string;
2175
- discountedPrice: number;
2176
- formatted?: {
2177
- price: string;
2178
- discountedPrice: string;
2179
- };
2180
- };
2181
- convertedPriceData?: {
2182
- currency: string;
2183
- discountedPrice: number;
2184
- formatted?: {
2185
- price: string;
2186
- discountedPrice: string;
2187
- };
2188
- };
2189
- costAndProfitData?: {
2190
- formattedItemCost: string;
2191
- profit: number;
2192
- formattedProfit: string;
2193
- profitMargin: number;
2194
- };
2195
- weight: number;
2196
- sku: string;
2197
- visible: boolean;
2198
- };
2199
- stock?: {
2200
- trackQuantity: boolean;
2201
- inStock: boolean;
2202
- };
2203
- }[];
2204
- seoData?: {
2205
- tags: {
2206
- type: string;
2207
- children: string;
2208
- custom: boolean;
2209
- disabled: boolean;
2210
- }[];
2211
- settings?: {
2212
- preventAutoRedirect: boolean;
2213
- keywords: {
2214
- term: string;
2215
- isMain: boolean;
2216
- }[];
2217
- };
2218
- };
2219
- exportProductId: string;
2220
- digitalFile?: {
2221
- id: string;
2222
- fileName: string;
2223
- fileType: FileType;
2224
- };
2225
- };
2226
- }
2227
- export interface UpdateProductPlatformizedResponseNonNullableFields {
2228
- product?: {
2229
- id: string;
2230
- slug: string;
2231
- productType: ProductType;
2232
- weightRange?: {
2233
- minValue: number;
2234
- maxValue: number;
2235
- };
2236
- stock?: {
2237
- trackInventory: boolean;
2238
- inStock: boolean;
2239
- inventoryStatus: InventoryStatus;
2240
- };
2241
- price?: {
2242
- currency: string;
2243
- discountedPrice: number;
2244
- formatted?: {
2245
- price: string;
2246
- discountedPrice: string;
2247
- };
2248
- };
2249
- priceData?: {
2250
- currency: string;
2251
- discountedPrice: number;
2252
- formatted?: {
2253
- price: string;
2254
- discountedPrice: string;
2255
- };
2256
- };
2257
- convertedPriceData?: {
2258
- currency: string;
2259
- discountedPrice: number;
2260
- formatted?: {
2261
- price: string;
2262
- discountedPrice: string;
2263
- };
2264
- };
2265
- priceRange?: {
2266
- minValue: number;
2267
- maxValue: number;
2268
- };
2269
- costAndProfitData?: {
2270
- formattedItemCost: string;
2271
- profit: number;
2272
- formattedProfit: string;
2273
- profitMargin: number;
2274
- };
2275
- costRange?: {
2276
- minValue: number;
2277
- maxValue: number;
2278
- };
2279
- pricePerUnitData?: {
2280
- totalQuantity: number;
2281
- totalMeasurementUnit: MeasurementUnit;
2282
- baseQuantity: number;
2283
- baseMeasurementUnit: MeasurementUnit;
2284
- };
2285
- additionalInfoSections: {
2286
- title: string;
2287
- description: string;
2288
- }[];
2289
- ribbons: {
2290
- text: string;
2291
- }[];
2292
- media?: {
2293
- mainMedia?: {
2294
- image?: {
2295
- url: string;
2296
- width: number;
2297
- height: number;
2298
- };
2299
- video?: {
2300
- files: {
2301
- url: string;
2302
- width: number;
2303
- height: number;
2304
- }[];
2305
- stillFrameMediaId: string;
2306
- };
2307
- thumbnail?: {
2308
- url: string;
2309
- width: number;
2310
- height: number;
2311
- };
2312
- mediaType: MediaItemType;
2313
- title: string;
2314
- id: string;
2315
- };
2316
- items: {
2317
- image?: {
2318
- url: string;
2319
- width: number;
2320
- height: number;
2321
- };
2322
- video?: {
2323
- files: {
2324
- url: string;
2325
- width: number;
2326
- height: number;
2327
- }[];
2328
- stillFrameMediaId: string;
2329
- };
2330
- thumbnail?: {
2331
- url: string;
2332
- width: number;
2333
- height: number;
2334
- };
2335
- mediaType: MediaItemType;
2336
- title: string;
2337
- id: string;
2338
- }[];
2339
- };
2340
- customTextFields: {
2341
- title: string;
2342
- maxLength: number;
2343
- mandatory: boolean;
2344
- }[];
2345
- productOptions: {
2346
- optionType: OptionType;
2347
- name: string;
2348
- choices: {
2349
- value: string;
2350
- description: string;
2351
- media?: {
2352
- mainMedia?: {
2353
- image?: {
2354
- url: string;
2355
- width: number;
2356
- height: number;
2357
- };
2358
- video?: {
2359
- files: {
2360
- url: string;
2361
- width: number;
2362
- height: number;
2363
- }[];
2364
- stillFrameMediaId: string;
2365
- };
2366
- thumbnail?: {
2367
- url: string;
2368
- width: number;
2369
- height: number;
2370
- };
2371
- mediaType: MediaItemType;
2372
- title: string;
2373
- id: string;
2374
- };
2375
- items: {
2376
- image?: {
2377
- url: string;
2378
- width: number;
2379
- height: number;
2380
- };
2381
- video?: {
2382
- files: {
2383
- url: string;
2384
- width: number;
2385
- height: number;
2386
- }[];
2387
- stillFrameMediaId: string;
2388
- };
2389
- thumbnail?: {
2390
- url: string;
2391
- width: number;
2392
- height: number;
2393
- };
2394
- mediaType: MediaItemType;
2395
- title: string;
2396
- id: string;
2397
- }[];
2398
- };
2399
- inStock: boolean;
2400
- visible: boolean;
2401
- }[];
2402
- }[];
2403
- productPageUrl?: {
2404
- base: string;
2405
- path: string;
2406
- };
2407
- numericId: string;
2408
- inventoryItemId: string;
2409
- discount?: {
2410
- type: DiscountType;
2411
- value: number;
2412
- };
2413
- collectionIds: string[];
2414
- variants: {
2415
- id: string;
2416
- variant?: {
2417
- priceData?: {
2418
- currency: string;
2419
- discountedPrice: number;
2420
- formatted?: {
2421
- price: string;
2422
- discountedPrice: string;
2423
- };
2424
- };
2425
- convertedPriceData?: {
2426
- currency: string;
2427
- discountedPrice: number;
2428
- formatted?: {
2429
- price: string;
2430
- discountedPrice: string;
2431
- };
2432
- };
2433
- costAndProfitData?: {
2434
- formattedItemCost: string;
2435
- profit: number;
2436
- formattedProfit: string;
2437
- profitMargin: number;
2438
- };
2439
- weight: number;
2440
- sku: string;
2441
- visible: boolean;
2442
- };
2443
- stock?: {
2444
- trackQuantity: boolean;
2445
- inStock: boolean;
2446
- };
2447
- }[];
2448
- seoData?: {
2449
- tags: {
2450
- type: string;
2451
- children: string;
2452
- custom: boolean;
2453
- disabled: boolean;
2454
- }[];
2455
- settings?: {
2456
- preventAutoRedirect: boolean;
2457
- keywords: {
2458
- term: string;
2459
- isMain: boolean;
2460
- }[];
2461
- };
2462
- };
2463
- exportProductId: string;
2464
- digitalFile?: {
2465
- id: string;
2466
- fileName: string;
2467
- fileType: FileType;
2468
- };
2469
- };
2470
- }
2471
- export interface UpdateVariantsResponseNonNullableFields {
2472
- variants: {
2473
- id: string;
2474
- variant?: {
2475
- priceData?: {
2476
- currency: string;
2477
- discountedPrice: number;
2478
- formatted?: {
2479
- price: string;
2480
- discountedPrice: string;
2481
- };
2482
- };
2483
- convertedPriceData?: {
2484
- currency: string;
2485
- discountedPrice: number;
2486
- formatted?: {
2487
- price: string;
2488
- discountedPrice: string;
2489
- };
2490
- };
2491
- costAndProfitData?: {
2492
- formattedItemCost: string;
2493
- profit: number;
2494
- formattedProfit: string;
2495
- profitMargin: number;
2496
- };
2497
- weight: number;
2498
- sku: string;
2499
- visible: boolean;
2500
- };
2501
- stock?: {
2502
- trackQuantity: boolean;
2503
- inStock: boolean;
2504
- };
2505
- }[];
2506
- }
2507
- export interface CreateCollectionResponseNonNullableFields {
2508
- collection?: {
2509
- media?: {
2510
- mainMedia?: {
2511
- image?: {
2512
- url: string;
2513
- width: number;
2514
- height: number;
2515
- };
2516
- video?: {
2517
- files: {
2518
- url: string;
2519
- width: number;
2520
- height: number;
2521
- }[];
2522
- stillFrameMediaId: string;
2523
- };
2524
- thumbnail?: {
2525
- url: string;
2526
- width: number;
2527
- height: number;
2528
- };
2529
- mediaType: MediaItemType;
2530
- title: string;
2531
- id: string;
2532
- };
2533
- items: {
2534
- image?: {
2535
- url: string;
2536
- width: number;
2537
- height: number;
2538
- };
2539
- video?: {
2540
- files: {
2541
- url: string;
2542
- width: number;
2543
- height: number;
2544
- }[];
2545
- stillFrameMediaId: string;
2546
- };
2547
- thumbnail?: {
2548
- url: string;
2549
- width: number;
2550
- height: number;
2551
- };
2552
- mediaType: MediaItemType;
2553
- title: string;
2554
- id: string;
2555
- }[];
2556
- };
2557
- numberOfProducts: number;
2558
- seoSchema?: {
2559
- tags: {
2560
- type: string;
2561
- children: string;
2562
- custom: boolean;
2563
- disabled: boolean;
2564
- }[];
2565
- settings?: {
2566
- preventAutoRedirect: boolean;
2567
- keywords: {
2568
- term: string;
2569
- isMain: boolean;
2570
- }[];
2571
- };
2572
- };
2573
- };
2574
- }
2575
- export interface UpdateCollectionResponseNonNullableFields {
2576
- collection?: {
2577
- media?: {
2578
- mainMedia?: {
2579
- image?: {
2580
- url: string;
2581
- width: number;
2582
- height: number;
2583
- };
2584
- video?: {
2585
- files: {
2586
- url: string;
2587
- width: number;
2588
- height: number;
2589
- }[];
2590
- stillFrameMediaId: string;
2591
- };
2592
- thumbnail?: {
2593
- url: string;
2594
- width: number;
2595
- height: number;
2596
- };
2597
- mediaType: MediaItemType;
2598
- title: string;
2599
- id: string;
2600
- };
2601
- items: {
2602
- image?: {
2603
- url: string;
2604
- width: number;
2605
- height: number;
2606
- };
2607
- video?: {
2608
- files: {
2609
- url: string;
2610
- width: number;
2611
- height: number;
2612
- }[];
2613
- stillFrameMediaId: string;
2614
- };
2615
- thumbnail?: {
2616
- url: string;
2617
- width: number;
2618
- height: number;
2619
- };
2620
- mediaType: MediaItemType;
2621
- title: string;
2622
- id: string;
2623
- }[];
2624
- };
2625
- numberOfProducts: number;
2626
- seoSchema?: {
2627
- tags: {
2628
- type: string;
2629
- children: string;
2630
- custom: boolean;
2631
- disabled: boolean;
2632
- }[];
2633
- settings?: {
2634
- preventAutoRedirect: boolean;
2635
- keywords: {
2636
- term: string;
2637
- isMain: boolean;
2638
- }[];
2639
- };
2640
- };
2641
- };
2642
- }
2643
- export interface BulkUpdateProductsResponseNonNullableFields {
2644
- results: {
2645
- itemMetadata?: {
2646
- originalIndex: number;
2647
- success: boolean;
2648
- error?: {
2649
- code: string;
2650
- description: string;
2651
- };
2652
- };
2653
- }[];
2654
- bulkActionMetadata?: {
2655
- totalSuccesses: number;
2656
- totalFailures: number;
2657
- undetailedFailures: number;
2658
- };
2659
- }
2660
- export interface BulkAdjustProductPropertiesResponseNonNullableFields {
2661
- results: {
2662
- itemMetadata?: {
2663
- originalIndex: number;
2664
- success: boolean;
2665
- error?: {
2666
- code: string;
2667
- description: string;
2668
- };
2669
- };
2670
- }[];
2671
- bulkActionMetadata?: {
2672
- totalSuccesses: number;
2673
- totalFailures: number;
2674
- undetailedFailures: number;
2675
- };
2676
- }
2677
- export interface V1CreateProductPlatformizedResponseNonNullableFields {
2678
- product?: {
2679
- id: string;
2680
- slug: string;
2681
- productType: ProductType;
2682
- weightRange?: {
2683
- minValue: number;
2684
- maxValue: number;
2685
- };
2686
- stock?: {
2687
- trackInventory: boolean;
2688
- inStock: boolean;
2689
- inventoryStatus: InventoryStatus;
2690
- };
2691
- price?: {
2692
- currency: string;
2693
- discountedPrice: number;
2694
- formatted?: {
2695
- price: string;
2696
- discountedPrice: string;
2697
- };
2698
- };
2699
- priceData?: {
2700
- currency: string;
2701
- discountedPrice: number;
2702
- formatted?: {
2703
- price: string;
2704
- discountedPrice: string;
2705
- };
2706
- };
2707
- convertedPriceData?: {
2708
- currency: string;
2709
- discountedPrice: number;
2710
- formatted?: {
2711
- price: string;
2712
- discountedPrice: string;
2713
- };
2714
- };
2715
- priceRange?: {
2716
- minValue: number;
2717
- maxValue: number;
2718
- };
2719
- costAndProfitData?: {
2720
- formattedItemCost: string;
2721
- profit: number;
2722
- formattedProfit: string;
2723
- profitMargin: number;
2724
- };
2725
- costRange?: {
2726
- minValue: number;
2727
- maxValue: number;
2728
- };
2729
- pricePerUnitData?: {
2730
- totalQuantity: number;
2731
- totalMeasurementUnit: MeasurementUnit;
2732
- baseQuantity: number;
2733
- baseMeasurementUnit: MeasurementUnit;
2734
- };
2735
- additionalInfoSections: {
2736
- title: string;
2737
- description: string;
2738
- }[];
2739
- ribbons: {
2740
- text: string;
2741
- }[];
2742
- media?: {
2743
- mainMedia?: {
2744
- image?: {
2745
- url: string;
2746
- width: number;
2747
- height: number;
2748
- };
2749
- video?: {
2750
- files: {
2751
- url: string;
2752
- width: number;
2753
- height: number;
2754
- }[];
2755
- stillFrameMediaId: string;
2756
- };
2757
- thumbnail?: {
2758
- url: string;
2759
- width: number;
2760
- height: number;
2761
- };
2762
- mediaType: MediaItemType;
2763
- title: string;
2764
- id: string;
2765
- };
2766
- items: {
2767
- image?: {
2768
- url: string;
2769
- width: number;
2770
- height: number;
2771
- };
2772
- video?: {
2773
- files: {
2774
- url: string;
2775
- width: number;
2776
- height: number;
2777
- }[];
2778
- stillFrameMediaId: string;
2779
- };
2780
- thumbnail?: {
2781
- url: string;
2782
- width: number;
2783
- height: number;
2784
- };
2785
- mediaType: MediaItemType;
2786
- title: string;
2787
- id: string;
2788
- }[];
2789
- };
2790
- customTextFields: {
2791
- title: string;
2792
- maxLength: number;
2793
- mandatory: boolean;
2794
- }[];
2795
- productOptions: {
2796
- optionType: OptionType;
2797
- name: string;
2798
- choices: {
2799
- value: string;
2800
- description: string;
2801
- media?: {
2802
- mainMedia?: {
2803
- image?: {
2804
- url: string;
2805
- width: number;
2806
- height: number;
2807
- };
2808
- video?: {
2809
- files: {
2810
- url: string;
2811
- width: number;
2812
- height: number;
2813
- }[];
2814
- stillFrameMediaId: string;
2815
- };
2816
- thumbnail?: {
2817
- url: string;
2818
- width: number;
2819
- height: number;
2820
- };
2821
- mediaType: MediaItemType;
2822
- title: string;
2823
- id: string;
2824
- };
2825
- items: {
2826
- image?: {
2827
- url: string;
2828
- width: number;
2829
- height: number;
2830
- };
2831
- video?: {
2832
- files: {
2833
- url: string;
2834
- width: number;
2835
- height: number;
2836
- }[];
2837
- stillFrameMediaId: string;
2838
- };
2839
- thumbnail?: {
2840
- url: string;
2841
- width: number;
2842
- height: number;
2843
- };
2844
- mediaType: MediaItemType;
2845
- title: string;
2846
- id: string;
2847
- }[];
2848
- };
2849
- inStock: boolean;
2850
- visible: boolean;
2851
- }[];
2852
- }[];
2853
- productPageUrl?: {
2854
- base: string;
2855
- path: string;
2856
- };
2857
- numericId: string;
2858
- inventoryItemId: string;
2859
- discount?: {
2860
- type: DiscountType;
2861
- value: number;
2862
- };
2863
- collectionIds: string[];
2864
- variants: {
2865
- id: string;
2866
- variant?: {
2867
- priceData?: {
2868
- currency: string;
2869
- discountedPrice: number;
2870
- formatted?: {
2871
- price: string;
2872
- discountedPrice: string;
2873
- };
2874
- };
2875
- convertedPriceData?: {
2876
- currency: string;
2877
- discountedPrice: number;
2878
- formatted?: {
2879
- price: string;
2880
- discountedPrice: string;
2881
- };
2882
- };
2883
- costAndProfitData?: {
2884
- formattedItemCost: string;
2885
- profit: number;
2886
- formattedProfit: string;
2887
- profitMargin: number;
2888
- };
2889
- weight: number;
2890
- sku: string;
2891
- visible: boolean;
2892
- };
2893
- stock?: {
2894
- trackQuantity: boolean;
2895
- inStock: boolean;
2896
- };
2897
- }[];
2898
- seoData?: {
2899
- tags: {
2900
- type: string;
2901
- children: string;
2902
- custom: boolean;
2903
- disabled: boolean;
2904
- }[];
2905
- settings?: {
2906
- preventAutoRedirect: boolean;
2907
- keywords: {
2908
- term: string;
2909
- isMain: boolean;
2910
- }[];
2911
- };
2912
- };
2913
- exportProductId: string;
2914
- digitalFile?: {
2915
- id: string;
2916
- fileName: string;
2917
- fileType: FileType;
2918
- };
2919
- };
2920
- }
2921
- export interface V1UpdateProductPlatformizedResponseNonNullableFields {
2922
- product?: {
2923
- id: string;
2924
- slug: string;
2925
- productType: ProductType;
2926
- weightRange?: {
2927
- minValue: number;
2928
- maxValue: number;
2929
- };
2930
- stock?: {
2931
- trackInventory: boolean;
2932
- inStock: boolean;
2933
- inventoryStatus: InventoryStatus;
2934
- };
2935
- price?: {
2936
- currency: string;
2937
- discountedPrice: number;
2938
- formatted?: {
2939
- price: string;
2940
- discountedPrice: string;
2941
- };
2942
- };
2943
- priceData?: {
2944
- currency: string;
2945
- discountedPrice: number;
2946
- formatted?: {
2947
- price: string;
2948
- discountedPrice: string;
2949
- };
2950
- };
2951
- convertedPriceData?: {
2952
- currency: string;
2953
- discountedPrice: number;
2954
- formatted?: {
2955
- price: string;
2956
- discountedPrice: string;
2957
- };
2958
- };
2959
- priceRange?: {
2960
- minValue: number;
2961
- maxValue: number;
2962
- };
2963
- costAndProfitData?: {
2964
- formattedItemCost: string;
2965
- profit: number;
2966
- formattedProfit: string;
2967
- profitMargin: number;
2968
- };
2969
- costRange?: {
2970
- minValue: number;
2971
- maxValue: number;
2972
- };
2973
- pricePerUnitData?: {
2974
- totalQuantity: number;
2975
- totalMeasurementUnit: MeasurementUnit;
2976
- baseQuantity: number;
2977
- baseMeasurementUnit: MeasurementUnit;
2978
- };
2979
- additionalInfoSections: {
2980
- title: string;
2981
- description: string;
2982
- }[];
2983
- ribbons: {
2984
- text: string;
2985
- }[];
2986
- media?: {
2987
- mainMedia?: {
2988
- image?: {
2989
- url: string;
2990
- width: number;
2991
- height: number;
2992
- };
2993
- video?: {
2994
- files: {
2995
- url: string;
2996
- width: number;
2997
- height: number;
2998
- }[];
2999
- stillFrameMediaId: string;
3000
- };
3001
- thumbnail?: {
3002
- url: string;
3003
- width: number;
3004
- height: number;
3005
- };
3006
- mediaType: MediaItemType;
3007
- title: string;
3008
- id: string;
3009
- };
3010
- items: {
3011
- image?: {
3012
- url: string;
3013
- width: number;
3014
- height: number;
3015
- };
3016
- video?: {
3017
- files: {
3018
- url: string;
3019
- width: number;
3020
- height: number;
3021
- }[];
3022
- stillFrameMediaId: string;
3023
- };
3024
- thumbnail?: {
3025
- url: string;
3026
- width: number;
3027
- height: number;
3028
- };
3029
- mediaType: MediaItemType;
3030
- title: string;
3031
- id: string;
3032
- }[];
3033
- };
3034
- customTextFields: {
3035
- title: string;
3036
- maxLength: number;
3037
- mandatory: boolean;
3038
- }[];
3039
- productOptions: {
3040
- optionType: OptionType;
3041
- name: string;
3042
- choices: {
3043
- value: string;
3044
- description: string;
3045
- media?: {
3046
- mainMedia?: {
3047
- image?: {
3048
- url: string;
3049
- width: number;
3050
- height: number;
3051
- };
3052
- video?: {
3053
- files: {
3054
- url: string;
3055
- width: number;
3056
- height: number;
3057
- }[];
3058
- stillFrameMediaId: string;
3059
- };
3060
- thumbnail?: {
3061
- url: string;
3062
- width: number;
3063
- height: number;
3064
- };
3065
- mediaType: MediaItemType;
3066
- title: string;
3067
- id: string;
3068
- };
3069
- items: {
3070
- image?: {
3071
- url: string;
3072
- width: number;
3073
- height: number;
3074
- };
3075
- video?: {
3076
- files: {
3077
- url: string;
3078
- width: number;
3079
- height: number;
3080
- }[];
3081
- stillFrameMediaId: string;
3082
- };
3083
- thumbnail?: {
3084
- url: string;
3085
- width: number;
3086
- height: number;
3087
- };
3088
- mediaType: MediaItemType;
3089
- title: string;
3090
- id: string;
3091
- }[];
3092
- };
3093
- inStock: boolean;
3094
- visible: boolean;
3095
- }[];
3096
- }[];
3097
- productPageUrl?: {
3098
- base: string;
3099
- path: string;
3100
- };
3101
- numericId: string;
3102
- inventoryItemId: string;
3103
- discount?: {
3104
- type: DiscountType;
3105
- value: number;
3106
- };
3107
- collectionIds: string[];
3108
- variants: {
3109
- id: string;
3110
- variant?: {
3111
- priceData?: {
3112
- currency: string;
3113
- discountedPrice: number;
3114
- formatted?: {
3115
- price: string;
3116
- discountedPrice: string;
3117
- };
3118
- };
3119
- convertedPriceData?: {
3120
- currency: string;
3121
- discountedPrice: number;
3122
- formatted?: {
3123
- price: string;
3124
- discountedPrice: string;
3125
- };
3126
- };
3127
- costAndProfitData?: {
3128
- formattedItemCost: string;
3129
- profit: number;
3130
- formattedProfit: string;
3131
- profitMargin: number;
3132
- };
3133
- weight: number;
3134
- sku: string;
3135
- visible: boolean;
3136
- };
3137
- stock?: {
3138
- trackQuantity: boolean;
3139
- inStock: boolean;
3140
- };
3141
- }[];
3142
- seoData?: {
3143
- tags: {
3144
- type: string;
3145
- children: string;
3146
- custom: boolean;
3147
- disabled: boolean;
3148
- }[];
3149
- settings?: {
3150
- preventAutoRedirect: boolean;
3151
- keywords: {
3152
- term: string;
3153
- isMain: boolean;
3154
- }[];
3155
- };
3156
- };
3157
- exportProductId: string;
3158
- digitalFile?: {
3159
- id: string;
3160
- fileName: string;
3161
- fileType: FileType;
3162
- };
3163
- };
3164
- }
3165
- export interface QueryProductsPlatformizedResponseNonNullableFields {
3166
- products: {
3167
- id: string;
3168
- slug: string;
3169
- productType: ProductType;
3170
- weightRange?: {
3171
- minValue: number;
3172
- maxValue: number;
3173
- };
3174
- stock?: {
3175
- trackInventory: boolean;
3176
- inStock: boolean;
3177
- inventoryStatus: InventoryStatus;
3178
- };
3179
- price?: {
3180
- currency: string;
3181
- discountedPrice: number;
3182
- formatted?: {
3183
- price: string;
3184
- discountedPrice: string;
3185
- };
3186
- };
3187
- priceData?: {
3188
- currency: string;
3189
- discountedPrice: number;
3190
- formatted?: {
3191
- price: string;
3192
- discountedPrice: string;
3193
- };
3194
- };
3195
- convertedPriceData?: {
3196
- currency: string;
3197
- discountedPrice: number;
3198
- formatted?: {
3199
- price: string;
3200
- discountedPrice: string;
3201
- };
3202
- };
3203
- priceRange?: {
3204
- minValue: number;
3205
- maxValue: number;
3206
- };
3207
- costAndProfitData?: {
3208
- formattedItemCost: string;
3209
- profit: number;
3210
- formattedProfit: string;
3211
- profitMargin: number;
3212
- };
3213
- costRange?: {
3214
- minValue: number;
3215
- maxValue: number;
3216
- };
3217
- pricePerUnitData?: {
3218
- totalQuantity: number;
3219
- totalMeasurementUnit: MeasurementUnit;
3220
- baseQuantity: number;
3221
- baseMeasurementUnit: MeasurementUnit;
3222
- };
3223
- additionalInfoSections: {
3224
- title: string;
3225
- description: string;
3226
- }[];
3227
- ribbons: {
3228
- text: string;
3229
- }[];
3230
- media?: {
3231
- mainMedia?: {
3232
- image?: {
3233
- url: string;
3234
- width: number;
3235
- height: number;
3236
- };
3237
- video?: {
3238
- files: {
3239
- url: string;
3240
- width: number;
3241
- height: number;
3242
- }[];
3243
- stillFrameMediaId: string;
3244
- };
3245
- thumbnail?: {
3246
- url: string;
3247
- width: number;
3248
- height: number;
3249
- };
3250
- mediaType: MediaItemType;
3251
- title: string;
3252
- id: string;
3253
- };
3254
- items: {
3255
- image?: {
3256
- url: string;
3257
- width: number;
3258
- height: number;
3259
- };
3260
- video?: {
3261
- files: {
3262
- url: string;
3263
- width: number;
3264
- height: number;
3265
- }[];
3266
- stillFrameMediaId: string;
3267
- };
3268
- thumbnail?: {
3269
- url: string;
3270
- width: number;
3271
- height: number;
3272
- };
3273
- mediaType: MediaItemType;
3274
- title: string;
3275
- id: string;
3276
- }[];
3277
- };
3278
- customTextFields: {
3279
- title: string;
3280
- maxLength: number;
3281
- mandatory: boolean;
3282
- }[];
3283
- productOptions: {
3284
- optionType: OptionType;
3285
- name: string;
3286
- choices: {
3287
- value: string;
3288
- description: string;
3289
- media?: {
3290
- mainMedia?: {
3291
- image?: {
3292
- url: string;
3293
- width: number;
3294
- height: number;
3295
- };
3296
- video?: {
3297
- files: {
3298
- url: string;
3299
- width: number;
3300
- height: number;
3301
- }[];
3302
- stillFrameMediaId: string;
3303
- };
3304
- thumbnail?: {
3305
- url: string;
3306
- width: number;
3307
- height: number;
3308
- };
3309
- mediaType: MediaItemType;
3310
- title: string;
3311
- id: string;
3312
- };
3313
- items: {
3314
- image?: {
3315
- url: string;
3316
- width: number;
3317
- height: number;
3318
- };
3319
- video?: {
3320
- files: {
3321
- url: string;
3322
- width: number;
3323
- height: number;
3324
- }[];
3325
- stillFrameMediaId: string;
3326
- };
3327
- thumbnail?: {
3328
- url: string;
3329
- width: number;
3330
- height: number;
3331
- };
3332
- mediaType: MediaItemType;
3333
- title: string;
3334
- id: string;
3335
- }[];
3336
- };
3337
- inStock: boolean;
3338
- visible: boolean;
3339
- }[];
3340
- }[];
3341
- productPageUrl?: {
3342
- base: string;
3343
- path: string;
3344
- };
3345
- numericId: string;
3346
- inventoryItemId: string;
3347
- discount?: {
3348
- type: DiscountType;
3349
- value: number;
3350
- };
3351
- collectionIds: string[];
3352
- variants: {
3353
- id: string;
3354
- variant?: {
3355
- priceData?: {
3356
- currency: string;
3357
- discountedPrice: number;
3358
- formatted?: {
3359
- price: string;
3360
- discountedPrice: string;
3361
- };
3362
- };
3363
- convertedPriceData?: {
3364
- currency: string;
3365
- discountedPrice: number;
3366
- formatted?: {
3367
- price: string;
3368
- discountedPrice: string;
3369
- };
3370
- };
3371
- costAndProfitData?: {
3372
- formattedItemCost: string;
3373
- profit: number;
3374
- formattedProfit: string;
3375
- profitMargin: number;
3376
- };
3377
- weight: number;
3378
- sku: string;
3379
- visible: boolean;
3380
- };
3381
- stock?: {
3382
- trackQuantity: boolean;
3383
- inStock: boolean;
3384
- };
3385
- }[];
3386
- seoData?: {
3387
- tags: {
3388
- type: string;
3389
- children: string;
3390
- custom: boolean;
3391
- disabled: boolean;
3392
- }[];
3393
- settings?: {
3394
- preventAutoRedirect: boolean;
3395
- keywords: {
3396
- term: string;
3397
- isMain: boolean;
3398
- }[];
3399
- };
3400
- };
3401
- exportProductId: string;
3402
- digitalFile?: {
3403
- id: string;
3404
- fileName: string;
3405
- fileType: FileType;
3406
- };
3407
- }[];
3408
- }
3409
- export interface GetProductResponseNonNullableFields {
3410
- product?: {
3411
- id: string;
3412
- slug: string;
3413
- productType: ProductType;
3414
- weightRange?: {
3415
- minValue: number;
3416
- maxValue: number;
3417
- };
3418
- stock?: {
3419
- trackInventory: boolean;
3420
- inStock: boolean;
3421
- inventoryStatus: InventoryStatus;
3422
- };
3423
- price?: {
3424
- currency: string;
3425
- discountedPrice: number;
3426
- formatted?: {
3427
- price: string;
3428
- discountedPrice: string;
3429
- };
3430
- };
3431
- priceData?: {
3432
- currency: string;
3433
- discountedPrice: number;
3434
- formatted?: {
3435
- price: string;
3436
- discountedPrice: string;
3437
- };
3438
- };
3439
- convertedPriceData?: {
3440
- currency: string;
3441
- discountedPrice: number;
3442
- formatted?: {
3443
- price: string;
3444
- discountedPrice: string;
3445
- };
3446
- };
3447
- priceRange?: {
3448
- minValue: number;
3449
- maxValue: number;
3450
- };
3451
- costAndProfitData?: {
3452
- formattedItemCost: string;
3453
- profit: number;
3454
- formattedProfit: string;
3455
- profitMargin: number;
3456
- };
3457
- costRange?: {
3458
- minValue: number;
3459
- maxValue: number;
3460
- };
3461
- pricePerUnitData?: {
3462
- totalQuantity: number;
3463
- totalMeasurementUnit: MeasurementUnit;
3464
- baseQuantity: number;
3465
- baseMeasurementUnit: MeasurementUnit;
3466
- };
3467
- additionalInfoSections: {
3468
- title: string;
3469
- description: string;
3470
- }[];
3471
- ribbons: {
3472
- text: string;
3473
- }[];
3474
- media?: {
3475
- mainMedia?: {
3476
- image?: {
3477
- url: string;
3478
- width: number;
3479
- height: number;
3480
- };
3481
- video?: {
3482
- files: {
3483
- url: string;
3484
- width: number;
3485
- height: number;
3486
- }[];
3487
- stillFrameMediaId: string;
3488
- };
3489
- thumbnail?: {
3490
- url: string;
3491
- width: number;
3492
- height: number;
3493
- };
3494
- mediaType: MediaItemType;
3495
- title: string;
3496
- id: string;
3497
- };
3498
- items: {
3499
- image?: {
3500
- url: string;
3501
- width: number;
3502
- height: number;
3503
- };
3504
- video?: {
3505
- files: {
3506
- url: string;
3507
- width: number;
3508
- height: number;
3509
- }[];
3510
- stillFrameMediaId: string;
3511
- };
3512
- thumbnail?: {
3513
- url: string;
3514
- width: number;
3515
- height: number;
3516
- };
3517
- mediaType: MediaItemType;
3518
- title: string;
3519
- id: string;
3520
- }[];
3521
- };
3522
- customTextFields: {
3523
- title: string;
3524
- maxLength: number;
3525
- mandatory: boolean;
3526
- }[];
3527
- productOptions: {
3528
- optionType: OptionType;
3529
- name: string;
3530
- choices: {
3531
- value: string;
3532
- description: string;
3533
- media?: {
3534
- mainMedia?: {
3535
- image?: {
3536
- url: string;
3537
- width: number;
3538
- height: number;
3539
- };
3540
- video?: {
3541
- files: {
3542
- url: string;
3543
- width: number;
3544
- height: number;
3545
- }[];
3546
- stillFrameMediaId: string;
3547
- };
3548
- thumbnail?: {
3549
- url: string;
3550
- width: number;
3551
- height: number;
3552
- };
3553
- mediaType: MediaItemType;
3554
- title: string;
3555
- id: string;
3556
- };
3557
- items: {
3558
- image?: {
3559
- url: string;
3560
- width: number;
3561
- height: number;
3562
- };
3563
- video?: {
3564
- files: {
3565
- url: string;
3566
- width: number;
3567
- height: number;
3568
- }[];
3569
- stillFrameMediaId: string;
3570
- };
3571
- thumbnail?: {
3572
- url: string;
3573
- width: number;
3574
- height: number;
3575
- };
3576
- mediaType: MediaItemType;
3577
- title: string;
3578
- id: string;
3579
- }[];
3580
- };
3581
- inStock: boolean;
3582
- visible: boolean;
3583
- }[];
3584
- }[];
3585
- productPageUrl?: {
3586
- base: string;
3587
- path: string;
3588
- };
3589
- numericId: string;
3590
- inventoryItemId: string;
3591
- discount?: {
3592
- type: DiscountType;
3593
- value: number;
3594
- };
3595
- collectionIds: string[];
3596
- variants: {
3597
- id: string;
3598
- variant?: {
3599
- priceData?: {
3600
- currency: string;
3601
- discountedPrice: number;
3602
- formatted?: {
3603
- price: string;
3604
- discountedPrice: string;
3605
- };
3606
- };
3607
- convertedPriceData?: {
3608
- currency: string;
3609
- discountedPrice: number;
3610
- formatted?: {
3611
- price: string;
3612
- discountedPrice: string;
3613
- };
3614
- };
3615
- costAndProfitData?: {
3616
- formattedItemCost: string;
3617
- profit: number;
3618
- formattedProfit: string;
3619
- profitMargin: number;
3620
- };
3621
- weight: number;
3622
- sku: string;
3623
- visible: boolean;
3624
- };
3625
- stock?: {
3626
- trackQuantity: boolean;
3627
- inStock: boolean;
3628
- };
3629
- }[];
3630
- seoData?: {
3631
- tags: {
3632
- type: string;
3633
- children: string;
3634
- custom: boolean;
3635
- disabled: boolean;
3636
- }[];
3637
- settings?: {
3638
- preventAutoRedirect: boolean;
3639
- keywords: {
3640
- term: string;
3641
- isMain: boolean;
3642
- }[];
3643
- };
3644
- };
3645
- exportProductId: string;
3646
- digitalFile?: {
3647
- id: string;
3648
- fileName: string;
3649
- fileType: FileType;
3650
- };
3651
- };
3652
- }
3653
- export interface GetProductPlatformizedResponseNonNullableFields {
3654
- product?: {
3655
- id: string;
3656
- slug: string;
3657
- productType: ProductType;
3658
- weightRange?: {
3659
- minValue: number;
3660
- maxValue: number;
3661
- };
3662
- stock?: {
3663
- trackInventory: boolean;
3664
- inStock: boolean;
3665
- inventoryStatus: InventoryStatus;
3666
- };
3667
- price?: {
3668
- currency: string;
3669
- discountedPrice: number;
3670
- formatted?: {
3671
- price: string;
3672
- discountedPrice: string;
3673
- };
3674
- };
3675
- priceData?: {
3676
- currency: string;
3677
- discountedPrice: number;
3678
- formatted?: {
3679
- price: string;
3680
- discountedPrice: string;
3681
- };
3682
- };
3683
- convertedPriceData?: {
3684
- currency: string;
3685
- discountedPrice: number;
3686
- formatted?: {
3687
- price: string;
3688
- discountedPrice: string;
3689
- };
3690
- };
3691
- priceRange?: {
3692
- minValue: number;
3693
- maxValue: number;
3694
- };
3695
- costAndProfitData?: {
3696
- formattedItemCost: string;
3697
- profit: number;
3698
- formattedProfit: string;
3699
- profitMargin: number;
3700
- };
3701
- costRange?: {
3702
- minValue: number;
3703
- maxValue: number;
3704
- };
3705
- pricePerUnitData?: {
3706
- totalQuantity: number;
3707
- totalMeasurementUnit: MeasurementUnit;
3708
- baseQuantity: number;
3709
- baseMeasurementUnit: MeasurementUnit;
3710
- };
3711
- additionalInfoSections: {
3712
- title: string;
3713
- description: string;
3714
- }[];
3715
- ribbons: {
3716
- text: string;
3717
- }[];
3718
- media?: {
3719
- mainMedia?: {
3720
- image?: {
3721
- url: string;
3722
- width: number;
3723
- height: number;
3724
- };
3725
- video?: {
3726
- files: {
3727
- url: string;
3728
- width: number;
3729
- height: number;
3730
- }[];
3731
- stillFrameMediaId: string;
3732
- };
3733
- thumbnail?: {
3734
- url: string;
3735
- width: number;
3736
- height: number;
3737
- };
3738
- mediaType: MediaItemType;
3739
- title: string;
3740
- id: string;
3741
- };
3742
- items: {
3743
- image?: {
3744
- url: string;
3745
- width: number;
3746
- height: number;
3747
- };
3748
- video?: {
3749
- files: {
3750
- url: string;
3751
- width: number;
3752
- height: number;
3753
- }[];
3754
- stillFrameMediaId: string;
3755
- };
3756
- thumbnail?: {
3757
- url: string;
3758
- width: number;
3759
- height: number;
3760
- };
3761
- mediaType: MediaItemType;
3762
- title: string;
3763
- id: string;
3764
- }[];
3765
- };
3766
- customTextFields: {
3767
- title: string;
3768
- maxLength: number;
3769
- mandatory: boolean;
3770
- }[];
3771
- productOptions: {
3772
- optionType: OptionType;
3773
- name: string;
3774
- choices: {
3775
- value: string;
3776
- description: string;
3777
- media?: {
3778
- mainMedia?: {
3779
- image?: {
3780
- url: string;
3781
- width: number;
3782
- height: number;
3783
- };
3784
- video?: {
3785
- files: {
3786
- url: string;
3787
- width: number;
3788
- height: number;
3789
- }[];
3790
- stillFrameMediaId: string;
3791
- };
3792
- thumbnail?: {
3793
- url: string;
3794
- width: number;
3795
- height: number;
3796
- };
3797
- mediaType: MediaItemType;
3798
- title: string;
3799
- id: string;
3800
- };
3801
- items: {
3802
- image?: {
3803
- url: string;
3804
- width: number;
3805
- height: number;
3806
- };
3807
- video?: {
3808
- files: {
3809
- url: string;
3810
- width: number;
3811
- height: number;
3812
- }[];
3813
- stillFrameMediaId: string;
3814
- };
3815
- thumbnail?: {
3816
- url: string;
3817
- width: number;
3818
- height: number;
3819
- };
3820
- mediaType: MediaItemType;
3821
- title: string;
3822
- id: string;
3823
- }[];
3824
- };
3825
- inStock: boolean;
3826
- visible: boolean;
3827
- }[];
3828
- }[];
3829
- productPageUrl?: {
3830
- base: string;
3831
- path: string;
3832
- };
3833
- numericId: string;
3834
- inventoryItemId: string;
3835
- discount?: {
3836
- type: DiscountType;
3837
- value: number;
3838
- };
3839
- collectionIds: string[];
3840
- variants: {
3841
- id: string;
3842
- variant?: {
3843
- priceData?: {
3844
- currency: string;
3845
- discountedPrice: number;
3846
- formatted?: {
3847
- price: string;
3848
- discountedPrice: string;
3849
- };
3850
- };
3851
- convertedPriceData?: {
3852
- currency: string;
3853
- discountedPrice: number;
3854
- formatted?: {
3855
- price: string;
3856
- discountedPrice: string;
3857
- };
3858
- };
3859
- costAndProfitData?: {
3860
- formattedItemCost: string;
3861
- profit: number;
3862
- formattedProfit: string;
3863
- profitMargin: number;
3864
- };
3865
- weight: number;
3866
- sku: string;
3867
- visible: boolean;
3868
- };
3869
- stock?: {
3870
- trackQuantity: boolean;
3871
- inStock: boolean;
3872
- };
3873
- }[];
3874
- seoData?: {
3875
- tags: {
3876
- type: string;
3877
- children: string;
3878
- custom: boolean;
3879
- disabled: boolean;
3880
- }[];
3881
- settings?: {
3882
- preventAutoRedirect: boolean;
3883
- keywords: {
3884
- term: string;
3885
- isMain: boolean;
3886
- }[];
3887
- };
3888
- };
3889
- exportProductId: string;
3890
- digitalFile?: {
3891
- id: string;
3892
- fileName: string;
3893
- fileType: FileType;
3894
- };
3895
- };
3896
- }
3897
- export interface GetCollectionBySlugResponseNonNullableFields {
3898
- collection?: {
3899
- media?: {
3900
- mainMedia?: {
3901
- image?: {
3902
- url: string;
3903
- width: number;
3904
- height: number;
3905
- };
3906
- video?: {
3907
- files: {
3908
- url: string;
3909
- width: number;
3910
- height: number;
3911
- }[];
3912
- stillFrameMediaId: string;
3913
- };
3914
- thumbnail?: {
3915
- url: string;
3916
- width: number;
3917
- height: number;
3918
- };
3919
- mediaType: MediaItemType;
3920
- title: string;
3921
- id: string;
3922
- };
3923
- items: {
3924
- image?: {
3925
- url: string;
3926
- width: number;
3927
- height: number;
3928
- };
3929
- video?: {
3930
- files: {
3931
- url: string;
3932
- width: number;
3933
- height: number;
3934
- }[];
3935
- stillFrameMediaId: string;
3936
- };
3937
- thumbnail?: {
3938
- url: string;
3939
- width: number;
3940
- height: number;
3941
- };
3942
- mediaType: MediaItemType;
3943
- title: string;
3944
- id: string;
3945
- }[];
3946
- };
3947
- numberOfProducts: number;
3948
- seoSchema?: {
3949
- tags: {
3950
- type: string;
3951
- children: string;
3952
- custom: boolean;
3953
- disabled: boolean;
3954
- }[];
3955
- settings?: {
3956
- preventAutoRedirect: boolean;
3957
- keywords: {
3958
- term: string;
3959
- isMain: boolean;
3960
- }[];
3961
- };
3962
- };
3963
- };
3964
- }
3965
- export interface ProductOptionsAvailabilityResponseNonNullableFields {
3966
- selectedVariant?: {
3967
- price?: {
3968
- currency: string;
3969
- discountedPrice: number;
3970
- formatted?: {
3971
- price: string;
3972
- discountedPrice: string;
3973
- };
3974
- };
3975
- convertedPriceData?: {
3976
- currency: string;
3977
- discountedPrice: number;
3978
- formatted?: {
3979
- price: string;
3980
- discountedPrice: string;
3981
- };
3982
- };
3983
- sku: string;
3984
- inStock: boolean;
3985
- visible: boolean;
3986
- variantId: string;
3987
- };
3988
- media?: {
3989
- mainMedia?: {
3990
- image?: {
3991
- url: string;
3992
- width: number;
3993
- height: number;
3994
- };
3995
- video?: {
3996
- files: {
3997
- url: string;
3998
- width: number;
3999
- height: number;
4000
- }[];
4001
- stillFrameMediaId: string;
4002
- };
4003
- thumbnail?: {
4004
- url: string;
4005
- width: number;
4006
- height: number;
4007
- };
4008
- mediaType: MediaItemType;
4009
- title: string;
4010
- id: string;
4011
- };
4012
- items: {
4013
- image?: {
4014
- url: string;
4015
- width: number;
4016
- height: number;
4017
- };
4018
- video?: {
4019
- files: {
4020
- url: string;
4021
- width: number;
4022
- height: number;
4023
- }[];
4024
- stillFrameMediaId: string;
4025
- };
4026
- thumbnail?: {
4027
- url: string;
4028
- width: number;
4029
- height: number;
4030
- };
4031
- mediaType: MediaItemType;
4032
- title: string;
4033
- id: string;
4034
- }[];
4035
- };
4036
- productOptions: {
4037
- optionType: OptionType;
4038
- name: string;
4039
- choices: {
4040
- value: string;
4041
- description: string;
4042
- media?: {
4043
- mainMedia?: {
4044
- image?: {
4045
- url: string;
4046
- width: number;
4047
- height: number;
4048
- };
4049
- video?: {
4050
- files: {
4051
- url: string;
4052
- width: number;
4053
- height: number;
4054
- }[];
4055
- stillFrameMediaId: string;
4056
- };
4057
- thumbnail?: {
4058
- url: string;
4059
- width: number;
4060
- height: number;
4061
- };
4062
- mediaType: MediaItemType;
4063
- title: string;
4064
- id: string;
4065
- };
4066
- items: {
4067
- image?: {
4068
- url: string;
4069
- width: number;
4070
- height: number;
4071
- };
4072
- video?: {
4073
- files: {
4074
- url: string;
4075
- width: number;
4076
- height: number;
4077
- }[];
4078
- stillFrameMediaId: string;
4079
- };
4080
- thumbnail?: {
4081
- url: string;
4082
- width: number;
4083
- height: number;
4084
- };
4085
- mediaType: MediaItemType;
4086
- title: string;
4087
- id: string;
4088
- }[];
4089
- };
4090
- inStock: boolean;
4091
- visible: boolean;
4092
- }[];
4093
- }[];
4094
- availableForPurchase: boolean;
4095
- managedProduct: boolean;
4096
- }
4097
- export interface QueryProductVariantsResponseNonNullableFields {
4098
- variants: {
4099
- id: string;
4100
- variant?: {
4101
- priceData?: {
4102
- currency: string;
4103
- discountedPrice: number;
4104
- formatted?: {
4105
- price: string;
4106
- discountedPrice: string;
4107
- };
4108
- };
4109
- convertedPriceData?: {
4110
- currency: string;
4111
- discountedPrice: number;
4112
- formatted?: {
4113
- price: string;
4114
- discountedPrice: string;
4115
- };
4116
- };
4117
- costAndProfitData?: {
4118
- formattedItemCost: string;
4119
- profit: number;
4120
- formattedProfit: string;
4121
- profitMargin: number;
4122
- };
4123
- weight: number;
4124
- sku: string;
4125
- visible: boolean;
4126
- };
4127
- stock?: {
4128
- trackQuantity: boolean;
4129
- inStock: boolean;
4130
- };
4131
- }[];
4132
- metadata?: {
4133
- items: number;
4134
- offset: number;
4135
- };
4136
- totalResults: number;
4137
- }
4138
- export interface QueryStoreVariantsResponseNonNullableFields {
4139
- variants: {
4140
- id: string;
4141
- variantId: string;
4142
- productId: string;
4143
- variantName: string;
4144
- productName: string;
4145
- managedVariant: boolean;
4146
- sku: string;
4147
- stock?: {
4148
- trackQuantity: boolean;
4149
- inStock: boolean;
4150
- };
4151
- collectionIds: string[];
4152
- media?: {
4153
- image?: {
4154
- id: string;
4155
- url: string;
4156
- height: number;
4157
- width: number;
4158
- };
4159
- video?: {
4160
- id: string;
4161
- url: string;
4162
- resolutions: {
4163
- url: string;
4164
- height: number;
4165
- width: number;
4166
- poster?: {
4167
- id: string;
4168
- url: string;
4169
- height: number;
4170
- width: number;
4171
- };
4172
- format: string;
4173
- }[];
4174
- posters: {
4175
- id: string;
4176
- url: string;
4177
- height: number;
4178
- width: number;
4179
- }[];
4180
- };
4181
- };
4182
- preorderInfo?: {
4183
- enabled: boolean;
4184
- };
4185
- }[];
4186
- }
4187
- export interface GetStoreVariantResponseNonNullableFields {
4188
- variant?: {
4189
- id: string;
4190
- variantId: string;
4191
- productId: string;
4192
- variantName: string;
4193
- productName: string;
4194
- managedVariant: boolean;
4195
- sku: string;
4196
- stock?: {
4197
- trackQuantity: boolean;
4198
- inStock: boolean;
4199
- };
4200
- collectionIds: string[];
4201
- media?: {
4202
- image?: {
4203
- id: string;
4204
- url: string;
4205
- height: number;
4206
- width: number;
4207
- };
4208
- video?: {
4209
- id: string;
4210
- url: string;
4211
- resolutions: {
4212
- url: string;
4213
- height: number;
4214
- width: number;
4215
- poster?: {
4216
- id: string;
4217
- url: string;
4218
- height: number;
4219
- width: number;
4220
- };
4221
- format: string;
4222
- }[];
4223
- posters: {
4224
- id: string;
4225
- url: string;
4226
- height: number;
4227
- width: number;
4228
- }[];
4229
- };
4230
- };
4231
- preorderInfo?: {
4232
- enabled: boolean;
4233
- };
4234
- };
4235
- }