workarea-api 4.4.6 → 4.5.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (333) 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 +87 -7
  8. data/Gemfile +1 -2
  9. data/README.md +23 -16
  10. data/Rakefile +16 -6
  11. data/admin/LICENSE +52 -0
  12. data/admin/README.md +4 -7
  13. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  15. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  16. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  17. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  18. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  19. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  21. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  23. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  27. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  29. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +1 -1
  31. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  33. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  34. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  35. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  36. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  37. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  38. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  39. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  40. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  41. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  42. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  43. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  44. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  45. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  47. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  48. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  49. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  50. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  51. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  52. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  53. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  55. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  58. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  59. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  60. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  61. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
  63. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  65. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  66. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  67. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  68. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  69. data/admin/workarea-api-admin.gemspec +7 -6
  70. data/app/views/workarea/api/docs/nav.haml +12 -0
  71. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  72. data/doc/api/admin/categories/creating_a_category.json +11 -8
  73. data/doc/api/admin/categories/listing_categories.json +8 -5
  74. data/doc/api/admin/categories/removing_a_category.json +8 -4
  75. data/doc/api/admin/categories/showing_a_category.json +10 -7
  76. data/doc/api/admin/categories/updating_a_category.json +9 -5
  77. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  78. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  79. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  80. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  81. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  82. data/doc/api/admin/content/creating_content.json +11 -8
  83. data/doc/api/admin/content/listing_content.json +8 -5
  84. data/doc/api/admin/content/showing_content.json +10 -7
  85. data/doc/api/admin/content/updating_content.json +8 -4
  86. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  87. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  88. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  89. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  90. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  91. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  92. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  93. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  94. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  95. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  96. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  97. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  98. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  99. data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
  100. data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
  101. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  102. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  103. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  104. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  105. data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
  106. data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
  107. data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
  108. data/doc/api/admin/global_functionality/paging_results.json +51 -0
  109. data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
  110. data/doc/api/admin/global_functionality/sorting_results.json +56 -0
  111. data/doc/api/admin/index.json +653 -578
  112. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  113. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  114. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  115. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  116. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  117. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  118. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  119. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  120. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  121. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  122. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  123. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  124. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  125. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  126. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  127. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  128. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  129. data/doc/api/admin/orders/listing_orders.json +8 -5
  130. data/doc/api/admin/orders/showing_an_order.json +8 -5
  131. data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
  132. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  133. data/doc/api/admin/pages/creating_a_page.json +11 -8
  134. data/doc/api/admin/pages/listing_pages.json +8 -5
  135. data/doc/api/admin/pages/removing_a_page.json +8 -4
  136. data/doc/api/admin/pages/showing_a_page.json +10 -7
  137. data/doc/api/admin/pages/updating_a_page.json +9 -5
  138. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  139. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  140. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  141. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  142. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  143. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  144. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  145. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  146. data/doc/api/admin/payments/listing_payments.json +7 -4
  147. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  148. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  149. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  150. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  151. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  152. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  153. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  154. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  155. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  156. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  157. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  158. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  159. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  160. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  161. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  162. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  163. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  164. data/doc/api/admin/products/creating_a_product.json +11 -8
  165. data/doc/api/admin/products/listing_products.json +8 -5
  166. data/doc/api/admin/products/removing_a_product.json +8 -4
  167. data/doc/api/admin/products/showing_a_product.json +10 -7
  168. data/doc/api/admin/products/updating_a_product.json +9 -5
  169. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  170. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  171. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  172. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  173. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  174. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  175. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  176. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  177. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  178. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  179. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  180. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  181. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  182. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  183. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +11 -7
  184. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  185. data/doc/api/admin/releases/creating_a_release.json +11 -8
  186. data/doc/api/admin/releases/listing_releases.json +8 -5
  187. data/doc/api/admin/releases/removing_a_release.json +8 -4
  188. data/doc/api/admin/releases/showing_a_release.json +10 -7
  189. data/doc/api/admin/releases/updating_a_release.json +9 -5
  190. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  191. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  192. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  193. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  194. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  195. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  196. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  197. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  198. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  199. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  200. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  201. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  202. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  203. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  204. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  205. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  206. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  207. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  208. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
  209. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  210. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  211. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  212. data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
  213. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  214. data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
  215. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  216. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  217. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  218. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  219. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  220. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  221. data/doc/api/admin/users/creating_a_user.json +11 -8
  222. data/doc/api/admin/users/listing_users.json +8 -5
  223. data/doc/api/admin/users/removing_a_user.json +8 -4
  224. data/doc/api/admin/users/showing_a_user.json +10 -12
  225. data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
  226. data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
  227. data/doc/api/admin/users/updating_a_user.json +9 -5
  228. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  229. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  230. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  231. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  232. data/doc/api/storefront/accounts/creating_an_account.json +7 -6
  233. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  234. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  235. data/doc/api/storefront/analytics/saving_a_category_view.json +18 -5
  236. data/doc/api/storefront/analytics/saving_a_product_view.json +18 -5
  237. data/doc/api/storefront/analytics/saving_a_search.json +18 -5
  238. data/doc/api/storefront/assets/showing_an_asset.json +9 -8
  239. data/doc/api/storefront/authentication/creating_an_authentication_token.json +9 -8
  240. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +9 -8
  241. data/doc/api/storefront/authentication/using_an_authentication_token.json +9 -8
  242. data/doc/api/storefront/cart/adding_a_promo_code.json +10 -9
  243. data/doc/api/storefront/cart/adding_an_item.json +10 -9
  244. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +9 -8
  245. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +7 -6
  246. data/doc/api/storefront/cart/delete_an_item.json +10 -9
  247. data/doc/api/storefront/cart/listing_user_s_carts.json +9 -8
  248. data/doc/api/storefront/cart/showing_cart.json +10 -9
  249. data/doc/api/storefront/cart/updating_an_item.json +10 -9
  250. data/doc/api/storefront/categories/showing_a_category.json +8 -7
  251. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +8 -7
  252. data/doc/api/storefront/checkout/completing_a_checkout.json +9 -8
  253. data/doc/api/storefront/checkout/showing_a_checkout.json +10 -9
  254. data/doc/api/storefront/checkout/updating_a_checkout.json +9 -8
  255. data/doc/api/storefront/contacts/creating_a_contact.json +7 -6
  256. data/doc/api/storefront/email_signups/creating_an_email_signup.json +7 -6
  257. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +7 -6
  258. data/doc/api/storefront/index.json +263 -258
  259. data/doc/api/storefront/menus/listing_menus.json +8 -7
  260. data/doc/api/storefront/menus/showing_a_menu.json +10 -9
  261. data/doc/api/storefront/orders/listing_the_user_s_orders.json +9 -8
  262. data/doc/api/storefront/orders/showing_an_order.json +10 -9
  263. data/doc/api/storefront/pages/showing_a_page.json +8 -7
  264. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +8 -6
  265. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
  266. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +9 -8
  267. data/doc/api/storefront/products/showing_a_product.json +8 -7
  268. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +8 -7
  269. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +10 -9
  270. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +11 -11
  271. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +6 -4
  272. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +8 -6
  273. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  274. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  275. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +9 -8
  276. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  277. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  278. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
  279. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  280. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +9 -8
  281. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  282. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
  283. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +9 -8
  284. data/doc/api/storefront/searches/showing_search_results.json +8 -7
  285. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  286. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  287. data/doc/api/storefront/system_content/showing_system_content.json +8 -7
  288. data/doc/api/storefront/system_content/showing_the_home_page.json +8 -7
  289. data/doc/api/storefront/taxons/showing_a_taxon.json +10 -9
  290. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +9 -8
  291. data/doc/api/storefront/validation_errors/general_validation_errors.json +4 -3
  292. data/lib/tasks/docs.rake +20 -0
  293. data/lib/workarea/api/documentation_test.rb +10 -1
  294. data/lib/workarea/api/version.rb +1 -1
  295. data/storefront/LICENSE +52 -0
  296. data/storefront/README.md +4 -7
  297. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  298. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  299. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  300. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  301. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  302. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  303. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  304. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  305. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  306. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  307. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  308. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  309. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  310. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  311. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  312. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  313. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  314. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  315. data/storefront/config/initializers/config.rb +19 -0
  316. data/storefront/lib/workarea/api/storefront.rb +1 -0
  317. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  318. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
  319. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  320. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
  321. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  322. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  323. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  324. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  325. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  326. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  327. data/storefront/workarea-api-storefront.gemspec +8 -7
  328. data/workarea-api.gemspec +4 -4
  329. metadata +38 -17
  330. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  331. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  332. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  333. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"S7ba6Jmi7ALkqhCzzk19ZC6T\""
11
+ "Authorization": "Token token=\"yqyMatgUo3pmh8VHqSwjH9Q3\""
12
12
  },
13
13
  "request_query_parameters": {
14
14
  },
@@ -24,13 +24,14 @@
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/\"6166f3e5ae6b4a5252bc123a70472f42\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:29 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "2c35946b-cc19-415e-8689-e1a6362072b5",
31
- "X-Runtime": "0.005800",
30
+ "X-Request-Id": "b3dc7314-e50d-4396-a576-e55819566e8e",
31
+ "X-Runtime": "0.003202",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
- "Content-Length": "203"
34
+ "Content-Length": "202"
34
35
  },
35
36
  "request_method": "GET",
36
37
  "request_path": "/api/storefront/account",
@@ -38,9 +39,9 @@
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"id\": \"5d5dbd8dd4322a4b69d79276\",\n \"email\": \"user267@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-21T21:54:21.038Z\",\n \"created_at\": \"2019-08-21T21:54:21.038Z\"\n}",
42
+ "response_body": "{\n \"id\": \"5dddc9451241596aa5205381\",\n \"email\": \"user55@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-11-27T00:54:29.765Z\",\n \"created_at\": \"2019-11-27T00:54:29.765Z\"\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"S7ba6Jmi7ALkqhCzzk19ZC6T\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"yqyMatgUo3pmh8VHqSwjH9Q3\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Accounts",
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"AdK8VpGSyXdNUzuGVuUhJGZm\"",
12
+ "Authorization": "Token token=\"bzriwTKpVj44uzWbXRedzDx6\"",
13
13
  "X-Http-Method-Override": "GET"
14
14
  },
15
15
  "request_query_parameters": {
@@ -26,13 +26,14 @@
26
26
  "Access-Control-Allow-Headers": "*",
27
27
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
28
28
  "X-Requested-With": "",
29
- "Vary": "X-Requested-With, X-Flash-Messages",
30
- "ETag": "W/\"860390f92f87fd1eb8edeab8ef315820\"",
29
+ "Vary": "X-Requested-With, X-Workarea-Segments",
30
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:28 GMT",
31
31
  "Cache-Control": "no-cache, no-store, must-revalidate",
32
- "X-Request-Id": "142efa84-00c3-4cc1-8a8e-092b6627582b",
33
- "X-Runtime": "0.005679",
32
+ "X-Request-Id": "b4f6c0e4-a095-46ac-b0ca-0fa3aab3fb43",
33
+ "X-Runtime": "0.003646",
34
+ "X-Workarea-Segments": "",
34
35
  "Expires": "0",
35
- "Content-Length": "203"
36
+ "Content-Length": "202"
36
37
  },
37
38
  "request_method": "POST",
38
39
  "request_path": "/api/storefront/account",
@@ -40,9 +41,9 @@
40
41
  "request_content_type": "application/json",
41
42
  "response_status": 200,
42
43
  "response_status_text": "OK",
43
- "response_body": "{\n \"id\": \"5d5dbd8cd4322a4b69d79272\",\n \"email\": \"user266@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-21T21:54:20.487Z\",\n \"created_at\": \"2019-08-21T21:54:20.487Z\"\n}",
44
+ "response_body": "{\n \"id\": \"5dddc9441241596aa520537c\",\n \"email\": \"user54@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-11-27T00:54:28.601Z\",\n \"created_at\": \"2019-11-27T00:54:28.601Z\"\n}",
44
45
  "response_content_type": "application/json",
45
- "curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"AdK8VpGSyXdNUzuGVuUhJGZm\\\"\" \\\n\t-H \"X-Http-Method-Override: GET\""
46
+ "curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"bzriwTKpVj44uzWbXRedzDx6\\\"\" \\\n\t-H \"X-Http-Method-Override: GET\""
46
47
  }
47
48
  ],
48
49
  "resource": "Accounts",
@@ -13,10 +13,23 @@
13
13
  "request_query_parameters": {
14
14
  },
15
15
  "response_headers": {
16
- "Content-Type": "text/html; charset=utf-8",
16
+ "X-Frame-Options": "SAMEORIGIN",
17
+ "X-XSS-Protection": "1; mode=block",
18
+ "X-Content-Type-Options": "nosniff",
19
+ "X-Download-Options": "noopen",
20
+ "X-Permitted-Cross-Domain-Policies": "none",
21
+ "Referrer-Policy": "strict-origin-when-cross-origin",
22
+ "Content-Type": "application/json",
23
+ "Access-Control-Allow-Origin": "*",
24
+ "Access-Control-Allow-Headers": "*",
25
+ "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:49 GMT",
17
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
18
- "X-Request-Id": "6d988bfd-dc84-4ac1-91f9-e9e3ca779a65",
19
- "X-Runtime": "0.002649",
30
+ "X-Request-Id": "73bac380-722e-4218-821c-f2f8f54b16ba",
31
+ "X-Runtime": "0.003717",
32
+ "X-Workarea-Segments": "",
20
33
  "Expires": "0",
21
34
  "Content-Length": "0"
22
35
  },
@@ -27,13 +40,13 @@
27
40
  "response_status": 200,
28
41
  "response_status_text": "OK",
29
42
  "response_body": null,
30
- "response_content_type": "text/html",
43
+ "response_content_type": "application/json",
31
44
  "curl": "curl \"https://www.example.com/api/storefront/analytics/category_view/12345\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
32
45
  }
33
46
  ],
34
47
  "resource": "Analytics",
35
48
  "description": "saving a category view",
36
49
  "route": "/api/storefront/analytics/category_view/:category_id",
37
- "explanation": "saving a category view will be reflected in admin reports",
50
+ "explanation": "<p>saving a category view will be reflected in admin reports</p>\n",
38
51
  "http_method": "POST"
39
52
  }
@@ -13,10 +13,23 @@
13
13
  "request_query_parameters": {
14
14
  },
15
15
  "response_headers": {
16
- "Content-Type": "text/html; charset=utf-8",
16
+ "X-Frame-Options": "SAMEORIGIN",
17
+ "X-XSS-Protection": "1; mode=block",
18
+ "X-Content-Type-Options": "nosniff",
19
+ "X-Download-Options": "noopen",
20
+ "X-Permitted-Cross-Domain-Policies": "none",
21
+ "Referrer-Policy": "strict-origin-when-cross-origin",
22
+ "Content-Type": "application/json",
23
+ "Access-Control-Allow-Origin": "*",
24
+ "Access-Control-Allow-Headers": "*",
25
+ "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:50 GMT",
17
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
18
- "X-Request-Id": "3aa00741-ae34-41b9-9c23-2dc758d19151",
19
- "X-Runtime": "0.002840",
30
+ "X-Request-Id": "c90fb4ed-3560-41d0-bebf-9093dc49aebb",
31
+ "X-Runtime": "0.007557",
32
+ "X-Workarea-Segments": "",
20
33
  "Expires": "0",
21
34
  "Content-Length": "0"
22
35
  },
@@ -27,13 +40,13 @@
27
40
  "response_status": 200,
28
41
  "response_status_text": "OK",
29
42
  "response_body": null,
30
- "response_content_type": "text/html",
43
+ "response_content_type": "application/json",
31
44
  "curl": "curl \"https://www.example.com/api/storefront/analytics/product_view/12345\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
32
45
  }
33
46
  ],
34
47
  "resource": "Analytics",
35
48
  "description": "saving a product view",
36
49
  "route": "/api/storefront/analytics/product_view/:product_id",
37
- "explanation": "saving a product view will be reflected in admin reports",
50
+ "explanation": "<p>saving a product view will be reflected in admin reports</p>\n",
38
51
  "http_method": "POST"
39
52
  }
@@ -13,10 +13,23 @@
13
13
  "request_query_parameters": {
14
14
  },
15
15
  "response_headers": {
16
- "Content-Type": "text/html; charset=utf-8",
16
+ "X-Frame-Options": "SAMEORIGIN",
17
+ "X-XSS-Protection": "1; mode=block",
18
+ "X-Content-Type-Options": "nosniff",
19
+ "X-Download-Options": "noopen",
20
+ "X-Permitted-Cross-Domain-Policies": "none",
21
+ "Referrer-Policy": "strict-origin-when-cross-origin",
22
+ "Content-Type": "application/json",
23
+ "Access-Control-Allow-Origin": "*",
24
+ "Access-Control-Allow-Headers": "*",
25
+ "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:51 GMT",
17
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
18
- "X-Request-Id": "8b19fca8-2746-49bc-94df-e191552aa898",
19
- "X-Runtime": "0.002739",
30
+ "X-Request-Id": "8c11e59d-e02f-469f-953b-6f745249b0e3",
31
+ "X-Runtime": "0.004747",
32
+ "X-Workarea-Segments": "",
20
33
  "Expires": "0",
21
34
  "Content-Length": "0"
22
35
  },
@@ -27,13 +40,13 @@
27
40
  "response_status": 200,
28
41
  "response_status_text": "OK",
29
42
  "response_body": null,
30
- "response_content_type": "text/html",
43
+ "response_content_type": "application/json",
31
44
  "curl": "curl \"https://www.example.com/api/storefront/analytics/search\" -d '{\"q\":\"foo\",\"total_results\":5}' -X POST \\\n\t-H \"Content-Type: application/json\""
32
45
  }
33
46
  ],
34
47
  "resource": "Analytics",
35
48
  "description": "Saving a search",
36
49
  "route": "/api/storefront/analytics/search",
37
- "explanation": " Saving a search will be reflected in admin reports. This is intended\n to be called once per search performed by a customer.\n",
50
+ "explanation": "<p>Saving a search will be reflected in admin reports. This is intended<br>\nto be called once per search performed by a customer.</p>\n",
38
51
  "http_method": "POST"
39
52
  }
@@ -23,28 +23,29 @@
23
23
  "Access-Control-Allow-Headers": "*",
24
24
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
25
25
  "X-Requested-With": "",
26
- "Vary": "X-Requested-With, X-Flash-Messages",
27
- "ETag": "W/\"a5c14b557854cee6ec5f29b9abb23921\"",
26
+ "Vary": "X-Requested-With, X-Workarea-Segments",
27
+ "Last-Modified": "Wed, 27 Nov 2019 00:49:11 GMT",
28
28
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "X-Request-Id": "7dfd7d27-f044-4216-8024-ebdce1de2ee0",
30
- "X-Runtime": "0.004118",
29
+ "X-Request-Id": "715bcdf3-606f-4086-a8a0-8d1489a6a600",
30
+ "X-Runtime": "0.021924",
31
+ "X-Workarea-Segments": "",
31
32
  "Expires": "0",
32
33
  "Content-Length": "217"
33
34
  },
34
35
  "request_method": "GET",
35
- "request_path": "/api/storefront/assets/5d5dbd2ed4322a4b69d78df5",
36
+ "request_path": "/api/storefront/assets/5dddc8071241596aa52044b2",
36
37
  "request_body": null,
37
38
  "request_content_type": null,
38
39
  "response_status": 200,
39
40
  "response_status_text": "OK",
40
- "response_body": "{\n \"id\": \"5d5dbd2ed4322a4b69d78df5\",\n \"name\": \"Summer Sale Callout\",\n \"url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMDgvMjEvNnBrMjhhbDJhel9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=158e5af8e3a65664\",\n \"type\": \"image\"\n}",
41
+ "response_body": "{\n \"id\": \"5dddc8071241596aa52044b2\",\n \"name\": \"Summer Sale Callout\",\n \"url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMTEvMjYvNnRtM2ZhZjVsaV9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=13d7196a5123bdf2\",\n \"type\": \"image\"\n}",
41
42
  "response_content_type": "application/json",
42
- "curl": "curl -g \"https://www.example.com/api/storefront/assets/5d5dbd2ed4322a4b69d78df5\" -X GET "
43
+ "curl": "curl -g \"https://www.example.com/api/storefront/assets/5dddc8071241596aa52044b2\" -X GET "
43
44
  }
44
45
  ],
45
46
  "resource": "Assets",
46
47
  "description": "Showing an asset",
47
48
  "route": "/api/storefront/assets/:id",
48
- "explanation": " Use this endpoint to look up assets stored in Workarea. Often times\n these will be referenced in content blocks.\n",
49
+ "explanation": "<p>Use this endpoint to look up assets stored in Workarea. Often times<br>\nthese will be referenced in content blocks.</p>\n",
49
50
  "http_method": "GET"
50
51
  }
@@ -24,28 +24,29 @@
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/\"a2ab4f837ea395ab575925b081cb3ca3\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:11 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "fb0ea804-827a-4bd6-9687-d5d7ab264b3c",
31
- "X-Runtime": "0.250259",
30
+ "X-Request-Id": "ef93f5f0-89c6-4273-abea-556419657c50",
31
+ "X-Runtime": "0.255656",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "76"
34
35
  },
35
36
  "request_method": "POST",
36
37
  "request_path": "/api/storefront/authentication_tokens",
37
- "request_body": "{\"email\":\"user8@workarea.com\",\"password\":\"p@assword!\"}",
38
+ "request_body": "{\"email\":\"user45@workarea.com\",\"password\":\"p@assword!\"}",
38
39
  "request_content_type": "application/json",
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"token\": \"q4eRbfXaAf3c4gJBHtojewZt\",\n \"expires_at\": \"2019-08-28T21:49:33.251Z\"\n}",
42
+ "response_body": "{\n \"token\": \"wVUVPF4cEg23REi2mQm7iBxt\",\n \"expires_at\": \"2019-12-04T00:54:11.187Z\"\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '{\"email\":\"user8@workarea.com\",\"password\":\"p@assword!\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
44
+ "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '{\"email\":\"user45@workarea.com\",\"password\":\"p@assword!\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
44
45
  }
45
46
  ],
46
47
  "resource": "Authentication",
47
48
  "description": "Creating an authentication token",
48
49
  "route": "/api/storefront/authentication_tokens",
49
- "explanation": " Creating an authentication token is the first step in user\n authentication. You will use this token to authenticate requests on\n behalf of the user going forward. To get a token you can use to\n authenticate an account, use this endpoint. You'll need the email\n and password from the user, and we'll issue a token that can be used\n to authenticate further requests for that customer. This token will\n expire after 7 days.\n Tokens are also invalidated when a user changes their password. See\n the \"using an authentication token\" example for how to use an\n authentication token.\n",
50
+ "explanation": "<p>Creating an authentication token is the first step in user<br>\nauthentication. You will use this token to authenticate requests on<br>\nbehalf of the user going forward. To get a token you can use to<br>\nauthenticate an account, use this endpoint. You&#39;ll need the email<br>\nand password from the user, and we&#39;ll issue a token that can be used<br>\nto authenticate further requests for that customer. This token will<br>\nexpire after 7 days.<br>\nTokens are also invalidated when a user changes their password. See<br>\nthe &quot;using an authentication token&quot; example for how to use an<br>\nauthentication token.</p>\n",
50
51
  "http_method": "POST"
51
52
  }
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/x-www-form-urlencoded",
12
- "Authorization": "Token token=\"igReqgpz6Y9DGU4FFhwSkKnJ\""
12
+ "Authorization": "Token token=\"318tfBEfNY1jVETcf4VY8cXb\""
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/\"66a238fd3ae548835be1e293b3f05cd9\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:08 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "b42d9eaf-b00a-4cae-9e64-64f82613936e",
32
- "X-Runtime": "0.007278",
31
+ "X-Request-Id": "07d39e5c-72c6-482f-b003-d64fda3cdbc4",
32
+ "X-Runtime": "0.007371",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "76"
35
36
  },
@@ -39,14 +40,14 @@
39
40
  "request_content_type": "application/x-www-form-urlencoded",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"token\": \"igReqgpz6Y9DGU4FFhwSkKnJ\",\n \"expires_at\": \"2019-08-28T21:49:33.839Z\"\n}",
43
+ "response_body": "{\n \"token\": \"318tfBEfNY1jVETcf4VY8cXb\",\n \"expires_at\": \"2019-12-04T00:54:08.274Z\"\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"igReqgpz6Y9DGU4FFhwSkKnJ\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"318tfBEfNY1jVETcf4VY8cXb\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Authentication",
48
49
  "description": "Refreshing an authentication token",
49
50
  "route": "/api/storefront/authentication_tokens",
50
- "explanation": " Refreshing an authentication token extends its expiration so that it\n can continue to be used.\n",
51
+ "explanation": "<p>Refreshing an authentication token extends its expiration so that it<br>\ncan continue to be used.</p>\n",
51
52
  "http_method": "PATCH"
52
53
  }
@@ -8,7 +8,7 @@
8
8
  "requests": [
9
9
  {
10
10
  "request_headers": {
11
- "Authorization": "Token token=\"bAaGYejkbNMHfx6TDqQdXuTu\""
11
+ "Authorization": "Token token=\"eT6N6vs6Ds48TebHF91YeVn6\""
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/\"2ec39cbe1d046132f0de3ce94564baa6\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:54:09 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "f40761b7-f873-4dbc-9c39-ed344380b7d9",
31
- "X-Runtime": "0.009212",
30
+ "X-Request-Id": "fc675d9c-5b12-408c-80a3-96331f421b30",
31
+ "X-Runtime": "0.003187",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "202"
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 \"id\": \"5d5dbc6ed4322a4b69d7824b\",\n \"email\": \"user10@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-21T21:49:34.380Z\",\n \"created_at\": \"2019-08-21T21:49:34.380Z\"\n}",
42
+ "response_body": "{\n \"id\": \"5dddc9311241596aa5205338\",\n \"email\": \"user44@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-11-27T00:54:09.725Z\",\n \"created_at\": \"2019-11-27T00:54:09.725Z\"\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"bAaGYejkbNMHfx6TDqQdXuTu\\\"\""
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"eT6N6vs6Ds48TebHF91YeVn6\\\"\""
44
45
  }
45
46
  ],
46
47
  "resource": "Authentication",
47
48
  "description": "Using an authentication token",
48
49
  "route": "/api/storefront/account",
49
- "explanation": " After obtaining an authentication token you can use it to request\n authenticated endpoints by including it in the Authorization header\n on the request, as demonstrated in this example.\n",
50
+ "explanation": "<p>After obtaining an authentication token you can use it to request<br>\nauthenticated endpoints by including it in the Authorization header<br>\non the request, as demonstrated in this example.</p>\n",
50
51
  "http_method": "GET"
51
52
  }
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"YUCbLwMv4jRfBc9SETr1T1pF\""
12
+ "Authorization": "Token token=\"jbHiFQqdFxqdyHJQKfMe4Fpu\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,28 +25,29 @@
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/\"94eba1c6dd609ac7ad0afb1ad7a98d0c\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:52:56 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "e6717679-5de6-42de-9004-0055a7cc32f8",
32
- "X-Runtime": "0.060686",
31
+ "X-Request-Id": "f6194164-b766-4ef2-9803-7b79e1ce5f63",
32
+ "X-Runtime": "0.092008",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "2428"
35
36
  },
36
37
  "request_method": "POST",
37
- "request_path": "/api/storefront/carts/47EDEC7608/add_promo_code",
38
+ "request_path": "/api/storefront/carts/BFB645F070/add_promo_code",
38
39
  "request_body": "{\"promo_code\":\"10OFF\"}",
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"id\": \"47EDEC7608\",\n \"url\": \"http://www.example.com/api/storefront/orders/47EDEC7608\",\n \"user_id\": \"5d5dbd84d4322a4b69d791e0\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n \"10OFF\"\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5dbd84d4322a4b69d791e7\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"description\": \"Order Total Discount\",\n \"discount\": true,\n \"amount\": {\n \"cents\": -100.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Order Total Discount\",\n \"amount\": {\n \"cents\": -100.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 900.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 900.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n}",
43
+ "response_body": "{\n \"id\": \"BFB645F070\",\n \"url\": \"http://www.example.com/api/storefront/orders/BFB645F070\",\n \"user_id\": \"5dddc8e61241596aa5204d2a\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n \"10OFF\"\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8e81241596aa5204d40\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"description\": \"Order Total Discount\",\n \"discount\": true,\n \"amount\": {\n \"cents\": -100.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Order Total Discount\",\n \"amount\": {\n \"cents\": -100.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 900.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 900.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/carts/47EDEC7608/add_promo_code\" -d '{\"promo_code\":\"10OFF\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"YUCbLwMv4jRfBc9SETr1T1pF\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/carts/BFB645F070/add_promo_code\" -d '{\"promo_code\":\"10OFF\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"jbHiFQqdFxqdyHJQKfMe4Fpu\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Cart",
48
49
  "description": "Adding a promo code",
49
50
  "route": "/api/storefront/carts/:id/add_promo_code",
50
- "explanation": "This endpoint will add promo codes to the cart",
51
+ "explanation": "<p>This endpoint will add promo codes to the cart</p>\n",
51
52
  "http_method": "POST"
52
53
  }
@@ -9,7 +9,7 @@
9
9
  {
10
10
  "request_headers": {
11
11
  "Content-Type": "application/json",
12
- "Authorization": "Token token=\"HCyWntMWPqwiTSJ4xzFUszCQ\""
12
+ "Authorization": "Token token=\"xrEQxw1fHaGcDyRVXxRFoKFo\""
13
13
  },
14
14
  "request_query_parameters": {
15
15
  },
@@ -25,28 +25,29 @@
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/\"f58035d634bf9472a97c02a37fbd740a\"",
28
+ "Vary": "X-Requested-With, X-Workarea-Segments",
29
+ "Last-Modified": "Wed, 27 Nov 2019 00:50:37 GMT",
30
30
  "Cache-Control": "no-cache, no-store, must-revalidate",
31
- "X-Request-Id": "34009673-9ae0-427a-8a9e-8b888f389293",
32
- "X-Runtime": "0.068047",
31
+ "X-Request-Id": "d6bcd77e-d837-482d-bfdd-7796a2e55c57",
32
+ "X-Runtime": "0.076277",
33
+ "X-Workarea-Segments": "",
33
34
  "Expires": "0",
34
35
  "Content-Length": "3920"
35
36
  },
36
37
  "request_method": "POST",
37
- "request_path": "/api/storefront/carts/FC57448C06/items",
38
+ "request_path": "/api/storefront/carts/70C1323C11/items",
38
39
  "request_body": "{\"product_id\":\"VINTEE\",\"sku\":\"VT001\",\"quantity\":2}",
39
40
  "request_content_type": "application/json",
40
41
  "response_status": 200,
41
42
  "response_status_text": "OK",
42
- "response_body": "{\n \"item\": {\n \"id\": \"5d5dbc8dd4322a4b69d783f4\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n \"order\": {\n \"id\": \"FC57448C06\",\n \"url\": \"http://www.example.com/api/storefront/orders/FC57448C06\",\n \"user_id\": \"5d5dbc8dd4322a4b69d783ed\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5dbc8dd4322a4b69d783f4\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n}",
43
+ "response_body": "{\n \"item\": {\n \"id\": \"5dddc85d1241596aa520485c\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n \"order\": {\n \"id\": \"70C1323C11\",\n \"url\": \"http://www.example.com/api/storefront/orders/70C1323C11\",\n \"user_id\": \"5dddc85c1241596aa5204846\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc85d1241596aa520485c\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n}",
43
44
  "response_content_type": "application/json",
44
- "curl": "curl \"https://www.example.com/api/storefront/carts/FC57448C06/items\" -d '{\"product_id\":\"VINTEE\",\"sku\":\"VT001\",\"quantity\":2}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"HCyWntMWPqwiTSJ4xzFUszCQ\\\"\""
45
+ "curl": "curl \"https://www.example.com/api/storefront/carts/70C1323C11/items\" -d '{\"product_id\":\"VINTEE\",\"sku\":\"VT001\",\"quantity\":2}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"xrEQxw1fHaGcDyRVXxRFoKFo\\\"\""
45
46
  }
46
47
  ],
47
48
  "resource": "Cart",
48
49
  "description": "Adding an item",
49
50
  "route": "/api/storefront/carts/:cart_id/items",
50
- "explanation": " Adds an item to the cart. Use the create a cart endpoint to get a\n cart_id to use with this endpoint.\n",
51
+ "explanation": "<p>Adds an item to the cart. Use the create a cart endpoint to get a<br>\ncart_id to use with this endpoint.</p>\n",
51
52
  "http_method": "POST"
52
53
  }