workarea-api 4.4.6 → 4.4.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -15
- data/admin/LICENSE +52 -0
- data/admin/README.md +4 -7
- data/admin/workarea-api-admin.gemspec +5 -4
- data/doc/api/admin/categories/bulk_upserting_categories.json +4 -4
- data/doc/api/admin/categories/creating_a_category.json +7 -7
- data/doc/api/admin/categories/listing_categories.json +4 -4
- data/doc/api/admin/categories/removing_a_category.json +4 -4
- data/doc/api/admin/categories/showing_a_category.json +6 -6
- data/doc/api/admin/categories/updating_a_category.json +5 -5
- data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +7 -7
- data/doc/api/admin/category_product_rules/listing_category_product_rules.json +6 -6
- data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +4 -4
- data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +4 -4
- data/doc/api/admin/content/bulk_upserting_content.json +4 -4
- data/doc/api/admin/content/creating_content.json +7 -7
- data/doc/api/admin/content/listing_content.json +4 -4
- data/doc/api/admin/content/showing_content.json +6 -6
- data/doc/api/admin/content/updating_content.json +4 -4
- data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +4 -4
- data/doc/api/admin/content_assets/creating_a_content_asset.json +7 -7
- data/doc/api/admin/content_assets/listing_content_assets.json +5 -5
- data/doc/api/admin/content_assets/removing_a_content_asset.json +4 -4
- data/doc/api/admin/content_assets/showing_a_content_asset.json +6 -6
- data/doc/api/admin/content_assets/updating_a_content_asset.json +5 -5
- data/doc/api/admin/discounts/creating_a_discount.json +7 -7
- data/doc/api/admin/discounts/listing_discounts.json +4 -4
- data/doc/api/admin/discounts/removing_a_discount.json +4 -4
- data/doc/api/admin/discounts/showing_a_discount.json +6 -6
- data/doc/api/admin/discounts/updating_discounts.json +4 -4
- data/doc/api/admin/email_signups/listing_email_signups.json +4 -4
- data/doc/api/admin/email_signups/showing_an_email_signup.json +6 -6
- data/doc/api/admin/fulfillment/listing_fulfillments.json +4 -4
- data/doc/api/admin/fulfillment/marking_items_as_canceled.json +6 -6
- data/doc/api/admin/fulfillment/marking_items_as_shipped.json +6 -6
- data/doc/api/admin/fulfillment/showing_fulfillment.json +4 -4
- data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +4 -4
- data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +6 -6
- data/doc/api/admin/inventory_skus/listing_inventory_skus.json +4 -4
- data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +2 -2
- data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +4 -4
- data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +2 -2
- data/doc/api/admin/navigation_menus/creating_a_menu.json +7 -7
- data/doc/api/admin/navigation_menus/listing_menus.json +4 -4
- data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +4 -4
- data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +6 -6
- data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +4 -4
- data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +4 -4
- data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +7 -7
- data/doc/api/admin/navigation_taxonomy/listing_taxons.json +4 -4
- data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +4 -4
- data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +6 -6
- data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +4 -4
- data/doc/api/admin/orders/listing_orders.json +4 -4
- data/doc/api/admin/orders/showing_an_order.json +4 -4
- data/doc/api/admin/orders/viewing_orders_by_date_range.json +8 -8
- data/doc/api/admin/pages/bulk_upserting_pages.json +4 -4
- data/doc/api/admin/pages/creating_a_page.json +7 -7
- data/doc/api/admin/pages/listing_pages.json +4 -4
- data/doc/api/admin/pages/removing_a_page.json +4 -4
- data/doc/api/admin/pages/showing_a_page.json +6 -6
- data/doc/api/admin/pages/updating_a_page.json +5 -5
- data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +4 -4
- data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +7 -7
- data/doc/api/admin/payment_profiles/listing_payment_profiles.json +4 -4
- data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +4 -4
- data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +6 -6
- data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +4 -4
- data/doc/api/admin/payment_transactions/listing_payment_transactions.json +4 -4
- data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +6 -6
- data/doc/api/admin/payments/listing_payments.json +4 -4
- data/doc/api/admin/payments/showing_an_payment.json +4 -4
- data/doc/api/admin/prices/creating_a_pricing_sku_price.json +4 -4
- data/doc/api/admin/prices/listing_pricing_sku_prices.json +4 -4
- data/doc/api/admin/prices/removing_a_pricing_sku_price.json +4 -4
- data/doc/api/admin/prices/updating_a_pricing_sku_price.json +4 -4
- data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +4 -4
- data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +6 -6
- data/doc/api/admin/pricing_skus/listing_pricing_skus.json +4 -4
- data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +2 -2
- data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +4 -4
- data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +2 -2
- data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +7 -7
- data/doc/api/admin/product_images/creating_a_product_image_from_url.json +7 -7
- data/doc/api/admin/product_images/listing_product_images.json +6 -6
- data/doc/api/admin/product_images/removing_a_product_image.json +4 -4
- data/doc/api/admin/product_images/updating_a_product_image.json +4 -4
- data/doc/api/admin/products/bulk_upserting_products.json +4 -4
- data/doc/api/admin/products/creating_a_product.json +7 -7
- data/doc/api/admin/products/listing_products.json +4 -4
- data/doc/api/admin/products/removing_a_product.json +4 -4
- data/doc/api/admin/products/showing_a_product.json +6 -6
- data/doc/api/admin/products/updating_a_product.json +5 -5
- data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +4 -4
- data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +7 -7
- data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +4 -4
- data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +4 -4
- data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +6 -6
- data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +4 -4
- data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +6 -6
- data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +4 -4
- data/doc/api/admin/redirects/bulk_upserting_redirects.json +4 -4
- data/doc/api/admin/redirects/creating_a_redirect.json +7 -7
- data/doc/api/admin/redirects/listing_redirects.json +4 -4
- data/doc/api/admin/redirects/removing_a_redirect.json +4 -4
- data/doc/api/admin/redirects/showing_a_redirect.json +6 -6
- data/doc/api/admin/redirects/updating_a_redirects.json +4 -4
- data/doc/api/admin/release_changes/adding_changes_to_a_release.json +7 -7
- data/doc/api/admin/releases/bulk_upserting_releases.json +4 -4
- data/doc/api/admin/releases/creating_a_release.json +7 -7
- data/doc/api/admin/releases/listing_releases.json +4 -4
- data/doc/api/admin/releases/removing_a_release.json +4 -4
- data/doc/api/admin/releases/showing_a_release.json +6 -6
- data/doc/api/admin/releases/updating_a_release.json +5 -5
- data/doc/api/admin/saved_addresses/creating_a_saved_address.json +7 -7
- data/doc/api/admin/saved_addresses/listing_saved_address.json +6 -6
- data/doc/api/admin/saved_addresses/removing_a_saved_address.json +4 -4
- data/doc/api/admin/saved_addresses/updating_a_saved_address.json +4 -4
- data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +8 -8
- data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +6 -6
- data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +4 -4
- data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +4 -4
- data/doc/api/admin/shipping/listing_shipments.json +4 -4
- data/doc/api/admin/shipping/showing_a_shipment.json +6 -6
- data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +7 -7
- data/doc/api/admin/shipping_rates/listing_shipping_rates.json +6 -6
- data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +4 -4
- data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +4 -4
- data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +4 -4
- data/doc/api/admin/shipping_services/creating_a_shipping_service.json +7 -7
- data/doc/api/admin/shipping_services/listing_shipping_services.json +4 -4
- data/doc/api/admin/shipping_services/removing_a_shipping_service.json +4 -4
- data/doc/api/admin/shipping_services/showing_a_shipping_service.json +6 -6
- data/doc/api/admin/shipping_services/updating_a_shipping_service.json +5 -5
- data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +4 -4
- data/doc/api/admin/tax_categories/creating_a_tax_category.json +7 -7
- data/doc/api/admin/tax_categories/listing_tax_categories.json +4 -4
- data/doc/api/admin/tax_categories/removing_a_tax_category.json +4 -4
- data/doc/api/admin/tax_categories/showing_a_tax_category.json +6 -6
- data/doc/api/admin/tax_categories/updating_a_tax_categories.json +4 -4
- data/doc/api/admin/tax_rates/creating_a_tax_rate.json +8 -8
- data/doc/api/admin/tax_rates/listing_tax_rates.json +6 -6
- data/doc/api/admin/tax_rates/removing_a_tax_rate.json +4 -4
- data/doc/api/admin/tax_rates/updating_a_tax_rate.json +4 -4
- data/doc/api/admin/users/bulk_upserting_users.json +4 -4
- data/doc/api/admin/users/creating_a_user.json +7 -7
- data/doc/api/admin/users/listing_users.json +4 -4
- data/doc/api/admin/users/removing_a_user.json +4 -4
- data/doc/api/admin/users/showing_a_user.json +6 -6
- data/doc/api/admin/users/updating_a_user.json +5 -5
- data/doc/api/admin/variants/creating_a_product_variant.json +6 -6
- data/doc/api/admin/variants/listing_product_variants.json +6 -6
- data/doc/api/admin/variants/removing_a_product_variant.json +4 -4
- data/doc/api/admin/variants/updating_a_product_variant.json +4 -4
- data/doc/api/storefront/accounts/creating_an_account.json +6 -6
- data/doc/api/storefront/accounts/getting_account_details.json +6 -6
- data/doc/api/storefront/accounts/updating_an_account.json +6 -6
- data/doc/api/storefront/analytics/saving_a_category_view.json +4 -4
- data/doc/api/storefront/analytics/saving_a_product_view.json +4 -4
- data/doc/api/storefront/analytics/saving_a_search.json +4 -4
- data/doc/api/storefront/assets/showing_an_asset.json +8 -8
- data/doc/api/storefront/authentication/creating_an_authentication_token.json +8 -8
- data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +8 -8
- data/doc/api/storefront/authentication/using_an_authentication_token.json +9 -9
- data/doc/api/storefront/cart/adding_a_promo_code.json +9 -9
- data/doc/api/storefront/cart/adding_an_item.json +9 -9
- data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +8 -8
- data/doc/api/storefront/cart/creating_a_new_guest_cart.json +6 -6
- data/doc/api/storefront/cart/delete_an_item.json +9 -9
- data/doc/api/storefront/cart/listing_user_s_carts.json +8 -8
- data/doc/api/storefront/cart/showing_cart.json +9 -9
- data/doc/api/storefront/cart/updating_an_item.json +9 -9
- data/doc/api/storefront/categories/showing_a_category.json +7 -7
- data/doc/api/storefront/categories/showing_a_listing_of_categories.json +7 -7
- data/doc/api/storefront/checkout/completing_a_checkout.json +8 -8
- data/doc/api/storefront/checkout/showing_a_checkout.json +8 -8
- data/doc/api/storefront/checkout/updating_a_checkout.json +8 -8
- data/doc/api/storefront/contacts/creating_a_contact.json +6 -6
- data/doc/api/storefront/email_signups/creating_an_email_signup.json +6 -6
- data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +6 -6
- data/doc/api/storefront/menus/listing_menus.json +7 -7
- data/doc/api/storefront/menus/showing_a_menu.json +9 -9
- data/doc/api/storefront/orders/listing_the_user_s_orders.json +8 -8
- data/doc/api/storefront/orders/showing_an_order.json +9 -9
- data/doc/api/storefront/pages/showing_a_page.json +7 -7
- data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +6 -6
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +10 -10
- data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +8 -8
- data/doc/api/storefront/products/showing_a_product.json +7 -7
- data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +7 -7
- data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +7 -7
- data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +10 -10
- data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +4 -4
- data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +6 -6
- data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +6 -6
- data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +5 -5
- data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +8 -8
- data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +7 -7
- data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +7 -7
- data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +6 -6
- data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +5 -5
- data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +8 -8
- data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +7 -7
- data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +7 -7
- data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +7 -7
- data/doc/api/storefront/searches/showing_search_results.json +7 -7
- data/doc/api/storefront/system_content/showing_system_content.json +7 -7
- data/doc/api/storefront/system_content/showing_the_home_page.json +7 -7
- data/doc/api/storefront/taxons/showing_a_taxon.json +9 -9
- data/doc/api/storefront/validation_errors/checkout_validation_errors.json +8 -8
- data/doc/api/storefront/validation_errors/general_validation_errors.json +4 -4
- data/lib/workarea/api/version.rb +1 -1
- data/storefront/LICENSE +52 -0
- data/storefront/README.md +4 -7
- data/storefront/workarea-api-storefront.gemspec +6 -5
- data/workarea-api.gemspec +3 -3
- metadata +13 -10
@@ -24,10 +24,10 @@
|
|
24
24
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
25
25
|
"X-Requested-With": "",
|
26
26
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
27
|
-
"ETag": "W/\"
|
27
|
+
"ETag": "W/\"0751e079ab614d2b7c3d88d04ee2dfc7\"",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"X-Request-Id": "
|
30
|
-
"X-Runtime": "0.
|
29
|
+
"X-Request-Id": "f49c7cf8-b415-46c3-a61c-62745596c4c5",
|
30
|
+
"X-Runtime": "0.008116",
|
31
31
|
"Expires": "0",
|
32
32
|
"Content-Length": "900"
|
33
33
|
},
|
@@ -37,7 +37,7 @@
|
|
37
37
|
"request_content_type": null,
|
38
38
|
"response_status": 200,
|
39
39
|
"response_status_text": "OK",
|
40
|
-
"response_body": "{\n \"title\": \"Sign up for our email list\",\n \"content_blocks\": [\n {\n \"id\": \"
|
40
|
+
"response_body": "{\n \"title\": \"Sign up for our email list\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ecba1d4322a04dfbf7be6\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Here is some administrated content\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ecba1d4322a04dfbf7be6\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecba1d4322a04dfbf7be6","type":"text","position":0,"data":{"text":"Here is some administrated content"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Here is some administrated content</div>\\n</div>\\n\"\n }\n ]\n}",
|
41
41
|
"response_content_type": "application/json",
|
42
42
|
"curl": "curl -g \"https://www.example.com/api/storefront/email_signups\" -X GET "
|
43
43
|
}
|
@@ -45,6 +45,6 @@
|
|
45
45
|
"resource": "Email Signups",
|
46
46
|
"description": "Showing an email signup content",
|
47
47
|
"route": "/api/storefront/email_signups",
|
48
|
-
"
|
49
|
-
"
|
48
|
+
"http_method": "GET",
|
49
|
+
"explanation": " This endpoint will return all relevant data for showing an email\n sign up form.\n"
|
50
50
|
}
|
@@ -18,7 +18,7 @@
|
|
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": "Thu, 22 Aug 2019 17:05:54 GMT",
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
@@ -26,9 +26,9 @@
|
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"ETag": "W/\"
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
29
|
+
"ETag": "W/\"f8b24944549a7e57fed303f1e78e281b\"",
|
30
|
+
"X-Request-Id": "248ec2df-3abf-42ba-9a80-00f66c0be4f5",
|
31
|
+
"X-Runtime": "0.029158",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "5185"
|
34
34
|
},
|
@@ -38,7 +38,7 @@
|
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"menus\": [\n {\n \"id\": \"
|
41
|
+
"response_body": "{\n \"menus\": [\n {\n \"id\": \"5d5ecb72d4322a04dfbf7910\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5d5ecb72d4322a04dfbf7910\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ecb72d4322a04dfbf7912\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5ecb72d4322a04dfbf790e\",\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_5d5ecb72d4322a04dfbf7912\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecb72d4322a04dfbf7912","type":"taxonomy","position":0,"data":{"start":"5d5ecb72d4322a04dfbf790e","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\": \"5d5ecb72d4322a04dfbf7916\",\n \"name\": \"Women\",\n \"position\": 1,\n \"url\": \"/api/storefront/menus/5d5ecb72d4322a04dfbf7916\",\n \"taxon_url\": \"http://example.com/women\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ecb72d4322a04dfbf7918\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5ecb72d4322a04dfbf7914\",\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_5d5ecb72d4322a04dfbf7918\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecb72d4322a04dfbf7918","type":"taxonomy","position":0,"data":{"start":"5d5ecb72d4322a04dfbf7914","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\": \"5d5ecb72d4322a04dfbf791c\",\n \"name\": \"Children\",\n \"position\": 2,\n \"url\": \"/api/storefront/menus/5d5ecb72d4322a04dfbf791c\",\n \"taxon_url\": \"http://example.com/children\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ecb72d4322a04dfbf791e\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5ecb72d4322a04dfbf791a\",\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_5d5ecb72d4322a04dfbf791e\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecb72d4322a04dfbf791e","type":"taxonomy","position":0,"data":{"start":"5d5ecb72d4322a04dfbf791a","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
42
|
"response_content_type": "application/json",
|
43
43
|
"curl": "curl -g \"https://www.example.com/api/storefront/menus\" -X GET "
|
44
44
|
}
|
@@ -46,6 +46,6 @@
|
|
46
46
|
"resource": "Menus",
|
47
47
|
"description": "Listing menus",
|
48
48
|
"route": "/api/storefront/menus",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " In the base HTML storefront, menus are used as the primary top-level\n navigation entry points. Each menu has associated content (composed\n of content blocks) that represent the navigation to be display when\n that menu is selected (usually a hover or a click on a mobile\n device). Each menu points at a particular spot in the taxonomy.\n"
|
51
51
|
}
|
@@ -18,7 +18,7 @@
|
|
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": "Thu, 22 Aug 2019 17:05:55 GMT",
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
@@ -26,26 +26,26 @@
|
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"ETag": "W/\"
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
29
|
+
"ETag": "W/\"22005042de552256e0f095a6331dc504\"",
|
30
|
+
"X-Request-Id": "c1ff732e-f004-43e2-9f82-d2c44f16147d",
|
31
|
+
"X-Runtime": "0.012242",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "1719"
|
34
34
|
},
|
35
35
|
"request_method": "GET",
|
36
|
-
"request_path": "/api/storefront/menus/
|
36
|
+
"request_path": "/api/storefront/menus/5d5ecb72d4322a04dfbf7924",
|
37
37
|
"request_body": null,
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"id\": \"
|
41
|
+
"response_body": "{\n \"id\": \"5d5ecb72d4322a04dfbf7924\",\n \"name\": \"Men\",\n \"position\": 0,\n \"url\": \"/api/storefront/menus/5d5ecb72d4322a04dfbf7924\",\n \"taxon_url\": \"http://example.com/men\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ecb73d4322a04dfbf7926\",\n \"type\": \"taxonomy\",\n \"area\": \"default\",\n \"data\": {\n \"start\": \"5d5ecb72d4322a04dfbf7922\",\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_5d5ecb73d4322a04dfbf7926\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecb73d4322a04dfbf7926","type":"taxonomy","position":0,"data":{"start":"5d5ecb72d4322a04dfbf7922","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
42
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/menus/
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/menus/5d5ecb72d4322a04dfbf7924\" -X GET "
|
44
44
|
}
|
45
45
|
],
|
46
46
|
"resource": "Menus",
|
47
47
|
"description": "Showing a menu",
|
48
48
|
"route": "/api/storefront/menus/:id",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " This endpoint will return all the data used to render a menu. This\n includes the corresponding content, as well a link to where the\n menu points at in the taxonomy.\n"
|
51
51
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"TnDbsa82x3uqvSYyaUSvD2WK\""
|
12
12
|
},
|
13
13
|
"request_query_parameters": {
|
14
14
|
},
|
@@ -25,10 +25,10 @@
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
|
-
"ETag": "W/\"
|
28
|
+
"ETag": "W/\"1c1fa13b4b36c2d781193f4128389d46\"",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "6743953a-fc8b-480c-a505-775aafe89030",
|
31
|
+
"X-Runtime": "0.031020",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "6389"
|
34
34
|
},
|
@@ -38,14 +38,14 @@
|
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"user_id\": \"5d5dbce1d4322a4b69d78a50\",\n \"orders\": [\n {\n \"id\": \"5FD19B695B\",\n \"url\": \"http://www.example.com/api/storefront/orders/5FD19B695B\",\n \"user_id\": \"5d5dbce1d4322a4b69d78a50\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2019-08-21T21:51:31.859Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5dbce2d4322a4b69d78a5a\",\n \"product_id\": \"EC647996A2\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 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\": \"5d5dbce2d4322a4b69d78a57\",\n \"product_id\": \"12DF7369C8\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 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\": \"5d5dbce2d4322a4b69d78a54\",\n \"product_id\": \"1AFBE84648\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 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\": \"5d5dbce2d4322a4b69d78a5e\",\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\": \"5d5dbce2d4322a4b69d78a72\",\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}",
|
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
42
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/orders\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/orders\" -X GET \\\n\t-H \"Authorization: Token token=\\\"TnDbsa82x3uqvSYyaUSvD2WK\\\"\""
|
44
44
|
}
|
45
45
|
],
|
46
46
|
"resource": "Orders",
|
47
47
|
"description": "Listing the user's orders",
|
48
48
|
"route": "/api/storefront/orders",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " This endpoints returns recently placed orders for a customer. Use it\n for showing an order history for the customer.\n"
|
51
51
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"PnZACtJRzYbDGwK7V7uRWodR\""
|
12
12
|
},
|
13
13
|
"request_query_parameters": {
|
14
14
|
},
|
@@ -25,27 +25,27 @@
|
|
25
25
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
|
-
"ETag": "W/\"
|
28
|
+
"ETag": "W/\"fcf8203e645f5755c544fbff66f1d2da\"",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "9b156d0e-4c31-4202-a688-20534a8eded0",
|
31
|
+
"X-Runtime": "0.039844",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "11595"
|
34
34
|
},
|
35
35
|
"request_method": "GET",
|
36
|
-
"request_path": "/api/storefront/orders/
|
36
|
+
"request_path": "/api/storefront/orders/D4AAC8264B",
|
37
37
|
"request_body": null,
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"order\": {\n \"id\": \"4B5A26891C\",\n \"url\": \"http://www.example.com/api/storefront/orders/4B5A26891C\",\n \"user_id\": \"5d5dbcded4322a4b69d789f6\",\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": \"2019-08-21T21:51:28.274Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5dbcded4322a4b69d78a00\",\n \"product_id\": \"FE98C1877E\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 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\": \"5d5dbcded4322a4b69d789fd\",\n \"product_id\": \"34615B56C8\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 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\": \"5d5dbcded4322a4b69d789fa\",\n \"product_id\": \"BFAF72E85F\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 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\": \"5d5dbcded4322a4b69d78a04\",\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\": \"5d5dbcdfd4322a4b69d78a18\",\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\": \"5d5dbcded4322a4b69d789fa\",\n \"product_id\": \"BFAF72E85F\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ]\n }\n ],\n \"pending_items\": [\n {\n \"id\": \"5d5dbcded4322a4b69d78a00\",\n \"product_id\": \"FE98C1877E\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 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\": \"5d5dbcded4322a4b69d789fd\",\n \"product_id\": \"34615B56C8\",\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=1566424156\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566424156\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566424156\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566424156\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566424156\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566424156\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 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}",
|
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
42
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/orders/
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/orders/D4AAC8264B\" -X GET \\\n\t-H \"Authorization: Token token=\\\"PnZACtJRzYbDGwK7V7uRWodR\\\"\""
|
44
44
|
}
|
45
45
|
],
|
46
46
|
"resource": "Orders",
|
47
47
|
"description": "Showing an order",
|
48
48
|
"route": "/api/storefront/orders/:id",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " This endpoint returns everything needed to render an order for a\n customer's order history including order details and fulfillment\n status.\n"
|
51
51
|
}
|
@@ -18,7 +18,7 @@
|
|
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": "Thu, 22 Aug 2019 17:02:06 GMT",
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
@@ -26,9 +26,9 @@
|
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"ETag": "W/\"
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
29
|
+
"ETag": "W/\"7e110e3342a1851e1c24165f0173b96b\"",
|
30
|
+
"X-Request-Id": "4acb4a28-61e9-4211-b68b-986aa060f9e6",
|
31
|
+
"X-Runtime": "0.019056",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "3949"
|
34
34
|
},
|
@@ -38,7 +38,7 @@
|
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"id\": \"
|
41
|
+
"response_body": "{\n \"id\": \"5d5eca8dd4322a04dfbf6f17\",\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\": \"5d5eca8ed4322a04dfbf6f1a\",\n \"url\": \"/api/storefront/taxons/5d5eca8ed4322a04dfbf6f1a\",\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\": \"5d5eca8ed4322a04dfbf6f19\",\n \"url\": \"/api/storefront/taxons/5d5eca8ed4322a04dfbf6f19\",\n \"name\": \"Women\",\n \"depth\": 1,\n \"navigable_url\": \"www.example.com/women\",\n \"parent_id\": \"5d5eca8ed4322a04dfbf6f1a\",\n \"parent_ids\": [\n \"5d5eca8ed4322a04dfbf6f1a\"\n ],\n \"position\": 0\n },\n {\n \"id\": \"5d5eca8ed4322a04dfbf6f1b\",\n \"url\": \"/api/storefront/taxons/5d5eca8ed4322a04dfbf6f1b\",\n \"name\": \"Summer Lookbook\",\n \"depth\": 2,\n \"navigable_url\": \"http://www.example.com/api/storefront/pages/summer-lookbook\",\n \"parent_id\": \"5d5eca8ed4322a04dfbf6f19\",\n \"parent_ids\": [\n \"5d5eca8ed4322a04dfbf6f1a\",\n \"5d5eca8ed4322a04dfbf6f19\"\n ],\n \"position\": 0\n }\n ],\n \"content_blocks\": [\n {\n \"id\": \"5d5eca8ed4322a04dfbf6f1c\",\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_5d5eca8ed4322a04dfbf6f1c\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5eca8ed4322a04dfbf6f1c","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\": \"5d5eca8ed4322a04dfbf6f1e\",\n \"type\": \"image\",\n \"area\": \"default\",\n \"data\": {\n \"image\": \"5d5eca8ed4322a04dfbf6f1d\",\n \"alt\": \"splash\",\n \"link\": \"\",\n \"align\": \"\",\n \"image_url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMDgvMjIvNXZuMG15bndyeV9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=02aee72d760d6f64\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--image\\\" id=\\\"content_block_5d5eca8ed4322a04dfbf6f1e\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5eca8ed4322a04dfbf6f1e","type":"image","position":1,"data":{"image":"5d5eca8ed4322a04dfbf6f1d","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/W1siZiIsIjIwMTkvMDgvMjIvNXZuMG15bndyeV9maWxlLmpwZyJdXQ/file.jpg?sha=2a023818886e6007\\\" />\\n</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5eca8ed4322a04dfbf6f1f\",\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_5d5eca8ed4322a04dfbf6f1f\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5eca8ed4322a04dfbf6f1f","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
42
|
"response_content_type": "application/json",
|
43
43
|
"curl": "curl -g \"https://www.example.com/api/storefront/pages/summer-lookbook\" -X GET "
|
44
44
|
}
|
@@ -46,6 +46,6 @@
|
|
46
46
|
"resource": "Pages",
|
47
47
|
"description": "Showing a page",
|
48
48
|
"route": "/api/storefront/pages/:slug",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " This endpoint will return all relevant data for showing a content\n page.\n"
|
51
51
|
}
|
@@ -26,25 +26,25 @@
|
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"X-Request-Id": "
|
30
|
-
"X-Runtime": "0.
|
29
|
+
"X-Request-Id": "80277dc9-6358-4550-8574-099976eb8f90",
|
30
|
+
"X-Runtime": "0.061114",
|
31
31
|
"Expires": "0",
|
32
32
|
"Content-Length": "0"
|
33
33
|
},
|
34
34
|
"request_method": "POST",
|
35
35
|
"request_path": "/api/storefront/password_resets",
|
36
|
-
"request_body": "{\"email\":\"
|
36
|
+
"request_body": "{\"email\":\"user60@workarea.com\"}",
|
37
37
|
"request_content_type": "application/json",
|
38
38
|
"response_status": 200,
|
39
39
|
"response_status_text": "OK",
|
40
40
|
"response_body": null,
|
41
41
|
"response_content_type": "application/json",
|
42
|
-
"curl": "curl \"https://www.example.com/api/storefront/password_resets\" -d '{\"email\":\"
|
42
|
+
"curl": "curl \"https://www.example.com/api/storefront/password_resets\" -d '{\"email\":\"user60@workarea.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
43
43
|
}
|
44
44
|
],
|
45
45
|
"resource": "Password Resets",
|
46
46
|
"description": "Sending a forgot password email",
|
47
47
|
"route": "/api/storefront/password_resets",
|
48
|
-
"
|
49
|
-
"
|
48
|
+
"http_method": "POST",
|
49
|
+
"explanation": " This will send a password reset email to the email address if there\n is an account. The email will contain a link to the site where the\n password reset can be completed.\n"
|
50
50
|
}
|
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": "5d5eca09d4322a04dfbf687b"
|
17
17
|
},
|
18
18
|
"response_headers": {
|
19
19
|
"X-Frame-Options": "SAMEORIGIN",
|
@@ -22,8 +22,8 @@
|
|
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/\"
|
26
|
-
"Last-Modified": "
|
25
|
+
"ETag": "W/\"b17fa2c1de87116193d97597566aea88\"",
|
26
|
+
"Last-Modified": "Thu, 22 Aug 2019 16:59:53 GMT",
|
27
27
|
"Content-Type": "application/json; charset=utf-8",
|
28
28
|
"Access-Control-Allow-Origin": "*",
|
29
29
|
"Access-Control-Allow-Headers": "*",
|
@@ -31,25 +31,25 @@
|
|
31
31
|
"X-Requested-With": "",
|
32
32
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
33
33
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
34
|
-
"X-Request-Id": "
|
35
|
-
"X-Runtime": "0.
|
34
|
+
"X-Request-Id": "4eebe26a-97fa-471b-83e6-4ebf87e691f9",
|
35
|
+
"X-Runtime": "0.042182",
|
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=5d5eca09d4322a04dfbf687b",
|
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\": \"B810D24E9C\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-4\",\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\": \"5d5eca04d4322a04dfbf686f\",\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\": \"B9D3B3470F\",\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\": \"5d5eca06d4322a04dfbf6875\",\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\": \"957BEF7F36\",\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\": \"5d5eca03d4322a04dfbf6867\",\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\": \"C7E3E3FE7E\",\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\": \"5d5eca08d4322a04dfbf6877\",\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\": \"1979ED0CA9\",\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\": \"5d5eca03d4322a04dfbf686b\",\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\": \"CC021095F8\",\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\": \"5d5eca05d4322a04dfbf6871\",\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=5d5eca09d4322a04dfbf687b\" -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
|
+
"http_method": "GET",
|
54
|
+
"explanation": " Display personalized recommendations based on a session ID that\n you've maintained for an anonymous browser (as opposed to\n authentication).\n"
|
55
55
|
}
|
@@ -8,7 +8,7 @@
|
|
8
8
|
"requests": [
|
9
9
|
{
|
10
10
|
"request_headers": {
|
11
|
-
"Authorization": "Token token=\"
|
11
|
+
"Authorization": "Token token=\"yTP2L1gFkt2RPQJUPvk2KAc4\""
|
12
12
|
},
|
13
13
|
"request_query_parameters": {
|
14
14
|
},
|
@@ -27,10 +27,10 @@
|
|
27
27
|
"X-Requested-With": "",
|
28
28
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
30
|
+
"X-Request-Id": "60ac78c4-8629-43e5-ad77-82d17571f6a1",
|
31
|
+
"X-Runtime": "0.039595",
|
32
32
|
"Expires": "0",
|
33
|
-
"Content-Length": "
|
33
|
+
"Content-Length": "3884"
|
34
34
|
},
|
35
35
|
"request_method": "GET",
|
36
36
|
"request_path": "/api/storefront/recommendations",
|
@@ -38,14 +38,14 @@
|
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"products\": [\n {\n \"id\": \"
|
41
|
+
"response_body": "{\n \"products\": [\n {\n \"id\": \"DC94930440\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-4\",\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\": \"5d5eca0cd4322a04dfbf6889\",\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\": \"7BFC9B113A\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-6\",\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\": \"5d5eca0dd4322a04dfbf688d\",\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\": \"F884685EFD\",\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\": \"5d5eca0cd4322a04dfbf688b\",\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\": \"D4A7F60DF6\",\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\": \"5d5eca0bd4322a04dfbf6887\",\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\": \"5C52DF4713\",\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\": \"5d5eca0bd4322a04dfbf6885\",\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\": \"27597450A4\",\n \"name\": \"Test Product\",\n \"description\": null,\n \"slug\": \"test-product-1\",\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\": \"5d5eca0ad4322a04dfbf6883\",\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
42
|
"response_content_type": "application/json",
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/recommendations\" -X GET \\\n\t-H \"Authorization: Token token=\\\"yTP2L1gFkt2RPQJUPvk2KAc4\\\"\""
|
44
44
|
}
|
45
45
|
],
|
46
46
|
"resource": "Personalized Recommendations",
|
47
47
|
"description": "Showing recommendations with authentication",
|
48
48
|
"route": "/api/storefront/recommendations",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " Display personalized recommendations based on the currently\n authenticated customer.\n"
|
51
51
|
}
|
@@ -18,7 +18,7 @@
|
|
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": "Thu, 22 Aug 2019 17:03:43 GMT",
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
@@ -26,9 +26,9 @@
|
|
26
26
|
"X-Requested-With": "",
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
29
|
-
"ETag": "W/\"
|
30
|
-
"X-Request-Id": "
|
31
|
-
"X-Runtime": "0.
|
29
|
+
"ETag": "W/\"47c8c7776b2c7b88064610d75898e32c\"",
|
30
|
+
"X-Request-Id": "206b0d67-c071-4f6b-a112-5dd280fa5289",
|
31
|
+
"X-Runtime": "0.061283",
|
32
32
|
"Expires": "0",
|
33
33
|
"Content-Length": "4103"
|
34
34
|
},
|
@@ -38,7 +38,7 @@
|
|
38
38
|
"request_content_type": null,
|
39
39
|
"response_status": 200,
|
40
40
|
"response_status_text": "OK",
|
41
|
-
"response_body": "{\n \"product\": {\n \"id\": \"
|
41
|
+
"response_body": "{\n \"product\": {\n \"id\": \"97DF0460C8\",\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\": \"5d5ecaefd4322a04dfbf72be\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n },\n {\n \"id\": \"5d5ecaefd4322a04dfbf72bf\",\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\": \"5d5ecaefd4322a04dfbf72c0\",\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/5d5ecaefd4322a04dfbf72c0/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaefd4322a04dfbf72c0/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n \"recommendations\": [\n {\n \"id\": \"1C95B635B9\",\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\": \"5d5ecaefd4322a04dfbf72c2\",\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\": \"5d5ecaefd4322a04dfbf72c3\",\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/5d5ecaefd4322a04dfbf72c3/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaefd4322a04dfbf72c3/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
42
42
|
"response_content_type": "application/json",
|
43
43
|
"curl": "curl -g \"https://www.example.com/api/storefront/products/nice-shirt\" -X GET "
|
44
44
|
}
|
@@ -46,6 +46,6 @@
|
|
46
46
|
"resource": "Products",
|
47
47
|
"description": "Showing a product",
|
48
48
|
"route": "/api/storefront/products/:slug",
|
49
|
-
"
|
50
|
-
"
|
49
|
+
"http_method": "GET",
|
50
|
+
"explanation": " This endpoint includes everything you need to render a product\n detail page including, variants, images, and recommendations.\n"
|
51
51
|
}
|
@@ -22,7 +22,7 @@
|
|
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": "Thu, 22 Aug 2019 17:03:44 GMT",
|
26
26
|
"Content-Type": "application/json; charset=utf-8",
|
27
27
|
"Access-Control-Allow-Origin": "*",
|
28
28
|
"Access-Control-Allow-Headers": "*",
|
@@ -30,9 +30,9 @@
|
|
30
30
|
"X-Requested-With": "",
|
31
31
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
32
32
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
33
|
-
"ETag": "W/\"
|
34
|
-
"X-Request-Id": "
|
35
|
-
"X-Runtime": "0.
|
33
|
+
"ETag": "W/\"11bbcdf082f64936d3b07167a0a22ed7\"",
|
34
|
+
"X-Request-Id": "e42bc38b-978c-4c38-a8f1-363e66d6fd47",
|
35
|
+
"X-Runtime": "0.047052",
|
36
36
|
"Expires": "0",
|
37
37
|
"Content-Length": "4111"
|
38
38
|
},
|
@@ -42,7 +42,7 @@
|
|
42
42
|
"request_content_type": null,
|
43
43
|
"response_status": 200,
|
44
44
|
"response_status_text": "OK",
|
45
|
-
"response_body": "{\n \"product\": {\n \"id\": \"
|
45
|
+
"response_body": "{\n \"product\": {\n \"id\": \"E1A6E827EC\",\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\": \"5d5ecaf0d4322a04dfbf72c7\",\n \"name\": \"SKU1\",\n \"sku\": \"SKU1\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n },\n {\n \"id\": \"5d5ecaf0d4322a04dfbf72c8\",\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\": \"5d5ecaf0d4322a04dfbf72c9\",\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/5d5ecaf0d4322a04dfbf72c9/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/nice-shirt/Blue/5d5ecaf0d4322a04dfbf72c9/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n \"recommendations\": [\n {\n \"id\": \"2CB4895464\",\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\": \"5d5ecaf0d4322a04dfbf72cb\",\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\": \"5d5ecaf0d4322a04dfbf72cc\",\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/5d5ecaf0d4322a04dfbf72cc/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/fall-jacket/Blue/5d5ecaf0d4322a04dfbf72cc/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
46
46
|
"response_content_type": "application/json",
|
47
47
|
"curl": "curl -g \"https://www.example.com/api/storefront/products/nice-shirt?sku=SKU2\" -X GET "
|
48
48
|
}
|
@@ -50,6 +50,6 @@
|
|
50
50
|
"resource": "Products",
|
51
51
|
"description": "Showing a product with a specific SKU selected",
|
52
52
|
"route": "/api/storefront/products/:slug",
|
53
|
-
"
|
54
|
-
"
|
53
|
+
"http_method": "GET",
|
54
|
+
"explanation": " This demonstrates how to get product details for a specific SKU.\n This will result in pricing, inventory, and images to match the\n storefront logic for that SKU.\n"
|
55
55
|
}
|