woo_get_order

Pack: woocommerce · Endpoint: https://gateway.pipeworx.io/woocommerce/mcp

Get a single order by ID from a WooCommerce store.

Parameters

NameTypeRequiredDescription
_apiKeystringyesWooCommerce consumer key
_apiSecretstringyesWooCommerce consumer secret
_storeUrlstringyesStore URL (e.g., https://mystore.com)
idnumberyesOrder ID

Example call

Arguments

{
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com",
  "id": 456
}

curl

curl -X POST https://gateway.pipeworx.io/woocommerce/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"woo_get_order","arguments":{"_apiKey":"your-woocommerce-api-key","_apiSecret":"your-woocommerce-api-secret","_storeUrl":"https://mystore.com","id":456}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('woo_get_order', {
  "_apiKey": "your-woocommerce-api-key",
  "_apiSecret": "your-woocommerce-api-secret",
  "_storeUrl": "https://mystore.com",
  "id": 456
});

Response shape

FieldTypeDescription
idnumberOrder ID
parent_idnumberParent order ID
numberstringOrder number
order_keystringOrder key
created_viastringCreation method
versionstringOrder version
statusstringOrder status
currencystringCurrency code
date_createdstringCreation date in ISO format
date_modifiedstringLast modified date in ISO format
discount_totalstringDiscount total
discount_taxstringDiscount tax
shipping_totalstringShipping total
shipping_taxstringShipping tax
cart_taxstringCart tax
totalstringOrder total
total_taxstringTotal tax
customer_idnumberCustomer ID
billingobjectBilling address details
shippingobjectShipping address details
line_itemsarrayOrder line items
Full JSON Schema
{
  "type": "object",
  "description": "Single order object from WooCommerce",
  "properties": {
    "id": {
      "type": "number",
      "description": "Order ID"
    },
    "parent_id": {
      "type": "number",
      "description": "Parent order ID"
    },
    "number": {
      "type": "string",
      "description": "Order number"
    },
    "order_key": {
      "type": "string",
      "description": "Order key"
    },
    "created_via": {
      "type": "string",
      "description": "Creation method"
    },
    "version": {
      "type": "string",
      "description": "Order version"
    },
    "status": {
      "type": "string",
      "description": "Order status"
    },
    "currency": {
      "type": "string",
      "description": "Currency code"
    },
    "date_created": {
      "type": "string",
      "description": "Creation date in ISO format"
    },
    "date_modified": {
      "type": "string",
      "description": "Last modified date in ISO format"
    },
    "discount_total": {
      "type": "string",
      "description": "Discount total"
    },
    "discount_tax": {
      "type": "string",
      "description": "Discount tax"
    },
    "shipping_total": {
      "type": "string",
      "description": "Shipping total"
    },
    "shipping_tax": {
      "type": "string",
      "description": "Shipping tax"
    },
    "cart_tax": {
      "type": "string",
      "description": "Cart tax"
    },
    "total": {
      "type": "string",
      "description": "Order total"
    },
    "total_tax": {
      "type": "string",
      "description": "Total tax"
    },
    "customer_id": {
      "type": "number",
      "description": "Customer ID"
    },
    "billing": {
      "type": "object",
      "description": "Billing address details"
    },
    "shipping": {
      "type": "object",
      "description": "Shipping address details"
    },
    "line_items": {
      "type": "array",
      "description": "Order line items",
      "items": {
        "type": "object"
      }
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "woocommerce": {
      "url": "https://gateway.pipeworx.io/woocommerce/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026