Skip to content

Shop

Updated View as Markdown

Personal Shop accounts, orders, carts and checkout preparation. Payment requires the shopper at the original Shop review URL. No payment completion or spend-card issuance.

What you can do (8)

What you can do

Available commands: 8 (4 read, 4 write). Enable only the commands your application needs.

Command Effect
Read your Shop account — shop.account.get Read
Read one page of your Shop orders — shop.orders.search Read
Prepare a Shop cart — shop.carts.create Write
Read your Shop cart — shop.carts.get Read
Update your Shop cart — shop.carts.update Write
Prepare a Shop checkout — shop.checkouts.create Write
Read your Shop checkout — shop.checkouts.get Read
Update your Shop checkout — shop.checkouts.update Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Shop, then enter the issued values in the connection form below.

  1. Use Shopify's documented Shop personal MCP authorization. Configure a supported OAuth client and exact redirect URI if required, save and authorize the personal account with personal_agent scope. Existing personal tokens are supported. Cart/checkout preparation does not authorize payment; review and complete it with the provider.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
OAuth callback Optional
Shop OAuth client ID Optional
Shop OAuth client secret Optional
Personal access token Optional
Granted scopes Optional
Return URL after authorization Optional

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Read your Shop account — shop.account.get

Run Read your Shop account with Shop. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 2 provider requests per invocation; timeout: 15 seconds.

Prepare a Shop cart — shop.carts.create

Run Prepare a Shop cart with Shop. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
cart object Required additionalProperties: false
cart.line_items array Required minItems: 1; maxItems: 25
cart.line_items[] object Optional additionalProperties: false
cart.line_items[].id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].parent_id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].item object Required additionalProperties: false
cart.line_items[].item.id string Required minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].item.quantity_unit object Optional additionalProperties: false
cart.line_items[].item.quantity_unit.unit string Required minLength: 1; maxLength: 32; pattern: "^[^\\p{C}]+$"
cart.line_items[].item.quantity_unit.display_text string Required minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"
cart.line_items[].item.quantity_unit.scale integer Optional minimum: 0; maximum: 15
cart.line_items[].item.quantity_unit.increment integer Optional minimum: 1
cart.line_items[].quantity integer Required minimum: 1; maximum: 1000000
cart.context object Optional additionalProperties: false
cart.context.address_country string Optional pattern: "^[A-Z]{2}$"
cart.context.address_region string Optional minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"
cart.context.postal_code string Optional minLength: 1; maxLength: 32; pattern: "^[^\\p{C}]+$"
cart.context.currency string Optional pattern: "^[A-Z]{3}$"
cart.context.language string Optional minLength: 1; maxLength: 35; pattern: "^[^\\p{C}]+$"
cart.discounts object Optional additionalProperties: false
cart.discounts.codes array Required maxItems: 10
cart.discounts.codes[] string Optional minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "cart": {
    "line_items": [
      {
        "item": {
          "id": "gid://shopify/ProductVariant/123"
        },
        "quantity": 1
      }
    ]
  }
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Read your Shop cart — shop.carts.get

Run Read your Shop cart with Shop. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
id string Required minLength: 1; maxLength: 1000; pattern: "^[^\\p{C}]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "id": "synthetic-resource"
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Update your Shop cart — shop.carts.update

Run Update your Shop cart with Shop. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
id string Required minLength: 1; maxLength: 1000; pattern: "^[^\\p{C}]+$"
cart object Required additionalProperties: true
cart.line_items array Required minItems: 0; maxItems: 25
cart.line_items[] object Optional additionalProperties: true
cart.line_items[].id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].parent_id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].item object Required additionalProperties: true
cart.line_items[].item.id string Required minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
cart.line_items[].quantity integer Required minimum: 1; maximum: 1000000

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "id": "synthetic-resource",
  "cart": {
    "line_items": [
      {
        "item": {
          "id": "gid://shopify/ProductVariant/123"
        },
        "quantity": 1
      }
    ]
  }
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Prepare a Shop checkout — shop.checkouts.create

Run Prepare a Shop checkout with Shop. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
checkout object Required additionalProperties: false
checkout.line_items array Required minItems: 1; maxItems: 25
checkout.line_items[] object Optional additionalProperties: false
checkout.line_items[].id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].parent_id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].item object Required additionalProperties: false
checkout.line_items[].item.id string Required minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].item.quantity_unit object Optional additionalProperties: false
checkout.line_items[].item.quantity_unit.unit string Required minLength: 1; maxLength: 32; pattern: "^[^\\p{C}]+$"
checkout.line_items[].item.quantity_unit.display_text string Required minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"
checkout.line_items[].item.quantity_unit.scale integer Optional minimum: 0; maximum: 15
checkout.line_items[].item.quantity_unit.increment integer Optional minimum: 1
checkout.line_items[].quantity integer Required minimum: 1; maximum: 1000000
checkout.context object Optional additionalProperties: false
checkout.context.address_country string Optional pattern: "^[A-Z]{2}$"
checkout.context.address_region string Optional minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"
checkout.context.postal_code string Optional minLength: 1; maxLength: 32; pattern: "^[^\\p{C}]+$"
checkout.context.currency string Optional pattern: "^[A-Z]{3}$"
checkout.context.language string Optional minLength: 1; maxLength: 35; pattern: "^[^\\p{C}]+$"
checkout.discounts object Optional additionalProperties: false
checkout.discounts.codes array Required maxItems: 10
checkout.discounts.codes[] string Optional minLength: 1; maxLength: 100; pattern: "^[^\\p{C}]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "checkout": {
    "line_items": [
      {
        "item": {
          "id": "gid://shopify/ProductVariant/123"
        },
        "quantity": 1
      }
    ]
  }
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Read your Shop checkout — shop.checkouts.get

Run Read your Shop checkout with Shop. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
id string Required minLength: 1; maxLength: 1000; pattern: "^[^\\p{C}]+$"

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "id": "synthetic-resource"
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Update your Shop checkout — shop.checkouts.update

Run Update your Shop checkout with Shop. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
shop string Required maxLength: 253; pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z](?:[a-z0-9-]*[a-z0-9])?$"
id string Required minLength: 1; maxLength: 1000; pattern: "^[^\\p{C}]+$"
checkout object Required additionalProperties: true
checkout.line_items array Required minItems: 0; maxItems: 25
checkout.line_items[] object Optional additionalProperties: true
checkout.line_items[].id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].parent_id string Optional minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].item object Required additionalProperties: true
checkout.line_items[].item.id string Required minLength: 1; maxLength: 300; pattern: "^[^\\p{C}]+$"
checkout.line_items[].quantity integer Required minimum: 1; maximum: 1000000

Full JSON Schema

Full JSON Schema

Example input

{
  "shop": "synthetic.myshopify.com",
  "id": "synthetic-resource",
  "checkout": {
    "line_items": [
      {
        "item": {
          "id": "gid://shopify/ProductVariant/123"
        },
        "quantity": 1
      }
    ]
  }
}

At most 2 provider requests per invocation; timeout: 15 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Type to search…

↑↓ navigate↵ selectEsc close