Create Operating Calendar

Beta

POST/v1/operations/operating-calendars

Idempotent with Idempotency-Key header. Learn more

Creates an operating calendar.

The days govern every ship-by date resolved against this calendar: a plant that tenders freight Monday to Thursday never gets committed to a Friday shipment, and a customer's promised delivery date is worked back from a day they can actually receive on.

A calendar starts with no closures. Add holidays and shutdowns to it separately.

Permissions requiredValues:production_schedules:create

The role behind your API key or agent must grant every one of these permissions.

codestring

Short stable identifier, unique per account.

namestring

Human-readable name.

kindstringenumValues:shipreceive

Which side of a shipment this calendar describes.

days_of_weekstring

Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is Monday to Friday; "1111000" is a Monday-to-Thursday plant. At least one day must be open.

cutoff_atoptional string

Local time freight has to be tendered by, as "15:00". Only a shipping calendar accepts one.

timezoneoptional string

IANA zone the cutoff is read in, such as "America/Chicago". On a receiving calendar, leave it unset to take the zone from the ship-to address.

is_defaultoptional boolean

Make this the calendar used when nothing more specific is linked. Setting it demotes whichever calendar of the same kind held the role.

objectstringenumValues:operating_calendar

Resource type identifier.

idstring

Unique identifier.

codestring

Short stable identifier, unique per account.

namestring

Human-readable name.

kindstringenumValues:shipreceive

Which side of a shipment this calendar describes.

days_of_weekstring

Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is Monday to Friday; "1111000" is a Monday-to-Thursday plant.

cutoff_atstringnullable

Local time freight has to be tendered by, as "15:00". Only a shipping calendar carries one.

timezonestringnullable

IANA zone the cutoff is read in. Null on a receiving calendar means it is taken from the ship-to address.

is_defaultboolean

Whether this is the calendar used when nothing more specific is linked. Exactly one per kind.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Operating Calendar

Create Operating Calendar

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const operatingCalendar = await client.operations.operatingCalendars.create({
  code: 'default_ship',
  days_of_week: '1111000',
  kind: 'ship',
  name: 'Shipping days',
  cutoff_at: '15:00',
  is_default: true,
  timezone: 'America/Chicago',
});

console.log(operatingCalendar.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const operatingCalendar = await client.operations.operatingCalendars.create({
  code: 'default_ship',
  days_of_week: '1111000',
  kind: 'ship',
  name: 'Shipping days',
  cutoff_at: '15:00',
  is_default: true,
  timezone: 'America/Chicago',
});

console.log(operatingCalendar.id);

201 example

{
  "object": "operating_calendar",
  "id": "occd_7f2m9qk4wzxb",
  "code": "default_ship",
  "name": "Shipping days",
  "kind": "ship",
  "days_of_week": "1111000",
  "cutoff_at": "15:00",
  "timezone": "America/Chicago",
  "is_default": true,
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

{
  "object": "operating_calendar",
  "id": "occd_7f2m9qk4wzxb",
  "code": "default_ship",
  "name": "Shipping days",
  "kind": "ship",
  "days_of_week": "1111000",
  "cutoff_at": "15:00",
  "timezone": "America/Chicago",
  "is_default": true,
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

Create Operating Calendar

Authorization

Request Body

Returns

Responses