Availability data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
location_idstringNo(reference to CommerceLocation)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sizenumberNo
item_idstringNo(reference to CommerceItem)
staff_user_idstringNo(reference to HrisEmployee)

TypeScript

TypeScript
export type CommerceAvailability = {
	location_id?: string; // (reference to CommerceLocation)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	size?: number;
	item_id?: string; // (reference to CommerceItem)
	staff_user_id?: string; // (reference to HrisEmployee)
	raw?: any;
} 

Zod

Zod
import { z } from 'zod';

export const ZodCommerceAvailability = z.object({
	location_id: z.string().optional().describe("(reference to CommerceLocation)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	size: z.number().optional(),
	item_id: z.string().optional().describe("(reference to CommerceItem)"),
	staff_user_id: z.string().optional().describe("(reference to HrisEmployee)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CommerceAvailability:
	"""(reference to CommerceLocation)"""
	location_id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	size: Optional[int]
	"""(reference to CommerceItem)"""
	item_id: Optional[str]
	"""(reference to HrisEmployee)"""
	staff_user_id: Optional[str]
Are we missing anything? Let us know
Was this page helpful?