Developer reference

The practical detail. If you are new here, start at /helloworld instead; it has a first task and a list of things worth building.

The data we publish

One stable public surface: /files/catalog.json, a schema.org feed of every product with SKU, name, url, category, brand, description, image and price. No key, no signup. It is a static file, so reading it costs us nothing.

Full documentation, including the catch weight rule you must get right before displaying any of our prices, is in docs/API.md.

What we can and cannot share

  • Open: products, cuts, weights, images, our story, store hours, pickup locations, shipping estimates.
  • By agreement, scoped to you: your own pricing, your own orders, your own invoices and tracking.
  • Never: anyone else's data, our margins or costs, and anything touching payment processing.

The partner API, in design

A scoped, authenticated API for people who buy from us: your price list, order placement and status, your invoices, shipment tracking. If you run a restaurant, a distributor, or a store that would resell our beef, tell us what you need and we will design it against a real integration rather than guessing.

Use the catalog file, not a crawler

The catalog file has everything the product pages have, in one request, already structured. It is faster for you than scraping and it is the polite way to do this. Automated scanning and load testing are not welcome. If your project needs something it does not cover, ask and we will find a way to give it to you properly.

Security

Found a security problem? Email gray@shipleyfarmsbeef.com directly rather than opening a public issue. We will confirm receipt and we will not pursue anyone reporting in good faith. We do not run a paid bounty.

Get in touch

Send us something   The repository