workarea-api 4.4.7 → 4.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (311) hide show
  1. checksums.yaml +4 -4
  2. data/.eslintrc.json +35 -0
  3. data/.github/workflows/ci.yml +35 -0
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +2 -0
  6. data/.stylelintrc.json +8 -0
  7. data/CHANGELOG.md +15 -11
  8. data/Gemfile +3 -2
  9. data/README.md +13 -0
  10. data/Rakefile +14 -5
  11. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  12. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  13. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  15. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  16. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  17. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  18. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  19. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  21. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  23. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  27. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  29. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  31. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  33. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  34. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  35. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  36. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  37. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  38. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  39. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  40. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  41. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  42. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  43. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  44. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  45. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  47. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  48. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  49. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  50. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  51. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  52. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  53. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  55. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  58. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  59. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  60. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  61. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  63. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  65. data/app/views/workarea/api/docs/nav.haml +12 -0
  66. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  67. data/doc/api/admin/categories/creating_a_category.json +11 -8
  68. data/doc/api/admin/categories/listing_categories.json +8 -5
  69. data/doc/api/admin/categories/removing_a_category.json +8 -4
  70. data/doc/api/admin/categories/showing_a_category.json +10 -7
  71. data/doc/api/admin/categories/updating_a_category.json +9 -5
  72. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  73. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  74. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  75. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  76. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  77. data/doc/api/admin/content/creating_content.json +11 -8
  78. data/doc/api/admin/content/listing_content.json +8 -5
  79. data/doc/api/admin/content/showing_content.json +10 -7
  80. data/doc/api/admin/content/updating_content.json +8 -4
  81. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  82. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  83. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  84. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  85. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  86. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  87. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  88. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  89. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  90. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  91. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  92. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  93. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  94. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  95. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  96. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  97. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  98. data/doc/api/admin/index.json +653 -578
  99. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  100. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  101. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  102. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  103. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  104. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  105. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  106. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  107. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  108. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  109. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  110. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  111. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  112. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  113. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  114. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  115. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  116. data/doc/api/admin/orders/listing_orders.json +8 -5
  117. data/doc/api/admin/orders/showing_an_order.json +8 -5
  118. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  119. data/doc/api/admin/pages/creating_a_page.json +11 -8
  120. data/doc/api/admin/pages/listing_pages.json +8 -5
  121. data/doc/api/admin/pages/removing_a_page.json +8 -4
  122. data/doc/api/admin/pages/showing_a_page.json +10 -7
  123. data/doc/api/admin/pages/updating_a_page.json +9 -5
  124. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  125. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  126. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  127. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  128. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  129. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  130. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  131. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  132. data/doc/api/admin/payments/listing_payments.json +7 -4
  133. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  134. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  135. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  136. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  137. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  138. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  139. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  140. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  141. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  142. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  143. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  144. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  145. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  146. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  147. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  148. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  149. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  150. data/doc/api/admin/products/creating_a_product.json +11 -8
  151. data/doc/api/admin/products/listing_products.json +8 -5
  152. data/doc/api/admin/products/removing_a_product.json +8 -4
  153. data/doc/api/admin/products/showing_a_product.json +10 -7
  154. data/doc/api/admin/products/updating_a_product.json +9 -5
  155. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  156. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  157. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  158. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  159. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  160. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  161. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  162. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  163. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  164. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  165. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  166. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  167. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  168. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  169. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +10 -6
  170. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  171. data/doc/api/admin/releases/creating_a_release.json +11 -8
  172. data/doc/api/admin/releases/listing_releases.json +8 -5
  173. data/doc/api/admin/releases/removing_a_release.json +8 -4
  174. data/doc/api/admin/releases/showing_a_release.json +10 -7
  175. data/doc/api/admin/releases/updating_a_release.json +9 -5
  176. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  177. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  178. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  179. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  180. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  181. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  182. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  183. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  184. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  185. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  186. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  187. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  188. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  189. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  190. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  191. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  192. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  193. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  194. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
  195. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  196. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  197. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  198. data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
  199. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  200. data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
  201. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  202. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  203. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  204. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  205. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  206. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  207. data/doc/api/admin/users/creating_a_user.json +11 -8
  208. data/doc/api/admin/users/listing_users.json +8 -5
  209. data/doc/api/admin/users/removing_a_user.json +8 -4
  210. data/doc/api/admin/users/showing_a_user.json +10 -12
  211. data/doc/api/admin/users/updating_a_user.json +9 -5
  212. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  213. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  214. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  215. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  216. data/doc/api/storefront/accounts/creating_an_account.json +8 -7
  217. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  218. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  219. data/doc/api/storefront/analytics/saving_a_category_view.json +19 -6
  220. data/doc/api/storefront/analytics/saving_a_product_view.json +19 -6
  221. data/doc/api/storefront/analytics/saving_a_search.json +19 -6
  222. data/doc/api/storefront/assets/showing_an_asset.json +10 -9
  223. data/doc/api/storefront/authentication/creating_an_authentication_token.json +10 -9
  224. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +10 -9
  225. data/doc/api/storefront/authentication/using_an_authentication_token.json +11 -10
  226. data/doc/api/storefront/cart/adding_a_promo_code.json +11 -10
  227. data/doc/api/storefront/cart/adding_an_item.json +11 -10
  228. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +10 -9
  229. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +8 -7
  230. data/doc/api/storefront/cart/delete_an_item.json +11 -10
  231. data/doc/api/storefront/cart/listing_user_s_carts.json +10 -9
  232. data/doc/api/storefront/cart/showing_cart.json +11 -10
  233. data/doc/api/storefront/cart/updating_an_item.json +11 -10
  234. data/doc/api/storefront/categories/showing_a_category.json +9 -8
  235. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +9 -8
  236. data/doc/api/storefront/checkout/completing_a_checkout.json +10 -9
  237. data/doc/api/storefront/checkout/showing_a_checkout.json +11 -10
  238. data/doc/api/storefront/checkout/updating_a_checkout.json +10 -9
  239. data/doc/api/storefront/contacts/creating_a_contact.json +8 -7
  240. data/doc/api/storefront/email_signups/creating_an_email_signup.json +8 -7
  241. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +8 -7
  242. data/doc/api/storefront/index.json +263 -258
  243. data/doc/api/storefront/menus/listing_menus.json +9 -8
  244. data/doc/api/storefront/menus/showing_a_menu.json +11 -10
  245. data/doc/api/storefront/orders/listing_the_user_s_orders.json +10 -9
  246. data/doc/api/storefront/orders/showing_an_order.json +11 -10
  247. data/doc/api/storefront/pages/showing_a_page.json +9 -8
  248. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +9 -7
  249. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +12 -12
  250. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +11 -10
  251. data/doc/api/storefront/products/showing_a_product.json +9 -8
  252. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +9 -8
  253. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +11 -10
  254. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +12 -12
  255. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +7 -5
  256. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +9 -7
  257. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  258. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  259. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +10 -9
  260. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  261. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  262. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
  263. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  264. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +10 -9
  265. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  266. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
  267. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +10 -9
  268. data/doc/api/storefront/searches/showing_search_results.json +9 -8
  269. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  270. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  271. data/doc/api/storefront/system_content/showing_system_content.json +9 -8
  272. data/doc/api/storefront/system_content/showing_the_home_page.json +9 -8
  273. data/doc/api/storefront/taxons/showing_a_taxon.json +11 -10
  274. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +10 -9
  275. data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
  276. data/lib/workarea/api/documentation_test.rb +10 -1
  277. data/lib/workarea/api/version.rb +1 -1
  278. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  279. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  280. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  281. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  282. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  283. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  284. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  285. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  286. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  287. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  288. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  289. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  290. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  291. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  292. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  293. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  294. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  295. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  296. data/storefront/config/initializers/config.rb +19 -0
  297. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  298. data/storefront/lib/workarea/api/storefront.rb +1 -0
  299. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  300. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  301. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  302. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  303. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  304. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  305. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  306. metadata +18 -12
  307. data/doc/api/admin/orders/viewing_orders_by_date_range.json +0 -68
  308. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  309. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  310. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  311. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/x-www-form-urlencoded",
12
- "Authorization": "Token token=\"NdMjPTc3rwCYLcoJsw15HAL3\""
12
+ "Authorization": "Token token=\"yEtPcSZrtU9zArYsJCWKx2PS\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -24,21 +24,23 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:54 GMT",
28
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "bd4637fe-12ee-4baa-b0d7-4ef64a1ac02d",
30
- "X-Runtime": "0.006546",
30
+ "X-Request-Id": "18931618-0dea-4738-8bcb-6ec8a2906e64",
31
+ "X-Runtime": "0.003916",
32
+ "X-Workarea-Segments": "",
31
33
  "Expires": "0"
32
34
  },
33
35
  "request_method": "DELETE",
34
- "request_path": "/api/storefront/saved_addresses/5d5eca51d4322a04dfbf6c14",
36
+ "request_path": "/api/storefront/saved_addresses/5dddc99a1241596aa5205503",
35
37
  "request_body": null,
36
38
  "request_content_type": "application/x-www-form-urlencoded",
37
39
  "response_status": 204,
38
40
  "response_status_text": "No Content",
39
41
  "response_body": null,
40
42
  "response_content_type": null,
41
- "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5d5eca51d4322a04dfbf6c14\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"NdMjPTc3rwCYLcoJsw15HAL3\\\"\""
43
+ "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5dddc99a1241596aa5205503\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"yEtPcSZrtU9zArYsJCWKx2PS\\\"\""
42
44
  }
43
45
  ],
44
46
  "resource": "Saved Addresses",
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"utvVgqxLKdG2wow2iQaEddgJ\""
11
+ "Authorization": "Token token=\"BW7ohsfkRsxwHfUakVxZBJc1\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,11 +24,12 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"9f1162d42524808f1bfe2f68244bd2ad\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:57 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "da123363-5a46-4c68-9c9c-119b4eec1f16",
31
- "X-Runtime": "0.016395",
30
+ "X-Request-Id": "abead827-d1a4-4a39-8d35-240a8dfb1fb3",
31
+ "X-Runtime": "0.003931",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "734"
34
35
  },
@@ -38,14 +39,14 @@
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5eca4ed4322a04dfbf6bfb\",\n \"addresses\": [\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5eca4ed4322a04dfbf6bfe\",\n \"id\": \"5d5eca4ed4322a04dfbf6bfe\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5eca4ed4322a04dfbf6bff\",\n \"id\": \"5d5eca4ed4322a04dfbf6bff\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n }\n ]\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc99d1241596aa520550b\",\n \"addresses\": [\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99d1241596aa520550f\",\n \"id\": \"5dddc99d1241596aa520550f\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n {\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99d1241596aa5205510\",\n \"id\": \"5dddc99d1241596aa5205510\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n }\n ]\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses\" -X GET \\\n\t-H \"Authorization: Token token=\\\"utvVgqxLKdG2wow2iQaEddgJ\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses\" -X GET \\\n\t-H \"Authorization: Token token=\\\"BW7ohsfkRsxwHfUakVxZBJc1\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Addresses",
47
48
  "description": "Listing the user's saved addresses",
48
49
  "route": "/api/storefront/saved_addresses",
49
- "http_method": "GET",
50
- "explanation": " List a customer's saved addresses. Useful for account management and\n for using saved addresses in checkout.\n"
50
+ "explanation": "<p>List a customer&#39;s saved addresses. Useful for account management and<br>\nfor using saved addresses in checkout.</p>\n",
51
+ "http_method": "GET"
51
52
  }
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"LJbyDHDtMFqNR18wJnuGGVFz\""
11
+ "Authorization": "Token token=\"5GQNUMpSREs8zfrHtkrRtTpF\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,23 +24,24 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"37eb0ee0499d77232732215e7dd2a8f4\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:56 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "b21f1e16-627b-4270-86cf-50b30432faf5",
31
- "X-Runtime": "0.007027",
30
+ "X-Request-Id": "7fe0a289-e787-4e87-b706-cfb9d27e6c71",
31
+ "X-Runtime": "0.003836",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "377"
34
35
  },
35
36
  "request_method": "GET",
36
- "request_path": "/api/storefront/saved_addresses/5d5eca51d4322a04dfbf6c0f",
37
+ "request_path": "/api/storefront/saved_addresses/5dddc99c1241596aa5205509",
37
38
  "request_body": null,
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5eca50d4322a04dfbf6c0c\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5eca51d4322a04dfbf6c0f\",\n \"id\": \"5d5eca51d4322a04dfbf6c0f\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc99b1241596aa5205505\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc99c1241596aa5205509\",\n \"id\": \"5dddc99c1241596aa5205509\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses/5d5eca51d4322a04dfbf6c0f\" -X GET \\\n\t-H \"Authorization: Token token=\\\"LJbyDHDtMFqNR18wJnuGGVFz\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_addresses/5dddc99c1241596aa5205509\" -X GET \\\n\t-H \"Authorization: Token token=\\\"5GQNUMpSREs8zfrHtkrRtTpF\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Addresses",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"TRJL1XAs4wqXZPSWRyGFsLiU\""
12
+ "Authorization": "Token token=\"FHoxyYe5QsxaYye31zkya3Vp\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,23 +25,24 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"56baa5da7eccc087e1bf88f0a12ca9ad\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:51 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "ecd8a2b4-6b1a-4c5c-a4b9-5bdf1bcea383",
32
- "X-Runtime": "0.070343",
31
+ "X-Request-Id": "1d9aa0af-893b-4d75-a4b8-e6672e3da2e0",
32
+ "X-Runtime": "0.080268",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "377"
35
36
  },
36
37
  "request_method": "PATCH",
37
- "request_path": "/api/storefront/saved_addresses/5d5eca4fd4322a04dfbf6c04",
38
+ "request_path": "/api/storefront/saved_addresses/5dddc9971241596aa52054f6",
38
39
  "request_body": "{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}",
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5eca4fd4322a04dfbf6c01\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5d5eca4fd4322a04dfbf6c04\",\n \"id\": \"5d5eca4fd4322a04dfbf6c04\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc9971241596aa52054f2\",\n \"url\": \"http://www.example.com/api/storefront/saved_addresses/5dddc9971241596aa52054f6\",\n \"id\": \"5dddc9971241596aa52054f6\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"4059 Mt Lee Dr.\",\n \"street_2\": null,\n \"city\": \"Hollywood\",\n \"country\": \"US\",\n \"region\": \"CA\",\n \"postal_code\": \"90068\",\n \"phone_number\": \"7545552390\",\n \"phone_extension\": null\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5d5eca4fd4322a04dfbf6c04\" -d '{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"TRJL1XAs4wqXZPSWRyGFsLiU\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_addresses/5dddc9971241596aa52054f6\" -d '{\"street\":\"4059 Mt Lee Dr.\",\"city\":\"Hollywood\",\"region\":\"CA\",\"postal_code\":\"90068\",\"phone_number\":\"7545552390\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"FHoxyYe5QsxaYye31zkya3Vp\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Addresses",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"gFyrUCzJ3YzRCAZvcP9GwvUw\""
12
+ "Authorization": "Token token=\"rtbqstRt5B87UebHPY4SYriL\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,11 +25,12 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"c7bf2ab3202f0c653f4049acf27a3908\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:15 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "e4457a5b-7fc8-4c81-8bd2-9ce6749da76d",
32
- "X-Runtime": "0.010508",
31
+ "X-Request-Id": "74d3bfbf-a7d2-435c-975c-c4906dac26bc",
32
+ "X-Runtime": "0.010853",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "294"
35
36
  },
@@ -39,9 +40,9 @@
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5ec9cfd4322a04dfbf632b\",\n \"id\": \"5d5ec9cfd4322a04dfbf6330\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9cfd4322a04dfbf6330\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc8fb1241596aa5204f6c\",\n \"id\": \"5dddc8fb1241596aa5204f72\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fb1241596aa5204f72\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards\" -d '{\"number\":\"4111111111111111\",\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"gFyrUCzJ3YzRCAZvcP9GwvUw\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards\" -d '{\"number\":\"4111111111111111\",\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"rtbqstRt5B87UebHPY4SYriL\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Credit Cards",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/x-www-form-urlencoded",
12
- "Authorization": "Token token=\"2Eh6tA5VZJ9rUZroynrAWX4t\""
12
+ "Authorization": "Token token=\"D2LCYEh6sAPC6HQUeTJwe9Pe\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -24,21 +24,23 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:17 GMT",
28
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "af987b0a-b5c8-4943-8678-869a04bd9a75",
30
- "X-Runtime": "0.007623",
30
+ "X-Request-Id": "c083436c-c7b0-4bda-940d-d9f466d8dc8b",
31
+ "X-Runtime": "0.005613",
32
+ "X-Workarea-Segments": "",
31
33
  "Expires": "0"
32
34
  },
33
35
  "request_method": "DELETE",
34
- "request_path": "/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf633c",
36
+ "request_path": "/api/storefront/saved_credit_cards/5dddc8fd1241596aa5204f81",
35
37
  "request_body": null,
36
38
  "request_content_type": "application/x-www-form-urlencoded",
37
39
  "response_status": 204,
38
40
  "response_status_text": "No Content",
39
41
  "response_body": null,
40
42
  "response_content_type": null,
41
- "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf633c\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"2Eh6tA5VZJ9rUZroynrAWX4t\\\"\""
43
+ "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8fd1241596aa5204f81\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"D2LCYEh6sAPC6HQUeTJwe9Pe\\\"\""
42
44
  }
43
45
  ],
44
46
  "resource": "Saved Credit Cards",
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"9B4z2rzwUdRdP8GVBseDg2CQ\""
11
+ "Authorization": "Token token=\"DQKxg6mi7izwjdLNV8QhmHYS\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,11 +24,12 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"74391c9491520c0e402264bff4208c55\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:16 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "acc4a14f-1545-4d50-8165-2511cb79de7e",
31
- "X-Runtime": "0.009153",
30
+ "X-Request-Id": "7cfdf86e-5030-43fb-85fa-c5c4cbea058f",
31
+ "X-Runtime": "0.005535",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "571"
34
35
  },
@@ -38,14 +39,14 @@
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5ec9ced4322a04dfbf6324\",\n \"credit_cards\": [\n {\n \"id\": \"5d5ec9ced4322a04dfbf6328\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6328\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n },\n {\n \"id\": \"5d5ec9ced4322a04dfbf6329\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6329\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n }\n ]\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc8fc1241596aa5204f74\",\n \"credit_cards\": [\n {\n \"id\": \"5dddc8fc1241596aa5204f79\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fc1241596aa5204f79\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n },\n {\n \"id\": \"5dddc8fc1241596aa5204f7a\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fc1241596aa5204f7a\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n }\n ]\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"9B4z2rzwUdRdP8GVBseDg2CQ\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards\" -X GET \\\n\t-H \"Authorization: Token token=\\\"DQKxg6mi7izwjdLNV8QhmHYS\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Credit Cards",
47
48
  "description": "Listing the user's saved credit cards",
48
49
  "route": "/api/storefront/saved_credit_cards",
49
- "http_method": "GET",
50
- "explanation": " List a customer's saved addresses. Useful for account management.\n These addresses will be available to the customer in an\n authenticated checkout.\n"
50
+ "explanation": "<p>List a customer&#39;s saved addresses. Useful for account management.<br>\nThese addresses will be available to the customer in an<br>\nauthenticated checkout.</p>\n",
51
+ "http_method": "GET"
51
52
  }
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"3gstq5QbUorVGaQ68esor1nD\""
11
+ "Authorization": "Token token=\"rdCn2gLdQQch8s6wpLMPWQsp\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,23 +24,24 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"52292c68f1c4a0050eafa702eb3dd1d6\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:19 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "291bedc7-9905-4898-98e8-f70e8107d308",
31
- "X-Runtime": "0.006976",
30
+ "X-Request-Id": "5b6ad680-3f33-4c8e-8308-4c5b66cdc815",
31
+ "X-Runtime": "0.005172",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "294"
34
35
  },
35
36
  "request_method": "GET",
36
- "request_path": "/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf6336",
37
+ "request_path": "/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f",
37
38
  "request_body": null,
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"user_id\": \"5d5ec9d0d4322a04dfbf6332\",\n \"id\": \"5d5ec9d0d4322a04dfbf6336\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf6336\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
42
+ "response_body": "{\n \"user_id\": \"5dddc8ff1241596aa5204f8a\",\n \"id\": \"5dddc8ff1241596aa5204f8f\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 3,\n \"year\": 2023,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5d5ec9d0d4322a04dfbf6336\" -X GET \\\n\t-H \"Authorization: Token token=\\\"3gstq5QbUorVGaQ68esor1nD\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8ff1241596aa5204f8f\" -X GET \\\n\t-H \"Authorization: Token token=\\\"rdCn2gLdQQch8s6wpLMPWQsp\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Saved Credit Cards",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"znRJwJSwnksRNf3hhfbHoWHa\""
12
+ "Authorization": "Token token=\"wcf51sh3LcP5yQHG58ejswar\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,23 +25,24 @@
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
29
- "ETag": "W/\"0038cc54b80e1fb6e7943b4bf37a94b8\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:53:18 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "1c143b11-ba5e-4272-aeef-4dadbbb0d752",
32
- "X-Runtime": "0.017047",
31
+ "X-Request-Id": "0d6cc30f-379a-4764-97c5-3963c3c1f1cb",
32
+ "X-Runtime": "0.009391",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "294"
35
36
  },
36
37
  "request_method": "PATCH",
37
- "request_path": "/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322",
38
+ "request_path": "/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88",
38
39
  "request_body": "{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}",
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"user_id\": \"5d5ec9ced4322a04dfbf631e\",\n \"id\": \"5d5ec9ced4322a04dfbf6322\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
+ "response_body": "{\n \"user_id\": \"5dddc8fe1241596aa5204f83\",\n \"id\": \"5dddc8fe1241596aa5204f88\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"znRJwJSwnksRNf3hhfbHoWHa\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"wcf51sh3LcP5yQHG58ejswar\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Saved Credit Cards",
@@ -19,19 +19,20 @@
19
19
  "X-Download-Options": "noopen",
20
20
  "X-Permitted-Cross-Domain-Policies": "none",
21
21
  "Referrer-Policy": "strict-origin-when-cross-origin",
22
- "Date": "Thu, 22 Aug 2019 17:00:24 GMT",
22
+ "Date": "Wed, 27 Nov 2019 00:55:07 GMT",
23
23
  "Content-Type": "application/json; charset=utf-8",
24
24
  "Access-Control-Allow-Origin": "*",
25
25
  "Access-Control-Allow-Headers": "*",
26
26
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
27
27
  "X-Requested-With": "",
28
- "Vary": "X-Requested-With, X-Flash-Messages",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:07 GMT",
29
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "ETag": "W/\"5cadef3e3fd1835a35070954308d0d32\"",
31
- "X-Request-Id": "02b9b8a2-403b-4f94-83ea-5cebacd48cee",
32
- "X-Runtime": "0.055426",
31
+ "X-Request-Id": "4c7ada86-44f8-4488-a832-5ff1a8535956",
32
+ "X-Runtime": "0.012656",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
- "Content-Length": "631"
35
+ "Content-Length": "16"
35
36
  },
36
37
  "request_method": "GET",
37
38
  "request_path": "/api/storefront/searches?q=red",
@@ -39,7 +40,7 @@
39
40
  "request_content_type": null,
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"results\": [\n {\n \"value\": \"red\",\n \"type\": \"Searches\",\n \"image\": null,\n \"url\": \"/api/storefront/search?q=red\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Product\",\n \"type\": \"Products\",\n \"image\": \"/product_images/placeholder/small_thumb.jpg?c=1566493120\",\n \"url\": \"/api/storefront/products/red-product\",\n \"analytics\": {\n \"id\": \"8CB6DE3B62\",\n \"name\": \"Red Product\",\n \"sku\": null,\n \"sale\": false,\n \"price\": 5.0,\n \"category\": null\n }\n },\n {\n \"value\": \"Page about Red Products\",\n \"type\": \"Pages\",\n \"image\": null,\n \"url\": \"/api/storefront/pages/page-about-red-products\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Category\",\n \"type\": \"Categories\",\n \"image\": null,\n \"url\": \"/api/storefront/categories/red-category\",\n \"analytics\": null\n }\n ]\n}",
43
+ "response_body": "{\n \"results\": null\n}",
43
44
  "response_content_type": "application/json",
44
45
  "curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET "
45
46
  }
@@ -47,6 +48,6 @@
47
48
  "resource": "Searches",
48
49
  "description": "Showing search autocomplete suggestions",
49
50
  "route": "/api/storefront/searches",
50
- "http_method": "GET",
51
- "explanation": " This list will be based on popular search terms and matching\n products, categories, etc. Useful for showing a autocomplete\n drop-down as a customer types in a search bar.\n"
51
+ "explanation": "<p>This list will be based on popular search terms and matching<br>\nproducts, categories, etc. Useful for showing a autocomplete<br>\ndrop-down as a customer types in a search bar.</p>\n",
52
+ "http_method": "GET"
52
53
  }
@@ -36,17 +36,18 @@
36
36
  "X-Download-Options": "noopen",
37
37
  "X-Permitted-Cross-Domain-Policies": "none",
38
38
  "Referrer-Policy": "strict-origin-when-cross-origin",
39
- "Date": "Thu, 22 Aug 2019 17:00:25 GMT",
39
+ "Date": "Wed, 27 Nov 2019 00:55:40 GMT",
40
40
  "Content-Type": "application/json; charset=utf-8",
41
41
  "Access-Control-Allow-Origin": "*",
42
42
  "Access-Control-Allow-Headers": "*",
43
43
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
44
44
  "X-Requested-With": "",
45
- "Vary": "X-Requested-With, X-Flash-Messages",
45
+ "Vary": "X-Requested-With, X-Workarea-Segments",
46
+ "Last-Modified": "Wed, 27 Nov 2019 00:55:40 GMT",
46
47
  "Cache-Control": "no-cache, no-store, must-revalidate",
47
- "ETag": "W/\"cbbd627ecb28bfddcc28d6597fc07c2e\"",
48
- "X-Request-Id": "bf062e15-7dc7-4d52-8a59-09ae63b7ce6f",
49
- "X-Runtime": "0.119178",
48
+ "X-Request-Id": "33b2710d-d66d-436b-a4d8-af1214018f15",
49
+ "X-Runtime": "0.064315",
50
+ "X-Workarea-Segments": "",
50
51
  "Expires": "0",
51
52
  "Content-Length": "6349"
52
53
  },
@@ -56,7 +57,7 @@
56
57
  "request_content_type": null,
57
58
  "response_status": 200,
58
59
  "response_status_text": "OK",
59
- "response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\n ],\n [\n \"Top Sellers\",\n \"top_sellers\"\n ],\n [\n \"Most Popular\",\n \"popularity\"\n ],\n [\n \"Newest\",\n \"newest\"\n ],\n [\n \"Price, Low to High\",\n \"price_asc\"\n ],\n [\n \"Price, High to Low\",\n \"price_desc\"\n ]\n ],\n \"sort\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69d7\",\n \"type\": \"text\",\n \"area\": \"results\",\n \"data\": {\n \"text\": \"Huzzah! Your search results are below!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d7\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d7&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Huzzah! Your search results are below!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5eca28d4322a04dfbf69d8\",\n \"type\": \"text\",\n \"area\": \"no_results\",\n \"data\": {\n \"text\": \"Sorry, we can't find what you searched for!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d8\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5d5eca28d4322a04dfbf69d8&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Sorry, we can&#39;t find what you searched for!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n }\n ],\n \"first_page\": true,\n \"second_page\": false,\n \"last_page\": true,\n \"page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"per_page\": 20,\n \"total_results\": 2,\n \"total_pages\": 1,\n \"facets\": [\n\n ],\n \"products\": [\n {\n \"id\": \"PRODUCT1\",\n \"name\": \"Pretty Nice Shirt\",\n \"description\": null,\n \"slug\": \"pretty-nice-shirt\",\n \"browser_title\": \"Pretty Nice Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Blue\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69da\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69db\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"PRODUCT2\",\n \"name\": \"Great Pants\",\n \"description\": null,\n \"slug\": \"great-pants\",\n \"browser_title\": \"Great Pants\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Brown\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69dd\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69de\",\n \"option\": \"Brown\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
60
+ "response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\n ],\n [\n \"Top Sellers\",\n \"top_sellers\"\n ],\n [\n \"Most Popular\",\n \"popularity\"\n ],\n [\n \"Newest\",\n \"newest\"\n ],\n [\n \"Price, Low to High\",\n \"price_asc\"\n ],\n [\n \"Price, High to Low\",\n \"price_desc\"\n ]\n ],\n \"sort\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"5dddc98b1241596aa5205407\",\n \"type\": \"text\",\n \"area\": \"results\",\n \"data\": {\n \"text\": \"Huzzah! Your search results are below!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc98b1241596aa5205407\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc98b1241596aa5205407&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Huzzah! Your search results are below!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5dddc98b1241596aa5205408\",\n \"type\": \"text\",\n \"area\": \"no_results\",\n \"data\": {\n \"text\": \"Sorry, we can't find what you searched for!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc98b1241596aa5205408\\\" data-analytics=\\\"{&quot;event&quot;:&quot;contentBlockDisplay&quot;,&quot;payload&quot;:{&quot;id&quot;:&quot;5dddc98b1241596aa5205408&quot;,&quot;type&quot;:&quot;text&quot;,&quot;position&quot;:0,&quot;data&quot;:{&quot;text&quot;:&quot;Sorry, we can&#39;t find what you searched for!&quot;}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n }\n ],\n \"first_page\": true,\n \"second_page\": false,\n \"last_page\": true,\n \"page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"per_page\": 20,\n \"total_results\": 2,\n \"total_pages\": 1,\n \"facets\": [\n\n ],\n \"products\": [\n {\n \"id\": \"PRODUCT1\",\n \"name\": \"Pretty Nice Shirt\",\n \"description\": null,\n \"slug\": \"pretty-nice-shirt\",\n \"browser_title\": \"Pretty Nice Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Blue\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5dddc98b1241596aa520540a\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5dddc98b1241596aa520540b\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"PRODUCT2\",\n \"name\": \"Great Pants\",\n \"description\": null,\n \"slug\": \"great-pants\",\n \"browser_title\": \"Great Pants\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Brown\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5dddc98b1241596aa520541a\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5dddc98b1241596aa520541b\",\n \"option\": \"Brown\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
60
61
  "response_content_type": "application/json",
61
62
  "curl": "curl -g \"https://www.example.com/api/storefront/search?page=1&q=large&sort=price_desc\" -X GET "
62
63
  }
@@ -64,6 +65,6 @@
64
65
  "resource": "Searches",
65
66
  "description": "Showing search results",
66
67
  "route": "/api/storefront/search",
67
- "http_method": "GET",
68
- "explanation": " This endpoint returns everything you'll need to show search results\n to customers. This includes products, filters, and any content\n that's been setup by an administrator.\n"
68
+ "explanation": "<p>This endpoint returns everything you&#39;ll need to show search results<br>\nto customers. This includes products, filters, and any content<br>\nthat&#39;s been setup by an administrator.</p>\n",
69
+ "http_method": "GET"
69
70
  }