asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
5dee25e5eef76fb2e8cc02e280d633fa71d4325e
medusa-store/www/apps/docs/content/references/js-client/classes/CartsResource.md
Shahed Nasser fa7c94b4cc docs: create docs workspace (#5174) 
* docs: migrate ui docs to docs universe

* created yarn workspace

* added eslint and tsconfig configurations

* fix eslint configurations

* fixed eslint configurations

* shared tailwind configurations

* added shared ui package

* added more shared components

* migrating more components

* made details components shared

* move InlineCode component

* moved InputText

* moved Loading component

* Moved Modal component

* moved Select components

* Moved Tooltip component

* moved Search components

* moved ColorMode provider

* Moved Notification components and providers

* used icons package

* use UI colors in api-reference

* moved Navbar component

* used Navbar and Search in UI docs

* added Feedback to UI docs

* general enhancements

* fix color mode

* added copy colors file from ui-preset

* added features and enhancements to UI docs

* move Sidebar component and provider

* general fixes and preparations for deployment

* update docusaurus version

* adjusted versions

* fix output directory

* remove rootDirectory property

* fix yarn.lock

* moved code component

* added vale for all docs MD and MDX

* fix tests

* fix vale error

* fix deployment errors

* change ignore commands

* add output directory

* fix docs test

* general fixes

* content fixes

* fix announcement script

* added changeset

* fix vale checks

* added nofilter option

* fix vale error
2023-09-21 20:57:15 +03:00

9.3 KiB
Raw Blame History

Class: CartsResource

Hierarchy

  • default

    ↳ CartsResource

Properties

lineItems

• lineItems: LineItemsResource

Defined in

medusa-js/src/resources/carts.ts:15

Methods

addShippingMethod

▸ addShippingMethod(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Adds a shipping method to cart

Parameters

Name Type Description
cart_id string Id of cart
payload StorePostCartsCartShippingMethodReq Containg id of shipping option and optional data
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:24

complete

▸ complete(cart_id, customHeaders?): ResponsePromise<StoreCompleteCartRes>

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_id string is required
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCompleteCartRes>

Defined in

medusa-js/src/resources/carts.ts:43

create

▸ create(payload?, customHeaders?): ResponsePromise<StoreCartsRes>

Creates a cart

Parameters

Name Type Description
payload? StorePostCartReq is optional and can contain a region_id and items. The cart will contain the payload, if provided. Otherwise it will be empty
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:58

createPaymentSessions

▸ createPaymentSessions(cart_id, customHeaders?): ResponsePromise<StoreCartsRes>

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_id string is required
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:74

deleteDiscount

▸ deleteDiscount(cart_id, code, customHeaders?): ResponsePromise<StoreCartsRes>

Removes a discount from cart.

Parameters

Name Type Description
cart_id string is required
code string discount code to remove
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:89

deletePaymentSession

▸ deletePaymentSession(cart_id, provider_id, customHeaders?): ResponsePromise<StoreCartsRes>

Removes a payment session from a cart. Can be useful in case a payment has failed

Parameters

Name Type Description
cart_id string is required
provider_id string the provider id of the session e.g. "stripe"
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:106

refreshPaymentSession

▸ refreshPaymentSession(cart_id, provider_id, customHeaders?): ResponsePromise<StoreCartsRes>

Refreshes a payment session.

Parameters

Name Type Description
cart_id string is required
provider_id string the provider id of the session e.g. "stripe"
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:122

retrieve

▸ retrieve(cart_id, customHeaders?): ResponsePromise<StoreCartsRes>

Retrieves a cart

Parameters

Name Type Description
cart_id string is required
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:137

setPaymentSession

▸ setPaymentSession(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Refreshes a payment session.

Parameters

Name Type Description
cart_id string is required
payload StorePostCartsCartPaymentSessionReq the provider id of the session e.g. "stripe"
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:152

update

▸ update(cart_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Updates a cart

Parameters

Name Type Description
cart_id string is required
payload StorePostCartsCartReq is required and can contain region_id, email, billing and shipping address
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:168

updatePaymentSession

▸ updatePaymentSession(cart_id, provider_id, payload, customHeaders?): ResponsePromise<StoreCartsRes>

Updates the payment method

Parameters

Name Type Description
cart_id string is required
provider_id string is required
payload StorePostCartsCartPaymentSessionUpdateReq is required
customHeaders Record<string, any>

Returns

ResponsePromise<StoreCartsRes>

Defined in

medusa-js/src/resources/carts.ts:185

Reference in New Issue View Git Blame Copy Permalink