Business model
The Business resource represents a store or service location inside an Ordering.co project.
Core operations
| Action | Method | Resource | Purpose |
|---|---|---|---|
| List businesses | GET | /business | Return businesses visible under the selected query and caller context. |
| Find a business | GET | /business/{business} | Return one business by numeric ID or slug. |
| Create a business | POST | /business | Create a business under administrator or business-manager rules. |
| Update a business | POST | /business/{business} | Partially update a business by numeric ID. |
| Delete a business | DELETE | /business/{business} | Delete a business when ownership and shared-resource checks allow it. |
An earlier model table labeled update as PUT, but the route listed here uses POST. The operation guide specifies each operation's parameters, authentication, request fields, responses, and errors.
Representative fields
The schema described here contains many operation-specific fields. Common groups include:
| Group | Representative fields |
|---|---|
| Identity | id, name, slug, description, about, enabled, featured |
| Contact | email, phone, cellphone, address, address_notes, zipcode |
| Location | city_id, location, timezone, country_code, state, locality |
| Commerce | currency, minimum, delivery_price, service_fee, tax, tax_type |
| Fulfillment | schedule, delivery_time, pickup_time, always_deliver |
| Media and presentation | logo, header, seo_image, seo_title, seo_description |
| Ownership and organization | owner_id, franchise_id, parent_business_id, types |
The spellings alchohol and use-printer are not field names used in the schema described here. The schema described here uses alcohol and use_printer.
Some properties are filterable and appear in the operation's x-ordering-whereable metadata. Field presence in the model does not mean every operation returns or accepts that field. Sparse responses and relation expansions can also change the response shape.
For structured schedules and locations, see Special data types, documented as a reference for structured schedules and locations. For endpoint-specific relation expansions, see Business special requests.