Class: LineItemsResource
Hierarchy
defaultCopy to Clipboard↳
LineItemsResourceCopy to Clipboard
Methods
create
▸ create(cart_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Creates a line-item for a cart
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | id of cart |
payloadCopy to Clipboard | StorePostCartsCartLineItemsReqCopy to Clipboard | details needed to create a line-item |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Defined in
medusa-js/src/resources/line-items.ts:17
delete
▸ delete(cart_idCopy to Clipboard, line_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Remove a line-item from a cart
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | id of cart |
line_idCopy to Clipboard | stringCopy to Clipboard | id of item to remove |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Defined in
medusa-js/src/resources/line-items.ts:50
update
▸ update(cart_idCopy to Clipboard, line_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Updates a line-item. Only quantity updates are allowed
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | id of cart |
line_idCopy to Clipboard | stringCopy to Clipboard | id of item to update |
payloadCopy to Clipboard | StorePostCartsCartLineItemsItemReqCopy to Clipboard | details needed to update a line-item |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>