154 lines
4.6 KiB
TypeScript
154 lines
4.6 KiB
TypeScript
/**
|
|
* @oas [post] /admin/inventory-items
|
|
* operationId: PostInventoryItems
|
|
* summary: Create Inventory Item
|
|
* description: Create a inventory item.
|
|
* x-authenticated: true
|
|
* parameters:
|
|
* - name: expand
|
|
* in: query
|
|
* description: Comma-separated relations that should be expanded in the returned data.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: expand
|
|
* description: Comma-separated relations that should be expanded in the returned data.
|
|
* - name: fields
|
|
* in: query
|
|
* description: Comma-separated fields that should be included in the returned data.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: fields
|
|
* description: Comma-separated fields that should be included in the returned data.
|
|
* - name: offset
|
|
* in: query
|
|
* description: The number of items to skip when retrieving a list.
|
|
* required: false
|
|
* schema:
|
|
* type: number
|
|
* title: offset
|
|
* description: The number of items to skip when retrieving a list.
|
|
* - name: limit
|
|
* in: query
|
|
* description: Limit the number of items returned in the list.
|
|
* required: false
|
|
* schema:
|
|
* type: number
|
|
* title: limit
|
|
* description: Limit the number of items returned in the list.
|
|
* - name: order
|
|
* in: query
|
|
* description: Field to sort items in the list by.
|
|
* required: false
|
|
* schema:
|
|
* type: string
|
|
* title: order
|
|
* description: Field to sort items in the list by.
|
|
* security:
|
|
* - api_token: []
|
|
* - cookie_auth: []
|
|
* - jwt_token: []
|
|
* requestBody:
|
|
* content:
|
|
* application/json:
|
|
* schema:
|
|
* type: object
|
|
* description: SUMMARY
|
|
* properties:
|
|
* sku:
|
|
* type: string
|
|
* title: sku
|
|
* description: The inventory item's sku.
|
|
* hs_code:
|
|
* type: string
|
|
* title: hs_code
|
|
* description: The inventory item's hs code.
|
|
* weight:
|
|
* type: number
|
|
* title: weight
|
|
* description: The inventory item's weight.
|
|
* length:
|
|
* type: number
|
|
* title: length
|
|
* description: The inventory item's length.
|
|
* height:
|
|
* type: number
|
|
* title: height
|
|
* description: The inventory item's height.
|
|
* width:
|
|
* type: number
|
|
* title: width
|
|
* description: The inventory item's width.
|
|
* origin_country:
|
|
* type: string
|
|
* title: origin_country
|
|
* description: The inventory item's origin country.
|
|
* mid_code:
|
|
* type: string
|
|
* title: mid_code
|
|
* description: The inventory item's mid code.
|
|
* material:
|
|
* type: string
|
|
* title: material
|
|
* description: The inventory item's material.
|
|
* title:
|
|
* type: string
|
|
* title: title
|
|
* description: The inventory item's title.
|
|
* description:
|
|
* type: string
|
|
* title: description
|
|
* description: The inventory item's description.
|
|
* thumbnail:
|
|
* type: string
|
|
* title: thumbnail
|
|
* description: The inventory item's thumbnail.
|
|
* metadata:
|
|
* type: object
|
|
* description: The inventory item's metadata.
|
|
* properties: {}
|
|
* requires_shipping:
|
|
* type: boolean
|
|
* title: requires_shipping
|
|
* description: The inventory item's requires shipping.
|
|
* required:
|
|
* - sku
|
|
* - hs_code
|
|
* - weight
|
|
* - length
|
|
* - height
|
|
* - width
|
|
* - origin_country
|
|
* - mid_code
|
|
* - material
|
|
* - title
|
|
* - description
|
|
* - requires_shipping
|
|
* - thumbnail
|
|
* - metadata
|
|
* x-codeSamples:
|
|
* - lang: Shell
|
|
* label: cURL
|
|
* source: |-
|
|
* curl -X POST '{backend_url}/admin/inventory-items' \
|
|
* -H 'x-medusa-access-token: {api_token}'
|
|
* tags:
|
|
* - Inventory Items
|
|
* responses:
|
|
* "400":
|
|
* $ref: "#/components/responses/400_error"
|
|
* "401":
|
|
* $ref: "#/components/responses/unauthorized"
|
|
* "404":
|
|
* $ref: "#/components/responses/not_found_error"
|
|
* "409":
|
|
* $ref: "#/components/responses/invalid_state_error"
|
|
* "422":
|
|
* $ref: "#/components/responses/invalid_request_error"
|
|
* "500":
|
|
* $ref: "#/components/responses/500_error"
|
|
*
|
|
*/
|
|
|