@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (577) hide show
  1. package/data/help/index.json +9685 -0
  2. package/data/script-api/index.json +1 -528
  3. package/data/tooling/index.json +4 -4
  4. package/data/xsd/index.json +1 -1
  5. package/dist/esm/cli/base-command.js +5 -0
  6. package/dist/esm/cli/base-command.js.map +1 -1
  7. package/dist/esm/clients/index.d.ts +2 -0
  8. package/dist/esm/clients/index.js +1 -0
  9. package/dist/esm/clients/index.js.map +1 -1
  10. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  11. package/dist/esm/clients/middleware-registry.js.map +1 -1
  12. package/dist/esm/clients/preferences.d.ts +83 -0
  13. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  14. package/dist/esm/clients/preferences.generated.js +6 -0
  15. package/dist/esm/clients/preferences.generated.js.map +1 -0
  16. package/dist/esm/clients/preferences.js +64 -0
  17. package/dist/esm/clients/preferences.js.map +1 -0
  18. package/dist/esm/config/dw-json.d.ts +2 -0
  19. package/dist/esm/config/dw-json.js.map +1 -1
  20. package/dist/esm/config/mapping.js +4 -0
  21. package/dist/esm/config/mapping.js.map +1 -1
  22. package/dist/esm/config/sources/dw-json-source.js +17 -4
  23. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  24. package/dist/esm/config/sources/env-source.js +2 -0
  25. package/dist/esm/config/sources/env-source.js.map +1 -1
  26. package/dist/esm/config/types.d.ts +14 -0
  27. package/dist/esm/docs/content-cache.d.ts +70 -0
  28. package/dist/esm/docs/content-cache.js +186 -0
  29. package/dist/esm/docs/content-cache.js.map +1 -0
  30. package/dist/esm/docs/index.d.ts +1 -0
  31. package/dist/esm/docs/index.js +2 -0
  32. package/dist/esm/docs/index.js.map +1 -1
  33. package/dist/esm/docs/search.js +34 -6
  34. package/dist/esm/docs/search.js.map +1 -1
  35. package/dist/esm/docs/types.d.ts +6 -1
  36. package/dist/esm/docs/types.js +1 -0
  37. package/dist/esm/docs/types.js.map +1 -1
  38. package/dist/esm/index.d.ts +2 -2
  39. package/dist/esm/index.js +1 -1
  40. package/dist/esm/index.js.map +1 -1
  41. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  42. package/dist/esm/operations/jobs/discover.js +87 -0
  43. package/dist/esm/operations/jobs/discover.js.map +1 -0
  44. package/dist/esm/operations/jobs/index.d.ts +2 -0
  45. package/dist/esm/operations/jobs/index.js +2 -0
  46. package/dist/esm/operations/jobs/index.js.map +1 -1
  47. package/dist/esm/operations/jobs/run.js +4 -3
  48. package/dist/esm/operations/jobs/run.js.map +1 -1
  49. package/package.json +5 -3
  50. package/specs/preferences-v1.yaml +2095 -0
  51. package/data/script-api/TopLevel.APIException.md +0 -119
  52. package/data/script-api/TopLevel.Array.md +0 -732
  53. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  54. package/data/script-api/TopLevel.BigInt.md +0 -154
  55. package/data/script-api/TopLevel.Boolean.md +0 -83
  56. package/data/script-api/TopLevel.ConversionError.md +0 -51
  57. package/data/script-api/TopLevel.DataView.md +0 -271
  58. package/data/script-api/TopLevel.Date.md +0 -688
  59. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  60. package/data/script-api/TopLevel.Error.md +0 -124
  61. package/data/script-api/TopLevel.EvalError.md +0 -47
  62. package/data/script-api/TopLevel.Fault.md +0 -133
  63. package/data/script-api/TopLevel.Float32Array.md +0 -186
  64. package/data/script-api/TopLevel.Float64Array.md +0 -186
  65. package/data/script-api/TopLevel.Function.md +0 -114
  66. package/data/script-api/TopLevel.Generator.md +0 -132
  67. package/data/script-api/TopLevel.IOError.md +0 -98
  68. package/data/script-api/TopLevel.Int16Array.md +0 -186
  69. package/data/script-api/TopLevel.Int32Array.md +0 -186
  70. package/data/script-api/TopLevel.Int8Array.md +0 -186
  71. package/data/script-api/TopLevel.InternalError.md +0 -47
  72. package/data/script-api/TopLevel.Iterable.md +0 -44
  73. package/data/script-api/TopLevel.Iterator.md +0 -89
  74. package/data/script-api/TopLevel.JSON.md +0 -173
  75. package/data/script-api/TopLevel.Map.md +0 -189
  76. package/data/script-api/TopLevel.Math.md +0 -948
  77. package/data/script-api/TopLevel.Module.md +0 -152
  78. package/data/script-api/TopLevel.Namespace.md +0 -152
  79. package/data/script-api/TopLevel.Number.md +0 -404
  80. package/data/script-api/TopLevel.Object.md +0 -472
  81. package/data/script-api/TopLevel.QName.md +0 -147
  82. package/data/script-api/TopLevel.RangeError.md +0 -47
  83. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  84. package/data/script-api/TopLevel.RegExp.md +0 -155
  85. package/data/script-api/TopLevel.Set.md +0 -150
  86. package/data/script-api/TopLevel.StopIteration.md +0 -36
  87. package/data/script-api/TopLevel.String.md +0 -1060
  88. package/data/script-api/TopLevel.Symbol.md +0 -196
  89. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  90. package/data/script-api/TopLevel.SystemError.md +0 -99
  91. package/data/script-api/TopLevel.TypeError.md +0 -47
  92. package/data/script-api/TopLevel.URIError.md +0 -47
  93. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  94. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  95. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  96. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  97. package/data/script-api/TopLevel.WeakMap.md +0 -135
  98. package/data/script-api/TopLevel.WeakSet.md +0 -96
  99. package/data/script-api/TopLevel.XML.md +0 -922
  100. package/data/script-api/TopLevel.XMLList.md +0 -418
  101. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  102. package/data/script-api/TopLevel.arguments.md +0 -56
  103. package/data/script-api/TopLevel.global.md +0 -539
  104. package/data/script-api/TopLevel.md +0 -58
  105. package/data/script-api/dw.alert.Alert.md +0 -175
  106. package/data/script-api/dw.alert.Alerts.md +0 -256
  107. package/data/script-api/dw.alert.md +0 -7
  108. package/data/script-api/dw.campaign.ABTest.md +0 -63
  109. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  110. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  111. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  112. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  113. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  114. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  115. package/data/script-api/dw.campaign.Campaign.md +0 -346
  116. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  117. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  118. package/data/script-api/dw.campaign.Coupon.md +0 -324
  119. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  120. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  121. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  122. package/data/script-api/dw.campaign.Discount.md +0 -271
  123. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  124. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  125. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  126. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  127. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  128. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  129. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  130. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  131. package/data/script-api/dw.campaign.Promotion.md +0 -939
  132. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  133. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  134. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  135. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  136. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  137. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  138. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  139. package/data/script-api/dw.campaign.md +0 -36
  140. package/data/script-api/dw.catalog.Catalog.md +0 -158
  141. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  142. package/data/script-api/dw.catalog.Category.md +0 -1212
  143. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  144. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  145. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  146. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  147. package/data/script-api/dw.catalog.Product.md +0 -2492
  148. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  149. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  150. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  151. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  152. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  153. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  154. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  155. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  156. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  157. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  158. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  159. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  160. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  161. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  162. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  163. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  164. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  165. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  166. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  167. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  168. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  169. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  170. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  171. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  172. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  173. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  174. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  175. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  176. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  177. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  178. package/data/script-api/dw.catalog.Store.md +0 -484
  179. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  180. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  181. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  182. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  183. package/data/script-api/dw.catalog.Variant.md +0 -1000
  184. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  185. package/data/script-api/dw.catalog.md +0 -50
  186. package/data/script-api/dw.content.Content.md +0 -481
  187. package/data/script-api/dw.content.ContentMgr.md +0 -147
  188. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  189. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  190. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  191. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  192. package/data/script-api/dw.content.Folder.md +0 -432
  193. package/data/script-api/dw.content.Library.md +0 -124
  194. package/data/script-api/dw.content.MarkupText.md +0 -150
  195. package/data/script-api/dw.content.MediaFile.md +0 -367
  196. package/data/script-api/dw.content.md +0 -15
  197. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  198. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  199. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  200. package/data/script-api/dw.crypto.Encoding.md +0 -193
  201. package/data/script-api/dw.crypto.JWE.md +0 -245
  202. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  203. package/data/script-api/dw.crypto.JWS.md +0 -260
  204. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  205. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  206. package/data/script-api/dw.crypto.Mac.md +0 -191
  207. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  208. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  209. package/data/script-api/dw.crypto.Signature.md +0 -241
  210. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  211. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  212. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  213. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  214. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  215. package/data/script-api/dw.crypto.md +0 -23
  216. package/data/script-api/dw.customer.AddressBook.md +0 -158
  217. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  218. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  219. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  220. package/data/script-api/dw.customer.Credentials.md +0 -524
  221. package/data/script-api/dw.customer.Customer.md +0 -488
  222. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  223. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  224. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  225. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  226. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  227. package/data/script-api/dw.customer.CustomerList.md +0 -76
  228. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  229. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  230. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  231. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  232. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  233. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  234. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  235. package/data/script-api/dw.customer.ProductList.md +0 -870
  236. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  237. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  238. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  239. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  240. package/data/script-api/dw.customer.Profile.md +0 -940
  241. package/data/script-api/dw.customer.Wallet.md +0 -136
  242. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  243. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  244. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  245. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  246. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  247. package/data/script-api/dw.customer.consent.md +0 -10
  248. package/data/script-api/dw.customer.md +0 -31
  249. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  250. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  251. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  252. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  253. package/data/script-api/dw.customer.oauth.md +0 -9
  254. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  255. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  256. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  257. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  258. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  259. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  260. package/data/script-api/dw.experience.Component.md +0 -166
  261. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  262. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  263. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  264. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  265. package/data/script-api/dw.experience.Page.md +0 -467
  266. package/data/script-api/dw.experience.PageMgr.md +0 -549
  267. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  268. package/data/script-api/dw.experience.Region.md +0 -119
  269. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  270. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  271. package/data/script-api/dw.experience.cms.md +0 -6
  272. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  273. package/data/script-api/dw.experience.image.Image.md +0 -101
  274. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  275. package/data/script-api/dw.experience.image.md +0 -8
  276. package/data/script-api/dw.experience.md +0 -16
  277. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  278. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  279. package/data/script-api/dw.extensions.applepay.md +0 -7
  280. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  281. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  282. package/data/script-api/dw.extensions.facebook.md +0 -7
  283. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  284. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  285. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  286. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  287. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  288. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  289. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  290. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  291. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  292. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  293. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  294. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  295. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  296. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  297. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  298. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  299. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  300. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  301. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  302. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  303. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  309. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  310. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.md +0 -28
  312. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  313. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  314. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  315. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  316. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  317. package/data/script-api/dw.extensions.pinterest.md +0 -10
  318. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  319. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  320. package/data/script-api/dw.io.File.md +0 -729
  321. package/data/script-api/dw.io.FileReader.md +0 -70
  322. package/data/script-api/dw.io.FileWriter.md +0 -159
  323. package/data/script-api/dw.io.InputStream.md +0 -35
  324. package/data/script-api/dw.io.OutputStream.md +0 -38
  325. package/data/script-api/dw.io.PrintWriter.md +0 -66
  326. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  327. package/data/script-api/dw.io.Reader.md +0 -284
  328. package/data/script-api/dw.io.StringWriter.md +0 -89
  329. package/data/script-api/dw.io.Writer.md +0 -96
  330. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  331. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  332. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  333. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  334. package/data/script-api/dw.io.md +0 -21
  335. package/data/script-api/dw.job.JobExecution.md +0 -111
  336. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  337. package/data/script-api/dw.job.md +0 -7
  338. package/data/script-api/dw.net.FTPClient.md +0 -621
  339. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  340. package/data/script-api/dw.net.HTTPClient.md +0 -775
  341. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  342. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  343. package/data/script-api/dw.net.Mail.md +0 -487
  344. package/data/script-api/dw.net.SFTPClient.md +0 -535
  345. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  346. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  347. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  348. package/data/script-api/dw.net.md +0 -15
  349. package/data/script-api/dw.object.ActiveData.md +0 -86
  350. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  351. package/data/script-api/dw.object.CustomObject.md +0 -82
  352. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  353. package/data/script-api/dw.object.Extensible.md +0 -71
  354. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  355. package/data/script-api/dw.object.Note.md +0 -118
  356. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  357. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  358. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  359. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  360. package/data/script-api/dw.object.PersistentObject.md +0 -92
  361. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  362. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  363. package/data/script-api/dw.object.md +0 -19
  364. package/data/script-api/dw.order.AbstractItem.md +0 -220
  365. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  366. package/data/script-api/dw.order.Appeasement.md +0 -398
  367. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  368. package/data/script-api/dw.order.Basket.md +0 -868
  369. package/data/script-api/dw.order.BasketMgr.md +0 -673
  370. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  371. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  372. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  373. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  374. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  375. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  376. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  377. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  378. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  379. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  380. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  381. package/data/script-api/dw.order.Invoice.md +0 -571
  382. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  383. package/data/script-api/dw.order.LineItem.md +0 -577
  384. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  385. package/data/script-api/dw.order.LineItemTax.md +0 -142
  386. package/data/script-api/dw.order.Order.md +0 -2770
  387. package/data/script-api/dw.order.OrderAddress.md +0 -624
  388. package/data/script-api/dw.order.OrderItem.md +0 -613
  389. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  390. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  391. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  392. package/data/script-api/dw.order.PaymentCard.md +0 -220
  393. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  394. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  395. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  396. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  397. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  398. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  399. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  400. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  401. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  402. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  403. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  404. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  405. package/data/script-api/dw.order.Return.md +0 -396
  406. package/data/script-api/dw.order.ReturnCase.md +0 -463
  407. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  408. package/data/script-api/dw.order.ReturnItem.md +0 -335
  409. package/data/script-api/dw.order.Shipment.md +0 -1132
  410. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  411. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  412. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  413. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  414. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  415. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  416. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  417. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  418. package/data/script-api/dw.order.SumItem.md +0 -158
  419. package/data/script-api/dw.order.TaxGroup.md +0 -128
  420. package/data/script-api/dw.order.TaxItem.md +0 -74
  421. package/data/script-api/dw.order.TaxMgr.md +0 -314
  422. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  423. package/data/script-api/dw.order.TrackingRef.md +0 -108
  424. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  425. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  426. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  427. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  428. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  429. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  430. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  431. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  432. package/data/script-api/dw.order.hooks.md +0 -13
  433. package/data/script-api/dw.order.md +0 -65
  434. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  435. package/data/script-api/dw.rpc.Stub.md +0 -373
  436. package/data/script-api/dw.rpc.WebReference.md +0 -133
  437. package/data/script-api/dw.rpc.md +0 -8
  438. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  439. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  440. package/data/script-api/dw.sitemap.md +0 -7
  441. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  442. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  443. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  444. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  445. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  446. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  447. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  448. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  449. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  450. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  451. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  452. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  453. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  454. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  455. package/data/script-api/dw.suggest.md +0 -19
  456. package/data/script-api/dw.svc.FTPService.md +0 -140
  457. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  458. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  459. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  460. package/data/script-api/dw.svc.HTTPService.md +0 -370
  461. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  462. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  463. package/data/script-api/dw.svc.Result.md +0 -320
  464. package/data/script-api/dw.svc.SOAPService.md +0 -104
  465. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  466. package/data/script-api/dw.svc.Service.md +0 -276
  467. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  468. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  469. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  470. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  471. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  472. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  473. package/data/script-api/dw.svc.md +0 -22
  474. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  475. package/data/script-api/dw.system.Cache.md +0 -126
  476. package/data/script-api/dw.system.CacheMgr.md +0 -70
  477. package/data/script-api/dw.system.HookMgr.md +0 -78
  478. package/data/script-api/dw.system.InternalObject.md +0 -47
  479. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  480. package/data/script-api/dw.system.Log.md +0 -198
  481. package/data/script-api/dw.system.LogNDC.md +0 -75
  482. package/data/script-api/dw.system.Logger.md +0 -216
  483. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  484. package/data/script-api/dw.system.Pipeline.md +0 -94
  485. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  486. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  487. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  488. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  489. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  490. package/data/script-api/dw.system.Request.md +0 -785
  491. package/data/script-api/dw.system.RequestHooks.md +0 -112
  492. package/data/script-api/dw.system.Response.md +0 -612
  493. package/data/script-api/dw.system.SearchStatus.md +0 -187
  494. package/data/script-api/dw.system.Session.md +0 -469
  495. package/data/script-api/dw.system.Site.md +0 -570
  496. package/data/script-api/dw.system.SitePreferences.md +0 -90
  497. package/data/script-api/dw.system.Status.md +0 -330
  498. package/data/script-api/dw.system.StatusItem.md +0 -273
  499. package/data/script-api/dw.system.System.md +0 -224
  500. package/data/script-api/dw.system.Transaction.md +0 -107
  501. package/data/script-api/dw.system.md +0 -32
  502. package/data/script-api/dw.template.ISML.md +0 -127
  503. package/data/script-api/dw.template.Velocity.md +0 -168
  504. package/data/script-api/dw.template.md +0 -7
  505. package/data/script-api/dw.util.ArrayList.md +0 -99
  506. package/data/script-api/dw.util.Assert.md +0 -370
  507. package/data/script-api/dw.util.BigInteger.md +0 -283
  508. package/data/script-api/dw.util.Bytes.md +0 -278
  509. package/data/script-api/dw.util.Calendar.md +0 -1051
  510. package/data/script-api/dw.util.Collection.md +0 -272
  511. package/data/script-api/dw.util.Currency.md +0 -147
  512. package/data/script-api/dw.util.DateUtils.md +0 -82
  513. package/data/script-api/dw.util.Decimal.md +0 -386
  514. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  515. package/data/script-api/dw.util.Geolocation.md +0 -293
  516. package/data/script-api/dw.util.HashMap.md +0 -50
  517. package/data/script-api/dw.util.HashSet.md +0 -65
  518. package/data/script-api/dw.util.Iterator.md +0 -86
  519. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  520. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  521. package/data/script-api/dw.util.List.md +0 -429
  522. package/data/script-api/dw.util.Locale.md +0 -277
  523. package/data/script-api/dw.util.Map.md +0 -251
  524. package/data/script-api/dw.util.MapEntry.md +0 -68
  525. package/data/script-api/dw.util.MappingKey.md +0 -96
  526. package/data/script-api/dw.util.MappingMgr.md +0 -113
  527. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  528. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  529. package/data/script-api/dw.util.SecureFilter.md +0 -572
  530. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  531. package/data/script-api/dw.util.Set.md +0 -39
  532. package/data/script-api/dw.util.SortedMap.md +0 -148
  533. package/data/script-api/dw.util.SortedSet.md +0 -173
  534. package/data/script-api/dw.util.StringUtils.md +0 -655
  535. package/data/script-api/dw.util.Template.md +0 -141
  536. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  537. package/data/script-api/dw.util.md +0 -37
  538. package/data/script-api/dw.value.EnumValue.md +0 -105
  539. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  540. package/data/script-api/dw.value.Money.md +0 -526
  541. package/data/script-api/dw.value.Quantity.md +0 -299
  542. package/data/script-api/dw.value.md +0 -9
  543. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  544. package/data/script-api/dw.web.ClickStream.md +0 -177
  545. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  546. package/data/script-api/dw.web.Cookie.md +0 -431
  547. package/data/script-api/dw.web.Cookies.md +0 -59
  548. package/data/script-api/dw.web.Form.md +0 -84
  549. package/data/script-api/dw.web.FormAction.md +0 -195
  550. package/data/script-api/dw.web.FormElement.md +0 -211
  551. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  552. package/data/script-api/dw.web.FormField.md +0 -642
  553. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  554. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  555. package/data/script-api/dw.web.FormGroup.md +0 -222
  556. package/data/script-api/dw.web.FormList.md +0 -134
  557. package/data/script-api/dw.web.FormListItem.md +0 -57
  558. package/data/script-api/dw.web.Forms.md +0 -25
  559. package/data/script-api/dw.web.HttpParameter.md +0 -462
  560. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  561. package/data/script-api/dw.web.LoopIterator.md +0 -231
  562. package/data/script-api/dw.web.PageMetaData.md +0 -197
  563. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  564. package/data/script-api/dw.web.PagingModel.md +0 -407
  565. package/data/script-api/dw.web.Resource.md +0 -147
  566. package/data/script-api/dw.web.URL.md +0 -174
  567. package/data/script-api/dw.web.URLAction.md +0 -95
  568. package/data/script-api/dw.web.URLParameter.md +0 -52
  569. package/data/script-api/dw.web.URLRedirect.md +0 -72
  570. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  571. package/data/script-api/dw.web.URLUtils.md +0 -1357
  572. package/data/script-api/dw.web.md +0 -34
  573. package/data/script-api/dw.ws.Port.md +0 -126
  574. package/data/script-api/dw.ws.WSUtil.md +0 -728
  575. package/data/script-api/dw.ws.WebReference2.md +0 -137
  576. package/data/script-api/dw.ws.md +0 -8
  577. package/data/script-api/index.md +0 -40
@@ -1,1343 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class FacebookProduct
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.extensions.facebook.FacebookProduct](dw.extensions.facebook.FacebookProduct.md)
6
-
7
- Represents a row in the Facebook catalog feed export.
8
-
9
-
10
- ## Constant Summary
11
-
12
- | Constant | Description |
13
- | --- | --- |
14
- | [AGE_GROUP_ADULT](#age_group_adult): [String](TopLevel.String.md) = "adult" | Indicates that the product is for adults. |
15
- | [AGE_GROUP_INFANT](#age_group_infant): [String](TopLevel.String.md) = "infant" | Indicates that the product is for infant children. |
16
- | [AGE_GROUP_KIDS](#age_group_kids): [String](TopLevel.String.md) = "kids" | Indicates that the product is for children. |
17
- | [AGE_GROUP_NEWBORN](#age_group_newborn): [String](TopLevel.String.md) = "newborn" | Indicates that the product is for newborn children. |
18
- | [AGE_GROUP_TODDLER](#age_group_toddler): [String](TopLevel.String.md) = "toddler" | Indicates that the product is for toddler children. |
19
- | [AVAILABILITY_AVAILABLE_FOR_ORDER](#availability_available_for_order): [String](TopLevel.String.md) = "available for order" | Indicates that the product can be ordered for later shipment. |
20
- | [AVAILABILITY_IN_STOCK](#availability_in_stock): [String](TopLevel.String.md) = "in stock" | Indicates that the product is available to ship immediately. |
21
- | [AVAILABILITY_OUT_OF_STOCK](#availability_out_of_stock): [String](TopLevel.String.md) = "out of stock" | Indicates that the product is out of stock. |
22
- | [AVAILABILITY_PREORDER](#availability_preorder): [String](TopLevel.String.md) = "preorder" | Indicates that the product will be available in the future. |
23
- | [CONDITION_NEW](#condition_new): [String](TopLevel.String.md) = "new" | Indicates that the product is new. |
24
- | [CONDITION_REFURBISHED](#condition_refurbished): [String](TopLevel.String.md) = "refurbished" | Indicates that the product is used but has been refurbished. |
25
- | [CONDITION_USED](#condition_used): [String](TopLevel.String.md) = "used" | Indicates that the product has been used. |
26
- | [GENDER_FEMALE](#gender_female): [String](TopLevel.String.md) = "female" | Indicates that the product is for females. |
27
- | [GENDER_MALE](#gender_male): [String](TopLevel.String.md) = "male" | Indicates that the product is for males. |
28
- | [GENDER_UNISEX](#gender_unisex): [String](TopLevel.String.md) = "unisex" | Indicates that the product is for both males and females. |
29
- | [SHIPPING_SIZE_UNIT_CM](#shipping_size_unit_cm): [String](TopLevel.String.md) = "cm" | Indicates that the product is measured in centimeters. |
30
- | [SHIPPING_SIZE_UNIT_FT](#shipping_size_unit_ft): [String](TopLevel.String.md) = "ft" | Indicates that the product is measured in feet. |
31
- | [SHIPPING_SIZE_UNIT_IN](#shipping_size_unit_in): [String](TopLevel.String.md) = "in" | Indicates that the product is measured in inches. |
32
- | [SHIPPING_SIZE_UNIT_M](#shipping_size_unit_m): [String](TopLevel.String.md) = "m" | Indicates that the product is measured in meters. |
33
- | [SHIPPING_WEIGHT_UNIT_G](#shipping_weight_unit_g): [String](TopLevel.String.md) = "g" | Indicates that the product is weighed in grams. |
34
- | [SHIPPING_WEIGHT_UNIT_KG](#shipping_weight_unit_kg): [String](TopLevel.String.md) = "kg" | Indicates that the product is weighed in kilograms. |
35
- | [SHIPPING_WEIGHT_UNIT_LB](#shipping_weight_unit_lb): [String](TopLevel.String.md) = "lb" | Indicates that the product is weighed in pounds. |
36
- | [SHIPPING_WEIGHT_UNIT_OZ](#shipping_weight_unit_oz): [String](TopLevel.String.md) = "oz" | Indicates that the product is weighed in ounces. |
37
-
38
- ## Property Summary
39
-
40
- | Property | Description |
41
- | --- | --- |
42
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the Facebook product. |
43
- | [ageGroup](#agegroup): [String](TopLevel.String.md) | Returns the age group for the Facebook product. |
44
- | [availability](#availability): [String](TopLevel.String.md) | Returns the availability of the Facebook product. |
45
- | [brand](#brand): [String](TopLevel.String.md) | Returns the Facebook brand of the product. |
46
- | [color](#color): [String](TopLevel.String.md) | Returns the Facebook color value label of the product. |
47
- | [condition](#condition): [String](TopLevel.String.md) | Returns the condition of the Facebook product. |
48
- | [customLabel0](#customlabel0): [String](TopLevel.String.md) | Returns the Facebook custom label 0 value of the product. |
49
- | [customLabel1](#customlabel1): [String](TopLevel.String.md) | Returns the Facebook custom label 1 value of the product. |
50
- | [customLabel2](#customlabel2): [String](TopLevel.String.md) | Returns the Facebook custom label 2 value of the product. |
51
- | [customLabel3](#customlabel3): [String](TopLevel.String.md) | Returns the Facebook custom label 3 value of the product. |
52
- | [customLabel4](#customlabel4): [String](TopLevel.String.md) | Returns the Facebook custom label 4 value of the product. |
53
- | [description](#description): [String](TopLevel.String.md) | Returns the description of the Facebook product. |
54
- | [expirationDate](#expirationdate): [Date](TopLevel.Date.md) | Returns the Facebook expiration date of the product. |
55
- | [gender](#gender): [String](TopLevel.String.md) | Returns the gender for the Facebook product. |
56
- | [googleProductCategory](#googleproductcategory): [String](TopLevel.String.md) | Returns the category of this product in the Google category taxonomy. |
57
- | [gtin](#gtin): [String](TopLevel.String.md) | Returns the Facebook GTIN of the product. |
58
- | [imageLinks](#imagelinks): [List](dw.util.List.md) | Returns a list containing the URLs of the images to show in Facebook for the product. |
59
- | [itemGroupID](#itemgroupid): [String](TopLevel.String.md) | Returns the ID of the Facebook item group for the product, that is, its master product. |
60
- | [link](#link): [URL](dw.web.URL.md) | Returns the URL of the Demandware storefront link to the product. |
61
- | [material](#material): [String](TopLevel.String.md) | Returns the Facebook material value label of the product. |
62
- | [mpn](#mpn): [String](TopLevel.String.md) | Returns the Facebook MPN of the product. |
63
- | [pattern](#pattern): [String](TopLevel.String.md) | Returns the Facebook pattern value label of the product. |
64
- | [price](#price): [Money](dw.value.Money.md) | Returns the price to show in Facebook for the product. |
65
- | [productType](#producttype): [String](TopLevel.String.md) | Returns the Facebook product type. |
66
- | [salePrice](#saleprice): [Money](dw.value.Money.md) | Returns the sale price to show in Facebook for the product. |
67
- | [salePriceEffectiveDateEnd](#salepriceeffectivedateend): [Date](TopLevel.Date.md) | Returns the end date of the Facebook sale price of the product. |
68
- | [salePriceEffectiveDateStart](#salepriceeffectivedatestart): [Date](TopLevel.Date.md) | Returns the start date of the Facebook sale price of the product. |
69
- | [shippingHeight](#shippingheight): [Number](TopLevel.Number.md) | Returns the shipping height of the product. |
70
- | [shippingLength](#shippinglength): [Number](TopLevel.Number.md) | Returns the shipping length of the product. |
71
- | [shippingSizeUnit](#shippingsizeunit): [String](TopLevel.String.md) | Returns the shipping size unit of the product. |
72
- | [shippingWeight](#shippingweight): [Quantity](dw.value.Quantity.md) | Returns the shipping weight for the product. |
73
- | [shippingWidth](#shippingwidth): [Number](TopLevel.Number.md) | Returns the shipping width of the product. |
74
- | [size](#size): [String](TopLevel.String.md) | Returns the Facebook size value label of the product. |
75
- | [title](#title): [String](TopLevel.String.md) | Returns the title of the Facebook product. |
76
-
77
- ## Constructor Summary
78
-
79
- This class does not have a constructor, so you cannot create it directly.
80
- ## Method Summary
81
-
82
- | Method | Description |
83
- | --- | --- |
84
- | [getAgeGroup](dw.extensions.facebook.FacebookProduct.md#getagegroup)() | Returns the age group for the Facebook product. |
85
- | [getAvailability](dw.extensions.facebook.FacebookProduct.md#getavailability)() | Returns the availability of the Facebook product. |
86
- | [getBrand](dw.extensions.facebook.FacebookProduct.md#getbrand)() | Returns the Facebook brand of the product. |
87
- | [getColor](dw.extensions.facebook.FacebookProduct.md#getcolor)() | Returns the Facebook color value label of the product. |
88
- | [getCondition](dw.extensions.facebook.FacebookProduct.md#getcondition)() | Returns the condition of the Facebook product. |
89
- | [getCustomLabel0](dw.extensions.facebook.FacebookProduct.md#getcustomlabel0)() | Returns the Facebook custom label 0 value of the product. |
90
- | [getCustomLabel1](dw.extensions.facebook.FacebookProduct.md#getcustomlabel1)() | Returns the Facebook custom label 1 value of the product. |
91
- | [getCustomLabel2](dw.extensions.facebook.FacebookProduct.md#getcustomlabel2)() | Returns the Facebook custom label 2 value of the product. |
92
- | [getCustomLabel3](dw.extensions.facebook.FacebookProduct.md#getcustomlabel3)() | Returns the Facebook custom label 3 value of the product. |
93
- | [getCustomLabel4](dw.extensions.facebook.FacebookProduct.md#getcustomlabel4)() | Returns the Facebook custom label 4 value of the product. |
94
- | [getDescription](dw.extensions.facebook.FacebookProduct.md#getdescription)() | Returns the description of the Facebook product. |
95
- | [getExpirationDate](dw.extensions.facebook.FacebookProduct.md#getexpirationdate)() | Returns the Facebook expiration date of the product. |
96
- | [getGender](dw.extensions.facebook.FacebookProduct.md#getgender)() | Returns the gender for the Facebook product. |
97
- | [getGoogleProductCategory](dw.extensions.facebook.FacebookProduct.md#getgoogleproductcategory)() | Returns the category of this product in the Google category taxonomy. |
98
- | [getGtin](dw.extensions.facebook.FacebookProduct.md#getgtin)() | Returns the Facebook GTIN of the product. |
99
- | [getID](dw.extensions.facebook.FacebookProduct.md#getid)() | Returns the ID of the Facebook product. |
100
- | [getImageLinks](dw.extensions.facebook.FacebookProduct.md#getimagelinks)() | Returns a list containing the URLs of the images to show in Facebook for the product. |
101
- | [getItemGroupID](dw.extensions.facebook.FacebookProduct.md#getitemgroupid)() | Returns the ID of the Facebook item group for the product, that is, its master product. |
102
- | [getLink](dw.extensions.facebook.FacebookProduct.md#getlink)() | Returns the URL of the Demandware storefront link to the product. |
103
- | [getMaterial](dw.extensions.facebook.FacebookProduct.md#getmaterial)() | Returns the Facebook material value label of the product. |
104
- | [getMpn](dw.extensions.facebook.FacebookProduct.md#getmpn)() | Returns the Facebook MPN of the product. |
105
- | [getPattern](dw.extensions.facebook.FacebookProduct.md#getpattern)() | Returns the Facebook pattern value label of the product. |
106
- | [getPrice](dw.extensions.facebook.FacebookProduct.md#getprice)() | Returns the price to show in Facebook for the product. |
107
- | [getProductType](dw.extensions.facebook.FacebookProduct.md#getproducttype)() | Returns the Facebook product type. |
108
- | [getSalePrice](dw.extensions.facebook.FacebookProduct.md#getsaleprice)() | Returns the sale price to show in Facebook for the product. |
109
- | [getSalePriceEffectiveDateEnd](dw.extensions.facebook.FacebookProduct.md#getsalepriceeffectivedateend)() | Returns the end date of the Facebook sale price of the product. |
110
- | [getSalePriceEffectiveDateStart](dw.extensions.facebook.FacebookProduct.md#getsalepriceeffectivedatestart)() | Returns the start date of the Facebook sale price of the product. |
111
- | [getShippingHeight](dw.extensions.facebook.FacebookProduct.md#getshippingheight)() | Returns the shipping height of the product. |
112
- | [getShippingLength](dw.extensions.facebook.FacebookProduct.md#getshippinglength)() | Returns the shipping length of the product. |
113
- | [getShippingSizeUnit](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)() | Returns the shipping size unit of the product. |
114
- | [getShippingWeight](dw.extensions.facebook.FacebookProduct.md#getshippingweight)() | Returns the shipping weight for the product. |
115
- | [getShippingWidth](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)() | Returns the shipping width of the product. |
116
- | [getSize](dw.extensions.facebook.FacebookProduct.md#getsize)() | Returns the Facebook size value label of the product. |
117
- | [getTitle](dw.extensions.facebook.FacebookProduct.md#gettitle)() | Returns the title of the Facebook product. |
118
- | [setAgeGroup](dw.extensions.facebook.FacebookProduct.md#setagegroupstring)([String](TopLevel.String.md)) | Sets the age group for the Facebook product. |
119
- | [setAvailability](dw.extensions.facebook.FacebookProduct.md#setavailabilitystring)([String](TopLevel.String.md)) | Sets the availability of the Facebook product. |
120
- | [setBrand](dw.extensions.facebook.FacebookProduct.md#setbrandstring)([String](TopLevel.String.md)) | Sets the Facebook brand of the product. |
121
- | [setColor](dw.extensions.facebook.FacebookProduct.md#setcolorstring)([String](TopLevel.String.md)) | Sets the Facebook color value label of the product. |
122
- | [setCondition](dw.extensions.facebook.FacebookProduct.md#setconditionstring)([String](TopLevel.String.md)) | Sets the condition of the Facebook product. |
123
- | [setCustomLabel0](dw.extensions.facebook.FacebookProduct.md#setcustomlabel0string)([String](TopLevel.String.md)) | Sets the Facebook custom label 0 value of the product. |
124
- | [setCustomLabel1](dw.extensions.facebook.FacebookProduct.md#setcustomlabel1string)([String](TopLevel.String.md)) | Sets the Facebook custom label 1 value of the product. |
125
- | [setCustomLabel2](dw.extensions.facebook.FacebookProduct.md#setcustomlabel2string)([String](TopLevel.String.md)) | Sets the Facebook custom label 2 value of the product. |
126
- | [setCustomLabel3](dw.extensions.facebook.FacebookProduct.md#setcustomlabel3string)([String](TopLevel.String.md)) | Sets the Facebook custom label 3 value of the product. |
127
- | [setCustomLabel4](dw.extensions.facebook.FacebookProduct.md#setcustomlabel4string)([String](TopLevel.String.md)) | Sets the Facebook custom label 4 value of the product. |
128
- | [setDescription](dw.extensions.facebook.FacebookProduct.md#setdescriptionstring)([String](TopLevel.String.md)) | Sets the description of the Facebook product. |
129
- | [setExpirationDate](dw.extensions.facebook.FacebookProduct.md#setexpirationdatedate)([Date](TopLevel.Date.md)) | Sets the Facebook expiration date of the product. |
130
- | [setGender](dw.extensions.facebook.FacebookProduct.md#setgenderstring)([String](TopLevel.String.md)) | Sets the gender for the Facebook product. |
131
- | [setGoogleProductCategory](dw.extensions.facebook.FacebookProduct.md#setgoogleproductcategorystring)([String](TopLevel.String.md)) | Sets the category of this product in the Google category taxonomy. |
132
- | [setGtin](dw.extensions.facebook.FacebookProduct.md#setgtinstring)([String](TopLevel.String.md)) | Sets the Facebook GTIN of the product. |
133
- | [setImageLinks](dw.extensions.facebook.FacebookProduct.md#setimagelinkslist)([List](dw.util.List.md)) | Sets the list of URLs of images to show in Facebook for the product. |
134
- | [setItemGroupID](dw.extensions.facebook.FacebookProduct.md#setitemgroupidstring)([String](TopLevel.String.md)) | Sets the ID of the Facebook item group for the product, that is, its master product. |
135
- | [setLink](dw.extensions.facebook.FacebookProduct.md#setlinkurl)([URL](dw.web.URL.md)) | Sets the URL of the Demandware storefront link to the product. |
136
- | [setMaterial](dw.extensions.facebook.FacebookProduct.md#setmaterialstring)([String](TopLevel.String.md)) | Sets the Facebook material value label of the product. |
137
- | [setMpn](dw.extensions.facebook.FacebookProduct.md#setmpnstring)([String](TopLevel.String.md)) | Sets the Facebook MPN of the product. |
138
- | [setPattern](dw.extensions.facebook.FacebookProduct.md#setpatternstring)([String](TopLevel.String.md)) | Sets the Facebook pattern value label of the product. |
139
- | [setPrice](dw.extensions.facebook.FacebookProduct.md#setpricemoney)([Money](dw.value.Money.md)) | Sets the price to show in Facebook for the product. |
140
- | [setProductType](dw.extensions.facebook.FacebookProduct.md#setproducttypestring)([String](TopLevel.String.md)) | Sets the Facebook product type. |
141
- | [setSalePrice](dw.extensions.facebook.FacebookProduct.md#setsalepricemoney)([Money](dw.value.Money.md)) | Sets the sale price to show in Facebook for the product. |
142
- | [setSalePriceEffectiveDateEnd](dw.extensions.facebook.FacebookProduct.md#setsalepriceeffectivedateenddate)([Date](TopLevel.Date.md)) | Sets the end date of the Facebook sale price of the product. |
143
- | [setSalePriceEffectiveDateStart](dw.extensions.facebook.FacebookProduct.md#setsalepriceeffectivedatestartdate)([Date](TopLevel.Date.md)) | Sets the start date of the Facebook sale price of the product. |
144
- | [setShippingHeight](dw.extensions.facebook.FacebookProduct.md#setshippingheightnumber)([Number](TopLevel.Number.md)) | Sets the shipping height of the product. |
145
- | [setShippingLength](dw.extensions.facebook.FacebookProduct.md#setshippinglengthnumber)([Number](TopLevel.Number.md)) | Sets the shipping length of the product. |
146
- | [setShippingSizeUnit](dw.extensions.facebook.FacebookProduct.md#setshippingsizeunitstring)([String](TopLevel.String.md)) | Sets the shipping size unit of the product. |
147
- | [setShippingWeight](dw.extensions.facebook.FacebookProduct.md#setshippingweightquantity)([Quantity](dw.value.Quantity.md)) | Sets the shipping weight for the product. |
148
- | [setShippingWidth](dw.extensions.facebook.FacebookProduct.md#setshippingwidthnumber)([Number](TopLevel.Number.md)) | Sets the shipping width of the product. |
149
- | [setSize](dw.extensions.facebook.FacebookProduct.md#setsizestring)([String](TopLevel.String.md)) | Sets the Facebook size value label of the product. |
150
- | [setTitle](dw.extensions.facebook.FacebookProduct.md#settitlestring)([String](TopLevel.String.md)) | Sets the title of the Facebook product. |
151
-
152
- ### Methods inherited from class Object
153
-
154
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
155
- ## Constant Details
156
-
157
- ### AGE_GROUP_ADULT
158
-
159
- - AGE_GROUP_ADULT: [String](TopLevel.String.md) = "adult"
160
- - : Indicates that the product is for adults.
161
-
162
-
163
- ---
164
-
165
- ### AGE_GROUP_INFANT
166
-
167
- - AGE_GROUP_INFANT: [String](TopLevel.String.md) = "infant"
168
- - : Indicates that the product is for infant children.
169
-
170
-
171
- ---
172
-
173
- ### AGE_GROUP_KIDS
174
-
175
- - AGE_GROUP_KIDS: [String](TopLevel.String.md) = "kids"
176
- - : Indicates that the product is for children.
177
-
178
-
179
- ---
180
-
181
- ### AGE_GROUP_NEWBORN
182
-
183
- - AGE_GROUP_NEWBORN: [String](TopLevel.String.md) = "newborn"
184
- - : Indicates that the product is for newborn children.
185
-
186
-
187
- ---
188
-
189
- ### AGE_GROUP_TODDLER
190
-
191
- - AGE_GROUP_TODDLER: [String](TopLevel.String.md) = "toddler"
192
- - : Indicates that the product is for toddler children.
193
-
194
-
195
- ---
196
-
197
- ### AVAILABILITY_AVAILABLE_FOR_ORDER
198
-
199
- - AVAILABILITY_AVAILABLE_FOR_ORDER: [String](TopLevel.String.md) = "available for order"
200
- - : Indicates that the product can be ordered for later shipment.
201
-
202
-
203
- ---
204
-
205
- ### AVAILABILITY_IN_STOCK
206
-
207
- - AVAILABILITY_IN_STOCK: [String](TopLevel.String.md) = "in stock"
208
- - : Indicates that the product is available to ship immediately.
209
-
210
-
211
- ---
212
-
213
- ### AVAILABILITY_OUT_OF_STOCK
214
-
215
- - AVAILABILITY_OUT_OF_STOCK: [String](TopLevel.String.md) = "out of stock"
216
- - : Indicates that the product is out of stock.
217
-
218
-
219
- ---
220
-
221
- ### AVAILABILITY_PREORDER
222
-
223
- - AVAILABILITY_PREORDER: [String](TopLevel.String.md) = "preorder"
224
- - : Indicates that the product will be available in the future.
225
-
226
-
227
- ---
228
-
229
- ### CONDITION_NEW
230
-
231
- - CONDITION_NEW: [String](TopLevel.String.md) = "new"
232
- - : Indicates that the product is new.
233
-
234
-
235
- ---
236
-
237
- ### CONDITION_REFURBISHED
238
-
239
- - CONDITION_REFURBISHED: [String](TopLevel.String.md) = "refurbished"
240
- - : Indicates that the product is used but has been refurbished.
241
-
242
-
243
- ---
244
-
245
- ### CONDITION_USED
246
-
247
- - CONDITION_USED: [String](TopLevel.String.md) = "used"
248
- - : Indicates that the product has been used.
249
-
250
-
251
- ---
252
-
253
- ### GENDER_FEMALE
254
-
255
- - GENDER_FEMALE: [String](TopLevel.String.md) = "female"
256
- - : Indicates that the product is for females.
257
-
258
-
259
- ---
260
-
261
- ### GENDER_MALE
262
-
263
- - GENDER_MALE: [String](TopLevel.String.md) = "male"
264
- - : Indicates that the product is for males.
265
-
266
-
267
- ---
268
-
269
- ### GENDER_UNISEX
270
-
271
- - GENDER_UNISEX: [String](TopLevel.String.md) = "unisex"
272
- - : Indicates that the product is for both males and females.
273
-
274
-
275
- ---
276
-
277
- ### SHIPPING_SIZE_UNIT_CM
278
-
279
- - SHIPPING_SIZE_UNIT_CM: [String](TopLevel.String.md) = "cm"
280
- - : Indicates that the product is measured in centimeters.
281
-
282
-
283
- ---
284
-
285
- ### SHIPPING_SIZE_UNIT_FT
286
-
287
- - SHIPPING_SIZE_UNIT_FT: [String](TopLevel.String.md) = "ft"
288
- - : Indicates that the product is measured in feet.
289
-
290
-
291
- ---
292
-
293
- ### SHIPPING_SIZE_UNIT_IN
294
-
295
- - SHIPPING_SIZE_UNIT_IN: [String](TopLevel.String.md) = "in"
296
- - : Indicates that the product is measured in inches.
297
-
298
-
299
- ---
300
-
301
- ### SHIPPING_SIZE_UNIT_M
302
-
303
- - SHIPPING_SIZE_UNIT_M: [String](TopLevel.String.md) = "m"
304
- - : Indicates that the product is measured in meters.
305
-
306
-
307
- ---
308
-
309
- ### SHIPPING_WEIGHT_UNIT_G
310
-
311
- - SHIPPING_WEIGHT_UNIT_G: [String](TopLevel.String.md) = "g"
312
- - : Indicates that the product is weighed in grams.
313
-
314
-
315
- ---
316
-
317
- ### SHIPPING_WEIGHT_UNIT_KG
318
-
319
- - SHIPPING_WEIGHT_UNIT_KG: [String](TopLevel.String.md) = "kg"
320
- - : Indicates that the product is weighed in kilograms.
321
-
322
-
323
- ---
324
-
325
- ### SHIPPING_WEIGHT_UNIT_LB
326
-
327
- - SHIPPING_WEIGHT_UNIT_LB: [String](TopLevel.String.md) = "lb"
328
- - : Indicates that the product is weighed in pounds.
329
-
330
-
331
- ---
332
-
333
- ### SHIPPING_WEIGHT_UNIT_OZ
334
-
335
- - SHIPPING_WEIGHT_UNIT_OZ: [String](TopLevel.String.md) = "oz"
336
- - : Indicates that the product is weighed in ounces.
337
-
338
-
339
- ---
340
-
341
- ## Property Details
342
-
343
- ### ID
344
- - ID: [String](TopLevel.String.md) `(read-only)`
345
- - : Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.
346
-
347
-
348
- ---
349
-
350
- ### ageGroup
351
- - ageGroup: [String](TopLevel.String.md)
352
- - : Returns the age group for the Facebook product.
353
-
354
-
355
- ---
356
-
357
- ### availability
358
- - availability: [String](TopLevel.String.md)
359
- - : Returns the availability of the Facebook product.
360
-
361
-
362
- ---
363
-
364
- ### brand
365
- - brand: [String](TopLevel.String.md)
366
- - : Returns the Facebook brand of the product.
367
-
368
-
369
- ---
370
-
371
- ### color
372
- - color: [String](TopLevel.String.md)
373
- - : Returns the Facebook color value label of the product.
374
-
375
-
376
- ---
377
-
378
- ### condition
379
- - condition: [String](TopLevel.String.md)
380
- - : Returns the condition of the Facebook product.
381
-
382
-
383
- ---
384
-
385
- ### customLabel0
386
- - customLabel0: [String](TopLevel.String.md)
387
- - : Returns the Facebook custom label 0 value of the product.
388
-
389
-
390
- ---
391
-
392
- ### customLabel1
393
- - customLabel1: [String](TopLevel.String.md)
394
- - : Returns the Facebook custom label 1 value of the product.
395
-
396
-
397
- ---
398
-
399
- ### customLabel2
400
- - customLabel2: [String](TopLevel.String.md)
401
- - : Returns the Facebook custom label 2 value of the product.
402
-
403
-
404
- ---
405
-
406
- ### customLabel3
407
- - customLabel3: [String](TopLevel.String.md)
408
- - : Returns the Facebook custom label 3 value of the product.
409
-
410
-
411
- ---
412
-
413
- ### customLabel4
414
- - customLabel4: [String](TopLevel.String.md)
415
- - : Returns the Facebook custom label 4 value of the product.
416
-
417
-
418
- ---
419
-
420
- ### description
421
- - description: [String](TopLevel.String.md)
422
- - : Returns the description of the Facebook product.
423
-
424
-
425
- ---
426
-
427
- ### expirationDate
428
- - expirationDate: [Date](TopLevel.Date.md)
429
- - : Returns the Facebook expiration date of the product. If the product is expired it will not be shown.
430
-
431
-
432
- ---
433
-
434
- ### gender
435
- - gender: [String](TopLevel.String.md)
436
- - : Returns the gender for the Facebook product.
437
-
438
-
439
- ---
440
-
441
- ### googleProductCategory
442
- - googleProductCategory: [String](TopLevel.String.md)
443
- - : Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters
444
- it is truncated.
445
-
446
-
447
-
448
- ---
449
-
450
- ### gtin
451
- - gtin: [String](TopLevel.String.md)
452
- - : Returns the Facebook GTIN of the product.
453
-
454
-
455
- ---
456
-
457
- ### imageLinks
458
- - imageLinks: [List](dw.util.List.md)
459
- - : Returns a list containing the URLs of the images to show in Facebook for the product.
460
-
461
-
462
- ---
463
-
464
- ### itemGroupID
465
- - itemGroupID: [String](TopLevel.String.md)
466
- - : Returns the ID of the Facebook item group for the product, that is, its master product.
467
-
468
-
469
- ---
470
-
471
- ### link
472
- - link: [URL](dw.web.URL.md)
473
- - : Returns the URL of the Demandware storefront link to the product.
474
-
475
-
476
- ---
477
-
478
- ### material
479
- - material: [String](TopLevel.String.md)
480
- - : Returns the Facebook material value label of the product.
481
-
482
-
483
- ---
484
-
485
- ### mpn
486
- - mpn: [String](TopLevel.String.md)
487
- - : Returns the Facebook MPN of the product.
488
-
489
-
490
- ---
491
-
492
- ### pattern
493
- - pattern: [String](TopLevel.String.md)
494
- - : Returns the Facebook pattern value label of the product.
495
-
496
-
497
- ---
498
-
499
- ### price
500
- - price: [Money](dw.value.Money.md)
501
- - : Returns the price to show in Facebook for the product.
502
-
503
-
504
- ---
505
-
506
- ### productType
507
- - productType: [String](TopLevel.String.md)
508
- - : Returns the Facebook product type. This is the retailer-defined category of the item.
509
-
510
-
511
- ---
512
-
513
- ### salePrice
514
- - salePrice: [Money](dw.value.Money.md)
515
- - : Returns the sale price to show in Facebook for the product.
516
-
517
-
518
- ---
519
-
520
- ### salePriceEffectiveDateEnd
521
- - salePriceEffectiveDateEnd: [Date](TopLevel.Date.md)
522
- - : Returns the end date of the Facebook sale price of the product.
523
-
524
-
525
- ---
526
-
527
- ### salePriceEffectiveDateStart
528
- - salePriceEffectiveDateStart: [Date](TopLevel.Date.md)
529
- - : Returns the start date of the Facebook sale price of the product.
530
-
531
-
532
- ---
533
-
534
- ### shippingHeight
535
- - shippingHeight: [Number](TopLevel.Number.md)
536
- - : Returns the shipping height of the product.
537
-
538
- **See Also:**
539
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
540
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
541
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
542
-
543
-
544
- ---
545
-
546
- ### shippingLength
547
- - shippingLength: [Number](TopLevel.Number.md)
548
- - : Returns the shipping length of the product.
549
-
550
- **See Also:**
551
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
552
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
553
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
554
-
555
-
556
- ---
557
-
558
- ### shippingSizeUnit
559
- - shippingSizeUnit: [String](TopLevel.String.md)
560
- - : Returns the shipping size unit of the product.
561
-
562
- **See Also:**
563
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
564
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
565
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
566
-
567
-
568
- ---
569
-
570
- ### shippingWeight
571
- - shippingWeight: [Quantity](dw.value.Quantity.md)
572
- - : Returns the shipping weight for the product.
573
-
574
-
575
- ---
576
-
577
- ### shippingWidth
578
- - shippingWidth: [Number](TopLevel.Number.md)
579
- - : Returns the shipping width of the product.
580
-
581
- **See Also:**
582
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
583
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
584
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
585
-
586
-
587
- ---
588
-
589
- ### size
590
- - size: [String](TopLevel.String.md)
591
- - : Returns the Facebook size value label of the product.
592
-
593
-
594
- ---
595
-
596
- ### title
597
- - title: [String](TopLevel.String.md)
598
- - : Returns the title of the Facebook product.
599
-
600
-
601
- ---
602
-
603
- ## Method Details
604
-
605
- ### getAgeGroup()
606
- - getAgeGroup(): [String](TopLevel.String.md)
607
- - : Returns the age group for the Facebook product.
608
-
609
- **Returns:**
610
- - product age group
611
-
612
-
613
- ---
614
-
615
- ### getAvailability()
616
- - getAvailability(): [String](TopLevel.String.md)
617
- - : Returns the availability of the Facebook product.
618
-
619
- **Returns:**
620
- - product availability
621
-
622
-
623
- ---
624
-
625
- ### getBrand()
626
- - getBrand(): [String](TopLevel.String.md)
627
- - : Returns the Facebook brand of the product.
628
-
629
- **Returns:**
630
- - the brand
631
-
632
-
633
- ---
634
-
635
- ### getColor()
636
- - getColor(): [String](TopLevel.String.md)
637
- - : Returns the Facebook color value label of the product.
638
-
639
- **Returns:**
640
- - the color value label
641
-
642
-
643
- ---
644
-
645
- ### getCondition()
646
- - getCondition(): [String](TopLevel.String.md)
647
- - : Returns the condition of the Facebook product.
648
-
649
- **Returns:**
650
- - product condition
651
-
652
-
653
- ---
654
-
655
- ### getCustomLabel0()
656
- - getCustomLabel0(): [String](TopLevel.String.md)
657
- - : Returns the Facebook custom label 0 value of the product.
658
-
659
- **Returns:**
660
- - the custom label 0 value
661
-
662
-
663
- ---
664
-
665
- ### getCustomLabel1()
666
- - getCustomLabel1(): [String](TopLevel.String.md)
667
- - : Returns the Facebook custom label 1 value of the product.
668
-
669
- **Returns:**
670
- - the custom label 1 value
671
-
672
-
673
- ---
674
-
675
- ### getCustomLabel2()
676
- - getCustomLabel2(): [String](TopLevel.String.md)
677
- - : Returns the Facebook custom label 2 value of the product.
678
-
679
- **Returns:**
680
- - the custom label 2 value
681
-
682
-
683
- ---
684
-
685
- ### getCustomLabel3()
686
- - getCustomLabel3(): [String](TopLevel.String.md)
687
- - : Returns the Facebook custom label 3 value of the product.
688
-
689
- **Returns:**
690
- - the custom label 3 value
691
-
692
-
693
- ---
694
-
695
- ### getCustomLabel4()
696
- - getCustomLabel4(): [String](TopLevel.String.md)
697
- - : Returns the Facebook custom label 4 value of the product.
698
-
699
- **Returns:**
700
- - the custom label 4 value
701
-
702
-
703
- ---
704
-
705
- ### getDescription()
706
- - getDescription(): [String](TopLevel.String.md)
707
- - : Returns the description of the Facebook product.
708
-
709
- **Returns:**
710
- - product description
711
-
712
-
713
- ---
714
-
715
- ### getExpirationDate()
716
- - getExpirationDate(): [Date](TopLevel.Date.md)
717
- - : Returns the Facebook expiration date of the product. If the product is expired it will not be shown.
718
-
719
- **Returns:**
720
- - the expiration date
721
-
722
-
723
- ---
724
-
725
- ### getGender()
726
- - getGender(): [String](TopLevel.String.md)
727
- - : Returns the gender for the Facebook product.
728
-
729
- **Returns:**
730
- - product gender
731
-
732
-
733
- ---
734
-
735
- ### getGoogleProductCategory()
736
- - getGoogleProductCategory(): [String](TopLevel.String.md)
737
- - : Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters
738
- it is truncated.
739
-
740
-
741
- **Returns:**
742
- - the category of this product in the Google category taxonomy
743
-
744
-
745
- ---
746
-
747
- ### getGtin()
748
- - getGtin(): [String](TopLevel.String.md)
749
- - : Returns the Facebook GTIN of the product.
750
-
751
- **Returns:**
752
- - the GTIN
753
-
754
-
755
- ---
756
-
757
- ### getID()
758
- - getID(): [String](TopLevel.String.md)
759
- - : Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.
760
-
761
- **Returns:**
762
- - product ID
763
-
764
-
765
- ---
766
-
767
- ### getImageLinks()
768
- - getImageLinks(): [List](dw.util.List.md)
769
- - : Returns a list containing the URLs of the images to show in Facebook for the product.
770
-
771
- **Returns:**
772
- - the URLs of the images
773
-
774
-
775
- ---
776
-
777
- ### getItemGroupID()
778
- - getItemGroupID(): [String](TopLevel.String.md)
779
- - : Returns the ID of the Facebook item group for the product, that is, its master product.
780
-
781
- **Returns:**
782
- - the ID of the Facebook item group
783
-
784
-
785
- ---
786
-
787
- ### getLink()
788
- - getLink(): [URL](dw.web.URL.md)
789
- - : Returns the URL of the Demandware storefront link to the product.
790
-
791
- **Returns:**
792
- - the URL of the storefront link
793
-
794
-
795
- ---
796
-
797
- ### getMaterial()
798
- - getMaterial(): [String](TopLevel.String.md)
799
- - : Returns the Facebook material value label of the product.
800
-
801
- **Returns:**
802
- - the material value label
803
-
804
-
805
- ---
806
-
807
- ### getMpn()
808
- - getMpn(): [String](TopLevel.String.md)
809
- - : Returns the Facebook MPN of the product.
810
-
811
- **Returns:**
812
- - the MPN
813
-
814
-
815
- ---
816
-
817
- ### getPattern()
818
- - getPattern(): [String](TopLevel.String.md)
819
- - : Returns the Facebook pattern value label of the product.
820
-
821
- **Returns:**
822
- - the pattern value label
823
-
824
-
825
- ---
826
-
827
- ### getPrice()
828
- - getPrice(): [Money](dw.value.Money.md)
829
- - : Returns the price to show in Facebook for the product.
830
-
831
- **Returns:**
832
- - the price to show in Facebook
833
-
834
-
835
- ---
836
-
837
- ### getProductType()
838
- - getProductType(): [String](TopLevel.String.md)
839
- - : Returns the Facebook product type. This is the retailer-defined category of the item.
840
-
841
- **Returns:**
842
- - the Facebook product type
843
-
844
-
845
- ---
846
-
847
- ### getSalePrice()
848
- - getSalePrice(): [Money](dw.value.Money.md)
849
- - : Returns the sale price to show in Facebook for the product.
850
-
851
- **Returns:**
852
- - the sale price to show in Facebook
853
-
854
-
855
- ---
856
-
857
- ### getSalePriceEffectiveDateEnd()
858
- - getSalePriceEffectiveDateEnd(): [Date](TopLevel.Date.md)
859
- - : Returns the end date of the Facebook sale price of the product.
860
-
861
- **Returns:**
862
- - the end date of the Facebook sale price
863
-
864
-
865
- ---
866
-
867
- ### getSalePriceEffectiveDateStart()
868
- - getSalePriceEffectiveDateStart(): [Date](TopLevel.Date.md)
869
- - : Returns the start date of the Facebook sale price of the product.
870
-
871
- **Returns:**
872
- - the start date of the Facebook sale price
873
-
874
-
875
- ---
876
-
877
- ### getShippingHeight()
878
- - getShippingHeight(): [Number](TopLevel.Number.md)
879
- - : Returns the shipping height of the product.
880
-
881
- **Returns:**
882
- - the shipping height
883
-
884
- **See Also:**
885
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
886
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
887
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
888
-
889
-
890
- ---
891
-
892
- ### getShippingLength()
893
- - getShippingLength(): [Number](TopLevel.Number.md)
894
- - : Returns the shipping length of the product.
895
-
896
- **Returns:**
897
- - the shipping length
898
-
899
- **See Also:**
900
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
901
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
902
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
903
-
904
-
905
- ---
906
-
907
- ### getShippingSizeUnit()
908
- - getShippingSizeUnit(): [String](TopLevel.String.md)
909
- - : Returns the shipping size unit of the product.
910
-
911
- **Returns:**
912
- - the shipping size unit
913
-
914
- **See Also:**
915
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
916
- - [getShippingWidth()](dw.extensions.facebook.FacebookProduct.md#getshippingwidth)
917
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
918
-
919
-
920
- ---
921
-
922
- ### getShippingWeight()
923
- - getShippingWeight(): [Quantity](dw.value.Quantity.md)
924
- - : Returns the shipping weight for the product.
925
-
926
- **Returns:**
927
- - the shipping weight
928
-
929
-
930
- ---
931
-
932
- ### getShippingWidth()
933
- - getShippingWidth(): [Number](TopLevel.Number.md)
934
- - : Returns the shipping width of the product.
935
-
936
- **Returns:**
937
- - the shipping width
938
-
939
- **See Also:**
940
- - [getShippingLength()](dw.extensions.facebook.FacebookProduct.md#getshippinglength)
941
- - [getShippingHeight()](dw.extensions.facebook.FacebookProduct.md#getshippingheight)
942
- - [getShippingSizeUnit()](dw.extensions.facebook.FacebookProduct.md#getshippingsizeunit)
943
-
944
-
945
- ---
946
-
947
- ### getSize()
948
- - getSize(): [String](TopLevel.String.md)
949
- - : Returns the Facebook size value label of the product.
950
-
951
- **Returns:**
952
- - the size value label
953
-
954
-
955
- ---
956
-
957
- ### getTitle()
958
- - getTitle(): [String](TopLevel.String.md)
959
- - : Returns the title of the Facebook product.
960
-
961
- **Returns:**
962
- - product title
963
-
964
-
965
- ---
966
-
967
- ### setAgeGroup(String)
968
- - setAgeGroup(ageGroup: [String](TopLevel.String.md)): void
969
- - : Sets the age group for the Facebook product. Possible values are
970
- [AGE_GROUP_ADULT](dw.extensions.facebook.FacebookProduct.md#age_group_adult),
971
- [AGE_GROUP_INFANT](dw.extensions.facebook.FacebookProduct.md#age_group_infant),
972
- [AGE_GROUP_KIDS](dw.extensions.facebook.FacebookProduct.md#age_group_kids),
973
- [AGE_GROUP_NEWBORN](dw.extensions.facebook.FacebookProduct.md#age_group_newborn),
974
- [AGE_GROUP_TODDLER](dw.extensions.facebook.FacebookProduct.md#age_group_toddler), or `null`.
975
-
976
-
977
- **Parameters:**
978
- - ageGroup - the ageGroup to set for this product
979
-
980
-
981
- ---
982
-
983
- ### setAvailability(String)
984
- - setAvailability(availability: [String](TopLevel.String.md)): void
985
- - : Sets the availability of the Facebook product. Possible values are
986
- [AVAILABILITY_AVAILABLE_FOR_ORDER](dw.extensions.facebook.FacebookProduct.md#availability_available_for_order),
987
- [AVAILABILITY_IN_STOCK](dw.extensions.facebook.FacebookProduct.md#availability_in_stock),
988
- [AVAILABILITY_OUT_OF_STOCK](dw.extensions.facebook.FacebookProduct.md#availability_out_of_stock), or
989
- [AVAILABILITY_PREORDER](dw.extensions.facebook.FacebookProduct.md#availability_preorder)
990
-
991
-
992
- **Parameters:**
993
- - availability - the availability status to set for this product
994
-
995
-
996
- ---
997
-
998
- ### setBrand(String)
999
- - setBrand(brand: [String](TopLevel.String.md)): void
1000
- - : Sets the Facebook brand of the product. If the value is longer than 70 characters it is truncated.
1001
-
1002
- **Parameters:**
1003
- - brand - Facebook brand, up to 70 characters
1004
-
1005
-
1006
- ---
1007
-
1008
- ### setColor(String)
1009
- - setColor(color: [String](TopLevel.String.md)): void
1010
- - : Sets the Facebook color value label of the product. If the value is longer than 100 characters it is truncated.
1011
-
1012
- **Parameters:**
1013
- - color - Facebook color value label, up to 100 characters
1014
-
1015
-
1016
- ---
1017
-
1018
- ### setCondition(String)
1019
- - setCondition(condition: [String](TopLevel.String.md)): void
1020
- - : Sets the condition of the Facebook product. Possible values are
1021
- [CONDITION_NEW](dw.extensions.facebook.FacebookProduct.md#condition_new),
1022
- [CONDITION_REFURBISHED](dw.extensions.facebook.FacebookProduct.md#condition_refurbished), or
1023
- [CONDITION_USED](dw.extensions.facebook.FacebookProduct.md#condition_used).
1024
-
1025
-
1026
- **Parameters:**
1027
- - condition - the condition status to set for this product
1028
-
1029
-
1030
- ---
1031
-
1032
- ### setCustomLabel0(String)
1033
- - setCustomLabel0(customLabel0: [String](TopLevel.String.md)): void
1034
- - : Sets the Facebook custom label 0 value of the product.
1035
-
1036
- **Parameters:**
1037
- - customLabel0 - custom label 0 value
1038
-
1039
-
1040
- ---
1041
-
1042
- ### setCustomLabel1(String)
1043
- - setCustomLabel1(customLabel1: [String](TopLevel.String.md)): void
1044
- - : Sets the Facebook custom label 1 value of the product.
1045
-
1046
- **Parameters:**
1047
- - customLabel1 - custom label 1 value
1048
-
1049
-
1050
- ---
1051
-
1052
- ### setCustomLabel2(String)
1053
- - setCustomLabel2(customLabel2: [String](TopLevel.String.md)): void
1054
- - : Sets the Facebook custom label 2 value of the product.
1055
-
1056
- **Parameters:**
1057
- - customLabel2 - custom label 2 value
1058
-
1059
-
1060
- ---
1061
-
1062
- ### setCustomLabel3(String)
1063
- - setCustomLabel3(customLabel3: [String](TopLevel.String.md)): void
1064
- - : Sets the Facebook custom label 3 value of the product.
1065
-
1066
- **Parameters:**
1067
- - customLabel3 - custom label 3 value
1068
-
1069
-
1070
- ---
1071
-
1072
- ### setCustomLabel4(String)
1073
- - setCustomLabel4(customLabel4: [String](TopLevel.String.md)): void
1074
- - : Sets the Facebook custom label 4 value of the product.
1075
-
1076
- **Parameters:**
1077
- - customLabel4 - custom label 4 value
1078
-
1079
-
1080
- ---
1081
-
1082
- ### setDescription(String)
1083
- - setDescription(description: [String](TopLevel.String.md)): void
1084
- - : Sets the description of the Facebook product. If the value is longer than 5000 characters it is truncated.
1085
-
1086
- **Parameters:**
1087
- - description - product description, up to 5000 characters
1088
-
1089
-
1090
- ---
1091
-
1092
- ### setExpirationDate(Date)
1093
- - setExpirationDate(expirationDate: [Date](TopLevel.Date.md)): void
1094
- - : Sets the Facebook expiration date of the product.
1095
-
1096
- **Parameters:**
1097
- - expirationDate - Facebook expiration date
1098
-
1099
-
1100
- ---
1101
-
1102
- ### setGender(String)
1103
- - setGender(gender: [String](TopLevel.String.md)): void
1104
- - : Sets the gender for the Facebook product. Possible values are
1105
- [GENDER_MALE](dw.extensions.facebook.FacebookProduct.md#gender_male),
1106
- [GENDER_FEMALE](dw.extensions.facebook.FacebookProduct.md#gender_female),
1107
- [GENDER_UNISEX](dw.extensions.facebook.FacebookProduct.md#gender_unisex), or `null`.
1108
-
1109
-
1110
- **Parameters:**
1111
- - gender - the gender to set for this product
1112
-
1113
-
1114
- ---
1115
-
1116
- ### setGoogleProductCategory(String)
1117
- - setGoogleProductCategory(googleProductCategory: [String](TopLevel.String.md)): void
1118
- - : Sets the category of this product in the Google category taxonomy.
1119
-
1120
- **Parameters:**
1121
- - googleProductCategory - Google product category
1122
-
1123
-
1124
- ---
1125
-
1126
- ### setGtin(String)
1127
- - setGtin(gtin: [String](TopLevel.String.md)): void
1128
- - : Sets the Facebook GTIN of the product. If the value is longer than 70 characters it is truncated.
1129
-
1130
- **Parameters:**
1131
- - gtin - Facebook GTIN, up to 70 characters
1132
-
1133
-
1134
- ---
1135
-
1136
- ### setImageLinks(List)
1137
- - setImageLinks(imageLinks: [List](dw.util.List.md)): void
1138
- - : Sets the list of URLs of images to show in Facebook for the product.
1139
-
1140
- **Parameters:**
1141
- - imageLinks - links to the product images
1142
-
1143
-
1144
- ---
1145
-
1146
- ### setItemGroupID(String)
1147
- - setItemGroupID(itemGroupID: [String](TopLevel.String.md)): void
1148
- - : Sets the ID of the Facebook item group for the product, that is, its master product.
1149
-
1150
- **Parameters:**
1151
- - itemGroupID - ID of Facebook item group
1152
-
1153
-
1154
- ---
1155
-
1156
- ### setLink(URL)
1157
- - setLink(link: [URL](dw.web.URL.md)): void
1158
- - : Sets the URL of the Demandware storefront link to the product.
1159
-
1160
- **Parameters:**
1161
- - link - Demandware storefront link to the product
1162
-
1163
-
1164
- ---
1165
-
1166
- ### setMaterial(String)
1167
- - setMaterial(material: [String](TopLevel.String.md)): void
1168
- - : Sets the Facebook material value label of the product. If the value is longer than 200 characters it is
1169
- truncated.
1170
-
1171
-
1172
- **Parameters:**
1173
- - material - Facebook material value label, up to 200 characters
1174
-
1175
-
1176
- ---
1177
-
1178
- ### setMpn(String)
1179
- - setMpn(mpn: [String](TopLevel.String.md)): void
1180
- - : Sets the Facebook MPN of the product. If the value is longer than 70 characters it is truncated.
1181
-
1182
- **Parameters:**
1183
- - mpn - Facebook MPN, up to 70 characters
1184
-
1185
-
1186
- ---
1187
-
1188
- ### setPattern(String)
1189
- - setPattern(pattern: [String](TopLevel.String.md)): void
1190
- - : Sets the Facebook pattern value label of the product. If the value is longer than 100 characters it is truncated.
1191
-
1192
- **Parameters:**
1193
- - pattern - Facebook pattern value label, up to 100 characters
1194
-
1195
-
1196
- ---
1197
-
1198
- ### setPrice(Money)
1199
- - setPrice(price: [Money](dw.value.Money.md)): void
1200
- - : Sets the price to show in Facebook for the product.
1201
-
1202
- **Parameters:**
1203
- - price - Facebook price
1204
-
1205
-
1206
- ---
1207
-
1208
- ### setProductType(String)
1209
- - setProductType(productType: [String](TopLevel.String.md)): void
1210
- - : Sets the Facebook product type. If the value is longer than 750 characters it is truncated.
1211
-
1212
- **Parameters:**
1213
- - productType - Facebook product type, up to 750 characters
1214
-
1215
-
1216
- ---
1217
-
1218
- ### setSalePrice(Money)
1219
- - setSalePrice(salePrice: [Money](dw.value.Money.md)): void
1220
- - : Sets the sale price to show in Facebook for the product.
1221
-
1222
- **Parameters:**
1223
- - salePrice - Facebook sale price
1224
-
1225
-
1226
- ---
1227
-
1228
- ### setSalePriceEffectiveDateEnd(Date)
1229
- - setSalePriceEffectiveDateEnd(salePriceEffectiveDateEnd: [Date](TopLevel.Date.md)): void
1230
- - : Sets the end date of the Facebook sale price of the product.
1231
-
1232
- **Parameters:**
1233
- - salePriceEffectiveDateEnd - end date of Facebook sale price
1234
-
1235
-
1236
- ---
1237
-
1238
- ### setSalePriceEffectiveDateStart(Date)
1239
- - setSalePriceEffectiveDateStart(salePriceEffectiveDateStart: [Date](TopLevel.Date.md)): void
1240
- - : Sets the start date of the Facebook sale price of the product.
1241
-
1242
- **Parameters:**
1243
- - salePriceEffectiveDateStart - start date of Facebook sale price
1244
-
1245
-
1246
- ---
1247
-
1248
- ### setShippingHeight(Number)
1249
- - setShippingHeight(shippingHeight: [Number](TopLevel.Number.md)): void
1250
- - : Sets the shipping height of the product. If the value is negative it is truncated to 0.
1251
-
1252
- **Parameters:**
1253
- - shippingHeight - shipping height, may not be negative
1254
-
1255
- **See Also:**
1256
- - [setShippingLength(Number)](dw.extensions.facebook.FacebookProduct.md#setshippinglengthnumber)
1257
- - [setShippingWidth(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingwidthnumber)
1258
- - [setShippingSizeUnit(String)](dw.extensions.facebook.FacebookProduct.md#setshippingsizeunitstring)
1259
-
1260
-
1261
- ---
1262
-
1263
- ### setShippingLength(Number)
1264
- - setShippingLength(shippingLength: [Number](TopLevel.Number.md)): void
1265
- - : Sets the shipping length of the product. If the value is negative it is truncated to 0.
1266
-
1267
- **Parameters:**
1268
- - shippingLength - shipping length, may not be negative
1269
-
1270
- **See Also:**
1271
- - [setShippingWidth(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingwidthnumber)
1272
- - [setShippingHeight(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingheightnumber)
1273
- - [setShippingSizeUnit(String)](dw.extensions.facebook.FacebookProduct.md#setshippingsizeunitstring)
1274
-
1275
-
1276
- ---
1277
-
1278
- ### setShippingSizeUnit(String)
1279
- - setShippingSizeUnit(shippingSizeUnit: [String](TopLevel.String.md)): void
1280
- - : Sets the shipping size unit of the product.
1281
-
1282
- **Parameters:**
1283
- - shippingSizeUnit - shipping size unit
1284
-
1285
- **See Also:**
1286
- - [setShippingLength(Number)](dw.extensions.facebook.FacebookProduct.md#setshippinglengthnumber)
1287
- - [setShippingWidth(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingwidthnumber)
1288
- - [setShippingHeight(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingheightnumber)
1289
-
1290
-
1291
- ---
1292
-
1293
- ### setShippingWeight(Quantity)
1294
- - setShippingWeight(shippingWeight: [Quantity](dw.value.Quantity.md)): void
1295
- - : Sets the shipping weight for the product. Possible unit values are
1296
- [SHIPPING_WEIGHT_UNIT_LB](dw.extensions.facebook.FacebookProduct.md#shipping_weight_unit_lb),
1297
- [SHIPPING_WEIGHT_UNIT_OZ](dw.extensions.facebook.FacebookProduct.md#shipping_weight_unit_oz),
1298
- [SHIPPING_WEIGHT_UNIT_G](dw.extensions.facebook.FacebookProduct.md#shipping_weight_unit_g), or
1299
- [SHIPPING_WEIGHT_UNIT_KG](dw.extensions.facebook.FacebookProduct.md#shipping_weight_unit_kg).
1300
-
1301
-
1302
- **Parameters:**
1303
- - shippingWeight - product shipping weight
1304
-
1305
-
1306
- ---
1307
-
1308
- ### setShippingWidth(Number)
1309
- - setShippingWidth(shippingWidth: [Number](TopLevel.Number.md)): void
1310
- - : Sets the shipping width of the product. If the value is negative it is truncated to 0.
1311
-
1312
- **Parameters:**
1313
- - shippingWidth - shipping width, may not be negative
1314
-
1315
- **See Also:**
1316
- - [setShippingLength(Number)](dw.extensions.facebook.FacebookProduct.md#setshippinglengthnumber)
1317
- - [setShippingHeight(Number)](dw.extensions.facebook.FacebookProduct.md#setshippingheightnumber)
1318
- - [setShippingSizeUnit(String)](dw.extensions.facebook.FacebookProduct.md#setshippingsizeunitstring)
1319
-
1320
-
1321
- ---
1322
-
1323
- ### setSize(String)
1324
- - setSize(size: [String](TopLevel.String.md)): void
1325
- - : Sets the Facebook size value label of the product. If the value is longer than 100 characters it is truncated.
1326
-
1327
- **Parameters:**
1328
- - size - Facebook size value label, up to 100 characters
1329
-
1330
-
1331
- ---
1332
-
1333
- ### setTitle(String)
1334
- - setTitle(title: [String](TopLevel.String.md)): void
1335
- - : Sets the title of the Facebook product. If the value is longer than 100 characters it is truncated.
1336
-
1337
- **Parameters:**
1338
- - title - product title, up to 100 characters
1339
-
1340
-
1341
- ---
1342
-
1343
- <!-- prettier-ignore-end -->