31 lines
982 B
YAML
31 lines
982 B
YAML
type: object
|
|
description: The updates to make on a changed shipping method.
|
|
x-schemaName: AdminUpdateDraftOrderActionShippingMethod
|
|
required:
|
|
- shipping_option_id
|
|
properties:
|
|
shipping_option_id:
|
|
type: string
|
|
title: shipping_option_id
|
|
description: The ID of the associated shipping option.
|
|
custom_amount:
|
|
type: number
|
|
title: custom_amount
|
|
description: >-
|
|
The custom amount of the shipping method. If not provided, the shipping
|
|
option's amount will be used.
|
|
description:
|
|
type: string
|
|
title: description
|
|
description: The shipping method's description.
|
|
internal_note:
|
|
type: string
|
|
title: internal_note
|
|
description: A note viewed only by admin users about the shipping method.
|
|
metadata:
|
|
type: object
|
|
description: The shipping method's metadata, can hold custom key-value pairs.
|
|
externalDocs:
|
|
url: https://docs.medusajs.com/api/admin#manage-metadata
|
|
description: Learn how to manage metadata
|