Dropshipping for eBay, Amazon and Shopify: products, listings, prices, stock, orders and analytics.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Adds a pricing rule for one visible store. Requires confirmed=true and impactConfirmed=true because pricing rules can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
WAPI PricingRulesRequest body: SourceId, PriceFrom, PriceTo, Markup, MarkupFixed.
Must be true after the user explicitly requested or confirmed the exact action.
ChannelOAuthId returned by hgr_list_channels for the selected visible store.
Must be true after the user explicitly confirmed the concrete high-impact consequences.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
Adds a pricing rule for one visible store. Requires confirmed=true and impactConfirmed=true because pricing rules can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI PricingRulesRequest body: SourceId, PriceFrom, PriceTo, Markup, MarkupFixed. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI PricingRulesRequest body: SourceId, PriceFrom, PriceTo, Markup, MarkupFixed."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Adds a Virtual Assistant / VA profile. Requires confirmed=true.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI AddRequest body: Name. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
{
"type": "object",
"required": [
"body",
"confirmed"
],
"properties": {
"body": {
"description": "WAPI AddRequest body: Name."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
}
},
"additionalProperties": false
}Changes AI Publisher automation status for one visible store. Requires confirmed=true and impactConfirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI AI Publisher status body: Id, Status. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI AI Publisher status body: Id, Status."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Creates/activates the default AI Publisher automation for one visible store. Requires confirmed=true and impactConfirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Creates a text-only support ticket. File attachments are blocked by MCP policy. Requires confirmed=true.
| Argument | Type | Description |
|---|---|---|
| message* | string | Message body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact support message. |
{
"type": "object",
"required": [
"message",
"confirmed"
],
"properties": {
"message": {
"type": "string",
"description": "Message body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact support message."
}
},
"additionalProperties": false
}Deletes/deactivates a pricing rule for one visible store. Requires confirmed=true and impactConfirmed=true because pricing rules can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI PricingRulesDeleteRequest body: RuleId, Active. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI PricingRulesDeleteRequest body: RuleId, Active."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Forces processing for orders resolved from visible order Reference. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Requests ForceRefresh for visible Product IDs. This confirms the request, not an immediate visible stock or price update. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. |
| productIds | array | Visible marketplace Product Id / primary id values. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| variationProductId | string | Visible variation Product Id / primary id when needed. |
| variationProductIds | array | Visible variation Product Id / primary id values when needed. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id."
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Visible marketplace Product Id / primary id values."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"variationProductId": {
"type": "string",
"description": "Visible variation Product Id / primary id when needed."
},
"variationProductIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Visible variation Product Id / primary id values when needed."
}
},
"additionalProperties": false
}Generates the only product CSV allowed by MCP policy. It returns plain CSV text, not a downloadable file, and only includes the HGRWeb report columns: eBay item ID, sku, stock, cost price and selling price. Requires explicit productIds and confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested the limited HGRWeb-style product CSV. |
| productIds* | array | Explicit visible Product Id / primary id values to include. Required; the MCP does not generate all-store product export files. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"productIds",
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested the limited HGRWeb-style product CSV."
},
"productIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Explicit visible Product Id / primary id values to include. Required; the MCP does not generate all-store product export files."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Generates HGR tracking for exact order lines when WAPI allows it. The MCP checks current WAPI order status and current WAPI fee data before executing. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Lists active listings for the selected visible store/channel. Use this for store-wide active listing/product questions, including most expensive products/listings, cheapest products/listings, stock checks, price ranking, source/supplier usage and other active listing aggregation. First resolve the store with hgr_list_channels, then call this tool using channelOAuthId from the selected store. For rankings, filtering and summaries, pass fields/sortBy/sortDirection/limit directly to this tool and answer from its response. For product source/supplier questions, request the source field when available; source means supplier/source marketplace. Use sourceId only to resolve visible supplier/source names. Do not use origin for source/supplier questions: origin means listing creation mechanism such as Catalog, BulkLister, WeListForYou, Extension, AI Publisher or AI Agent. The response can be a compact schema/data payload: interpret each data row by matching positions with schema; this is not an error and does not require a second pass. Public replies use visible product ids and marketplace references. Do not use this tool to construct CSV, XML, XLSX, feed or bulk export files. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| page | integer | One-based page number. |
| limit | integer | Maximum number of rows to return. HGRApi maximum is 10000. |
| fields | array | Fields to return. Use projection for compact answers. |
| offset | integer | Zero-based row offset. |
| sortBy |
Reads affiliate dashboard summary.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads affiliate monthly dashboard summary.
| Argument | Type | Description |
|---|---|---|
| year | integer | Optional year number accepted by WAPI. |
| month | integer | Optional month number accepted by WAPI. |
{
"type": "object",
"properties": {
"year": {
"type": "integer",
"description": "Optional year number accepted by WAPI."
},
"month": {
"type": "integer",
"description": "Optional month number accepted by WAPI."
}
},
"additionalProperties": false
}Reads affiliate withdrawal history. Changing withdrawal method must be done in HGRWeb.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads AI Agent configuration for one visible store. AI Agent is distinct from AI Publisher. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads AI Agent dashboard and maturity metrics for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/AI/GetTasks. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get tasks operation in AI optimization task management. Use when: Use it when a client needs to run the get tasks operation for AI optimization task management. Input: No explicit input parameters required. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get tasks operation. Search terms: ai gettasks. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads AI Publisher filters/automation configuration for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI filters request body with Status values. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI filters request body with Status values."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads AI Publisher history for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI AI Publisher history request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI AI Publisher history request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Analytics/BeingWatched. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET being watched operation in current-channel watcher analytics. Use when: Use it when a client needs to run the being watched operation for current-channel watcher analytics. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the being watched operation. Search terms: analytics beingwatched. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Analytics/GetWatchers. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get watchers operation in current-channel watcher analytics. Use when: Use it when a client needs to run the get watchers operation for current-channel watcher analytics. Input: [FromQuery] minutes: int?. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get watchers operation. Search terms: analytics getwatchers. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| minutes | integer | HGRApi query parameter minutes. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"minutes": {
"type": "integer",
"description": "HGRApi query parameter minutes."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Analytics/ProductsNotBeingWatched. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET products not being watched operation in current-channel watcher analytics. Use when: Use it when a client needs to run the products not being watched operation for current-channel watcher analytics. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the products not being watched operation. Search terms: analytics productsnotbeingwatched. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads the authenticated HGR user profile visible to the web app.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads current auto-ordering fees from WAPI.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads auto-ordering configuration from WAPI for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Secret fields are redacted before returning.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Catalog/GetProductSource. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get product source operation in catalog/source candidate discovery or publication. Use when: Use it when a client needs to run the get product source operation for catalog/source candidate discovery or publication. Input: id: int. Output: Returns the result or applies the effect of the get product source operation. Search terms: catalog getproductsource. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Catalog/NewGetListingStatus. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns recent catalog publication jobs and their listing results. ownerAgent: publication. Use when: Use to inspect recorded publication status or errors, not to discover supplier products. Input: Header channel identifies the selected store. No body. Output: Returns job status and listing status/error data with EnumValues. Url identifies new publications even before ProductSourceId resolution; ProductSourceId remains available for legacy clients. ListingStatus.Status is a bitmask and can combine flags. Search terms: catalog newgetlistingstatus. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads store/channel configuration for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/ChannelListing/getCategoryInfo. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get category info operation in published product creation and optimization. Use when: Use it when a client needs to run the get category info operation for published product creation and optimization. Input: [FromQuery] id: string. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get category info operation. Search terms: channellisting getcategoryinfo. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| id* | string | HGRApi query parameter id. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"id",
"channelOAuthId"
],
"properties": {
"id": {
"type": "string",
"description": "HGRApi query parameter id."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/ChannelListing/getCustomCategories. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get custom categories operation in published product creation and optimization. Use when: Use it when a client needs to run the get custom categories operation for published product creation and optimization. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get custom categories operation. Search terms: channellisting getcustomcategories. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/ChannelListing/getSettings. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get settings operation in published product creation and optimization. Use when: Use it when a client needs to run the get settings operation for published product creation and optimization. Input: [FromQuery] sourceId: int. [FromQuery] sourcePrice: decimal. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get settings operation. Search terms: channellisting getsettings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| sourceId* | integer | HGRApi query parameter sourceId. |
| sourcePrice* | number | HGRApi query parameter sourcePrice. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"sourceId",
"sourcePrice",
"channelOAuthId"
],
"properties": {
"sourceId": {
"type": "integer",
"description": "HGRApi query parameter sourceId."
},
"sourcePrice": {
"type": "number",
"description": "HGRApi query parameter sourcePrice."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/ChannelListing/isBrandInVeRoList. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET is brand in ve ro list operation in published product creation and optimization. Use when: Use it when a client needs to run the is brand in ve ro list operation for published product creation and optimization. Input: [FromQuery] brand: string. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the is brand in ve ro list operation. Search terms: channellisting isbrandinverolist. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| brand* | string | HGRApi query parameter brand. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"brand",
"channelOAuthId"
],
"properties": {
"brand": {
"type": "string",
"description": "HGRApi query parameter brand."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads effective supplier settings after store defaults and supplier overrides. This is settings data, not supplier availability or listing usage data. Boolean monitoring settings do not enable or disable a supplier. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetAffiliateStatistics/{period}/{from}/{to}. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get affiliate statistics operation in dashboard data. Use when: Use it when a client needs to run the get affiliate statistics operation for dashboard data. Input: [FromRoute] period: ePeriod. [FromRoute] from: DateTime?. [FromRoute] to: DateTime?. Output: Returns the result or applies the effect of the get affiliate statistics operation. Search terms: dashboard getaffiliatestatistics period from to.
| Argument | Type | Description |
|---|---|---|
| to* | string | HGRApi route parameter to. |
| from* | string | HGRApi route parameter from. |
| period* | string | HGRApi route parameter period. |
{
"type": "object",
"required": [
"period",
"from",
"to"
],
"properties": {
"to": {
"type": "string",
"description": "HGRApi route parameter to."
},
"from": {
"type": "string",
"description": "HGRApi route parameter from."
},
"period": {
"type": "string",
"description": "HGRApi route parameter period."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetListingServices. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Lists publication services purchased by the user. ownerAgent: account-metrics. Domain: services. Entity: listing_service. Operation: list. Scope: all_user_stores. Use when: Use it to show pending or purchased We List For You orders/services. Input: No explicit input parameters required. Does not use concrete listing ids. Output: Returns publication services and their status. Search terms: dashboard getlistingservices.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetListingSummary. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns an aggregate summary of published products, recent products and average price for the current channel. ownerAgent: account-metrics. Domain: listings. Entity: listing_summary. Operation: aggregate. Scope: current_store. Use when: Use it for dashboard views or aggregate metrics for the selected channel. Input: Header channel: current ChannelOAuthId. Does not use concrete listing ids. Output: Returns listing counters and aggregates. Search terms: dashboard getlistingsummary. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetNoApiServers. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get no api servers operation in dashboard data. Use when: Use it when a client needs to run the get no api servers operation for dashboard data. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the get no api servers operation. Search terms: dashboard getnoapiservers.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetOptimizedCount. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get optimized count operation in dashboard data. Use when: Use it when a client needs to run the get optimized count operation for dashboard data. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get optimized count operation. Search terms: dashboard getoptimizedcount. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetPendingStatistics. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get pending statistics operation in dashboard data. Use when: Use it when a client needs to run the get pending statistics operation for dashboard data. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get pending statistics operation. Search terms: dashboard getpendingstatistics. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/GetUpcomingWebinar. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get upcoming webinar operation in dashboard data. Use when: Use it when a client needs to run the get upcoming webinar operation for dashboard data. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the get upcoming webinar operation. Search terms: dashboard getupcomingwebinar.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/RequestCode. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET request code operation in dashboard data. Use when: Use it when a client needs to run the request code operation for dashboard data. Input: [FromQuery] id: int. Output: Returns the result or applies the effect of the request code operation. Search terms: dashboard requestcode.
| Argument | Type | Description |
|---|---|---|
| id* | integer | HGRApi query parameter id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"description": "HGRApi query parameter id."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dashboard/TaskPendingAutoOrder2. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET task pending auto order2 operation in dashboard data. Use when: Use it when a client needs to run the task pending auto order2 operation for dashboard data. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the task pending auto order2 operation. Search terms: taskpendingautoorder 2, dashboard taskpendingautoorder 2. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Dispatch/Get. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get operation in shipping and dispatch operations. Use when: Use it when a client needs to run the get operation for shipping and dispatch operations. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get operation. Search terms: dispatch get. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/HelpCentre/GetTicket/{id}. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Reads one authenticated CRM support ticket by visible ticket id. Domain: support. Entity: support_ticket. Operation: get_exact. Scope: authenticated_user. Use when: Use when the user asks about an existing support ticket and provides the visible TCK-* ticket reference. Input: [FromRoute] id: string. Legacy numeric ids are not supported. Output: Returns ticket detail including visible id/number, state, priority, dates, customer and messages. Search terms: helpcentre getticket id.
| Argument | Type | Description |
|---|---|---|
| id* | string | HGRApi route parameter id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "HGRApi route parameter id."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Listing/DidList. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET did list operation in bulk publication and publication tracking. Use when: Use it when a client needs to run the did list operation for bulk publication and publication tracking. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the did list operation. Search terms: listing didlist. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Listing/ListingsCountPerChannel. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET listings count per channel operation in bulk publication and publication tracking. Use when: Use it when a client needs to run the listings count per channel operation for bulk publication and publication tracking. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the listings count per channel operation. Search terms: listing listingscountperchannel. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads price history for one exact listing variation. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| productId | string | Visible marketplace Product Id / primary id. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| variationProductId | string | Visible variation Product Id / primary id when the listing has multiple variations. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"variationProductId": {
"type": "string",
"description": "Visible variation Product Id / primary id when the listing has multiple variations."
}
},
"additionalProperties": false
}Reads stock history for one exact listing variation. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| productId | string | Visible marketplace Product Id / primary id. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| variationProductId | string | Visible variation Product Id / primary id when the listing has multiple variations. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"variationProductId": {
"type": "string",
"description": "Visible variation Product Id / primary id when the listing has multiple variations."
}
},
"additionalProperties": false
}Gets exact listings only by concrete HGR listing ids or visible marketplace primary ids. Do not use this tool to discover, scan, rank, filter or aggregate a store's listings. For bulk/global listing queries use active, pending or terminated listings instead. Do not use this tool to construct CSV, XML, XLSX, feed or bulk export files. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| listingIds | array | Concrete HGR listing ids. Use only when the exact listing ids are already known. |
| primaryIds | array | Concrete visible marketplace primary ids. Use only when the exact primary ids are already known. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"listingIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Concrete HGR listing ids. Use only when the exact listing ids are already known."
},
"primaryIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Concrete visible marketplace primary ids. Use only when the exact primary ids are already known."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads No-API Server configuration/status. Passwords and secrets are redacted, and connection states are translated to human language.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads No-API Server verification/connection state for a visible store and translates it to human language. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Lists pending listings for one visible store. First resolve the store with hgr_list_channels, then call this tool using channelOAuthId from the selected store. For rankings, filtering and summaries, pass fields/sortBy/sortDirection/limit directly to this tool and answer from its response. Pending listing ids may be shown only where HGRWeb shows them. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| page | integer | One-based page number. |
| limit | integer | Maximum number of rows to return. HGRApi maximum is 10000. |
| fields | array | Fields to return. Use projection for compact answers. |
| offset | integer | Zero-based row offset. |
| sortBy | string | Field used to sort before limit/pagination. |
| sortDirection | string | Sort direction. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| showWeListForYou | boolean |
Reads Price Warrior dashboard/settings for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads pricing rules for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET Api/Products/Subscriptions/Get. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Lists the HGR listing-subscription plans and prices available to the requesting account. ownerAgent: account-metrics. supportingAgents: support, orchestrator. Domain: account_metrics. Entity: subscription_plan. Operation: list. Scope: product_catalog. AllowedIntents: subscription_plan_catalog. Use when: Use to quote monthly or annual plan prices and compare listing capacities. Input: No body or query input. Authentication is optional: sign in for eligible legacy prices. Anonymous requests receive public prices. Admin-only: false. The selected channel is not required. Output: Returns the complete enabled listing-plan catalogue. ProductOrder is listing capacity. Each price includes PlatformId, BillingPeriodId, CurrencyId, Price and PlatformProductId. LegacyPricing indicates continuing legacy subscription eligibility. Search terms: products subscriptions get.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads sales aggregates for the selected visible store using WAPI GetSales. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI GetSalesRequest body: Period, From, To, timeDiff. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI GetSalesRequest body: Period, From, To, timeDiff."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Sales/GetOrderImage/{orderId}/{cache}. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get order image operation in sales/order operations. Use when: Use it when a client needs to run the get order image operation for sales/order operations. Input: [FromRoute] orderId: int. [FromRoute] cache: string. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get order image operation. Search terms: sales getorderimage orderid cache. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| cache* | string | HGRApi route parameter cache. |
| orderId* | string | HGRApi route parameter orderId. |
{
"type": "object",
"required": [
"orderId",
"cache"
],
"properties": {
"cache": {
"type": "string",
"description": "HGRApi route parameter cache."
},
"orderId": {
"type": "string",
"description": "HGRApi route parameter orderId."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/SearchProduct/getMissingListings. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns marketplace/channel listings that HGR detected during the latest periodic synchronization as missing from HGR for the current store. ownerAgent: listings. Domain: listings. Entity: missing_listing. Operation: list_missing. Scope: current_store. Use when: Use it when the user asks what products or listings from the current store can be imported into HGR, what listings are missing in HGR, or what items were detected as not present after synchronization. Input: Header channel: current ChannelOAuthId. No body. Output: Returns missing listing candidates with ChannelItem, ChannelTitle, Sku and variation attributes. HGRApi removes entries that already exist in HGR as successfully created listings before returning them. Search terms: searchproduct getmissinglistings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/SearchProduct/GetPendingNoApiPreviousValues. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get pending no api previous values operation in existing published product/listing management. Use when: Use it when a client needs to run the get pending no api previous values operation for existing published product/listing management. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get pending no api previous values operation. Search terms: searchproduct getpendingnoapipreviousvalues. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/SearchProduct/PriceChanges. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Reads the recorded selling price change history shown in HGRWeb for one listing variation. ownerAgent: listings. Domain: listings. Entity: listing_price_history. Operation: read_history. Scope: exact_variation. Use when: Use it when the user asks for price history, price changes, previous selling prices or a price timeline of an identified or attached store product. Current price in the product details is not its history. Input: Required query id: positive internal ListingVariationId, not the parent ListingId, supplier ProductSourceId or marketplace Product ID. Resolve the attached product's visible Product ID through Listing/GetListings in the selected channel; use the matching variation Id. If several variations match, resolve the requested variation rather than choosing one arbitrarily. Output: Returns History entries with Date, Value (channel selling price), Author and Why when recorded. A successful History: [] means no recorded price changes for that variation. success=false or a missing History is a failed lookup, not evidence of no history. Search terms: searchproduct pricechanges. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/SearchProduct/StockChanges. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Reads the recorded stock quantity change history shown in HGRWeb for one listing variation. ownerAgent: listings. Domain: listings. Entity: listing_stock_history. Operation: read_history. Scope: exact_variation. Use when: Use it when the user asks for stock history, stock changes, quantity changes, inventory history or an availability timeline of an identified or attached store product. Current stock in the product details is not its history. Input: Required query id: positive internal ListingVariationId, not the parent ListingId, supplier ProductSourceId or marketplace Product ID. Resolve the attached product's visible Product ID through Listing/GetListings in the selected channel; use the matching variation Id. If several variations match, resolve the requested variation rather than choosing one arbitrarily. Output: Returns History entries with Date, Value (channel stock quantity), Author and Why when recorded. A successful History: [] means no recorded stock changes for that variation. success=false or a missing History is a failed lookup, not evidence of no history. Search terms: searchproduct stockchanges. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads explicitly saved supplier settings for one visible store. This is settings data, not supplier availability or listing usage data. It must never be interpreted as an enabled, disabled or suspended supplier state. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Lists current sources/suppliers from WAPI for one visible store/channel, optionally filtered by visible countryCode. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| countryCode | string | Optional visible country code, for example UK, US, ES, FR, DE, AU or IT. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"countryCode": {
"type": "string",
"description": "Optional visible country code, for example UK, US, ES, FR, DE, AU or IT."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Sources/Get. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Lists supplier/source marketplaces available to the user and the current channel. ownerAgent: catalog-sources. supportingAgents: listings. Domain: sources. Entity: supplier_source. Operation: list. Scope: current_store. Use when: Use it to build supplier selectors, map sourceId values to visible names, resolve suppliers for a catalog search, or verify whether a supplier supports publication and Auto Ordering for the selected store and country. Use actual returned supplier IDs when a catalog search specifies a supplier; do not invent IDs. Input: [FromQuery] isoCountry: int?. Header channel: current ChannelOAuthId. If isoCountry is not sent, use the selected channel country. Output: Returns sources/suppliers with Id, Name, BaseUrl, Site, publication permissions, HasAutoOrder, AutoOrderingFee and other visible metadata. Search terms: sources get. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| isoCountry | integer | HGRApi query parameter isoCountry. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"isoCountry": {
"type": "integer",
"description": "HGRApi query parameter isoCountry."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Sources/GetPublic. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Lists visible supplier/source marketplaces and their capabilities for a requested country without requiring a selected channel. ownerAgent: catalog-sources. supportingAgents: account-metrics, orders-autoordering, support. Domain: sources. Entity: supplier_source. Operation: list. Scope: country_catalog. AllowedIntents: supplier_capabilities. Use when: Use it for general commercial or pre-sales questions about suppliers available in a country, publication methods, Auto Ordering support, or the configured Auto Ordering fee when no authenticated store context is required. SearchTerms: suppliers available by country, supplier capabilities by country, Amazon Italy Auto Ordering, Amazon.it Auto Ordering, supplier Auto Ordering fee, supported suppliers in Italy. NegativeUseCases: Do not use it to claim that a supplier account is configured for the current user; Do not use it to list private suppliers belonging to the authenticated user. Input: Required [FromQuery] isoCountry: string. Use the two-letter HGR country code inferred from the marketplace or country named by the user, such as IT for Italy. Output: Returns visible sources/suppliers for the country with Id, Name, BaseUrl, Site, publication permissions, HasAutoOrder and AutoOrderingFee. Search terms: sources getpublic.
| Argument | Type | Description |
|---|---|---|
| isoCountry* | string | HGRApi query parameter isoCountry. |
{
"type": "object",
"required": [
"isoCountry"
],
"properties": {
"isoCountry": {
"type": "string",
"description": "HGRApi query parameter isoCountry."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Sources/GoOut. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET go out operation in source/supplier reading. Use when: Use it when a client needs to run the go out operation for source/supplier reading. Input: [FromQuery] sourceUrl: string. [FromQuery] isoCountry: int?. [FromQuery] channelListingId: int?. Output: Returns the result or applies the effect of the go out operation. Search terms: sources goout. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| sourceUrl* | string | HGRApi query parameter sourceUrl. |
| isoCountry | integer | HGRApi query parameter isoCountry. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| channelListingId | integer | HGRApi query parameter channelListingId. |
{
"type": "object",
"required": [
"sourceUrl",
"channelOAuthId"
],
"properties": {
"sourceUrl": {
"type": "string",
"description": "HGRApi query parameter sourceUrl."
},
"isoCountry": {
"type": "integer",
"description": "HGRApi query parameter isoCountry."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"channelListingId": {
"type": "integer",
"description": "HGRApi query parameter channelListingId."
}
},
"additionalProperties": false
}Reads the visible current subscription/quota summary. It never creates, changes or cancels subscriptions.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Reads one support ticket by its visible ticket id/reference.
| Argument | Type | Description |
|---|---|---|
| ticketId* | string | Visible support ticket id/reference. |
{
"type": "object",
"required": [
"ticketId"
],
"properties": {
"ticketId": {
"type": "string",
"description": "Visible support ticket id/reference."
}
},
"additionalProperties": false
}Lists terminated listings for one visible store. First resolve the store with hgr_list_channels, then call this tool using channelOAuthId from the selected store. Supports fields, sortBy, sortDirection, limit and pagination declared by HGRApi. Terminated listings do not expose price or stock fields. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| page | integer | One-based page number. |
| limit | integer | Maximum number of rows to return. HGRApi maximum is 10000. |
| fields | array | Fields to return. Use projection for compact answers. |
| offset | integer | Zero-based row offset. |
| sortBy | string | Field used to sort before limit/pagination. |
| sortDirection | string | Sort direction. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"page": {
"type": "integer",
"description": "One-based page number."
},
"limit": {
"type": "integer",
"description": "Maximum number of rows to return. HGRApi maximum is 10000."
},
"fields": {
"type": "array",
"items": {
"enum": [
"listingId",
"productId",
"title",
"status",
"origin",
"createdOn",
"terminatedOn",
"isBeingRelisted",
"relistedOn",
"sourceId",
"variationCount"
],
"type": "string"
},
"description": "Fields to return. Use projection for compact answers."
},
"offset": {
"type": "integer",
"description": "Zero-based row offset."
},
"sortBy": {
"enum": [
"listingId",
"productId",
"title",
"createdOn",
"terminatedOn",
"isBeingRelisted",
"relistedOn",
"variationCount"
],
"type": "string",
"description": "Field used to sort before limit/pagination."
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET Api/User/GetTokenBalance. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get token balance operation in visible user data. Use when: Use it when a client needs to run the get token balance operation for visible user data. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the get token balance operation. Search terms: user gettokenbalance.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Dedicated HGRApi tool for GET Api/User/GetTokenHistory. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns the authenticated user's token usage history. ownerAgent: account-metrics. Domain: account_tokens. Entity: token_history. Operation: list. Scope: authenticated_user. Use when: Use it when the authenticated user needs to review token charges, credits, awards, paid token entries or AI action usage history. Input: No body. Uses the authenticated user id from Authorization. No Header channel / ChannelOAuthId required. Not admin-only. Output: Returns history items with ReferenceType, Title, TokenAmount, UpdatedOn and ActionTypes. Search terms: user gettokenhistory.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Lists Virtual Assistant / VA profiles. Prefer names in user-facing responses.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Winning/Get/{id}. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET get operation in winning product generation reading. Use when: Use it when a client needs to run the get operation for winning product generation reading. Input: [FromRoute] id: int. Output: Returns the result or applies the effect of the get operation. Search terms: winning get id.
| Argument | Type | Description |
|---|---|---|
| id* | string | HGRApi route parameter id. |
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "HGRApi route parameter id."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for GET api/Winning/List. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the GET list operation in winning product generation reading. Use when: Use it when a client needs to run the list operation for winning product generation reading. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the list operation. Search terms: winning list.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Lists the user's connected stores/channels with channelOAuthId, store name, marketplace, country and connection status. Use channelOAuthId from this response for store-scoped endpoint tools.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Publishes one pending listing immediately by its visible pending listing id. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this for active or terminated listings. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| pendingListingId | integer | Visible pending listing id, only for pending listings where HGRWeb shows this id. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this for active or terminated listings."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"pendingListingId": {
"type": "integer",
"description": "Visible pending listing id, only for pending listings where HGRWeb shows this id."
}
},
"additionalProperties": false
}Lists support tickets for the authenticated user.
No arguments.
{
"type": "object",
"properties": {},
"additionalProperties": false
}Lists listing templates for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Loads marketplace business policies for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Loads available shipping addresses for an order resolved from visible order Reference. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Reads progress for an order resolved from visible order Reference. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Loads marketplace shipping options for one visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Marks a listing template as default for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally, confirmed=true and impactConfirmed=true because templates can affect publishing flows.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI MakeDefaultRequest body: templateId. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI MakeDefaultRequest body: templateId."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Marks orders resolved from visible order Reference as manually dispatched. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Marks exact order lines as purchased in HGR. The MCP resolves current WAPI status and uses FixedOrderLine only for CompletedAutoOrderPending. Requires confirmed=true after showing the full HGRWeb warning. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after showing the full HGRWeb warning: do not use this unless already purchased; it only marks the order as purchased in HGR; Auto-Ordering is required for automatic supplier purchase/shipping. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after showing the full HGRWeb warning: do not use this unless already purchased; it only marks the order as purchased in HGR; Auto-Ordering is required for automatic supplier purchase/shipping."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Marks orders resolved from visible order Reference as fixed/resolved. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Moves one pending listing to manual review by its visible pending listing id. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this for active or terminated listings. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| pendingListingId | integer | Visible pending listing id, only for pending listings where HGRWeb shows this id. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this for active or terminated listings."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"pendingListingId": {
"type": "integer",
"description": "Visible pending listing id, only for pending listings where HGRWeb shows this id."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/AI/CreateTask. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST create task operation in AI optimization task management. Use when: Use it when a client needs to run the create task operation for AI optimization task management. Input: rq: Data.CreateTaskRequest. Main fields: Action: AIActionType, AutoPublish: bool, Listings: int[], Settings: CreateTaskRequestSetting[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the create task operation. Search terms: ai createtask. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/AI/CreateTask request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/AI/CreateTask request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/AI/GetImageInfo. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get image info operation in AI optimization task management. Use when: Use it when a client needs to run the get image info operation for AI optimization task management. Input: rq: GetImageInfoRequest. Main fields: Ids: int[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get image info operation. Search terms: ai getimageinfo. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/AI/GetImageInfo request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/AI/GetImageInfo request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/AI/GetTaskResult. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get task result operation in AI optimization task management. Use when: Use it when a client needs to run the get task result operation for AI optimization task management. Input: rq: GetTaskResultRequest. Main fields: TaskId: int, ListingId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get task result operation. Search terms: ai gettaskresult. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/AI/GetTaskResult request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/AI/GetTaskResult request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/AI/PublishNow. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST publish now operation in AI optimization task management. Use when: Use it when a client needs to run the publish now operation for AI optimization task management. Input: rq: PublishNowRequest. Main fields: TaskId: int, ListingId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the publish now operation. Search terms: ai publishnow. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/AI/PublishNow request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/AI/PublishNow request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Analytics/AddWork. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST add work operation in current-channel watcher analytics. Use when: Use it when a client needs to run the add work operation for current-channel watcher analytics. Input: rq: AddWorkRequest. Main fields: Ids: int[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the add work operation. Search terms: analytics addwork. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Analytics/AddWork request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Analytics/AddWork request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Catalog/GetProducts. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides supplier candidates for publication. ownerAgent: catalog-sources. Opening the catalog returns stored recommendations; explicit web, AI chat and MCP searches discover products through a deep internet search that may take several minutes. Use when: Use for catalog/source candidate discovery, not existing store inventory, importing store products, stock checks or ranking active listings. AI chat and MCP may search and apply the documented catalog filters, including themes, seasons and occasions such as Mother's Day gifts. Warn the user in their language before starting that a deep internet search may take several minutes; do not require confirmation for this read-only search. Input: CatalogProductsRequest. Header channel identifies the selected store and country. Search=false or omitted returns all type-0 country recommendations; SessionId preserves random order. For explicit searches from the web, AI chat or MCP set Search=true. Search accepts SourceIds, PriceFrom/PriceTo, ProfitFrom/ProfitTo, Prime options, Criteria as only the human-written free-text product search prompt (not a literal title substring) and optional Tags (selected theme/category integer IDs, using the same IDs as AI Publisher orders). When SourceIds is omitted or empty, searches use up to four distinct eligible supplier domains with the highest priority for the store's country and channel; source ID ascending breaks priority ties. Explicit supplier inclusions or exclusions retain their existing behavior. Theme, category, trending and store exclusion filters remain separate from Criteria. When Criteria is empty, categories and seasonal themes are expanded into related product families before searching; a human-written Criteria skips this expansion. Trending remains a search requirement. Price/profit requirements use effective channel/supplier settings and fees. For example, a Mother's Day product search uses {"search":true,"criteria":"Mother's Day gifts"}. Do not invent a quantity parameter; show the requested number from the returned candidates. Output: Returns Products with SourceId, Url, Title, ImageUrl, SourcePrice, ChannelPrice, Profit and SubOrigin. Initial candidates have CatalogSelection=1; search candidates have CatalogSearch=2. Publish by URL rather than ProductSourceId. Initial mode returns the complete stored country collection. Search returns at most 50 candidates total and can return fewer or none when no eligible products are found. TotalResults and PageSize are the returned count. Search terms: catalog getproducts. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
Dedicated HGRApi tool for POST api/Catalog/SubmitCatalog. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Queues selected catalog candidates for publication or review. ownerAgent: publication. Use when: Use after selecting real candidates from Catalog/GetProducts. Not for discovering products, importing existing store inventory, or publishing ad-hoc URLs; use Listing/SaveBulkPublish for general URL publication. Input: CatalogSubmitRequest. Header channel is required. Each ProductsToList item contains the exact Url, Title, SubOrigin (CatalogSelection=1 or CatalogSearch=2) and optional PublishOn for individual scheduling. Optimization/review options and Origin remain supported. Legacy Id and DelaysMap remain accepted for existing first-steps clients. UserDevice is optional web telemetry; AI chat and MCP omit it. Output: Creates URL-based bulk jobs, records SubOrigin while preserving Origin=Catalog, and returns BatchId. Token/quota validation applies. Search terms: catalog submitcatalog. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Catalog/SubmitCatalog request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Dedicated HGRApi tool for POST api/ChannelListing/ClearOneVariation. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST clear one variation operation in published product creation and optimization. Use when: Use it when a client needs to run the clear one variation operation for published product creation and optimization. Input: rq: ClearVariationsRequest. Main fields: ChannelListingId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the clear one variation operation. Search terms: channellisting clearonevariation. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/ClearOneVariation request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
Dedicated HGRApi tool for POST api/ChannelListing/ClearVariations. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST clear variations operation in published product creation and optimization. Use when: Use it when a client needs to run the clear variations operation for published product creation and optimization. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the clear variations operation. Search terms: channellisting clearvariations. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/ClearVariations request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/ClearVariations request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/getCategoriesByText. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get categories by text operation in published product creation and optimization. Use when: Use it when a client needs to run the get categories by text operation for published product creation and optimization. Input: [FromBody] rq: GetCategoriesByTextRequest. Main fields: Text: string. Header channel: current ChannelOAuthId. Output: Returns the categories whose name contains the text. When no category name contains it, returns suggested categories for the text: for eBay and TikTok stores the first one is the HGR suggestion for that text, followed by the marketplace suggestions. Search terms: channellisting getcategoriesbytext. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/getCategoriesByText request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/getCategoriesByText request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/GetCategorySpecifics. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns category field definitions and populated values for manual product preparation. ownerAgent: publication. Use when: Use when the manual product form needs fields for its selected category and supplier product data. Input: GetCategorySpecificsRequest: SourceId, Price, CategoryId, Title, Paragraphs, Features, TableValues. Header channel: current ChannelOAuthId. Admin: false. Output: response_data remains the category field collection. Admin or impersonated sessions additionally receive debug alongside response_data, with actual product inputs and returned definitions, restrictions and values. Missing initial values, internal filling decisions and browser-side changes are explicitly marked as unavailable, never inferred. A failed category-field request includes admin debug with its trace ID in the error response. Search terms: channellisting getcategoryspecifics. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/GetCategorySpecifics request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/GetCategorySpecifics request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/getSuggestedCategories. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get suggested categories operation in published product creation and optimization. Use when: Use it when a client needs to run the get suggested categories operation for published product creation and optimization. Input: [FromBody] rq: Request.GetSuggestedCategoriesRequest. Main fields: Url: string, Text: string. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get suggested categories operation. Search terms: channellisting getsuggestedcategories. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/getSuggestedCategories request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/getSuggestedCategories request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/GetSuggestedTitles. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get suggested titles operation in published product creation and optimization. Use when: Use it when a client needs to run the get suggested titles operation for published product creation and optimization. Input: [FromBody] request: SuggestedTitles. Main fields: CategoryId: int, Product: SourceProduct. Output: Returns the result or applies the effect of the get suggested titles operation. Search terms: channellisting getsuggestedtitles. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/GetSuggestedTitles request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/GetSuggestedTitles request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/List. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Resolves one supplier product URL into validated product data for listing creation. ownerAgent: publication. Use when: Use when a user has submitted one concrete supplier product URL and needs the product data required to prepare a listing. Input: ListRequest body with Url and optional extension ExtraData. Header channel: current ChannelOAuthId. Output: Returns ComListing with validated product data when details can be obtained. A successful product response may also include OtherUrls so compatible extension clients can offer an optional switch to bulk publish. For a recognized product URL whose details cannot be obtained, returns Success=false with ErrorType=UnknownProduct without OtherUrls. Non-product pages may return OtherUrls for bulk discovery. Search terms: channellisting list. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/List request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/List request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/MonitorExistingListing. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Imports or monitors existing channel listings in HGR. Imported listings are always activated. ownerAgent: publication. Use when: Use when concrete existing store listing/product ids and source URLs are already selected and the user wants HGR to monitor/import those existing listings. Input: [FromBody] model: AddListingModel. Main fields: OAuthId: int, Listings: ListingToMonitor[]. Header channel: current ChannelOAuthId. ToRelist is currently ignored. UserDevice is optional HGRWeb client telemetry; AI chat and MCP must omit it and must not invent a device value. Output: Returns import/monitoring results with inserted, invalid, repeated and quota-related entries. Imported eBay API variations preserve VAT when the store supplies it; unknown VAT is not inferred from the publication default. Search terms: channellisting monitorexistinglisting. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/MonitorExistingListing request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Dedicated HGRApi tool for POST api/ChannelListing/MonitorExistingListing2. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Imports existing store products into HGR with live progress over one HTTP stream. Imported products are activated; no new marketplace adverts are published. ownerAgent: publication. Use when: Use when exact existing store product ids and supplier URLs are selected and the caller can keep an SSE response open. Send the entire selection in one request. Do not use for catalog discovery or new marketplace publication. Input: Authenticated, not admin-only. Body: AddListingModel with Listings containing Id, SourceURL and optional VariationSku, VariationAttributes, SourceVariation, SourceWarehouse, Markup and Title. Requires Header channel: authorized ChannelOAuthId; the body OAuthId does not override it. ToRelist is ignored. UserDevice is optional web telemetry; AI and MCP must omit it. Output: SSE progress events contain phase, total, processed, imported, alreadyExisting, rejected, failed and optional itemId, error, pages, totalPages and cachedProducts. The terminal completed event contains inserted, wereInYourHGR, repeated, emptyUrl, notValidUrl, failed (id, variationSku, error), total, processed, ok and error. Inspect ok, failed and processed/total; a terminal event alone does not mean all products were imported. An unexpected stream failure emits error. Search terms: monitorexistinglisting 2, channellisting monitorexistinglisting 2. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/MonitorExistingListing2 request body. |
| confirmed* | boolean |
Dedicated HGRApi tool for POST api/ChannelListing/OptimizeImage. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST optimize image operation in published product creation and optimization. Use when: Use it when a client needs to run the optimize image operation for published product creation and optimization. Input: rq: OptimizeImageRequest. Main fields: ImageUrl: string, Action: AIActionType, Settings: Setting[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the optimize image operation. Search terms: channellisting optimizeimage. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/OptimizeImage request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/OptimizeImage request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ChannelListing/OptimizeSpecificFields. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST optimize specific fields operation in published product creation and optimization. Use when: Use it when a client needs to run the optimize specific fields operation for published product creation and optimization. Input: rq: OptimizeSpecificFieldsRequest. Main fields: ProductSourceId: int, Fields: ChannelSpecificField[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the optimize specific fields operation. Search terms: channellisting optimizespecificfields. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ChannelListing/OptimizeSpecificFields request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/OptimizeSpecificFields request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Dispatch/GetShipmentDetails. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get shipment details operation in shipping and dispatch operations. Use when: Use it when a client needs to run the get shipment details operation for shipping and dispatch operations. Input: [FromBody] request: GetShipmentDetailsRequest. Main fields: TrackingCode: string. Output: Returns the result or applies the effect of the get shipment details operation. Search terms: dispatch getshipmentdetails. Send the exact request payload in body.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Dispatch/GetShipmentDetails request body. |
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Dispatch/GetShipmentDetails request body."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Dispatch/UpdateShipmentDetails. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST update shipment details operation in shipping and dispatch operations. Use when: Use it when a client needs to run the update shipment details operation for shipping and dispatch operations. Input: [FromBody] request: VelociPackerShipmentUpdateRequest. Main fields: TrackingCode: string, OrderReference: string, DeliveredOn: DateTime. Output: Returns the result or applies the effect of the update shipment details operation. Search terms: dispatch updateshipmentdetails. Send the exact request payload in body. Requires confirmed=true before execution.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Dispatch/UpdateShipmentDetails request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
{
"type": "object",
"required": [
"body",
"confirmed"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Dispatch/UpdateShipmentDetails request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/HelpCentre/Contact. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Creates a legacy authenticated help-centre contact ticket. Domain: support. Entity: support_ticket. Operation: create. Scope: authenticated_user. Use when: Use for legacy contact form submissions where a visible ticket id is not required. AIChat must prefer Contact2 when it needs to show the created ticket reference/link. Input: rq: ContactModel. Main fields: Message: string, Attachments: Attachment[]. Optional X-HGR-Client: ai_chat identifies the HGR AI chat gateway; normal web requests omit it. Output: Boolean success flag only. It does not return a visible ticket id. The creation event actor is human for web submissions or ai_chat for HGR AI chat; the first message remains an inbound customer message. Search terms: helpcentre contact. Send the exact request payload in body. Requires confirmed=true before execution.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/HelpCentre/Contact request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
{
"type": "object",
"required": [
"body",
"confirmed"
],
"properties": {
"body": {
"description": "HGRApi POST /api/HelpCentre/Contact request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Listing/AutoList. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST auto list operation in bulk publication and publication tracking. Use when: Use it when a client needs to run the auto list operation for bulk publication and publication tracking. Input: request: AutoListRequest. Main fields: WeListForYou: bool. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the auto list operation. Search terms: listing autolist. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/AutoList request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/AutoList request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Listing/GetBulkHistory. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns recent bulk publication jobs and their recorded status/errors for the selected store. ownerAgent: publication. Use when: Use it to inspect bulk publication history and diagnose a job's recorded error. Input: Optional AutoListRequest. Header channel: current ChannelOAuthId. Output: Returns logs with job status, error code, listing status and origin. EnumValues maps the numeric codes. ChannelListingStatusFlags is a bitmask: decode every set bit, not the whole number as one ordinal. Search terms: listing getbulkhistory. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/GetBulkHistory request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/GetBulkHistory request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Listing/GetScrapingConfig. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns supplier page extraction settings for the listing extension and bulk publication. Use when: Use it to identify product details and product links from a supported supplier page. Input: rq: GetScrapingConfigRequest. Main fields: Url: string, Site: eCountry?. Header channel: current ChannelOAuthId; Site defaults to the current store country. Output: Returns supplier-specific extraction settings. Keeps a configured product-link selector; uses all page links only when no link selector is configured. Search terms: listing getscrapingconfig. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/GetScrapingConfig request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/GetScrapingConfig request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Listing/MigrateBulk. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Queues selected listings for migration to a target channel in bulk. ownerAgent: publication. Use when: Use when concrete listing ids and a target channel are already selected and the user wants to migrate/copy them in bulk. Input: data: MigrateBulkRequest. Main fields: ListingIds: int[], TargetId: int, listFrequencyMinutes: int, dontListUntil: DateTime?, reviewBeforePublishing: bool, createdBy: int, ignoreVero: bool, ignoreOOS: bool, optimizeTitle: bool, optimizeDescription: bool, optimizeFields: bool. Header channel: current ChannelOAuthId. UserDevice is optional HGRWeb client telemetry; AI chat and MCP must omit it and must not invent a device value. Output: Creates migration bulk jobs for the selected listing ids. Search terms: listing migratebulk. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/MigrateBulk request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Dedicated HGRApi tool for POST api/Listing/Partner. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST partner operation in bulk publication and publication tracking. Use when: Use it when a client needs to run the partner operation for bulk publication and publication tracking. Input: request: AutoListRequest. Main fields: WeListForYou: bool. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the partner operation. Search terms: listing partner. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/Partner request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/Partner request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Listing/RelistedBulk2. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Queues selected existing listings for relisting in bulk. ownerAgent: publication. Use when: Use when concrete listing ids are already selected and the user wants to relist them in bulk. Input: data: RelistedBulk2Request. Main fields: ListingIds: int[], listFrequencyMinutes: int, dontListUntil: DateTime?, reviewBeforePublishing: bool, createdBy: int, ignoreVero: bool, ignoreOOS: bool, optimizeTitle: bool, optimizeDescription: bool, optimizeFields: bool. Header channel: current ChannelOAuthId. UserDevice is optional HGRWeb client telemetry; AI chat and MCP must omit it and must not invent a device value. Output: Creates relist bulk jobs for the selected listing ids. Search terms: relistedbulk 2, listing relistedbulk 2. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/RelistedBulk2 request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Dedicated HGRApi tool for POST api/Listing/SaveAutolist. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Saves a bulk/autolist publication batch. ownerAgent: publication. Use when: Use when the user wants to queue multiple source URLs for publication or review through the autolist/bulk listing flow. Input: data: SaveAutolistRequest. Main fields: listings: string[][], listFrequencyMinutes: int, dontListUntil: DateTime?, reviewBeforePublishing: bool, createdBy: int, ignoreVero: bool, ignoreOOS: bool, optimizeTitle: bool, optimizeDescription: bool, optimizeFields: bool, publishVariations: bool, WeListForYou: bool, GeneratorId: int?. Each listings row is [sourceUrl] or [sourceUrl, optionalTitle]. sourceUrl is required; an omitted, null or empty title means no custom title is supplied. A supplied title is preserved. Header channel: current ChannelOAuthId. UserDevice is optional HGRWeb client telemetry; AI chat and MCP must omit it and must not invent a device value. Output: Creates bulk listing jobs and returns an AutolistSummaryViewModel with processed, duplicated, invalid and quota-related counts. Search terms: listing saveautolist. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Listing/SaveAutolist request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId |
Dedicated HGRApi tool for POST api/Listing/SaveBulkPublish. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Saves a batch of URLs for bulk publication and returns one result per line. ownerAgent: publication. SearchTerms: save bulk publish, bulk publish, bulk publishing, mass publication, publicar en bulk. Use when: Use it when the client needs to know exactly which line was processed and which line was rejected without summarizing only by counts. Use it when selected products are source product URLs, Amazon URLs, ASIN URLs converted to source URLs, or source-page URLs. Do not use it to get existing listings or search candidates. Input: data: SaveAutolistRequest. Main fields: listings: string[][], listFrequencyMinutes: int, dontListUntil: DateTime?, reviewBeforePublishing: bool, createdBy: int, ignoreVero: bool, ignoreOOS: bool, optimizeTitle: bool, optimizeDescription: bool, optimizeFields: bool, publishVariations: bool, WeListForYou: bool. listings is string[][] where each row is [sourceUrl, optionalTitle]; sourceUrl is the supplier/source product URL to publish. Use reviewBeforePublishing for pending review, optimizeTitle/optimizeDescription/optimizeFields for optimization choices, and listFrequencyMinutes/dontListUntil for delayed publication. Do not send CatalogSubmitRequest.ProductsToList here. Header channel: current ChannelOAuthId. Internal client fields are managed by the tool and are not tool inputs. Output: Returns SaveBulkPublishLineStatus[] in the same order as listings. Values: Processed, ForbiddenWordsUrl, DuplicatedUrl, InvalidUrl, InvalidSourceUrl, ExistingListing, NoQuota, InvalidGenerator or DuplicatedProductSource. Search terms: listing savebulkpublish. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* |
Dedicated HGRApi tool for POST api/ListingCreate/EditPending. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST edit pending operation in manual product creation. Use when: Use it when a client needs to run the edit pending operation for manual product creation. Input: [FromBody] rq: EditPendingRequest. Main fields: ListingId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the edit pending operation. Search terms: listingcreate editpending. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ListingCreate/EditPending request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ListingCreate/EditPending request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/ListingCreate/GetData. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Resolves one supplier URL into validated product and draft-listing data for the extension's manual product flow. ownerAgent: publication. Use when: Use when the extension submits one supplier URL and needs the product details required to prepare a manual product. Input: GetDataRequest body with Url and optional extension ExtraData. AliExpress URLs may include selected variation labels and a native skuId. Header channel: current ChannelOAuthId. Admin: false. Output: Returns ProductInformation and Listing when complete product details can be obtained. AliExpress manual imports refresh the selected SKU and full variation family from the supplier even when cached product details exist. ASOS UK, Matalan and Home Bargains imports refresh supplier data when the cached or browser-extracted product has no variations; the returned product uses its selected size identity to avoid an empty parent option and retain a stable size-specific URL. Explicit ASOS UK product URLs with a selected variant preserve that exact size and avoid adding a duplicate selected-size option when the same size is already present in the variation family. Explicit AliExpress SKU selections are preserved; invalid or conflicting selections return an error instead of substituting the first variation. Variation labels remain separate from other URL parameters. A successful product response may also include OtherUrls so the client can offer an optional switch to bulk publish. A recognized product whose details cannot be obtained returns ErrorType=UnknownProduct without OtherUrls; non-product pages may return OtherUrls for bulk discovery. Admin or impersonated sessions additionally receive Debug with extraction configuration excluding cookies, intermediate product snapshots, data-source decisions and final product/draft fields. Category filling is diagnosed separately through ChannelListing/GetCategorySpecifics; browser-side changes are not observed here. Search terms: listingcreate getdata. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type |
|---|
Dedicated HGRApi tool for POST api/ListingCreate/GetDataByPSIds. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Loads current supplier data for the exact product-source variations used during manual multi-variation product creation. ownerAgent: publication. Domain: publication. Entity: product_source_variation_data. Operation: read_and_refresh. Scope: selected_channel. Use when: Use it when the manual product form needs price, stock, EAN and source images for a known set of exact ProductSourceIds, especially before displaying or publishing all supplier variations. Do not use it to discover products or variations without exact ProductSourceIds, or for existing store-listing collection or ranking. Input: [FromBody] rq: GetDataByPSIdsRequest. Main fields: ProductSourceIds: int[]. Header channel: current ChannelOAuthId. Admin: false. Output: Returns ProductSources keyed by the requested ProductSourceId, with available images, price, stock and EAN. Cached stock is read from saved supplier stock options. Matalan and Home Bargains sizes are refreshed with live stock information, including zero stock for unavailable sizes. Sources configured for live refresh return non-empty freshly scraped images immediately; cached images are retained only when the refresh supplies no images. Requested AliExpress variation URLs using a readable selection, a numeric skuId/sku_id, or both together, without a saved supplier SKU are refreshed to resolve that exact variation and load its images. These AliExpress child refreshes obtain stock information and return refreshed data only after the supplier identity, price and available stock have been saved. If the supplier identity, price or available stock cannot be confirmed, or saving fails, the response retains cached data. Bare AliExpress product URLs are not refreshed by this recovery rule. The refresh can also update stored product-source data. Search terms: listingcreate getdatabypsids. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
Dedicated HGRApi tool for POST api/ListingCreate/Submit. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Submits a manually prepared listing for creation. ownerAgent: publication. Use when: Use only after manual listing creation data has already been prepared and the user wants to create or queue that exact listing. Input: [FromBody] rq: SubmitCreateRequest, compatible with CreateRequest. Variation Markup settings are rounded to the nearest integer, with midpoint values rounded away from zero. Non-finite, malformed or out-of-range Markup values are ignored without deleting an existing override. For eBay API only, a missing VAT variation setting is initialized from the saved draft VAT or the store's PublishVAT default. Explicit product VAT, including zero, is preserved. VAT must be an integer from 0 to 100. UserDevice is optional HGRWeb client telemetry; AI chat and MCP must omit it and must not invent a device value. Output: Creates the listing through ListingService and returns success. Search terms: listingcreate submit. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally. Internal-only request fields are removed automatically before the HGRApi request is sent.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/ListingCreate/Submit request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer |
Dedicated HGRApi tool for POST api/NotificationCenter/GetAll. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get all operation in notification centre operations. Use when: Use it when a client needs to run the get all operation for notification centre operations. Input: rq: GetAllRequest. Main fields: Page: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get all operation. Search terms: notificationcenter getall. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/NotificationCenter/GetAll request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/NotificationCenter/GetAll request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/NotificationCenter/MarkAllAsRead. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST mark all as read operation in notification centre operations. Use when: Use it when a client needs to run the mark all as read operation for notification centre operations. Input: No explicit input parameters required. Output: Returns the result or applies the effect of the mark all as read operation. Search terms: notificationcenter markallasread. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/NotificationCenter/MarkAllAsRead request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/NotificationCenter/MarkAllAsRead request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/NotificationCenter/MarkAllChannelAsRead. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST mark all channel as read operation in notification centre operations. Use when: Use it when a client needs to run the mark all channel as read operation for notification centre operations. Input: Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the mark all channel as read operation. Search terms: notificationcenter markallchannelasread. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/NotificationCenter/MarkAllChannelAsRead request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/NotificationCenter/MarkAllChannelAsRead request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/NotificationCenter/MarkAsRead. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST mark as read operation in notification centre operations. Use when: Use it when a client needs to run the mark as read operation for notification centre operations. Input: rq: MarkAsReadRequest. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the mark as read operation. Search terms: notificationcenter markasread. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/NotificationCenter/MarkAsRead request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/NotificationCenter/MarkAsRead request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/FixedOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Completes an exact order line that is in CompletedAutoOrderPending. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: complete_pending_autoorder. Scope: current_store. Use when: Use only for an exact order line whose current state is CompletedAutoOrderPending and the user confirms the corresponding visible Mark as Purchased action. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Required Header channel: current ChannelOAuthId. Output: Moves eligible CompletedAutoOrderPending lines to CompletedAutoOrder and returns refreshed order data. Search terms: sales fixedorderline. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/FixedOrderLine request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/FixedOrderLine request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/ForceProcessOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST force process order line operation in sales/order operations. Use when: Use it when a client needs to run the force process order line operation for sales/order operations. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the force process order line operation. Search terms: sales forceprocessorderline. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/ForceProcessOrderLine request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
Dedicated HGRApi tool for POST api/Sales/GenerateTrackingId. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Generates an HGR/VelociPacker tracking number for exact existing order lines that have already been processed or marked as purchased. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: generate_tracking. Scope: current_store. Use when: Use it when the user explicitly asks HGR to generate tracking for an existing order. A manually purchased supplier order must first be marked as purchased in HGR; in HGRWeb the user then clicks Generate it in Orders. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Required Header channel: current ChannelOAuthId. Output: Queues HGR/VelociPacker tracking generation for each supplied order line and returns refreshed order data on success or the processing result when generation cannot start. Search terms: sales generatetrackingid. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/GenerateTrackingId request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Dedicated HGRApi tool for POST api/Sales/LoadAddressesFromOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST load addresses from order line operation in sales/order operations. Use when: Use it when a client needs to run the load addresses from order line operation for sales/order operations. Input: [FromBody] rq: LoadAddressFromOrderLineRequest. Main fields: OrderLineId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the load addresses from order line operation. Search terms: sales loadaddressesfromorderline. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/LoadAddressesFromOrderLine request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/LoadAddressesFromOrderLine request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/LoadProgress. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST load progress operation in sales/order operations. Use when: Use it when a client needs to run the load progress operation for sales/order operations. Input: [FromBody] rq: LoadProgressRequest. Main fields: Id: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the load progress operation. Search terms: sales loadprogress. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/LoadProgress request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/LoadProgress request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/ManuallyDispatchOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Records exact existing order lines as manually purchased in HGR. This is the HGRWeb Mark as Purchased action for normal manual-purchase states. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: mark_purchased. Scope: current_store. Use when: Use only after the user confirms that they already placed the real supplier order manually and wants to record that purchase in HGR before generating HGR/VelociPacker tracking. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Required Header channel: current ChannelOAuthId. Output: Changes eligible order lines to the manually purchased state and returns refreshed order data. Search terms: sales manuallydispatchorderline. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/ManuallyDispatchOrderLine request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/ManuallyDispatchOrderLine request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/MarkAsDispatched. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Acknowledges in HGR that an order-dispatch warning was handled manually for one exact order line. ownerAgent: orders-autoordering. Domain: orders. Entity: order_line. Operation: acknowledge_manual_dispatch. Scope: current_store. Use when: Use only when the user explicitly wants to clear the HGR warning after manually handling dispatch in the marketplace. Input: [FromBody] rq: AddAutoOrderReferenceRequest. Main field: OrderLineId: int. Required Header channel: current ChannelOAuthId. Output: Marks the dispatch warning as acknowledged in HGR and returns whether the order line was updated. Search terms: sales markasdispatched. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/MarkAsDispatched request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/MarkAsDispatched request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/ProcessOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Starts automatic supplier purchase processing for exact existing order lines using the current saved auto-ordering settings. ownerAgent: orders-autoordering. Use when: Use it when the user explicitly wants to process or retry an existing order after correcting a payment card or another auto-ordering setting. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Required Header channel: current ChannelOAuthId. Output: Attempts normal processing for each supplied order line and returns refreshed order data on success or the processing error result. Search terms: sales processorderline. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/ProcessOrderLine request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/ProcessOrderLine request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/Sales/StopOrderLine. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST stop order line operation in sales/order operations. Use when: Use it when a client needs to run the stop order line operation for sales/order operations. Input: [FromBody] rq: LoadAddressesFromOrderLineRequest. Main fields: OrderLineIds: int[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the stop order line operation. Search terms: sales stoporderline. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Sales/StopOrderLine request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/StopOrderLine request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/DefaultSettingsMultiple. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST default settings multiple operation in existing published product/listing management. Use when: Use it when a client needs to run the default settings multiple operation for existing published product/listing management. Input: [FromBody] rq: RemoveMultipleListingRequest. Main fields: Ids: int[]. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the default settings multiple operation. Search terms: searchproduct defaultsettingsmultiple. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/DefaultSettingsMultiple request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/DefaultSettingsMultiple request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/getListingsImages. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Returns the first image of active listings for concrete publication ids. ownerAgent: listings. Domain: listings. Entity: exact_listing. Operation: get_exact. Scope: current_store. Use when: Use it only when concrete listingIds are already known and thumbnails are needed for those exact listings. Input: Header channel: current ChannelOAuthId and body int[] with concrete listingIds. Does not accept free search or store scans. Output: Returns a map from published product id to image URLs. Search terms: searchproduct getlistingsimages. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/getListingsImages request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/getListingsImages request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/getPendingListingsImages2. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST get pending listings images2 operation in existing published product/listing management. Use when: Use it when a client needs to run the get pending listings images2 operation for existing published product/listing management. Input: [FromBody] listings: GetPendingListingsImages2Request[]. Main fields: Id: int, SourceId: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the get pending listings images2 operation. Search terms: getpendinglistingsimages 2, searchproduct getpendinglistingsimages 2. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/getPendingListingsImages2 request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/getPendingListingsImages2 request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/ListNow. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Retries a failed pending publication or submits a pending product now. Domain: listings. Entity: pending_listing. Operation: retry_or_publish. Scope: current_store. State: pending. RequiredInputs: confirmed. ownerAgent: publication. SupportingAgents: listings, support. AllowedIntents: retry_pending_publication, publish_pending_listing. ReadOnly: false. RequiresConfirmation: true. RequiresChannel: true. Use when: The user asks to retry or resubmit an existing pending product after fixing a marketplace error, or explicitly asks to publish a pending product now. Use this action instead of telling the user to click Retry in HGRWeb. SearchTerms: retry pending listing, retry publishing, publish pending listing now, resubmit pending product, retry failed publication, retry ebay publication. NegativeUseCases: Do not retry automatically merely because the user asks what the error means; Do not use for relisting an active or terminated product. Input: [FromBody] rq: Request.ListNowRequest. Id is the first variation ID, not its parent ListingId. Resolve the attached product or GetPending listingId through Listing/GetListings with ListingIds and Projection=Identifiers in the selected channel, then use variations[0].id, as HGRWeb Retry does. Header channel: current ChannelOAuthId. Output: BaseResponse.Success reports whether the retry or scheduling request was accepted, not whether marketplace publication has completed. Search terms: searchproduct listnow. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/ListNow request body. |
| confirmed* |
Dedicated HGRApi tool for POST api/SearchProduct/Optimize. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST optimize operation in existing published product/listing management. Use when: Use it when a client needs to run the optimize operation for existing published product/listing management. Input: [FromBody] data: OptimizeRequest. Main fields: ListingId: int?, ProductSourceId: int?, CurrentTitle: string, OptimizeTitle: bool, OptimizeDescription: bool, OptimizeFields: bool. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the optimize operation. Search terms: searchproduct optimize. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/Optimize request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/Optimize request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/PauseToReview. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Moves a scheduled pending product to manual review so it is not published at its scheduled time. ReadOnly: false. RequiresConfirmation: true. RequiresChannel: true. Use when: The user asks to pause, hold or stop a scheduled pending product so it is reviewed before publication. SearchTerms: pause pending listing, move pending listing to review, hold scheduled publication, stop scheduled listing. NegativeUseCases: Do not use for active or terminated listings. Input: [FromBody] rq: Request.ListNowRequest. Id is the first variation ID, not its parent ListingId. Resolve the attached product or GetPending listingId through Listing/GetListings with ListingIds and Projection=Identifiers in the selected channel, then use variations[0].id, as HGRWeb Pause does. Header channel: current ChannelOAuthId. Output: BaseResponse.Success is true when the product moved to review. It is false when the variation belongs to another channel, the product is not scheduled for its first listing, or its scheduled time is less than 3 minutes away. Search terms: searchproduct pausetoreview. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/PauseToReview request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer |
Dedicated HGRApi tool for POST api/SearchProduct/Relist. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST relist operation in existing published product/listing management. Use when: Use it when a client needs to run the relist operation for existing published product/listing management. Input: [FromBody] rq: RelistRequest. Main fields: Id: int. Header channel: current ChannelOAuthId. Output: Returns the result or applies the effect of the relist operation. Search terms: searchproduct relist. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/Relist request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/Relist request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST api/SearchProduct/RemoveListing. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Removes one listing from HGR. HGRWeb uses it to delete pending listings in review or error so they are never published. ReadOnly: false. RequiresConfirmation: true. RequiresChannel: true. Use when: The user explicitly asks to remove or delete a pending listing so it is never published. SearchTerms: remove pending listing, delete pending listing, remove listing from HGR. Input: [FromBody] rq: Request.ListNowRequest. Id is a variation ID of the listing to remove, not its parent ListingId. Resolve the attached product or GetPending listingId through Listing/GetListings with ListingIds and Projection=Identifiers in the selected channel, then use variations[0].id, as HGRWeb Remove does. The whole listing that owns that variation is removed. Header channel: current ChannelOAuthId, used to resolve the variation; the endpoint itself does not check it. Output: BaseResponse.Success is true when the listing was marked removed and false when no listing in the authenticated user's stores owns that variation ID. Search terms: searchproduct removelisting. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/RemoveListing request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer |
Dedicated HGRApi tool for POST api/SearchProduct/SaveMultipleProductChanges. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST save multiple product changes operation in existing published product/listing management. Use when: Use it when a client needs to run the save multiple product changes operation for existing published product/listing management. Input: [FromBody] changes: SaveMultipleProductChangesRequest. Main fields: ListingIds: int[], DataByListing: Dictionary<int, SaveMultipleProductChangesRequestD>, Markup: SaveProductChangeNumber, IncreaseMarkup: SaveProductChangeNumber, Price: SaveProductChangeDecimal, Quantity: SaveProductChangeNumber, Profit: SaveProductChangeNumber, MonitorPrice: SaveProductChangeBoolean, MonitorStock: SaveProductChangeBoolean, MonitorPriceDecrease: SaveProductChangeBoolean, PriceDecreasePercentage: SaveProductChangeNumber, IgnoreRules: SaveProductChangeBoolean, MinQuantity: SaveProductChangeNumber, PrimeOnly: SaveProductChangeBoolean, ShippingPolicy: SaveProductChangeLong, ReturnPolicy: SaveProductChangeLong, PaymentPolicy: SaveProductChangeLong, DispatchTimeDays: SaveProductChangeNumber. Header channel: current ChannelOAuthId. VAT is optional and only supported for eBay API: omit to leave unchanged, use {value: integer} from 0 to 100 to set, or {value: null} to remove the override and send zero to eBay. VAT applies to every variation of the affected eBay listing. Output: Returns the result or applies the effect of the save multiple product changes operation. Side effect: when a new channel stock quantity is applied to a listing variation, its previous channel stock quantity is recorded in the stock history (author: user), so it appears in the stock changes history. VAT settings are saved only for provider-accepted changes. Search terms: searchproduct savemultipleproductchanges. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
Dedicated HGRApi tool for POST api/SearchProduct/TerminateListing2. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Provides the POST terminate listing2 operation in existing published product/listing management. Use when: Use it when a client needs to run the terminate listing2 operation for existing published product/listing management. Input: [FromBody] item: TerminateItemRequest. Main fields: Id: int. Header channel: current ChannelOAuthId. Output: Ends the listing in the store. Marks it terminated in HGR and returns success=true only when the store confirms the end or reports that the item was already ended. When the store refuses the end, returns success=false and the listing stays active in HGR. Search terms: terminatelisting 2, searchproduct terminatelisting 2. Send the exact request payload in body. Requires confirmed=true and impactConfirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/SearchProduct/TerminateListing2 request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
Dedicated HGRApi tool for POST ai publisher filters checknew. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Checks whether a proposed AI Publisher order returns enough current product candidates. ownerAgent: ai-publisher. Use when: Use to check candidate availability without saving an order or publishing products. Input: NewFiltersRequest. Filter.Criteria is the optional free-text product search prompt, not a literal title substring. Supplier, price, profit, Prime and tag filters apply. Header channel: current ChannelOAuthId. Output: Returns GOOD, INSUFFICIENT or BAD based on up to 50 search results. Search terms: ai publisher filters checknew. Send the exact request payload in body. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST ai publisher filters checknew request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST ai publisher filters checknew request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Dedicated HGRApi tool for POST ai publisher filters new. This is an explicit tool with a fixed endpoint; it is not a generic endpoint caller. HGRApi functional documentation: Purpose: Creates a scheduled AI Publisher publication order for the selected store, including search conditions copied from the catalog. ownerAgent: ai-publisher. Use when: Use to create an order with product conditions, quantity, schedule and optimization preferences. Input: NewFiltersRequest.Filter: supplier Sources, OnlyPrime, optional Criteria (the free-text search prompt, up to 4000 characters; not a literal title substring), PriceMin/PriceMax, ProfitMin/ProfitMax and optional Tags (array of separate integer IDs, not bit flags). Tag IDs: 1 Valentine's Day, 2 Mother's Day, 3 Father's Day, 4 Back to school, 5 Halloween, 6 Black Friday, 7 Cyber Monday, 8 Christmas, 9 New Year's Eve, 10 Prime Day, 11 Trending, 12 Home and garden, 13 Electronics, 14 Toys and games, 15 Health and beauty, 16 Sports, 17 Pet supplies. Header channel: current ChannelOAuthId; the selected store determines ChannelOauthId. Output: Returns the identifier of the created order. Search terms: ai publisher filters new. Send the exact request payload in body. Requires confirmed=true before execution. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST ai publisher filters new request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
Starts normal processing for orders resolved from visible order Reference. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Refreshes marketplace business policies for one visible store. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Relists one terminated listing by visible Product ID. Requires confirmed=true and impactConfirmed=true after warning about consequences. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this for active or terminated listings. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
| pendingListingId | integer | Visible pending listing id, only for pending listings where HGRWeb shows this id. |
{
"type": "object",
"required": [
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this for active or terminated listings."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
},
"pendingListingId": {
"type": "integer",
"description": "Visible pending listing id, only for pending listings where HGRWeb shows this id."
}
},
"additionalProperties": false
}Removes an auto-ordering configuration by autoOrderingAccountRef returned by hgr_get_autoordering_configuration for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally, confirmed=true and impactConfirmed=true after warning about consequences.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
| autoOrderingAccountRef* | string | Opaque auto-ordering account reference returned by hgr_get_autoordering_configuration. |
{
"type": "object",
"required": [
"autoOrderingAccountRef",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
},
"autoOrderingAccountRef": {
"type": "string",
"description": "Opaque auto-ordering account reference returned by hgr_get_autoordering_configuration."
}
},
"additionalProperties": false
}Removes or retires one listing by visible Product ID, or a pending listing by the visible pending listing id. Requires confirmed=true and impactConfirmed=true after warning about consequences. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this for active or terminated listings. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
| pendingListingId | integer | Visible pending listing id, only for pending listings where HGRWeb shows this id. |
{
"type": "object",
"required": [
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this for active or terminated listings."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
},
"pendingListingId": {
"type": "integer",
"description": "Visible pending listing id, only for pending listings where HGRWeb shows this id."
}
},
"additionalProperties": false
}Replies to a support ticket with text only. File attachments are blocked by MCP policy. Requires confirmed=true.
| Argument | Type | Description |
|---|---|---|
| message* | string | Message body. |
| ticketId* | string | Visible support ticket id/reference. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact support message. |
{
"type": "object",
"required": [
"ticketId",
"message",
"confirmed"
],
"properties": {
"message": {
"type": "string",
"description": "Message body."
},
"ticketId": {
"type": "string",
"description": "Visible support ticket id/reference."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact support message."
}
},
"additionalProperties": false
}Requests a No-API Server verification code for a visible store. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Saves AI Agent configuration. Requires confirmed=true and impactConfirmed=true; activation requires acceptedAiAgentTerms=true and disabling requires disableWarningConfirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI SaveAgentChannelConfigurationRequest body, for example Enabled=true/false. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
| acceptedAiAgentTerms | boolean | Required as true when enabling AI Agent. |
| disableWarningConfirmed | boolean | Required as true when disabling AI Agent after warning that it will stop learning and may need to start over if reactivated. |
Saves auto-ordering configuration with the exact WAPI request body for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally, confirmed=true and impactConfirmed=true for supplier credential/configuration changes. Secret fields are redacted in the response.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI SaveAutoOrderingRequest body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI SaveAutoOrderingRequest body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Saves one channel setting using WAPI SaveOne. Requires confirmed=true and impactConfirmed=true because channel settings can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI ChannelConfiguration SaveOneRequest body: Key, Value. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI ChannelConfiguration SaveOneRequest body: Key, Value."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Saves one exact setting exposed by HGRWeb Supplier configuration. No supported setting enables, disables, suspends or re-enables a supplier. Requires confirmed=true and impactConfirmed=true because source settings can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | object | |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"type": "object",
"required": [
"Key",
"SourceId",
"Value"
],
"properties": {
"Key": {
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
19,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54
],
"type": "integer",
"description": "Source setting key exposed by HGRWeb Supplier configuration. 1=Markup percentage, 2=Dispatch days, 3=Monitor stock, 4=Monitor price, 5=Monitor price decreases, 6=Maximum monitored price-decrease percentage, 7=Default description template, 8=Default delivery policy, 9=Returns policy, 10=Global Shipping Program, 11=Shipping business policy, 12=Return business policy, 13=Payment business policy, 14=Item location city, 15=Item location postcode, 16=Item location country, 17=Amazon Prime-only products, 19=Amazon maximum delivery days, 29=Aosom business links, 30=Fixed markup, 31-37 and 47-48=GPSR responsible-person details, 38-44 and 49-50=GPSR manufacturer details, 45=Responsible-person override mode, 46=Manufacturer override mode, 51=Adjusted supplier cost percentage, 52=Fixed adjusted supplier cost, 53=Action when shipping cost is unknown, 54=Fixed shipping cost when unknown. No key enables, disables, suspends or re-enables a supplier."
},
"Value": {
"type": "string",
"description": "Serialized value required by Key. Boolean keys 3, 4, 5, 10, 17 and 29 use 0=false or 1=true. Numeric keys 1, 2, 6, 19, 30, 51, 52 and 54 use an invariant numeric string. Keys 45 and 46 use 0=apply only when original data is absent or 1=always override. Key 53 uses 0=mark out of stock or 1=use the fixed shipping price from key 54. Key 9 accepts Days_14, Days_30, Days_60 or No_Returns. Keys 7, 11, 12 and 13 require an existing template or marketplace policy identifier returned by the corresponding read tool; never invent an identifier. Key 16 uses a country code. Text and GPSR keys use their literal text value."
},
"SourceId": {
"type": "integer",
"description": "Exact source identifier returned by the HGR sources endpoint."
}
},
"additionalProperties": false
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Searches orders/order lines by visible order Reference and optional visible store. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| reference | string | Visible marketplace/order reference to search for. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"reference": {
"type": "string",
"description": "Visible marketplace/order reference to search for."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Sends a No-API Server security answer. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| answer* | string | Security answer provided by the user. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"answer",
"confirmed",
"channelOAuthId"
],
"properties": {
"answer": {
"type": "string",
"description": "Security answer provided by the user."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Sends a No-API Server verification code. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| code* | string | Verification code received by the user. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"code",
"confirmed",
"channelOAuthId"
],
"properties": {
"code": {
"type": "string",
"description": "Verification code received by the user."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Sets the manual tracking/reference state for one exact order line using WAPI ManualTrackingIdSet. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Sets/corrects the shipping address for an order resolved from the visible order Reference. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI shipping address payload. Include shippingAddress only; the MCP resolves the order line from the visible order Reference. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI shipping address payload. Include shippingAddress only; the MCP resolves the order line from the visible order Reference."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Stops orders resolved from visible order Reference. Requires confirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| reference | string | Visible marketplace/order reference. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"reference": {
"type": "string",
"description": "Visible marketplace/order reference."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}Terminates one active listing by visible Product ID. Requires confirmed=true and impactConfirmed=true after warning about consequences. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this for active or terminated listings. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
| pendingListingId | integer | Visible pending listing id, only for pending listings where HGRWeb shows this id. |
{
"type": "object",
"required": [
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this for active or terminated listings."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
},
"pendingListingId": {
"type": "integer",
"description": "Visible pending listing id, only for pending listings where HGRWeb shows this id."
}
},
"additionalProperties": false
}Updates AI Publisher optimization columns. Requires confirmed=true and impactConfirmed=true. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI optimization body: OptimizeTitles, OptimizeDescriptions, OptimizeFields. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI optimization body: OptimizeTitles, OptimizeDescriptions, OptimizeFields."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Changes editable fields of one exact listing variation using HGRApi SaveProductChanges. Call only after the listing is exact and the user explicitly confirmed the action. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| notes | string | New listing notes. |
| price | number | New channel price. |
| title | string | New listing title. |
| markup | number | New percentage markup. |
| quantity | integer | New channel stock quantity. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact change. |
| primeOnly | boolean | Whether this listing should use Prime-only source offers when applicable. |
| productId | string | Visible marketplace Product Id / primary id. Prefer this when the user provides a Product Id. |
| sourceUrl | string |
Updates No-API Server credentials/configuration with the exact WAPI credentials array for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally, confirmed=true and impactConfirmed=true. Never returns passwords.
| Argument | Type | Description |
|---|---|---|
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact credential/configuration change. |
| credentials* | any | Exact WAPI ManagedServerCredentials[] array. Password values are accepted as input but never returned. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete credential/configuration consequences. |
{
"type": "object",
"required": [
"credentials",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact credential/configuration change."
},
"credentials": {
"description": "Exact WAPI ManagedServerCredentials[] array. Password values are accepted as input but never returned."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete credential/configuration consequences."
}
},
"additionalProperties": false
}Updates Price Warrior settings for one visible store. Requires confirmed=true and impactConfirmed=true because repricing can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI PriceWarrior UpdateSettingsRequest body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI PriceWarrior UpdateSettingsRequest body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Updates a pricing rule for one visible store. Requires confirmed=true and impactConfirmed=true because pricing rules can affect many listings. Requires HGRApi Header channel / ChannelOAuthId resolved internally.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI PricingRulesUpdateRequest body: RuleId and supported rule fields. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI PricingRulesUpdateRequest body: RuleId and supported rule fields."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Updates a listing template for one visible store/channel. Requires HGRApi Header channel / ChannelOAuthId resolved internally, confirmed=true and impactConfirmed=true because templates can affect publishing flows.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI Templates UpdateRequest body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI Templates UpdateRequest body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}Updates or deactivates a Virtual Assistant / VA profile. Requires confirmed=true.
| Argument | Type | Description |
|---|---|---|
| body* | any | WAPI UpdateRequest body: Id, Active and other supported fields. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
{
"type": "object",
"required": [
"body",
"confirmed"
],
"properties": {
"body": {
"description": "WAPI UpdateRequest body: Id, Active and other supported fields."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
}
},
"additionalProperties": false
}| string |
| Field used to sort before limit/pagination. |
| sortDirection | string | Sort direction. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"page": {
"type": "integer",
"description": "One-based page number."
},
"limit": {
"type": "integer",
"description": "Maximum number of rows to return. HGRApi maximum is 10000."
},
"fields": {
"type": "array",
"items": {
"enum": [
"listingId",
"productId",
"title",
"status",
"origin",
"publishedOn",
"salePrice",
"stock",
"sourcePrice",
"sourceStock",
"source",
"sourceId",
"variationCount"
],
"type": "string"
},
"description": "Fields to return. Use projection for compact answers."
},
"offset": {
"type": "integer",
"description": "Zero-based row offset."
},
"sortBy": {
"enum": [
"listingId",
"productId",
"title",
"publishedOn",
"salePrice",
"stock",
"sourcePrice",
"sourceStock",
"variationCount"
],
"type": "string",
"description": "Field used to sort before limit/pagination."
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| Whether to include We List For You pending items. |
{
"type": "object",
"required": [
"channelOAuthId"
],
"properties": {
"page": {
"type": "integer",
"description": "One-based page number."
},
"limit": {
"type": "integer",
"description": "Maximum number of rows to return. HGRApi maximum is 10000."
},
"fields": {
"type": "array",
"items": {
"enum": [
"listingId",
"productId",
"title",
"status",
"origin",
"createdOn",
"listedOn",
"dontListUntil",
"salePrice",
"stock",
"sourcePrice",
"sourceStock",
"sourceId",
"variationCount"
],
"type": "string"
},
"description": "Fields to return. Use projection for compact answers."
},
"offset": {
"type": "integer",
"description": "Zero-based row offset."
},
"sortBy": {
"enum": [
"listingId",
"productId",
"title",
"createdOn",
"listedOn",
"dontListUntil",
"salePrice",
"stock",
"sourcePrice",
"sourceStock",
"variationCount"
],
"type": "string",
"description": "Field used to sort before limit/pagination."
},
"sortDirection": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"showWeListForYou": {
"type": "boolean",
"description": "Whether to include We List For You pending items."
}
},
"additionalProperties": false
}| Argument | Type | Description |
|---|---|---|
| body* | any | HGRApi POST /api/Catalog/GetProducts request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Catalog/GetProducts request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Catalog/SubmitCatalog request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/ClearOneVariation request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/MonitorExistingListing request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ChannelListing/MonitorExistingListing2 request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| impactConfirmed* |
| boolean |
| Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/MigrateBulk request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/RelistedBulk2 request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| integer |
| ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/SaveAutolist request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| any |
| HGRApi POST /api/Listing/SaveBulkPublish request body. Internal-only request fields are removed automatically. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Listing/SaveBulkPublish request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}| Description |
|---|
| body* | any | HGRApi POST /api/ListingCreate/GetData request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ListingCreate/GetData request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| body* |
| any |
| HGRApi POST /api/ListingCreate/GetDataByPSIds request body. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ListingCreate/GetDataByPSIds request body."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/ListingCreate/Submit request body. Internal-only request fields are removed automatically."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/ForceProcessOrderLine request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/Sales/GenerateTrackingId request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| boolean |
| Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/ListNow request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/PauseToReview request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}| ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| impactConfirmed* | boolean | Must be true after the user explicitly confirmed the concrete high-impact consequences. |
{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/RemoveListing request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}| body* |
| any |
| HGRApi POST /api/SearchProduct/SaveMultipleProductChanges request body. |
| confirmed* | boolean | Must be true after the user explicitly requested or confirmed the exact action. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/SaveMultipleProductChanges request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST /api/SearchProduct/TerminateListing2 request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "HGRApi POST ai publisher filters new request body."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
}
},
"additionalProperties": false
}{
"type": "object",
"required": [
"body",
"confirmed",
"impactConfirmed",
"channelOAuthId"
],
"properties": {
"body": {
"description": "WAPI SaveAgentChannelConfigurationRequest body, for example Enabled=true/false."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact action."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"impactConfirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly confirmed the concrete high-impact consequences."
},
"acceptedAiAgentTerms": {
"type": "boolean",
"description": "Required as true when enabling AI Agent."
},
"disableWarningConfirmed": {
"type": "boolean",
"description": "Required as true when disabling AI Agent after warning that it will stop learning and may need to start over if reactivated."
}
},
"additionalProperties": false
}| New source product URL. |
| ignoreRules | boolean | Whether this listing ignores pricing rules. |
| markupFixed | number | New fixed markup. |
| minQuantity | number | New minimum quantity setting. |
| monitorPrice | boolean | Whether HGR should monitor source price for this listing. |
| monitorStock | boolean | Whether HGR should monitor source stock for this listing. |
| returnPolicy | integer | New marketplace return business policy id. |
| paymentPolicy | integer | New marketplace payment business policy id. |
| channelOAuthId* | integer | ChannelOAuthId returned by hgr_list_channels for the selected visible store. |
| shippingPolicy | integer | New marketplace shipping business policy id. |
| maxDeliveryDays | number | New maximum delivery days setting. |
| dispatchTimeDays | number | New dispatch handling time in days. |
| variationProductId | string | Visible variation Product Id / primary id when the listing has multiple variations. |
| monitorPriceDecrease | boolean | Whether HGR should monitor source price decreases for this listing. |
| priceDecreasePercentage | number | Price decrease percentage setting. |
{
"type": "object",
"required": [
"confirmed",
"channelOAuthId"
],
"properties": {
"notes": {
"type": "string",
"description": "New listing notes."
},
"price": {
"type": "number",
"description": "New channel price."
},
"title": {
"type": "string",
"description": "New listing title."
},
"markup": {
"type": "number",
"description": "New percentage markup."
},
"quantity": {
"type": "integer",
"description": "New channel stock quantity."
},
"confirmed": {
"type": "boolean",
"description": "Must be true after the user explicitly requested or confirmed the exact change."
},
"primeOnly": {
"type": "boolean",
"description": "Whether this listing should use Prime-only source offers when applicable."
},
"productId": {
"type": "string",
"description": "Visible marketplace Product Id / primary id. Prefer this when the user provides a Product Id."
},
"sourceUrl": {
"type": "string",
"description": "New source product URL."
},
"ignoreRules": {
"type": "boolean",
"description": "Whether this listing ignores pricing rules."
},
"markupFixed": {
"type": "number",
"description": "New fixed markup."
},
"minQuantity": {
"type": "number",
"description": "New minimum quantity setting."
},
"monitorPrice": {
"type": "boolean",
"description": "Whether HGR should monitor source price for this listing."
},
"monitorStock": {
"type": "boolean",
"description": "Whether HGR should monitor source stock for this listing."
},
"returnPolicy": {
"type": "integer",
"description": "New marketplace return business policy id."
},
"paymentPolicy": {
"type": "integer",
"description": "New marketplace payment business policy id."
},
"channelOAuthId": {
"type": "integer",
"description": "ChannelOAuthId returned by hgr_list_channels for the selected visible store."
},
"shippingPolicy": {
"type": "integer",
"description": "New marketplace shipping business policy id."
},
"maxDeliveryDays": {
"type": "number",
"description": "New maximum delivery days setting."
},
"dispatchTimeDays": {
"type": "number",
"description": "New dispatch handling time in days."
},
"variationProductId": {
"type": "string",
"description": "Visible variation Product Id / primary id when the listing has multiple variations."
},
"monitorPriceDecrease": {
"type": "boolean",
"description": "Whether HGR should monitor source price decreases for this listing."
},
"priceDecreasePercentage": {
"type": "number",
"description": "Price decrease percentage setting."
}
},
"additionalProperties": false
}