API referenceFulfilment schedule

Fulfilment schedule

2 operations. Every schema and example on this page is generated from the platform contract.

GET/api/v1/fulfilment-schedule

Fetch the store’s per-weekday Now/Collect schedule + overrides.

Merchant read of the store’s per-weekday Now/Collect availability and one-off date overrides.

auth merchant:readop getFulfilmentSchedulerate limited errors

Parameters

store_idstring · uuidqueryrequired

Store whose schedule to fetch (also authorises the merchant).

Response, 200

scheduleobjectrequired

The store’s per-weekday Now/Collect schedule + one-off date overrides.

2 child fields

weekdaysarray of objectrequired

Always 7 entries, day_of_week 0..6.

6 child fields

day_of_weeknumberrequired

0..6 (0=Sun).

is_closedbooleanrequired

opens_atstring, nullablerequired

closes_atstring, nullablerequired

now_enabledbooleanrequired

Buy-now (at-counter) available this weekday.

collect_enabledbooleanrequired

Click & Collect available this weekday.

overridesarray of objectrequired

6 child fields

idstringrequired

override_datestringrequired

YYYY-MM-DD.

is_closedbooleanrequired

now_enabledbooleanrequired

collect_enabledbooleanrequired

notestring, nullablerequired

e.g. "Bank holiday".

curl -G "https://www.membber.com/api/v1/fulfilment-schedule" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  --data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.GET("/api/v1/fulfilment-schedule", {
  params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.getFulfilmentSchedule(
    query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json

print(response)

Response, 200

{
  "schedule": {
    "weekdays": [
      {
        "day_of_week": 1,
        "is_closed": true,
        "opens_at": "<opens_at>",
        "closes_at": "<closes_at>",
        "now_enabled": true,
        "collect_enabled": true
      }
    ],
    "overrides": [
      {
        "id": "00000d1b-0000-4000-8000-d0c500000000",
        "override_date": "<override_date>",
        "is_closed": true,
        "now_enabled": true,
        "collect_enabled": true,
        "note": "Added at the front desk"
      }
    ]
  }
}

PATCH/api/v1/fulfilment-schedule

Upsert weekday rows and/or replace date overrides.

Upserts the supplied weekday rows and, when `overrides` is present, fully replaces the override set. A null/absent `overrides` key leaves overrides untouched. Idempotent (upsert).

auth merchant:writeop updateFulfilmentScheduleidempotent retry rate limited errors

Request body

store_idstring · uuidrequired

Store whose schedule to update (also authorises the merchant).

weekdaysarray of objectoptional

Upsert these weekday rows (omit to leave weekdays untouched).

6 child fields

day_of_weekintegerrequired

is_closedbooleanoptional

opens_atstring, nullableoptional

closes_atstring, nullableoptional

now_enabledbooleanoptional

collect_enabledbooleanoptional

overridesarray of objectoptional

Fully REPLACE the override set with these (omit/null to leave overrides untouched).

5 child fields

override_datestringrequired

YYYY-MM-DD.

is_closedbooleanoptional

now_enabledbooleanoptional

collect_enabledbooleanoptional

notestring, nullableoptional

Response, 200

scheduleobjectrequired

The store’s per-weekday Now/Collect schedule + one-off date overrides.

2 child fields

weekdaysarray of objectrequired

Always 7 entries, day_of_week 0..6.

6 child fields

day_of_weeknumberrequired

0..6 (0=Sun).

is_closedbooleanrequired

opens_atstring, nullablerequired

closes_atstring, nullablerequired

now_enabledbooleanrequired

Buy-now (at-counter) available this weekday.

collect_enabledbooleanrequired

Click & Collect available this weekday.

overridesarray of objectrequired

6 child fields

idstringrequired

override_datestringrequired

YYYY-MM-DD.

is_closedbooleanrequired

now_enabledbooleanrequired

collect_enabledbooleanrequired

notestring, nullablerequired

e.g. "Bank holiday".

curl -X PATCH "https://www.membber.com/api/v1/fulfilment-schedule" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "6659c139-0000-4000-8000-d0c500000066"
  }'

import { createMembberClient } from "@membber/sdk-ts";

const membber = createMembberClient({
  getAccessToken: () => process.env.MEMBBER_TOKEN,
});

const { data, error } = await membber.raw.PATCH("/api/v1/fulfilment-schedule", {
  body: {
    store_id: "6659c139-0000-4000-8000-d0c500000066"
  },
  headers: { "Idempotency-Key": crypto.randomUUID() },
});

if (error) {
  // Typed error envelope: { error: { code, message, requestId } }
  throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);

import MembberSwift

let client = MembberClient(
    serverURL: MembberClient.productionServerURL,
    tokenProvider: { session.accessToken }
)

let response = try await client.api.updateFulfilmentSchedule(
    body: .json(.init(
        storeId: "6659c139-0000-4000-8000-d0c500000066"
    ))
).ok.body.json

print(response)

Response, 200

{
  "schedule": {
    "weekdays": [
      {
        "day_of_week": 1,
        "is_closed": true,
        "opens_at": "<opens_at>",
        "closes_at": "<closes_at>",
        "now_enabled": true,
        "collect_enabled": true
      }
    ],
    "overrides": [
      {
        "id": "00000d1b-0000-4000-8000-d0c500000000",
        "override_date": "<override_date>",
        "is_closed": true,
        "now_enabled": true,
        "collect_enabled": true,
        "note": "Added at the front desk"
      }
    ]
  }
}