Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostShippingProfilesProfileReq.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

1.9 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPostShippingProfilesProfileReq

internal.internal.AdminPostShippingProfilesProfileReq

Schema

AdminPostShippingProfilesProfileReq type: object 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

Properties

metadata

Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:92


name

Optional name: string

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:91


products

Optional products: string[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:94


shipping_options

Optional shipping_options: string[]

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:95


type

Optional type: ShippingProfileType

Defined in

packages/medusa/dist/api/routes/admin/shipping-profiles/update-shipping-profile.d.ts:93