MCP Server and Resource Metrics
- Server URL:
https://<domain>/orchestration/mcp - Total Tools: 210
- Total Error Codes: 11
Server Overview
The MCP server provides a robust suite of 210 tools designed to streamline e-commerce operations, including account management, subscriptions, orders, payments, customer profiles, and inventory.
Tools
The following table lists the available MCP tools for Storefront Orchestration services along with their descriptions and required/optional parameters:
| Tool Name | Tool Description | Required Parameters | Optional Parameters |
|---|---|---|---|
| restBase64ImageUpload | The “Upload an Image” tool requires a valid storeId and base64 image data, returning success or error responses based on request validity. |
|
None |
| restFileImageUpload | The “Upload an Image” tool requires a valid storeId and returns JSON responses for success or various error codes. |
|
None |
| restCreateAccount | Create an account and invite a customer as an admin using specified parameters, request body, and tool responses. |
|
|
| restGetAccount | The “Load an Account” tool retrieves account details using required parameters like accountId and storeId, with responses ranging from success (200) to various error codes (400, 401, 403, 500). |
|
|
| restPatchAccount | The “Update an Account” tool allows updating account details via a JSON request, with validation and various response codes for success or errors. |
|
|
| restGetRolesOfUser | Load Roles of a Buyer Account tool retrieves user role associations based on account and store identifiers, with responses for success or various error conditions. |
|
|
| restGetAllAccountAddressRest | Retrieve all addresses associated with an account using specified parameters and handle responses including success, errors, or validation issues via the tool. |
|
|
| restCreateAccountAddressRest | Create an address for an account using path parameters, query parameters, and a JSON request body, with detailed validation and response codes. |
|
|
| restGetAccountAddressRest | Retrieve an address linked to an account using required identifiers and optional locale, with detailed responses for success or errors. |
|
|
| restPatchUpdateAccountAddressRest | Update an account’s address using path parameters, query parameters, and a JSON request body, with detailed validation and response handling. |
|
|
| restCreateApprovalWorkflowRule | Create an Approval Workflow Rule by providing required parameters and request body details, with responses indicating success or various error states. |
|
|
| restUpdateApprovalWorkflowRule | Update specific or all fields of an Approval Workflow Rule using required parameters and a tool request object, with detailed responses for success or errors. |
|
|
| restGetAllApprovalWorkflowRules | The “Load All Approval Workflow Rules” tool retrieves workflow rules based on account and store identifiers, with support for filtering, sorting, and locale customization, returning detailed responses or error codes. |
|
|
| restGetAccountAccountBuyer | Retrieve account buyer information using path and query parameters, with responses detailing success, errors, or authorization issues via the tool. |
|
|
| restGetUserCostCentres | Retrieve all cost centers of a buyer using accountId and storeId, with optional locale, and handle various response statuses. |
|
|
| restBuyerOrderAmountValidate | The tool validates a buyer’s order amount using path and query parameters, returning structured JSON responses for various status codes. |
|
|
| restGetRoles | Retrieve all roles associated with a buyer account using path and query parameters, with detailed response formats for success and error cases. |
|
|
| restGetRolesPrivileges | Load Privileges of a Buyer Role retrieves privilege details for a specified buyer role using account, role, store identifiers, and optional locale parameters, with structured responses for various status codes. |
|
|
| restGetAllPrivilegeGroups | Retrieve all privileges associated with a buyer role using account and store identifiers, with responses in specified locales via the tool. |
|
|
| restGetContract | Retrieve contract details using accountId, contractId, and optional query parameters, with responses indicating success or various errors. |
|
|
| restGetAllContracts | The “Load All Contracts” tool retrieves paginated contract data based on specified parameters, with detailed responses for success or errors. |
|
|
| restGetCostCentres | Retrieve cost centers using specified parameters, with responses detailing success, errors, or status codes, via the tool. |
|
|
| restCreateCostCentre | Create a cost center by providing account ID, store ID, locale, and cost center details in the request body, with responses indicating success or various error states. |
|
|
| restGetCostCentre | Retrieve a cost center using accountId, costCentreId, and storeId, with responses for success or various error conditions via the tool. |
|
|
| restDeleteCostCentre | Deactivate a cost center by providing required account, cost center, and store identifiers, with responses indicating success or various error states. |
|
|
| restUpdateCostCentre | Update a cost center by providing required identifiers, request body details, and handling responses for success or errors using the tool. |
|
|
| restGetAllBudgets | Retrieve all budgets using accountId, costCentreId, and storeId, with optional locale, returning detailed budget data or error responses. |
|
|
| restCreateABudgetRest | Add a budget to a cost center for a team by specifying required parameters and a JSON request, with responses indicating success or various errors. |
|
|
| restGetABudgetRest | Retrieve budget details using required account, cost center, and budget IDs, with optional locale and store ID parameters, returning success or error responses. |
|
|
| restDeleteABudgetRest | Remove a budget from a cost center for a team using specified identifiers and optional locale, with detailed response codes for success or errors. |
|
|
| restPatchUpdateBudgetRest | Update a team’s budget within a cost center using required identifiers and a JSON request, with responses indicating success or various errors. |
|
|
| restGetAllTeams | The “Load All Teams” tool retrieves team details using parameters like accountId, locale, storeId, pagination, filters, and sorting, with responses indicating success or various error states. |
|
|
| restCreateATeamRest | The “Create a Team” tool allows users to define team details via JSON input, with validation and responses for success or errors. |
|
|
| restGetATeamRest | The “Get A Team” tool retrieves team details using accountId and teamId, with optional locale and required storeId parameters, returning success or error responses in JSON format. |
|
|
| restDeleteATeamRest | Remove a team from an account using required identifiers, optional locale, and store parameters, with responses for success or various errors. |
|
|
| restPatchUpdateTeamRest | The Patch Update a Team tool allows updating team details via parameters and a JSON request body, with responses indicating success or various error states. |
|
|
| restUpdateAccount | Add a customer to a team within an account using specified parameters, request body, and handling various response codes. |
|
|
| restDeleteAccount | Remove a customer from a team within an account using specific identifiers and optional locale settings, with detailed response codes for success or errors. |
|
|
| restGetAccountAttributes | Retrieve account attributes with optional filtering, sorting, pagination, and locale settings, returning JSON responses for success or various error codes. |
|
|
| restGetAccountSettings | Load Account Settings retrieves account types and collection properties based on locale and storeId, with responses ranging from success to various error codes. |
|
|
| restGetReportAnalytics | Get Data Analytics tool provides various report types based on query parameters and returns JSON responses for success or error codes. |
|
|
| restGetReport | The “Get Report” tool retrieves various types of reports based on specified parameters like date range, grouping, filters, and store ID, with detailed response codes for success or errors. |
|
|
| restGetSubscriptionsRest | Retrieve subscription details with optional filters, sorting, pagination, and various response formats using the tool. |
|
|
| restRouteCreateSubscriptionRoute | Create a subscription without placing an order by specifying required parameters and request body in the tool. |
|
|
| restGetSubscriptionByIdRest | Fetch subscription details by ID using path and query parameters, with various response codes for success or errors. |
|
|
| restUpdateSubscriptionByIdRest | Update a subscription by providing required identifiers, subscription data, and handling various response statuses through the tool. |
|
|
| restRouteCreateMultipleSubscription Route |
Add items to an existing subscription by specifying required parameters and JSON request body, with detailed response codes for success or errors. |
|
|
| restDeleteSubscriptionItem | Delete a subscription item by its item ID using specified parameters, with various response codes indicating success or errors. |
|
|
| restUpdateSubscriptionItemRoute | Update a subscription item by providing required identifiers, optional parameters, and request details, with responses indicating success or various error states. |
|
|
| restSubscriptionItem SkipNextOrderRest |
The “Subscription Item Skip Next Order” tool allows skipping the next order for a subscription item using required parameters and provides various response codes for success or errors. |
|
|
| restSubscriptionBulkItem SkipNextOrderRest |
The tool allows skipping the next order for a subscription using required parameters and provides various response codes for success or errors. |
|
|
| restSubscriptionSkipNextOrderRest | The “Subscription Skip Next Order” tool allows skipping the next order for a subscription using required parameters and provides various response codes for success or errors. |
|
|
| restSubscriptionFrequencyTypesRest | Retrieve subscription frequency types using storeId and locale, with detailed success and error response formats for various HTTP status codes. |
|
|
| restGetActiveAndLiveSubscriptionRest | Retrieve active and live subscription counts with optional promotion details using locale and store identifiers via the tool. |
|
|
| restUserSubscriptionGetByIdRest | Retrieve user subscription details by ID using path and query parameters, with various response codes and properties. |
|
|
| restSubscriptionPreference PlaceOrderv1Rest |
Process subscription orders for the current month using preference ID, with detailed parameters and response codes for various outcomes in the tool. |
|
|
| restUserSubscriptionPatchByIdRest | Updates a user subscription by ID using path, query parameters, and request body data, with various response codes and JSON outputs. |
|
|
| restGetSubscriptionAddressRest | Retrieve a user’s subscription address using required identifiers and optional locale settings, with detailed response formats and error handling. |
|
|
| restValidateAddress GetShippingMethodRest |
This tool validates subscription addresses and retrieves shipping methods based on user preferences and provided parameters. |
|
|
| restSubscriptionPreference PlaceOrderRest |
Process subscription orders for the current month using preference ID, with various parameters and response codes for success or errors. |
|
|
| restUpdateAllSubscription ByUserIdRest |
Update all subscriptions by user ID with optional query filters, locale, and store details, returning success or error responses in JSON format. |
|
|
| restGetOrders | Retrieve all orders based on filters, sorting, pagination, and store ID, with detailed responses for success or errors. |
|
|
| restGetOrderById | Load an order using path and query parameters to retrieve detailed order, customer, and financial information, with various response codes for success or errors via the tool. |
|
|
| restCancelOrderRest | Cancel an order by providing required parameters and request body, with responses indicating success or various error states. |
|
|
| restUpdateOrderByIdRest | The “Change Status for B2B Approval Workflow” tool updates order status and properties based on provided parameters and returns detailed responses for success or errors. |
|
|
| restCancelOrderItemRest | Cancel an order item by providing required IDs, store details, reason, and quantity via a tool request. |
|
|
| restReturnOrderItemRest | The Return Order Item tool facilitates returning an order item using unique IDs, store details, and reason inputs, with responses indicating success or specific errors. |
|
|
| restReturnOrderRest | The “Return an Order” tool processes order returns using path, query parameters, and a JSON request body, with varied response codes indicating success or errors. |
|
|
| restGetSellerOrders | Retrieve seller orders using filters, sorting, pagination, and store details, with responses for success, bad request, unauthorized access, or not found errors. |
|
|
| restGetCatalogInventory | Retrieve inventory details using query parameters like locale, storeId, mode, page, and size, with responses ranging from success (200) to various error codes (400, 401, 403, 500). |
|
|
| restGetInventoryTransaction | Retrieve transaction data using query parameters like locale, skuId, storeId, mode, page, and size, with detailed response codes and examples. |
|
|
| restGetLoyaltyById | The “Load a Loyalty Rewards Bank” tool provides localized responses, requires a store identifier, and returns detailed user loyalty data, with various success and error codes. |
|
|
| restGetAllTransactions | The “Find All Transactions” tool retrieves transaction details based on query parameters like locale, storeId, sorting, filters, pagination, and size, with various response codes indicating success or errors. |
|
|
| restGetAllTemplates | Retrieve all templates with query parameters for locale, storeId, pagination, and responses detailing success or various error codes. |
|
|
| restGetTemplateById | Fetch a template by ID using query parameters like locale, siteDomain, and mode, with various response codes indicating success or errors. |
|
None |
| restCreatePublishSellersite | Switch between draft and live content of the wizard using query parameters like locale and storeId, with detailed response codes for success or errors. |
|
|
| restDeleteConfigRest | This tool provides locale-specific responses and error handling for store-related queries, with success (204) and various error codes (400, 401, 403, 500). |
|
|
| restGetSellerSite | The “Get Site Data” tool retrieves site-related information based on query parameters and returns JSON responses for success or various error codes. |
|
|
| restCreateSellerSite | Configure seller site data using query parameters and request body, with responses ranging from success to various error codes. |
|
|
| restGetStoreAssociationProperties | The “Load a Store” tool retrieves store details and associations using query parameters like locale and storeId, with responses ranging from success (200) to various error codes (400, 401, 403, 500). |
|
|
| restGetCarts | Retrieve all carts with filtering, sorting, pagination, and locale options using a store identifier, returning success or error responses in JSON format. |
|
|
| restGetCartByType | The “Get Calculated Cart” tool retrieves detailed cart information based on parameters like cart type, locale, and store ID, with varied response codes for success or errors. |
|
|
| restCreateCartByType | Create a cart by specifying cart type, store ID, and optional locale, with detailed request and response properties for managing cart items, promotions, payments, and more using the tool. |
|
|
| restDeleteCartByType | The “Delete a Cart” tool requires cartType and storeId parameters, supports optional locale, and provides various HTTP responses for success or errors. |
|
|
| restUpdateCartByType | The “Update Cart Attributes” tool allows updating cart details based on cart type, store ID, and optional locale, with structured JSON input and detailed response codes. |
|
|
| routePatchBuyerAdminCartItem | Buyer Admin can update a cart item using required parameters, JSON request body, and various response codes for success or errors via the tool. |
|
|
| restDeleteB2BItemFromBagById | The tool allows deletion of a cart item using required parameters and provides various response codes for success or errors. |
|
|
| restUpdateBuyerBagItemById | Update a B2B buyer’s user cart item by specifying required parameters, request body details, and handling various tool response codes. |
|
|
| restDeleteCartSubscription | Delete a subscription from a user’s cart using required parameters, with responses ranging from success (202) to various error codes (400-500). |
|
|
| restGetAllCartItemsByType | The “Get All Cart Items” tool retrieves detailed information about items in a user’s cart based on mandatory parameters like cartType and storeId, with optional locale support. |
|
|
| restAddItemsToBagByType | The “Add Multiple Cart Items” tool allows users to add multiple items to a cart using detailed parameters, request body, and response formats. |
|
|
| restDeleteAllItemsFromBag ByCartType |
The “Delete All Cart Items” tool removes all items from a user cart, requiring cartType and storeId parameters, with various response codes for success or errors. |
|
|
| restGetCartItemById | Retrieve detailed information about a specific cart item using required parameters like cartType and itemId, with optional query parameters and various response codes. |
|
|
| restDeleteItemFromBagById | Delete a cart item using required parameters like cartType and itemId, with optional locale and storeId, returning success or error responses. |
|
|
| restUpdateBagItemById | Update a cart item by specifying required parameters, request body details, and handling various tool responses for success or errors. |
|
|
| addItemToBagByType | The “Add Single Cart Item” tool allows adding a product to a user cart with required parameters and provides detailed responses for success or errors. |
|
|
| restDeleteAllCartLoyaltyRewards | Delete all loyalty rewards from a user cart using required parameters like cart type and store ID, with locale support and detailed response codes. |
|
|
| restDeleteCartLoyaltyReward | Delete a loyalty reward from a user cart using required parameters, with responses indicating success or various error codes. |
|
|
| restGetCartPaymentsRest | Retrieve all payment details in a user cart using specified parameters and handle various response statuses. |
|
|
| restCreateCartPayments | This tool enables adding multiple payments to a cart by specifying required parameters and payment details in JSON format, with various response codes for success or errors. |
|
|
| restDeleteCartPayments | Delete all payments from a user cart using required parameters like cartType and storeId, with locale support and detailed error responses. |
|
|
| AllPatchPaymentRest | Update multiple payments in a user’s cart by specifying required parameters and payment details using the tool. |
|
|
| restGetCartPaymentByPaymentId | Retrieve payment details in a user cart using mandatory parameters and optional locale settings, with structured responses for success or errors. |
|
|
| restDeleteCartPaymentById | Delete a payment from a user cart using required parameters and handle responses for success or various errors via the tool. |
|
|
| restUpdateCartPaymentById | Update a payment in a cart involves specifying required parameters, payment details, and handling various response codes using the tool. |
|
|
| restGetAllPromocodesFromBag | Retrieve all promocodes in a cart using required parameters like cartType and storeId, with optional locale, and handle various response statuses. |
|
|
| restAddPromocodesToBag | The tool allows adding multiple promocodes to a user cart using specified parameters and JSON request body, with detailed response codes for success or errors. |
|
|
| restDeleteAllPromocodesFromBag | Delete all promocodes from a user cart using required parameters like cartType and storeId, with locale as optional, returning appropriate success or error responses. |
|
|
| getPromocodeFromBag | Retrieve a promocode from a user cart using required parameters and handle various response statuses. |
|
|
| restDeletePromocodeFromBag | Delete a promocode from a user cart using required parameters, with responses ranging from success to various error codes. |
|
|
| routeSinglePageCheckout | Cart Quick Checkout enables adding items to a user cart with detailed parameters, request body, and response handling using the tool. |
|
|
| restGetOrderConfirmation | Retrieve order confirmation details using cart type, store ID, and optional locale parameters, with various response codes for success or errors. |
|
|
| restCreateOrderForCart | Create an order from a cart by specifying required parameters, handling locale settings, and receiving detailed responses for success or errors via the tool. |
|
|
| restGetSellerCartByType | The “Seller Get Calculated Cart” tool retrieves detailed cart information based on parameters like cart type, locale, store ID, and mode, with various response codes indicating success or errors. |
|
|
| restUpdateSellerCartByType | The Seller Update Cart Attributes tool allows updating cart details based on cart type, with parameters for locale, store, domain, mode, and a detailed JSON request body, returning various success or error responses. |
|
|
| restAddSellerItemsToBagByType | The tool enables sellers to add multiple items to a user’s cart, specifying details like quantity, promotions, and delivery options, with structured request and response formats. |
|
|
| restDeleteSellerItemFromBagById | Seller Delete a Cart Item tool allows removing an item from a user’s cart using required parameters and returns appropriate success or error responses. |
|
|
| restUpdateSellerBagItemById | The tool allows sellers to update cart items using specified parameters, request body details, and handles responses for various status codes. |
|
|
| restCreateSellerCartPayments | Allows sellers to add multiple payments to a cart using a detailed tool request structure and response handling. |
|
|
| restDeleteSellerCartPayments | The tool allows sellers to delete all payments from a user cart, with various parameters and response codes for validation and errors. |
|
|
| restGetSellerOrderConfirmation | The “Seller Get an Order Confirmation” tool retrieves detailed cart information based on parameters like cartType, locale, storeId, and domain, with various success and error responses. |
|
|
| restCreateSellerOrderForCart | Sellers can create an order from a user cart by providing required parameters, request body, and handling various tool responses. |
|
|
| restCreateSubscriptionsRest | The “Create Subscription” tool allows creating subscriptions with locale and storeId parameters, returning various JSON responses based on success or error codes. |
|
|
| restFindFirstDeliveryDateRest | The tool returns the first delivery date based on locale, store ID, and requested delivery date, with detailed success and error response formats. |
|
|
| restUpdateB2BCartStatusByType | Update the B2B Approval Cart tool by providing required parameters and JSON request body, with responses ranging from success (200) to various error codes (400-500). |
|
|
| getQuoteCarts | Retrieve all quote carts using query parameters like filter, sort, pagination, storeId, size, and locale, with various response codes indicating success or errors. |
|
|
| restGetAllList | Retrieve paginated lists based on parameters like page, size, locale, storeId, type, and name, with detailed success and error responses. |
|
|
| restCreateList | Create a list by providing required details like name, type, and itemType in JSON format, with various response codes indicating success or errors. |
|
|
| restGetListById | Retrieve a list using mandatory identifiers and optional locale, with detailed response properties and error handling for various scenarios. |
|
|
| restDeleteListById | Delete a list using its unique ID, with optional locale and required store ID, returning success or detailed error responses. |
|
|
| restUpdateListById | Update a list by providing required identifiers, editable fields, and JSON-formatted details, with responses indicating success or errors. |
|
|
| restGetListItems | Retrieve all items from a specified list using required parameters like listId, storeId, page, size, and optional filters, sorting, or locale settings, with paginated JSON responses. |
|
|
| restCreateListItems | Add items to a specified list using a tool with required parameters and JSON-formatted request body, returning success or error responses. |
|
|
| restGetListItemById | Retrieve a specific item from a list using required identifiers and optional locale or store details, with JSON responses for success. |
|
|
| restDeleteListItemById | Delete an item from a list using specified parameters, with responses indicating success or various errors. |
|
|
| restUpdateListItemById | Update an item in a list by specifying mandatory IDs, optional locale, store details, and JSON request body, with responses indicating success or updates. |
|
|
| restShareListById | The tool allows sharing a list by specifying list details, recipients, and locale, with responses confirming success or providing the shared list data. |
|
|
| restGetCategoryById | The tool loads category lists based on parameters like category ID, locale, store ID, hierarchy level, and includes parent categories, with responses ranging from success to various error codes. |
|
|
| restGetProductList | Retrieve all products of a category using specified parameters and handle responses for success or errors. |
|
|
| restFindAllImageAssetsRest | Retrieve image assets with optional filters, pagination, and locale settings via the tool, returning success or error responses. |
|
|
| restGetProductById | The “Load a Product” tool retrieves product details using path and query parameters, with various response codes indicating success or errors. |
|
|
| restGetProductByIdAndPromotion | Retrieve promotions for special products using various parameters and request body, with detailed response codes and examples. |
|
|
| restFetchPromoMessages | Retrieve promotion messages for products using a tool with specified locale and store ID, returning success or error responses. |
|
|
| restSearch | The “Load Products by Search Term” tool retrieves product details based on search criteria, filters, sorting, and pagination, with detailed responses for success or various error scenarios. |
|
|
| restGetSellerProductList | Retrieve all seller products within a category using specified parameters and filters via the tool. |
|
|
| restGetSellerBundleProducts | Retrieve bundle product details for a seller using query parameters like locale, storeId, layout, domain, mode, page, and size, with various response codes. |
|
|
| restCreateSellerBundleProduct | Create a bundle product for a seller using specified parameters and return appropriate tool responses. |
|
|
| restGetSellerHomePageProducts | Retrieve product details for a seller using specified parameters and handle various response statuses via the tool. |
|
|
| restCreateSellerProduct | Create a product for a seller using specified parameters and handle responses for success or various errors via the tool. |
|
|
| restGetSellerProductById | The “Load a Seller Product” tool retrieves product details using path and query parameters, returning JSON responses for success or various error codes. |
|
|
| restSellerSearch | The tool retrieves seller products based on search terms, filters, sorting, and pagination, with detailed response handling for success and error scenarios. |
|
|
| restGetProductBySemanticId | Semantic for Storefront is a tool that retrieves category, product, or SKU details based on semantic identifiers, supporting localization and store-specific configurations with detailed response codes. |
|
|
| restGetSuggestion | Load Suggestions by Search Term tool provides search term suggestions, corrections, and error responses based on query parameters and validation. |
|
|
| Get_all_locations | Retrieve all locations with various query parameters and detailed response handling using the tool. |
|
|
| restSubscriptionPlaceOrderRest | Create a subscription recurrence order by ID using required parameters and a tool response with detailed status codes. |
|
|
| restGetSubscriptionSummaryByIdRest | Retrieve a user’s subscription summary using the subscription ID and optional query parameters via the tool, with detailed responses for success or error cases. |
|
|
| restGetRatingsReviewsRest | Retrieve ratings and reviews with optional hashtags, summaries, sorting, filtering, pagination, and localized responses using the tool. |
|
|
| restUploadImageToCreatedReviewRest | Upload images to a rating and review by specifying path and query parameters, with detailed response codes and properties for success or errors in the tool. |
|
|
| restRouteRatingQuestions AndAnswersRest |
This tool enables creating questions and answers using specified parameters, request body, and structured JSON responses for various HTTP statuses. |
|
|
| restGetAllAnswersForQuestion | Retrieve all answers for a specific question using parameters like locale, sorting, pagination, and handle responses for success or various errors via the tool. |
|
|
| restRouteRatingAnswers ForQuestionRest |
A tool endpoint to create answers for a question using path, query parameters, and a JSON request body, with detailed response codes and examples. |
|
|
| restGetRatingsReviewsByIdRest | Fetch a rating and review by its ID, with optional locale customization and detailed response/error handling. |
|
|
| restCreateReviewRest | Create a rating and review with classification using a JSON request and locale-based tool responses. |
|
|
| restCreateReviewFeedbackRest | The “Create a Review Feedback” tool allows submitting feedback data via JSON, with responses ranging from success (200, 201) to various error codes (400-500). |
|
|
| restGetAllQestions | The “Get All Questions” tool retrieves paginated question and answer data with optional locale and item ID parameters, returning success or various error responses. |
|
|
| restGetAllRatingsSummaryRest | The tool provides rating summaries with sorting, filtering, pagination, and locale options, returning JSON responses for success or various error codes. |
|
|
| restRouteVotes | Create a vote by providing question, answer, user IDs, and vote type in the request body, with detailed responses for success or errors using the tool. |
|
|
| restRouteGetVotes | Retrieve vote counts (likes and unlikes) for an answer using specified parameters via the tool. |
|
|
| restGetCustomer | The “Load a Customer” tool retrieves customer details using query parameters and provides responses for success or various error scenarios. |
|
|
| restCreateCustomer | The “Create a Customer” tool allows customer creation with detailed parameters, request body, and response codes for success or errors. |
|
|
| restDeleteCustomer | Delete a customer using the tool with locale and storeId parameters, returning success or detailed error responses. |
|
|
| restUpdateCustomer | Update a customer by providing required store ID, optional locale, and customer details in JSON format, with responses indicating success or various error states. |
|
|
| restSendActivationRequest | Generate an activation token for a user by providing locale, storeId, and user details, with responses indicating success or various errors. |
|
|
| restActivateCustomer | Validate an activation parameter using locale, storeId, and customer details, with structured responses for success or various errors via the tool. |
|
|
| restGetCustomerAddress | Retrieve all customer addresses using query parameters and return detailed responses or error messages via the tool. |
|
|
| restCreateCustomerAddress | Add a customer’s address with required fields like storeId and zip, using a JSON request object, and receive responses for success, errors, or validation issues via the tool. |
|
|
| restGetCustomerAddressById | Fetch customer address details using path and query parameters, with various response codes and validation rules. |
|
|
| restDeleteCustomerAddress | Delete a customer’s address using the required addressId and storeId parameters, with locale support and detailed response codes. |
|
|
| restUpdateCustomerAddress | Update a customer’s address by providing required identifiers, address details, and validation parameters through the tool. |
|
|
| restAddSellerRoleToBAUser | Add a seller role to a BA user using the tool, with locale and storeId parameters, and responses ranging from success (200) to various error codes (400, 401, 403, 500). |
|
|
| restExport | Export customer profile information using query parameters like locale and storeId, with detailed tool response codes for success or errors. |
|
|
| restLogin | The Customer Login tool facilitates user authentication via query parameters, request body, and provides detailed responses for success or error scenarios. |
|
|
| restLogout | Customer Logout tool allows users to log out with locale and storeId parameters, returning various HTTP responses based on request validity. |
|
|
| restUpdateRewardsOptIn | Create loyalty rewards based on opt-in value using locale and storeId parameters, with detailed response handling for success or errors. |
|
|
| restUpdatePassword | Update a customer’s password by providing old, new, and confirmed passwords, with responses indicating success or specific errors. |
|
|
| restGetAllPayment | Load Payments of a Customer tool retrieves payment details based on query parameters and returns structured responses for success or error scenarios. |
|
|
| restCreatePaymentRest | Add a customer’s payment by specifying required details like store ID, payment type, and status, with responses indicating success or errors. |
|
|
| restGetUserPaymentById | Fetch customer payment details using path and query parameters, with responses indicating success or various error codes. |
|
|
| restDeletePayment | Delete a customer’s payment using the payment ID and store ID, with optional locale, returning various status codes based on the tool’s response. |
|
|
| restUpdatePayment | Update a customer’s payment details using the tool with specified parameters and request body, returning appropriate responses based on success or errors. |
|
|
| restGetPaymentsTokens | Retrieve customer payment tokens using query parameters like locale, storeId, and type, with detailed success and error responses. |
|
|
| restResetPassword | Reset a password by providing required parameters and customer identity information, with responses indicating success or specific errors. |
|
|
| restValidateResetPassword | The Validate Reset Password tool verifies customer-provided reset parameters and passwords, returning success or error responses based on validation. |
|
|
| restUpdatePassword BySecurityQuestions |
Reset Password by Security Questions tool enables password updates using security questions, customer identity, and validation mechanisms with detailed response codes. |
|
|
| restCreateSession | The “Create a Session” tool establishes a session using required parameters like storeId and userId, returning session details or error responses in JSON format. |
|
|
| getSessionPropertiesRouteRest | Load authorization details using the Processor class, with query parameters for user inclusion and detailed response/error structures. | None |
|
| oAuthAuthorizeRouteRest | The “Authorize Client” tool handles client authorization via required query parameters and provides JSON responses for success, errors, or server issues. |
|
|
| refreshSessionAuthRouteRest | The refresh session tool provides responses for various status codes, including success, client errors, and server errors, with detailed JSON structures. | None |
|
| routeGetPaymentOptionsRest | Retrieve all payment options with specified parameters, returning success or error responses in JSON format. |
|
|
| routeRegisterPaymentRest | Register a payment using specified parameters and request body, with detailed response codes and properties for success or errors. |
|
|
| getRecommendedAlsoProductsRest | Load a list of products for recommendation based on query parameters like locale, storeId, and productIds, with detailed response handling for success and error scenarios. |
|
|
| getSchemaOrgCategoryByIdRest | Load All Category Lists tool retrieves category data based on parameters like locale, storeId, hierarchy level, and includes parent categories, with various response codes for success or errors. |
|
|
| getSchemaOrgProductListRest | Retrieve all products of a category using specified parameters like categoryId, storeId, filters, and pagination, with detailed response handling. |
|
|
| getSchemaOrgProductByIdRest | The “Load a Product” tool retrieves product details using path and query parameters, returning JSON responses for success or various error codes. |
|
|
| getSchemaOrgPromotionsfor ProductsRest |
A tool for fetching product promotions using parameters like productId, storeId, and locale, with detailed responses for success or various errors. |
|
|
| getSchemaOrgListOfProductsRest | Fetch a list of products using query parameters like locale, storeId, and productIds, with responses ranging from success (200) to various error codes (400, 401, 403, 500). |
|
|
| getSchemaOrgSearchRest | The tool retrieves products based on search terms, filters, sorting, and pagination, with detailed response codes for success or errors. |
|
|
| shipmentTrackingRouteRest | This tool allows tracking parcels using shipping or parcel references, with customizable locale and store identifiers. |
|
|
| ping | The tool’s ping response returns a 200 status with plain text content. | None | None |
| clearCache | The “Clear SFO Cache” tool clears store or cart cache using specified query parameters and returns a 200 (Success) response. |
|
|
Error Responses
The table below lists standard error codes with their corresponding descriptions for API responses:
| Error Code | Error Description |
|---|---|
| 200 | (Success): Output type |
| 201 | (Success): Created Successfully |
| 202 | Updated Successfully |
| 204 | (Success): Success |
| 400 | Bad Request |
| 401 | UnAuthorized |
| 403 | Forbidden |
| 404 | Page Not Found |
| 409 | Conflict |
| 422 | Not Ok |
| 500 | Server Error |
Useful Resources
- API Specifications: API Endpoints – Storefront Orchestration
- Services Details: Storefront Orchestration Services
Revision History
2025-11-19 | JP – Updated domain
2025-09-29 | SD – Page created and content added