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
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"request_headers": {
|
|
11
11
|
"Content-Type": "application/json",
|
|
12
|
-
"Authorization": "Token token=\"
|
|
12
|
+
"Authorization": "Token token=\"znRJwJSwnksRNf3hhfbHoWHa\""
|
|
13
13
|
},
|
|
14
14
|
"request_query_parameters": {
|
|
15
15
|
},
|
|
@@ -26,22 +26,22 @@
|
|
|
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/\"0038cc54b80e1fb6e7943b4bf37a94b8\"",
|
|
30
30
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
31
|
+
"X-Request-Id": "1c143b11-ba5e-4272-aeef-4dadbbb0d752",
|
|
32
|
+
"X-Runtime": "0.017047",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "294"
|
|
35
35
|
},
|
|
36
36
|
"request_method": "PATCH",
|
|
37
|
-
"request_path": "/api/storefront/saved_credit_cards/
|
|
37
|
+
"request_path": "/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322",
|
|
38
38
|
"request_body": "{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}",
|
|
39
39
|
"request_content_type": "application/json",
|
|
40
40
|
"response_status": 200,
|
|
41
41
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"user_id\": \"
|
|
42
|
+
"response_body": "{\n \"user_id\": \"5d5ec9ced4322a04dfbf631e\",\n \"id\": \"5d5ec9ced4322a04dfbf6322\",\n \"url\": \"http://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322\",\n \"default\": false,\n \"issuer\": \"Visa\",\n \"display_number\": \"XXXX-XXXX-XXXX-1881\",\n \"month\": 7,\n \"year\": 2024,\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\"\n}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
|
-
"curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/
|
|
44
|
+
"curl": "curl \"https://www.example.com/api/storefront/saved_credit_cards/5d5ec9ced4322a04dfbf6322\" -d '{\"month\":\"7\",\"year\":\"2024\",\"cvv\":\"123\"}' -X PATCH \\\n\t-H \"Content-Type: application/json\" \\\n\t-H \"Authorization: Token token=\\\"znRJwJSwnksRNf3hhfbHoWHa\\\"\""
|
|
45
45
|
}
|
|
46
46
|
],
|
|
47
47
|
"resource": "Saved Credit Cards",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"X-Download-Options": "noopen",
|
|
20
20
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
21
21
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
22
|
-
"Date": "
|
|
22
|
+
"Date": "Thu, 22 Aug 2019 17:00:24 GMT",
|
|
23
23
|
"Content-Type": "application/json; charset=utf-8",
|
|
24
24
|
"Access-Control-Allow-Origin": "*",
|
|
25
25
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -27,9 +27,9 @@
|
|
|
27
27
|
"X-Requested-With": "",
|
|
28
28
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"ETag": "W/\"
|
|
31
|
-
"X-Request-Id": "
|
|
32
|
-
"X-Runtime": "0.
|
|
30
|
+
"ETag": "W/\"5cadef3e3fd1835a35070954308d0d32\"",
|
|
31
|
+
"X-Request-Id": "02b9b8a2-403b-4f94-83ea-5cebacd48cee",
|
|
32
|
+
"X-Runtime": "0.055426",
|
|
33
33
|
"Expires": "0",
|
|
34
34
|
"Content-Length": "631"
|
|
35
35
|
},
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"request_content_type": null,
|
|
40
40
|
"response_status": 200,
|
|
41
41
|
"response_status_text": "OK",
|
|
42
|
-
"response_body": "{\n \"results\": [\n {\n \"value\": \"red\",\n \"type\": \"Searches\",\n \"image\": null,\n \"url\": \"/api/storefront/search?q=red\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Product\",\n \"type\": \"Products\",\n \"image\": \"/product_images/placeholder/small_thumb.jpg?c=
|
|
42
|
+
"response_body": "{\n \"results\": [\n {\n \"value\": \"red\",\n \"type\": \"Searches\",\n \"image\": null,\n \"url\": \"/api/storefront/search?q=red\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Product\",\n \"type\": \"Products\",\n \"image\": \"/product_images/placeholder/small_thumb.jpg?c=1566493120\",\n \"url\": \"/api/storefront/products/red-product\",\n \"analytics\": {\n \"id\": \"8CB6DE3B62\",\n \"name\": \"Red Product\",\n \"sku\": null,\n \"sale\": false,\n \"price\": 5.0,\n \"category\": null\n }\n },\n {\n \"value\": \"Page about Red Products\",\n \"type\": \"Pages\",\n \"image\": null,\n \"url\": \"/api/storefront/pages/page-about-red-products\",\n \"analytics\": null\n },\n {\n \"value\": \"Red Category\",\n \"type\": \"Categories\",\n \"image\": null,\n \"url\": \"/api/storefront/categories/red-category\",\n \"analytics\": null\n }\n ]\n}",
|
|
43
43
|
"response_content_type": "application/json",
|
|
44
44
|
"curl": "curl -g \"https://www.example.com/api/storefront/searches?q=red\" -X GET "
|
|
45
45
|
}
|
|
@@ -47,6 +47,6 @@
|
|
|
47
47
|
"resource": "Searches",
|
|
48
48
|
"description": "Showing search autocomplete suggestions",
|
|
49
49
|
"route": "/api/storefront/searches",
|
|
50
|
-
"
|
|
51
|
-
"
|
|
50
|
+
"http_method": "GET",
|
|
51
|
+
"explanation": " This list will be based on popular search terms and matching\n products, categories, etc. Useful for showing a autocomplete\n drop-down as a customer types in a search bar.\n"
|
|
52
52
|
}
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"X-Download-Options": "noopen",
|
|
37
37
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
38
38
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
39
|
-
"Date": "
|
|
39
|
+
"Date": "Thu, 22 Aug 2019 17:00:25 GMT",
|
|
40
40
|
"Content-Type": "application/json; charset=utf-8",
|
|
41
41
|
"Access-Control-Allow-Origin": "*",
|
|
42
42
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -44,9 +44,9 @@
|
|
|
44
44
|
"X-Requested-With": "",
|
|
45
45
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
46
46
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
47
|
-
"ETag": "W/\"
|
|
48
|
-
"X-Request-Id": "
|
|
49
|
-
"X-Runtime": "0.
|
|
47
|
+
"ETag": "W/\"cbbd627ecb28bfddcc28d6597fc07c2e\"",
|
|
48
|
+
"X-Request-Id": "bf062e15-7dc7-4d52-8a59-09ae63b7ce6f",
|
|
49
|
+
"X-Runtime": "0.119178",
|
|
50
50
|
"Expires": "0",
|
|
51
51
|
"Content-Length": "6349"
|
|
52
52
|
},
|
|
@@ -56,7 +56,7 @@
|
|
|
56
56
|
"request_content_type": null,
|
|
57
57
|
"response_status": 200,
|
|
58
58
|
"response_status_text": "OK",
|
|
59
|
-
"response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\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\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"
|
|
59
|
+
"response_body": "{\n \"query_string\": \"large\",\n \"message\": null,\n \"redirect\": null,\n \"sorts\": [\n [\n \"Relevance\",\n \"relevance\"\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\": {\n \"name\": \"Price, High to Low\",\n \"slug\": \"price_desc\",\n \"field\": \"sorts.price\",\n \"direction\": \"desc\"\n },\n \"content_blocks\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69d7\",\n \"type\": \"text\",\n \"area\": \"results\",\n \"data\": {\n \"text\": \"Huzzah! Your search results are below!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d7\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5eca28d4322a04dfbf69d7","type":"text","position":0,"data":{"text":"Huzzah! Your search results are below!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Huzzah! Your search results are below!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5eca28d4322a04dfbf69d8\",\n \"type\": \"text\",\n \"area\": \"no_results\",\n \"data\": {\n \"text\": \"Sorry, we can't find what you searched for!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5eca28d4322a04dfbf69d8\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5eca28d4322a04dfbf69d8","type":"text","position":0,"data":{"text":"Sorry, we can't find what you searched for!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Sorry, we can't find what you searched for!</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\": 2,\n \"total_pages\": 1,\n \"facets\": [\n\n ],\n \"products\": [\n {\n \"id\": \"PRODUCT1\",\n \"name\": \"Pretty Nice Shirt\",\n \"description\": null,\n \"slug\": \"pretty-nice-shirt\",\n \"browser_title\": \"Pretty Nice Shirt\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Blue\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69da\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69db\",\n \"option\": \"Blue\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/pretty-nice-shirt/Blue/5d5eca28d4322a04dfbf69db/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"PRODUCT2\",\n \"name\": \"Great Pants\",\n \"description\": null,\n \"slug\": \"great-pants\",\n \"browser_title\": \"Great Pants\",\n \"meta_description\": null,\n \"template\": \"generic\",\n \"customizations\": null,\n \"details\": {\n \"Material\": [\n \"Cotton\"\n ],\n \"Style\": [\n \"12345\"\n ]\n },\n \"digital\": false,\n \"filters\": {\n \"Size\": [\n \"Small\",\n \"Medium\",\n \"Large\"\n ],\n \"Color\": \"Brown\"\n },\n \"purchasable\": true,\n \"inventory_status\": \"\",\n \"variants\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69dd\",\n \"name\": \"SKU\",\n \"sku\": \"SKU\",\n \"details\": {\n }\n }\n ],\n \"sell_min_price\": null,\n \"sell_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_min_price\": {\n \"cents\": 3500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_max_price\": {\n \"cents\": 5000.0,\n \"currency_iso\": \"USD\"\n },\n \"images\": [\n {\n \"id\": \"5d5eca28d4322a04dfbf69de\",\n \"option\": \"Brown\",\n \"position\": 0,\n \"primary\": true,\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small.jpg?c=0\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium.jpg?c=0\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/small_thumb.jpg?c=0\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/medium_thumb.jpg?c=0\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/large_thumb.jpg?c=0\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/detail.jpg?c=0\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/zoom.jpg?c=0\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/super_zoom.jpg?c=0\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon.jpg?c=0\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/great-pants/Brown/5d5eca28d4322a04dfbf69de/favicon_ico.jpg?c=0\"\n }\n ]\n }\n ]\n }\n ]\n}",
|
|
60
60
|
"response_content_type": "application/json",
|
|
61
61
|
"curl": "curl -g \"https://www.example.com/api/storefront/search?page=1&q=large&sort=price_desc\" -X GET "
|
|
62
62
|
}
|
|
@@ -64,6 +64,6 @@
|
|
|
64
64
|
"resource": "Searches",
|
|
65
65
|
"description": "Showing search results",
|
|
66
66
|
"route": "/api/storefront/search",
|
|
67
|
-
"
|
|
68
|
-
"
|
|
67
|
+
"http_method": "GET",
|
|
68
|
+
"explanation": " This endpoint returns everything you'll need to show search results\n to customers. This includes products, filters, and any content\n that's been setup by an administrator.\n"
|
|
69
69
|
}
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "
|
|
21
|
+
"Date": "Thu, 22 Aug 2019 16:58:57 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -26,9 +26,9 @@
|
|
|
26
26
|
"X-Requested-With": "",
|
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"ETag": "W/\"
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
29
|
+
"ETag": "W/\"80e99c9a4189f1075fe29a655c4f5d4c\"",
|
|
30
|
+
"X-Request-Id": "8c0d811f-3856-4390-9274-617f125c362d",
|
|
31
|
+
"X-Runtime": "0.010637",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "1981"
|
|
34
34
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"request_content_type": null,
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"id\": \"5d5ec9d1d4322a04dfbf633e\",\n \"name\": \"Layout\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Layout\",\n \"browser_title\": \"Layout\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ec9d1d4322a04dfbf633f\",\n \"type\": \"text\",\n \"area\": \"header_promo\",\n \"data\": {\n \"text\": \"Don't miss our sizzling summer deals!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ec9d1d4322a04dfbf633f\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ec9d1d4322a04dfbf633f","type":"text","position":0,"data":{"text":"Don't miss our sizzling summer deals!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Don't miss our sizzling summer deals!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5ec9d1d4322a04dfbf6340\",\n \"type\": \"text\",\n \"area\": \"footer_navigation\",\n \"data\": {\n \"text\": \"Be the first to received our exclusive discounts\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ec9d1d4322a04dfbf6340\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ec9d1d4322a04dfbf6340","type":"text","position":0,"data":{"text":"Be the first to received our exclusive discounts"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Be the first to received our exclusive discounts</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/layout\" -X GET "
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "System Content",
|
|
47
47
|
"description": "Showing system content",
|
|
48
48
|
"route": "/api/storefront/system_content/:name",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " System content is content for an area of site not configured by the\n CMS. Examples would be content for the cart page, content for\n checkout, site layout content, etc. The home page is also an example\n of system content and shown in a separate example.\n"
|
|
51
51
|
}
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "
|
|
21
|
+
"Date": "Thu, 22 Aug 2019 16:58:57 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -26,9 +26,9 @@
|
|
|
26
26
|
"X-Requested-With": "",
|
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"ETag": "W/\"
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
29
|
+
"ETag": "W/\"0cb889e813b55f6fa624cf1cacf1b257\"",
|
|
30
|
+
"X-Request-Id": "cf0fb6d8-3f87-4ad8-8961-79a3dc6c1cd1",
|
|
31
|
+
"X-Runtime": "0.009229",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "1830"
|
|
34
34
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"request_content_type": null,
|
|
39
39
|
"response_status": 200,
|
|
40
40
|
"response_status_text": "OK",
|
|
41
|
-
"response_body": "{\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"id\": \"5d5ec9d1d4322a04dfbf6342\",\n \"name\": \"Home Page\",\n \"url\": \"http://www.example.com/api/storefront/system_content/Home%20Page\",\n \"browser_title\": \"Home Page\",\n \"meta_description\": \"Shop online for Workarea API products\",\n \"content_blocks\": [\n {\n \"id\": \"5d5ec9d1d4322a04dfbf6343\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Summer is here!\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 0,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ec9d1d4322a04dfbf6343\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ec9d1d4322a04dfbf6343","type":"text","position":0,"data":{"text":"Summer is here!"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Summer is here!</div>\\n</div>\\n\"\n },\n {\n \"id\": \"5d5ec9d1d4322a04dfbf6344\",\n \"type\": \"text\",\n \"area\": \"default\",\n \"data\": {\n \"text\": \"Get 20% off all swimwear\"\n },\n \"hidden_breakpoints\": [\n\n ],\n \"position\": 1,\n \"html\": \"<div class=\\\"content-block content-block--text\\\" id=\\\"content_block_5d5ec9d1d4322a04dfbf6344\\\" data-analytics=\\\"{"event":"contentBlockDisplay","payload":{"id":"5d5ec9d1d4322a04dfbf6344","type":"text","position":1,"data":{"text":"Get 20% off all swimwear"}}}\\\" data-hidden-block-css-content=\\\"Block hidden at this breakpoint\\\"><div class='text-content-block'>Get 20% off all swimwear</div>\\n</div>\\n\"\n }\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
43
|
"curl": "curl -g \"https://www.example.com/api/storefront/system_content/home_page\" -X GET "
|
|
44
44
|
}
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"resource": "System Content",
|
|
47
47
|
"description": "Showing the home page",
|
|
48
48
|
"route": "/api/storefront/system_content/home_page",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " This endpoint returns everything you'll need to render the home\n page.\n"
|
|
51
51
|
}
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"X-Download-Options": "noopen",
|
|
19
19
|
"X-Permitted-Cross-Domain-Policies": "none",
|
|
20
20
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
21
|
-
"Date": "
|
|
21
|
+
"Date": "Thu, 22 Aug 2019 17:02:10 GMT",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Access-Control-Allow-Origin": "*",
|
|
24
24
|
"Access-Control-Allow-Headers": "*",
|
|
@@ -26,26 +26,26 @@
|
|
|
26
26
|
"X-Requested-With": "",
|
|
27
27
|
"Vary": "X-Requested-With, X-Flash-Messages",
|
|
28
28
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
29
|
-
"ETag": "W/\"
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
29
|
+
"ETag": "W/\"68a6afbf1d116813312ea2a8cb13646d\"",
|
|
30
|
+
"X-Request-Id": "335b1d1a-a625-4d60-b1d5-774f0d1d5b7b",
|
|
31
|
+
"X-Runtime": "0.009750",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "534"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "GET",
|
|
36
|
-
"request_path": "/api/storefront/taxons/
|
|
36
|
+
"request_path": "/api/storefront/taxons/5d5eca92d4322a04dfbf6f44",
|
|
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 \"taxon\": {\n \"id\": \"
|
|
41
|
+
"response_body": "{\n \"taxon\": {\n \"id\": \"5d5eca92d4322a04dfbf6f44\",\n \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": \"http://example.com/pages/mens\",\n \"parent_id\": \"5d5eca92d4322a04dfbf6f45\",\n \"parent_ids\": [\n \"5d5eca92d4322a04dfbf6f45\"\n ],\n \"position\": 0\n },\n \"children\": [\n {\n \"id\": \"5d5eca92d4322a04dfbf6f46\",\n \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f46\",\n \"name\": \"Sale\",\n \"depth\": 2,\n \"navigable_url\": null,\n \"parent_id\": \"5d5eca92d4322a04dfbf6f44\",\n \"parent_ids\": [\n \"5d5eca92d4322a04dfbf6f45\",\n \"5d5eca92d4322a04dfbf6f44\"\n ],\n \"position\": 0\n }\n ]\n}",
|
|
42
42
|
"response_content_type": "application/json",
|
|
43
|
-
"curl": "curl -g \"https://www.example.com/api/storefront/taxons/
|
|
43
|
+
"curl": "curl -g \"https://www.example.com/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\" -X GET "
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Taxons",
|
|
47
47
|
"description": "Showing a taxon",
|
|
48
48
|
"route": "/api/storefront/taxons/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "GET",
|
|
50
|
+
"explanation": " This endpoint will show details on a particular node (or taxon) of\n the site taxonomy, along with its children.\n"
|
|
51
51
|
}
|
|
@@ -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/\"1c738b755ccc1b901b10d9fd9e7b24de\"",
|
|
29
29
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
30
|
-
"X-Request-Id": "
|
|
31
|
-
"X-Runtime": "0.
|
|
30
|
+
"X-Request-Id": "df8c92ae-b1f8-48d9-9497-d49dd15b9f03",
|
|
31
|
+
"X-Runtime": "0.491660",
|
|
32
32
|
"Expires": "0",
|
|
33
33
|
"Content-Length": "3271"
|
|
34
34
|
},
|
|
35
35
|
"request_method": "PATCH",
|
|
36
|
-
"request_path": "/api/storefront/checkouts/
|
|
36
|
+
"request_path": "/api/storefront/checkouts/B90394D2D5",
|
|
37
37
|
"request_body": "{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}",
|
|
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\": \"B90394D2D5\",\n \"url\": \"http://www.example.com/api/storefront/orders/B90394D2D5\",\n \"user_id\": null,\n \"email\": \"susanb@\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca6ed4322a04dfbf6d7a\",\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/B90394D2D5\",\n \"started_at\": \"2019-08-22T17:01:34.556Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"susanb@\",\n \"problems\": [\n \"Email is invalid\"\n ],\n \"shipping_address\": {\n \"id\": \"5d5eca6fd4322a04dfbf6d81\",\n \"first_name\": \"\",\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\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"First name can't be blank\"\n ]\n },\n \"billing_address\": {\n \"id\": \"5d5eca6fd4322a04dfbf6d82\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"Street can't be blank\"\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\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 \"Address is invalid\"\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/B90394D2D5\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
|
|
44
44
|
}
|
|
45
45
|
],
|
|
46
46
|
"resource": "Validation Errors",
|
|
47
47
|
"description": "Checkout validation errors",
|
|
48
48
|
"route": "/api/storefront/checkouts/:id",
|
|
49
|
-
"
|
|
50
|
-
"
|
|
49
|
+
"http_method": "PATCH",
|
|
50
|
+
"explanation": " Due to the more complex nature of checkout updates and data,\n checkout validation errors are returned inline with the resource\n they are coming from as shown below. Note the response status can be\n 200 OK, due to some data being persisted properly.\n"
|
|
51
51
|
}
|
|
@@ -21,8 +21,8 @@
|
|
|
21
21
|
"Referrer-Policy": "strict-origin-when-cross-origin",
|
|
22
22
|
"Content-Type": "application/json; charset=utf-8",
|
|
23
23
|
"Cache-Control": "no-cache, no-store, must-revalidate",
|
|
24
|
-
"X-Request-Id": "
|
|
25
|
-
"X-Runtime": "0.
|
|
24
|
+
"X-Request-Id": "9cf31710-98e2-4a0e-a0e9-8c98d3044773",
|
|
25
|
+
"X-Runtime": "0.008732",
|
|
26
26
|
"Expires": "0",
|
|
27
27
|
"Content-Length": "59"
|
|
28
28
|
},
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
"resource": "Validation Errors",
|
|
41
41
|
"description": "General validation errors",
|
|
42
42
|
"route": "/api/storefront/account",
|
|
43
|
-
"
|
|
44
|
-
"
|
|
43
|
+
"http_method": "POST",
|
|
44
|
+
"explanation": " This demonstrates API responses when invalid data is submitted.\n"
|
|
45
45
|
}
|
data/lib/workarea/api/version.rb
CHANGED
data/storefront/LICENSE
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
WebLinc
|
|
2
|
+
Business Source License
|
|
3
|
+
|
|
4
|
+
Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
|
|
5
|
+
|
|
6
|
+
Licensed Work: Workarea Commerce Platform
|
|
7
|
+
The Licensed Work is (c) 2019 WebLinc Corporation
|
|
8
|
+
|
|
9
|
+
Additional Use Grant:
|
|
10
|
+
You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
|
|
11
|
+
|
|
12
|
+
A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties.
|
|
13
|
+
|
|
14
|
+
For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
|
|
15
|
+
|
|
16
|
+
Change Date: 2019-08-20
|
|
17
|
+
|
|
18
|
+
Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
|
|
19
|
+
|
|
20
|
+
Terms
|
|
21
|
+
|
|
22
|
+
The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
|
|
23
|
+
|
|
24
|
+
Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
|
|
25
|
+
|
|
26
|
+
If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
|
|
27
|
+
|
|
28
|
+
All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
|
|
29
|
+
|
|
30
|
+
You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
|
|
31
|
+
|
|
32
|
+
Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
|
|
33
|
+
|
|
34
|
+
This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
|
|
35
|
+
|
|
36
|
+
Covenants of Licensor
|
|
37
|
+
In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
|
|
38
|
+
|
|
39
|
+
To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
|
|
40
|
+
|
|
41
|
+
To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
|
|
42
|
+
|
|
43
|
+
To specify a Change Date.
|
|
44
|
+
|
|
45
|
+
Not to modify this License in any other way.
|
|
46
|
+
|
|
47
|
+
Notice
|
|
48
|
+
The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
|
|
49
|
+
|
|
50
|
+
For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
|
|
51
|
+
|
|
52
|
+
License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.
|
data/storefront/README.md
CHANGED
|
@@ -48,11 +48,8 @@ curl \
|
|
|
48
48
|
"http://yourincredibleheadlesscommercesolution.biz/api/carts.json"
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
|
|
51
|
+
License
|
|
52
|
+
--------------------------------------------------------------------------------
|
|
53
|
+
Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)
|
|
52
54
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
For licensing, contact [sales@workarea.com][].
|
|
56
|
-
|
|
57
|
-
[Workarea API]: https://homebase.weblinc.com/plugins/workarea-api-admin
|
|
58
|
-
[sales@workarea.com]: mailto:sales@workarea.com
|
|
55
|
+
[Workarea API]: https://github.com/workarea-commerce/workarea-api
|
|
@@ -3,11 +3,12 @@ require File.expand_path('../../lib/workarea/api/version', __FILE__)
|
|
|
3
3
|
Gem::Specification.new do |s|
|
|
4
4
|
s.name = 'workarea-api-storefront'
|
|
5
5
|
s.version = Workarea::Api::VERSION
|
|
6
|
-
s.authors = ['
|
|
7
|
-
s.email = ['
|
|
8
|
-
s.homepage = '
|
|
9
|
-
s.
|
|
10
|
-
s.
|
|
6
|
+
s.authors = ['Ben Crouse']
|
|
7
|
+
s.email = ['bcrouse@workarea.com']
|
|
8
|
+
s.homepage = 'https://www.workarea.com'
|
|
9
|
+
s.license = 'Business Software License'
|
|
10
|
+
s.summary = 'Storefront JSON REST API for the Workarea Commerce Platform'
|
|
11
|
+
s.description = 'This provides a storefront JSON REST API for the Workarea Commerce Platform. Useful for building apps, kiosks, etc.'
|
|
11
12
|
|
|
12
13
|
s.files = `git ls-files`.split("\n")
|
|
13
14
|
|
data/workarea-api.gemspec
CHANGED
|
@@ -6,10 +6,10 @@ Gem::Specification.new do |s|
|
|
|
6
6
|
s.name = 'workarea-api'
|
|
7
7
|
s.version = Workarea::Api::VERSION
|
|
8
8
|
s.authors = ['Ben Crouse', 'Curt Howard']
|
|
9
|
-
s.email = ['bcrouse@
|
|
9
|
+
s.email = ['bcrouse@workarea.com', 'choward@workarea.com']
|
|
10
10
|
s.homepage = 'https://github.com/workarea-commerce/workarea-api'
|
|
11
|
-
s.summary = 'API
|
|
12
|
-
s.description = '
|
|
11
|
+
s.summary = 'Adds a JSON REST API to the Workarea Commerce Platform'
|
|
12
|
+
s.description = 'This wraps gems for a storefront and admin JSON REST API for the Workarea Commerce Platform.'
|
|
13
13
|
|
|
14
14
|
s.files = `git ls-files`.split("\n")
|
|
15
15
|
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: workarea-api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 4.4.
|
|
4
|
+
version: 4.4.7
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Ben Crouse
|
|
@@ -9,7 +9,7 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date: 2019-08-
|
|
12
|
+
date: 2019-08-22 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: workarea
|
|
@@ -37,28 +37,28 @@ dependencies:
|
|
|
37
37
|
requirements:
|
|
38
38
|
- - '='
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
|
-
version: 4.4.
|
|
40
|
+
version: 4.4.7
|
|
41
41
|
type: :runtime
|
|
42
42
|
prerelease: false
|
|
43
43
|
version_requirements: !ruby/object:Gem::Requirement
|
|
44
44
|
requirements:
|
|
45
45
|
- - '='
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 4.4.
|
|
47
|
+
version: 4.4.7
|
|
48
48
|
- !ruby/object:Gem::Dependency
|
|
49
49
|
name: workarea-api-admin
|
|
50
50
|
requirement: !ruby/object:Gem::Requirement
|
|
51
51
|
requirements:
|
|
52
52
|
- - '='
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: 4.4.
|
|
54
|
+
version: 4.4.7
|
|
55
55
|
type: :runtime
|
|
56
56
|
prerelease: false
|
|
57
57
|
version_requirements: !ruby/object:Gem::Requirement
|
|
58
58
|
requirements:
|
|
59
59
|
- - '='
|
|
60
60
|
- !ruby/object:Gem::Version
|
|
61
|
-
version: 4.4.
|
|
61
|
+
version: 4.4.7
|
|
62
62
|
- !ruby/object:Gem::Dependency
|
|
63
63
|
name: raddocs
|
|
64
64
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -87,10 +87,11 @@ dependencies:
|
|
|
87
87
|
- - "~>"
|
|
88
88
|
- !ruby/object:Gem::Version
|
|
89
89
|
version: 2.0.2
|
|
90
|
-
description:
|
|
90
|
+
description: This wraps gems for a storefront and admin JSON REST API for the Workarea
|
|
91
|
+
Commerce Platform.
|
|
91
92
|
email:
|
|
92
|
-
- bcrouse@
|
|
93
|
-
- choward@
|
|
93
|
+
- bcrouse@workarea.com
|
|
94
|
+
- choward@workarea.com
|
|
94
95
|
executables: []
|
|
95
96
|
extensions: []
|
|
96
97
|
extra_rdoc_files: []
|
|
@@ -109,6 +110,7 @@ files:
|
|
|
109
110
|
- README.md
|
|
110
111
|
- Rakefile
|
|
111
112
|
- admin/.gitignore
|
|
113
|
+
- admin/LICENSE
|
|
112
114
|
- admin/README.md
|
|
113
115
|
- admin/Rakefile
|
|
114
116
|
- admin/app/assets/images/workarea/api/admin/icons/api.svg
|
|
@@ -514,6 +516,7 @@ files:
|
|
|
514
516
|
- lib/workarea/api/engine.rb
|
|
515
517
|
- lib/workarea/api/version.rb
|
|
516
518
|
- storefront/.gitignore
|
|
519
|
+
- storefront/LICENSE
|
|
517
520
|
- storefront/README.md
|
|
518
521
|
- storefront/Rakefile
|
|
519
522
|
- storefront/app/controllers/workarea/api/storefront/accounts_controller.rb
|
|
@@ -737,5 +740,5 @@ requirements: []
|
|
|
737
740
|
rubygems_version: 3.0.4
|
|
738
741
|
signing_key:
|
|
739
742
|
specification_version: 4
|
|
740
|
-
summary: API
|
|
743
|
+
summary: Adds a JSON REST API to the Workarea Commerce Platform
|
|
741
744
|
test_files: []
|