Class: CartsResource
Hierarchy
defaultCopy to Clipboard↳
CartsResourceCopy to Clipboard
Properties
lineItems
• lineItems: LineItemsResourceCopy to Clipboard
Defined in
medusa-js/src/resources/carts.ts:15
Methods
addShippingMethod
▸ addShippingMethod(cart_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Adds a shipping method to cart
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | Id of cart |
payloadCopy to Clipboard | StorePostCartsCartShippingMethodReqCopy to Clipboard | Containg id of shipping option and optional data |
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/carts.ts:24
complete
▸ complete(cart_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCompleteCartResCopy to Clipboard>
Completes a cart. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. If payment is authorized and order is not yet created, we make sure to do so. The completion of a cart can be performed idempotently with a provided header Idempotency-Key. If not provuided, we will generate one for the request.
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCompleteCartResCopy to Clipboard>
Defined in
medusa-js/src/resources/carts.ts:43
create
▸ create(payload?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Creates a cart
Parameters
| Name | Type | Description |
|---|---|---|
payload?Copy to Clipboard | StorePostCartReqCopy to Clipboard | is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty |
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/carts.ts:58
createPaymentSessions
▸ createPaymentSessions(cart_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Creates payment sessions. Initializes the payment sessions that can be used to pay for the items of the cart. This is usually called when a customer proceeds to checkout.
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
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/carts.ts:74
deleteDiscount
▸ deleteDiscount(cart_idCopy to Clipboard, codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Removes a discount from cart.
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
codeCopy to Clipboard | stringCopy to Clipboard | discount code 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/carts.ts:89
deletePaymentSession
▸ deletePaymentSession(cart_idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Removes a payment session from a cart. Can be useful in case a payment has failed
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
provider_idCopy to Clipboard | stringCopy to Clipboard | the provider id of the session e.g. "stripe" |
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/carts.ts:106
refreshPaymentSession
▸ refreshPaymentSession(cart_idCopy to Clipboard, provider_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Refreshes a payment session.
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
provider_idCopy to Clipboard | stringCopy to Clipboard | the provider id of the session e.g. "stripe" |
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/carts.ts:122
retrieve
▸ retrieve(cart_idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Retrieves a cart
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
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/carts.ts:137
setPaymentSession
▸ setPaymentSession(cart_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Refreshes a payment session.
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
payloadCopy to Clipboard | StorePostCartsCartPaymentSessionReqCopy to Clipboard | the provider id of the session e.g. "stripe" |
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/carts.ts:152
update
▸ update(cart_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Updates a cart
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
payloadCopy to Clipboard | StorePostCartsCartReqCopy to Clipboard | is required and can contain region_id, email, billing and shipping address |
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/carts.ts:168
updatePaymentSession
▸ updatePaymentSession(cart_idCopy to Clipboard, provider_idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>
Updates the payment method
Parameters
| Name | Type | Description |
|---|---|---|
cart_idCopy to Clipboard | stringCopy to Clipboard | is required |
provider_idCopy to Clipboard | stringCopy to Clipboard | is required |
payloadCopy to Clipboard | StorePostCartsCartPaymentSessionUpdateReqCopy to Clipboard | is required |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<StoreCartsResCopy to Clipboard>