doc/api/storefront/index.json in workarea-api-4.4.7 vs doc/api/storefront/index.json in workarea-api-4.5.0
- old
+ new
@@ -1,252 +1,268 @@
{
"resources": [
{
- "name": "Categories",
+ "name": "Accounts",
"examples": [
{
- "description": "Showing a listing of categories",
- "link": "storefront/categories/showing_a_listing_of_categories.json",
+ "description": "Creating an account",
+ "link": "storefront/accounts/creating_an_account.json",
"groups": "all",
- "route": "/api/storefront/categories",
- "method": "GET"
+ "route": "/api/storefront/account",
+ "method": "POST"
},
{
- "description": "Showing a category",
- "link": "storefront/categories/showing_a_category.json",
+ "description": "Getting account details",
+ "link": "storefront/accounts/getting_account_details.json",
"groups": "all",
- "route": "/api/storefront/categories/:slug",
+ "route": "/api/storefront/account",
"method": "GET"
+ },
+ {
+ "description": "Updating an account",
+ "link": "storefront/accounts/updating_an_account.json",
+ "groups": "all",
+ "route": "/api/storefront/account",
+ "method": "POST"
}
]
},
{
- "name": "Recent views",
+ "name": "Analytics",
"examples": [
{
- "description": "Updating recent views with authentication",
- "link": "storefront/recent_views/updating_recent_views_with_authentication.json",
+ "description": "Saving a search",
+ "link": "storefront/analytics/saving_a_search.json",
"groups": "all",
- "route": "/api/storefront/recent_views",
- "method": "PATCH"
+ "route": "/api/storefront/analytics/search",
+ "method": "POST"
},
{
- "description": "Showing recent views from authentication",
- "link": "storefront/recent_views/showing_recent_views_from_authentication.json",
+ "description": "saving a category view",
+ "link": "storefront/analytics/saving_a_category_view.json",
"groups": "all",
- "route": "/api/storefront/recent_views",
- "method": "GET"
+ "route": "/api/storefront/analytics/category_view/:category_id",
+ "method": "POST"
},
{
- "description": "Showing recent views with a session_id",
- "link": "storefront/recent_views/showing_recent_views_with_a_session_id.json",
+ "description": "saving a product view",
+ "link": "storefront/analytics/saving_a_product_view.json",
"groups": "all",
- "route": "/api/storefront/recent_views",
- "method": "GET"
- },
+ "route": "/api/storefront/analytics/product_view/:product_id",
+ "method": "POST"
+ }
+ ]
+ },
+ {
+ "name": "Assets",
+ "examples": [
{
- "description": "Updating recent views with a session_id",
- "link": "storefront/recent_views/updating_recent_views_with_a_session_id.json",
+ "description": "Showing an asset",
+ "link": "storefront/assets/showing_an_asset.json",
"groups": "all",
- "route": "/api/storefront/recent_views",
- "method": "PATCH"
+ "route": "/api/storefront/assets/:id",
+ "method": "GET"
}
]
},
{
- "name": "Checkout",
+ "name": "Authentication",
"examples": [
{
- "description": "Updating a checkout",
- "link": "storefront/checkout/updating_a_checkout.json",
+ "description": "Creating an authentication token",
+ "link": "storefront/authentication/creating_an_authentication_token.json",
"groups": "all",
- "route": "/api/storefront/checkouts/:id",
- "method": "PATCH"
+ "route": "/api/storefront/authentication_tokens",
+ "method": "POST"
},
{
- "description": "Completing a checkout",
- "link": "storefront/checkout/completing_a_checkout.json",
+ "description": "Refreshing an authentication token",
+ "link": "storefront/authentication/refreshing_an_authentication_token.json",
"groups": "all",
- "route": "/api/storefront/checkouts/:id/complete",
- "method": "POST"
+ "route": "/api/storefront/authentication_tokens",
+ "method": "PATCH"
},
{
- "description": "Showing a checkout",
- "link": "storefront/checkout/showing_a_checkout.json",
+ "description": "Using an authentication token",
+ "link": "storefront/authentication/using_an_authentication_token.json",
"groups": "all",
- "route": "/api/storefront/checkouts/:id/reset",
+ "route": "/api/storefront/account",
"method": "GET"
}
]
},
{
- "name": "System Content",
+ "name": "Cart",
"examples": [
{
- "description": "Showing system content",
- "link": "storefront/system_content/showing_system_content.json",
+ "description": "Adding a promo code",
+ "link": "storefront/cart/adding_a_promo_code.json",
"groups": "all",
- "route": "/api/storefront/system_content/:name",
- "method": "GET"
+ "route": "/api/storefront/carts/:id/add_promo_code",
+ "method": "POST"
},
{
- "description": "Showing the home page",
- "link": "storefront/system_content/showing_the_home_page.json",
+ "description": "Adding an item",
+ "link": "storefront/cart/adding_an_item.json",
"groups": "all",
- "route": "/api/storefront/system_content/home_page",
- "method": "GET"
- }
- ]
- },
- {
- "name": "Email Signups",
- "examples": [
+ "route": "/api/storefront/carts/:cart_id/items",
+ "method": "POST"
+ },
{
- "description": "Creating an email signup",
- "link": "storefront/email_signups/creating_an_email_signup.json",
+ "description": "Creating a new cart for a user",
+ "link": "storefront/cart/creating_a_new_cart_for_a_user.json",
"groups": "all",
- "route": "/api/storefront/email_signups",
+ "route": "/api/storefront/carts",
"method": "POST"
},
{
- "description": "Showing an email signup content",
- "link": "storefront/email_signups/showing_an_email_signup_content.json",
+ "description": "Creating a new guest cart",
+ "link": "storefront/cart/creating_a_new_guest_cart.json",
"groups": "all",
- "route": "/api/storefront/email_signups",
- "method": "GET"
- }
- ]
- },
- {
- "name": "Searches",
- "examples": [
+ "route": "/api/storefront/carts",
+ "method": "POST"
+ },
{
- "description": "Showing search autocomplete suggestions",
- "link": "storefront/searches/showing_search_autocomplete_suggestions.json",
+ "description": "Delete an item",
+ "link": "storefront/cart/delete_an_item.json",
"groups": "all",
- "route": "/api/storefront/searches",
+ "route": "/api/storefront/carts/:cart_id/items/:id",
+ "method": "DELETE"
+ },
+ {
+ "description": "Listing user's carts",
+ "link": "storefront/cart/listing_user_s_carts.json",
+ "groups": "all",
+ "route": "/api/storefront/carts",
"method": "GET"
},
{
- "description": "Showing search results",
- "link": "storefront/searches/showing_search_results.json",
+ "description": "Showing cart",
+ "link": "storefront/cart/showing_cart.json",
"groups": "all",
- "route": "/api/storefront/search",
+ "route": "/api/storefront/carts/:id",
"method": "GET"
+ },
+ {
+ "description": "Updating an item",
+ "link": "storefront/cart/updating_an_item.json",
+ "groups": "all",
+ "route": "/api/storefront/carts/:cart_id/items/:id",
+ "method": "PATCH"
}
]
},
{
- "name": "Accounts",
+ "name": "Categories",
"examples": [
{
- "description": "Getting account details",
- "link": "storefront/accounts/getting_account_details.json",
+ "description": "Showing a category",
+ "link": "storefront/categories/showing_a_category.json",
"groups": "all",
- "route": "/api/storefront/account",
+ "route": "/api/storefront/categories/:slug",
"method": "GET"
},
{
- "description": "Creating an account",
- "link": "storefront/accounts/creating_an_account.json",
+ "description": "Showing a listing of categories",
+ "link": "storefront/categories/showing_a_listing_of_categories.json",
"groups": "all",
- "route": "/api/storefront/account",
- "method": "POST"
- },
- {
- "description": "Updating an account",
- "link": "storefront/accounts/updating_an_account.json",
- "groups": "all",
- "route": "/api/storefront/account",
- "method": "POST"
+ "route": "/api/storefront/categories",
+ "method": "GET"
}
]
},
{
- "name": "Menus",
+ "name": "Checkout",
"examples": [
{
- "description": "Showing a menu",
- "link": "storefront/menus/showing_a_menu.json",
+ "description": "Completing a checkout",
+ "link": "storefront/checkout/completing_a_checkout.json",
"groups": "all",
- "route": "/api/storefront/menus/:id",
- "method": "GET"
+ "route": "/api/storefront/checkouts/:id/complete",
+ "method": "POST"
},
{
- "description": "Listing menus",
- "link": "storefront/menus/listing_menus.json",
+ "description": "Showing a checkout",
+ "link": "storefront/checkout/showing_a_checkout.json",
"groups": "all",
- "route": "/api/storefront/menus",
+ "route": "/api/storefront/checkouts/:id",
"method": "GET"
+ },
+ {
+ "description": "Updating a checkout",
+ "link": "storefront/checkout/updating_a_checkout.json",
+ "groups": "all",
+ "route": "/api/storefront/checkouts/:id",
+ "method": "PATCH"
}
]
},
{
- "name": "Password Resets",
+ "name": "Contacts",
"examples": [
{
- "description": "Sending a forgot password email",
- "link": "storefront/password_resets/sending_a_forgot_password_email.json",
+ "description": "Creating a contact",
+ "link": "storefront/contacts/creating_a_contact.json",
"groups": "all",
- "route": "/api/storefront/password_resets",
+ "route": "/api/storefront/contacts",
"method": "POST"
}
]
},
{
- "name": "Authentication",
+ "name": "Email Signups",
"examples": [
{
- "description": "Creating an authentication token",
- "link": "storefront/authentication/creating_an_authentication_token.json",
+ "description": "Creating an email signup",
+ "link": "storefront/email_signups/creating_an_email_signup.json",
"groups": "all",
- "route": "/api/storefront/authentication_tokens",
+ "route": "/api/storefront/email_signups",
"method": "POST"
},
{
- "description": "Refreshing an authentication token",
- "link": "storefront/authentication/refreshing_an_authentication_token.json",
+ "description": "Showing an email signup content",
+ "link": "storefront/email_signups/showing_an_email_signup_content.json",
"groups": "all",
- "route": "/api/storefront/authentication_tokens",
- "method": "PATCH"
- },
- {
- "description": "Using an authentication token",
- "link": "storefront/authentication/using_an_authentication_token.json",
- "groups": "all",
- "route": "/api/storefront/account",
+ "route": "/api/storefront/email_signups",
"method": "GET"
}
]
},
{
- "name": "Contacts",
+ "name": "Menus",
"examples": [
{
- "description": "Creating a contact",
- "link": "storefront/contacts/creating_a_contact.json",
+ "description": "Listing menus",
+ "link": "storefront/menus/listing_menus.json",
"groups": "all",
- "route": "/api/storefront/contacts",
- "method": "POST"
+ "route": "/api/storefront/menus",
+ "method": "GET"
+ },
+ {
+ "description": "Showing a menu",
+ "link": "storefront/menus/showing_a_menu.json",
+ "groups": "all",
+ "route": "/api/storefront/menus/:id",
+ "method": "GET"
}
]
},
{
"name": "Orders",
"examples": [
{
- "description": "Showing an order",
- "link": "storefront/orders/showing_an_order.json",
+ "description": "Listing the user's orders",
+ "link": "storefront/orders/listing_the_user_s_orders.json",
"groups": "all",
- "route": "/api/storefront/orders/:id",
+ "route": "/api/storefront/orders",
"method": "GET"
},
{
- "description": "Listing the user's orders",
- "link": "storefront/orders/listing_the_user_s_orders.json",
+ "description": "Showing an order",
+ "link": "storefront/orders/showing_an_order.json",
"groups": "all",
- "route": "/api/storefront/orders",
+ "route": "/api/storefront/orders/:id",
"method": "GET"
}
]
},
{
@@ -260,10 +276,22 @@
"method": "GET"
}
]
},
{
+ "name": "Password Resets",
+ "examples": [
+ {
+ "description": "Sending a forgot password email",
+ "link": "storefront/password_resets/sending_a_forgot_password_email.json",
+ "groups": "all",
+ "route": "/api/storefront/password_resets",
+ "method": "POST"
+ }
+ ]
+ },
+ {
"name": "Personalized Recommendations",
"examples": [
{
"description": "Showing recommendations with a session ID",
"link": "storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json",
@@ -279,236 +307,194 @@
"method": "GET"
}
]
},
{
- "name": "Saved Addresses",
+ "name": "Products",
"examples": [
{
- "description": "Creating a saved address",
- "link": "storefront/saved_addresses/creating_a_saved_address.json",
+ "description": "Showing a product",
+ "link": "storefront/products/showing_a_product.json",
"groups": "all",
- "route": "/api/storefront/saved_addresses",
- "method": "POST"
- },
- {
- "description": "Updating a saved address",
- "link": "storefront/saved_addresses/updating_a_saved_address.json",
- "groups": "all",
- "route": "/api/storefront/saved_addresses/:id",
- "method": "PATCH"
- },
- {
- "description": "Listing the user's saved addresses",
- "link": "storefront/saved_addresses/listing_the_user_s_saved_addresses.json",
- "groups": "all",
- "route": "/api/storefront/saved_addresses",
+ "route": "/api/storefront/products/:slug",
"method": "GET"
},
{
- "description": "Showing a saved address",
- "link": "storefront/saved_addresses/showing_a_saved_address.json",
+ "description": "Showing a product with a specific SKU selected",
+ "link": "storefront/products/showing_a_product_with_a_specific_sku_selected.json",
"groups": "all",
- "route": "/api/storefront/saved_addresses/:id",
+ "route": "/api/storefront/products/:slug",
"method": "GET"
- },
- {
- "description": "Deleting a saved address",
- "link": "storefront/saved_addresses/deleting_a_saved_address.json",
- "groups": "all",
- "route": "/api/storefront/saved_addresses/:id",
- "method": "DELETE"
}
]
},
{
- "name": "Assets",
+ "name": "Recent views",
"examples": [
{
- "description": "Showing an asset",
- "link": "storefront/assets/showing_an_asset.json",
+ "description": "Showing recent views from authentication",
+ "link": "storefront/recent_views/showing_recent_views_from_authentication.json",
"groups": "all",
- "route": "/api/storefront/assets/:id",
+ "route": "/api/storefront/recent_views",
"method": "GET"
- }
- ]
- },
- {
- "name": "Validation Errors",
- "examples": [
+ },
{
- "description": "Checkout validation errors",
- "link": "storefront/validation_errors/checkout_validation_errors.json",
+ "description": "Showing recent views with a session_id",
+ "link": "storefront/recent_views/showing_recent_views_with_a_session_id.json",
"groups": "all",
- "route": "/api/storefront/checkouts/:id",
+ "route": "/api/storefront/recent_views",
+ "method": "GET"
+ },
+ {
+ "description": "Updating recent views with a session_id",
+ "link": "storefront/recent_views/updating_recent_views_with_a_session_id.json",
+ "groups": "all",
+ "route": "/api/storefront/recent_views",
"method": "PATCH"
},
{
- "description": "General validation errors",
- "link": "storefront/validation_errors/general_validation_errors.json",
+ "description": "Updating recent views with authentication",
+ "link": "storefront/recent_views/updating_recent_views_with_authentication.json",
"groups": "all",
- "route": "/api/storefront/account",
- "method": "POST"
+ "route": "/api/storefront/recent_views",
+ "method": "PATCH"
}
]
},
{
- "name": "Analytics",
+ "name": "Saved Addresses",
"examples": [
{
- "description": "Saving a search abandonment",
- "link": "storefront/analytics/saving_a_search_abandonment.json",
+ "description": "Creating a saved address",
+ "link": "storefront/saved_addresses/creating_a_saved_address.json",
"groups": "all",
- "route": "/api/storefront/analytics/search_abandonment",
+ "route": "/api/storefront/saved_addresses",
"method": "POST"
},
{
- "description": "saving a category view",
- "link": "storefront/analytics/saving_a_category_view.json",
+ "description": "Deleting a saved address",
+ "link": "storefront/saved_addresses/deleting_a_saved_address.json",
"groups": "all",
- "route": "/api/storefront/analytics/category_view/:category_id",
- "method": "POST"
+ "route": "/api/storefront/saved_addresses/:id",
+ "method": "DELETE"
},
{
- "description": "saving a product view",
- "link": "storefront/analytics/saving_a_product_view.json",
+ "description": "Listing the user's saved addresses",
+ "link": "storefront/saved_addresses/listing_the_user_s_saved_addresses.json",
"groups": "all",
- "route": "/api/storefront/analytics/product_view/:product_id",
- "method": "POST"
+ "route": "/api/storefront/saved_addresses",
+ "method": "GET"
},
{
- "description": "Saving a search",
- "link": "storefront/analytics/saving_a_search.json",
+ "description": "Showing a saved address",
+ "link": "storefront/saved_addresses/showing_a_saved_address.json",
"groups": "all",
- "route": "/api/storefront/analytics/search",
- "method": "POST"
+ "route": "/api/storefront/saved_addresses/:id",
+ "method": "GET"
},
{
- "description": "Saving filters",
- "link": "storefront/analytics/saving_filters.json",
+ "description": "Updating a saved address",
+ "link": "storefront/saved_addresses/updating_a_saved_address.json",
"groups": "all",
- "route": "/api/storefront/analytics/filters",
- "method": "POST"
+ "route": "/api/storefront/saved_addresses/:id",
+ "method": "PATCH"
}
]
},
{
- "name": "Cart",
+ "name": "Saved Credit Cards",
"examples": [
{
- "description": "Creating a new cart for a user",
- "link": "storefront/cart/creating_a_new_cart_for_a_user.json",
+ "description": "Creating a saved credit card",
+ "link": "storefront/saved_credit_cards/creating_a_saved_credit_card.json",
"groups": "all",
- "route": "/api/storefront/carts",
+ "route": "/api/storefront/saved_credit_cards",
"method": "POST"
},
{
- "description": "Showing cart",
- "link": "storefront/cart/showing_cart.json",
+ "description": "Deleting a saved credit card",
+ "link": "storefront/saved_credit_cards/deleting_a_saved_credit_card.json",
"groups": "all",
- "route": "/api/storefront/carts/:id",
- "method": "GET"
+ "route": "/api/storefront/saved_credit_cards/:id",
+ "method": "DELETE"
},
{
- "description": "Listing user's carts",
- "link": "storefront/cart/listing_user_s_carts.json",
+ "description": "Listing the user's saved credit cards",
+ "link": "storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json",
"groups": "all",
- "route": "/api/storefront/carts",
+ "route": "/api/storefront/saved_credit_cards",
"method": "GET"
},
{
- "description": "Adding a promo code",
- "link": "storefront/cart/adding_a_promo_code.json",
+ "description": "Showing a saved credit card",
+ "link": "storefront/saved_credit_cards/showing_a_saved_credit_card.json",
"groups": "all",
- "route": "/api/storefront/carts/:id/add_promo_code",
- "method": "POST"
+ "route": "/api/storefront/saved_credit_cards/:id",
+ "method": "GET"
},
{
- "description": "Delete an item",
- "link": "storefront/cart/delete_an_item.json",
+ "description": "Updating a saved credit card",
+ "link": "storefront/saved_credit_cards/updating_a_saved_credit_card.json",
"groups": "all",
- "route": "/api/storefront/carts/:cart_id/items/:id",
- "method": "DELETE"
- },
- {
- "description": "Creating a new guest cart",
- "link": "storefront/cart/creating_a_new_guest_cart.json",
- "groups": "all",
- "route": "/api/storefront/carts",
- "method": "POST"
- },
- {
- "description": "Updating an item",
- "link": "storefront/cart/updating_an_item.json",
- "groups": "all",
- "route": "/api/storefront/carts/:cart_id/items/:id",
+ "route": "/api/storefront/saved_credit_cards/:id",
"method": "PATCH"
- },
- {
- "description": "Adding an item",
- "link": "storefront/cart/adding_an_item.json",
- "groups": "all",
- "route": "/api/storefront/carts/:cart_id/items",
- "method": "POST"
}
]
},
{
- "name": "Products",
+ "name": "Searches",
"examples": [
{
- "description": "Showing a product with a specific SKU selected",
- "link": "storefront/products/showing_a_product_with_a_specific_sku_selected.json",
+ "description": "Showing search autocomplete suggestions",
+ "link": "storefront/searches/showing_search_autocomplete_suggestions.json",
"groups": "all",
- "route": "/api/storefront/products/:slug",
+ "route": "/api/storefront/searches",
"method": "GET"
},
{
- "description": "Showing a product",
- "link": "storefront/products/showing_a_product.json",
+ "description": "Showing search results",
+ "link": "storefront/searches/showing_search_results.json",
"groups": "all",
- "route": "/api/storefront/products/:slug",
+ "route": "/api/storefront/search",
"method": "GET"
}
]
},
{
- "name": "Saved Credit Cards",
+ "name": "Segmentation",
"examples": [
{
- "description": "Updating a saved credit card",
- "link": "storefront/saved_credit_cards/updating_a_saved_credit_card.json",
+ "description": "Specifying session count for segmentation",
+ "link": "storefront/segmentation/specifying_session_count_for_segmentation.json",
"groups": "all",
- "route": "/api/storefront/saved_credit_cards/:id",
- "method": "PATCH"
+ "route": "/api/storefront/system_content/home_page",
+ "method": "GET"
},
{
- "description": "Showing a saved credit card",
- "link": "storefront/saved_credit_cards/showing_a_saved_credit_card.json",
+ "description": "Using session IDs for segmenting non-authenticated users",
+ "link": "storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json",
"groups": "all",
- "route": "/api/storefront/saved_credit_cards/:id",
+ "route": "/api/storefront/system_content/home_page",
"method": "GET"
- },
+ }
+ ]
+ },
+ {
+ "name": "System Content",
+ "examples": [
{
- "description": "Creating a saved credit card",
- "link": "storefront/saved_credit_cards/creating_a_saved_credit_card.json",
+ "description": "Showing system content",
+ "link": "storefront/system_content/showing_system_content.json",
"groups": "all",
- "route": "/api/storefront/saved_credit_cards",
- "method": "POST"
+ "route": "/api/storefront/system_content/:name",
+ "method": "GET"
},
{
- "description": "Deleting a saved credit card",
- "link": "storefront/saved_credit_cards/deleting_a_saved_credit_card.json",
+ "description": "Showing the home page",
+ "link": "storefront/system_content/showing_the_home_page.json",
"groups": "all",
- "route": "/api/storefront/saved_credit_cards/:id",
- "method": "DELETE"
- },
- {
- "description": "Listing the user's saved credit cards",
- "link": "storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json",
- "groups": "all",
- "route": "/api/storefront/saved_credit_cards",
+ "route": "/api/storefront/system_content/home_page",
"method": "GET"
}
]
},
{
@@ -518,9 +504,28 @@
"description": "Showing a taxon",
"link": "storefront/taxons/showing_a_taxon.json",
"groups": "all",
"route": "/api/storefront/taxons/:id",
"method": "GET"
+ }
+ ]
+ },
+ {
+ "name": "Validation Errors",
+ "examples": [
+ {
+ "description": "Checkout validation errors",
+ "link": "storefront/validation_errors/checkout_validation_errors.json",
+ "groups": "all",
+ "route": "/api/storefront/checkouts/:id",
+ "method": "PATCH"
+ },
+ {
+ "description": "General validation errors",
+ "link": "storefront/validation_errors/general_validation_errors.json",
+ "groups": "all",
+ "route": "/api/storefront/account",
+ "method": "POST"
}
]
}
]
}
\ No newline at end of file