workarea-api 4.4.6 → 4.5.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.eslintrc.json +35 -0
- data/.github/workflows/ci.yml +35 -0
- data/.gitignore +1 -0
- data/.rubocop.yml +2 -0
- data/.stylelintrc.json +8 -0
- data/CHANGELOG.md +87 -7
- data/Gemfile +1 -2
- data/README.md +23 -16
- data/Rakefile +16 -6
- data/admin/LICENSE +52 -0
- data/admin/README.md +4 -7
- data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
- data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
- data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
- data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
- data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
- data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
- data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
- data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +1 -1
- data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
- data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
- data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
- data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
- data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
- data/admin/lib/workarea/api/admin/engine.rb +11 -0
- data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
- data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
- data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
- data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
- data/admin/test/dummy/config/initializers/session_store.rb +3 -1
- data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
- data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
- data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
- data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
- data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
- data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
- data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
- data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
- data/admin/workarea-api-admin.gemspec +7 -6
- data/app/views/workarea/api/docs/nav.haml +12 -0
- data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
- data/doc/api/admin/categories/creating_a_category.json +11 -8
- data/doc/api/admin/categories/listing_categories.json +8 -5
- data/doc/api/admin/categories/removing_a_category.json +8 -4
- data/doc/api/admin/categories/showing_a_category.json +10 -7
- data/doc/api/admin/categories/updating_a_category.json +9 -5
- data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
- data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
- data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
- data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
- data/doc/api/admin/content/bulk_upserting_content.json +8 -4
- data/doc/api/admin/content/creating_content.json +11 -8
- data/doc/api/admin/content/listing_content.json +8 -5
- data/doc/api/admin/content/showing_content.json +10 -7
- data/doc/api/admin/content/updating_content.json +8 -4
- data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
- data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
- data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
- data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
- data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
- data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
- data/doc/api/admin/discounts/creating_a_discount.json +11 -8
- data/doc/api/admin/discounts/listing_discounts.json +8 -5
- data/doc/api/admin/discounts/removing_a_discount.json +8 -4
- data/doc/api/admin/discounts/showing_a_discount.json +10 -7
- data/doc/api/admin/discounts/updating_discounts.json +8 -4
- data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
- data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
- data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
- data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
- data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
- data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
- data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
- data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
- data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
- data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
- data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
- data/doc/api/admin/global_functionality/paging_results.json +51 -0
- data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
- data/doc/api/admin/global_functionality/sorting_results.json +56 -0
- data/doc/api/admin/index.json +653 -578
- data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
- data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
- data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
- data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
- data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
- data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
- data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
- data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
- data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
- data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
- data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
- data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
- data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
- data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
- data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
- data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
- data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
- data/doc/api/admin/orders/listing_orders.json +8 -5
- data/doc/api/admin/orders/showing_an_order.json +8 -5
- data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
- data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
- data/doc/api/admin/pages/creating_a_page.json +11 -8
- data/doc/api/admin/pages/listing_pages.json +8 -5
- data/doc/api/admin/pages/removing_a_page.json +8 -4
- data/doc/api/admin/pages/showing_a_page.json +10 -7
- data/doc/api/admin/pages/updating_a_page.json +9 -5
- data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
- data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
- data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
- data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
- data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
- data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
- data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
- data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
- data/doc/api/admin/payments/listing_payments.json +7 -4
- data/doc/api/admin/payments/showing_an_payment.json +7 -4
- data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
- data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
- data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
- data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
- data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
- data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
- data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
- data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
- data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
- data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
- data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
- data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
- data/doc/api/admin/product_images/listing_product_images.json +10 -7
- data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
- data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
- data/doc/api/admin/products/bulk_upserting_products.json +8 -4
- data/doc/api/admin/products/creating_a_product.json +11 -8
- data/doc/api/admin/products/listing_products.json +8 -5
- data/doc/api/admin/products/removing_a_product.json +8 -4
- data/doc/api/admin/products/showing_a_product.json +10 -7
- data/doc/api/admin/products/updating_a_product.json +9 -5
- data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
- data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
- data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
- data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
- data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
- data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
- data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
- data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
- data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
- data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
- data/doc/api/admin/redirects/listing_redirects.json +7 -4
- data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
- data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
- data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
- data/doc/api/admin/release_changes/adding_changes_to_a_release.json +11 -7
- data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
- data/doc/api/admin/releases/creating_a_release.json +11 -8
- data/doc/api/admin/releases/listing_releases.json +8 -5
- data/doc/api/admin/releases/removing_a_release.json +8 -4
- data/doc/api/admin/releases/showing_a_release.json +10 -7
- data/doc/api/admin/releases/updating_a_release.json +9 -5
- data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
- data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
- data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
- data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
- data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
- data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
- data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
- data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
- data/doc/api/admin/shipping/listing_shipments.json +7 -4
- data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
- data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
- data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
- data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
- data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
- data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
- data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
- data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
- data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
- data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
- data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
- data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
- data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
- data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
- data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
- data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
- data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
- data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
- data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
- data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
- data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
- data/doc/api/admin/users/bulk_upserting_users.json +8 -4
- data/doc/api/admin/users/creating_a_user.json +11 -8
- data/doc/api/admin/users/listing_users.json +8 -5
- data/doc/api/admin/users/removing_a_user.json +8 -4
- data/doc/api/admin/users/showing_a_user.json +10 -12
- data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
- data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
- data/doc/api/admin/users/updating_a_user.json +9 -5
- data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
- data/doc/api/admin/variants/listing_product_variants.json +10 -7
- data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
- data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
- data/doc/api/storefront/accounts/creating_an_account.json +7 -6
- data/doc/api/storefront/accounts/getting_account_details.json +9 -8
- data/doc/api/storefront/accounts/updating_an_account.json +9 -8
- data/doc/api/storefront/analytics/saving_a_category_view.json +18 -5
- data/doc/api/storefront/analytics/saving_a_product_view.json +18 -5
- data/doc/api/storefront/analytics/saving_a_search.json +18 -5
- data/doc/api/storefront/assets/showing_an_asset.json +9 -8
- data/doc/api/storefront/authentication/creating_an_authentication_token.json +9 -8
- data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +9 -8
- data/doc/api/storefront/authentication/using_an_authentication_token.json +9 -8
- data/doc/api/storefront/cart/adding_a_promo_code.json +10 -9
- data/doc/api/storefront/cart/adding_an_item.json +10 -9
- data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +9 -8
- data/doc/api/storefront/cart/creating_a_new_guest_cart.json +7 -6
- data/doc/api/storefront/cart/delete_an_item.json +10 -9
- data/doc/api/storefront/cart/listing_user_s_carts.json +9 -8
- data/doc/api/storefront/cart/showing_cart.json +10 -9
- data/doc/api/storefront/cart/updating_an_item.json +10 -9
- data/doc/api/storefront/categories/showing_a_category.json +8 -7
- data/doc/api/storefront/categories/showing_a_listing_of_categories.json +8 -7
- data/doc/api/storefront/checkout/completing_a_checkout.json +9 -8
- data/doc/api/storefront/checkout/showing_a_checkout.json +10 -9
- data/doc/api/storefront/checkout/updating_a_checkout.json +9 -8
- data/doc/api/storefront/contacts/creating_a_contact.json +7 -6
- data/doc/api/storefront/email_signups/creating_an_email_signup.json +7 -6
- data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +7 -6
- data/doc/api/storefront/index.json +263 -258
- data/doc/api/storefront/menus/listing_menus.json +8 -7
- data/doc/api/storefront/menus/showing_a_menu.json +10 -9
- data/doc/api/storefront/orders/listing_the_user_s_orders.json +9 -8
- data/doc/api/storefront/orders/showing_an_order.json +10 -9
- data/doc/api/storefront/pages/showing_a_page.json +8 -7
- data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +8 -6
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +9 -8
- data/doc/api/storefront/products/showing_a_product.json +8 -7
- data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +8 -7
- data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +10 -9
- data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +11 -11
- data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +6 -4
- data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +8 -6
- data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
- data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
- data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +9 -8
- data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
- data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
- data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
- data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
- data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +9 -8
- data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
- data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
- data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +9 -8
- data/doc/api/storefront/searches/showing_search_results.json +8 -7
- data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
- data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
- data/doc/api/storefront/system_content/showing_system_content.json +8 -7
- data/doc/api/storefront/system_content/showing_the_home_page.json +8 -7
- data/doc/api/storefront/taxons/showing_a_taxon.json +10 -9
- data/doc/api/storefront/validation_errors/checkout_validation_errors.json +9 -8
- data/doc/api/storefront/validation_errors/general_validation_errors.json +4 -3
- data/lib/tasks/docs.rake +20 -0
- data/lib/workarea/api/documentation_test.rb +10 -1
- data/lib/workarea/api/version.rb +1 -1
- data/storefront/LICENSE +52 -0
- data/storefront/README.md +4 -7
- data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
- data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
- data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
- data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
- data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
- data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
- data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
- data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
- data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
- data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
- data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
- data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
- data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
- data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
- data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
- data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
- data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
- data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
- data/storefront/config/initializers/config.rb +19 -0
- data/storefront/lib/workarea/api/storefront.rb +1 -0
- data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
- data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
- data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
- data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
- data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
- data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
- data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
- data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
- data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
- data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
- data/storefront/workarea-api-storefront.gemspec +8 -7
- data/workarea-api.gemspec +4 -4
- metadata +38 -17
- data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
- data/doc/api/storefront/analytics/saving_filters.json +0 -38
- data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
- data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"wcf51sh3LcP5yQHG58ejswar\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -25,23 +25,24 @@
|
|
|
25
25
|
"Access-Control-Allow-Headers": "*",
|
|
26
26
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
27
|
"X-Requested-With": "",
|
|
28
|
-
"Vary": "X-Requested-With, X-
|
|
29
|
-
"
|
|
28
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
29
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:53:18 GMT",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "0d6cc30f-379a-4764-97c5-3963c3c1f1cb",
|
|
32
|
+
"X-Runtime": "0.009391",
|
|
33
|
+
"X-Workarea-Segments": "",
|
|
33
34
|
"Expires": "0",
|
|
34
35
|
"Content-Length": "294"
|
|
35
36
|
},
|
|
36
37
|
"request_method": "PATCH",
|
|
37
|
-
"request_path": "/api/storefront/saved_credit_cards/
|
|
38
|
+
"request_path": "/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88",
|
|
38
39
|
"request_body": "{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}",
|
|
39
40
|
"request_content_type": "application/json",
|
|
40
41
|
"response_status": 200,
|
|
41
42
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"user_id\": \"
|
|
43
|
+
"response_body": "{\n \"user_id\": \"5dddc8fe1241596aa5204f83\",\n \"id\": \"5dddc8fe1241596aa5204f88\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
|
|
43
44
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/
|
|
45
|
+
"curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5dddc8fe1241596aa5204f88\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"wcf51sh3LcP5yQHG58ejswar\\\"\""
|
|
45
46
|
}
|
|
46
47
|
],
|
|
47
48
|
"resource": "Saved Credit Cards",
|
|
@@ -19,19 +19,20 @@
|
|
|
19
19
|
"X-Download-Options": "noopen",
|
|
20
20
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
21
21
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
22
|
-
"Date": "Wed,
|
|
22
|
+
"Date": "Wed, 27 Nov 2019 00:55:07 GMT",
|
|
23
23
|
"Content-Type": "application/json; charset=utf-8",
|
|
24
24
|
"Access-Control-Allow-Origin": "*",
|
|
25
25
|
"Access-Control-Allow-Headers": "*",
|
|
26
26
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
27
|
"X-Requested-With": "",
|
|
28
|
-
"Vary": "X-Requested-With, X-
|
|
28
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
29
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:55:07 GMT",
|
|
29
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"
|
|
31
|
-
"X-
|
|
32
|
-
"X-
|
|
31
|
+
"X-Request-Id": "4c7ada86-44f8-4488-a832-5ff1a8535956",
|
|
32
|
+
"X-Runtime": "0.012656",
|
|
33
|
+
"X-Workarea-Segments": "",
|
|
33
34
|
"Expires": "0",
|
|
34
|
-
"Content-Length": "
|
|
35
|
+
"Content-Length": "16"
|
|
35
36
|
},
|
|
36
37
|
"request_method": "GET",
|
|
37
38
|
"request_path": "/api/storefront/searches?q=red",
|
|
@@ -39,7 +40,7 @@
|
|
|
39
40
|
"request_content_type": null,
|
|
40
41
|
"response_status": 200,
|
|
41
42
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"results\":
|
|
43
|
+
"response_body": "{\n \"results\": null\n}",
|
|
43
44
|
"response_content_type": "application/json",
|
|
44
45
|
"curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET "
|
|
45
46
|
}
|
|
@@ -47,6 +48,6 @@
|
|
|
47
48
|
"resource": "Searches",
|
|
48
49
|
"description": "Showing search autocomplete suggestions",
|
|
49
50
|
"route": "/api/storefront/searches",
|
|
50
|
-
"explanation": "
|
|
51
|
+
"explanation": "<p>This list will be based on popular search terms and matching<br>\nproducts, categories, etc. Useful for showing a autocomplete<br>\ndrop-down as a customer types in a search bar.</p>\n",
|
|
51
52
|
"http_method": "GET"
|
|
52
53
|
}
|
|
@@ -36,17 +36,18 @@
|
|
|
36
36
|
"X-Download-Options": "noopen",
|
|
37
37
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
38
38
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
39
|
-
"Date": "Wed,
|
|
39
|
+
"Date": "Wed, 27 Nov 2019 00:55:40 GMT",
|
|
40
40
|
"Content-Type": "application/json; charset=utf-8",
|
|
41
41
|
"Access-Control-Allow-Origin": "*",
|
|
42
42
|
"Access-Control-Allow-Headers": "*",
|
|
43
43
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
44
44
|
"X-Requested-With": "",
|
|
45
|
-
"Vary": "X-Requested-With, X-
|
|
45
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
46
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:55:40 GMT",
|
|
46
47
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
47
|
-
"
|
|
48
|
-
"X-
|
|
49
|
-
"X-
|
|
48
|
+
"X-Request-Id": "33b2710d-d66d-436b-a4d8-af1214018f15",
|
|
49
|
+
"X-Runtime": "0.064315",
|
|
50
|
+
"X-Workarea-Segments": "",
|
|
50
51
|
"Expires": "0",
|
|
51
52
|
"Content-Length": "6349"
|
|
52
53
|
},
|
|
@@ -56,7 +57,7 @@
|
|
|
56
57
|
"request_content_type": null,
|
|
57
58
|
"response_status": 200,
|
|
58
59
|
"response_status_text": "OK",
|
|
59
|
-
"response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\n ],\n [\n \"Top Sellers\",\n \"top_sellers\"\n ],\n [\n \"Most Popular\",\n \"popularity\"\n ],\n [\n \"Newest\",\n \"newest\"\n ],\n [\n \"Price, Low to High\",\n \"price_asc\"\n ],\n [\n \"Price, High to Low\",\n \"price_desc\"\n ]\n ],\n \"sort\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"
|
|
60
|
+
"response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\n ],\n [\n \"Top Sellers\",\n \"top_sellers\"\n ],\n [\n \"Most Popular\",\n \"popularity\"\n ],\n [\n \"Newest\",\n \"newest\"\n ],\n [\n \"Price, Low to High\",\n \"price_asc\"\n ],\n [\n \"Price, High to Low\",\n \"price_desc\"\n ]\n ],\n \"sort\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"5dddc98b1241596aa5205407\",\n \"type\": \"text\",\n \"area\": \"results\",\n \"data\": {\n \"text\": \"Huzzah! Your search results are below!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc98b1241596aa5205407\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc98b1241596aa5205407","type":"text","position":0,"data":{"text":"Huzzah! Your search results are below!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5dddc98b1241596aa5205408\",\n \"type\": \"text\",\n \"area\": \"no_results\",\n \"data\": {\n \"text\": \"Sorry, we can't find what you searched for!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc98b1241596aa5205408\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc98b1241596aa5205408","type":"text","position":0,"data":{"text":"Sorry, we can't find what you searched for!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</div>\\n</div>\\n\"\n }\n ],\n \"first_page\": true,\n \"second_page\": false,\n \"last_page\": true,\n \"page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"per_page\": 20,\n \"total_results\": 2,\n \"total_pages\": 1,\n \"facets\": [\n\n ],\n \"products\": [\n {\n \"id\": \"PRODUCT1\",\n \"name\": \"Pretty Nice Shirt\",\n \"description\": null,\n \"slug\": \"pretty-nice-shirt\",\n \"browser_title\": \"Pretty Nice Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Blue\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5dddc98b1241596aa520540a\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5dddc98b1241596aa520540b\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5dddc98b1241596aa520540b/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"PRODUCT2\",\n \"name\": \"Great Pants\",\n \"description\": null,\n \"slug\": \"great-pants\",\n \"browser_title\": \"Great Pants\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Brown\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5dddc98b1241596aa520541a\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5dddc98b1241596aa520541b\",\n \"option\": \"Brown\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5dddc98b1241596aa520541b/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
|
60
61
|
"response_content_type": "application/json",
|
|
61
62
|
"curl": "curl -g \"https://www.example.com/api/storefront/search?page=1&q=large&sort=price_desc\" -X GET "
|
|
62
63
|
}
|
|
@@ -64,6 +65,6 @@
|
|
|
64
65
|
"resource": "Searches",
|
|
65
66
|
"description": "Showing search results",
|
|
66
67
|
"route": "/api/storefront/search",
|
|
67
|
-
"explanation": "
|
|
68
|
+
"explanation": "<p>This endpoint returns everything you'll need to show search results<br>\nto customers. This includes products, filters, and any content<br>\nthat's been setup by an administrator.</p>\n",
|
|
68
69
|
"http_method": "GET"
|
|
69
70
|
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
{
|
|
2
|
+
"parameters": [
|
|
3
|
+
|
|
4
|
+
],
|
|
5
|
+
"response_fields": [
|
|
6
|
+
|
|
7
|
+
],
|
|
8
|
+
"requests": [
|
|
9
|
+
{
|
|
10
|
+
"request_headers": {
|
|
11
|
+
},
|
|
12
|
+
"request_query_parameters": {
|
|
13
|
+
"sessions": "1"
|
|
14
|
+
},
|
|
15
|
+
"response_headers": {
|
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
|
19
|
+
"X-Download-Options": "noopen",
|
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
22
|
+
"Date": "Wed, 27 Nov 2019 00:51:37 GMT",
|
|
23
|
+
"Content-Type": "application/json; charset=utf-8",
|
|
24
|
+
"Access-Control-Allow-Origin": "*",
|
|
25
|
+
"Access-Control-Allow-Headers": "*",
|
|
26
|
+
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
|
+
"X-Workarea-Segmented-Content": "true",
|
|
28
|
+
"X-Requested-With": "",
|
|
29
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
30
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:51:37 GMT",
|
|
31
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
32
|
+
"X-Request-Id": "78e758bb-111a-45e9-b45c-38b616e0c18b",
|
|
33
|
+
"X-Runtime": "0.006550",
|
|
34
|
+
"X-Workarea-Segments": "first_time_visitor",
|
|
35
|
+
"Expires": "0",
|
|
36
|
+
"Content-Length": "1014"
|
|
37
|
+
},
|
|
38
|
+
"request_method": "GET",
|
|
39
|
+
"request_path": "/api/storefront/system_content/home_page?sessions=1",
|
|
40
|
+
"request_body": null,
|
|
41
|
+
"request_content_type": null,
|
|
42
|
+
"response_status": 200,
|
|
43
|
+
"response_status_text": "OK",
|
|
44
|
+
"response_body": "{\n \"id\": \"5dddc8991241596aa5204b57\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8991241596aa5204b58\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Hello visitor!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8991241596aa5204b58\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8991241596aa5204b58","type":"text","position":0,"data":{"text":"Hello visitor!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Hello visitor!</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
45
|
+
"response_content_type": "application/json",
|
|
46
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page?sessions=1\" -X GET "
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"request_headers": {
|
|
50
|
+
},
|
|
51
|
+
"request_query_parameters": {
|
|
52
|
+
"sessions": "2"
|
|
53
|
+
},
|
|
54
|
+
"response_headers": {
|
|
55
|
+
"X-Frame-Options": "SAMEORIGIN",
|
|
56
|
+
"X-XSS-Protection": "1; mode=block",
|
|
57
|
+
"X-Content-Type-Options": "nosniff",
|
|
58
|
+
"X-Download-Options": "noopen",
|
|
59
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
|
60
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
61
|
+
"Date": "Wed, 27 Nov 2019 00:51:37 GMT",
|
|
62
|
+
"Content-Type": "application/json; charset=utf-8",
|
|
63
|
+
"Access-Control-Allow-Origin": "*",
|
|
64
|
+
"Access-Control-Allow-Headers": "*",
|
|
65
|
+
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
66
|
+
"X-Workarea-Segmented-Content": "true",
|
|
67
|
+
"X-Requested-With": "",
|
|
68
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
69
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:51:37 GMT",
|
|
70
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
71
|
+
"X-Request-Id": "30666cef-8a67-4268-a8cf-eb13f27a4bec",
|
|
72
|
+
"X-Runtime": "0.006299",
|
|
73
|
+
"X-Workarea-Segments": "returning_visitor",
|
|
74
|
+
"Expires": "0",
|
|
75
|
+
"Content-Length": "1011"
|
|
76
|
+
},
|
|
77
|
+
"request_method": "GET",
|
|
78
|
+
"request_path": "/api/storefront/system_content/home_page?sessions=2",
|
|
79
|
+
"request_body": null,
|
|
80
|
+
"request_content_type": null,
|
|
81
|
+
"response_status": 200,
|
|
82
|
+
"response_status_text": "OK",
|
|
83
|
+
"response_body": "{\n \"id\": \"5dddc8991241596aa5204b57\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8991241596aa5204b59\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Welcome back!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8991241596aa5204b59\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8991241596aa5204b59","type":"text","position":1,"data":{"text":"Welcome back!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Welcome back!</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
84
|
+
"response_content_type": "application/json",
|
|
85
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page?sessions=2\" -X GET "
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"resource": "Segmentation",
|
|
89
|
+
"description": "Specifying session count for segmentation",
|
|
90
|
+
"route": "/api/storefront/system_content/home_page",
|
|
91
|
+
"explanation": "<p>Workarea supports segmenting users by number of sessions, e.g.<br>\nfirst-time vs returning visitors. To support this in the storefront<br>\nAPI, the client will be responsible for managing this since the API<br>\nis stateless (doesn't have cookies/session).</p>\n\n<p>To get session-based segments functioning, you need to pass a<br>\n<code>sessions</code> parameter in each request. Workarea will use that as<br>\nthe number of sessions for determing the segments for the response.<br>\nThis works for all requests across the storefront API.</p>\n\n<p>This example shows getting a home page with segmented content based<br>\non the number of sessions.</p>\n",
|
|
92
|
+
"http_method": "GET"
|
|
93
|
+
}
|
data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
{
|
|
2
|
+
"parameters": [
|
|
3
|
+
|
|
4
|
+
],
|
|
5
|
+
"response_fields": [
|
|
6
|
+
|
|
7
|
+
],
|
|
8
|
+
"requests": [
|
|
9
|
+
{
|
|
10
|
+
"request_headers": {
|
|
11
|
+
},
|
|
12
|
+
"request_query_parameters": {
|
|
13
|
+
"session_id": "session_1"
|
|
14
|
+
},
|
|
15
|
+
"response_headers": {
|
|
16
|
+
"X-Frame-Options": "SAMEORIGIN",
|
|
17
|
+
"X-XSS-Protection": "1; mode=block",
|
|
18
|
+
"X-Content-Type-Options": "nosniff",
|
|
19
|
+
"X-Download-Options": "noopen",
|
|
20
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
|
21
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
22
|
+
"Date": "Wed, 27 Nov 2019 00:51:36 GMT",
|
|
23
|
+
"Content-Type": "application/json; charset=utf-8",
|
|
24
|
+
"Access-Control-Allow-Origin": "*",
|
|
25
|
+
"Access-Control-Allow-Headers": "*",
|
|
26
|
+
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
|
+
"X-Workarea-Segmented-Content": "true",
|
|
28
|
+
"X-Requested-With": "",
|
|
29
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
30
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:51:36 GMT",
|
|
31
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
32
|
+
"X-Request-Id": "f4a84544-444b-49ed-b271-bca835333e42",
|
|
33
|
+
"X-Runtime": "0.006377",
|
|
34
|
+
"X-Workarea-Segments": "first_time_customer",
|
|
35
|
+
"Expires": "0",
|
|
36
|
+
"Content-Length": "1038"
|
|
37
|
+
},
|
|
38
|
+
"request_method": "GET",
|
|
39
|
+
"request_path": "/api/storefront/system_content/home_page?session_id=session_1",
|
|
40
|
+
"request_body": null,
|
|
41
|
+
"request_content_type": null,
|
|
42
|
+
"response_status": 200,
|
|
43
|
+
"response_status_text": "OK",
|
|
44
|
+
"response_body": "{\n \"id\": \"5dddc8971241596aa5204b4f\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8981241596aa5204b50\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Thanks for your order!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8981241596aa5204b50\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8981241596aa5204b50","type":"text","position":0,"data":{"text":"Thanks for your order!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Thanks for your order!</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
45
|
+
"response_content_type": "application/json",
|
|
46
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page?session_id=session_1\" -X GET "
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"request_headers": {
|
|
50
|
+
},
|
|
51
|
+
"request_query_parameters": {
|
|
52
|
+
"session_id": "session_2"
|
|
53
|
+
},
|
|
54
|
+
"response_headers": {
|
|
55
|
+
"X-Frame-Options": "SAMEORIGIN",
|
|
56
|
+
"X-XSS-Protection": "1; mode=block",
|
|
57
|
+
"X-Content-Type-Options": "nosniff",
|
|
58
|
+
"X-Download-Options": "noopen",
|
|
59
|
+
"X-Permitted-Cross-Domain-Policies": "none",
|
|
60
|
+
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
61
|
+
"Date": "Wed, 27 Nov 2019 00:51:36 GMT",
|
|
62
|
+
"Content-Type": "application/json; charset=utf-8",
|
|
63
|
+
"Access-Control-Allow-Origin": "*",
|
|
64
|
+
"Access-Control-Allow-Headers": "*",
|
|
65
|
+
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
66
|
+
"X-Workarea-Segmented-Content": "true",
|
|
67
|
+
"X-Requested-With": "",
|
|
68
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
69
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:51:36 GMT",
|
|
70
|
+
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
71
|
+
"X-Request-Id": "11d049a0-74f8-48c0-b300-b71ff108f751",
|
|
72
|
+
"X-Runtime": "0.006377",
|
|
73
|
+
"X-Workarea-Segments": "returning_customer",
|
|
74
|
+
"Expires": "0",
|
|
75
|
+
"Content-Length": "1059"
|
|
76
|
+
},
|
|
77
|
+
"request_method": "GET",
|
|
78
|
+
"request_path": "/api/storefront/system_content/home_page?session_id=session_2",
|
|
79
|
+
"request_body": null,
|
|
80
|
+
"request_content_type": null,
|
|
81
|
+
"response_status": 200,
|
|
82
|
+
"response_status_text": "OK",
|
|
83
|
+
"response_body": "{\n \"id\": \"5dddc8971241596aa5204b4f\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8981241596aa5204b51\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Welcome back repeat customer!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8981241596aa5204b51\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8981241596aa5204b51","type":"text","position":1,"data":{"text":"Welcome back repeat customer!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Welcome back repeat customer!</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
84
|
+
"response_content_type": "application/json",
|
|
85
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page?session_id=session_2\" -X GET "
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"resource": "Segmentation",
|
|
89
|
+
"description": "Using session IDs for segmenting non-authenticated users",
|
|
90
|
+
"route": "/api/storefront/system_content/home_page",
|
|
91
|
+
"explanation": "<p>Workarea supports segmenting users by number of orders, revenue, etc.<br>\nFor this functionality to work for users without accounts, you'll<br>\nneed to maintain and pass a <code>session_id</code> consistently throughout calls<br>\nto the API.</p>\n\n<p>An instance of <code>Metrics::User</code> will be found or created for that<br>\n<code>session_id</code>, and data about the user will be tracked there.</p>\n\n<p>Assuming use of the <code>session_id</code> consistently through checkout, this<br>\nexample shows getting home page content for two different anonymous<br>\nusers and getting segmented content back.</p>\n",
|
|
92
|
+
"http_method": "GET"
|
|
93
|
+
}
|
|
@@ -18,17 +18,18 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "Wed,
|
|
21
|
+
"Date": "Wed, 27 Nov 2019 00:52:48 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:52:48 GMT",
|
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"
|
|
30
|
-
"X-
|
|
31
|
-
"X-
|
|
30
|
+
"X-Request-Id": "f3d9d3a1-842e-422e-b717-5c29b14889e8",
|
|
31
|
+
"X-Runtime": "0.008132",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "1981"
|
|
34
35
|
},
|
|
@@ -38,7 +39,7 @@
|
|
|
38
39
|
"request_content_type": null,
|
|
39
40
|
"response_status": 200,
|
|
40
41
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"id\": \"5dddc8e01241596aa5204ce3\",\n \"name\": \"Layout\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Layout\",\n \"browser_title\": \"Layout\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8e01241596aa5204ce4\",\n \"type\": \"text\",\n \"area\": \"header_promo\",\n \"data\": {\n \"text\": \"Don't miss our sizzling summer deals!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8e01241596aa5204ce4\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8e01241596aa5204ce4","type":"text","position":0,"data":{"text":"Don't miss our sizzling summer deals!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Don't miss our sizzling summer deals!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5dddc8e01241596aa5204ce5\",\n \"type\": \"text\",\n \"area\": \"footer_navigation\",\n \"data\": {\n \"text\": \"Be the first to received our exclusive discounts\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8e01241596aa5204ce5\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8e01241596aa5204ce5","type":"text","position":0,"data":{"text":"Be the first to received our exclusive discounts"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Be the first to received our exclusive discounts</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
44
|
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/layout\" -X GET "
|
|
44
45
|
}
|
|
@@ -46,6 +47,6 @@
|
|
|
46
47
|
"resource": "System Content",
|
|
47
48
|
"description": "Showing system content",
|
|
48
49
|
"route": "/api/storefront/system_content/:name",
|
|
49
|
-
"explanation": "
|
|
50
|
+
"explanation": "<p>System content is content for an area of site not configured by the<br>\nCMS. Examples would be content for the cart page, content for<br>\ncheckout, site layout content, etc. The home page is also an example<br>\nof system content and shown in a separate example.</p>\n",
|
|
50
51
|
"http_method": "GET"
|
|
51
52
|
}
|
|
@@ -18,17 +18,18 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "Wed,
|
|
21
|
+
"Date": "Wed, 27 Nov 2019 00:52:48 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:52:48 GMT",
|
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"
|
|
30
|
-
"X-
|
|
31
|
-
"X-
|
|
30
|
+
"X-Request-Id": "f924549d-136a-4b93-b820-e6149f37bfc2",
|
|
31
|
+
"X-Runtime": "0.008772",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "1830"
|
|
34
35
|
},
|
|
@@ -38,7 +39,7 @@
|
|
|
38
39
|
"request_content_type": null,
|
|
39
40
|
"response_status": 200,
|
|
40
41
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"id\": \"5dddc8df1241596aa5204cde\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5dddc8df1241596aa5204cdf\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Summer is here!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8df1241596aa5204cdf\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8df1241596aa5204cdf","type":"text","position":0,"data":{"text":"Summer is here!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Summer is here!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5dddc8df1241596aa5204ce0\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Get 20% off all swimwear\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8df1241596aa5204ce0\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8df1241596aa5204ce0","type":"text","position":1,"data":{"text":"Get 20% off all swimwear"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Get 20% off all swimwear</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
44
|
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page\" -X GET "
|
|
44
45
|
}
|
|
@@ -46,6 +47,6 @@
|
|
|
46
47
|
"resource": "System Content",
|
|
47
48
|
"description": "Showing the home page",
|
|
48
49
|
"route": "/api/storefront/system_content/home_page",
|
|
49
|
-
"explanation": "
|
|
50
|
+
"explanation": "<p>This endpoint returns everything you'll need to render the home<br>\npage.</p>\n",
|
|
50
51
|
"http_method": "GET"
|
|
51
52
|
}
|
|
@@ -18,34 +18,35 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "Wed,
|
|
21
|
+
"Date": "Wed, 27 Nov 2019 00:52:46 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:52:46 GMT",
|
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"
|
|
30
|
-
"X-
|
|
31
|
-
"X-
|
|
30
|
+
"X-Request-Id": "5ceec41f-08e9-4933-a1f9-788147b25053",
|
|
31
|
+
"X-Runtime": "0.007104",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "534"
|
|
34
35
|
},
|
|
35
36
|
"request_method": "GET",
|
|
36
|
-
"request_path": "/api/storefront/taxons/
|
|
37
|
+
"request_path": "/api/storefront/taxons/5dddc8dd1241596aa5204cd9",
|
|
37
38
|
"request_body": null,
|
|
38
39
|
"request_content_type": null,
|
|
39
40
|
"response_status": 200,
|
|
40
41
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"taxon\": {\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"taxon\": {\n \"id\": \"5dddc8dd1241596aa5204cd9\",\n \"url\": \"/api/storefront/taxons/5dddc8dd1241596aa5204cd9\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": \"http://example.com/pages/mens\",\n \"parent_id\": \"5dddc8dd1241596aa5204cda\",\n \"parent_ids\": [\n \"5dddc8dd1241596aa5204cda\"\n ],\n \"position\": 0\n },\n \"children\": [\n {\n \"id\": \"5dddc8de1241596aa5204cdb\",\n \"url\": \"/api/storefront/taxons/5dddc8de1241596aa5204cdb\",\n \"name\": \"Sale\",\n \"depth\": 2,\n \"navigable_url\": null,\n \"parent_id\": \"5dddc8dd1241596aa5204cd9\",\n \"parent_ids\": [\n \"5dddc8dd1241596aa5204cda\",\n \"5dddc8dd1241596aa5204cd9\"\n ],\n \"position\": 0\n }\n ]\n}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/taxons/
|
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/taxons/5dddc8dd1241596aa5204cd9\" -X GET "
|
|
44
45
|
}
|
|
45
46
|
],
|
|
46
47
|
"resource": "Taxons",
|
|
47
48
|
"description": "Showing a taxon",
|
|
48
49
|
"route": "/api/storefront/taxons/:id",
|
|
49
|
-
"explanation": "
|
|
50
|
+
"explanation": "<p>This endpoint will show details on a particular node (or taxon) of<br>\nthe site taxonomy, along with its children.</p>\n",
|
|
50
51
|
"http_method": "GET"
|
|
51
52
|
}
|
|
@@ -24,28 +24,29 @@
|
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
28
|
-
"
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:51:33 GMT",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "1f3d729a-7f8d-47cc-a170-f6dbf096a0bf",
|
|
31
|
+
"X-Runtime": "0.447104",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "3271"
|
|
34
35
|
},
|
|
35
36
|
"request_method": "PATCH",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
37
|
+
"request_path": "/api/storefront/checkouts/65CBE75A6F",
|
|
37
38
|
"request_body": "{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}",
|
|
38
39
|
"request_content_type": "application/json",
|
|
39
40
|
"response_status": 200,
|
|
40
41
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"order\": {\n \"id\": \"65CBE75A6F\",\n \"url\": \"http://www.example.com/api/storefront/orders/65CBE75A6F\",\n \"user_id\": null,\n \"email\": \"susanb@\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8951241596aa5204b41\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1574815751\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1574815751\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1574815751\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1574815751\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1574815751\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/65CBE75A6F\",\n \"started_at\": \"2019-11-27T00:51:33.506Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"susanb@\",\n \"problems\": [\n \"Email is invalid\"\n ],\n \"shipping_address\": {\n \"id\": \"5dddc8951241596aa5204b48\",\n \"first_name\": \"\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"First name can't be blank\"\n ]\n },\n \"billing_address\": {\n \"id\": \"5dddc8951241596aa5204b49\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"Street can't be blank\"\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"shipping_service\": null,\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl \"https://www.example.com/api/storefront/checkouts/
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/checkouts/65CBE75A6F\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
|
44
45
|
}
|
|
45
46
|
],
|
|
46
47
|
"resource": "Validation Errors",
|
|
47
48
|
"description": "Checkout validation errors",
|
|
48
49
|
"route": "/api/storefront/checkouts/:id",
|
|
49
|
-
"explanation": "
|
|
50
|
+
"explanation": "<p>Due to the more complex nature of checkout updates and data,<br>\ncheckout validation errors are returned inline with the resource<br>\nthey are coming from as shown below. Note the response status can be<br>\n200 OK, due to some data being persisted properly.</p>\n",
|
|
50
51
|
"http_method": "PATCH"
|
|
51
52
|
}
|