catalog

Find custom branded merchandise by keywords (e.g. "insulated tumbler", "trade show tote bag", "eco pen") with optional category, color, size and price filters. Returns product summaries with a from-price and the handle to pass to get_product or quote_price. Results are ranked by relevance unless sorted by price. Omit `query` to browse: with a `category` and no keywords this returns that category, which is how to answer an occasion or gifting ask. When nothing matches, facets.categories lists the categories worth browsing instead and `notes` says so.

{
  "type": "object",
  "properties": {
    "query": {
      "description": "Keywords, a product name, or a SKU. Omit to browse everything the other filters allow.",
      "type": "string",
      "maxLength": 200
    },
    "category": {
      "description": "A category name from a previous result's facets, e.g. \"Drinkware\", \"2026 Gift Guide\".",
      "type": "string",
      "maxLength": 100
    },
    "color": {
      "type": "string",
      "maxLength": 60
    },
    "size": {
      "type": "string",
      "maxLength": 40
    },
    "price_min": {
      "description": "Minimum from-price per unit, USD.",
      "type": "number",
      "minimum": 0
    },
    "price_max": {
      "description": "Maximum from-price per unit, USD.",
      "type": "number",
      "exclusiveMinimum": 0
    },
    "page": {
      "description": "Zero-based page.",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "page_size": {
      "type": "integer",
      "minimum": 1,
      "maximum": 24
    },
    "sort": {
      "type": "string",
      "enum": [
        "relevance",
        "price_asc",
        "price_desc"
      ]
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Full UCP product records for up to 6 products by id or handle, in one call. Use get_product for one.

{
  "type": "object",
  "properties": {
    "ids": {
      "minItems": 1,
      "maxItems": 6,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      },
      "description": "Product ids or handles (slugs)."
    }
  },
  "required": [
    "ids"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The full UCP product record: description, images, categories, colors, sizes, decoration methods, price range, minimum quantity, lead time, and whether a free sample is offered. For a price at a specific quantity, call quote_price.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    }
  },
  "required": [
    "product"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Price an order of a given quantity: per-unit price at that quantity, one-time setup, run charges, rush and tariff, the subtotal (before shipping and tax), whether the quantity is orderable, the next price break, and a deep_link that opens promotionpros.com on exactly this configuration with the same total. Optionally choose color, decoration method, number of imprint colors, per-size quantities and rush.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    },
    "quantity": {
      "description": "Total pieces.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "sizes": {
      "description": "Per-size quantities for apparel; replaces quantity.",
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "size": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "size",
          "quantity"
        ]
      }
    },
    "color": {
      "description": "Product color name, from get_product_options.",
      "type": "string",
      "maxLength": 60
    },
    "imprint_method": {
      "description": "Decoration method name, from get_imprint_options.",
      "type": "string",
      "maxLength": 80
    },
    "imprint_colors": {
      "description": "Number of ink colors in the logo on the primary location.",
      "type": "integer",
      "minimum": 1,
      "maximum": 12
    },
    "rush": {
      "type": "boolean"
    }
  },
  "required": [
    "product"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

How a product can be decorated: each imprint method with its minimum and maximum quantity, setup charge and whether it is one-time or per additional location, whether the first imprint is included in the unit price, extra-color and extra-location run charges, imprint locations with their sizes and color limits, and guidance on when to use the method.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    }
  },
  "required": [
    "product"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The choices before a quote: colors (with hex), sizes with their quantity price ladders, whether sizes are priced differently, quantity step, stock by color and size when tracked, free shipping, lead time and rush availability, and the free-sample link when the product qualifies.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    }
  },
  "required": [
    "product"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

When an order placed today would arrive: the standard FedEx Ground date and, when the product offers it, the rush date — both in one call. Give the buyer's US state for a real shipping lane; dates are business days from today in Central time and include the free proof, production and transit. Rush skips the proof wait and starts the same business day when artwork arrives before noon Central.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    },
    "destination_state": {
      "description": "Where it ships to: a US state code (\"IL\") or full name (\"Illinois\"). Omit if unknown — a typical US transit is assumed. US only.",
      "type": "string",
      "maxLength": 40
    }
  },
  "required": [
    "product"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Issue a real, numbered Promotion Pros quote for a configuration priced with quote_price, and email it to the buyer. Returns the quote number, the reconciled price breakdown, a PDF, a link to the quote page and a link that takes the buyer straight to payment. Requires the buyer's full name, work email and phone number — ask for them, and confirm the configuration and the quantity, before calling this. This writes: it creates an order record and sends mail, and calling it twice issues two quotes to the same person. The price is recomputed live by promotionpros.com, so it can differ slightly from quote_price's snapshot; the numbers returned here are the quoted ones. Shipping and tax are not in the quote until the buyer adds a delivery address on the quote page.

{
  "type": "object",
  "properties": {
    "product": {
      "type": "object",
      "properties": {
        "slug": {
          "description": "The product page path, e.g. \"blue-ceramic-mug-11oz\" — from a search result's handle or a promotionpros.com URL.",
          "type": "string",
          "minLength": 1
        },
        "id": {
          "description": "The catalog product id, as returned by search_catalog.",
          "type": "integer",
          "exclusiveMinimum": 0,
          "maximum": 9007199254740991
        },
        "sku": {
          "description": "The Promotion Pros SKU shown on the product page.",
          "type": "string",
          "minLength": 1
        }
      },
      "description": "Identify the product by exactly one of slug, id or sku."
    },
    "quantity": {
      "description": "Total pieces. Below the method's minimum, the quote is issued at the minimum.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "sizes": {
      "description": "Per-size quantities for apparel; replaces quantity.",
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "size": {
            "type": "string",
            "minLength": 1
          },
          "quantity": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "size",
          "quantity"
        ]
      }
    },
    "color": {
      "description": "Product color name, from get_product_options.",
      "type": "string",
      "maxLength": 60
    },
    "imprint_method": {
      "description": "Decoration method name, from get_imprint_options.",
      "type": "string",
      "maxLength": 80
    },
    "imprint_colors": {
      "type": "integer",
      "minimum": 1,
      "maximum": 12
    },
    "rush": {
      "type": "boolean"
    },
    "full_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "description": "The buyer's full name, as they gave it."
    },
    "email": {
      "type": "string",
      "minLength": 3,
      "maxLength": 200,
      "description": "The buyer's work email. The quote is sent here, so confirm it before calling."
    },
    "phone": {
      "type": "string",
      "minLength": 5,
      "maxLength": 40,
      "description": "A phone number to reach the buyer on. Required by the quote desk."
    },
    "company": {
      "type": "string",
      "maxLength": 200
    },
    "destination_state": {
      "description": "Where it ships to, for the arrival estimate recorded on the quote: a US state code (\"IL\") or name. Omit if unknown.",
      "type": "string",
      "maxLength": 40
    }
  },
  "required": [
    "product",
    "full_name",
    "email",
    "phone"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}