Shipping

amerta

---

amerta / payload-types / Shipping

Interface: Shipping

Defined in: payload-types.ts:2618

This interface was referenced by Config's JSON-Schema via the definition "shipping".

Properties

active?

optional active: boolean | null

Defined in: payload-types.ts:2703

Enable or disable this shipping method

---

citiesType

citiesType: "all" | "specific"

Defined in: payload-types.ts:2639

Choose whether this applies to all cities or specific ones

---

cost

cost: number

Defined in: payload-types.ts:2679

Shipping cost in currency units (e.g., 5.00 for $5)

---

country

country: string | Country

Defined in: payload-types.ts:2635

Select the country this shipping method applies to

---

createdAt

createdAt: string

Defined in: payload-types.ts:2712

---

description?

optional description: string | null

Defined in: payload-types.ts:2631

Optional description of the shipping method

---

estimatedDaysMax

estimatedDaysMax: number

Defined in: payload-types.ts:2687

Maximum delivery days

---

estimatedDaysMin

estimatedDaysMin: number

Defined in: payload-types.ts:2683

Minimum delivery days

---

freeThreshold?

optional freeThreshold: number | null

Defined in: payload-types.ts:2699

Order amount above which shipping is free (leave empty for no free shipping)

---

id

id: string

Defined in: payload-types.ts:2619

---

label

label: string

Defined in: payload-types.ts:2627

Label displayed to customers (e.g., 'Standard - 5-7 days')

---

name

name: string

Defined in: payload-types.ts:2623

e.g., Standard Shipping, Express Delivery

---

salesChannel

salesChannel: string | SalesChannel

Defined in: payload-types.ts:2707

This shipping method will only be available in the selected sales channels.

---

sortOrder?

optional sortOrder: number | null

Defined in: payload-types.ts:2711

Order in which to display shipping options

---

specificCities?

optional specificCities: { active?: boolean | null; city: string; code: string; cost: number; estimatedDaysMax: number; estimatedDaysMin: number; freeThreshold?: number | null; id?: string | null; }[] | null

Defined in: payload-types.ts:2643

Define specific cities for this shipping method

---

taxable?

optional taxable: boolean | null

Defined in: payload-types.ts:2691

Whether this shipping cost is subject to tax

---

taxRate?

optional taxRate: number | null

Defined in: payload-types.ts:2695

Tax rate as percentage (e.g., 8.7 for 8.7%)

---

updatedAt

updatedAt: string

Defined in: payload-types.ts:2713