API docs
Sous Chef Management API
Request access

Set location special hours

POST/management/stores/setLocationSpecialHours

Replace a location's upcoming special dates: holidays, early closes, full-day closures. The list you send replaces all special dates from today forward; past dates are untouched. Propagates asynchronously to every storefront at the location, including those of an organization that has set its own weekly hours at this kitchen: a closure closes them like every other storefront, and a date that opens the kitchen opens each one only within the hours fetchStoreHours reports as its regular.

The location tier is the only special-hours tier this API writes. Sous Chef also holds brand-at-location overrides, and a storefront's effective special dates combine the two. fetchStoreHours reports the combined result.

dates is required and must be non-empty unless wipeAll: true, which clears every upcoming special date instead. See SetLocationSpecialHoursRequest.

Scope: owner-only, which is narrower than the reads. Only a locationId your organization owns: one whose Location.organizationId from fetchLocations equals your own organization id. If you operate a brand out of somebody else's host kitchen, fetchLocations shows you that kitchen and fetchStoreHours reports its special dates, but you may not write them. A location-hours write is not brand-scoped: it moves the schedule for every brand trading there, including the host's. Ask the host to make the change.

A locationId that is not yours, whether it belongs to another organization or is a host kitchen you operate in, is treated the same as one that does not exist. Each returns the same 404 and nothing is written. The response body does not say which case applied, so check organizationId on the location from fetchLocations against your own organization id before you write.

Safe to retry: this operation changes state but is idempotent.

Request

application/json
required
  • locationIdstring

    The Location to write special hours for. Required.

  • datesSpecialDate[]

    The complete desired set of special hours for the location, replacing every upcoming date not present in it. Required and must be non-empty unless wipeAll: true. See the request's own description.

  • wipeAllboolean

    Set to true to clear every upcoming special date. Absent means the normal behavior (send dates). See the request's own description.

Responses

200: The location's special dates as saved by this call.

Headers

  • x-mealco-tx-idstringoptional

    The correlation id for this call, returned on every response that an operation produces, successful or not. Quote it when you report a problem so that we can trace the request. You may send your own x-mealco-tx-id on the request and it is used as the id. It is optional in the schema because a request with a malformed JSON body is rejected before an id is assigned, so that one response carries neither this header nor the txId field of the error body.

  • datesSpecialDate[]

    The location's special dates as persisted after this call.

About Stores

The places you operate and the brands you operate there.

Sous Chef models a restaurant business in three layers, and every other section of this API assumes them. A brand is a menu concept: what a customer sees on a delivery app. A location is a physical address with a kitchen in it. A store is one storefront: a single brand, at a single location, on a single platform. A location running two brands on three platforms has six stores, each with its own menu, hours and pause state.

The directory reads join on ids, never on display names: every store carries its location.id and brand.id, and a location carries the id of each brand it runs.

Start here. A location carries the timezone that every schedule, report window and business day elsewhere on this API is interpreted in.

Every operation is scoped to the organization your API key resolves to, and nothing here calls out to a delivery platform live. The directory reads (fetchLocations, fetchBrands, fetchStores, fetchStore, fetchStoreHours, fetchStoreMenus) never mutate; setLocationHours and setLocationSpecialHours write a location you own.

Whether a storefront is currently taking orders is not in this section. fetchStoreStatuses, pauseStores, unpauseStores and the store.status.changed webhook are in the Store status section. This section describes what you operate. That one describes whether it is open right now, and whether the platform agrees.