workarea-api 4.4.7 → 4.5.0
Sign up to get free protection for your applications and to get access to all the features.
- 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 +15 -11
- data/Gemfile +3 -2
- data/README.md +13 -0
- data/Rakefile +14 -5
- 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/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/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/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/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/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/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 +10 -6
- 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/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 +8 -7
- 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 +19 -6
- data/doc/api/storefront/analytics/saving_a_product_view.json +19 -6
- data/doc/api/storefront/analytics/saving_a_search.json +19 -6
- data/doc/api/storefront/assets/showing_an_asset.json +10 -9
- data/doc/api/storefront/authentication/creating_an_authentication_token.json +10 -9
- data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +10 -9
- data/doc/api/storefront/authentication/using_an_authentication_token.json +11 -10
- data/doc/api/storefront/cart/adding_a_promo_code.json +11 -10
- data/doc/api/storefront/cart/adding_an_item.json +11 -10
- data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +10 -9
- data/doc/api/storefront/cart/creating_a_new_guest_cart.json +8 -7
- data/doc/api/storefront/cart/delete_an_item.json +11 -10
- data/doc/api/storefront/cart/listing_user_s_carts.json +10 -9
- data/doc/api/storefront/cart/showing_cart.json +11 -10
- data/doc/api/storefront/cart/updating_an_item.json +11 -10
- data/doc/api/storefront/categories/showing_a_category.json +9 -8
- data/doc/api/storefront/categories/showing_a_listing_of_categories.json +9 -8
- data/doc/api/storefront/checkout/completing_a_checkout.json +10 -9
- data/doc/api/storefront/checkout/showing_a_checkout.json +11 -10
- data/doc/api/storefront/checkout/updating_a_checkout.json +10 -9
- data/doc/api/storefront/contacts/creating_a_contact.json +8 -7
- data/doc/api/storefront/email_signups/creating_an_email_signup.json +8 -7
- data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +8 -7
- data/doc/api/storefront/index.json +263 -258
- data/doc/api/storefront/menus/listing_menus.json +9 -8
- data/doc/api/storefront/menus/showing_a_menu.json +11 -10
- data/doc/api/storefront/orders/listing_the_user_s_orders.json +10 -9
- data/doc/api/storefront/orders/showing_an_order.json +11 -10
- data/doc/api/storefront/pages/showing_a_page.json +9 -8
- data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +9 -7
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +12 -12
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +11 -10
- data/doc/api/storefront/products/showing_a_product.json +9 -8
- data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +9 -8
- data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +11 -10
- data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +12 -12
- data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +7 -5
- data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +9 -7
- 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 +10 -9
- 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 +10 -9
- 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 +10 -9
- data/doc/api/storefront/searches/showing_search_results.json +9 -8
- 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 +9 -8
- data/doc/api/storefront/system_content/showing_the_home_page.json +9 -8
- data/doc/api/storefront/taxons/showing_a_taxon.json +11 -10
- data/doc/api/storefront/validation_errors/checkout_validation_errors.json +10 -9
- data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
- data/lib/workarea/api/documentation_test.rb +10 -1
- data/lib/workarea/api/version.rb +1 -1
- 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/visit.decorator +52 -0
- data/storefront/lib/workarea/api/storefront.rb +1 -0
- data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
- 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
- metadata +18 -12
- data/doc/api/admin/orders/viewing_orders_by_date_range.json +0 -68
- 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
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"requests": [
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
|
-
"Authorization": "Token token=\"
|
|
11
|
+
"Authorization": "Token token=\"PyZYRYWTePm6MxVHq8YcbAy9\""
|
|
12
12
|
},
|
|
13
13
|
"request_query_parameters": {
|
|
14
14
|
},
|
|
@@ -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:52:51 GMT",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "2a802a02-c076-4439-be9f-e51812cb65f4",
|
|
31
|
+
"X-Runtime": "0.055468",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "2236"
|
|
34
35
|
},
|
|
35
36
|
"request_method": "GET",
|
|
36
|
-
"request_path": "/api/storefront/carts/
|
|
37
|
+
"request_path": "/api/storefront/carts/D1897A816B",
|
|
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 \"id\": \"
|
|
42
|
+
"response_body": "{\n \"id\": \"D1897A816B\",\n \"url\": \"http://www.example.com/api/storefront/orders/D1897A816B\",\n \"user_id\": \"5dddc8e21241596aa5204ce8\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8e31241596aa5204cfe\",\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}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/carts/
|
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/carts/D1897A816B\" -X GET \\\n\t-H \"Authorization: Token token=\\\"PyZYRYWTePm6MxVHq8YcbAy9\\\"\""
|
|
44
45
|
}
|
|
45
46
|
],
|
|
46
47
|
"resource": "Cart",
|
|
47
48
|
"description": "Showing cart",
|
|
48
49
|
"route": "/api/storefront/carts/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
50
|
+
"explanation": "<p>This will get details on a cart you've created with the cart<br>\ncreation endpoint.</p>\n",
|
|
51
|
+
"http_method": "GET"
|
|
51
52
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"FN3aXvpN1CF1WnZaAkjjdUKD\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -25,28 +25,29 @@
|
|
|
25
25
|
"Access-Control-Allow-Headers": "*",
|
|
26
26
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
27
|
"X-Requested-With": "",
|
|
28
|
-
"Vary": "X-Requested-With, X-
|
|
29
|
-
"
|
|
28
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
29
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:50:35 GMT",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "ee770fd7-c129-40de-b3bb-069f1d7f032c",
|
|
32
|
+
"X-Runtime": "0.080208",
|
|
33
|
+
"X-Workarea-Segments": "",
|
|
33
34
|
"Expires": "0",
|
|
34
35
|
"Content-Length": "3920"
|
|
35
36
|
},
|
|
36
37
|
"request_method": "PATCH",
|
|
37
|
-
"request_path": "/api/storefront/carts/
|
|
38
|
+
"request_path": "/api/storefront/carts/A1E0D80812/items/5dddc85b1241596aa5204835",
|
|
38
39
|
"request_body": "{\"sku\":\"VT002\",\"quantity\":3}",
|
|
39
40
|
"request_content_type": "application/json",
|
|
40
41
|
"response_status": 200,
|
|
41
42
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"item\": {\n \"id\": \"
|
|
43
|
+
"response_body": "{\n \"item\": {\n \"id\": \"5dddc85b1241596aa5204835\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT002\",\n \"quantity\": 3,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT002\",\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\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n \"order\": {\n \"id\": \"A1E0D80812\",\n \"url\": \"http://www.example.com/api/storefront/orders/A1E0D80812\",\n \"user_id\": \"5dddc85a1241596aa520481f\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc85b1241596aa5204835\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT002\",\n \"quantity\": 3,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT002\",\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\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 600.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\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n}",
|
|
43
44
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/carts/
|
|
45
|
+
"curl": "curl \"https://www.example.com/api/storefront/carts/A1E0D80812/items/5dddc85b1241596aa5204835\" -d '{\"sku\":\"VT002\",\"quantity\":3}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"FN3aXvpN1CF1WnZaAkjjdUKD\\\"\""
|
|
45
46
|
}
|
|
46
47
|
],
|
|
47
48
|
"resource": "Cart",
|
|
48
49
|
"description": "Updating an item",
|
|
49
50
|
"route": "/api/storefront/carts/:cart_id/items/:id",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
51
|
+
"explanation": "<p>Updates an item in the cart. Use the create a cart endpoint to get a<br>\ncart ID to use with this endpoint, and use the adding an item<br>\nendpoint to get an ID for an item.</p>\n",
|
|
52
|
+
"http_method": "PATCH"
|
|
52
53
|
}
|
|
@@ -31,17 +31,18 @@
|
|
|
31
31
|
"X-Download-Options": "noopen",
|
|
32
32
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
33
33
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
34
|
-
"Date": "
|
|
34
|
+
"Date": "Wed, 27 Nov 2019 00:52:40 GMT",
|
|
35
35
|
"Content-Type": "application/json; charset=utf-8",
|
|
36
36
|
"Access-Control-Allow-Origin": "*",
|
|
37
37
|
"Access-Control-Allow-Headers": "*",
|
|
38
38
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
39
39
|
"X-Requested-With": "",
|
|
40
|
-
"Vary": "X-Requested-With, X-
|
|
40
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
41
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:52:40 GMT",
|
|
41
42
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
42
|
-
"
|
|
43
|
-
"X-
|
|
44
|
-
"X-
|
|
43
|
+
"X-Request-Id": "3cedf17c-4e2a-4c91-a615-152d726fd286",
|
|
44
|
+
"X-Runtime": "0.033085",
|
|
45
|
+
"X-Workarea-Segments": "",
|
|
45
46
|
"Expires": "0",
|
|
46
47
|
"Content-Length": "5026"
|
|
47
48
|
},
|
|
@@ -51,7 +52,7 @@
|
|
|
51
52
|
"request_content_type": null,
|
|
52
53
|
"response_status": 200,
|
|
53
54
|
"response_status_text": "OK",
|
|
54
|
-
"response_body": "{\n \"id\": \"
|
|
55
|
+
"response_body": "{\n \"id\": \"5dddc8d71241596aa5204cb4\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"browser_title\": \"Home - Mens - Shirts\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"sorts\": [\n [\n \"Featured\",\n \"featured\"\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\": \"price_desc\",\n \"breadcrumbs\": [\n {\n \"id\": \"5dddc8d71241596aa5204cba\",\n \"url\": \"/api/storefront/taxons/5dddc8d71241596aa5204cba\",\n \"name\": \"Home\",\n \"depth\": 0,\n \"navigable_url\": \"/\",\n \"parent_id\": null,\n \"parent_ids\": [\n\n ],\n \"position\": 0\n },\n {\n \"id\": \"5dddc8d71241596aa5204cb9\",\n \"url\": \"/api/storefront/taxons/5dddc8d71241596aa5204cb9\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": null,\n \"parent_id\": \"5dddc8d71241596aa5204cba\",\n \"parent_ids\": [\n \"5dddc8d71241596aa5204cba\"\n ],\n \"position\": 0\n },\n {\n \"id\": \"5dddc8d71241596aa5204cbb\",\n \"url\": \"/api/storefront/taxons/5dddc8d71241596aa5204cbb\",\n \"name\": \"Shirts\",\n \"depth\": 2,\n \"navigable_url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"parent_id\": \"5dddc8d71241596aa5204cb9\",\n \"parent_ids\": [\n \"5dddc8d71241596aa5204cba\",\n \"5dddc8d71241596aa5204cb9\"\n ],\n \"position\": 0\n }\n ],\n \"content_blocks\": [\n {\n \"id\": \"5dddc8d81241596aa5204cbc\",\n \"type\": \"text\",\n \"area\": \"above_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8d81241596aa5204cbc\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8d81241596aa5204cbc","type":"text","position":0,"data":{"text":"text"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5dddc8d81241596aa5204cbd\",\n \"type\": \"text\",\n \"area\": \"below_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5dddc8d81241596aa5204cbd\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5dddc8d81241596aa5204cbd","type":"text","position":0,"data":{"text":"text"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</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\": 1,\n \"total_pages\": 1,\n \"facets\": [\n {\n \"type\": \"terms\",\n \"name\": \"Size\",\n \"display_name\": \"Size\",\n \"results\": [\n {\n \"name\": \"Small\",\n \"count\": 1\n },\n {\n \"name\": \"Medium\",\n \"count\": 1\n },\n {\n \"name\": \"Large\",\n \"count\": 1\n }\n ]\n }\n ],\n \"products\": [\n {\n \"id\": \"FE50321449\",\n \"name\": \"Sweet Shirt\",\n \"description\": null,\n \"slug\": \"sweet-shirt\",\n \"browser_title\": \"Sweet Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\n ],\n \"color\": [\n \"Red\"\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\": \"5dddc8d71241596aa5204cab\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5dddc8d71241596aa5204cac\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5dddc8d71241596aa5204cac/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
|
55
56
|
"response_content_type": "application/json",
|
|
56
57
|
"curl": "curl -g \"https://www.example.com/api/storefront/categories/shirts?page=1&sort=price_desc\" -X GET "
|
|
57
58
|
}
|
|
@@ -59,6 +60,6 @@
|
|
|
59
60
|
"resource": "Categories",
|
|
60
61
|
"description": "Showing a category",
|
|
61
62
|
"route": "/api/storefront/categories/:slug",
|
|
62
|
-
"
|
|
63
|
-
"
|
|
63
|
+
"explanation": "<p>This endpoint includes everything you need to render a category,<br>\nincluding any associated content, products, and filters.</p>\n",
|
|
64
|
+
"http_method": "GET"
|
|
64
65
|
}
|
|
@@ -22,17 +22,18 @@
|
|
|
22
22
|
"X-Download-Options": "noopen",
|
|
23
23
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
24
24
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
25
|
-
"Date": "
|
|
25
|
+
"Date": "Wed, 27 Nov 2019 00:52:42 GMT",
|
|
26
26
|
"Content-Type": "application/json; charset=utf-8",
|
|
27
27
|
"Access-Control-Allow-Origin": "*",
|
|
28
28
|
"Access-Control-Allow-Headers": "*",
|
|
29
29
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
30
30
|
"X-Requested-With": "",
|
|
31
|
-
"Vary": "X-Requested-With, X-
|
|
31
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
32
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:52:42 GMT",
|
|
32
33
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
33
|
-
"
|
|
34
|
-
"X-
|
|
35
|
-
"X-
|
|
34
|
+
"X-Request-Id": "1985fa40-07cb-4cf7-b01a-2d60583fd06f",
|
|
35
|
+
"X-Runtime": "0.006764",
|
|
36
|
+
"X-Workarea-Segments": "",
|
|
36
37
|
"Expires": "0",
|
|
37
38
|
"Content-Length": "273"
|
|
38
39
|
},
|
|
@@ -42,7 +43,7 @@
|
|
|
42
43
|
"request_content_type": null,
|
|
43
44
|
"response_status": 200,
|
|
44
45
|
"response_status_text": "OK",
|
|
45
|
-
"response_body": "{\n \"categories\": [\n {\n \"id\": \"
|
|
46
|
+
"response_body": "{\n \"categories\": [\n {\n \"id\": \"5dddc8da1241596aa5204cc9\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\"\n },\n {\n \"id\": \"5dddc8da1241596aa5204cd3\",\n \"name\": \"Pants\",\n \"slug\": \"pants\",\n \"url\": \"http://www.example.com/api/storefront/categories/pants\"\n }\n ]\n}",
|
|
46
47
|
"response_content_type": "application/json",
|
|
47
48
|
"curl": "curl -g \"https://www.example.com/api/storefront/categories?page=1\" -X GET "
|
|
48
49
|
}
|
|
@@ -50,6 +51,6 @@
|
|
|
50
51
|
"resource": "Categories",
|
|
51
52
|
"description": "Showing a listing of categories",
|
|
52
53
|
"route": "/api/storefront/categories",
|
|
53
|
-
"
|
|
54
|
-
"
|
|
54
|
+
"explanation": "<p>This endpoint will give you a paginated list of all active<br>\ncategories, that is, all categories that could be shown on the<br>\nstorefront.</p>\n",
|
|
55
|
+
"http_method": "GET"
|
|
55
56
|
}
|
|
@@ -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:53:04 GMT",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "
|
|
30
|
+
"X-Request-Id": "f63c91d4-74c5-4668-b4c9-7037d4344844",
|
|
31
|
+
"X-Runtime": "1.455383",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "4695"
|
|
34
35
|
},
|
|
35
36
|
"request_method": "POST",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
37
|
+
"request_path": "/api/storefront/checkouts/4F98F9F8C0/complete",
|
|
37
38
|
"request_body": "{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}",
|
|
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\": \"4F98F9F8C0\",\n \"url\": \"http://www.example.com/api/storefront/orders/4F98F9F8C0\",\n \"user_id\": null,\n \"email\": \"susanb@workarea.com\",\n \"placed_at\": \"2019-11-27T00:53:04.256Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8ed1241596aa5204da0\",\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\": 1000.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\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5dddc8ed1241596aa5204dae\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"billing_address\": {\n \"id\": \"5dddc8ee1241596aa5204dd8\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"tenders\": [\n {\n \"type\": \"credit_card\",\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 3,\n \"year\": 2021\n }\n ]\n },\n \"fulfillment\": {\n \"status\": \"Open\",\n \"packages\": [\n\n ],\n \"pending_items\": [\n {\n \"id\": \"5dddc8ed1241596aa5204da0\",\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 \"canceled_items\": [\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/4F98F9F8C0/complete\" -d '{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
45
|
}
|
|
45
46
|
],
|
|
46
47
|
"resource": "Checkout",
|
|
47
48
|
"description": "Completing a checkout",
|
|
48
49
|
"route": "/api/storefront/checkouts/:id/complete",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
50
|
+
"explanation": "<p>This endpoint completes checkout and places the order. Payment<br>\ntender information is required at this point, and should be included<br>\nwith this request.</p>\n",
|
|
51
|
+
"http_method": "POST"
|
|
51
52
|
}
|
|
@@ -23,28 +23,29 @@
|
|
|
23
23
|
"Access-Control-Allow-Headers": "*",
|
|
24
24
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
25
25
|
"X-Requested-With": "",
|
|
26
|
-
"Vary": "X-Requested-With, X-
|
|
27
|
-
"
|
|
26
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
27
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:53:10 GMT",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"X-Request-Id": "
|
|
30
|
-
"X-Runtime": "0.
|
|
29
|
+
"X-Request-Id": "82b18cff-a9e1-4d4d-9fc1-521ec952b655",
|
|
30
|
+
"X-Runtime": "0.082309",
|
|
31
|
+
"X-Workarea-Segments": "",
|
|
31
32
|
"Expires": "0",
|
|
32
33
|
"Content-Length": "2900"
|
|
33
34
|
},
|
|
34
35
|
"request_method": "GET",
|
|
35
|
-
"request_path": "/api/storefront/checkouts/
|
|
36
|
+
"request_path": "/api/storefront/checkouts/D44686C517",
|
|
36
37
|
"request_body": null,
|
|
37
38
|
"request_content_type": null,
|
|
38
39
|
"response_status": 200,
|
|
39
40
|
"response_status_text": "OK",
|
|
40
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"order\": {\n \"id\": \"D44686C517\",\n \"url\": \"http://www.example.com/api/storefront/orders/D44686C517\",\n \"user_id\": null,\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8f61241596aa5204e9a\",\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/D44686C517\",\n \"started_at\": \"2019-11-27T00:53:10.600Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"sbaker@workarea.com\",\n \"problems\": [\n\n ],\n \"billing_address\": {\n \"id\": \"5dddc8f61241596aa5204eb0\",\n \"first_name\": null,\n \"last_name\": null,\n \"company\": null,\n \"street\": null,\n \"street_2\": null,\n \"city\": null,\n \"country\": null,\n \"region\": null,\n \"postal_code\": null,\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n\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\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
|
|
41
42
|
"response_content_type": "application/json",
|
|
42
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/checkouts/
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/checkouts/D44686C517\" -X GET "
|
|
43
44
|
}
|
|
44
45
|
],
|
|
45
46
|
"resource": "Checkout",
|
|
46
47
|
"description": "Showing a checkout",
|
|
47
|
-
"route": "/api/storefront/checkouts/:id
|
|
48
|
-
"
|
|
49
|
-
"
|
|
48
|
+
"route": "/api/storefront/checkouts/:id",
|
|
49
|
+
"explanation": "<p>This will give you overview of the state of checkout for the<br>\nassociated order ID. It includes full order information, as well<br>\nas summary information for each step of checkout.</p>\n",
|
|
50
|
+
"http_method": "GET"
|
|
50
51
|
}
|
|
@@ -24,28 +24,29 @@
|
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
28
|
-
"
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:53:14 GMT",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "1.
|
|
30
|
+
"X-Request-Id": "a34b5f86-aa51-4284-892b-9a6efab28fd4",
|
|
31
|
+
"X-Runtime": "1.728587",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "3978"
|
|
34
35
|
},
|
|
35
36
|
"request_method": "PATCH",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
37
|
+
"request_path": "/api/storefront/checkouts/7261CDFEAC",
|
|
37
38
|
"request_body": "{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}",
|
|
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\": \"7261CDFEAC\",\n \"url\": \"http://www.example.com/api/storefront/orders/7261CDFEAC\",\n \"user_id\": null,\n \"email\": \"susanb@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5dddc8f81241596aa5204ec5\",\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\": 1000.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\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5dddc8f81241596aa5204ed3\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"billing_address\": {\n \"id\": \"5dddc8f91241596aa5204efd\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/7261CDFEAC\",\n \"started_at\": \"2019-11-27T00:53:12.791Z\",\n \"shippable\": true,\n \"complete\": false,\n \"addresses\": {\n \"complete\": true,\n \"email\": \"susanb@workarea.com\",\n \"problems\": [\n\n ],\n \"shipping_address\": {\n \"id\": \"5dddc8f81241596aa5204ed3\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n },\n \"billing_address\": {\n \"id\": \"5dddc8f91241596aa5204efd\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n }\n },\n \"shipping\": {\n \"complete\": true,\n \"problems\": [\n\n ],\n \"shipping_service\": \"Express\",\n \"shipping_total\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n {\n \"name\": \"Standard\",\n \"price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"name\": \"Express\",\n \"price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"name\": \"Overnight\",\n \"price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n\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/7261CDFEAC\" -d '{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
|
44
45
|
}
|
|
45
46
|
],
|
|
46
47
|
"resource": "Checkout",
|
|
47
48
|
"description": "Updating a checkout",
|
|
48
49
|
"route": "/api/storefront/checkouts/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
50
|
+
"explanation": "<p>Use this endpoint to make updates to checkout. This will typically<br>\nmean setting addresses and shipping options for the checkout.</p>\n",
|
|
51
|
+
"http_method": "PATCH"
|
|
51
52
|
}
|
|
@@ -24,11 +24,12 @@
|
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
26
26
|
"X-Requested-With": "",
|
|
27
|
-
"Vary": "X-Requested-With, X-
|
|
28
|
-
"
|
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
|
28
|
+
"Last-Modified": "Wed, 27 Nov 2019 00:50:56 GMT",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "494b0407-edc8-4eda-87ed-f4d8cab1f372",
|
|
31
|
+
"X-Runtime": "0.057435",
|
|
32
|
+
"X-Workarea-Segments": "",
|
|
32
33
|
"Expires": "0",
|
|
33
34
|
"Content-Length": "228"
|
|
34
35
|
},
|
|
@@ -38,7 +39,7 @@
|
|
|
38
39
|
"request_content_type": "application/json",
|
|
39
40
|
"response_status": 200,
|
|
40
41
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"inquiry\": {\n \"_id\": \"
|
|
42
|
+
"response_body": "{\n \"inquiry\": {\n \"_id\": \"5dddc8701241596aa5204883\",\n \"created_at\": \"2019-11-27T00:50:56.027Z\",\n \"email\": \"email@example.com\",\n \"message\": \"Message\",\n \"name\": \"Name\",\n \"order_id\": \"OrderID\",\n \"subject\": \"orders\",\n \"updated_at\": \"2019-11-27T00:50:56.027Z\"\n }\n}",
|
|
42
43
|
"response_content_type": "application/json",
|
|
43
44
|
"curl": "curl \"https://www.example.com/api/storefront/contacts\" -d '{\"name\":\"Name\",\"email\":\"email@example.com\",\"order_id\":\"OrderID\",\"subject\":\"orders\",\"message\":\"Message\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
45
|
}
|
|
@@ -46,6 +47,6 @@
|
|
|
46
47
|
"resource": "Contacts",
|
|
47
48
|
"description": "Creating a contact",
|
|
48
49
|
"route": "/api/storefront/contacts",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
50
|
+
"explanation": "<p>This endpoints creates a customer service inquiry on behalf of the<br>\ncustomer, and will send an email to the address in<br>\nWorkarea.config.email_to</p>\n",
|
|
51
|
+
"http_method": "POST"
|
|
51
52
|
}
|