Files
medusa-store/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml
Shahed Nasser 7d650771d1 docs: generate medusa-react reference (#6004)
* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
2024-01-05 17:03:38 +02:00

27 lines
814 B
YAML

type: object
description: The detail to update of the shipping profile.
properties:
name:
description: The name of the Shipping Profile
type: string
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
type:
description: The type of the Shipping Profile
type: string
enum:
- default
- gift_card
- custom
products:
description: product IDs to associate with the Shipping Profile
type: array
shipping_options:
description: Shipping option IDs to associate with the Shipping Profile
type: array