workarea-api 4.4.6 → 4.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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
@@ -0,0 +1,51 @@
1
+ {
2
+ "parameters": [
3
+ {
4
+ "name": "page",
5
+ "description": "Current page"
6
+ }
7
+ ],
8
+ "response_fields": [
9
+
10
+ ],
11
+ "requests": [
12
+ {
13
+ "request_headers": {
14
+ },
15
+ "request_query_parameters": {
16
+ "page": "1"
17
+ },
18
+ "response_headers": {
19
+ "X-Frame-Options": "SAMEORIGIN",
20
+ "X-XSS-Protection": "1; mode=block",
21
+ "X-Content-Type-Options": "nosniff",
22
+ "X-Download-Options": "noopen",
23
+ "X-Permitted-Cross-Domain-Policies": "none",
24
+ "Referrer-Policy": "strict-origin-when-cross-origin",
25
+ "Content-Type": "application/json; charset=utf-8",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:46:16 GMT",
29
+ "Cache-Control": "no-cache, no-store, must-revalidate",
30
+ "X-Request-Id": "c41640b5-39f4-4e7a-a996-c25f16bbc7fa",
31
+ "X-Runtime": "0.009128",
32
+ "X-Workarea-Segments": "",
33
+ "Expires": "0",
34
+ "Content-Length": "1470"
35
+ },
36
+ "request_method": "GET",
37
+ "request_path": "/api/admin/products?page=1",
38
+ "request_body": null,
39
+ "request_content_type": null,
40
+ "response_status": 200,
41
+ "response_status_text": "OK",
42
+ "response_body": "{\n \"products\": [\n {\n \"_id\": \"FE90881E79\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"browser_title\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-11-27T00:46:16.183Z\",\n \"customizations\": null,\n \"default_category_id\": null,\n \"description\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"last_indexed_at\": \"2019-11-27T00:46:16.351Z\",\n \"meta_description\": null,\n \"name\": \"Test Product\",\n \"purchasable\": true,\n \"slug\": \"test-product-1\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-11-27T00:46:16.183Z\",\n \"variants\": [\n {\n \"_id\": \"5dddc7581241594254076551\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"created_at\": null,\n \"details\": {\n },\n \"name\": \"SKU\",\n \"position\": 0,\n \"sku\": \"SKU\",\n \"updated_at\": null\n }\n ]\n },\n {\n \"_id\": \"0C006008AA\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"browser_title\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-11-27T00:46:15.798Z\",\n \"customizations\": null,\n \"default_category_id\": null,\n \"description\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"last_indexed_at\": \"2019-11-27T00:46:16.176Z\",\n \"meta_description\": null,\n \"name\": \"Test Product\",\n \"purchasable\": true,\n \"slug\": \"test-product\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-11-27T00:46:16.045Z\",\n \"variants\": [\n {\n \"_id\": \"5dddc7571241594254076548\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"created_at\": null,\n \"details\": {\n },\n \"name\": \"SKU\",\n \"position\": 0,\n \"sku\": \"SKU\",\n \"updated_at\": null\n }\n ]\n }\n ]\n}",
43
+ "response_content_type": "application/json",
44
+ "curl": "curl -g \"https://www.example.com/api/admin/products?page=1\" -X GET "
45
+ }
46
+ ],
47
+ "resource": "Global Functionality",
48
+ "description": "Paging results",
49
+ "route": "/api/admin/products",
50
+ "http_method": "GET"
51
+ }
@@ -0,0 +1,51 @@
1
+ {
2
+ "parameters": [
3
+ {
4
+ "name": "page",
5
+ "description": "Current page"
6
+ }
7
+ ],
8
+ "response_fields": [
9
+
10
+ ],
11
+ "requests": [
12
+ {
13
+ "request_headers": {
14
+ },
15
+ "request_query_parameters": {
16
+ "page": "2"
17
+ },
18
+ "response_headers": {
19
+ "X-Frame-Options": "SAMEORIGIN",
20
+ "X-XSS-Protection": "1; mode=block",
21
+ "X-Content-Type-Options": "nosniff",
22
+ "X-Download-Options": "noopen",
23
+ "X-Permitted-Cross-Domain-Policies": "none",
24
+ "Referrer-Policy": "strict-origin-when-cross-origin",
25
+ "Content-Type": "application/json; charset=utf-8",
26
+ "X-Requested-With": "",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 27 Nov 2019 00:46:25 GMT",
29
+ "Cache-Control": "no-cache, no-store, must-revalidate",
30
+ "X-Request-Id": "41ee8aa9-4a90-4dca-a63f-bb9de95a757d",
31
+ "X-Runtime": "0.006204",
32
+ "X-Workarea-Segments": "",
33
+ "Expires": "0",
34
+ "Content-Length": "15"
35
+ },
36
+ "request_method": "GET",
37
+ "request_path": "/api/admin/products?page=2",
38
+ "request_body": null,
39
+ "request_content_type": null,
40
+ "response_status": 200,
41
+ "response_status_text": "OK",
42
+ "response_body": "{\n \"products\": [\n\n ]\n}",
43
+ "response_content_type": "application/json",
44
+ "curl": "curl -g \"https://www.example.com/api/admin/products?page=2\" -X GET "
45
+ }
46
+ ],
47
+ "resource": "Global Functionality",
48
+ "description": "Retrieving addtional pages of results",
49
+ "route": "/api/admin/products",
50
+ "http_method": "GET"
51
+ }
@@ -0,0 +1,56 @@
1
+ {
2
+ "parameters": [
3
+ {
4
+ "name": "sort_by",
5
+ "description": "Field on which to sort (see responses for possible values)"
6
+ },
7
+ {
8
+ "name": "sort_direction",
9
+ "description": "Direction to sort (asc or desc)"
10
+ }
11
+ ],
12
+ "response_fields": [
13
+
14
+ ],
15
+ "requests": [
16
+ {
17
+ "request_headers": {
18
+ },
19
+ "request_query_parameters": {
20
+ "sort_by": "created_at",
21
+ "sort_direction": "desc"
22
+ },
23
+ "response_headers": {
24
+ "X-Frame-Options": "SAMEORIGIN",
25
+ "X-XSS-Protection": "1; mode=block",
26
+ "X-Content-Type-Options": "nosniff",
27
+ "X-Download-Options": "noopen",
28
+ "X-Permitted-Cross-Domain-Policies": "none",
29
+ "Referrer-Policy": "strict-origin-when-cross-origin",
30
+ "Content-Type": "application/json; charset=utf-8",
31
+ "X-Requested-With": "",
32
+ "Vary": "X-Requested-With, X-Workarea-Segments",
33
+ "Last-Modified": "Wed, 27 Nov 2019 00:46:18 GMT",
34
+ "Cache-Control": "no-cache, no-store, must-revalidate",
35
+ "X-Request-Id": "34fe40ca-9ab3-48d9-80cd-ef78c950695c",
36
+ "X-Runtime": "0.008967",
37
+ "X-Workarea-Segments": "",
38
+ "Expires": "0",
39
+ "Content-Length": "1470"
40
+ },
41
+ "request_method": "GET",
42
+ "request_path": "/api/admin/products?sort_by=created_at&sort_direction=desc",
43
+ "request_body": null,
44
+ "request_content_type": null,
45
+ "response_status": 200,
46
+ "response_status_text": "OK",
47
+ "response_body": "{\n \"products\": [\n {\n \"_id\": \"FA159F10A9\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"browser_title\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-11-27T00:46:17.924Z\",\n \"customizations\": null,\n \"default_category_id\": null,\n \"description\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"last_indexed_at\": \"2019-11-27T00:46:18.118Z\",\n \"meta_description\": null,\n \"name\": \"Test Product\",\n \"purchasable\": true,\n \"slug\": \"test-product-1\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-11-27T00:46:17.924Z\",\n \"variants\": [\n {\n \"_id\": \"5dddc7591241594254076563\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"created_at\": null,\n \"details\": {\n },\n \"name\": \"SKU\",\n \"position\": 0,\n \"sku\": \"SKU\",\n \"updated_at\": null\n }\n ]\n },\n {\n \"_id\": \"2FD88D2901\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"browser_title\": null,\n \"copied_from_id\": null,\n \"created_at\": \"2019-11-27T00:46:17.551Z\",\n \"customizations\": null,\n \"default_category_id\": null,\n \"description\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"last_indexed_at\": \"2019-11-27T00:46:17.915Z\",\n \"meta_description\": null,\n \"name\": \"Test Product\",\n \"purchasable\": true,\n \"slug\": \"test-product\",\n \"subscribed_user_ids\": [\n\n ],\n \"tags\": [\n\n ],\n \"template\": \"generic\",\n \"updated_at\": \"2019-11-27T00:46:17.791Z\",\n \"variants\": [\n {\n \"_id\": \"5dddc759124159425407655a\",\n \"active\": true,\n \"active_segment_ids\": [\n\n ],\n \"created_at\": null,\n \"details\": {\n },\n \"name\": \"SKU\",\n \"position\": 0,\n \"sku\": \"SKU\",\n \"updated_at\": null\n }\n ]\n }\n ]\n}",
48
+ "response_content_type": "application/json",
49
+ "curl": "curl -g \"https://www.example.com/api/admin/products?sort_by=created_at&sort_direction=desc\" -X GET "
50
+ }
51
+ ],
52
+ "resource": "Global Functionality",
53
+ "description": "Sorting results",
54
+ "route": "/api/admin/products",
55
+ "http_method": "GET"
56
+ }
@@ -3,6 +3,13 @@
3
3
  {
4
4
  "name": "Categories",
5
5
  "examples": [
6
+ {
7
+ "description": "Bulk upserting categories",
8
+ "link": "admin/categories/bulk_upserting_categories.json",
9
+ "groups": "all",
10
+ "route": "/api/admin/categories/bulk",
11
+ "method": "PATCH"
12
+ },
6
13
  {
7
14
  "description": "Creating a category",
8
15
  "link": "admin/categories/creating_a_category.json",
@@ -11,11 +18,11 @@
11
18
  "method": "POST"
12
19
  },
13
20
  {
14
- "description": "Updating a category",
15
- "link": "admin/categories/updating_a_category.json",
21
+ "description": "Listing categories",
22
+ "link": "admin/categories/listing_categories.json",
16
23
  "groups": "all",
17
- "route": "/api/admin/categories/:id",
18
- "method": "PATCH"
24
+ "route": "/api/admin/categories",
25
+ "method": "GET"
19
26
  },
20
27
  {
21
28
  "description": "Removing a category",
@@ -32,118 +39,144 @@
32
39
  "method": "GET"
33
40
  },
34
41
  {
35
- "description": "Bulk upserting categories",
36
- "link": "admin/categories/bulk_upserting_categories.json",
42
+ "description": "Updating a category",
43
+ "link": "admin/categories/updating_a_category.json",
37
44
  "groups": "all",
38
- "route": "/api/admin/categories/bulk",
45
+ "route": "/api/admin/categories/:id",
39
46
  "method": "PATCH"
40
- },
41
- {
42
- "description": "Listing categories",
43
- "link": "admin/categories/listing_categories.json",
44
- "groups": "all",
45
- "route": "/api/admin/categories",
46
- "method": "GET"
47
47
  }
48
48
  ]
49
49
  },
50
50
  {
51
- "name": "Payment Profiles",
51
+ "name": "Category Product Rules",
52
52
  "examples": [
53
53
  {
54
- "description": "Listing payment profiles",
55
- "link": "admin/payment_profiles/listing_payment_profiles.json",
54
+ "description": "Creating a category product rule",
55
+ "link": "admin/category_product_rules/creating_a_category_product_rule.json",
56
56
  "groups": "all",
57
- "route": "/api/admin/payment_profiles",
58
- "method": "GET"
57
+ "route": "/api/admin/categories/:category_id/product_rules",
58
+ "method": "POST"
59
59
  },
60
60
  {
61
- "description": "Showing a payment profile",
62
- "link": "admin/payment_profiles/showing_a_payment_profile.json",
61
+ "description": "Listing category product rules",
62
+ "link": "admin/category_product_rules/listing_category_product_rules.json",
63
63
  "groups": "all",
64
- "route": "/api/admin/payment_profiles/:id",
64
+ "route": "/api/admin/categories/:category_id/product_rules",
65
65
  "method": "GET"
66
66
  },
67
67
  {
68
- "description": "Removing a payment profile",
69
- "link": "admin/payment_profiles/removing_a_payment_profile.json",
68
+ "description": "Removing a category product rule",
69
+ "link": "admin/category_product_rules/removing_a_category_product_rule.json",
70
70
  "groups": "all",
71
- "route": "/api/admin/payment_profiles/:id",
71
+ "route": "/api/admin/categories/:category_id/product_rules/:id",
72
72
  "method": "DELETE"
73
73
  },
74
74
  {
75
- "description": "Creating a payment profile",
76
- "link": "admin/payment_profiles/creating_a_payment_profile.json",
75
+ "description": "Updating a category product rule",
76
+ "link": "admin/category_product_rules/updating_a_category_product_rule.json",
77
77
  "groups": "all",
78
- "route": "/api/admin/payment_profiles",
78
+ "route": "/api/admin/categories/:category_id/product_rules/:id",
79
+ "method": "PATCH"
80
+ }
81
+ ]
82
+ },
83
+ {
84
+ "name": "Content",
85
+ "examples": [
86
+ {
87
+ "description": "Bulk upserting content",
88
+ "link": "admin/content/bulk_upserting_content.json",
89
+ "groups": "all",
90
+ "route": "/api/admin/content/bulk",
91
+ "method": "PATCH"
92
+ },
93
+ {
94
+ "description": "Creating content",
95
+ "link": "admin/content/creating_content.json",
96
+ "groups": "all",
97
+ "route": "/api/admin/content",
79
98
  "method": "POST"
80
99
  },
81
100
  {
82
- "description": "Updating a payment profiles",
83
- "link": "admin/payment_profiles/updating_a_payment_profiles.json",
101
+ "description": "Listing content",
102
+ "link": "admin/content/listing_content.json",
84
103
  "groups": "all",
85
- "route": "/api/admin/payment_profiles/:id",
86
- "method": "PATCH"
104
+ "route": "/api/admin/content",
105
+ "method": "POST"
87
106
  },
88
107
  {
89
- "description": "Bulk upserting payment profiles",
90
- "link": "admin/payment_profiles/bulk_upserting_payment_profiles.json",
108
+ "description": "Showing content",
109
+ "link": "admin/content/showing_content.json",
91
110
  "groups": "all",
92
- "route": "/api/admin/payment_profiles/bulk",
111
+ "route": "/api/admin/content/:id",
112
+ "method": "GET"
113
+ },
114
+ {
115
+ "description": "Updating content",
116
+ "link": "admin/content/updating_content.json",
117
+ "groups": "all",
118
+ "route": "/api/admin/content/:id",
93
119
  "method": "PATCH"
94
120
  }
95
121
  ]
96
122
  },
97
123
  {
98
- "name": "Shipping Services",
124
+ "name": "Content Assets",
99
125
  "examples": [
100
126
  {
101
- "description": "Bulk upserting shipping_services",
102
- "link": "admin/shipping_services/bulk_upserting_shipping_services.json",
127
+ "description": "Bulk upserting content assets",
128
+ "link": "admin/content_assets/bulk_upserting_content_assets.json",
103
129
  "groups": "all",
104
- "route": "/api/admin/shipping_services/bulk",
130
+ "route": "/api/admin/content_assets/bulk",
105
131
  "method": "PATCH"
106
132
  },
107
133
  {
108
- "description": "Removing a shipping_service",
109
- "link": "admin/shipping_services/removing_a_shipping_service.json",
134
+ "description": "Creating a content asset",
135
+ "link": "admin/content_assets/creating_a_content_asset.json",
110
136
  "groups": "all",
111
- "route": "/api/admin/shipping_services/:id",
112
- "method": "DELETE"
137
+ "route": "/api/admin/content_assets",
138
+ "method": "POST"
113
139
  },
114
140
  {
115
- "description": "Creating a shipping_service",
116
- "link": "admin/shipping_services/creating_a_shipping_service.json",
141
+ "description": "Listing content assets",
142
+ "link": "admin/content_assets/listing_content_assets.json",
117
143
  "groups": "all",
118
- "route": "/api/admin/shipping_services",
119
- "method": "POST"
144
+ "route": "/api/admin/content_assets",
145
+ "method": "GET"
120
146
  },
121
147
  {
122
- "description": "Updating a shipping_service",
123
- "link": "admin/shipping_services/updating_a_shipping_service.json",
148
+ "description": "Removing a content asset",
149
+ "link": "admin/content_assets/removing_a_content_asset.json",
124
150
  "groups": "all",
125
- "route": "/api/admin/shipping_services/:id",
126
- "method": "PATCH"
151
+ "route": "/api/admin/content_assets/:id",
152
+ "method": "DELETE"
127
153
  },
128
154
  {
129
- "description": "Listing shipping_services",
130
- "link": "admin/shipping_services/listing_shipping_services.json",
155
+ "description": "Showing a content asset",
156
+ "link": "admin/content_assets/showing_a_content_asset.json",
131
157
  "groups": "all",
132
- "route": "/api/admin/shipping_services",
158
+ "route": "/api/admin/content_assets/:id",
133
159
  "method": "GET"
134
160
  },
135
161
  {
136
- "description": "Showing a shipping_service",
137
- "link": "admin/shipping_services/showing_a_shipping_service.json",
162
+ "description": "Updating a content asset",
163
+ "link": "admin/content_assets/updating_a_content_asset.json",
138
164
  "groups": "all",
139
- "route": "/api/admin/shipping_services/:id",
140
- "method": "GET"
165
+ "route": "/api/admin/content_assets/:id",
166
+ "method": "PATCH"
141
167
  }
142
168
  ]
143
169
  },
144
170
  {
145
171
  "name": "Discounts",
146
172
  "examples": [
173
+ {
174
+ "description": "Creating a discount",
175
+ "link": "admin/discounts/creating_a_discount.json",
176
+ "groups": "all",
177
+ "route": "/api/admin/discounts",
178
+ "method": "POST"
179
+ },
147
180
  {
148
181
  "description": "Listing discounts",
149
182
  "link": "admin/discounts/listing_discounts.json",
@@ -152,11 +185,11 @@
152
185
  "method": "GET"
153
186
  },
154
187
  {
155
- "description": "Updating discounts",
156
- "link": "admin/discounts/updating_discounts.json",
188
+ "description": "Removing a discount",
189
+ "link": "admin/discounts/removing_a_discount.json",
157
190
  "groups": "all",
158
191
  "route": "/api/admin/discounts/:id",
159
- "method": "PATCH"
192
+ "method": "DELETE"
160
193
  },
161
194
  {
162
195
  "description": "Showing a discount",
@@ -166,18 +199,11 @@
166
199
  "method": "GET"
167
200
  },
168
201
  {
169
- "description": "Creating a discount",
170
- "link": "admin/discounts/creating_a_discount.json",
171
- "groups": "all",
172
- "route": "/api/admin/discounts",
173
- "method": "POST"
174
- },
175
- {
176
- "description": "Removing a discount",
177
- "link": "admin/discounts/removing_a_discount.json",
202
+ "description": "Updating discounts",
203
+ "link": "admin/discounts/updating_discounts.json",
178
204
  "groups": "all",
179
205
  "route": "/api/admin/discounts/:id",
180
- "method": "DELETE"
206
+ "method": "PATCH"
181
207
  }
182
208
  ]
183
209
  },
@@ -197,271 +223,233 @@
197
223
  "groups": "all",
198
224
  "route": "/api/admin/email_signups/:id",
199
225
  "method": "GET"
200
- }
201
- ]
202
- },
203
- {
204
- "name": "Pricing SKUs",
205
- "examples": [
226
+ },
206
227
  {
207
- "description": "Creating an pricing SKU",
208
- "link": "admin/pricing_skus/creating_an_pricing_sku.json",
228
+ "description": "Showing an email signup by ID",
229
+ "link": "admin/email_signups/showing_an_email_signup_by_id.json",
209
230
  "groups": "all",
210
- "route": "/api/admin/pricing_skus",
211
- "method": "POST"
231
+ "route": "/api/admin/email_signups/:id",
232
+ "method": "GET"
212
233
  },
213
234
  {
214
- "description": "Showing an pricing SKU",
215
- "link": "admin/pricing_skus/showing_an_pricing_sku.json",
235
+ "description": "Showing an email signup by email",
236
+ "link": "admin/email_signups/showing_an_email_signup_by_email.json",
216
237
  "groups": "all",
217
- "route": "/api/admin/pricing_skus/:id",
238
+ "route": "/api/admin/email_signups/:email",
218
239
  "method": "GET"
219
- },
240
+ }
241
+ ]
242
+ },
243
+ {
244
+ "name": "Fulfillment",
245
+ "examples": [
220
246
  {
221
- "description": "Updating an pricing SKU",
222
- "link": "admin/pricing_skus/updating_an_pricing_sku.json",
247
+ "description": "Listing fulfillments",
248
+ "link": "admin/fulfillment/listing_fulfillments.json",
223
249
  "groups": "all",
224
- "route": "/api/admin/pricing_skus/:id",
225
- "method": "PATCH"
250
+ "route": "/api/admin/fulfillments",
251
+ "method": "GET"
226
252
  },
227
253
  {
228
- "description": "Removing an pricing SKU",
229
- "link": "admin/pricing_skus/removing_an_pricing_sku.json",
254
+ "description": "Marking items as canceled",
255
+ "link": "admin/fulfillment/marking_items_as_canceled.json",
230
256
  "groups": "all",
231
- "route": "/api/admin/pricing_skus/:id",
232
- "method": "DELETE"
257
+ "route": "/api/admin/fulfillments/:order_id/cancel_items",
258
+ "method": "POST"
233
259
  },
234
260
  {
235
- "description": "Bulk upserting pricing SKUs",
236
- "link": "admin/pricing_skus/bulk_upserting_pricing_skus.json",
261
+ "description": "Marking items as shipped",
262
+ "link": "admin/fulfillment/marking_items_as_shipped.json",
237
263
  "groups": "all",
238
- "route": "/api/admin/pricing_skus/bulk",
239
- "method": "PATCH"
264
+ "route": "/api/admin/fulfillments/:order_id/ship_items",
265
+ "method": "POST"
240
266
  },
241
267
  {
242
- "description": "Listing pricing SKUs",
243
- "link": "admin/pricing_skus/listing_pricing_skus.json",
268
+ "description": "Showing fulfillment",
269
+ "link": "admin/fulfillment/showing_fulfillment.json",
244
270
  "groups": "all",
245
- "route": "/api/admin/pricing_skus",
271
+ "route": "/api/admin/fulfillments/:order_id",
246
272
  "method": "GET"
247
273
  }
248
274
  ]
249
275
  },
250
276
  {
251
- "name": "Navigation menus",
277
+ "name": "Global Functionality",
252
278
  "examples": [
253
279
  {
254
- "description": "Showing a navigation menu",
255
- "link": "admin/navigation_menus/showing_a_navigation_menu.json",
280
+ "description": "Dealing with locales",
281
+ "link": "admin/global_functionality/dealing_with_locales.json",
256
282
  "groups": "all",
257
- "route": "/api/admin/navigation_menus/:id",
283
+ "route": "/api/admin/products",
258
284
  "method": "GET"
259
285
  },
260
286
  {
261
- "description": "Listing menus",
262
- "link": "admin/navigation_menus/listing_menus.json",
287
+ "description": "Filtering by created at time stamp",
288
+ "link": "admin/global_functionality/filtering_by_created_at_time_stamp.json",
263
289
  "groups": "all",
264
- "route": "/api/admin/navigation_menus",
290
+ "route": "/api/admin/products",
265
291
  "method": "GET"
266
292
  },
267
293
  {
268
- "description": "Updating a navigation menus",
269
- "link": "admin/navigation_menus/updating_a_navigation_menus.json",
294
+ "description": "Filtering by updated time stamp",
295
+ "link": "admin/global_functionality/filtering_by_updated_time_stamp.json",
270
296
  "groups": "all",
271
- "route": "/api/admin/navigation_menus/:id",
272
- "method": "PATCH"
297
+ "route": "/api/admin/products",
298
+ "method": "GET"
273
299
  },
274
300
  {
275
- "description": "Creating a menu",
276
- "link": "admin/navigation_menus/creating_a_menu.json",
301
+ "description": "Paging results",
302
+ "link": "admin/global_functionality/paging_results.json",
277
303
  "groups": "all",
278
- "route": "/api/admin/navigation_menus",
279
- "method": "POST"
304
+ "route": "/api/admin/products",
305
+ "method": "GET"
280
306
  },
281
307
  {
282
- "description": "Removing a navigation menu",
283
- "link": "admin/navigation_menus/removing_a_navigation_menu.json",
308
+ "description": "Retrieving addtional pages of results",
309
+ "link": "admin/global_functionality/retrieving_addtional_pages_of_results.json",
284
310
  "groups": "all",
285
- "route": "/api/admin/navigation_menus/:id",
286
- "method": "DELETE"
311
+ "route": "/api/admin/products",
312
+ "method": "GET"
313
+ },
314
+ {
315
+ "description": "Sorting results",
316
+ "link": "admin/global_functionality/sorting_results.json",
317
+ "groups": "all",
318
+ "route": "/api/admin/products",
319
+ "method": "GET"
287
320
  }
288
321
  ]
289
322
  },
290
323
  {
291
- "name": "Navigation taxonomy",
324
+ "name": "Inventory SKUs",
292
325
  "examples": [
293
326
  {
294
- "description": "Creating a taxon",
295
- "link": "admin/navigation_taxonomy/creating_a_taxon.json",
296
- "groups": "all",
297
- "route": "/api/admin/navigation_taxons",
298
- "method": "POST"
299
- },
300
- {
301
- "description": "Listing taxons",
302
- "link": "admin/navigation_taxonomy/listing_taxons.json",
327
+ "description": "Bulk upserting inventory SKUs",
328
+ "link": "admin/inventory_skus/bulk_upserting_inventory_skus.json",
303
329
  "groups": "all",
304
- "route": "/api/admin/navigation_taxons",
305
- "method": "GET"
330
+ "route": "/api/admin/inventory_skus/bulk",
331
+ "method": "PATCH"
306
332
  },
307
333
  {
308
- "description": "Bulk upserting navigation taxons",
309
- "link": "admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json",
334
+ "description": "Creating an inventory SKU",
335
+ "link": "admin/inventory_skus/creating_an_inventory_sku.json",
310
336
  "groups": "all",
311
- "route": "/api/admin/navigation_taxons/bulk",
312
- "method": "PATCH"
337
+ "route": "/api/admin/inventory_skus",
338
+ "method": "POST"
313
339
  },
314
340
  {
315
- "description": "Updating a navigation taxons",
316
- "link": "admin/navigation_taxonomy/updating_a_navigation_taxons.json",
341
+ "description": "Listing inventory SKUs",
342
+ "link": "admin/inventory_skus/listing_inventory_skus.json",
317
343
  "groups": "all",
318
- "route": "/api/admin/navigation_taxons/:id",
319
- "method": "PATCH"
344
+ "route": "/api/admin/inventory_skus",
345
+ "method": "GET"
320
346
  },
321
347
  {
322
- "description": "Removing a navigation taxon",
323
- "link": "admin/navigation_taxonomy/removing_a_navigation_taxon.json",
348
+ "description": "Removing an inventory SKU",
349
+ "link": "admin/inventory_skus/removing_an_inventory_sku.json",
324
350
  "groups": "all",
325
- "route": "/api/admin/navigation_taxons/:id",
351
+ "route": "/api/admin/inventory_skus/:id",
326
352
  "method": "DELETE"
327
353
  },
328
354
  {
329
- "description": "Showing a navigation taxon",
330
- "link": "admin/navigation_taxonomy/showing_a_navigation_taxon.json",
331
- "groups": "all",
332
- "route": "/api/admin/navigation_taxons/:id",
333
- "method": "GET"
334
- }
335
- ]
336
- },
337
- {
338
- "name": "Payment transactions",
339
- "examples": [
340
- {
341
- "description": "Showing a payment transaction",
342
- "link": "admin/payment_transactions/showing_a_payment_transaction.json",
355
+ "description": "Showing an inventory SKU",
356
+ "link": "admin/inventory_skus/showing_an_inventory_sku.json",
343
357
  "groups": "all",
344
- "route": "/api/admin/payment_transactions/:id",
358
+ "route": "/api/admin/inventory_skus/:id",
345
359
  "method": "GET"
346
360
  },
347
361
  {
348
- "description": "Listing payment transactions",
349
- "link": "admin/payment_transactions/listing_payment_transactions.json",
362
+ "description": "Updating an inventory SKU",
363
+ "link": "admin/inventory_skus/updating_an_inventory_sku.json",
350
364
  "groups": "all",
351
- "route": "/api/admin/payment_transactions",
352
- "method": "GET"
365
+ "route": "/api/admin/inventory_skus/:id",
366
+ "method": "PATCH"
353
367
  }
354
368
  ]
355
369
  },
356
370
  {
357
- "name": "Tax Categories",
371
+ "name": "Navigation menus",
358
372
  "examples": [
359
373
  {
360
- "description": "Bulk upserting tax categories",
361
- "link": "admin/tax_categories/bulk_upserting_tax_categories.json",
374
+ "description": "Creating a menu",
375
+ "link": "admin/navigation_menus/creating_a_menu.json",
362
376
  "groups": "all",
363
- "route": "/api/admin/tax_categories/bulk",
364
- "method": "PATCH"
377
+ "route": "/api/admin/navigation_menus",
378
+ "method": "POST"
365
379
  },
366
380
  {
367
- "description": "Listing tax categories",
368
- "link": "admin/tax_categories/listing_tax_categories.json",
381
+ "description": "Listing menus",
382
+ "link": "admin/navigation_menus/listing_menus.json",
369
383
  "groups": "all",
370
- "route": "/api/admin/tax_categories",
384
+ "route": "/api/admin/navigation_menus",
371
385
  "method": "GET"
372
386
  },
373
387
  {
374
- "description": "Removing a tax category",
375
- "link": "admin/tax_categories/removing_a_tax_category.json",
388
+ "description": "Removing a navigation menu",
389
+ "link": "admin/navigation_menus/removing_a_navigation_menu.json",
376
390
  "groups": "all",
377
- "route": "/api/admin/tax_categories/:id",
391
+ "route": "/api/admin/navigation_menus/:id",
378
392
  "method": "DELETE"
379
393
  },
380
394
  {
381
- "description": "Showing a tax category",
382
- "link": "admin/tax_categories/showing_a_tax_category.json",
395
+ "description": "Showing a navigation menu",
396
+ "link": "admin/navigation_menus/showing_a_navigation_menu.json",
383
397
  "groups": "all",
384
- "route": "/api/admin/tax_categories/:id",
398
+ "route": "/api/admin/navigation_menus/:id",
385
399
  "method": "GET"
386
400
  },
387
401
  {
388
- "description": "Creating a tax category",
389
- "link": "admin/tax_categories/creating_a_tax_category.json",
390
- "groups": "all",
391
- "route": "/api/admin/tax_categories",
392
- "method": "POST"
393
- },
394
- {
395
- "description": "Updating a tax categories",
396
- "link": "admin/tax_categories/updating_a_tax_categories.json",
402
+ "description": "Updating a navigation menus",
403
+ "link": "admin/navigation_menus/updating_a_navigation_menus.json",
397
404
  "groups": "all",
398
- "route": "/api/admin/tax_categories/:id",
405
+ "route": "/api/admin/navigation_menus/:id",
399
406
  "method": "PATCH"
400
407
  }
401
408
  ]
402
409
  },
403
410
  {
404
- "name": "Category Product Rules",
411
+ "name": "Navigation taxonomy",
405
412
  "examples": [
406
413
  {
407
- "description": "Listing category product rules",
408
- "link": "admin/category_product_rules/listing_category_product_rules.json",
414
+ "description": "Bulk upserting navigation taxons",
415
+ "link": "admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json",
409
416
  "groups": "all",
410
- "route": "/api/admin/categories/:category_id/product_rules",
411
- "method": "GET"
417
+ "route": "/api/admin/navigation_taxons/bulk",
418
+ "method": "PATCH"
412
419
  },
413
420
  {
414
- "description": "Creating a category product rule",
415
- "link": "admin/category_product_rules/creating_a_category_product_rule.json",
421
+ "description": "Creating a taxon",
422
+ "link": "admin/navigation_taxonomy/creating_a_taxon.json",
416
423
  "groups": "all",
417
- "route": "/api/admin/categories/:category_id/product_rules",
424
+ "route": "/api/admin/navigation_taxons",
418
425
  "method": "POST"
419
426
  },
420
427
  {
421
- "description": "Updating a category product rule",
422
- "link": "admin/category_product_rules/updating_a_category_product_rule.json",
423
- "groups": "all",
424
- "route": "/api/admin/categories/:category_id/product_rules/:id",
425
- "method": "PATCH"
426
- },
427
- {
428
- "description": "Removing a category product rule",
429
- "link": "admin/category_product_rules/removing_a_category_product_rule.json",
430
- "groups": "all",
431
- "route": "/api/admin/categories/:category_id/product_rules/:id",
432
- "method": "DELETE"
433
- }
434
- ]
435
- },
436
- {
437
- "name": "Prices",
438
- "examples": [
439
- {
440
- "description": "Listing pricing sku prices",
441
- "link": "admin/prices/listing_pricing_sku_prices.json",
428
+ "description": "Listing taxons",
429
+ "link": "admin/navigation_taxonomy/listing_taxons.json",
442
430
  "groups": "all",
443
- "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
431
+ "route": "/api/admin/navigation_taxons",
444
432
  "method": "GET"
445
433
  },
446
434
  {
447
- "description": "Removing a pricing sku price",
448
- "link": "admin/prices/removing_a_pricing_sku_price.json",
435
+ "description": "Removing a navigation taxon",
436
+ "link": "admin/navigation_taxonomy/removing_a_navigation_taxon.json",
449
437
  "groups": "all",
450
- "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
438
+ "route": "/api/admin/navigation_taxons/:id",
451
439
  "method": "DELETE"
452
440
  },
453
441
  {
454
- "description": "Creating a pricing sku price",
455
- "link": "admin/prices/creating_a_pricing_sku_price.json",
442
+ "description": "Showing a navigation taxon",
443
+ "link": "admin/navigation_taxonomy/showing_a_navigation_taxon.json",
456
444
  "groups": "all",
457
- "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
458
- "method": "POST"
445
+ "route": "/api/admin/navigation_taxons/:id",
446
+ "method": "GET"
459
447
  },
460
448
  {
461
- "description": "Updating a pricing sku price",
462
- "link": "admin/prices/updating_a_pricing_sku_price.json",
449
+ "description": "Updating a navigation taxons",
450
+ "link": "admin/navigation_taxonomy/updating_a_navigation_taxons.json",
463
451
  "groups": "all",
464
- "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
452
+ "route": "/api/admin/navigation_taxons/:id",
465
453
  "method": "PATCH"
466
454
  }
467
455
  ]
@@ -477,17 +465,17 @@
477
465
  "method": "GET"
478
466
  },
479
467
  {
480
- "description": "Viewing orders by date range",
481
- "link": "admin/orders/viewing_orders_by_date_range.json",
468
+ "description": "Showing an order",
469
+ "link": "admin/orders/showing_an_order.json",
482
470
  "groups": "all",
483
- "route": "/api/admin/orders",
471
+ "route": "/api/admin/orders/:id",
484
472
  "method": "GET"
485
473
  },
486
474
  {
487
- "description": "Showing an order",
488
- "link": "admin/orders/showing_an_order.json",
475
+ "description": "Viewing orders by date range",
476
+ "link": "admin/orders/viewing_orders_by_date_range.json",
489
477
  "groups": "all",
490
- "route": "/api/admin/orders/:id",
478
+ "route": "/api/admin/orders",
491
479
  "method": "GET"
492
480
  }
493
481
  ]
@@ -495,13 +483,6 @@
495
483
  {
496
484
  "name": "Pages",
497
485
  "examples": [
498
- {
499
- "description": "Updating a page",
500
- "link": "admin/pages/updating_a_page.json",
501
- "groups": "all",
502
- "route": "/api/admin/pages/:id",
503
- "method": "PATCH"
504
- },
505
486
  {
506
487
  "description": "Bulk upserting pages",
507
488
  "link": "admin/pages/bulk_upserting_pages.json",
@@ -509,6 +490,20 @@
509
490
  "route": "/api/admin/pages/bulk",
510
491
  "method": "PATCH"
511
492
  },
493
+ {
494
+ "description": "Creating a page",
495
+ "link": "admin/pages/creating_a_page.json",
496
+ "groups": "all",
497
+ "route": "/api/admin/pages",
498
+ "method": "POST"
499
+ },
500
+ {
501
+ "description": "Listing pages",
502
+ "link": "admin/pages/listing_pages.json",
503
+ "groups": "all",
504
+ "route": "/api/admin/pages",
505
+ "method": "GET"
506
+ },
512
507
  {
513
508
  "description": "Removing a page",
514
509
  "link": "admin/pages/removing_a_page.json",
@@ -524,213 +519,260 @@
524
519
  "method": "GET"
525
520
  },
526
521
  {
527
- "description": "Creating a page",
528
- "link": "admin/pages/creating_a_page.json",
529
- "groups": "all",
530
- "route": "/api/admin/pages",
531
- "method": "POST"
532
- },
533
- {
534
- "description": "Listing pages",
535
- "link": "admin/pages/listing_pages.json",
522
+ "description": "Updating a page",
523
+ "link": "admin/pages/updating_a_page.json",
536
524
  "groups": "all",
537
- "route": "/api/admin/pages",
538
- "method": "GET"
525
+ "route": "/api/admin/pages/:id",
526
+ "method": "PATCH"
539
527
  }
540
528
  ]
541
529
  },
542
530
  {
543
- "name": "Saved Addresses",
531
+ "name": "Payment Profiles",
544
532
  "examples": [
545
533
  {
546
- "description": "Creating a saved address",
547
- "link": "admin/saved_addresses/creating_a_saved_address.json",
534
+ "description": "Bulk upserting payment profiles",
535
+ "link": "admin/payment_profiles/bulk_upserting_payment_profiles.json",
548
536
  "groups": "all",
549
- "route": "/api/admin/users/:user_id/saved_addresses",
537
+ "route": "/api/admin/payment_profiles/bulk",
538
+ "method": "PATCH"
539
+ },
540
+ {
541
+ "description": "Creating a payment profile",
542
+ "link": "admin/payment_profiles/creating_a_payment_profile.json",
543
+ "groups": "all",
544
+ "route": "/api/admin/payment_profiles",
550
545
  "method": "POST"
551
546
  },
552
547
  {
553
- "description": "Updating a saved address",
554
- "link": "admin/saved_addresses/updating_a_saved_address.json",
548
+ "description": "Listing payment profiles",
549
+ "link": "admin/payment_profiles/listing_payment_profiles.json",
555
550
  "groups": "all",
556
- "route": "/api/admin/users/:user_id/saved_addresses/:id",
557
- "method": "PATCH"
551
+ "route": "/api/admin/payment_profiles",
552
+ "method": "GET"
558
553
  },
559
554
  {
560
- "description": "Removing a saved address",
561
- "link": "admin/saved_addresses/removing_a_saved_address.json",
555
+ "description": "Removing a payment profile",
556
+ "link": "admin/payment_profiles/removing_a_payment_profile.json",
562
557
  "groups": "all",
563
- "route": "/api/admin/users/:user_id/saved_addresses/:id",
558
+ "route": "/api/admin/payment_profiles/:id",
564
559
  "method": "DELETE"
565
560
  },
566
561
  {
567
- "description": "Listing saved address",
568
- "link": "admin/saved_addresses/listing_saved_address.json",
562
+ "description": "Showing a payment profile",
563
+ "link": "admin/payment_profiles/showing_a_payment_profile.json",
569
564
  "groups": "all",
570
- "route": "/api/admin/users/:user_id/saved_addresses",
565
+ "route": "/api/admin/payment_profiles/:id",
571
566
  "method": "GET"
567
+ },
568
+ {
569
+ "description": "Updating a payment profiles",
570
+ "link": "admin/payment_profiles/updating_a_payment_profiles.json",
571
+ "groups": "all",
572
+ "route": "/api/admin/payment_profiles/:id",
573
+ "method": "PATCH"
572
574
  }
573
575
  ]
574
576
  },
575
577
  {
576
- "name": "Tax Rates",
578
+ "name": "Payment transactions",
577
579
  "examples": [
578
580
  {
579
- "description": "Listing tax rates",
580
- "link": "admin/tax_rates/listing_tax_rates.json",
581
+ "description": "Listing payment transactions",
582
+ "link": "admin/payment_transactions/listing_payment_transactions.json",
581
583
  "groups": "all",
582
- "route": "/api/admin/tax_categories/:tax_category_id/rates",
584
+ "route": "/api/admin/payment_transactions",
583
585
  "method": "GET"
584
586
  },
585
587
  {
586
- "description": "Removing a tax rate",
587
- "link": "admin/tax_rates/removing_a_tax_rate.json",
588
+ "description": "Showing a payment transaction",
589
+ "link": "admin/payment_transactions/showing_a_payment_transaction.json",
588
590
  "groups": "all",
589
- "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
590
- "method": "PATCH"
591
- },
591
+ "route": "/api/admin/payment_transactions/:id",
592
+ "method": "GET"
593
+ }
594
+ ]
595
+ },
596
+ {
597
+ "name": "Payments",
598
+ "examples": [
592
599
  {
593
- "description": "Updating a tax rate",
594
- "link": "admin/tax_rates/updating_a_tax_rate.json",
600
+ "description": "Listing payments",
601
+ "link": "admin/payments/listing_payments.json",
595
602
  "groups": "all",
596
- "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
597
- "method": "PATCH"
603
+ "route": "/api/admin/payments",
604
+ "method": "GET"
598
605
  },
599
606
  {
600
- "description": "Creating a tax rate",
601
- "link": "admin/tax_rates/creating_a_tax_rate.json",
607
+ "description": "Showing an payment",
608
+ "link": "admin/payments/showing_an_payment.json",
602
609
  "groups": "all",
603
- "route": "/api/admin/tax_categories/:tax_category_id/rates",
610
+ "route": "/api/admin/payments/:id",
611
+ "method": "GET"
612
+ }
613
+ ]
614
+ },
615
+ {
616
+ "name": "Prices",
617
+ "examples": [
618
+ {
619
+ "description": "Creating a pricing sku price",
620
+ "link": "admin/prices/creating_a_pricing_sku_price.json",
621
+ "groups": "all",
622
+ "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
604
623
  "method": "POST"
624
+ },
625
+ {
626
+ "description": "Listing pricing sku prices",
627
+ "link": "admin/prices/listing_pricing_sku_prices.json",
628
+ "groups": "all",
629
+ "route": "/api/admin/pricing_skus/:pricing_sku_id/prices",
630
+ "method": "GET"
631
+ },
632
+ {
633
+ "description": "Removing a pricing sku price",
634
+ "link": "admin/prices/removing_a_pricing_sku_price.json",
635
+ "groups": "all",
636
+ "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
637
+ "method": "DELETE"
638
+ },
639
+ {
640
+ "description": "Updating a pricing sku price",
641
+ "link": "admin/prices/updating_a_pricing_sku_price.json",
642
+ "groups": "all",
643
+ "route": "/api/admin/pricing_skus/:pricing_sku_id/prices/:id",
644
+ "method": "PATCH"
605
645
  }
606
646
  ]
607
647
  },
608
648
  {
609
- "name": "Product Images",
649
+ "name": "Pricing SKUs",
610
650
  "examples": [
611
651
  {
612
- "description": "Updating a product image",
613
- "link": "admin/product_images/updating_a_product_image.json",
652
+ "description": "Bulk upserting pricing SKUs",
653
+ "link": "admin/pricing_skus/bulk_upserting_pricing_skus.json",
614
654
  "groups": "all",
615
- "route": "/api/admin/products/:product_id/images/:id",
655
+ "route": "/api/admin/pricing_skus/bulk",
616
656
  "method": "PATCH"
617
657
  },
618
658
  {
619
- "description": "Listing product images",
620
- "link": "admin/product_images/listing_product_images.json",
659
+ "description": "Creating an pricing SKU",
660
+ "link": "admin/pricing_skus/creating_an_pricing_sku.json",
621
661
  "groups": "all",
622
- "route": "/api/admin/products/:product_id/images",
662
+ "route": "/api/admin/pricing_skus",
663
+ "method": "POST"
664
+ },
665
+ {
666
+ "description": "Listing pricing SKUs",
667
+ "link": "admin/pricing_skus/listing_pricing_skus.json",
668
+ "groups": "all",
669
+ "route": "/api/admin/pricing_skus",
623
670
  "method": "GET"
624
671
  },
625
672
  {
626
- "description": "Removing a product image",
627
- "link": "admin/product_images/removing_a_product_image.json",
673
+ "description": "Removing an pricing SKU",
674
+ "link": "admin/pricing_skus/removing_an_pricing_sku.json",
628
675
  "groups": "all",
629
- "route": "/api/admin/products/:product_id/images/:id",
676
+ "route": "/api/admin/pricing_skus/:id",
630
677
  "method": "DELETE"
631
678
  },
632
679
  {
633
- "description": "Creating a product image from URL",
634
- "link": "admin/product_images/creating_a_product_image_from_url.json",
680
+ "description": "Showing an pricing SKU",
681
+ "link": "admin/pricing_skus/showing_an_pricing_sku.json",
635
682
  "groups": "all",
636
- "route": "/api/admin/products/:product_id/images",
637
- "method": "POST"
683
+ "route": "/api/admin/pricing_skus/:id",
684
+ "method": "GET"
638
685
  },
639
686
  {
640
- "description": "Creating a product image from Base64",
641
- "link": "admin/product_images/creating_a_product_image_from_base64.json",
687
+ "description": "Updating an pricing SKU",
688
+ "link": "admin/pricing_skus/updating_an_pricing_sku.json",
642
689
  "groups": "all",
643
- "route": "/api/admin/products/:product_id/images",
644
- "method": "POST"
690
+ "route": "/api/admin/pricing_skus/:id",
691
+ "method": "PATCH"
645
692
  }
646
693
  ]
647
694
  },
648
695
  {
649
- "name": "Fulfillment",
696
+ "name": "Product Images",
650
697
  "examples": [
651
698
  {
652
- "description": "Showing fulfillment",
653
- "link": "admin/fulfillment/showing_fulfillment.json",
699
+ "description": "Creating a product image from Base64",
700
+ "link": "admin/product_images/creating_a_product_image_from_base64.json",
654
701
  "groups": "all",
655
- "route": "/api/admin/fulfillments/:order_id",
656
- "method": "GET"
702
+ "route": "/api/admin/products/:product_id/images",
703
+ "method": "POST"
657
704
  },
658
705
  {
659
- "description": "Listing fulfillments",
660
- "link": "admin/fulfillment/listing_fulfillments.json",
706
+ "description": "Creating a product image from URL",
707
+ "link": "admin/product_images/creating_a_product_image_from_url.json",
661
708
  "groups": "all",
662
- "route": "/api/admin/fulfillments",
709
+ "route": "/api/admin/products/:product_id/images",
710
+ "method": "POST"
711
+ },
712
+ {
713
+ "description": "Listing product images",
714
+ "link": "admin/product_images/listing_product_images.json",
715
+ "groups": "all",
716
+ "route": "/api/admin/products/:product_id/images",
663
717
  "method": "GET"
664
718
  },
665
719
  {
666
- "description": "Marking items as canceled",
667
- "link": "admin/fulfillment/marking_items_as_canceled.json",
720
+ "description": "Removing a product image",
721
+ "link": "admin/product_images/removing_a_product_image.json",
668
722
  "groups": "all",
669
- "route": "/api/admin/fulfillments/:order_id/cancel_items",
670
- "method": "POST"
723
+ "route": "/api/admin/products/:product_id/images/:id",
724
+ "method": "DELETE"
671
725
  },
672
726
  {
673
- "description": "Marking items as shipped",
674
- "link": "admin/fulfillment/marking_items_as_shipped.json",
727
+ "description": "Updating a product image",
728
+ "link": "admin/product_images/updating_a_product_image.json",
675
729
  "groups": "all",
676
- "route": "/api/admin/fulfillments/:order_id/ship_items",
677
- "method": "POST"
730
+ "route": "/api/admin/products/:product_id/images/:id",
731
+ "method": "PATCH"
678
732
  }
679
733
  ]
680
734
  },
681
735
  {
682
- "name": "Content Assets",
736
+ "name": "Products",
683
737
  "examples": [
684
738
  {
685
- "description": "Removing a content asset",
686
- "link": "admin/content_assets/removing_a_content_asset.json",
739
+ "description": "Bulk upserting products",
740
+ "link": "admin/products/bulk_upserting_products.json",
687
741
  "groups": "all",
688
- "route": "/api/admin/content_assets/:id",
689
- "method": "DELETE"
742
+ "route": "/api/admin/products/bulk",
743
+ "method": "PATCH"
690
744
  },
691
745
  {
692
- "description": "Bulk upserting content assets",
693
- "link": "admin/content_assets/bulk_upserting_content_assets.json",
746
+ "description": "Creating a product",
747
+ "link": "admin/products/creating_a_product.json",
694
748
  "groups": "all",
695
- "route": "/api/admin/content_assets/bulk",
696
- "method": "PATCH"
749
+ "route": "/api/admin/products",
750
+ "method": "POST"
697
751
  },
698
752
  {
699
- "description": "Listing content assets",
700
- "link": "admin/content_assets/listing_content_assets.json",
753
+ "description": "Listing products",
754
+ "link": "admin/products/listing_products.json",
701
755
  "groups": "all",
702
- "route": "/api/admin/content_assets",
756
+ "route": "/api/admin/products",
703
757
  "method": "GET"
704
758
  },
705
759
  {
706
- "description": "Updating a content asset",
707
- "link": "admin/content_assets/updating_a_content_asset.json",
760
+ "description": "Removing a product",
761
+ "link": "admin/products/removing_a_product.json",
708
762
  "groups": "all",
709
- "route": "/api/admin/content_assets/:id",
710
- "method": "PATCH"
763
+ "route": "/api/admin/products/:id",
764
+ "method": "DELETE"
711
765
  },
712
766
  {
713
- "description": "Showing a content asset",
714
- "link": "admin/content_assets/showing_a_content_asset.json",
767
+ "description": "Showing a product",
768
+ "link": "admin/products/showing_a_product.json",
715
769
  "groups": "all",
716
- "route": "/api/admin/content_assets/:id",
770
+ "route": "/api/admin/products/:id",
717
771
  "method": "GET"
718
772
  },
719
773
  {
720
- "description": "Creating a content asset",
721
- "link": "admin/content_assets/creating_a_content_asset.json",
722
- "groups": "all",
723
- "route": "/api/admin/content_assets",
724
- "method": "POST"
725
- }
726
- ]
727
- },
728
- {
729
- "name": "Release Changes",
730
- "examples": [
731
- {
732
- "description": "Adding changes to a release",
733
- "link": "admin/release_changes/adding_changes_to_a_release.json",
774
+ "description": "Updating a product",
775
+ "link": "admin/products/updating_a_product.json",
734
776
  "groups": "all",
735
777
  "route": "/api/admin/products/:id",
736
778
  "method": "PATCH"
@@ -747,6 +789,13 @@
747
789
  "route": "/api/admin/promo_code_lists/bulk",
748
790
  "method": "PATCH"
749
791
  },
792
+ {
793
+ "description": "Creating a promo code list",
794
+ "link": "admin/promo_code_lists/creating_a_promo_code_list.json",
795
+ "groups": "all",
796
+ "route": "/api/admin/promo_code_lists",
797
+ "method": "POST"
798
+ },
750
799
  {
751
800
  "description": "Listing promo code lists",
752
801
  "link": "admin/promo_code_lists/listing_promo_code_lists.json",
@@ -755,11 +804,11 @@
755
804
  "method": "GET"
756
805
  },
757
806
  {
758
- "description": "Creating a promo code list",
759
- "link": "admin/promo_code_lists/creating_a_promo_code_list.json",
807
+ "description": "Removing a promo code list",
808
+ "link": "admin/promo_code_lists/removing_a_promo_code_list.json",
760
809
  "groups": "all",
761
- "route": "/api/admin/promo_code_lists",
762
- "method": "POST"
810
+ "route": "/api/admin/promo_code_lists/:id",
811
+ "method": "DELETE"
763
812
  },
764
813
  {
765
814
  "description": "Showing a promo code list",
@@ -774,444 +823,470 @@
774
823
  "groups": "all",
775
824
  "route": "/api/admin/promo_code_lists/:id",
776
825
  "method": "PATCH"
777
- },
778
- {
779
- "description": "Removing a promo code list",
780
- "link": "admin/promo_code_lists/removing_a_promo_code_list.json",
781
- "groups": "all",
782
- "route": "/api/admin/promo_code_lists/:id",
783
- "method": "DELETE"
784
826
  }
785
827
  ]
786
828
  },
787
829
  {
788
- "name": "Variants",
830
+ "name": "Recommendation Settings",
789
831
  "examples": [
790
832
  {
791
- "description": "Creating a product variant",
792
- "link": "admin/variants/creating_a_product_variant.json",
793
- "groups": "all",
794
- "route": "/api/admin/products/:product_id/variants",
795
- "method": "POST"
796
- },
797
- {
798
- "description": "Removing a product variant",
799
- "link": "admin/variants/removing_a_product_variant.json",
833
+ "description": "Showing recommendation settings",
834
+ "link": "admin/recommendation_settings/showing_recommendation_settings.json",
800
835
  "groups": "all",
801
- "route": "/api/admin/products/:product_id/variants/:id",
802
- "method": "DELETE"
836
+ "route": "/api/admin/products/:product_id/recommendation_settings",
837
+ "method": "GET"
803
838
  },
804
839
  {
805
- "description": "Updating a product variant",
806
- "link": "admin/variants/updating_a_product_variant.json",
840
+ "description": "Updating recommendation settings",
841
+ "link": "admin/recommendation_settings/updating_recommendation_settings.json",
807
842
  "groups": "all",
808
- "route": "/api/admin/products/:product_id/variants/:id",
843
+ "route": "/api/admin/products/:product_id/recommendation_settings",
809
844
  "method": "PATCH"
810
- },
811
- {
812
- "description": "Listing product variants",
813
- "link": "admin/variants/listing_product_variants.json",
814
- "groups": "all",
815
- "route": "/api/admin/products/:product_id/variants",
816
- "method": "GET"
817
845
  }
818
846
  ]
819
847
  },
820
848
  {
821
- "name": "Payments",
849
+ "name": "Redirects",
822
850
  "examples": [
823
851
  {
824
- "description": "Listing payments",
825
- "link": "admin/payments/listing_payments.json",
852
+ "description": "Bulk upserting redirects",
853
+ "link": "admin/redirects/bulk_upserting_redirects.json",
826
854
  "groups": "all",
827
- "route": "/api/admin/payments",
828
- "method": "GET"
855
+ "route": "/api/admin/redirects/bulk",
856
+ "method": "PATCH"
829
857
  },
830
858
  {
831
- "description": "Showing an payment",
832
- "link": "admin/payments/showing_an_payment.json",
833
- "groups": "all",
834
- "route": "/api/admin/payments/:id",
835
- "method": "GET"
836
- }
837
- ]
838
- },
839
- {
840
- "name": "Products",
841
- "examples": [
842
- {
843
- "description": "Removing a product",
844
- "link": "admin/products/removing_a_product.json",
859
+ "description": "Creating a redirect",
860
+ "link": "admin/redirects/creating_a_redirect.json",
845
861
  "groups": "all",
846
- "route": "/api/admin/products/:id",
847
- "method": "DELETE"
862
+ "route": "/api/admin/redirects",
863
+ "method": "POST"
848
864
  },
849
865
  {
850
- "description": "Updating a product",
851
- "link": "admin/products/updating_a_product.json",
866
+ "description": "Listing redirects",
867
+ "link": "admin/redirects/listing_redirects.json",
852
868
  "groups": "all",
853
- "route": "/api/admin/products/:id",
854
- "method": "PATCH"
869
+ "route": "/api/admin/redirects",
870
+ "method": "GET"
855
871
  },
856
872
  {
857
- "description": "Showing a product",
858
- "link": "admin/products/showing_a_product.json",
873
+ "description": "Removing a redirect",
874
+ "link": "admin/redirects/removing_a_redirect.json",
859
875
  "groups": "all",
860
- "route": "/api/admin/products/:id",
861
- "method": "GET"
876
+ "route": "/api/admin/redirects/:id",
877
+ "method": "DELETE"
862
878
  },
863
879
  {
864
- "description": "Listing products",
865
- "link": "admin/products/listing_products.json",
880
+ "description": "Showing a redirect",
881
+ "link": "admin/redirects/showing_a_redirect.json",
866
882
  "groups": "all",
867
- "route": "/api/admin/products",
883
+ "route": "/api/admin/redirects/:id",
868
884
  "method": "GET"
869
885
  },
870
886
  {
871
- "description": "Creating a product",
872
- "link": "admin/products/creating_a_product.json",
887
+ "description": "Updating a redirects",
888
+ "link": "admin/redirects/updating_a_redirects.json",
873
889
  "groups": "all",
874
- "route": "/api/admin/products",
875
- "method": "POST"
876
- },
890
+ "route": "/api/admin/redirects/:id",
891
+ "method": "PATCH"
892
+ }
893
+ ]
894
+ },
895
+ {
896
+ "name": "Release Changes",
897
+ "examples": [
877
898
  {
878
- "description": "Bulk upserting products",
879
- "link": "admin/products/bulk_upserting_products.json",
899
+ "description": "Adding changes to a release",
900
+ "link": "admin/release_changes/adding_changes_to_a_release.json",
880
901
  "groups": "all",
881
- "route": "/api/admin/products/bulk",
902
+ "route": "/api/admin/products/:id",
882
903
  "method": "PATCH"
883
904
  }
884
905
  ]
885
906
  },
886
907
  {
887
- "name": "Shipping Rates",
908
+ "name": "Releases",
888
909
  "examples": [
889
910
  {
890
- "description": "Updating a shipping rate",
891
- "link": "admin/shipping_rates/updating_a_shipping_rate.json",
911
+ "description": "Bulk upserting releases",
912
+ "link": "admin/releases/bulk_upserting_releases.json",
892
913
  "groups": "all",
893
- "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
914
+ "route": "/api/admin/releases/bulk",
894
915
  "method": "PATCH"
895
916
  },
896
917
  {
897
- "description": "Creating a shipping rate",
898
- "link": "admin/shipping_rates/creating_a_shipping_rate.json",
918
+ "description": "Creating a release",
919
+ "link": "admin/releases/creating_a_release.json",
899
920
  "groups": "all",
900
- "route": "/api/admin/shipping_services/:shipping_service_id/rates",
921
+ "route": "/api/admin/releases",
901
922
  "method": "POST"
902
923
  },
903
924
  {
904
- "description": "Listing shipping rates",
905
- "link": "admin/shipping_rates/listing_shipping_rates.json",
925
+ "description": "Listing releases",
926
+ "link": "admin/releases/listing_releases.json",
906
927
  "groups": "all",
907
- "route": "/api/admin/shipping_services/:shipping_service_id/rates",
928
+ "route": "/api/admin/releases",
908
929
  "method": "GET"
909
930
  },
910
931
  {
911
- "description": "Removing a shipping rate",
912
- "link": "admin/shipping_rates/removing_a_shipping_rate.json",
932
+ "description": "Removing a release",
933
+ "link": "admin/releases/removing_a_release.json",
913
934
  "groups": "all",
914
- "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
935
+ "route": "/api/admin/releases/:id",
915
936
  "method": "DELETE"
916
- }
917
- ]
918
- },
919
- {
920
- "name": "Recommendation Settings",
921
- "examples": [
937
+ },
922
938
  {
923
- "description": "Showing recommendation settings",
924
- "link": "admin/recommendation_settings/showing_recommendation_settings.json",
939
+ "description": "Showing a release",
940
+ "link": "admin/releases/showing_a_release.json",
925
941
  "groups": "all",
926
- "route": "/api/admin/products/:product_id/recommendation_settings",
942
+ "route": "/api/admin/releases/:id",
927
943
  "method": "GET"
928
944
  },
929
945
  {
930
- "description": "Updating recommendation settings",
931
- "link": "admin/recommendation_settings/updating_recommendation_settings.json",
946
+ "description": "Updating a release",
947
+ "link": "admin/releases/updating_a_release.json",
932
948
  "groups": "all",
933
- "route": "/api/admin/products/:product_id/recommendation_settings",
949
+ "route": "/api/admin/releases/:id",
934
950
  "method": "PATCH"
935
951
  }
936
952
  ]
937
953
  },
938
954
  {
939
- "name": "Saved Credit Cards",
955
+ "name": "Saved Addresses",
940
956
  "examples": [
941
957
  {
942
- "description": "Removing a saved credit card",
943
- "link": "admin/saved_credit_cards/removing_a_saved_credit_card.json",
958
+ "description": "Creating a saved address",
959
+ "link": "admin/saved_addresses/creating_a_saved_address.json",
944
960
  "groups": "all",
945
- "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
946
- "method": "DELETE"
961
+ "route": "/api/admin/users/:user_id/saved_addresses",
962
+ "method": "POST"
947
963
  },
948
964
  {
949
- "description": "Listing saved credit cards",
950
- "link": "admin/saved_credit_cards/listing_saved_credit_cards.json",
965
+ "description": "Listing saved address",
966
+ "link": "admin/saved_addresses/listing_saved_address.json",
951
967
  "groups": "all",
952
- "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
968
+ "route": "/api/admin/users/:user_id/saved_addresses",
953
969
  "method": "GET"
954
970
  },
955
971
  {
956
- "description": "Updating a saved credit card",
957
- "link": "admin/saved_credit_cards/updating_a_saved_credit_card.json",
972
+ "description": "Removing a saved address",
973
+ "link": "admin/saved_addresses/removing_a_saved_address.json",
958
974
  "groups": "all",
959
- "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
960
- "method": "PATCH"
975
+ "route": "/api/admin/users/:user_id/saved_addresses/:id",
976
+ "method": "DELETE"
961
977
  },
962
978
  {
963
- "description": "Creating a saved credit card",
964
- "link": "admin/saved_credit_cards/creating_a_saved_credit_card.json",
979
+ "description": "Updating a saved address",
980
+ "link": "admin/saved_addresses/updating_a_saved_address.json",
965
981
  "groups": "all",
966
- "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
967
- "method": "POST"
982
+ "route": "/api/admin/users/:user_id/saved_addresses/:id",
983
+ "method": "PATCH"
968
984
  }
969
985
  ]
970
986
  },
971
987
  {
972
- "name": "Content",
988
+ "name": "Saved Credit Cards",
973
989
  "examples": [
974
990
  {
975
- "description": "Listing content",
976
- "link": "admin/content/listing_content.json",
991
+ "description": "Creating a saved credit card",
992
+ "link": "admin/saved_credit_cards/creating_a_saved_credit_card.json",
977
993
  "groups": "all",
978
- "route": "/api/admin/content",
994
+ "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
979
995
  "method": "POST"
980
996
  },
981
997
  {
982
- "description": "Showing content",
983
- "link": "admin/content/showing_content.json",
998
+ "description": "Listing saved credit cards",
999
+ "link": "admin/saved_credit_cards/listing_saved_credit_cards.json",
984
1000
  "groups": "all",
985
- "route": "/api/admin/content/:id",
1001
+ "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards",
986
1002
  "method": "GET"
987
1003
  },
988
1004
  {
989
- "description": "Bulk upserting content",
990
- "link": "admin/content/bulk_upserting_content.json",
991
- "groups": "all",
992
- "route": "/api/admin/content/bulk",
993
- "method": "PATCH"
994
- },
995
- {
996
- "description": "Creating content",
997
- "link": "admin/content/creating_content.json",
1005
+ "description": "Removing a saved credit card",
1006
+ "link": "admin/saved_credit_cards/removing_a_saved_credit_card.json",
998
1007
  "groups": "all",
999
- "route": "/api/admin/content",
1000
- "method": "POST"
1008
+ "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
1009
+ "method": "DELETE"
1001
1010
  },
1002
1011
  {
1003
- "description": "Updating content",
1004
- "link": "admin/content/updating_content.json",
1012
+ "description": "Updating a saved credit card",
1013
+ "link": "admin/saved_credit_cards/updating_a_saved_credit_card.json",
1005
1014
  "groups": "all",
1006
- "route": "/api/admin/content/:id",
1015
+ "route": "/api/admin/payment_profiles/:payment_profile_id/saved_credit_cards/:id",
1007
1016
  "method": "PATCH"
1008
1017
  }
1009
1018
  ]
1010
1019
  },
1011
1020
  {
1012
- "name": "Releases",
1021
+ "name": "Shipping",
1013
1022
  "examples": [
1014
1023
  {
1015
- "description": "Listing releases",
1016
- "link": "admin/releases/listing_releases.json",
1024
+ "description": "Listing shipments",
1025
+ "link": "admin/shipping/listing_shipments.json",
1017
1026
  "groups": "all",
1018
- "route": "/api/admin/releases",
1027
+ "route": "/api/admin/shippings",
1019
1028
  "method": "GET"
1020
1029
  },
1021
1030
  {
1022
- "description": "Showing a release",
1023
- "link": "admin/releases/showing_a_release.json",
1031
+ "description": "Showing a shipment",
1032
+ "link": "admin/shipping/showing_a_shipment.json",
1024
1033
  "groups": "all",
1025
- "route": "/api/admin/releases/:id",
1034
+ "route": "/api/admin/shippings/:id",
1026
1035
  "method": "GET"
1027
- },
1036
+ }
1037
+ ]
1038
+ },
1039
+ {
1040
+ "name": "Shipping Rates",
1041
+ "examples": [
1028
1042
  {
1029
- "description": "Updating a release",
1030
- "link": "admin/releases/updating_a_release.json",
1043
+ "description": "Creating a shipping rate",
1044
+ "link": "admin/shipping_rates/creating_a_shipping_rate.json",
1031
1045
  "groups": "all",
1032
- "route": "/api/admin/releases/:id",
1033
- "method": "PATCH"
1046
+ "route": "/api/admin/shipping_services/:shipping_service_id/rates",
1047
+ "method": "POST"
1034
1048
  },
1035
1049
  {
1036
- "description": "Bulk upserting releases",
1037
- "link": "admin/releases/bulk_upserting_releases.json",
1050
+ "description": "Listing shipping rates",
1051
+ "link": "admin/shipping_rates/listing_shipping_rates.json",
1038
1052
  "groups": "all",
1039
- "route": "/api/admin/releases/bulk",
1040
- "method": "PATCH"
1053
+ "route": "/api/admin/shipping_services/:shipping_service_id/rates",
1054
+ "method": "GET"
1041
1055
  },
1042
1056
  {
1043
- "description": "Removing a release",
1044
- "link": "admin/releases/removing_a_release.json",
1057
+ "description": "Removing a shipping rate",
1058
+ "link": "admin/shipping_rates/removing_a_shipping_rate.json",
1045
1059
  "groups": "all",
1046
- "route": "/api/admin/releases/:id",
1060
+ "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
1047
1061
  "method": "DELETE"
1048
1062
  },
1049
1063
  {
1050
- "description": "Creating a release",
1051
- "link": "admin/releases/creating_a_release.json",
1064
+ "description": "Updating a shipping rate",
1065
+ "link": "admin/shipping_rates/updating_a_shipping_rate.json",
1052
1066
  "groups": "all",
1053
- "route": "/api/admin/releases",
1054
- "method": "POST"
1067
+ "route": "/api/admin/shipping_services/:shipping_service_id/rates/:id",
1068
+ "method": "PATCH"
1055
1069
  }
1056
1070
  ]
1057
1071
  },
1058
1072
  {
1059
- "name": "Users",
1073
+ "name": "Shipping Services",
1060
1074
  "examples": [
1061
1075
  {
1062
- "description": "Creating a user",
1063
- "link": "admin/users/creating_a_user.json",
1076
+ "description": "Bulk upserting shipping_services",
1077
+ "link": "admin/shipping_services/bulk_upserting_shipping_services.json",
1064
1078
  "groups": "all",
1065
- "route": "/api/admin/users",
1066
- "method": "POST"
1079
+ "route": "/api/admin/shipping_services/bulk",
1080
+ "method": "PATCH"
1067
1081
  },
1068
1082
  {
1069
- "description": "Bulk upserting users",
1070
- "link": "admin/users/bulk_upserting_users.json",
1083
+ "description": "Creating a shipping_service",
1084
+ "link": "admin/shipping_services/creating_a_shipping_service.json",
1071
1085
  "groups": "all",
1072
- "route": "/api/admin/users/bulk",
1073
- "method": "PATCH"
1086
+ "route": "/api/admin/shipping_services",
1087
+ "method": "POST"
1074
1088
  },
1075
1089
  {
1076
- "description": "Removing a user",
1077
- "link": "admin/users/removing_a_user.json",
1090
+ "description": "Listing shipping_services",
1091
+ "link": "admin/shipping_services/listing_shipping_services.json",
1078
1092
  "groups": "all",
1079
- "route": "/api/admin/users/:id",
1080
- "method": "DELETE"
1093
+ "route": "/api/admin/shipping_services",
1094
+ "method": "GET"
1081
1095
  },
1082
1096
  {
1083
- "description": "Showing a user",
1084
- "link": "admin/users/showing_a_user.json",
1097
+ "description": "Removing a shipping_service",
1098
+ "link": "admin/shipping_services/removing_a_shipping_service.json",
1085
1099
  "groups": "all",
1086
- "route": "/api/admin/users/:id",
1087
- "method": "GET"
1100
+ "route": "/api/admin/shipping_services/:id",
1101
+ "method": "DELETE"
1088
1102
  },
1089
1103
  {
1090
- "description": "Listing users",
1091
- "link": "admin/users/listing_users.json",
1104
+ "description": "Showing a shipping_service",
1105
+ "link": "admin/shipping_services/showing_a_shipping_service.json",
1092
1106
  "groups": "all",
1093
- "route": "/api/admin/users",
1107
+ "route": "/api/admin/shipping_services/:id",
1094
1108
  "method": "GET"
1095
1109
  },
1096
1110
  {
1097
- "description": "Updating a user",
1098
- "link": "admin/users/updating_a_user.json",
1111
+ "description": "Updating a shipping_service",
1112
+ "link": "admin/shipping_services/updating_a_shipping_service.json",
1099
1113
  "groups": "all",
1100
- "route": "/api/admin/users/:id",
1114
+ "route": "/api/admin/shipping_services/:id",
1101
1115
  "method": "PATCH"
1102
1116
  }
1103
1117
  ]
1104
1118
  },
1105
1119
  {
1106
- "name": "Inventory SKUs",
1120
+ "name": "Tax Categories",
1107
1121
  "examples": [
1108
1122
  {
1109
- "description": "Updating an inventory SKU",
1110
- "link": "admin/inventory_skus/updating_an_inventory_sku.json",
1123
+ "description": "Bulk upserting tax categories",
1124
+ "link": "admin/tax_categories/bulk_upserting_tax_categories.json",
1111
1125
  "groups": "all",
1112
- "route": "/api/admin/inventory_skus/:id",
1126
+ "route": "/api/admin/tax_categories/bulk",
1113
1127
  "method": "PATCH"
1114
1128
  },
1115
1129
  {
1116
- "description": "Removing an inventory SKU",
1117
- "link": "admin/inventory_skus/removing_an_inventory_sku.json",
1130
+ "description": "Creating a tax category",
1131
+ "link": "admin/tax_categories/creating_a_tax_category.json",
1118
1132
  "groups": "all",
1119
- "route": "/api/admin/inventory_skus/:id",
1120
- "method": "DELETE"
1133
+ "route": "/api/admin/tax_categories",
1134
+ "method": "POST"
1121
1135
  },
1122
1136
  {
1123
- "description": "Bulk upserting inventory SKUs",
1124
- "link": "admin/inventory_skus/bulk_upserting_inventory_skus.json",
1137
+ "description": "Listing tax categories",
1138
+ "link": "admin/tax_categories/listing_tax_categories.json",
1125
1139
  "groups": "all",
1126
- "route": "/api/admin/inventory_skus/bulk",
1127
- "method": "PATCH"
1140
+ "route": "/api/admin/tax_categories",
1141
+ "method": "GET"
1128
1142
  },
1129
1143
  {
1130
- "description": "Creating an inventory SKU",
1131
- "link": "admin/inventory_skus/creating_an_inventory_sku.json",
1144
+ "description": "Removing a tax category",
1145
+ "link": "admin/tax_categories/removing_a_tax_category.json",
1132
1146
  "groups": "all",
1133
- "route": "/api/admin/inventory_skus",
1134
- "method": "POST"
1147
+ "route": "/api/admin/tax_categories/:id",
1148
+ "method": "DELETE"
1135
1149
  },
1136
1150
  {
1137
- "description": "Listing inventory SKUs",
1138
- "link": "admin/inventory_skus/listing_inventory_skus.json",
1151
+ "description": "Showing a tax category",
1152
+ "link": "admin/tax_categories/showing_a_tax_category.json",
1139
1153
  "groups": "all",
1140
- "route": "/api/admin/inventory_skus",
1154
+ "route": "/api/admin/tax_categories/:id",
1141
1155
  "method": "GET"
1142
1156
  },
1143
1157
  {
1144
- "description": "Showing an inventory SKU",
1145
- "link": "admin/inventory_skus/showing_an_inventory_sku.json",
1158
+ "description": "Updating a tax categories",
1159
+ "link": "admin/tax_categories/updating_a_tax_categories.json",
1146
1160
  "groups": "all",
1147
- "route": "/api/admin/inventory_skus/:id",
1148
- "method": "GET"
1161
+ "route": "/api/admin/tax_categories/:id",
1162
+ "method": "PATCH"
1149
1163
  }
1150
1164
  ]
1151
1165
  },
1152
1166
  {
1153
- "name": "Shipping",
1167
+ "name": "Tax Rates",
1154
1168
  "examples": [
1155
1169
  {
1156
- "description": "Listing shipments",
1157
- "link": "admin/shipping/listing_shipments.json",
1170
+ "description": "Creating a tax rate",
1171
+ "link": "admin/tax_rates/creating_a_tax_rate.json",
1158
1172
  "groups": "all",
1159
- "route": "/api/admin/shippings",
1160
- "method": "GET"
1173
+ "route": "/api/admin/tax_categories/:tax_category_id/rates",
1174
+ "method": "POST"
1161
1175
  },
1162
1176
  {
1163
- "description": "Showing a shipment",
1164
- "link": "admin/shipping/showing_a_shipment.json",
1177
+ "description": "Listing tax rates",
1178
+ "link": "admin/tax_rates/listing_tax_rates.json",
1165
1179
  "groups": "all",
1166
- "route": "/api/admin/shippings/:id",
1180
+ "route": "/api/admin/tax_categories/:tax_category_id/rates",
1167
1181
  "method": "GET"
1182
+ },
1183
+ {
1184
+ "description": "Removing a tax rate",
1185
+ "link": "admin/tax_rates/removing_a_tax_rate.json",
1186
+ "groups": "all",
1187
+ "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
1188
+ "method": "PATCH"
1189
+ },
1190
+ {
1191
+ "description": "Updating a tax rate",
1192
+ "link": "admin/tax_rates/updating_a_tax_rate.json",
1193
+ "groups": "all",
1194
+ "route": "/api/admin/tax_categories/:tax_category_id/rates/:id",
1195
+ "method": "PATCH"
1168
1196
  }
1169
1197
  ]
1170
1198
  },
1171
1199
  {
1172
- "name": "Redirects",
1200
+ "name": "Users",
1173
1201
  "examples": [
1174
1202
  {
1175
- "description": "Updating a redirects",
1176
- "link": "admin/redirects/updating_a_redirects.json",
1203
+ "description": "Bulk upserting users",
1204
+ "link": "admin/users/bulk_upserting_users.json",
1177
1205
  "groups": "all",
1178
- "route": "/api/admin/redirects/:id",
1206
+ "route": "/api/admin/users/bulk",
1179
1207
  "method": "PATCH"
1180
1208
  },
1181
1209
  {
1182
- "description": "Listing redirects",
1183
- "link": "admin/redirects/listing_redirects.json",
1210
+ "description": "Creating a user",
1211
+ "link": "admin/users/creating_a_user.json",
1184
1212
  "groups": "all",
1185
- "route": "/api/admin/redirects",
1213
+ "route": "/api/admin/users",
1214
+ "method": "POST"
1215
+ },
1216
+ {
1217
+ "description": "Listing users",
1218
+ "link": "admin/users/listing_users.json",
1219
+ "groups": "all",
1220
+ "route": "/api/admin/users",
1186
1221
  "method": "GET"
1187
1222
  },
1188
1223
  {
1189
- "description": "Bulk upserting redirects",
1190
- "link": "admin/redirects/bulk_upserting_redirects.json",
1224
+ "description": "Removing a user",
1225
+ "link": "admin/users/removing_a_user.json",
1191
1226
  "groups": "all",
1192
- "route": "/api/admin/redirects/bulk",
1193
- "method": "PATCH"
1227
+ "route": "/api/admin/users/:id",
1228
+ "method": "DELETE"
1194
1229
  },
1195
1230
  {
1196
- "description": "Creating a redirect",
1197
- "link": "admin/redirects/creating_a_redirect.json",
1231
+ "description": "Showing a user",
1232
+ "link": "admin/users/showing_a_user.json",
1198
1233
  "groups": "all",
1199
- "route": "/api/admin/redirects",
1234
+ "route": "/api/admin/users/:id",
1235
+ "method": "GET"
1236
+ },
1237
+ {
1238
+ "description": "Showing a user by ID",
1239
+ "link": "admin/users/showing_a_user_by_id.json",
1240
+ "groups": "all",
1241
+ "route": "/api/admin/users/:id",
1242
+ "method": "GET"
1243
+ },
1244
+ {
1245
+ "description": "Showing a user by email",
1246
+ "link": "admin/users/showing_a_user_by_email.json",
1247
+ "groups": "all",
1248
+ "route": "/api/admin/users/:email",
1249
+ "method": "GET"
1250
+ },
1251
+ {
1252
+ "description": "Updating a user",
1253
+ "link": "admin/users/updating_a_user.json",
1254
+ "groups": "all",
1255
+ "route": "/api/admin/users/:id",
1256
+ "method": "PATCH"
1257
+ }
1258
+ ]
1259
+ },
1260
+ {
1261
+ "name": "Variants",
1262
+ "examples": [
1263
+ {
1264
+ "description": "Creating a product variant",
1265
+ "link": "admin/variants/creating_a_product_variant.json",
1266
+ "groups": "all",
1267
+ "route": "/api/admin/products/:product_id/variants",
1200
1268
  "method": "POST"
1201
1269
  },
1202
1270
  {
1203
- "description": "Showing a redirect",
1204
- "link": "admin/redirects/showing_a_redirect.json",
1271
+ "description": "Listing product variants",
1272
+ "link": "admin/variants/listing_product_variants.json",
1205
1273
  "groups": "all",
1206
- "route": "/api/admin/redirects/:id",
1274
+ "route": "/api/admin/products/:product_id/variants",
1207
1275
  "method": "GET"
1208
1276
  },
1209
1277
  {
1210
- "description": "Removing a redirect",
1211
- "link": "admin/redirects/removing_a_redirect.json",
1278
+ "description": "Removing a product variant",
1279
+ "link": "admin/variants/removing_a_product_variant.json",
1212
1280
  "groups": "all",
1213
- "route": "/api/admin/redirects/:id",
1281
+ "route": "/api/admin/products/:product_id/variants/:id",
1214
1282
  "method": "DELETE"
1283
+ },
1284
+ {
1285
+ "description": "Updating a product variant",
1286
+ "link": "admin/variants/updating_a_product_variant.json",
1287
+ "groups": "all",
1288
+ "route": "/api/admin/products/:product_id/variants/:id",
1289
+ "method": "PATCH"
1215
1290
  }
1216
1291
  ]
1217
1292
  }