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
|
@@ -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/\"a47c683a0a41cc3b8de2dda64404f553\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "52e3d358-78ad-48b9-b1ee-a340a014e609",
|
|
31
|
+
"X-Runtime": "0.015314",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "522"
|
|
34
34
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"request_content_type": "application/x-www-form-urlencoded",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"id\": \"08E34C003B\",\n \"url\": \"http://www.example.com/api/storefront/orders/08E34C003B\",\n \"user_id\": null,\n \"email\": null,\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": false,\n \"items\": [\n\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl \"https://www.example.com/api/storefront/carts\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\""
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "Cart",
|
|
47
47
|
"description": "Creating a new guest cart",
|
|
48
48
|
"route": "/api/storefront/carts",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " Use this endpoint to create a cart. This allows the possibility of\n multiple carts for a user.\n"
|
|
51
51
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/x-www-form-urlencoded",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"4rpLsZrnP7ckZABRgAtSLPh5\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -26,27 +26,27 @@
|
|
|
26
26
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
27
|
"X-Requested-With": "",
|
|
28
28
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
29
|
-
"ETag": "W/\"
|
|
29
|
+
"ETag": "W/\"b9b9bbd05d85d21a031ade80e2e8f7e8\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "172ca661-9a58-40f6-b634-54cdc1cb61b7",
|
|
32
|
+
"X-Runtime": "0.026547",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "572"
|
|
35
35
|
},
|
|
36
36
|
"request_method": "DELETE",
|
|
37
|
-
"request_path": "/api/storefront/carts/
|
|
37
|
+
"request_path": "/api/storefront/carts/85BAD11EE5/items/5d5eca75d4322a04dfbf6dbf",
|
|
38
38
|
"request_body": null,
|
|
39
39
|
"request_content_type": "application/x-www-form-urlencoded",
|
|
40
40
|
"response_status": 200,
|
|
41
41
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"order\": {\n \"id\": \"85BAD11EE5\",\n \"url\": \"http://www.example.com/api/storefront/orders/85BAD11EE5\",\n \"user_id\": \"5d5eca75d4322a04dfbf6db8\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": false,\n \"items\": [\n\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/carts/
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/carts/85BAD11EE5/items/5d5eca75d4322a04dfbf6dbf\" -d '' -X DELETE \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"4rpLsZrnP7ckZABRgAtSLPh5\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Cart",
|
|
48
48
|
"description": "Delete an item",
|
|
49
49
|
"route": "/api/storefront/carts/:cart_id/items/:id",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "DELETE",
|
|
51
|
+
"explanation": " Removes an item in the cart. Use the create a cart endpoint to get a\n cart ID to use with this endpoint, and use the adding an item\n endpoint to get an ID for an item.\n"
|
|
52
52
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"requests": [
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
|
-
"Authorization": "Token token=\"
|
|
11
|
+
"Authorization": "Token token=\"CrZw9QpmAQMXQ1U4jZJbtFLj\""
|
|
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/\"8cbf808663c8bc1d8081557b518d7611\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "85543ea5-5e2e-4c9e-bec5-df72a8a707f1",
|
|
31
|
+
"X-Runtime": "0.017978",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "2286"
|
|
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\": \"
|
|
41
|
+
"response_body": "{\n \"user_id\": \"5d5eca16d4322a04dfbf68f1\",\n \"orders\": [\n {\n \"id\": \"BD2043E4EA\",\n \"url\": \"http://www.example.com/api/storefront/orders/BD2043E4EA\",\n \"user_id\": \"5d5eca16d4322a04dfbf68f1\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca17d4322a04dfbf68f8\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/carts\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/carts\" -X GET \\\n\t-H \"Authorization: Token token=\\\"CrZw9QpmAQMXQ1U4jZJbtFLj\\\"\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Cart",
|
|
47
47
|
"description": "Listing user's carts",
|
|
48
48
|
"route": "/api/storefront/carts",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " You can get a listing of all of a user's open carts with this\n endpoint. There will usually be one from the standard storefront,\n but with the cart creation endpoint there is the potential to create\n and manage multiple carts for a single user.\n"
|
|
51
51
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"requests": [
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
|
-
"Authorization": "Token token=\"
|
|
11
|
+
"Authorization": "Token token=\"yT5qs3JEZPE5pyrjTmmhQVFi\""
|
|
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/\"65bc42b29610c38471d15b186265ab6b\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "44c1fe63-9fc2-4f6a-858c-9938db45abfb",
|
|
31
|
+
"X-Runtime": "0.054564",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "2236"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "GET",
|
|
36
|
-
"request_path": "/api/storefront/carts/
|
|
36
|
+
"request_path": "/api/storefront/carts/5B6B7D9ACD",
|
|
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\": \"5B6B7D9ACD\",\n \"url\": \"http://www.example.com/api/storefront/orders/5B6B7D9ACD\",\n \"user_id\": \"5d5eca1bd4322a04dfbf6934\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca1cd4322a04dfbf693b\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/carts/
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/carts/5B6B7D9ACD\" -X GET \\\n\t-H \"Authorization: Token token=\\\"yT5qs3JEZPE5pyrjTmmhQVFi\\\"\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Cart",
|
|
47
47
|
"description": "Showing cart",
|
|
48
48
|
"route": "/api/storefront/carts/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " This will get details on a cart you've created with the cart\n creation endpoint.\n"
|
|
51
51
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"SpvNBmdFv6pcGWnzaiAuxTy2\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -26,27 +26,27 @@
|
|
|
26
26
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
27
27
|
"X-Requested-With": "",
|
|
28
28
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
29
|
-
"ETag": "W/\"
|
|
29
|
+
"ETag": "W/\"4f53e8d5352a454946f0b160b9506ed9\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "8879497f-06c9-4a75-8b6f-1654096f8fd1",
|
|
32
|
+
"X-Runtime": "0.081303",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "3920"
|
|
35
35
|
},
|
|
36
36
|
"request_method": "PATCH",
|
|
37
|
-
"request_path": "/api/storefront/carts/
|
|
37
|
+
"request_path": "/api/storefront/carts/FB9FFBB14A/items/5d5eca77d4322a04dfbf6ddd",
|
|
38
38
|
"request_body": "{\"sku\":\"VT002\",\"quantity\":3}",
|
|
39
39
|
"request_content_type": "application/json",
|
|
40
40
|
"response_status": 200,
|
|
41
41
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"item\": {\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"item\": {\n \"id\": \"5d5eca77d4322a04dfbf6ddd\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT002\",\n \"quantity\": 3,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT002\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n },\n \"order\": {\n \"id\": \"FB9FFBB14A\",\n \"url\": \"http://www.example.com/api/storefront/orders/FB9FFBB14A\",\n \"user_id\": \"5d5eca77d4322a04dfbf6dd6\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca77d4322a04dfbf6ddd\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT002\",\n \"quantity\": 3,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT002\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 600.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1800.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n }\n}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/carts/
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/carts/FB9FFBB14A/items/5d5eca77d4322a04dfbf6ddd\" -d '{\"sku\":\"VT002\",\"quantity\":3}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"SpvNBmdFv6pcGWnzaiAuxTy2\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Cart",
|
|
48
48
|
"description": "Updating an item",
|
|
49
49
|
"route": "/api/storefront/carts/:cart_id/items/:id",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "PATCH",
|
|
51
|
+
"explanation": " Updates an item in the cart. Use the create a cart endpoint to get a\n cart ID to use with this endpoint, and use the adding an item\n endpoint to get an ID for an item.\n"
|
|
52
52
|
}
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
"X-Download-Options": "noopen",
|
|
32
32
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
33
33
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
34
|
-
"Date": "
|
|
34
|
+
"Date": "Thu, 22 Aug 2019 17:03:14 GMT",
|
|
35
35
|
"Content-Type": "application/json; charset=utf-8",
|
|
36
36
|
"Access-Control-Allow-Origin": "*",
|
|
37
37
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -39,9 +39,9 @@
|
|
|
39
39
|
"X-Requested-With": "",
|
|
40
40
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
41
41
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
42
|
-
"ETag": "W/\"
|
|
43
|
-
"X-Request-Id": "
|
|
44
|
-
"X-Runtime": "0.
|
|
42
|
+
"ETag": "W/\"d77464fb879e2e6511c1f89966f35dfb\"",
|
|
43
|
+
"X-Request-Id": "0a68049d-aba8-429b-9af0-20b6b51247b1",
|
|
44
|
+
"X-Runtime": "0.032425",
|
|
45
45
|
"Expires": "0",
|
|
46
46
|
"Content-Length": "5026"
|
|
47
47
|
},
|
|
@@ -51,7 +51,7 @@
|
|
|
51
51
|
"request_content_type": null,
|
|
52
52
|
"response_status": 200,
|
|
53
53
|
"response_status_text": "OK",
|
|
54
|
-
"response_body": "{\n \"id\": \"
|
|
54
|
+
"response_body": "{\n \"id\": \"5d5ecad2d4322a04dfbf7137\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"browser_title\": \"Home - Mens - Shirts\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"sorts\": [\n [\n \"Featured\",\n \"featured\"\n ],\n [\n \"Top Sellers\",\n \"top_sellers\"\n ],\n [\n \"Most Popular\",\n \"popularity\"\n ],\n [\n \"Newest\",\n \"newest\"\n ],\n [\n \"Price, Low to High\",\n \"price_asc\"\n ],\n [\n \"Price, High to Low\",\n \"price_desc\"\n ]\n ],\n \"sort\": \"price_desc\",\n \"breadcrumbs\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf713b\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713b\",\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\": \"5d5ecad2d4322a04dfbf713a\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713a\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": null,\n \"parent_id\": \"5d5ecad2d4322a04dfbf713b\",\n \"parent_ids\": [\n \"5d5ecad2d4322a04dfbf713b\"\n ],\n \"position\": 0\n },\n {\n \"id\": \"5d5ecad2d4322a04dfbf713c\",\n \"url\": \"/api/storefront/taxons/5d5ecad2d4322a04dfbf713c\",\n \"name\": \"Shirts\",\n \"depth\": 2,\n \"navigable_url\": \"http://www.example.com/api/storefront/categories/shirts\",\n \"parent_id\": \"5d5ecad2d4322a04dfbf713a\",\n \"parent_ids\": [\n \"5d5ecad2d4322a04dfbf713b\",\n \"5d5ecad2d4322a04dfbf713a\"\n ],\n \"position\": 0\n }\n ],\n \"content_blocks\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf713d\",\n \"type\": \"text\",\n \"area\": \"above_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ecad2d4322a04dfbf713d\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecad2d4322a04dfbf713d","type":"text","position":0,"data":{"text":"text"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5ecad2d4322a04dfbf713e\",\n \"type\": \"text\",\n \"area\": \"below_results\",\n \"data\": {\n \"text\": \"text\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ecad2d4322a04dfbf713e\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ecad2d4322a04dfbf713e","type":"text","position":0,"data":{"text":"text"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>text</div>\\n</div>\\n\"\n }\n ],\n \"first_page\": true,\n \"second_page\": false,\n \"last_page\": true,\n \"page\": 1,\n \"next_page\": null,\n \"prev_page\": null,\n \"per_page\": 20,\n \"total_results\": 1,\n \"total_pages\": 1,\n \"facets\": [\n {\n \"type\": \"terms\",\n \"name\": \"Size\",\n \"display_name\": \"Size\",\n \"results\": [\n {\n \"name\": \"Small\",\n \"count\": 1\n },\n {\n \"name\": \"Medium\",\n \"count\": 1\n },\n {\n \"name\": \"Large\",\n \"count\": 1\n }\n ]\n }\n ],\n \"products\": [\n {\n \"id\": \"0CC2B425DC\",\n \"name\": \"Sweet Shirt\",\n \"description\": null,\n \"slug\": \"sweet-shirt\",\n \"browser_title\": \"Sweet Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"size\": [\n \"Small\"\n ],\n \"color\": [\n \"Red\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"color\": \"Blue\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf7135\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n \"color\": [\n \"Blue\"\n ]\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 200.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5ecad2d4322a04dfbf7136\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/sweet-shirt/Blue/5d5ecad2d4322a04dfbf7136/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
|
55
55
|
"response_content_type": "application/json",
|
|
56
56
|
"curl": "curl -g \"https://www.example.com/api/storefront/categories/shirts?page=1&sort=price_desc\" -X GET "
|
|
57
57
|
}
|
|
@@ -59,6 +59,6 @@
|
|
|
59
59
|
"resource": "Categories",
|
|
60
60
|
"description": "Showing a category",
|
|
61
61
|
"route": "/api/storefront/categories/:slug",
|
|
62
|
-
"
|
|
63
|
-
"
|
|
62
|
+
"http_method": "GET",
|
|
63
|
+
"explanation": " This endpoint includes everything you need to render a category,\n including any associated content, products, and filters.\n"
|
|
64
64
|
}
|
|
@@ -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:13 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/\"ed0f476278477fed176fca81ad3c37f6\"",
|
|
34
|
+
"X-Request-Id": "ba250ade-99be-40b4-bf62-2b933650ab91",
|
|
35
|
+
"X-Runtime": "0.005917",
|
|
36
36
|
"Expires": "0",
|
|
37
37
|
"Content-Length": "273"
|
|
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 \"categories\": [\n {\n \"id\": \"
|
|
45
|
+
"response_body": "{\n \"categories\": [\n {\n \"id\": \"5d5ecad1d4322a04dfbf712a\",\n \"name\": \"Shirts\",\n \"slug\": \"shirts\",\n \"url\": \"http://www.example.com/api/storefront/categories/shirts\"\n },\n {\n \"id\": \"5d5ecad1d4322a04dfbf7132\",\n \"name\": \"Pants\",\n \"slug\": \"pants\",\n \"url\": \"http://www.example.com/api/storefront/categories/pants\"\n }\n ]\n}",
|
|
46
46
|
"response_content_type": "application/json",
|
|
47
47
|
"curl": "curl -g \"https://www.example.com/api/storefront/categories?page=1\" -X GET "
|
|
48
48
|
}
|
|
@@ -50,6 +50,6 @@
|
|
|
50
50
|
"resource": "Categories",
|
|
51
51
|
"description": "Showing a listing of categories",
|
|
52
52
|
"route": "/api/storefront/categories",
|
|
53
|
-
"
|
|
54
|
-
"
|
|
53
|
+
"http_method": "GET",
|
|
54
|
+
"explanation": " This endpoint will give you a paginated list of all active\n categories, that is, all categories that could be shown on the\n storefront.\n"
|
|
55
55
|
}
|
|
@@ -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/\"b5aecafa6c3622e1ca72d8fd2867ef19\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "
|
|
30
|
+
"X-Request-Id": "92fba1ae-86d4-47fc-b821-a80ac713cd6d",
|
|
31
|
+
"X-Runtime": "8.453429",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "4695"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "POST",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
36
|
+
"request_path": "/api/storefront/checkouts/76A4C94A8B/complete",
|
|
37
37
|
"request_body": "{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}",
|
|
38
38
|
"request_content_type": "application/json",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"order\": {\n \"id\": \"76A4C94A8B\",\n \"url\": \"http://www.example.com/api/storefront/orders/76A4C94A8B\",\n \"user_id\": null,\n \"email\": \"susanb@workarea.com\",\n \"placed_at\": \"2019-08-22T16:59:13.347Z\",\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5ec9ded4322a04dfbf63ff\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5d5ec9ded4322a04dfbf640d\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"billing_address\": {\n \"id\": \"5d5ec9dfd4322a04dfbf6437\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"tenders\": [\n {\n \"type\": \"credit_card\",\n \"amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1111\",\n \"month\": 3,\n \"year\": 2021\n }\n ]\n },\n \"fulfillment\": {\n \"status\": \"Open\",\n \"packages\": [\n\n ],\n \"pending_items\": [\n {\n \"id\": \"5d5ec9ded4322a04dfbf63ff\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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 \"canceled_items\": [\n\n ]\n }\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl \"https://www.example.com/api/storefront/checkouts/
|
|
43
|
+
"curl": "curl \"https://www.example.com/api/storefront/checkouts/76A4C94A8B/complete\" -d '{\"payment\":\"new_card\",\"credit_card\":{\"number\":\"4111111111111111\",\"month\":\"3\",\"year\":2021,\"cvv\":\"123\"}}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Checkout",
|
|
47
47
|
"description": "Completing a checkout",
|
|
48
48
|
"route": "/api/storefront/checkouts/:id/complete",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " This endpoint completes checkout and places the order. Payment\n tender information is required at this point, and should be included\n with this request.\n"
|
|
51
51
|
}
|
|
@@ -24,27 +24,27 @@
|
|
|
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/\"9e2e7a8b84711009a1c9cca739297432\"",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"X-Request-Id": "
|
|
30
|
-
"X-Runtime": "0.
|
|
29
|
+
"X-Request-Id": "59d9b22e-2791-4420-a1c7-e3e0bd811056",
|
|
30
|
+
"X-Runtime": "0.072430",
|
|
31
31
|
"Expires": "0",
|
|
32
32
|
"Content-Length": "2900"
|
|
33
33
|
},
|
|
34
34
|
"request_method": "GET",
|
|
35
|
-
"request_path": "/api/storefront/checkouts/
|
|
35
|
+
"request_path": "/api/storefront/checkouts/5B622C2A71/reset",
|
|
36
36
|
"request_body": null,
|
|
37
37
|
"request_content_type": null,
|
|
38
38
|
"response_status": 200,
|
|
39
39
|
"response_status_text": "OK",
|
|
40
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
40
|
+
"response_body": "{\n \"order\": {\n \"id\": \"5B622C2A71\",\n \"url\": \"http://www.example.com/api/storefront/orders/5B622C2A71\",\n \"user_id\": null,\n \"email\": \"sbaker@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5ec9e9d4322a04dfbf64b8\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/5B622C2A71\",\n \"started_at\": \"2019-08-22T16:59:21.879Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"sbaker@workarea.com\",\n \"problems\": [\n\n ],\n \"billing_address\": {\n \"id\": \"5d5ec9e9d4322a04dfbf64cd\",\n \"first_name\": null,\n \"last_name\": null,\n \"company\": null,\n \"street\": null,\n \"street_2\": null,\n \"city\": null,\n \"country\": null,\n \"region\": null,\n \"postal_code\": null,\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n\n ],\n \"shipping_service\": null,\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
|
|
41
41
|
"response_content_type": "application/json",
|
|
42
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/checkouts/
|
|
42
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/checkouts/5B622C2A71/reset\" -X GET "
|
|
43
43
|
}
|
|
44
44
|
],
|
|
45
45
|
"resource": "Checkout",
|
|
46
46
|
"description": "Showing a checkout",
|
|
47
47
|
"route": "/api/storefront/checkouts/:id/reset",
|
|
48
|
-
"
|
|
49
|
-
"
|
|
48
|
+
"http_method": "GET",
|
|
49
|
+
"explanation": " This endpoint resets the checkout by wiping all private information\n from the order and it's associated models. Use it for handling\n timeouts, logouts, and any other situation where you want to ensure\n the safety of the customer's information.\n"
|
|
50
50
|
}
|
|
@@ -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/\"6e0934f736990a9065ba6ebfcb7bcac3\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "1.
|
|
30
|
+
"X-Request-Id": "906d43de-0b7b-4fdd-8189-e59e04c5e98d",
|
|
31
|
+
"X-Runtime": "1.743208",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "3978"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "PATCH",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
36
|
+
"request_path": "/api/storefront/checkouts/34A4218651",
|
|
37
37
|
"request_body": "{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}",
|
|
38
38
|
"request_content_type": "application/json",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"order\": {\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"order\": {\n \"id\": \"34A4218651\",\n \"url\": \"http://www.example.com/api/storefront/orders/34A4218651\",\n \"user_id\": null,\n \"email\": \"susanb@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5ec9ead4322a04dfbf64d3\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=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\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": \"Express\",\n \"shipping_address\": {\n \"id\": \"5d5ec9ead4322a04dfbf64e1\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"billing_address\": {\n \"id\": \"5d5ec9ebd4322a04dfbf650b\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null\n },\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/34A4218651\",\n \"started_at\": \"2019-08-22T16:59:22.819Z\",\n \"shippable\": true,\n \"complete\": false,\n \"addresses\": {\n \"complete\": true,\n \"email\": \"susanb@workarea.com\",\n \"problems\": [\n\n ],\n \"shipping_address\": {\n \"id\": \"5d5ec9ead4322a04dfbf64e1\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n },\n \"billing_address\": {\n \"id\": \"5d5ec9ebd4322a04dfbf650b\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": \"6465552390\",\n \"phone_extension\": null,\n \"problems\": [\n\n ]\n }\n },\n \"shipping\": {\n \"complete\": true,\n \"problems\": [\n\n ],\n \"shipping_service\": \"Express\",\n \"shipping_total\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n {\n \"name\": \"Standard\",\n \"price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"name\": \"Express\",\n \"price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n {\n \"name\": \"Overnight\",\n \"price\": {\n \"cents\": 2000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl \"https://www.example.com/api/storefront/checkouts/
|
|
43
|
+
"curl": "curl \"https://www.example.com/api/storefront/checkouts/34A4218651\" -d '{\"email\":\"susanb@workarea.com\",\"shipping_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\",\"phone_number\":\"6465552390\"},\"shipping_service\":\"Express\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Checkout",
|
|
47
47
|
"description": "Updating a checkout",
|
|
48
48
|
"route": "/api/storefront/checkouts/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "PATCH",
|
|
50
|
+
"explanation": " Use this endpoint to make updates to checkout. This will typically\n mean setting addresses and shipping options for the checkout.\n"
|
|
51
51
|
}
|
|
@@ -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/\"23c8441f9c0099654c530606a8f94a48\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "68a3e29d-cd7f-47cb-82bd-c12f2baac9fd",
|
|
31
|
+
"X-Runtime": "0.082381",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "228"
|
|
34
34
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"request_content_type": "application/json",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"inquiry\": {\n \"_id\": \"
|
|
41
|
+
"response_body": "{\n \"inquiry\": {\n \"_id\": \"5d5eca61d4322a04dfbf6ca0\",\n \"created_at\": \"2019-08-22T17:01:21.027Z\",\n \"email\": \"email@example.com\",\n \"message\": \"Message\",\n \"name\": \"Name\",\n \"order_id\": \"OrderID\",\n \"subject\": \"orders\",\n \"updated_at\": \"2019-08-22T17:01:21.027Z\"\n }\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl \"https://www.example.com/api/storefront/contacts\" -d '{\"name\":\"Name\",\"email\":\"email@example.com\",\"order_id\":\"OrderID\",\"subject\":\"orders\",\"message\":\"Message\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "Contacts",
|
|
47
47
|
"description": "Creating a contact",
|
|
48
48
|
"route": "/api/storefront/contacts",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " This endpoints creates a customer service inquiry on behalf of the\n customer, and will send an email to the address in\n Workarea.config.email_to\n"
|
|
51
51
|
}
|
|
@@ -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/\"f450e6bbed16875fe3c684da0efe644c\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "75a39e38-3b5b-43e1-8725-6cbb633d1729",
|
|
31
|
+
"X-Runtime": "0.009484",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "61"
|
|
34
34
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"request_content_type": "application/json",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"id\": \"5d5ecba1d4322a04dfbf7be3\",\n \"email\": \"email@example.com\"\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl \"https://www.example.com/api/storefront/email_signups\" -d '{\"email\":\"email@example.com\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "Email Signups",
|
|
47
47
|
"description": "Creating an email signup",
|
|
48
48
|
"route": "/api/storefront/email_signups",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " Use this endpoint to create an email signup. This will usually be\n forwarded to an Email Service Provider, but Workarea will keep a\n record of it just in case.\n"
|
|
51
51
|
}
|