medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingOptionsOptionReq.md

displayed_sidebar

displayed_sidebar
jsClientSidebar

Class: AdminPostShippingOptionsOptionReq

internal.internal.AdminPostShippingOptionsOptionReq

Schema

AdminPostShippingOptionsOptionReq type: object required:

• requirements properties: name: description: "The name of the Shipping Option" type: string amount: description: "The amount to charge for the Shipping Option. If the price_type of the shipping option is calculated, this amount will not actually be used." type: integer admin_only: description: If set to true, the shipping option can only be used when creating draft orders. type: boolean metadata: description: "An optional set of key-value pairs with additional information." type: object externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" requirements: description: "The requirements that must be satisfied for the Shipping Option to be available." type: array items: type: object required: - type - amount properties: id: description: The ID of an existing requirement. If an ID is passed, the existing requirement's details are updated. Otherwise, a new requirement is created. type: string type: description: The type of the requirement type: string enum: - max_subtotal - min_subtotal amount: description: The amount to compare with. type: integer includes_tax: description: "Tax included in prices of shipping option" x-featureFlag: "tax_inclusive_pricing" type: boolean

Properties

admin_only

• Optional admin_only: boolean

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:134

---

amount

• Optional amount: number

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:132

---

includes_tax

• Optional includes_tax: boolean

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:136

---

metadata

• Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:135

---

name

• name: string

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:131

---

requirements

• requirements: OptionRequirement[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-options/update-shipping-option.d.ts:133