VYG Docs

Commerce

Orders

GET/v1/commerce/orders

Scope: commerce:read. MCP tool: list_orders.

View orders, newest first. Filter by date, order status, payment status or customer. For a customer’s combined order history, use list_customer_orders.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
cursor?|

next_cursor from the previous page.

created_at_gte?string|null
created_at_lte?string|null
state?string|null
billing_status?string|null
customer_email?string|null
customer_phone?string|null
customer_id?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/orders"
{  "data": [    {      "id": "string",      "external_id": "string",      "number": "string",      "state": "string",      "billing_status": "string",      "total": "string",      "currency_code": "string",      "customer": {        "contact_id": "string"      },      "created_at": "string",      "recovered_at": "string"    }  ],  "next_cursor": "string"}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Order

GET/v1/commerce/orders/{id}

Scope: commerce:read. MCP tool: get_order.

View an order and its items. Use the ID from list_orders or the Shopify order ID (external_id). Returns 404 if the order cannot be found.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/orders/string"
{  "id": "string",  "external_id": "string",  "number": "string",  "state": "string",  "billing_status": "string",  "total": "string",  "currency_code": "string",  "customer": {    "contact_id": "string",    "shopify_customer_id": "string"  },  "created_at": "string",  "recovered_at": "string",  "processed_at": "string",  "updated_at": "string",  "line_items": [    {      "title": "string",      "quantity": 0,      "price": "string",      "sku": "string",      "product_id": "string",      "variant_id": "string",      "variant_title": "string"    }  ]}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Subscriptions

GET/v1/commerce/subscriptions

Scope: commerce:read. MCP tool: list_subscriptions.

View subscriptions. Filter by status or customer.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
cursor?|

next_cursor from the previous page.

status?string|null
customer_email?string|null
customer_phone?string|null
customer_id?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/subscriptions"
{  "data": [    {      "id": "string",      "external_id": "string",      "provider": "string",      "status": "string",      "next_billing_date": "string",      "billing_interval": "string",      "billing_interval_count": 0,      "total_price": "string",      "currency_code": "string",      "customer": {        "contact_id": "string",        "external_customer_id": "string"      },      "product_refs": [        {          "product_id": "string",          "variant_id": "string",          "title": "string",          "quantity": 0        }      ],      "created_at": "string"    }  ],  "next_cursor": "string"}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Subscription

GET/v1/commerce/subscriptions/{id}

Scope: commerce:read. MCP tool: get_subscription.

View a subscription by its external ID. Returns 404 if it cannot be found.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/subscriptions/string"
{  "id": "string",  "external_id": "string",  "provider": "string",  "status": "string",  "next_billing_date": "string",  "billing_interval": "string",  "billing_interval_count": 0,  "total_price": "string",  "currency_code": "string",  "customer": {    "contact_id": "string",    "external_customer_id": "string"  },  "product_refs": [    {      "product_id": "string",      "variant_id": "string",      "title": "string",      "quantity": 0    }  ],  "created_at": "string"}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Products

GET/v1/commerce/products

Scope: commerce:read. MCP tool: list_products.

View products in your Shopify store. Product updates can take about 30 seconds to appear.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
cursor?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/products"
{  "data": [    {      "id": "string",      "title": "string",      "status": "string",      "variants": [        {          "id": "string",          "price": "string",          "sku": "string"        }      ],      "images": [        {          "id": "string",          "url": "string",          "alt_text": "string"        }      ]    }  ],  "next_cursor": "string"}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Product

GET/v1/commerce/products/{id}

Scope: commerce:read. MCP tool: get_product.

View a product by ID. Returns 404 if it cannot be found.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/commerce/products/string"
{  "id": "string",  "title": "string",  "status": "string",  "variants": [    {      "id": "string",      "price": "string",      "sku": "string"    }  ],  "images": [    {      "id": "string",      "url": "string",      "alt_text": "string"    }  ]}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}
{  "error": {    "code": "bad_request",    "message": "string"  }}

Segments

Previous Page

Insights

Next Page