Shoptegrity

Look up one brand, store or company by name: its cited parent company, ownership type, source links and, for scored brands, a Shoptegrity composite score (an opinion). Use it for a single known name. Fields without a cited source come back null and are listed as withheld. A name Shoptegrity does not have returns an error that is not a negative finding about the company.

{
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "lookup_brandArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "lookup_brandOutput"
}

List alternatives for one brand that a Shoptegrity editor approved and that have a cited basis. Returns an empty list, with a note, when none are approved yet; browse_alternatives lists cited employee-owned, cooperative and independent options by category instead. Alternatives are not ranked by commission.

{
  "type": "object",
  "properties": {
    "brand_name": {
      "title": "Brand Name",
      "type": "string"
    }
  },
  "required": [
    "brand_name"
  ],
  "title": "find_alternativesArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "find_alternativesOutput"
}

Alternatives to mainstream shopping that have a cited basis: employee-owned, cooperative, credit union, B Corp or family-owned sellers. structure filters by kind (for example 'employee-owned', 'cooperative', 'credit union', 'b corp'); query filters by words in the name or the category it substitutes for (for example 'grocery' or 'hardware'). Each result carries the source that backs it. Not ranked by commission.

{
  "type": "object",
  "properties": {
    "structure": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Structure"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Query"
    },
    "limit": {
      "default": 20,
      "title": "Limit",
      "type": "integer"
    }
  },
  "title": "browse_alternativesArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "browse_alternativesOutput"
}

Local businesses near a US ZIP code or a town and state, such as '55401' or 'Duluth, MN': Shoptegrity's directory (co-ops, markets, credit unions; pilot areas) plus independent shops anywhere in the US (books, gifts, toys, food, markets, grocery, hardware, clothing, secondhand, outdoors, home, music), for Small Business Saturday or any local shopping. category narrows either list; radius_km is 0.1 to 500 (default 25; shops are searched within 15). Chains and franchises are left out. Not ranked by commission.

{
  "type": "object",
  "properties": {
    "location": {
      "title": "Location",
      "type": "string"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category"
    },
    "radius_km": {
      "default": 25,
      "title": "Radius Km",
      "type": "number"
    }
  },
  "required": [
    "location"
  ],
  "title": "find_local_businessesArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "find_local_businessesOutput"
}

Search the scored-brand table by name, category and minimum grade, and return a short summary per brand (parent company, shareholder payout, grade and ratings where published). Use it to browse; use lookup_brand for one known name. An empty result means no match, not a negative finding.

{
  "type": "object",
  "properties": {
    "query": {
      "default": "",
      "title": "Query",
      "type": "string"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category"
    },
    "min_grade": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Min Grade"
    },
    "limit": {
      "default": 20,
      "title": "Limit",
      "type": "integer"
    }
  },
  "title": "search_top_brandsArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "search_top_brandsOutput"
}

In-depth cited metrics for one brand: the split of revenue among workers, executives and shareholders, labor records, and waste, plus SEC filing figures where they exist. Every field without a cited source is null and listed under withheld_claims. Grades and ratings are Shoptegrity opinions.

{
  "type": "object",
  "properties": {
    "brand_name": {
      "title": "Brand Name",
      "type": "string"
    }
  },
  "required": [
    "brand_name"
  ],
  "title": "lookup_brand_integrityArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "lookup_brand_integrityOutput"
}

Scorecards for the major retailers Shoptegrity covers (Walmart, Target, Costco, Amazon, Kroger, Dollar General, The Home Depot, WinCo Foods, Ace Hardware): parent company, revenue, net income and shareholder payouts from SEC filings, and ratings or swaps only where an editor approved them. Takes no arguments. Missing values are null (withheld).

{
  "type": "object",
  "properties": {},
  "title": "rate_major_retailersArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "rate_major_retailersOutput"
}

One major retailer's cited financial figures and any editor-approved swap. Takes a retailer name such as Walmart or The Home Depot. The swap fields are null until a swap has been approved and cited; the error lists the retailers available.

{
  "type": "object",
  "properties": {
    "retailer_name": {
      "title": "Retailer Name",
      "type": "string"
    }
  },
  "required": [
    "retailer_name"
  ],
  "title": "get_retailer_swapsArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "get_retailer_swapsOutput"
}

Shoptegrity's cited ownership signals for a seller or brand name, or a plain statement that it has none (not a negative finding). Same data as lookup_brand, phrased for a seller you are about to buy from.

{
  "type": "object",
  "properties": {
    "name": {
      "title": "Name",
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "title": "check_sellerArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "check_sellerOutput"
}

Search independent sellers for a product or gift idea, with today's price, a check against recorded price history, and any Shoptegrity standing, for gift ideas and holiday shopping. max_price is in USD.

{
  "type": "object",
  "properties": {
    "product": {
      "title": "Product",
      "type": "string"
    },
    "max_price": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Max Price"
    },
    "limit": {
      "default": 10,
      "title": "Limit",
      "type": "integer"
    }
  },
  "required": [
    "product"
  ],
  "title": "responsible_alternativesArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "responsible_alternativesOutput"
}

Judge a sale price against Shoptegrity's recorded daily price history for a Shopify catalog product. Flags 'raised_then_lowered' when a price was pushed up before a sale. Works for Black Friday and Cyber Monday deals. product_id comes from responsible_alternatives.

{
  "type": "object",
  "properties": {
    "product_id": {
      "title": "Product Id",
      "type": "string"
    },
    "current_price": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Current Price"
    }
  },
  "required": [
    "product_id"
  ],
  "title": "check_dealArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "check_dealOutput"
}

A plan for shopping with integrity on Black Friday, Small Business Saturday, Cyber Monday, Giving Tuesday or for holiday gifts: the date, days left, and which Shoptegrity tools to use at each step. occasion is black_friday, small_business_saturday, cyber_monday, giving_tuesday, christmas, or 'next' for the next one coming up. today is an ISO date and defaults to the server's date. For Black Friday, Cyber Monday and holiday gifts it also returns links to large retailers' own weekly-ad and deals pages.

{
  "type": "object",
  "properties": {
    "occasion": {
      "default": "next",
      "title": "Occasion",
      "type": "string"
    },
    "today": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Today"
    }
  },
  "title": "holiday_shopping_guideArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "holiday_shopping_guideOutput"
}

Check a shopping or gift list: for each item, which scored company it belongs to (if any), the cited facts Shoptegrity holds (parent, filings, shareholder payouts) and what is withheld. Items can be products, brands or stores, such as 'AirPods', 'Tide pods' or 'Walmart'. Up to 50 items.

{
  "type": "object",
  "properties": {
    "items": {
      "items": {
        "type": "string"
      },
      "title": "Items",
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "title": "check_cartArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "check_cartOutput"
}

Products from independent Shopify sellers whose price Shoptegrity recorded dropping below its usual level. Shows real drops rather than headline discounts, for Black Friday and Cyber Monday. A drop counts only with at least 7 earlier days of recorded prices; prices raised before a sale never qualify. min_percent_off is 1-90. query filters by words in the title or seller. max_per_seller (default 3) keeps one seller's sale from filling the list. Largest drop first, never ordered by commission.

{
  "type": "object",
  "properties": {
    "min_percent_off": {
      "default": 10,
      "title": "Min Percent Off",
      "type": "number"
    },
    "query": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Query"
    },
    "limit": {
      "default": 20,
      "title": "Limit",
      "type": "integer"
    },
    "max_per_seller": {
      "default": 3,
      "title": "Max Per Seller",
      "type": "integer"
    }
  },
  "title": "verified_dealsArguments"
}

{
  "type": "object",
  "properties": {
    "result": {
      "additionalProperties": true,
      "title": "Result",
      "type": "object"
    }
  },
  "required": [
    "result"
  ],
  "title": "verified_dealsOutput"
}