workarea-api 4.4.7 → 4.5.5
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 +97 -7
- data/Gemfile +1 -2
- data/README.md +14 -1
- data/Rakefile +18 -8
- 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 +2 -2
- 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 +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 +10 -7
- 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 +8 -5
- data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
- data/doc/api/admin/tax_categories/showing_a_tax_category.json +10 -7
- 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 +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 +11 -10
- data/doc/api/storefront/checkout/failure_to_update_a_checkout.json +52 -0
- 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 +269 -257
- 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 +11 -11
- 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 +9 -8
- 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 +10 -9
- 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 +12 -11
- data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
- 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/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 +2 -2
- data/workarea-api.gemspec +1 -1
- metadata +32 -13
- 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
@@ -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": "
|
21
|
+
"Date": "Wed, 19 Aug 2020 13:58:28 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, 19 Aug 2020 13:58:28 GMT",
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"
|
30
|
-
"X-
|
31
|
-
"X-
|
30
|
+
"X-Request-Id": "7fac0227-db2f-4bb0-8029-becbb420593d",
|
31
|
+
"X-Runtime": "0.072843",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "5185"
|
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 \"menus\": [\n {\n \"id\": \"
|
42
|
+
"response_body": "{\n \"menus\": [\n {\n \"id\": \"5f3d30040218236e938cfb71\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5f3d30040218236e938cfb71\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5f3d30040218236e938cfb73\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5f3d30040218236e938cfb6f\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5f3d30040218236e938cfb73\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d30040218236e938cfb73","type":"taxonomy","position":0,"data":{"start":"5f3d30040218236e938cfb6f","header":"","show_starting_taxon":true,"image":"","image_alt":"","image_link":"","image_position":""}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n },\n {\n \"id\": \"5f3d30040218236e938cfb77\",\n \"name\": \"Women\",\n \"position\": 1,\n \"url\": \"/api/storefront/menus/5f3d30040218236e938cfb77\",\n \"taxon_url\": \"http://example.com/women\",\n \"content_blocks\": [\n {\n \"id\": \"5f3d30040218236e938cfb79\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5f3d30040218236e938cfb75\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5f3d30040218236e938cfb79\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d30040218236e938cfb79","type":"taxonomy","position":0,"data":{"start":"5f3d30040218236e938cfb75","header":"","show_starting_taxon":true,"image":"","image_alt":"","image_link":"","image_position":""}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n },\n {\n \"id\": \"5f3d30040218236e938cfb7d\",\n \"name\": \"Children\",\n \"position\": 2,\n \"url\": \"/api/storefront/menus/5f3d30040218236e938cfb7d\",\n \"taxon_url\": \"http://example.com/children\",\n \"content_blocks\": [\n {\n \"id\": \"5f3d30040218236e938cfb7f\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5f3d30040218236e938cfb7b\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5f3d30040218236e938cfb7f\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d30040218236e938cfb7f","type":"taxonomy","position":0,"data":{"start":"5f3d30040218236e938cfb7b","header":"","show_starting_taxon":true,"image":"","image_alt":"","image_link":"","image_position":""}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n }\n ]\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
44
|
"curl": "curl -g \"https://www.example.com/api/storefront/menus\" -X GET "
|
44
45
|
}
|
@@ -46,6 +47,6 @@
|
|
46
47
|
"resource": "Menus",
|
47
48
|
"description": "Listing menus",
|
48
49
|
"route": "/api/storefront/menus",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>In the base HTML storefront, menus are used as the primary top-level<br>\nnavigation entry points. Each menu has associated content (composed<br>\nof content blocks) that represent the navigation to be display when<br>\nthat menu is selected (usually a hover or a click on a mobile<br>\ndevice). Each menu points at a particular spot in the taxonomy.</p>\n",
|
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": "
|
21
|
+
"Date": "Wed, 19 Aug 2020 13:58:29 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, 19 Aug 2020 13:58:30 GMT",
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"
|
30
|
-
"X-
|
31
|
-
"X-
|
30
|
+
"X-Request-Id": "0477f572-ade1-4af0-838e-3e4b25a33ed5",
|
31
|
+
"X-Runtime": "0.047014",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "1719"
|
34
35
|
},
|
35
36
|
"request_method": "GET",
|
36
|
-
"request_path": "/api/storefront/menus/
|
37
|
+
"request_path": "/api/storefront/menus/5f3d30050218236e938cfb87",
|
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\": \"5f3d30050218236e938cfb87\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5f3d30050218236e938cfb87\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5f3d30050218236e938cfb89\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5f3d30050218236e938cfb85\",\n \"header\": \"\",\n \"show_starting_taxon\": true,\n \"image\": \"\",\n \"image_alt\": \"\",\n \"image_link\": \"\",\n \"image_position\": \"\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--taxonomy\\\" id=\\\"content_block_5f3d30050218236e938cfb89\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d30050218236e938cfb89","type":"taxonomy","position":0,"data":{"start":"5f3d30050218236e938cfb85","header":"","show_starting_taxon":true,"image":"","image_alt":"","image_link":"","image_position":""}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='taxonomy-content-block'>\\n<div class='taxonomy-content-block__container taxonomy-content-block__container--without-image'>\\n<ul class='taxonomy-content-block__menu'>\\n<li class='taxonomy-content-block__menu-item taxonomy-content-block__menu-item--start'>\\nSale\\n</li>\\n</ul>\\n</div>\\n</div>\\n</div>\\n\"\n }\n ]\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/menus/
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/menus/5f3d30050218236e938cfb87\" -X GET "
|
44
45
|
}
|
45
46
|
],
|
46
47
|
"resource": "Menus",
|
47
48
|
"description": "Showing a menu",
|
48
49
|
"route": "/api/storefront/menus/:id",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>This endpoint will return all the data used to render a menu. This<br>\nincludes the corresponding content, as well a link to where the<br>\nmenu points at in the taxonomy.</p>\n",
|
51
|
+
"http_method": "GET"
|
51
52
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"WfE3JMRhsFRNVjuHJW8R5qzc\""
|
12
12
|
},
|
13
13
|
"request_query_parameters": {
|
14
14
|
},
|
@@ -24,11 +24,12 @@
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
26
26
|
"X-Requested-With": "",
|
27
|
-
"Vary": "X-Requested-With, X-
|
28
|
-
"
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
28
|
+
"Last-Modified": "Wed, 19 Aug 2020 13:55:35 GMT",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "965e439f-26a1-4516-8824-a96f319b8937",
|
31
|
+
"X-Runtime": "0.032533",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "6389"
|
34
35
|
},
|
@@ -38,14 +39,14 @@
|
|
38
39
|
"request_content_type": null,
|
39
40
|
"response_status": 200,
|
40
41
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"user_id\": \"5d5eca67d4322a04dfbf6d06\",\n \"orders\": [\n {\n \"id\": \"CCC1BC23CA\",\n \"url\": \"http://www.example.com/api/storefront/orders/CCC1BC23CA\",\n \"user_id\": \"5d5eca67d4322a04dfbf6d06\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2019-08-22T17:01:29.897Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca68d4322a04dfbf6d10\",\n \"product_id\": \"4BCA4E9FE3\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n {\n \"id\": \"5d5eca68d4322a04dfbf6d0d\",\n \"product_id\": \"6F156110DA\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 \"id\": \"5d5eca67d4322a04dfbf6d0a\",\n \"product_id\": \"5903172D27\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 4000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5d5eca68d4322a04dfbf6d14\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": \"5d5eca68d4322a04dfbf6d28\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Test Card\",\n \"display_number\": \"XXXX-XXXX-XXXX-1\",\n \"month\": 1,\n \"year\": 2020\n }\n ]\n }\n ]\n}",
|
42
|
+
"response_body": "{\n \"user_id\": \"5f3d2f520218236e938cf11f\",\n \"orders\": [\n {\n \"id\": \"B72BA24A04\",\n \"url\": \"http://www.example.com/api/storefront/orders/B72BA24A04\",\n \"user_id\": \"5f3d2f520218236e938cf11f\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2020-08-19T13:55:34.142Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5f3d2f540218236e938cf133\",\n \"product_id\": \"DE76DF607F\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n {\n \"id\": \"5f3d2f530218236e938cf12d\",\n \"product_id\": \"1F70879869\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 \"id\": \"5f3d2f530218236e938cf127\",\n \"product_id\": \"34293CBFEC\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 4000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5f3d2f540218236e938cf13a\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": \"5f3d2f540218236e938cf14e\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Test Card\",\n \"display_number\": \"XXXX-XXXX-XXXX-1\",\n \"month\": 1,\n \"year\": 2021\n }\n ]\n }\n ]\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/orders\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/orders\" -X GET \\\n\t-H \"Authorization: Token token=\\\"WfE3JMRhsFRNVjuHJW8R5qzc\\\"\""
|
44
45
|
}
|
45
46
|
],
|
46
47
|
"resource": "Orders",
|
47
48
|
"description": "Listing the user's orders",
|
48
49
|
"route": "/api/storefront/orders",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>This endpoints returns recently placed orders for a customer. Use it<br>\nfor showing an order history for the customer.</p>\n",
|
51
|
+
"http_method": "GET"
|
51
52
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"YdTLkGqZwuvQDwvBVq3uZuRW\""
|
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, 19 Aug 2020 13:55:41 GMT",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "645a2213-6d96-48c3-be6c-ced27ddae08e",
|
31
|
+
"X-Runtime": "0.035103",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "11595"
|
34
35
|
},
|
35
36
|
"request_method": "GET",
|
36
|
-
"request_path": "/api/storefront/orders/
|
37
|
+
"request_path": "/api/storefront/orders/124C536C8A",
|
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 \"order\": {\n \"id\": \"D4AAC8264B\",\n \"url\": \"http://www.example.com/api/storefront/orders/D4AAC8264B\",\n \"user_id\": \"5d5eca63d4322a04dfbf6cac\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2019-08-22T17:01:25.811Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca64d4322a04dfbf6cb6\",\n \"product_id\": \"8C6778E648\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n {\n \"id\": \"5d5eca64d4322a04dfbf6cb3\",\n \"product_id\": \"8937ED316B\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 \"id\": \"5d5eca63d4322a04dfbf6cb0\",\n \"product_id\": \"3442E225FA\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 4000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5d5eca64d4322a04dfbf6cba\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": \"5d5eca64d4322a04dfbf6cce\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Test Card\",\n \"display_number\": \"XXXX-XXXX-XXXX-1\",\n \"month\": 1,\n \"year\": 2020\n }\n ]\n },\n \"fulfillment\": {\n \"status\": \"Partially Shipped\",\n \"packages\": [\n {\n \"tracking_number\": \"1z\",\n \"tracking_link\": \"http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1z\",\n \"items\": [\n {\n \"id\": \"5d5eca63d4322a04dfbf6cb0\",\n \"product_id\": \"3442E225FA\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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 }\n ],\n \"pending_items\": [\n {\n \"id\": \"5d5eca64d4322a04dfbf6cb6\",\n \"product_id\": \"8C6778E648\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"canceled_items\": [\n {\n \"id\": \"5d5eca64d4322a04dfbf6cb3\",\n \"product_id\": \"8937ED316B\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 }\n}",
|
42
|
+
"response_body": "{\n \"order\": {\n \"id\": \"124C536C8A\",\n \"url\": \"http://www.example.com/api/storefront/orders/124C536C8A\",\n \"user_id\": \"5f3d2f580218236e938cf18e\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2020-08-19T13:55:40.032Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5f3d2f5a0218236e938cf1a2\",\n \"product_id\": \"DC4C8E330D\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n {\n \"id\": \"5f3d2f590218236e938cf19c\",\n \"product_id\": \"EB7FDFA55D\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 \"id\": \"5f3d2f590218236e938cf196\",\n \"product_id\": \"C259032794\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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\": 100.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 4000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 4100.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5f3d2f5a0218236e938cf1a9\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": \"5f3d2f5a0218236e938cf1bd\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": \"Second Floor\",\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\": 4100.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Test Card\",\n \"display_number\": \"XXXX-XXXX-XXXX-1\",\n \"month\": 1,\n \"year\": 2021\n }\n ]\n },\n \"fulfillment\": {\n \"status\": \"Partially Shipped\",\n \"packages\": [\n {\n \"tracking_number\": \"1z\",\n \"tracking_link\": \"http://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1z\",\n \"items\": [\n {\n \"id\": \"5f3d2f590218236e938cf196\",\n \"product_id\": \"C259032794\",\n \"sku\": \"PROD1\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-one?sku=PROD1\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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 }\n ],\n \"pending_items\": [\n {\n \"id\": \"5f3d2f5a0218236e938cf1a2\",\n \"product_id\": \"DC4C8E330D\",\n \"sku\": \"PROD3\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-three?sku=PROD3\",\n \"options\": {\n },\n \"customizations\": {\n \"foo\": \"bar\"\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": true,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"canceled_items\": [\n {\n \"id\": \"5f3d2f590218236e938cf19c\",\n \"product_id\": \"EB7FDFA55D\",\n \"sku\": \"PROD2\",\n \"quantity\": 1,\n \"product_url\": \"http://www.example.com/api/storefront/products/product-two?sku=PROD2\",\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=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 1000.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 }\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/orders/
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/orders/124C536C8A\" -X GET \\\n\t-H \"Authorization: Token token=\\\"YdTLkGqZwuvQDwvBVq3uZuRW\\\"\""
|
44
45
|
}
|
45
46
|
],
|
46
47
|
"resource": "Orders",
|
47
48
|
"description": "Showing an order",
|
48
49
|
"route": "/api/storefront/orders/:id",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>This endpoint returns everything needed to render an order for a<br>\ncustomer's order history including order details and fulfillment<br>\nstatus.</p>\n",
|
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": "
|
21
|
+
"Date": "Wed, 19 Aug 2020 13:58:12 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, 19 Aug 2020 13:58:12 GMT",
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"
|
30
|
-
"X-
|
31
|
-
"X-
|
30
|
+
"X-Request-Id": "304bc416-5a4b-4012-be74-a7a8d8aa4e0a",
|
31
|
+
"X-Runtime": "0.029564",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "3949"
|
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\": \"5f3d2ff30218236e938cfb17\",\n \"name\": \"Summer Lookbook\",\n \"url\": \"http://www.example.com/api/storefront/pages/summer-lookbook\",\n \"browser_title\": \"Summer Lookbook\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"breadcrumbs\": [\n {\n \"id\": \"5f3d2ff30218236e938cfb1a\",\n \"url\": \"/api/storefront/taxons/5f3d2ff30218236e938cfb1a\",\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\": \"5f3d2ff30218236e938cfb19\",\n \"url\": \"/api/storefront/taxons/5f3d2ff30218236e938cfb19\",\n \"name\": \"Women\",\n \"depth\": 1,\n \"navigable_url\": \"www.example.com/women\",\n \"parent_id\": \"5f3d2ff30218236e938cfb1a\",\n \"parent_ids\": [\n \"5f3d2ff30218236e938cfb1a\"\n ],\n \"position\": 0\n },\n {\n \"id\": \"5f3d2ff30218236e938cfb1b\",\n \"url\": \"/api/storefront/taxons/5f3d2ff30218236e938cfb1b\",\n \"name\": \"Summer Lookbook\",\n \"depth\": 2,\n \"navigable_url\": \"http://www.example.com/api/storefront/pages/summer-lookbook\",\n \"parent_id\": \"5f3d2ff30218236e938cfb19\",\n \"parent_ids\": [\n \"5f3d2ff30218236e938cfb1a\",\n \"5f3d2ff30218236e938cfb19\"\n ],\n \"position\": 0\n }\n ],\n \"content_blocks\": [\n {\n \"id\": \"5f3d2ff40218236e938cfb1c\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Great new looks for summer\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2ff40218236e938cfb1c\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d2ff40218236e938cfb1c","type":"text","position":0,"data":{"text":"Great new looks for summer"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Great new looks for summer</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5f3d2ff40218236e938cfb1e\",\n \"type\": \"image\",\n \"area\": \"default\",\n \"data\": {\n \"image\": \"5f3d2ff40218236e938cfb1d\",\n \"alt\": \"splash\",\n \"link\": \"\",\n \"align\": \"\",\n \"image_url\": \"http://www.example.com/media/W1siZiIsIjIwMjAvMDgvMTkvN2I0OWZvMGF2eF9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=c1cbdba013924176\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--image\\\" id=\\\"content_block_5f3d2ff40218236e938cfb1e\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d2ff40218236e938cfb1e","type":"image","position":1,"data":{"image":"5f3d2ff40218236e938cfb1d","alt":"splash","link":"","align":""}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='image-content-block image-content-block--'>\\n<img alt=\\\"splash\\\" class=\\\"image-content-block__image\\\" src=\\\"/media/W1siZiIsIjIwMjAvMDgvMTkvN2I0OWZvMGF2eF9maWxlLmpwZyJdXQ/file.jpg?sha=ee0fb00277bcac32\\\" />\\n</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5f3d2ff40218236e938cfb1f\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Pool party fashion\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 2,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5f3d2ff40218236e938cfb1f\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5f3d2ff40218236e938cfb1f","type":"text","position":2,"data":{"text":"Pool party fashion"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Pool party fashion</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/pages/summer-lookbook\" -X GET "
|
44
45
|
}
|
@@ -46,6 +47,6 @@
|
|
46
47
|
"resource": "Pages",
|
47
48
|
"description": "Showing a page",
|
48
49
|
"route": "/api/storefront/pages/:slug",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>This endpoint will return all relevant data for showing a content<br>\npage.</p>\n",
|
51
|
+
"http_method": "GET"
|
51
52
|
}
|
@@ -24,27 +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-
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
28
|
+
"Last-Modified": "Wed, 19 Aug 2020 13:56:05 GMT",
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"X-Request-Id": "
|
30
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "6ee3c794-71a6-4bfd-adde-d50c81cde751",
|
31
|
+
"X-Runtime": "0.055095",
|
32
|
+
"X-Workarea-Segments": "",
|
31
33
|
"Expires": "0",
|
32
34
|
"Content-Length": "0"
|
33
35
|
},
|
34
36
|
"request_method": "POST",
|
35
37
|
"request_path": "/api/storefront/password_resets",
|
36
|
-
"request_body": "{\"email\":\"
|
38
|
+
"request_body": "{\"email\":\"user23@workarea.com\"}",
|
37
39
|
"request_content_type": "application/json",
|
38
40
|
"response_status": 200,
|
39
41
|
"response_status_text": "OK",
|
40
42
|
"response_body": null,
|
41
43
|
"response_content_type": "application/json",
|
42
|
-
"curl": "curl \"https://www.example.com/api/storefront/password_resets\" -d '{\"email\":\"
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/password_resets\" -d '{\"email\":\"user23@workarea.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
43
45
|
}
|
44
46
|
],
|
45
47
|
"resource": "Password Resets",
|
46
48
|
"description": "Sending a forgot password email",
|
47
49
|
"route": "/api/storefront/password_resets",
|
48
|
-
"
|
49
|
-
"
|
50
|
+
"explanation": "<p>This will send a password reset email to the email address if there<br>\nis an account. The email will contain a link to the site where the<br>\npassword reset can be completed.</p>\n",
|
51
|
+
"http_method": "POST"
|
50
52
|
}
|
data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json
CHANGED
@@ -13,7 +13,7 @@
|
|
13
13
|
"request_headers": {
|
14
14
|
},
|
15
15
|
"request_query_parameters": {
|
16
|
-
"session_id": "
|
16
|
+
"session_id": "5f3d2fdb0218236e938cfa4c"
|
17
17
|
},
|
18
18
|
"response_headers": {
|
19
19
|
"X-Frame-Options": "SAMEORIGIN",
|
@@ -22,34 +22,34 @@
|
|
22
22
|
"X-Download-Options": "noopen",
|
23
23
|
"X-Permitted-Cross-Domain-Policies": "none",
|
24
24
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
25
|
-
"ETag": "W/\"b17fa2c1de87116193d97597566aea88\"",
|
26
|
-
"Last-Modified": "Thu, 22 Aug 2019 16:59:53 GMT",
|
27
25
|
"Content-Type": "application/json; charset=utf-8",
|
28
26
|
"Access-Control-Allow-Origin": "*",
|
29
27
|
"Access-Control-Allow-Headers": "*",
|
30
28
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
31
29
|
"X-Requested-With": "",
|
32
|
-
"Vary": "X-Requested-With, X-
|
30
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
31
|
+
"Last-Modified": "Wed, 19 Aug 2020 13:57:47 GMT",
|
33
32
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
34
|
-
"X-Request-Id": "
|
35
|
-
"X-Runtime": "0.
|
33
|
+
"X-Request-Id": "7c1c724d-87a3-40e2-a97a-51062149706f",
|
34
|
+
"X-Runtime": "0.036701",
|
35
|
+
"X-Workarea-Segments": "",
|
36
36
|
"Expires": "0",
|
37
37
|
"Content-Length": "3882"
|
38
38
|
},
|
39
39
|
"request_method": "GET",
|
40
|
-
"request_path": "/api/storefront/recommendations?session_id=
|
40
|
+
"request_path": "/api/storefront/recommendations?session_id=5f3d2fdb0218236e938cfa4c",
|
41
41
|
"request_body": null,
|
42
42
|
"request_content_type": null,
|
43
43
|
"response_status": 200,
|
44
44
|
"response_status_text": "OK",
|
45
|
-
"response_body": "{\n \"products\": [\n {\n \"id\": \"
|
45
|
+
"response_body": "{\n \"products\": [\n {\n \"id\": \"E9E7800955\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-5\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fd40218236e938cf9d9\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"34E5EC2999\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-8\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fd90218236e938cfa27\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"1D17CB49A1\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fd00218236e938cf993\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"BFDEA22DC7\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-2\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fd10218236e938cf9a6\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"CFBAAA16DC\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-9\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fda0218236e938cfa47\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"8FE4FF5D0E\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-7\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fd70218236e938cfa0a\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n }\n ]\n}",
|
46
46
|
"response_content_type": "application/json",
|
47
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations?session_id=
|
47
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations?session_id=5f3d2fdb0218236e938cfa4c\" -X GET "
|
48
48
|
}
|
49
49
|
],
|
50
50
|
"resource": "Personalized Recommendations",
|
51
51
|
"description": "Showing recommendations with a session ID",
|
52
52
|
"route": "/api/storefront/recommendations",
|
53
|
-
"
|
54
|
-
"
|
53
|
+
"explanation": "<p>Display personalized recommendations based on a session ID that<br>\nyou've maintained for an anonymous browser (as opposed to<br>\nauthentication).</p>\n",
|
54
|
+
"http_method": "GET"
|
55
55
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"q9xkPcTMUCp5NFwpfozRwqio\""
|
12
12
|
},
|
13
13
|
"request_query_parameters": {
|
14
14
|
},
|
@@ -19,18 +19,19 @@
|
|
19
19
|
"X-Download-Options": "noopen",
|
20
20
|
"X-Permitted-Cross-Domain-Policies": "none",
|
21
21
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
22
|
-
"ETag": "W/\"56c7c66c36f11a5934f425a6b1266426\"",
|
23
22
|
"Content-Type": "application/json; charset=utf-8",
|
24
23
|
"Access-Control-Allow-Origin": "*",
|
25
24
|
"Access-Control-Allow-Headers": "*",
|
26
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
27
26
|
"X-Requested-With": "",
|
28
|
-
"Vary": "X-Requested-With, X-
|
27
|
+
"Vary": "X-Requested-With, X-Workarea-Segments",
|
28
|
+
"Last-Modified": "Wed, 19 Aug 2020 13:57:35 GMT",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "ae071ac6-9ffa-40af-bbc8-2939a64917df",
|
31
|
+
"X-Runtime": "0.038205",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
|
-
"Content-Length": "
|
34
|
+
"Content-Length": "3882"
|
34
35
|
},
|
35
36
|
"request_method": "GET",
|
36
37
|
"request_path": "/api/storefront/recommendations",
|
@@ -38,14 +39,14 @@
|
|
38
39
|
"request_content_type": null,
|
39
40
|
"response_status": 200,
|
40
41
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"products\": [\n {\n \"id\": \"
|
42
|
+
"response_body": "{\n \"products\": [\n {\n \"id\": \"502278AE1B\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fc40218236e938cf8d3\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"D2E25421D8\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-2\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fc50218236e938cf8e6\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"412426AC92\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-3\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fc60218236e938cf8f4\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"AA5D509E67\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-5\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fc80218236e938cf919\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"7BCCE88702\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-8\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fcd0218236e938cf967\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n },\n {\n \"id\": \"374816CDDC\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-9\",\n \"browser_title\": \"Test Product\",\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 \"Material\": \"Cotton\",\n \"Style\": \"12345\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5f3d2fce0218236e938cf987\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n\n ]\n }\n ]\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
44
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations\" -X GET \\\n\t-H \"Authorization: Token token=\\\"q9xkPcTMUCp5NFwpfozRwqio\\\"\""
|
44
45
|
}
|
45
46
|
],
|
46
47
|
"resource": "Personalized Recommendations",
|
47
48
|
"description": "Showing recommendations with authentication",
|
48
49
|
"route": "/api/storefront/recommendations",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>Display personalized recommendations based on the currently<br>\nauthenticated customer.</p>\n",
|
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": "
|
21
|
+
"Date": "Wed, 19 Aug 2020 13:57:21 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, 19 Aug 2020 13:57:21 GMT",
|
28
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"
|
30
|
-
"X-
|
31
|
-
"X-
|
30
|
+
"X-Request-Id": "c9551c4e-40fa-4f32-92ad-bcab93497379",
|
31
|
+
"X-Runtime": "0.070922",
|
32
|
+
"X-Workarea-Segments": "",
|
32
33
|
"Expires": "0",
|
33
34
|
"Content-Length": "4103"
|
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 \"product\": {\n \"id\": \"
|
42
|
+
"response_body": "{\n \"product\": {\n \"id\": \"D4F7562AFC\",\n \"name\": \"Nice Shirt\",\n \"description\": null,\n \"slug\": \"nice-shirt\",\n \"browser_title\": \"Nice 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\": \"5f3d2fc00218236e938cf884\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n },\n {\n \"id\": \"5f3d2fc00218236e938cf885\",\n \"name\": \"SKU2\",\n \"sku\": \"SKU2\",\n \"details\": {\n \"color\": [\n \"Red\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 300.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\": 300.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5f3d2fc00218236e938cf886\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc00218236e938cf886/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n \"recommendations\": [\n {\n \"id\": \"09730125B6\",\n \"name\": \"Fall Jacket\",\n \"description\": null,\n \"slug\": \"fall-jacket\",\n \"browser_title\": \"Fall Jacket\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\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\": \"5f3d2fc10218236e938cf89b\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\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\": \"5f3d2fc10218236e938cf89c\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc10218236e938cf89c/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
42
43
|
"response_content_type": "application/json",
|
43
44
|
"curl": "curl -g \"https://www.example.com/api/storefront/products/nice-shirt\" -X GET "
|
44
45
|
}
|
@@ -46,6 +47,6 @@
|
|
46
47
|
"resource": "Products",
|
47
48
|
"description": "Showing a product",
|
48
49
|
"route": "/api/storefront/products/:slug",
|
49
|
-
"
|
50
|
-
"
|
50
|
+
"explanation": "<p>This endpoint includes everything you need to render a product<br>\ndetail page including, variants, images, and recommendations.</p>\n",
|
51
|
+
"http_method": "GET"
|
51
52
|
}
|
@@ -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, 19 Aug 2020 13:57:23 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, 19 Aug 2020 13:57:23 GMT",
|
32
33
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
33
|
-
"
|
34
|
-
"X-
|
35
|
-
"X-
|
34
|
+
"X-Request-Id": "4d459126-94f6-4e43-bfb5-80b74eec5265",
|
35
|
+
"X-Runtime": "0.134119",
|
36
|
+
"X-Workarea-Segments": "",
|
36
37
|
"Expires": "0",
|
37
38
|
"Content-Length": "4111"
|
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 \"product\": {\n \"id\": \"
|
46
|
+
"response_body": "{\n \"product\": {\n \"id\": \"EC52269A34\",\n \"name\": \"Nice Shirt\",\n \"description\": null,\n \"slug\": \"nice-shirt\",\n \"browser_title\": \"Nice 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\": \"In Stock\",\n \"variants\": [\n {\n \"id\": \"5f3d2fc20218236e938cf8aa\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n },\n {\n \"id\": \"5f3d2fc20218236e938cf8ab\",\n \"name\": \"SKU2\",\n \"sku\": \"SKU2\",\n \"details\": {\n \"color\": [\n \"Red\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 300.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 300.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 300.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5f3d2fc20218236e938cf8ac\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5f3d2fc20218236e938cf8ac/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n \"recommendations\": [\n {\n \"id\": \"001616E40C\",\n \"name\": \"Fall Jacket\",\n \"description\": null,\n \"slug\": \"fall-jacket\",\n \"browser_title\": \"Fall Jacket\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\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\": \"5f3d2fc30218236e938cf8c1\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\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\": \"5f3d2fc30218236e938cf8c2\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5f3d2fc30218236e938cf8c2/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
46
47
|
"response_content_type": "application/json",
|
47
48
|
"curl": "curl -g \"https://www.example.com/api/storefront/products/nice-shirt?sku=SKU2\" -X GET "
|
48
49
|
}
|
@@ -50,6 +51,6 @@
|
|
50
51
|
"resource": "Products",
|
51
52
|
"description": "Showing a product with a specific SKU selected",
|
52
53
|
"route": "/api/storefront/products/:slug",
|
53
|
-
"
|
54
|
-
"
|
54
|
+
"explanation": "<p>This demonstrates how to get product details for a specific SKU.<br>\nThis will result in pricing, inventory, and images to match the<br>\nstorefront logic for that SKU.</p>\n",
|
55
|
+
"http_method": "GET"
|
55
56
|
}
|