ShippingOption
Type: schema
TypeScript Definition
typescript
ShippingOption: {{
id?: string;
name?: string;
description?: string | null;
is_connected?: boolean;
is_forward_shipping?: boolean;
is_return_shipping?: boolean;
logo_dark?: $Read<string | null>;
logo_light?: $Read<string | null>;
/** @description Primary logo URL for display. Same as `logo_light` for most providers. */
logo?: $Read<string | null>;
/** @enum {unknown} */
fulfillment_type?: $Read<"delivery" | "collect-in-store">;
sort_order?: $Read<number>;
/** @enum {unknown} */
type?: "auto" | "manual";
/** @enum {unknown} */
status?: "active" | "inactive";
};
/** ShippingRateBasedOnItemWeight */
}OpenAPI Schema
json
{
"title": "ShippingOption",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"is_connected": {
"type": "boolean"
},
"is_forward_shipping": {
"type": "boolean"
},
"is_return_shipping": {
"type": "boolean"
},
"logo_dark": {
"type": [
"string",
"null"
],
"readOnly": true
},
"logo_light": {
"type": [
"string",
"null"
],
"readOnly": true
},
"logo": {
"description": "Primary logo URL for display. Same as `logo_light` for most providers.",
"type": [
"string",
"null"
],
"readOnly": true
},
"fulfillment_type": {
"enum": [
"delivery",
"collect-in-store"
],
"readOnly": true
},
"sort_order": {
"type": "integer",
"readOnly": true
},
"type": {
"enum": [
"auto",
"manual"
]
},
"status": {
"enum": [
"active",
"inactive"
]
}
}
}Auto-generated from OpenAPI spec and TypeScript definitions