Files
medusa-store/www/apps/docs/content/references/js-client/classes/internal-8.internal.AdminPostStockLocationsReq.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.8 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

Class: AdminPostStockLocationsReq

internal.internal.AdminPostStockLocationsReq

Schema

AdminPostStockLocationsReq type: object required:

  • name properties: name: description: the name of the stock location type: string address_id: description: the ID of an existing stock location address to associate with the stock location. Only required if address is not provided. type: string metadata: type: object description: An optional key-value map with additional details example: {car: "white"} externalDocs: description: "Learn about the metadata attribute, and how to delete and update it." url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" address: description: A new stock location address to create and associate with the stock location. Only required if address_id is not provided. $ref: "#/components/schemas/StockLocationAddressInput"

Properties

address

Optional address: StockLocationAddress

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:145


address_id

Optional address_id: string

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:146


metadata

Optional metadata: Record<string, unknown>

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:147


name

name: string

Defined in

packages/medusa/dist/api/routes/admin/stock-locations/create-stock-location.d.ts:144