Order Desk MCP by usefulapi
Search Order Desk orders and inventory; read order items and shipments; create or update orders.
¿Debería usar esto?
Calidad y seguridad
A
Hallazgos (2)
- LOWTool 'orderdesk_create_inventory_item' name length outside 3-30 rangeen orderdesk_create_inventory_item
- LOWTool 'orderdesk_update_inventory_item' name length outside 3-30 rangeen orderdesk_update_inventory_item
Basado en el análisis automatizado de las definiciones de herramientas y el cumplimiento del protocolo.
Costo de contexto
~5,629Tokens (definiciones de herramientas)
~3.4 KBTamaño de respuesta típico
Impacto significativo en la atención (4.40% 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": {
"order-desk": {
"url": "https://order-desk.usefulapi.io/mcp"
}
}
}Puntos de conexión remotos
https://order-desk.usefulapi.io/mcpstreamable-httpQué puede hacer
Inventario de herramientas
Herramientas (15)
🟢 Solo lectura🟡 Escritura🔴 Eliminación⚪ Desconocido
🟢orderdesk_get_store
The store's name, id, FOLDERS (id -> name; orders live in exactly one folder, and folder ids are needed to filter and move orders) and key settings (timezone, locale, stock behavior, shipping methods). The API key and mail credentials are never returned. GET /store.
Esquema de entrada
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_list_orders(folder_id, folder_name, source_id, source_name, added_from, ...)
Search orders, newest first, with items, addresses, totals, payment and shipments. Filters combine with AND. Prefer a date range: Order Desk asks clients to avoid open-ended queries. Page with limit and offset (next_offset). GET /orders.
Esquema de entrada
{
"type": "object",
"properties": {
"folder_id": {
"description": "Folder id, or several separated by commas (see orderdesk_get_store).",
"type": "string",
"pattern": "^\\d{1,12}(,\\d{1,12}){0,19}$"
},
"folder_name": {
"description": "The folder's exact name instead of its id.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_id": {
"description": "Your original order id from the cart or marketplace.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"source_name": {
"description": "Order source name (cart or marketplace).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"added_from": {
"description": "Orders added on or after this time (a date means the start of that UTC day).",
"type": "string"
},
"added_to": {
"description": "Orders added on or before this time (a date means the end of that UTC day).",
"type": "string"
},
"modified_from": {
"description": "Orders modified on or after this time.",
"type": "string"
},
"modified_to": {
"description": "Orders modified on or before this time.",
"type": "string"
},
"email": {
"description": "Customer e-mail address.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"customer_id": {
"description": "Customer id in the originating system.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"customer_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"customer_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"shipping_last_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"shipping_first_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"include_history": {
"description": "Include each order's history (slow; use with a small limit).",
"type": "boolean"
},
"order_by": {
"description": "Order field to sort by (default date_added).",
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,39}$"
},
"order": {
"description": "Sort direction (default DESC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"limit": {
"description": "How many records to return, 1-100 (default 20).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_get_order(order_id)
One order by Order Desk's internal id: addresses, items, totals, payment, notes, discounts, checkout data and shipments. To find an order by your own id, use orderdesk_list_orders with source_id. GET /orders/{order_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id (not the cart's order number)."
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_list_order_items(order_id)
The line items of one order (name, SKU, price, quantity, weight, delivery type, variations). GET /orders/{order_id}/order-items.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_list_order_shipments(order_id)
The shipments recorded against an order: carrier, tracking number and URL, method, weight, cost, dates. GET /orders/{order_id}/shipments.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_create_order(order_items, shipping, customer, email, source_id, ...)
WRITE: add a new order to the store. Needs at least one item, and a name or company in the shipping or customer address (if only one address is given the other is copied from it). Omit folder_id to land in the first folder. Order Desk rejects an order it recognizes as a duplicate and names the existing order id. POST /orders.
Esquema de entrada
{
"type": "object",
"properties": {
"order_items": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 500
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"quantity": {
"description": "Defaults to 1.",
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"weight": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"code": {
"description": "Item SKU or product code.",
"type": "string",
"maxLength": 200
},
"delivery_type": {
"description": "ship (default), noship, download or future.",
"type": "string",
"enum": [
"ship",
"noship",
"download",
"future"
]
},
"category_code": {
"type": "string",
"maxLength": 200
},
"variation_list": {
"description": "Variations, e.g. {\"Size\":\"Large\",\"Color\":\"Red\"} (max 5,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"metadata": {
"description": "Hidden item details (max 15,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
}
},
"description": "Line items (at least one)."
},
"shipping": {
"description": "Shipping address.",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"customer": {
"description": "Customer (billing) address.",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"email": {
"description": "Customer e-mail address.",
"type": "string",
"maxLength": 200
},
"source_id": {
"description": "Your own order id (the order's Order Desk id is used when blank).",
"type": "string",
"maxLength": 200
},
"source_name": {
"description": "Order source / cart name (default Order Desk).",
"type": "string",
"maxLength": 200
},
"folder_id": {
"description": "Folder to put the order in (see orderdesk_get_store).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"shipping_method": {
"type": "string",
"maxLength": 200
},
"shipping_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"handling_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"tax_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"payment_type": {
"description": "Visa, MasterCard, PayPal, ...",
"type": "string",
"maxLength": 200
},
"payment_status": {
"description": "Defaults to Captured.",
"type": "string",
"enum": [
"Approved",
"Authorized",
"Captured",
"Fully Refunded",
"Partially Refunded",
"Pending",
"Rejected",
"Voided"
]
},
"checkout_data": {
"description": "Editable extra order details (max 3,500 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"order_metadata": {
"description": "Hidden extra order details (max 2,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"order_items"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_update_order(order_id, email, shipping_method, shipping_total, handling_total, ...)
WRITE: change fields of an existing order. Order Desk's PUT replaces the whole record, so this reads the order, applies only the fields you pass (shipping/customer address fields and checkout_data/order_metadata keys are merged into what is there, other values replaced) and sends the complete record back, items included. The order keeps its folder; use orderdesk_move_orders to move it. PUT /orders/{order_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
},
"email": {
"type": "string",
"maxLength": 200
},
"shipping_method": {
"type": "string",
"maxLength": 200
},
"shipping_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"handling_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"tax_total": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"payment_status": {
"type": "string",
"enum": [
"Approved",
"Authorized",
"Captured",
"Fully Refunded",
"Partially Refunded",
"Pending",
"Rejected",
"Voided"
]
},
"shipping": {
"description": "Shipping address fields to change (others are kept).",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"customer": {
"description": "Customer address fields to change (others are kept).",
"type": "object",
"properties": {
"first_name": {
"type": "string",
"maxLength": 200
},
"last_name": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"address1": {
"type": "string",
"maxLength": 200
},
"address2": {
"type": "string",
"maxLength": 200
},
"address3": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"address4": {
"type": "string",
"maxLength": 200,
"description": "Shipping addresses only."
},
"city": {
"type": "string",
"maxLength": 200
},
"state": {
"type": "string",
"maxLength": 200,
"description": "State or region."
},
"postal_code": {
"type": "string",
"maxLength": 200
},
"country": {
"type": "string",
"maxLength": 200,
"description": "Country code or full country name."
},
"phone": {
"type": "string",
"maxLength": 200
}
}
},
"checkout_data": {
"description": "Checkout data keys to set (other keys are kept).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"order_metadata": {
"description": "Order metadata keys to set (other keys are kept).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"order_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_add_order_item(order_id, item)
WRITE: add one line item to an existing order; Order Desk recalculates the totals. POST /orders/{order_id}/order-items.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
},
"item": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 500
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"quantity": {
"description": "Defaults to 1.",
"type": "integer",
"minimum": 1,
"maximum": 1000000
},
"weight": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"code": {
"description": "Item SKU or product code.",
"type": "string",
"maxLength": 200
},
"delivery_type": {
"description": "ship (default), noship, download or future.",
"type": "string",
"enum": [
"ship",
"noship",
"download",
"future"
]
},
"category_code": {
"type": "string",
"maxLength": 200
},
"variation_list": {
"description": "Variations, e.g. {\"Size\":\"Large\",\"Color\":\"Red\"} (max 5,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"metadata": {
"description": "Hidden item details (max 15,000 characters as JSON).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"description": "The line item to add (name, code, price, quantity...)."
}
},
"required": [
"order_id",
"item"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_add_order_note(order_id, note, source_name)
WRITE: append an entry to an order's history. History is append-only (entries cannot be edited or removed) and an order holds at most 250 entries, so do not use it for routine polling. POST /orders/{order_id}/order-history.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
},
"note": {
"type": "string",
"minLength": 1,
"maxLength": 1800,
"description": "The note text."
},
"source_name": {
"description": "What wrote the entry (default API).",
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"order_id",
"note"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_add_shipment(order_id, tracking_number, carrier_code, shipment_method, weight, ...)
WRITE: record a shipment (carrier and tracking number) against an order. One shipment per parcel; several shipments represent a partial fulfillment. Use "n/a" when there is no tracking number. If tracking_url is omitted Order Desk derives it. POST /orders/{order_id}/shipments.
Esquema de entrada
{
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal order id."
},
"tracking_number": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Carrier tracking number, or \"n/a\"."
},
"carrier_code": {
"description": "Carrier code such as USPS or FedEx.",
"type": "string",
"maxLength": 50
},
"shipment_method": {
"description": "Shipping service name, e.g. First Class International.",
"type": "string",
"maxLength": 200
},
"weight": {
"description": "Final shipment weight.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"cost": {
"description": "Your cost to send the shipment.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"tracking_url": {
"type": "string",
"maxLength": 1000,
"pattern": "^https?:\\/\\/"
}
},
"required": [
"order_id",
"tracking_number"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_move_orders(order_ids, destination_folder_id, destination_folder_name)
WRITE: move one or more orders to another folder. Moving runs the rules attached to the destination folder (which can send e-mail, call fulfillment services, etc.) and writes a history entry. Pass exactly one of destination_folder_id or destination_folder_name (see orderdesk_get_store). Returns each order's previous folder. POST /move-orders.
Esquema de entrada
{
"type": "object",
"properties": {
"order_ids": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"description": "Order Desk's internal order ids."
},
"destination_folder_id": {
"description": "Folder id to move to.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"destination_folder_name": {
"description": "Exact folder name to move to.",
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"order_ids"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_list_inventory_items(search, code, name, manufacturer_sku, location, ...)
Search the store's inventory (SKU, name, price, cost, weight, stock, location). Order Desk returns every match with no paging, so narrow with search/code/name; limit and offset slice the result here. GET /inventory-items.
Esquema de entrada
{
"type": "object",
"properties": {
"search": {
"description": "Matches name, code and metadata together.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"code": {
"description": "Exact SKU.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"description": "Product name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"manufacturer_sku": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"location": {
"description": "Warehouse or fulfillment method.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"updated_from": {
"description": "Items updated on or after this time.",
"type": "string"
},
"limit": {
"description": "How many items to return, 1-200 (default 50).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 200
},
"offset": {
"description": "Records to skip (default 0). Pass the previous reply's next_offset.",
"type": "integer",
"minimum": 0,
"maximum": 1000000
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢orderdesk_get_inventory_item(inventory_item_id)
One inventory item by Order Desk's internal id. GET /inventory-items/{inventory_item_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"inventory_item_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal inventory item id (see orderdesk_list_inventory_items)."
}
},
"required": [
"inventory_item_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_create_inventory_item(name, code, price, cost, weight, ...)
WRITE: add an inventory item. The code (SKU) must match the code your orders arrive with. POST /inventory-items.
Esquema de entrada
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Product name."
},
"code": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Unique SKU."
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"cost": {
"description": "Item cost.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"weight": {
"description": "Shipping weight.",
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"stock": {
"description": "Units available.",
"type": "integer",
"minimum": -1000000000,
"maximum": 1000000000
},
"manufacturer_sku": {
"type": "string",
"maxLength": 200
},
"location": {
"description": "Warehouse or fulfillment method.",
"type": "string",
"maxLength": 200
},
"variation_list": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"metadata": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"name",
"code"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴orderdesk_update_inventory_item(inventory_item_id, name, code, price, cost, ...)
WRITE: change fields of an inventory item, for example its stock count. Order Desk's PUT replaces the whole record, so this reads the item, applies only the fields you pass (metadata and variation keys are merged) and sends the complete record back. PUT /inventory-items/{inventory_item_id}.
Esquema de entrada
{
"type": "object",
"properties": {
"inventory_item_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Order Desk's internal inventory item id."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"code": {
"description": "SKU.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"cost": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"weight": {
"type": "number",
"minimum": 0,
"maximum": 1000000000
},
"stock": {
"description": "The new units-available count (replaces the old one).",
"type": "integer",
"minimum": -1000000000,
"maximum": 1000000000
},
"manufacturer_sku": {
"type": "string",
"maxLength": 200
},
"location": {
"type": "string",
"maxLength": 200
},
"variation_list": {
"description": "Variation keys to set (others are kept).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
},
"metadata": {
"description": "Metadata keys to set (others are kept).",
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}
}
},
"required": [
"inventory_item_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Comunidad
Evidencia
Observaciones recientes
verificadoversión no registrada15 herramientas