Operating Calendars

The operating_calendar object

OperatingCalendar is the set of days one party to a shipment operates.

A ship calendar is the plant tendering freight to a carrier; a receive calendar is a customer's dock accepting it. Ship-by dates are resolved against both, so an order is never committed to a day nobody can act on.

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.

Used by

POSTCreate Operating CalendarOperating CalendarsPATCHUpdate Operating CalendarOperating CalendarsGETList Operating CalendarsOperating CalendarsGETRetrieve Operating CalendarOperating CalendarsDELETEDelete Operating CalendarOperating CalendarsPOSTCreate Operating Calendar ClosureOperating CalendarsGETList Operating Calendar ClosuresOperating CalendarsDELETEDelete Operating Calendar ClosureOperating Calendars