Inventory data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringNo
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
item_idstringNo(reference to CommerceItem)
item_variant_idstringNo(reference to CommerceCommerceItemvariant)
item_option_idstringNo
location_idstringNo(reference to CommerceLocation)
availablenumberNo
metadataCommerceMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
metadata[].descriptionstringNo
metadata[].is_requiredbooleanNo

TypeScript

TypeScript
export type CommerceInventory = {
	id?: string;
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	item_id?: string; // (reference to CommerceItem)
	item_variant_id?: string; // (reference to CommerceCommerceItemvariant)
	item_option_id?: string;
	location_id?: string; // (reference to CommerceLocation)
	available?: number;
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodCommerceInventory = z.object({
	id: z.string().optional(),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	item_id: z.string().optional().describe("(reference to CommerceItem)"),
	item_variant_id: z.string().optional().describe("(reference to CommerceCommerceItemvariant)"),
	item_option_id: z.string().optional(),
	location_id: z.string().optional().describe("(reference to CommerceLocation)"),
	available: z.number().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CommerceInventory:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(reference to CommerceItem)"""
	item_id: Optional[str]
	"""(reference to CommerceCommerceItemvariant)"""
	item_variant_id: Optional[str]
	item_option_id: Optional[str]
	"""(reference to CommerceLocation)"""
	location_id: Optional[str]
	available: Optional[int]
	metadata: Optional[PropertyCommerceInventoryMetadata]
Are we missing anything? Let us know
Was this page helpful?