Docs
MCP serverAvailable tools

Receive inventory

Record a multi-product supplier inventory delivery at a location.

MCP toolreceive_inventory

Purpose

Record a multi-product supplier inventory delivery at a location.

Use when
A supplier delivery has been received.
Do not use when
You are correcting a single stock level without a delivery.
Required permissions
products:manage
Side effects
Destructive
Idempotency
Idempotent

Input schema

JSON Schema
{  "type": "object",  "properties": {    "idempotencyKey": {      "type": "string",      "minLength": 1,      "maxLength": 200,      "description": "Unique retry key for this exact operation. Reuse it only when retrying the same request."    },    "input": {      "type": "object",      "properties": {        "supplierId": {          "$ref": "#/definitions/__schema0"        },        "locationId": {          "$ref": "#/definitions/__schema1"        },        "reference": {          "$ref": "#/definitions/__schema2"        },        "note": {          "$ref": "#/definitions/__schema3"        },        "items": {          "$ref": "#/definitions/__schema4"        }      },      "required": [        "supplierId",        "locationId",        "items"      ],      "additionalProperties": false    }  },  "required": [    "idempotencyKey",    "input"  ],  "$schema": "http://json-schema.org/draft-07/schema#",  "additionalProperties": false,  "definitions": {    "__schema0": {      "type": "string",      "minLength": 1    },    "__schema1": {      "type": "string",      "minLength": 1    },    "__schema2": {      "type": "string",      "minLength": 1,      "maxLength": 120    },    "__schema3": {      "type": "string",      "minLength": 1,      "maxLength": 500    },    "__schema4": {      "minItems": 1,      "maxItems": 50,      "type": "array",      "items": {        "$ref": "#/definitions/__schema5"      }    },    "__schema5": {      "type": "object",      "properties": {        "productId": {          "type": "string",          "minLength": 1        },        "quantity": {          "type": "number",          "exclusiveMinimum": 0        }      },      "required": [        "productId",        "quantity"      ],      "additionalProperties": false    }  }}

Output schema

JSON Schema
{  "type": "object",  "properties": {    "data": {      "type": "object",      "properties": {        "inventoryReceiptId": {          "type": "string"        },        "itemCount": {          "type": "integer",          "exclusiveMinimum": 0,          "maximum": 9007199254740991        }      },      "required": [        "inventoryReceiptId",        "itemCount"      ],      "additionalProperties": false    },    "error": {      "$schema": "http://json-schema.org/draft-07/schema#",      "type": "object",      "properties": {        "code": {          "type": "string",          "enum": [            "validation_error",            "unauthenticated",            "forbidden",            "not_found",            "method_not_allowed",            "conflict",            "idempotency_conflict",            "operation_in_progress",            "recovery_required",            "rate_limited",            "provider_unavailable",            "internal"          ]        },        "message": {          "type": "string"        },        "details": {          "type": "object",          "properties": {            "issues": {              "type": "array",              "items": {                "type": "object",                "properties": {                  "path": {                    "type": "array",                    "items": {                      "anyOf": [                        {                          "type": "string"                        },                        {                          "type": "number"                        }                      ]                    }                  },                  "message": {                    "type": "string"                  },                  "code": {                    "type": "string"                  }                },                "required": [                  "path",                  "message"                ],                "additionalProperties": false              }            },            "retryable": {              "type": "boolean"            },            "retryAfterSeconds": {              "type": "integer",              "exclusiveMinimum": 0,              "maximum": 9007199254740991            }          },          "additionalProperties": false        }      },      "required": [        "code",        "message"      ],      "additionalProperties": false    }  },  "$schema": "http://json-schema.org/draft-07/schema#",  "additionalProperties": false,  "oneOf": [    {      "required": [        "data"      ]    },    {      "required": [        "error"      ]    }  ]}

Related workflow

See the canonical workflows in the introduction

Related tools

Update inventory

Set or restock a product inventory level. mode selects whether stock is replaced or increased.

Read prices

List product price overrides for one customer or business location. subjectId is the customerId from get_contacts or locationId from get_configuration.