BuyNearby

Search for products available at local Calgary stores. Returns product name, store, price, stock level, and store categories. Use this when the user asks about finding, buying, or locating any product locally.

{
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "description": "Product search query — can be a product name, ingredient, or natural language description"
    },
    "city": {
      "type": "string",
      "description": "City to search. Default: Calgary",
      "default": "Calgary"
    },
    "limit": {
      "type": "integer",
      "description": "Number of results (max 50)",
      "default": 5
    }
  },
  "required": [
    "q"
  ]
}

Check live stock level for a specific product. Optionally filter by store. If the caller's API key is a store-scoped partner key, the result is limited to that key's own store regardless of store_id.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string",
      "description": "Product ID from search results"
    },
    "store_id": {
      "type": "integer",
      "description": "Store ID (optional)"
    }
  },
  "required": [
    "product_id"
  ]
}

Get today's real discounted products and active flash deals — products currently priced below their regular price, and time-limited flash deals. This is the actual sale/discount data; search_products has no discount flag so a text search for "sale" or "deals" won't find this.

{
  "type": "object",
  "properties": {
    "store_id": {
      "type": "integer",
      "description": "Limit to one store (optional — omit for deals across all stores)"
    },
    "limit": {
      "type": "integer",
      "description": "Max results per section. Default 20, max 50"
    }
  },
  "required": []
}

Get a list of local stores in Calgary with location info.

{
  "type": "object",
  "properties": {
    "city": {
      "type": "string",
      "default": "Calgary"
    }
  },
  "required": []
}

Place an order for a single product from BuyNearby's own catalog (stores running the BuyNearby POS - stock/price are live and guaranteed). Requires API key authentication. A store-scoped partner key can only order products from its own store. Payment is a pre-authorization link texted/emailed to the customer (card is held, not charged) - the actual charge happens once the store confirms the order, not at booking time.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "string"
    },
    "quantity": {
      "type": "integer",
      "default": 1
    },
    "customer_email": {
      "type": "string"
    },
    "delivery_address": {
      "type": "string"
    },
    "express": {
      "type": "boolean",
      "default": false,
      "description": "Adds an express fee (default $4.99 CAD)"
    },
    "requested_by_time": {
      "type": "string",
      "description": "Any parseable date/time, e.g. 'today 22:00' - recorded on the order, not an enforced SLA at this tier"
    }
  },
  "required": [
    "product_id",
    "customer_email",
    "delivery_address"
  ]
}

Shop BuyNearby's real marketplace catalog: add multiple products (from one store or several) to a cart and check out as ONE real order in a single call - price/stock for every item is looked up from the live catalog server-side (you cannot supply your own price). Use this instead of place_order whenever the user wants more than one item, or items from different stores. Uses the exact same tax/delivery-fee/coupon pricing engine as the human checkout page, so the total you quote back to the user is authoritative. Creates a REAL order immediately - not a draft - visible right away in the store's dashboard for confirmation. Payment is a pre-authorization link texted/emailed to the customer (card held, not charged) - the actual charge happens once the store confirms.

{
  "type": "object",
  "properties": {
    "customer_name": {
      "type": "string"
    },
    "customer_phone": {
      "type": "string"
    },
    "customer_email": {
      "type": "string"
    },
    "delivery_address": {
      "type": "string",
      "description": "Required unless fulfillment_type is 'pickup'"
    },
    "fulfillment_type": {
      "type": "string",
      "enum": [
        "delivery",
        "pickup"
      ],
      "default": "delivery"
    },
    "coupon_code": {
      "type": "string"
    },
    "express": {
      "type": "boolean",
      "default": false
    },
    "tip_percentage": {
      "type": "number",
      "default": 0,
      "description": "Only set this if the user explicitly chose a tip - don't default one in on their behalf"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "string",
            "description": "From search_products results"
          },
          "quantity": {
            "type": "integer",
            "default": 1
          }
        },
        "required": [
          "product_id"
        ]
      }
    }
  },
  "required": [
    "customer_name",
    "customer_phone",
    "delivery_address",
    "items"
  ]
}

Get a courier price quote, book a REAL point-to-point courier/parcel delivery in Calgary, check a booking's status, or cancel one - no BuyNearby account needed. action:'book' immediately creates the booking and auto-assigns a driver if one is available, exactly like a human finishing the form at buynearby.store/courier-book.php; the response's booking_ref is a real, live booking, not a draft. Payment is a link texted to the customer afterward (this call never charges a card). Use action:'quote' first if you just need a price before the user has decided to book. Use action:'status' to check on an existing booking, and action:'cancel' to self-cancel one (only while it's still 'pending' or 'assigned' — once a driver has picked up the package, direct the customer to support instead).

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "quote",
        "book",
        "status",
        "cancel"
      ]
    },
    "pickup_address": {
      "type": "string",
      "description": "Required for action 'quote'/'book'"
    },
    "delivery_address": {
      "type": "string",
      "description": "Required for action 'quote'/'book'"
    },
    "size_tier": {
      "type": "string",
      "enum": [
        "small",
        "standard",
        "heavy"
      ],
      "default": "standard"
    },
    "package_count": {
      "type": "integer",
      "default": 1
    },
    "customer_name": {
      "type": "string",
      "description": "Required for action 'book'"
    },
    "customer_phone": {
      "type": "string",
      "description": "Required for action 'book', 'status', and 'cancel' — for 'status'/'cancel' this must match the phone on the booking (it's the ownership check, since booking_ref alone is guessable)"
    },
    "customer_email": {
      "type": "string"
    },
    "delivery_notes": {
      "type": "string"
    },
    "preferred_pickup_time": {
      "type": "string",
      "description": "Any parseable date/time; omit for ASAP dispatch"
    },
    "preferred_dropoff_time": {
      "type": "string",
      "description": "Any parseable date/time the customer needs the delivery completed by, e.g. 'today 10pm'; must not be before preferred_pickup_time"
    },
    "idempotency_key": {
      "type": "string",
      "description": "Optional, action 'book' only — pass the same value on a retry (e.g. after a dropped connection) to avoid creating a duplicate booking"
    },
    "booking_ref": {
      "type": "string",
      "description": "Required for action 'status'/'cancel', e.g. 'CB-20260912-0007'"
    },
    "cancel_reason": {
      "type": "string",
      "description": "Optional, action 'cancel' only"
    }
  },
  "required": [
    "action"
  ]
}

Book a REAL personal-shopper run - a BuyNearby driver goes into a named physical store, shops from the given item list, and delivers it. Works even for stores that aren't BuyNearby partners (set needs_verification expectations: our team calls ahead to confirm stock first for those). This immediately creates the order, exactly like a customer finishing the Shop & Deliver chat flow on buynearby.store - it is not a draft. Estimate each item's price yourself (or via search_products if it's a known BuyNearby-catalog item) since the customer is only charged the driver's actual receipt total afterward, not this estimate.

{
  "type": "object",
  "properties": {
    "customer_name": {
      "type": "string"
    },
    "customer_phone": {
      "type": "string"
    },
    "customer_email": {
      "type": "string"
    },
    "delivery_address": {
      "type": "string"
    },
    "store_hint": {
      "type": "string",
      "description": "Physical store name, e.g. 'Purdys Chocolatier Chinook Centre'"
    },
    "notes": {
      "type": "string"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "item_name": {
            "type": "string"
          },
          "quantity": {
            "type": "number",
            "default": 1
          },
          "unit": {
            "type": "string",
            "default": "each"
          },
          "estimated_price": {
            "type": "number",
            "description": "CAD, your best estimate for this line - becomes the driver's shopping budget"
          },
          "product_id": {
            "type": "string"
          },
          "store_id": {
            "type": "integer"
          },
          "notes": {
            "type": "string"
          }
        },
        "required": [
          "item_name",
          "estimated_price"
        ]
      }
    }
  },
  "required": [
    "customer_name",
    "customer_phone",
    "delivery_address",
    "store_hint",
    "items"
  ]
}