Return data model

Updated:

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

Data Model
FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
order_idstringNo
statusenumNoValues: REQUESTED, OPEN, APPROVED, REJECTED, CLOSED, CANCELLED, OTHER
typestringNo
currencystringNo
total_refund_amountnumberNo
customer_emailstringNo
customer_namestringNo
return_by_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
lineitemsCommerceReturnLineitem[]No
lineitems[].idstringNo
lineitems[].order_line_idstringNo
lineitems[].item_idstringNo(reference to CommerceItem)
lineitems[].skustringNo
lineitems[].namestringNo
lineitems[].quantitynumberNo
lineitems[].refund_amountnumberNo
lineitems[].reasonstringNo
lineitems[].statusstringNo
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 CommerceReturn = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	order_id?: string;
	status?: 'REQUESTED' | 'OPEN' | 'APPROVED' | 'REJECTED' | 'CLOSED' | 'CANCELLED' | 'OTHER';
	type?: string;
	currency?: string;
	total_refund_amount?: number;
	customer_email?: string;
	customer_name?: string;
	return_by_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	lineitems?: [];
	metadata?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodCommerceReturn = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	order_id: z.string().optional(),
	status: z.enum("REQUESTED", "OPEN", "APPROVED", "REJECTED", "CLOSED", "CANCELLED", "OTHER").optional(),
	type: z.string().optional(),
	currency: z.string().optional(),
	total_refund_amount: z.number().optional(),
	customer_email: z.string().optional(),
	customer_name: z.string().optional(),
	return_by_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	lineitems: z.array().optional(),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class CommerceReturnStatus(str, Enum):
	REQUESTED = 'REQUESTED'
	OPEN = 'OPEN'
	APPROVED = 'APPROVED'
	REJECTED = 'REJECTED'
	CLOSED = 'CLOSED'
	CANCELLED = 'CANCELLED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class CommerceReturn:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	order_id: Optional[str]
	status: Optional[CommerceReturnStatus]
	type: Optional[str]
	currency: Optional[str]
	total_refund_amount: Optional[int]
	customer_email: Optional[str]
	customer_name: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	return_by_at: Optional[str]
	lineitems: Optional[PropertyCommerceReturnLineitems]
	metadata: Optional[PropertyCommerceReturnMetadata]
Are we missing anything? Let us know
Was this page helpful?