Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /shopify | Type: Application | PCID required: Yes
| Tool | Description |
|---|
shopify_create_product | Create a new product in Shopify store |
shopify_search_products | Search for products in Shopify store |
shopify_update_product | Update an existing product in Shopify store |
shopify_get_product | Get detailed information about a specific product |
shopify_create_product_variant | Create a new variant for an existing product. Note: To set inventory quantity, both inventoryQuantity and locationId must be provided. |
shopify_update_inventory_level | Update inventory level for a product variant |
shopify_list_locations | List all locations (warehouses, stores, etc.) in the Shopify store. Use this to get location IDs for inventory management. |
shopify_create_custom_collection | Create a custom collection to organize products |
shopify_add_product_to_collection | Add a product to a custom collection |
shopify_list_orders | List orders from the Shopify store |
shopify_get_order | Get detailed information about a specific order |
shopify_create_customer | Create a new customer in Shopify |
shopify_search_customers | Search for customers in Shopify store |
shopify_get_customer | Get detailed information about a specific customer |
shopify_list_products | List all products in the Shopify store |
shopify_get_shop_info | Get information about the Shopify store |
shopify_list_trigger_capabilities | List available Shopify trigger types and their configurations |
shopify_create_trigger | Create a Shopify webhook trigger for store events |
shopify_update_trigger | Update an existing Shopify webhook trigger |
shopify_delete_trigger | Delete a Shopify webhook trigger |
shopify_create_product
Create a new product in Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
title | string | Yes | — | Product title |
description | string | No | — | Product description (HTML supported) |
vendor | string | No | — | Product vendor/brand name |
productType | string | No | — | Product type/category |
status | string | No | "ACTIVE" | Product status |
tags | string[] | No | — | Product tags for organization |
images | string[] | No | — | Array of image URLs |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"title": {
"type": "string",
"description": "Product title"
},
"description": {
"type": "string",
"description": "Product description (HTML supported)"
},
"vendor": {
"type": "string",
"description": "Product vendor/brand name"
},
"productType": {
"type": "string",
"description": "Product type/category"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"ARCHIVED",
"DRAFT"
],
"default": "ACTIVE",
"description": "Product status"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Product tags for organization"
},
"images": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of image URLs"
}
},
"required": [
"PCID",
"title"
]
}
shopify_search_products
Search for products in Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
title | string | No | — | Product title to search for |
exactMatch | boolean | No | false | Whether title search should be exact match |
vendor | string | No | — | Filter by vendor name |
productType | string | No | — | Filter by product type |
maxResults | number | No | 50 | Maximum number of results to return |
sortKey | string | No | "CREATED_AT" | Sort results by this field |
reverse | boolean | No | false | Reverse the sort order |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"title": {
"type": "string",
"description": "Product title to search for"
},
"exactMatch": {
"type": "boolean",
"default": false,
"description": "Whether title search should be exact match"
},
"vendor": {
"type": "string",
"description": "Filter by vendor name"
},
"productType": {
"type": "string",
"description": "Filter by product type"
},
"maxResults": {
"type": "number",
"default": 50,
"description": "Maximum number of results to return"
},
"sortKey": {
"type": "string",
"enum": [
"TITLE",
"CREATED_AT",
"UPDATED_AT",
"PRODUCT_TYPE",
"VENDOR"
],
"default": "CREATED_AT",
"description": "Sort results by this field"
},
"reverse": {
"type": "boolean",
"default": false,
"description": "Reverse the sort order"
}
},
"required": [
"PCID"
]
}
shopify_update_product
Update an existing product in Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productId | string | Yes | — | Product ID to update |
title | string | No | — | Updated product title |
description | string | No | — | Updated product description |
vendor | string | No | — | Updated vendor name |
productType | string | No | — | Updated product type |
status | string | No | — | Updated product status |
tags | string[] | No | — | Updated product tags |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to update"
},
"title": {
"type": "string",
"description": "Updated product title"
},
"description": {
"type": "string",
"description": "Updated product description"
},
"vendor": {
"type": "string",
"description": "Updated vendor name"
},
"productType": {
"type": "string",
"description": "Updated product type"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"ARCHIVED",
"DRAFT"
],
"description": "Updated product status"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated product tags"
}
},
"required": [
"PCID",
"productId"
]
}
shopify_get_product
Get detailed information about a specific product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productId | string | Yes | — | Product ID to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to retrieve"
}
},
"required": [
"PCID",
"productId"
]
}
shopify_create_product_variant
Create a new variant for an existing product. Note: To set inventory quantity, both inventoryQuantity and locationId must be provided.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productId | string | Yes | — | Product ID to add variant to |
title | string | Yes | — | Variant title/value (e.g., “Small”, “Red”, “Default Title”) |
price | string | Yes | — | Variant price |
optionName | string | No | — | Name of the product option this variant value belongs to (e.g., “Size”, “Color”). Defaults to “Title” which is Shopify’s default option name. |
sku | string | No | — | Stock keeping unit |
inventoryQuantity | number | No | — | Inventory quantity (requires locationId to be set as well) |
locationId | string | No | — | Location ID for inventory (required if inventoryQuantity is provided) |
weight | number | No | — | Weight in grams |
requiresShipping | boolean | No | true | Whether variant requires shipping |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to add variant to"
},
"title": {
"type": "string",
"description": "Variant title/value (e.g., \"Small\", \"Red\", \"Default Title\")"
},
"price": {
"type": "string",
"description": "Variant price"
},
"optionName": {
"type": "string",
"description": "Name of the product option this variant value belongs to (e.g., \"Size\", \"Color\"). Defaults to \"Title\" which is Shopify's default option name."
},
"sku": {
"type": "string",
"description": "Stock keeping unit"
},
"inventoryQuantity": {
"type": "number",
"description": "Inventory quantity (requires locationId to be set as well)"
},
"locationId": {
"type": "string",
"description": "Location ID for inventory (required if inventoryQuantity is provided)"
},
"weight": {
"type": "number",
"description": "Weight in grams"
},
"requiresShipping": {
"type": "boolean",
"default": true,
"description": "Whether variant requires shipping"
}
},
"required": [
"PCID",
"productId",
"title",
"price"
]
}
shopify_update_inventory_level
Update inventory level for a product variant
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
inventoryItemId | string | Yes | — | Inventory item ID |
locationId | string | Yes | — | Location ID |
availableQuantity | number | Yes | — | New available quantity |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"inventoryItemId": {
"type": "string",
"description": "Inventory item ID"
},
"locationId": {
"type": "string",
"description": "Location ID"
},
"availableQuantity": {
"type": "number",
"description": "New available quantity"
}
},
"required": [
"PCID",
"inventoryItemId",
"locationId",
"availableQuantity"
]
}
shopify_list_locations
List all locations (warehouses, stores, etc.) in the Shopify store. Use this to get location IDs for inventory management.
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
}
},
"required": [
"PCID"
]
}
shopify_create_custom_collection
Create a custom collection to organize products
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
title | string | Yes | — | Collection title |
description | string | No | — | Collection description |
published | boolean | No | true | Whether collection is published |
sortOrder | string | No | "MANUAL" | How products are sorted in collection |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"title": {
"type": "string",
"description": "Collection title"
},
"description": {
"type": "string",
"description": "Collection description"
},
"published": {
"type": "boolean",
"default": true,
"description": "Whether collection is published"
},
"sortOrder": {
"type": "string",
"enum": [
"ALPHA_ASC",
"ALPHA_DESC",
"BEST_SELLING",
"CREATED",
"CREATED_DESC",
"MANUAL",
"PRICE_ASC",
"PRICE_DESC"
],
"default": "MANUAL",
"description": "How products are sorted in collection"
}
},
"required": [
"PCID",
"title"
]
}
shopify_add_product_to_collection
Add a product to a custom collection
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
productId | string | Yes | — | Product ID to add |
collectionId | string | Yes | — | Collection ID to add product to |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to add"
},
"collectionId": {
"type": "string",
"description": "Collection ID to add product to"
}
},
"required": [
"PCID",
"productId",
"collectionId"
]
}
shopify_list_orders
List orders from the Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
status | string | No | "ANY" | Filter orders by status |
financialStatus | string | No | — | Filter by financial status |
fulfillmentStatus | string | No | — | Filter by fulfillment status |
maxResults | number | No | 50 | Maximum number of orders to return |
sortKey | string | No | "CREATED_AT" | Sort orders by this field |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"status": {
"type": "string",
"enum": [
"OPEN",
"CLOSED",
"CANCELLED",
"ANY"
],
"default": "ANY",
"description": "Filter orders by status"
},
"financialStatus": {
"type": "string",
"enum": [
"AUTHORIZED",
"PAID",
"PARTIALLY_PAID",
"PARTIALLY_REFUNDED",
"PENDING",
"REFUNDED",
"UNPAID",
"VOIDED"
],
"description": "Filter by financial status"
},
"fulfillmentStatus": {
"type": "string",
"enum": [
"FULFILLED",
"PARTIAL",
"RESTOCKED",
"UNFULFILLED"
],
"description": "Filter by fulfillment status"
},
"maxResults": {
"type": "number",
"default": 50,
"description": "Maximum number of orders to return"
},
"sortKey": {
"type": "string",
"enum": [
"CREATED_AT",
"ID",
"ORDER_NUMBER",
"PROCESSED_AT",
"TOTAL_PRICE",
"UPDATED_AT"
],
"default": "CREATED_AT",
"description": "Sort orders by this field"
}
},
"required": [
"PCID"
]
}
shopify_get_order
Get detailed information about a specific order
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
orderId | string | Yes | — | Order ID to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID to retrieve"
}
},
"required": [
"PCID",
"orderId"
]
}
shopify_create_customer
Create a new customer in Shopify
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
firstName | string | Yes | — | Customer first name |
lastName | string | Yes | — | Customer last name |
email | string | Yes | — | Customer email address |
phone | string | No | — | Customer phone number |
acceptsMarketing | boolean | No | false | Whether customer accepts marketing emails |
tags | string[] | No | — | Customer tags |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"firstName": {
"type": "string",
"description": "Customer first name"
},
"lastName": {
"type": "string",
"description": "Customer last name"
},
"email": {
"type": "string",
"description": "Customer email address"
},
"phone": {
"type": "string",
"description": "Customer phone number"
},
"acceptsMarketing": {
"type": "boolean",
"default": false,
"description": "Whether customer accepts marketing emails"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Customer tags"
}
},
"required": [
"PCID",
"firstName",
"lastName",
"email"
]
}
shopify_search_customers
Search for customers in Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
query | string | Yes | — | Search query (email, name, phone, etc.) |
maxResults | number | No | 50 | Maximum number of customers to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"query": {
"type": "string",
"description": "Search query (email, name, phone, etc.)"
},
"maxResults": {
"type": "number",
"default": 50,
"description": "Maximum number of customers to return"
}
},
"required": [
"PCID",
"query"
]
}
shopify_get_customer
Get detailed information about a specific customer
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customerId | string | Yes | — | Customer ID to retrieve |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"customerId": {
"type": "string",
"description": "Customer ID to retrieve"
}
},
"required": [
"PCID",
"customerId"
]
}
shopify_list_products
List all products in the Shopify store
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
status | string | No | — | Filter products by status |
maxResults | number | No | 50 | Maximum number of products to return |
sortKey | string | No | "CREATED_AT" | Sort products by this field |
reverse | boolean | No | false | Reverse the sort order |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"ARCHIVED",
"DRAFT"
],
"description": "Filter products by status"
},
"maxResults": {
"type": "number",
"default": 50,
"description": "Maximum number of products to return"
},
"sortKey": {
"type": "string",
"enum": [
"TITLE",
"CREATED_AT",
"UPDATED_AT",
"PRODUCT_TYPE",
"VENDOR"
],
"default": "CREATED_AT",
"description": "Sort products by this field"
},
"reverse": {
"type": "boolean",
"default": false,
"description": "Reverse the sort order"
}
},
"required": [
"PCID"
]
}
shopify_get_shop_info
Get information about the Shopify store
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
}
},
"required": [
"PCID"
]
}
shopify_list_trigger_capabilities
List available Shopify trigger types and their configurations
{
"type": "object",
"properties": {}
}
shopify_create_trigger
Create a Shopify webhook trigger for store events
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
webhookUrl | string | Yes | — | Webhook callback URL |
topic | string | Yes | — | Event topic to subscribe to |
metafieldNamespaces | string[] | No | — | Metafield namespaces to include |
privateMetafieldNamespaces | string[] | No | — | Private metafield namespaces to include |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"webhookUrl": {
"type": "string",
"description": "Webhook callback URL"
},
"topic": {
"type": "string",
"description": "Event topic to subscribe to"
},
"metafieldNamespaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "Metafield namespaces to include"
},
"privateMetafieldNamespaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "Private metafield namespaces to include"
}
},
"required": [
"PCID",
"webhookUrl",
"topic"
]
}
shopify_update_trigger
Update an existing Shopify webhook trigger
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
webhookId | string | Yes | — | Webhook ID to update |
topic | string | Yes | — | Updated event topic |
metafieldNamespaces | string[] | No | — | Updated metafield namespaces |
privateMetafieldNamespaces | string[] | No | — | Updated private metafield namespaces |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"webhookId": {
"type": "string",
"description": "Webhook ID to update"
},
"topic": {
"type": "string",
"description": "Updated event topic"
},
"metafieldNamespaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated metafield namespaces"
},
"privateMetafieldNamespaces": {
"type": "array",
"items": {
"type": "string"
},
"description": "Updated private metafield namespaces"
}
},
"required": [
"PCID",
"webhookId",
"topic"
]
}
shopify_delete_trigger
Delete a Shopify webhook trigger
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
webhookId | string | Yes | — | Webhook ID to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"webhookId": {
"type": "string",
"description": "Webhook ID to delete"
}
},
"required": [
"PCID",
"webhookId"
]
}