/faire | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
faire_backorder_items | Set availability for order items (for backordering or marking discontinued) |
faire_cancel_order | Cancel an order (only if state is NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED) |
faire_create_product | Create a new product in Faire marketplace |
faire_create_variant | Create a new product variant |
faire_get_brand_profile | Get current brand profile information |
faire_get_inventory_by_skus | Get inventory levels by SKU(s) |
faire_get_inventory_by_variant_ids | Get inventory levels by variant ID(s) |
faire_get_order | Get detailed information about a specific order |
faire_get_orders | Get orders from Faire. Orders are returned oldest first (ascending by updated_at). |
faire_get_packing_slip | Download packing slip PDF for an order |
faire_get_product | Get detailed information about a specific product |
faire_get_products | Get products from Faire marketplace. Products returned ascending by updated_at. |
faire_get_retailer_info | Get public retailer information |
faire_get_taxonomy_types | Get all available product taxonomy types/categories |
faire_process_order | Mark an order as processing |
faire_ship_order | Mark an order as shipped with tracking information (moves state to PRE_TRANSIT, then IN_TRANSIT when carrier accepts) |
faire_update_inventory_by_skus | Update inventory levels by SKU(s) |
faire_update_inventory_by_variant_ids | Update inventory levels by variant ID(s) |
faire_update_product | Update an existing product |
faire_update_variant | Update an existing product variant |
faire_backorder_items
Set availability for order items (for backordering or marking discontinued) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID |
availabilities | object | Yes | — | Map keyed by order item ID (oi_xxx). Must set either discontinued=true OR backordered_until |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID"
},
"availabilities": {
"type": "object",
"additionalProperties": true,
"description": "Map keyed by order item ID (oi_xxx). Must set either discontinued=true OR backordered_until"
}
},
"required": [
"PCID",
"orderId",
"availabilities"
]
}
faire_cancel_order
Cancel an order (only if state is NEW, PROCESSING, PENDING_RETAILER_CONFIRMATION, or BACKORDERED) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID to cancel |
reason | string | Yes | — | Reason for cancellation (e.g., ITEM_OUT_OF_STOCK) |
note | string | Yes | — | Explanation for retailer (30-1000 characters) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID to cancel"
},
"reason": {
"type": "string",
"description": "Reason for cancellation (e.g., ITEM_OUT_OF_STOCK)"
},
"note": {
"type": "string",
"description": "Explanation for retailer (30-1000 characters)"
}
},
"required": [
"PCID",
"orderId",
"reason",
"note"
]
}
faire_create_product
Create a new product in Faire marketplace Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotence_token | string | Yes | — | Unique identifier for idempotence |
name | string | Yes | — | Product name |
unit_multiplier | number | Yes | — | Case size/quantity - product ships in multiples of this |
minimum_order_quantity | number | Yes | — | Minimum units to purchase (must be multiple of unit_multiplier) |
taxonomy_type | object | Yes | — | Product category/type |
variant_option_sets | object[] | Yes | — | Variant options for this product |
variants | any[] | Yes | — | Initial variants for this product |
description | string | No | — | Product description (max 1000 chars) |
short_description | string | No | — | Short description (max 75 chars) |
lifecycle_state | string | No | — | Lifecycle state |
preorderable | boolean | No | — | Whether product can be preordered |
made_in_country | string | No | — | ISO 3166-1 alpha-3 country code (e.g., USA, CAN) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"idempotence_token": {
"type": "string",
"description": "Unique identifier for idempotence"
},
"name": {
"type": "string",
"description": "Product name"
},
"unit_multiplier": {
"type": "number",
"description": "Case size/quantity - product ships in multiples of this"
},
"minimum_order_quantity": {
"type": "number",
"description": "Minimum units to purchase (must be multiple of unit_multiplier)"
},
"taxonomy_type": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Taxonomy type ID"
}
},
"description": "Product category/type"
},
"variant_option_sets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Option name (e.g., Size, Color)"
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Available values"
}
}
},
"description": "Variant options for this product"
},
"variants": {
"type": "array",
"items": {
"type": "any"
},
"description": "Initial variants for this product"
},
"description": {
"type": "string",
"description": "Product description (max 1000 chars)"
},
"short_description": {
"type": "string",
"description": "Short description (max 75 chars)"
},
"lifecycle_state": {
"type": "string",
"description": "Lifecycle state"
},
"preorderable": {
"type": "boolean",
"description": "Whether product can be preordered"
},
"made_in_country": {
"type": "string",
"description": "ISO 3166-1 alpha-3 country code (e.g., USA, CAN)"
}
},
"required": [
"PCID",
"idempotence_token",
"name",
"unit_multiplier",
"minimum_order_quantity",
"taxonomy_type",
"variant_option_sets",
"variants"
]
}
faire_create_variant
Create a new product variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID |
idempotence_token | string | Yes | — | Unique identifier for idempotence |
sku | string | Yes | — | SKU for this variant |
options | object[] | Yes | — | Options that define this variant (must match product variant_option_sets) |
prices | object[] | Yes | — | Prices by geography and currency |
available_quantity | number | No | — | Available inventory quantity |
gtin | string | No | — | Global Trade Item Number |
tariff_code | string | No | — | HS6 Tariff Code |
backordered_until | string | No | — | ISO 8601 timestamp when variant will be back in stock |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID"
},
"idempotence_token": {
"type": "string",
"description": "Unique identifier for idempotence"
},
"sku": {
"type": "string",
"description": "SKU for this variant"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Option name"
},
"value": {
"type": "string",
"description": "Option value"
}
}
},
"description": "Options that define this variant (must match product variant_option_sets)"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"geo_constraint": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Country code (e.g., USA, CAN)"
}
}
},
"wholesale_price": {
"type": "object",
"properties": {
"amount_minor": {
"type": "number",
"description": "Price in minor currency units (cents)"
},
"currency": {
"type": "string",
"description": "Currency code (e.g., USD, CAD)"
}
}
},
"retail_price": {
"type": "object",
"properties": {
"amount_minor": {
"type": "number",
"description": "Retail price in minor currency units"
},
"currency": {
"type": "string",
"description": "Currency code"
}
}
}
}
},
"description": "Prices by geography and currency"
},
"available_quantity": {
"type": "number",
"description": "Available inventory quantity"
},
"gtin": {
"type": "string",
"description": "Global Trade Item Number"
},
"tariff_code": {
"type": "string",
"description": "HS6 Tariff Code"
},
"backordered_until": {
"type": "string",
"description": "ISO 8601 timestamp when variant will be back in stock"
}
},
"required": [
"PCID",
"productId",
"idempotence_token",
"sku",
"options",
"prices"
]
}
faire_get_brand_profile
Get current brand profile informationShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
}
},
"required": [
"PCID"
]
}
faire_get_inventory_by_skus
Get inventory levels by SKU(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
skus | string[] | Yes | — | Array of SKUs to retrieve inventory for |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"skus": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of SKUs to retrieve inventory for"
}
},
"required": [
"PCID",
"skus"
]
}
faire_get_inventory_by_variant_ids
Get inventory levels by variant ID(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ids | string[] | Yes | — | Array of variant IDs to retrieve inventory for |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"ids": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of variant IDs to retrieve inventory for"
}
},
"required": [
"PCID",
"ids"
]
}
faire_get_order
Get detailed information about a specific order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID to retrieve |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID to retrieve"
}
},
"required": [
"PCID",
"orderId"
]
}
faire_get_orders
Get orders from Faire. Orders are returned oldest first (ascending by updated_at). Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | number | No | 50 | Maximum number of orders to return (10-50) |
page | number | No | — | Page number for offset pagination (first result is (page-1)*limit) |
updated_at_min | string | No | — | ISO 8601 timestamp - only show orders modified since this time |
created_at_min | string | No | — | ISO 8601 timestamp - only show orders created since this time |
excluded_states | string | No | — | Comma-separated states to exclude (e.g., “DELIVERED,CANCELLED”) |
ship_after_max | string | No | — | ISO 8601 timestamp - only show orders due to ship at or before this time |
cursor | string | No | — | Pagination cursor from previous response. Cannot be used with date filters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"limit": {
"type": "number",
"default": 50,
"description": "Maximum number of orders to return (10-50)"
},
"page": {
"type": "number",
"description": "Page number for offset pagination (first result is (page-1)*limit)"
},
"updated_at_min": {
"type": "string",
"description": "ISO 8601 timestamp - only show orders modified since this time"
},
"created_at_min": {
"type": "string",
"description": "ISO 8601 timestamp - only show orders created since this time"
},
"excluded_states": {
"type": "string",
"description": "Comma-separated states to exclude (e.g., \"DELIVERED,CANCELLED\")"
},
"ship_after_max": {
"type": "string",
"description": "ISO 8601 timestamp - only show orders due to ship at or before this time"
},
"cursor": {
"type": "string",
"description": "Pagination cursor from previous response. Cannot be used with date filters."
}
},
"required": [
"PCID"
]
}
faire_get_packing_slip
Download packing slip PDF for an order Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID |
timezone | string | No | — | IANA timezone string (e.g., America/New_York), default UTC |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID"
},
"timezone": {
"type": "string",
"description": "IANA timezone string (e.g., America/New_York), default UTC"
}
},
"required": [
"PCID",
"orderId"
]
}
faire_get_product
Get detailed information about a specific product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID to retrieve |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to retrieve"
}
},
"required": [
"PCID",
"productId"
]
}
faire_get_products
Get products from Faire marketplace. Products returned ascending by updated_at. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | number | No | 50 | Maximum number of products to return (10-250) |
page | number | No | — | Page number for offset pagination |
updated_at_min | string | No | — | ISO 8601 timestamp - only return products modified since |
sku | string | No | — | SKU to search for |
include_deleted | boolean | No | — | Include deleted products in response |
cursor | string | No | — | Pagination cursor. Cannot be used with updated_at_min, sku, or include_deleted |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"limit": {
"type": "number",
"default": 50,
"description": "Maximum number of products to return (10-250)"
},
"page": {
"type": "number",
"description": "Page number for offset pagination"
},
"updated_at_min": {
"type": "string",
"description": "ISO 8601 timestamp - only return products modified since"
},
"sku": {
"type": "string",
"description": "SKU to search for"
},
"include_deleted": {
"type": "boolean",
"description": "Include deleted products in response"
},
"cursor": {
"type": "string",
"description": "Pagination cursor. Cannot be used with updated_at_min, sku, or include_deleted"
}
},
"required": [
"PCID"
]
}
faire_get_retailer_info
Get public retailer information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
retailerId | string | Yes | — | Retailer ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"retailerId": {
"type": "string",
"description": "Retailer ID"
}
},
"required": [
"PCID",
"retailerId"
]
}
faire_get_taxonomy_types
Get all available product taxonomy types/categoriesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
}
},
"required": [
"PCID"
]
}
faire_process_order
Mark an order as processing Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID to process |
expected_ship_date | string | No | — | ISO 8601 timestamp of expected ship date |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID to process"
},
"expected_ship_date": {
"type": "string",
"description": "ISO 8601 timestamp of expected ship date"
}
},
"required": [
"PCID",
"orderId"
]
}
faire_ship_order
Mark an order as shipped with tracking information (moves state to PRE_TRANSIT, then IN_TRANSIT when carrier accepts) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
orderId | string | Yes | — | Order ID to ship |
shipments | object[] | Yes | — | Array of shipments to add |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"orderId": {
"type": "string",
"description": "Order ID to ship"
},
"shipments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "Order ID"
},
"carrier": {
"type": "string",
"description": "Carrier name (e.g., fedex, ups, usps)"
},
"tracking_code": {
"type": "string",
"description": "Tracking code"
},
"maker_cost_cents": {
"type": "number",
"description": "Shipping cost in USD cents"
}
}
},
"description": "Array of shipments to add"
}
},
"required": [
"PCID",
"orderId",
"shipments"
]
}
faire_update_inventory_by_skus
Update inventory levels by SKU(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventories | object[] | Yes | — | Array of inventory updates |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"inventories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "SKU"
},
"available_quantity": {
"type": "number",
"description": "Available quantity"
},
"discontinued": {
"type": "boolean",
"description": "Mark as discontinued"
}
}
},
"description": "Array of inventory updates"
}
},
"required": [
"PCID",
"inventories"
]
}
faire_update_inventory_by_variant_ids
Update inventory levels by variant ID(s) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
inventories | object[] | Yes | — | Array of inventory updates |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"inventories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_variant_id": {
"type": "string",
"description": "Variant ID"
},
"available_quantity": {
"type": "number",
"description": "Available quantity"
},
"discontinued": {
"type": "boolean",
"description": "Mark as discontinued"
}
}
},
"description": "Array of inventory updates"
}
},
"required": [
"PCID",
"inventories"
]
}
faire_update_product
Update an existing product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID to update |
updates | object | Yes | — | Fields to update (name, description, taxonomy_type, etc.) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID to update"
},
"updates": {
"type": "object",
"additionalProperties": true,
"description": "Fields to update (name, description, taxonomy_type, etc.)"
}
},
"required": [
"PCID",
"productId",
"updates"
]
}
faire_update_variant
Update an existing product variant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productId | string | Yes | — | Product ID |
variantId | string | Yes | — | Variant ID to update |
updates | object | Yes | — | Fields to update (name, sku, prices, available_quantity, etc.) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"productId": {
"type": "string",
"description": "Product ID"
},
"variantId": {
"type": "string",
"description": "Variant ID to update"
},
"updates": {
"type": "object",
"additionalProperties": true,
"description": "Fields to update (name, sku, prices, available_quantity, etc.)"
}
},
"required": [
"PCID",
"productId",
"variantId",
"updates"
]
}

