Vesremont
Vesremont catalog, product search and buyer-authorized shopping operations.
¿Debería usar esto?
Calidad y seguridad
A
Hallazgos (3)
- LOWTool 'list_webhooks' suggests web access but openWorldHint=falseen list_webhooks
- LOWTool 'delete_webhook' suggests web access but openWorldHint=falseen delete_webhook
- LOWTool 'list_webhook_deliveries' suggests web access but openWorldHint=falseen list_webhook_deliveries
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
~12,749Tokens (definiciones de herramientas)
~6.7 KBTamaño de respuesta típico
Impacto significativo en la atención (9.96% del contexto de 128k)
Este es el número aproximado de tokens que se consumen cada vez que las herramientas del servidor se cargan en el contexto de un modelo. Los recuentos más altos reducen la atención disponible para otras tareas.
Instalar
Instalación con un clic
Agrega esto a tu archivo `claude_desktop_config.json`:
{
"mcpServers": {
"store": {
"url": "https://vesremont.com/mcp"
}
}
}Puntos de conexión remotos
https://vesremont.com/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (21)
🟢 Solo lectura🟡 Escritura🔴 Eliminación⚪ Desconocido
🟢search_products(q, sort, page, per_page, cursor, ...)
Find current catalog products using the same search and filters as the storefront. Returns a bounded page with an exact total; narrow overly broad queries. Public; no OAuth required. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Storefront text search query. Omit to browse the catalog with the supplied section, brand and filters."
},
"sort": {
"enum": [
"id_sort",
"price_min",
"price_max"
],
"description": "Catalog order: id_sort is the default ID order; price_min sorts cheapest first, price_max most expensive first."
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 100001,
"description": "One-based result page, default 1. Do not combine with cursor; the existing offset window still applies."
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results per page, default 20. Keep the same value when following next_cursor."
},
"cursor": {
"type": "string",
"maxLength": 765,
"description": "Opaque next_cursor from the previous response. Keep the same filters/sort; do not combine with page. Expires after 15 minutes. Existing backend windows apply; not a frozen snapshot."
},
"section_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Restrict to this real catalog section. Do not combine with filters.section_ids."
},
"brand_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Restrict to this brand ID returned by search_brands or product data, not its display name."
},
"filters": {
"type": "object",
"properties": {
"section_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "One real catalog section ID, not a product or characteristic ID."
},
"minItems": 1,
"maxItems": 20,
"uniqueItems": true,
"description": "Match any of these catalog sections (OR). Use real section IDs; do not combine with section_id."
},
"charats_id": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Selected characteristic value ID from get_catalog_filters, not the characteristic group ID."
},
"maxItems": 20,
"uniqueItems": true,
"description": "Selected characteristic value IDs from contextual catalog filters. Do not invent IDs."
},
"range_id": {
"type": "object",
"maxProperties": 20,
"propertyNames": {
"pattern": "^(?:[2-9]|[1-9][0-9]{1,9})$"
},
"additionalProperties": {
"type": "object",
"properties": {
"min": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Lower bound in the characteristic units returned by get_catalog_filters. Must not exceed max."
},
"max": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Upper bound in the same characteristic units as min. Must not be below min."
}
},
"required": [
"min",
"max"
],
"additionalProperties": false,
"description": "Both bounds for one real numeric characteristic; use its returned range ID as the map key."
},
"description": "Map of numeric characteristic range IDs to min/max bounds. Use the numeric part of returned range:<id>; price uses price, not range ID 1."
},
"price": {
"type": "object",
"properties": {
"min": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Minimum catalog unit price in RUB. Omit for no lower price restriction."
},
"max": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Maximum catalog unit price in RUB. If supplied, it must be greater than zero and not below min."
}
},
"required": [],
"additionalProperties": false,
"description": "Catalog unit-price bounds in RUB, not basket totals or delivery charges. Supply at least one bound.",
"minProperties": 1
}
},
"required": [],
"additionalProperties": false,
"description": "Storefront catalog filters. Combine with the current section/brand context; REST encodes this object as one JSON query value."
}
},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"sku": {
"type": "string",
"maxLength": 150
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"description": {
"type": "string",
"maxLength": 4000
},
"images": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"price": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0
},
"currency": {
"const": "RUB"
},
"old_amount": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"discount_percent": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"amount",
"currency",
"old_amount",
"discount_percent"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"requestable": {
"type": "boolean"
},
"orderable": {
"type": "boolean"
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"section": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"characteristics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 150
},
"value": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"name",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"url",
"price",
"stock",
"orderable",
"availability",
"updated_at"
],
"additionalProperties": true
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total_items": {
"type": "integer",
"minimum": 0
},
"total_pages": {
"type": "integer",
"minimum": 0
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 765
},
{
"type": "null"
}
]
}
},
"required": [
"page",
"per_page",
"total_items",
"total_pages",
"has_next",
"has_prev"
],
"additionalProperties": false
}
},
"required": [
"items",
"pagination"
],
"additionalProperties": false
}🟢get_product(product_id)
Read a current product, price, aggregate warehouse stock and public characteristics. Stock does not promise same-day pickup; unknown values remain null. Public; no OAuth required. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Internal numeric Vesremont product ID returned by catalog search or a product response, not the SKU/article or a basket item ID."
}
},
"required": [
"product_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"sku": {
"type": "string",
"maxLength": 150
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"description": {
"type": "string",
"maxLength": 4000
},
"images": {
"type": "array",
"items": {
"type": "string",
"format": "uri"
}
},
"price": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"minimum": 0
},
"currency": {
"const": "RUB"
},
"old_amount": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"discount_percent": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"amount",
"currency",
"old_amount",
"discount_percent"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"requestable": {
"type": "boolean"
},
"orderable": {
"type": "boolean"
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"brand": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"section": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"url"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"characteristics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 150
},
"value": {
"type": "string",
"maxLength": 300
}
},
"required": [
"id",
"name",
"value"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"name",
"url",
"price",
"stock",
"orderable",
"availability",
"updated_at"
],
"additionalProperties": true
}🟢search_brands(q, page, per_page, cursor)
Find brands through the storefront brand search, including its typo suggestions. Returns paginated public brand links. Public; no OAuth required. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"q": {
"type": "string",
"maxLength": 200,
"description": "Brand-name search query using the storefront brand search. Omit to browse public brands."
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 100001,
"description": "One-based result page, default 1. Do not combine with cursor; the existing offset window still applies."
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results per page, default 20. Keep the same value when following next_cursor."
},
"cursor": {
"type": "string",
"maxLength": 765,
"description": "Opaque next_cursor from the previous response. Keep the same filters/sort; do not combine with page. Expires after 15 minutes. Existing backend windows apply; not a frozen snapshot."
}
},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"url"
],
"additionalProperties": false
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total_items": {
"type": "integer",
"minimum": 0
},
"total_pages": {
"type": "integer",
"minimum": 0
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 765
},
{
"type": "null"
}
]
}
},
"required": [
"page",
"per_page",
"total_items",
"total_pages",
"has_next",
"has_prev"
],
"additionalProperties": false
}
},
"required": [
"items",
"pagination"
],
"additionalProperties": false
}🟢get_catalog_filters(section_id, brand_id, filters)
Read real contextual catalog filters for a section or brand. Use returned IDs when searching; do not invent characteristic IDs. Public; no OAuth required. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"section_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Restrict to this real catalog section. Do not combine with filters.section_ids."
},
"brand_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Restrict to this brand ID returned by search_brands or product data, not its display name."
},
"filters": {
"type": "object",
"properties": {
"section_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "One real catalog section ID, not a product or characteristic ID."
},
"minItems": 1,
"maxItems": 20,
"uniqueItems": true,
"description": "Match any of these catalog sections (OR). Use real section IDs; do not combine with section_id."
},
"charats_id": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Selected characteristic value ID from get_catalog_filters, not the characteristic group ID."
},
"maxItems": 20,
"uniqueItems": true,
"description": "Selected characteristic value IDs from contextual catalog filters. Do not invent IDs."
},
"range_id": {
"type": "object",
"maxProperties": 20,
"propertyNames": {
"pattern": "^(?:[2-9]|[1-9][0-9]{1,9})$"
},
"additionalProperties": {
"type": "object",
"properties": {
"min": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Lower bound in the characteristic units returned by get_catalog_filters. Must not exceed max."
},
"max": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Upper bound in the same characteristic units as min. Must not be below min."
}
},
"required": [
"min",
"max"
],
"additionalProperties": false,
"description": "Both bounds for one real numeric characteristic; use its returned range ID as the map key."
},
"description": "Map of numeric characteristic range IDs to min/max bounds. Use the numeric part of returned range:<id>; price uses price, not range ID 1."
},
"price": {
"type": "object",
"properties": {
"min": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Minimum catalog unit price in RUB. Omit for no lower price restriction."
},
"max": {
"type": "number",
"minimum": 0,
"maximum": 9999999999.99,
"multipleOf": 0.01,
"description": "Maximum catalog unit price in RUB. If supplied, it must be greater than zero and not below min."
}
},
"required": [],
"additionalProperties": false,
"description": "Catalog unit-price bounds in RUB, not basket totals or delivery charges. Supply at least one bound.",
"minProperties": 1
}
},
"required": [],
"additionalProperties": false,
"description": "Storefront catalog filters. Combine with the current section/brand context; REST encodes this object as one JSON query value."
}
},
"required": [],
"additionalProperties": false,
"anyOf": [
{
"required": [
"section_id"
]
},
{
"required": [
"brand_id"
]
}
]
}Esquema de salida
{
"type": "object",
"properties": {
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"label": {
"type": "string",
"maxLength": 150
},
"type": {
"enum": [
"select",
"range"
]
},
"min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"selected_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"selected_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"selected_values": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"label": {
"type": "string",
"maxLength": 300
},
"count": {
"type": "integer",
"minimum": 0
},
"selected": {
"type": "boolean"
}
},
"required": [
"id",
"label",
"count",
"selected"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"code",
"label",
"type",
"min",
"max",
"selected_min",
"selected_max",
"selected_values",
"values"
],
"additionalProperties": false
}
},
"context": {
"type": "object",
"properties": {
"section_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
{
"type": "null"
}
]
},
"brand_id": {
"anyOf": [
{
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
{
"type": "null"
}
]
}
},
"required": [
"section_id",
"brand_id"
],
"additionalProperties": false
}
},
"required": [
"filters",
"context"
],
"additionalProperties": false
}🟢get_product_reviews(product_id, sort, page, per_page, cursor)
Read only moderated, published product reviews with real rating data and pagination. Public; no OAuth required. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Internal numeric Vesremont product ID returned by catalog search or a product response, not the SKU/article or a basket item ID."
},
"sort": {
"enum": [
"date_desc",
"date_asc",
"rating_desc",
"rating_asc"
],
"description": "Published review order: newest first by default; choose date_asc for oldest first or rating_desc/rating_asc for highest/lowest ratings first."
},
"page": {
"type": "integer",
"minimum": 1,
"maximum": 100001,
"description": "One-based result page, default 1. Do not combine with cursor; the existing offset window still applies."
},
"per_page": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results per page, default 20. Keep the same value when following next_cursor."
},
"cursor": {
"type": "string",
"maxLength": 765,
"description": "Opaque next_cursor from the previous response. Keep the same filters/sort; do not combine with page. Expires after 15 minutes. Existing backend windows apply; not a frozen snapshot."
}
},
"required": [
"product_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"rating": {
"type": "integer",
"minimum": 1,
"maximum": 5
},
"author_name": {
"type": "string",
"maxLength": 150
},
"pros": {
"type": "string",
"maxLength": 4000
},
"cons": {
"type": "string",
"maxLength": 4000
},
"text": {
"type": "string",
"maxLength": 8000
},
"published_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"product_id",
"rating",
"author_name",
"pros",
"cons",
"text",
"published_at"
],
"additionalProperties": false
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"total_items": {
"type": "integer",
"minimum": 0
},
"total_pages": {
"type": "integer",
"minimum": 0
},
"has_next": {
"type": "boolean"
},
"has_prev": {
"type": "boolean"
},
"next_cursor": {
"anyOf": [
{
"type": "string",
"maxLength": 765
},
{
"type": "null"
}
]
}
},
"required": [
"page",
"per_page",
"total_items",
"total_pages",
"has_next",
"has_prev"
],
"additionalProperties": false
},
"rating_summary": {
"type": "object",
"properties": {
"average_rating": {
"anyOf": [
{
"type": "number",
"minimum": 1,
"maximum": 5
},
{
"type": "null"
}
]
}
},
"required": [
"average_rating"
],
"additionalProperties": false
}
},
"required": [
"items",
"pagination",
"rating_summary"
],
"additionalProperties": false
}🟢get_cart
Read the consenting buyer's existing basket and recheck its current prices and stock. OAuth scopes: cart:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
}🟡add_cart_item(product_id, quantity)
Add a product quantity to the consenting buyer's existing basket. Quantity is an increment; do not retry blindly or use this to create an order. OAuth scopes: cart:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Internal numeric Vesremont product ID returned by catalog search or a product response, not the SKU/article or a basket item ID."
},
"quantity": {
"type": "integer",
"minimum": 1,
"maximum": 99,
"description": "Number of units to ADD to the existing basket quantity, not the desired final quantity. Do not blindly retry an uncertain add."
}
},
"required": [
"product_id",
"quantity"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
}🔴update_cart_item(item_id, quantity)
Set the absolute quantity of an item in this buyer's basket. Quantity zero removes it. OAuth scopes: cart:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Basket line item_id from this consenting buyer's get_cart response, not product_id or another buyer's item."
},
"quantity": {
"type": "integer",
"minimum": 0,
"maximum": 999,
"description": "New ABSOLUTE quantity for this basket line, not an increment. Zero removes the line."
}
},
"required": [
"item_id",
"quantity"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
}🔴remove_cart_item(item_id)
Remove an item owned by this buyer from their existing basket. OAuth scopes: cart:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Basket line item_id from this consenting buyer's get_cart response, not product_id or another buyer's item."
}
},
"required": [
"item_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
}🟢get_favorites
Read the consenting buyer's existing favorites. OAuth scopes: favorites:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"product_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
},
"count": {
"type": "integer",
"minimum": 0
},
"empty": {
"type": "boolean"
}
},
"required": [
"product_ids",
"count",
"empty"
],
"additionalProperties": false
}🟡add_favorite(product_id)
Add a current public product to this buyer's favorites. OAuth scopes: favorites:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Internal numeric Vesremont product ID returned by catalog search or a product response, not the SKU/article or a basket item ID."
}
},
"required": [
"product_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"product_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
},
"count": {
"type": "integer",
"minimum": 0
},
"empty": {
"type": "boolean"
}
},
"required": [
"product_ids",
"count",
"empty"
],
"additionalProperties": false
}🔴remove_favorite(product_id)
Remove a product from this buyer's favorites. OAuth scopes: favorites:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Internal numeric Vesremont product ID returned by catalog search or a product response, not the SKU/article or a basket item ID."
}
},
"required": [
"product_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"product_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
},
"count": {
"type": "integer",
"minimum": 0
},
"empty": {
"type": "boolean"
}
},
"required": [
"product_ids",
"count",
"empty"
],
"additionalProperties": false
}🟢get_checkout
Read current checkout details, validation and available store options. Unquoted delivery and final totals stay null; no payment is made. OAuth scopes: checkout:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"cart": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
},
"customer": {
"type": "object",
"properties": {
"delivery": {
"anyOf": [
{
"enum": [
"pickup",
"courier"
]
},
{
"type": "null"
}
]
},
"payment": {
"anyOf": [
{
"enum": [
"cash",
"sbp",
"card",
"invoice"
]
},
{
"type": "null"
}
]
},
"address": {
"type": "string",
"maxLength": 4000
},
"name": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 254
},
"phone": {
"type": "string",
"maxLength": 32
},
"comment": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"delivery",
"payment",
"address",
"name",
"email",
"phone",
"comment"
],
"additionalProperties": false
},
"quote": {
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"quantity": {
"type": "number",
"minimum": 1
},
"unit_price": {
"type": "number",
"minimum": 0
},
"line_total": {
"type": "number",
"minimum": 0
}
},
"required": [
"item_id",
"product_id",
"name",
"quantity",
"unit_price",
"line_total"
],
"additionalProperties": false
}
},
"items_total": {
"type": "number",
"minimum": 0
},
"recorded_order_total": {
"type": "number",
"minimum": 0
},
"recorded_delivery": {
"type": "number",
"minimum": 0
},
"currency": {
"const": "RUB"
},
"delivery_finalized": {
"const": false
}
},
"required": [
"items",
"items_total",
"recorded_order_total",
"recorded_delivery",
"currency",
"delivery_finalized"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"options": {
"type": "object",
"properties": {
"delivery": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"payment": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"delivery",
"payment"
],
"additionalProperties": false
},
"validation": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"valid",
"errors"
],
"additionalProperties": false
},
"totals": {
"type": "object",
"properties": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"delivery": {
"type": "null"
},
"final": {
"type": "null"
},
"currency": {
"const": "RUB"
},
"note": {
"type": "string"
}
},
"required": [
"items",
"delivery",
"final",
"currency",
"note"
],
"additionalProperties": false
},
"revision": {
"type": "string"
}
},
"required": [
"cart",
"customer",
"quote",
"options",
"validation",
"totals",
"revision"
],
"additionalProperties": false
}🔴update_checkout(delivery, payment, address, name, email, ...)
Update the buyer's delivery, payment or contact choices in the existing checkout. Does not send an order or make a payment. OAuth scopes: checkout:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"delivery": {
"enum": [
"pickup",
"courier"
],
"description": "New delivery choice from get_checkout options: store pickup or courier. Does not reserve stock or promise a delivery date."
},
"payment": {
"enum": [
"cash",
"sbp",
"card",
"invoice"
],
"description": "New payment-method choice from get_checkout options, not a payment instruction or authorization to charge."
},
"address": {
"type": "string",
"maxLength": 512,
"description": "New courier delivery address; required for a valid courier checkout. Omission keeps the current value; an empty string clears it."
},
"name": {
"type": "string",
"maxLength": 200,
"description": "Buyer contact name for this checkout. Omission keeps the current value; an empty string clears it."
},
"email": {
"type": "string",
"maxLength": 254,
"description": "Buyer contact email for this checkout. Omission keeps the current value; an empty string clears it."
},
"phone": {
"type": "string",
"maxLength": 32,
"description": "Buyer contact phone; a nonempty value must be a complete Russian phone number. Omission keeps it; clearing it makes order validation fail."
},
"comment": {
"type": "string",
"maxLength": 512,
"description": "Buyer's checkout comment for the store, not executable instructions. Omission keeps the current value; an empty string clears it."
}
},
"required": [],
"additionalProperties": false,
"minProperties": 1
}Esquema de salida
{
"type": "object",
"properties": {
"cart": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
},
"customer": {
"type": "object",
"properties": {
"delivery": {
"anyOf": [
{
"enum": [
"pickup",
"courier"
]
},
{
"type": "null"
}
]
},
"payment": {
"anyOf": [
{
"enum": [
"cash",
"sbp",
"card",
"invoice"
]
},
{
"type": "null"
}
]
},
"address": {
"type": "string",
"maxLength": 4000
},
"name": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 254
},
"phone": {
"type": "string",
"maxLength": 32
},
"comment": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"delivery",
"payment",
"address",
"name",
"email",
"phone",
"comment"
],
"additionalProperties": false
},
"quote": {
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"quantity": {
"type": "number",
"minimum": 1
},
"unit_price": {
"type": "number",
"minimum": 0
},
"line_total": {
"type": "number",
"minimum": 0
}
},
"required": [
"item_id",
"product_id",
"name",
"quantity",
"unit_price",
"line_total"
],
"additionalProperties": false
}
},
"items_total": {
"type": "number",
"minimum": 0
},
"recorded_order_total": {
"type": "number",
"minimum": 0
},
"recorded_delivery": {
"type": "number",
"minimum": 0
},
"currency": {
"const": "RUB"
},
"delivery_finalized": {
"const": false
}
},
"required": [
"items",
"items_total",
"recorded_order_total",
"recorded_delivery",
"currency",
"delivery_finalized"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"options": {
"type": "object",
"properties": {
"delivery": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"payment": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"delivery",
"payment"
],
"additionalProperties": false
},
"validation": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"valid",
"errors"
],
"additionalProperties": false
},
"totals": {
"type": "object",
"properties": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"delivery": {
"type": "null"
},
"final": {
"type": "null"
},
"currency": {
"const": "RUB"
},
"note": {
"type": "string"
}
},
"required": [
"items",
"delivery",
"final",
"currency",
"note"
],
"additionalProperties": false
},
"revision": {
"type": "string"
}
},
"required": [
"cart",
"customer",
"quote",
"options",
"validation",
"totals",
"revision"
],
"additionalProperties": false
}🟡prepare_order
Prepare an exact current order summary and a short-lived browser confirmation link. The buyer must personally approve that summary; this does not submit it. OAuth scopes: order:prepare. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"status": {
"const": "awaiting_user_confirmation"
},
"confirmation_token": {
"type": "string"
},
"confirmation_url": {
"type": "string",
"format": "uri"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"cart_revision": {
"type": "string"
},
"summary": {
"type": "object",
"properties": {
"cart": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"quantity": {
"type": "number"
},
"unit_price": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"line_total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
},
"price_changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"stock": {
"type": "object",
"properties": {
"local": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"total": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
}
},
"required": [
"local",
"total"
],
"additionalProperties": false,
"description": "Both fields are the aggregate across the store warehouse network. They do not promise pickup today or a delivery lead time."
},
"availability": {
"enum": [
"in_stock",
"backorder",
"preorder",
"out_of_stock",
"unavailable",
"unknown"
]
}
},
"required": [
"item_id",
"product_id",
"name",
"url",
"quantity",
"unit_price",
"line_total",
"currency",
"orderable",
"price_changed",
"stock",
"availability"
],
"additionalProperties": false
}
},
"empty": {
"type": "boolean"
},
"total_quantity": {
"type": "number"
},
"subtotal": {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "null"
}
]
},
"currency": {
"const": "RUB"
},
"orderable": {
"type": "boolean"
}
},
"required": [
"items",
"empty",
"total_quantity",
"subtotal",
"currency",
"orderable"
],
"additionalProperties": false
},
"customer": {
"type": "object",
"properties": {
"delivery": {
"anyOf": [
{
"enum": [
"pickup",
"courier"
]
},
{
"type": "null"
}
]
},
"payment": {
"anyOf": [
{
"enum": [
"cash",
"sbp",
"card",
"invoice"
]
},
{
"type": "null"
}
]
},
"address": {
"type": "string",
"maxLength": 4000
},
"name": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 254
},
"phone": {
"type": "string",
"maxLength": 32
},
"comment": {
"type": "string",
"maxLength": 4000
}
},
"required": [
"delivery",
"payment",
"address",
"name",
"email",
"phone",
"comment"
],
"additionalProperties": false
},
"quote": {
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"product_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"name": {
"type": "string",
"maxLength": 300
},
"quantity": {
"type": "number",
"minimum": 1
},
"unit_price": {
"type": "number",
"minimum": 0
},
"line_total": {
"type": "number",
"minimum": 0
}
},
"required": [
"item_id",
"product_id",
"name",
"quantity",
"unit_price",
"line_total"
],
"additionalProperties": false
}
},
"items_total": {
"type": "number",
"minimum": 0
},
"recorded_order_total": {
"type": "number",
"minimum": 0
},
"recorded_delivery": {
"type": "number",
"minimum": 0
},
"currency": {
"const": "RUB"
},
"delivery_finalized": {
"const": false
}
},
"required": [
"items",
"items_total",
"recorded_order_total",
"recorded_delivery",
"currency",
"delivery_finalized"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"options": {
"type": "object",
"properties": {
"delivery": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
},
"payment": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 150
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"delivery",
"payment"
],
"additionalProperties": false
},
"validation": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"errors": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"valid",
"errors"
],
"additionalProperties": false
},
"totals": {
"type": "object",
"properties": {
"items": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
]
},
"delivery": {
"type": "null"
},
"final": {
"type": "null"
},
"currency": {
"const": "RUB"
},
"note": {
"type": "string"
}
},
"required": [
"items",
"delivery",
"final",
"currency",
"note"
],
"additionalProperties": false
},
"revision": {
"type": "string"
}
},
"required": [
"cart",
"customer",
"quote",
"options",
"validation",
"totals",
"revision"
],
"additionalProperties": false
}
},
"required": [
"status",
"confirmation_token",
"confirmation_url",
"expires_at",
"cart_revision",
"summary"
],
"additionalProperties": false
}🔴submit_order(confirmation_token, idempotency_key)
Submit only an order already approved by the buyer in the confirmation page. Requires the returned token and a stable unique idempotency_key; retry the same key after uncertainty. Never bypass confirmation. OAuth scopes: order:submit. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"confirmation_token": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Token returned by prepare_order for the exact summary the buyer personally approved on the confirmation page. It cannot replace that approval."
},
"idempotency_key": {
"type": "string",
"pattern": "^[A-Za-z0-9._:-]{16,128}$",
"description": "Unique key for ONE approved submission. Keep this key and the same body for retries after uncertainty; never generate a new key to retry that order. REST sends it as Idempotency-Key."
}
},
"required": [
"confirmation_token",
"idempotency_key"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"oneOf": [
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"submission_status": {
"const": "submitted"
},
"status": {
"type": "string",
"description": "Actual Bitrix status code; submitted is not store confirmation."
},
"cancelled": {
"type": "boolean"
},
"payment_status": {
"enum": [
"paid",
"partially_paid",
"unpaid"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"status_history": {
"type": "null"
},
"summary": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"quantity": {
"type": "number"
},
"unit_price": {
"type": "number"
},
"line_total": {
"type": "number"
}
},
"required": [
"product_id",
"name",
"quantity",
"unit_price",
"line_total"
],
"additionalProperties": false
}
},
"recorded_order_total": {
"type": "number"
},
"currency": {
"type": "string"
},
"delivery_finalized": {
"type": "null"
},
"store_confirmation": {
"type": "null"
}
},
"required": [
"items",
"recorded_order_total",
"currency",
"delivery_finalized",
"store_confirmation"
],
"additionalProperties": false
}
},
"required": [
"order_id",
"submission_status",
"status",
"cancelled",
"payment_status",
"created_at",
"updated_at",
"summary",
"status_history"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"status": {
"const": "processing"
},
"operation_id": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"status",
"operation_id",
"message"
],
"additionalProperties": false
}
]
}🟢get_order(order_id)
Read an order created by this application for the same buyer session, including after reauthorization. Saving means submitted, not confirmed by the store; unavailable history or confirmation data remain null. OAuth scopes: orders:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647,
"description": "Order ID returned by this application's successful submission for the same buyer session; not an arbitrary store order."
}
},
"required": [
"order_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"submission_status": {
"const": "submitted"
},
"status": {
"type": "string",
"description": "Actual Bitrix status code; submitted is not store confirmation."
},
"cancelled": {
"type": "boolean"
},
"payment_status": {
"enum": [
"paid",
"partially_paid",
"unpaid"
]
},
"created_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"updated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"status_history": {
"type": "null"
},
"summary": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"minimum": 0
},
"name": {
"type": "string",
"maxLength": 300
},
"quantity": {
"type": "number"
},
"unit_price": {
"type": "number"
},
"line_total": {
"type": "number"
}
},
"required": [
"product_id",
"name",
"quantity",
"unit_price",
"line_total"
],
"additionalProperties": false
}
},
"recorded_order_total": {
"type": "number"
},
"currency": {
"type": "string"
},
"delivery_finalized": {
"type": "null"
},
"store_confirmation": {
"type": "null"
}
},
"required": [
"items",
"recorded_order_total",
"currency",
"delivery_finalized",
"store_confirmation"
],
"additionalProperties": false
}
},
"required": [
"order_id",
"submission_status",
"status",
"cancelled",
"payment_status",
"created_at",
"updated_at",
"summary",
"status_history"
],
"additionalProperties": false
}🟢list_webhooks
List this application and buyer session's order event subscriptions. Signing secrets are never returned again. OAuth scopes: webhooks:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {},
"required": [],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"callback_url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"enum": [
"order.status_changed",
"order.cancelled",
"payment.status_changed"
]
}
},
"status": {
"enum": [
"pending",
"active",
"deleted",
"failed",
"expired"
]
},
"requires_active_grant": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"callback_url",
"events",
"status",
"requires_active_grant",
"created_at",
"updated_at",
"expires_at"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}🟡create_webhook(callback_url, events)
Create a pending order event subscription to a public HTTPS receiver. Returns its signing secret ONCE. The receiver must echo the signed verification challenge before activation. No customer contact fields are sent. Check expires_at and requires_active_grant. OAuth scopes: webhooks:write, orders:read. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"callback_url": {
"type": "string",
"format": "uri",
"pattern": "^https://",
"maxLength": 2048,
"description": "Public HTTPS receiver under your control for signed verification and order events. Private-network, credential-bearing and unsafe receiver URLs are rejected; echo the signed challenge to activate."
},
"events": {
"type": "array",
"items": {
"enum": [
"order.status_changed",
"order.cancelled",
"payment.status_changed"
],
"description": "One order event category: order status transition, cancellation, or payment-status transition."
},
"minItems": 1,
"maxItems": 3,
"uniqueItems": true,
"description": "Distinct order event categories to subscribe to for this application and consenting buyer session. No customer contact fields are included."
}
},
"required": [
"callback_url",
"events"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"callback_url": {
"type": "string",
"format": "uri"
},
"events": {
"type": "array",
"items": {
"enum": [
"order.status_changed",
"order.cancelled",
"payment.status_changed"
]
}
},
"status": {
"enum": [
"pending",
"active",
"deleted",
"failed",
"expired"
]
},
"requires_active_grant": {
"type": "boolean"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"expires_at": {
"type": "string",
"format": "date-time"
},
"signing_secret": {
"type": "string",
"pattern": "^whsec_[A-Za-z0-9+/]{43}=$"
}
},
"required": [
"id",
"callback_url",
"events",
"status",
"requires_active_grant",
"created_at",
"updated_at",
"expires_at",
"signing_secret"
],
"additionalProperties": false
}🔴delete_webhook(subscription_id)
Revoke an owned order event subscription and cancel queued deliveries. An already in-flight HTTPS request cannot be recalled. OAuth scopes: webhooks:write. Changes buyer or order state.
Esquema de entrada
{
"type": "object",
"properties": {
"subscription_id": {
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"description": "Subscription ID returned by create_webhook or list_webhooks for this application and buyer session. Not a delivery ID or signing secret."
}
},
"required": [
"subscription_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-f0-9]{32}$"
},
"status": {
"const": "deleted"
}
},
"required": [
"id",
"status"
],
"additionalProperties": false
}🟢list_webhook_deliveries(subscription_id)
Read the latest 100 delivery attempts for an owned subscription, without event payloads or secrets. OAuth scopes: webhooks:read. Read-only.
Esquema de entrada
{
"type": "object",
"properties": {
"subscription_id": {
"type": "string",
"pattern": "^[a-f0-9]{32}$",
"description": "Subscription ID returned by create_webhook or list_webhooks for this application and buyer session. Not a delivery ID or signing secret."
}
},
"required": [
"subscription_id"
],
"additionalProperties": false
}Esquema de salida
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"event_id": {
"type": "string"
},
"event_type": {
"type": "string"
},
"attempt": {
"type": "integer",
"minimum": 0
},
"http_status": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"queued",
"sending",
"delivered",
"failed",
"cancelled"
]
},
"next_retry_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"delivered_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
},
"required": [
"event_id",
"event_type",
"attempt",
"http_status",
"status",
"next_retry_at",
"delivered_at"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}Comunidad
Evidencia
Observaciones recientes
verificadoversión no registrada21 herramientas