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/\"c179a18e95b9dbd5db114716004fa132\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "cd6d0961-2b3f-4a78-805a-4b0f1cf6c1cd",
|
|
31
|
+
"X-Runtime": "0.353300",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "306"
|
|
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 \"account\": {\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"account\": {\n \"id\": \"5d5ecb14d4322a04dfbf741c\",\n \"email\": \"bob@workarea.com\",\n \"public_info\": null,\n \"first_name\": null,\n \"last_name\": null,\n \"updated_at\": \"2019-08-22T17:04:20.954Z\",\n \"created_at\": \"2019-08-22T17:04:20.954Z\"\n },\n \"authentication_token\": {\n \"token\": \"1MHbvDvBTv4fvb5T9PwXc9h5\",\n \"expires_at\": \"2019-08-29T17:04:21.042Z\"\n }\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"bob@workarea.com\",\"password\":\"areallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "Accounts",
|
|
47
47
|
"description": "Creating an account",
|
|
48
48
|
"route": "/api/storefront/account",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " This endpoint does three things: it creates an account, it creates\n an authentication token, and it sends an account creation email to\n 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=\"Svs7Xin3mUSKPRm4nmb4aZ7T\""
|
|
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/\"9b4c5b64cdfe76d2923a008d8458f421\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "0e6fa2a4-5988-4856-8e1b-01502d97878e",
|
|
31
|
+
"X-Runtime": "0.006057",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "203"
|
|
34
34
|
},
|
|
@@ -38,9 +38,9 @@
|
|
|
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\": \"5d5ecb14d4322a04dfbf7418\",\n \"email\": \"user285@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-22T17:04:20.332Z\",\n \"created_at\": \"2019-08-22T17:04:20.332Z\"\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"Svs7Xin3mUSKPRm4nmb4aZ7T\\\"\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Accounts",
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"31NgTSxxcFYoiicmjYcxAntn\"",
|
|
13
13
|
"X-Http-Method-Override": "GET"
|
|
14
14
|
},
|
|
15
15
|
"request_query_parameters": {
|
|
@@ -27,10 +27,10 @@
|
|
|
27
27
|
"Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
|
|
28
28
|
"X-Requested-With": "",
|
|
29
29
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
30
|
-
"ETag": "W/\"
|
|
30
|
+
"ETag": "W/\"6ef3657762c3cd36ef4effe376b4e0b6\"",
|
|
31
31
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
32
|
-
"X-Request-Id": "
|
|
33
|
-
"X-Runtime": "0.
|
|
32
|
+
"X-Request-Id": "5aa7a39a-5707-41a0-84ac-a857dabca6e2",
|
|
33
|
+
"X-Runtime": "0.010824",
|
|
34
34
|
"Expires": "0",
|
|
35
35
|
"Content-Length": "203"
|
|
36
36
|
},
|
|
@@ -40,9 +40,9 @@
|
|
|
40
40
|
"request_content_type": "application/json",
|
|
41
41
|
"response_status": 200,
|
|
42
42
|
"response_status_text": "OK",
|
|
43
|
-
"response_body": "{\n \"id\": \"
|
|
43
|
+
"response_body": "{\n \"id\": \"5d5ecb13d4322a04dfbf7414\",\n \"email\": \"user284@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-22T17:04:19.694Z\",\n \"created_at\": \"2019-08-22T17:04:19.694Z\"\n}",
|
|
44
44
|
"response_content_type": "application/json",
|
|
45
|
-
"curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"
|
|
45
|
+
"curl": "curl \"https://www.example.com/api/storefront/account\" -d '{\"email\":\"billy@workarea.com\",\"password\":\"adifferentbutstillreallysecurepassword\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"31NgTSxxcFYoiicmjYcxAntn\\\"\" \\\n\t-H \"X-Http-Method-Override: GET\""
|
|
46
46
|
}
|
|
47
47
|
],
|
|
48
48
|
"resource": "Accounts",
|
|
@@ -15,8 +15,8 @@
|
|
|
15
15
|
"response_headers": {
|
|
16
16
|
"Content-Type": "text/html; charset=utf-8",
|
|
17
17
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
18
|
-
"X-Request-Id": "
|
|
19
|
-
"X-Runtime": "0.
|
|
18
|
+
"X-Request-Id": "e83dabd2-201c-46bb-b617-9a066f34760c",
|
|
19
|
+
"X-Runtime": "0.002698",
|
|
20
20
|
"Expires": "0",
|
|
21
21
|
"Content-Length": "0"
|
|
22
22
|
},
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"resource": "Analytics",
|
|
35
35
|
"description": "saving a category view",
|
|
36
36
|
"route": "/api/storefront/analytics/category_view/:category_id",
|
|
37
|
-
"
|
|
38
|
-
"
|
|
37
|
+
"http_method": "POST",
|
|
38
|
+
"explanation": "saving a category view will be reflected in admin reports"
|
|
39
39
|
}
|
|
@@ -15,8 +15,8 @@
|
|
|
15
15
|
"response_headers": {
|
|
16
16
|
"Content-Type": "text/html; charset=utf-8",
|
|
17
17
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
18
|
-
"X-Request-Id": "
|
|
19
|
-
"X-Runtime": "0.
|
|
18
|
+
"X-Request-Id": "762b3a63-c78b-46ad-9b84-1ef43d14cf1f",
|
|
19
|
+
"X-Runtime": "0.002679",
|
|
20
20
|
"Expires": "0",
|
|
21
21
|
"Content-Length": "0"
|
|
22
22
|
},
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"resource": "Analytics",
|
|
35
35
|
"description": "saving a product view",
|
|
36
36
|
"route": "/api/storefront/analytics/product_view/:product_id",
|
|
37
|
-
"
|
|
38
|
-
"
|
|
37
|
+
"http_method": "POST",
|
|
38
|
+
"explanation": "saving a product view will be reflected in admin reports"
|
|
39
39
|
}
|
|
@@ -15,8 +15,8 @@
|
|
|
15
15
|
"response_headers": {
|
|
16
16
|
"Content-Type": "text/html; charset=utf-8",
|
|
17
17
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
18
|
-
"X-Request-Id": "
|
|
19
|
-
"X-Runtime": "0.
|
|
18
|
+
"X-Request-Id": "e261574b-09b6-4a7f-85f5-52383e08314f",
|
|
19
|
+
"X-Runtime": "0.003015",
|
|
20
20
|
"Expires": "0",
|
|
21
21
|
"Content-Length": "0"
|
|
22
22
|
},
|
|
@@ -34,6 +34,6 @@
|
|
|
34
34
|
"resource": "Analytics",
|
|
35
35
|
"description": "Saving a search",
|
|
36
36
|
"route": "/api/storefront/analytics/search",
|
|
37
|
-
"
|
|
38
|
-
"
|
|
37
|
+
"http_method": "POST",
|
|
38
|
+
"explanation": " Saving a search will be reflected in admin reports. This is intended\n to be called once per search performed by a customer.\n"
|
|
39
39
|
}
|
|
@@ -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/\"84d1ea8812e5268e2a39b2febb4e2a52\"",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"X-Request-Id": "
|
|
30
|
-
"X-Runtime": "0.
|
|
29
|
+
"X-Request-Id": "da2a7293-2f25-43cc-a1a6-aefe5e4735a6",
|
|
30
|
+
"X-Runtime": "0.004657",
|
|
31
31
|
"Expires": "0",
|
|
32
32
|
"Content-Length": "217"
|
|
33
33
|
},
|
|
34
34
|
"request_method": "GET",
|
|
35
|
-
"request_path": "/api/storefront/assets/
|
|
35
|
+
"request_path": "/api/storefront/assets/5d5ecb4ed4322a04dfbf76e6",
|
|
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 \"id\": \"
|
|
40
|
+
"response_body": "{\n \"id\": \"5d5ecb4ed4322a04dfbf76e6\",\n \"name\": \"Summer Sale Callout\",\n \"url\": \"http://www.example.com/media/W1siZiIsIjIwMTkvMDgvMjIvOGJ4NzEzZ3k1NF9maWxlLmpwZyJdLFsicCIsIm9wdGltIl1d/file.jpg?sha=ae3e59fda31e8675\",\n \"type\": \"image\"\n}",
|
|
41
41
|
"response_content_type": "application/json",
|
|
42
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/assets/
|
|
42
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/assets/5d5ecb4ed4322a04dfbf76e6\" -X GET "
|
|
43
43
|
}
|
|
44
44
|
],
|
|
45
45
|
"resource": "Assets",
|
|
46
46
|
"description": "Showing an asset",
|
|
47
47
|
"route": "/api/storefront/assets/:id",
|
|
48
|
-
"
|
|
49
|
-
"
|
|
48
|
+
"http_method": "GET",
|
|
49
|
+
"explanation": " Use this endpoint to look up assets stored in Workarea. Often times\n these will be referenced in content blocks.\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/\"f5c9346693cf83a66994fd508d3a8d98\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "ccde8c8f-f8b5-482a-a052-d869cad4f317",
|
|
31
|
+
"X-Runtime": "0.256992",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "76"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "POST",
|
|
36
36
|
"request_path": "/api/storefront/authentication_tokens",
|
|
37
|
-
"request_body": "{\"email\":\"
|
|
37
|
+
"request_body": "{\"email\":\"user400@workarea.com\",\"password\":\"p@assword!\"}",
|
|
38
38
|
"request_content_type": "application/json",
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"token\": \"
|
|
41
|
+
"response_body": "{\n \"token\": \"CZUsXvX9o1bE9ugo35qFxtsT\",\n \"expires_at\": \"2019-08-29T17:06:42.626Z\"\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '{\"email\":\"
|
|
43
|
+
"curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '{\"email\":\"user400@workarea.com\",\"password\":\"p@assword!\"}' -X POST \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Authentication",
|
|
47
47
|
"description": "Creating an authentication token",
|
|
48
48
|
"route": "/api/storefront/authentication_tokens",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "POST",
|
|
50
|
+
"explanation": " Creating an authentication token is the first step in user\n authentication. You will use this token to authenticate requests on\n behalf of the user going forward. To get a token you can use to\n authenticate an account, use this endpoint. You'll need the email\n and password from the user, and we'll issue a token that can be used\n to authenticate further requests for that customer. This token will\n expire after 7 days.\n Tokens are also invalidated when a user changes their password. See\n the \"using an authentication token\" example for how to use an\n authentication token.\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=\"P18mWxiY3xFv5NBzNQXyUtDy\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -26,10 +26,10 @@
|
|
|
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/\"3c498ff26a4f29dbd604930395323dfd\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "4efe4660-f394-49ca-9691-3a2aff761751",
|
|
32
|
+
"X-Runtime": "0.006391",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "76"
|
|
35
35
|
},
|
|
@@ -39,14 +39,14 @@
|
|
|
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 \"token\": \"
|
|
42
|
+
"response_body": "{\n \"token\": \"P18mWxiY3xFv5NBzNQXyUtDy\",\n \"expires_at\": \"2019-08-29T17:06:43.807Z\"\n}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/authentication_tokens\" -d '' -X PATCH \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"P18mWxiY3xFv5NBzNQXyUtDy\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Authentication",
|
|
48
48
|
"description": "Refreshing an authentication token",
|
|
49
49
|
"route": "/api/storefront/authentication_tokens",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "PATCH",
|
|
51
|
+
"explanation": " Refreshing an authentication token extends its expiration so that it\n can continue to be used.\n"
|
|
52
52
|
}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"requests": [
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
|
-
"Authorization": "Token token=\"
|
|
11
|
+
"Authorization": "Token token=\"BkPF5tvB28Mw4xoxngr1Ykdg\""
|
|
12
12
|
},
|
|
13
13
|
"request_query_parameters": {
|
|
14
14
|
},
|
|
@@ -25,12 +25,12 @@
|
|
|
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/\"4175ee7f97c7634deea80a2a9368559a\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "a70bffbe-babf-4744-b283-cf131b855caf",
|
|
31
|
+
"X-Runtime": "0.007518",
|
|
32
32
|
"Expires": "0",
|
|
33
|
-
"Content-Length": "
|
|
33
|
+
"Content-Length": "203"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "GET",
|
|
36
36
|
"request_path": "/api/storefront/account",
|
|
@@ -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 \"id\": \"
|
|
41
|
+
"response_body": "{\n \"id\": \"5d5ecba3d4322a04dfbf7bec\",\n \"email\": \"user401@workarea.com\",\n \"public_info\": \"BC\",\n \"first_name\": \"Ben\",\n \"last_name\": \"Crouse\",\n \"updated_at\": \"2019-08-22T17:06:43.165Z\",\n \"created_at\": \"2019-08-22T17:06:43.165Z\"\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/account\" -X GET \\\n\t-H \"Authorization: Token token=\\\"BkPF5tvB28Mw4xoxngr1Ykdg\\\"\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Authentication",
|
|
47
47
|
"description": "Using an authentication token",
|
|
48
48
|
"route": "/api/storefront/account",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " After obtaining an authentication token you can use it to request\n authenticated endpoints by including it in the Authorization header\n on the request, as demonstrated in this example.\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=\"A42vikHG24MpdMirDzRgWvdq\""
|
|
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/\"71618f4f82148b3abf975abb9ffb20e0\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "9d48354e-369d-4ad2-889c-4b426a2b7d04",
|
|
32
|
+
"X-Runtime": "0.066053",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "2428"
|
|
35
35
|
},
|
|
36
36
|
"request_method": "POST",
|
|
37
|
-
"request_path": "/api/storefront/carts/
|
|
37
|
+
"request_path": "/api/storefront/carts/73B4E43004/add_promo_code",
|
|
38
38
|
"request_body": "{\"promo_code\":\"10OFF\"}",
|
|
39
39
|
"request_content_type": "application/json",
|
|
40
40
|
"response_status": 200,
|
|
41
41
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"id\": \"
|
|
42
|
+
"response_body": "{\n \"id\": \"73B4E43004\",\n \"url\": \"http://www.example.com/api/storefront/orders/73B4E43004\",\n \"user_id\": \"5d5eca1ad4322a04dfbf691b\",\n \"email\": \"bcrouse@workarea.com\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n \"10OFF\"\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca1bd4322a04dfbf6922\",\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 \"description\": \"Order Total Discount\",\n \"discount\": true,\n \"amount\": {\n \"cents\": -100.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 \"description\": \"Order Total Discount\",\n \"amount\": {\n \"cents\": -100.0,\n \"currency_iso\": \"USD\"\n }\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\": 900.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 900.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\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/73B4E43004/add_promo_code\" -d '{\"promo_code\":\"10OFF\"}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"A42vikHG24MpdMirDzRgWvdq\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Cart",
|
|
48
48
|
"description": "Adding a promo code",
|
|
49
49
|
"route": "/api/storefront/carts/:id/add_promo_code",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "POST",
|
|
51
|
+
"explanation": "This endpoint will add promo codes to the cart"
|
|
52
52
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"5VLvCJM25ehi4Jdz3ivnNJw3\""
|
|
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/\"fb8d0a817e4186aea6426ed43bc6cc3f\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "fd3c87c1-1fd1-4942-a609-ac600ed2a43e",
|
|
32
|
+
"X-Runtime": "0.081906",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "3920"
|
|
35
35
|
},
|
|
36
36
|
"request_method": "POST",
|
|
37
|
-
"request_path": "/api/storefront/carts/
|
|
37
|
+
"request_path": "/api/storefront/carts/EE04EC3B2A/items",
|
|
38
38
|
"request_body": "{\"product_id\":\"VINTEE\",\"sku\":\"VT001\",\"quantity\":2}",
|
|
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\": \"5d5eca76d4322a04dfbf6dcd\",\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 \"order\": {\n \"id\": \"EE04EC3B2A\",\n \"url\": \"http://www.example.com/api/storefront/orders/EE04EC3B2A\",\n \"user_id\": \"5d5eca76d4322a04dfbf6dc6\",\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\": \"5d5eca76d4322a04dfbf6dcd\",\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}",
|
|
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/EE04EC3B2A/items\" -d '{\"product_id\":\"VINTEE\",\"sku\":\"VT001\",\"quantity\":2}' -X POST \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"5VLvCJM25ehi4Jdz3ivnNJw3\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Cart",
|
|
48
48
|
"description": "Adding an item",
|
|
49
49
|
"route": "/api/storefront/carts/:cart_id/items",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "POST",
|
|
51
|
+
"explanation": " Adds an item to the cart. Use the create a cart endpoint to get a\n cart_id to use with this endpoint.\n"
|
|
52
52
|
}
|
|
@@ -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=\"nSBVAgAPSRSVjqgHPsyTuLZV\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -26,10 +26,10 @@
|
|
|
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/\"92e1ed95a3c830a3a8371002863765cc\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "230a7c6c-bbf6-48df-8f65-41ad934a357b",
|
|
32
|
+
"X-Runtime": "0.014275",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "544"
|
|
35
35
|
},
|
|
@@ -39,14 +39,14 @@
|
|
|
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 \"id\": \"
|
|
42
|
+
"response_body": "{\n \"id\": \"9A551D81A1\",\n \"url\": \"http://www.example.com/api/storefront/orders/9A551D81A1\",\n \"user_id\": \"5d5eca19d4322a04dfbf690d\",\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}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/carts\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/carts\" -d '' -X POST \\\n\t-H \"Content-Type: application/x-www-form-urlencoded\" \\\n\t-H \"Authorization: Token token=\\\"nSBVAgAPSRSVjqgHPsyTuLZV\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Cart",
|
|
48
48
|
"description": "Creating a new cart for a user",
|
|
49
49
|
"route": "/api/storefront/carts",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "POST",
|
|
51
|
+
"explanation": " Here's how to create a cart for a user. This endpoint allows the\n possibility of multiple carts for a user.\n"
|
|
52
52
|
}
|