medusa-store/docs/content/references/services/classes/ClaimService.md

Class: ClaimService

Hierarchy

• "medusa-interfaces"

  ↳ ClaimService

Constructors

constructor

• new ClaimService(__namedParameters)

Parameters

Name	Type
__namedParameters	Object

Overrides

BaseService.constructor

Defined in

services/claim.js:14

Properties

addressRepo_

• addressRepo_: any

Defined in

services/claim.js:36

---

claimItemService_

• claimItemService_: any

Defined in

services/claim.js:37

---

claimRepository_

• claimRepository_: any

Defined in

services/claim.js:38

---

eventBus_

• eventBus_: any

Defined in

services/claim.js:39

---

fulfillmentProviderService_

• fulfillmentProviderService_: any

Defined in

services/claim.js:40

---

fulfillmentService_

• fulfillmentService_: any

Defined in

services/claim.js:41

---

inventoryService_

• inventoryService_: any

Defined in

services/claim.js:42

---

lineItemService_

• lineItemService_: any

Defined in

services/claim.js:43

---

paymentProviderService_

• paymentProviderService_: any

Defined in

services/claim.js:44

---

regionService_

• regionService_: any

Defined in

services/claim.js:45

---

returnService_

• returnService_: any

Defined in

services/claim.js:46

---

shippingOptionService_

• shippingOptionService_: any

Defined in

services/claim.js:47

---

taxProviderService_

• taxProviderService_: any

Defined in

services/claim.js:48

---

totalsService_

• totalsService_: any

Defined in

services/claim.js:49

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CANCELED	string
CREATED	string
FULFILLMENT_CREATED	string
REFUND_PROCESSED	string
SHIPMENT_CREATED	string
UPDATED	string

Defined in

services/claim.js:5

Methods

cancel

▸ cancel(id): Promise<any>

Parameters

Name	Type
id	any

Returns

Promise<any>

Defined in

services/claim.js:644

---

cancelFulfillment

▸ cancelFulfillment(fulfillmentId): Promise<any>

Parameters

Name	Type
fulfillmentId	any

Returns

Promise<any>

Defined in

services/claim.js:512

---

create

▸ create(data): any

Creates a Claim on an Order. Claims consists of items that are claimed and optionally items to be sent as replacement for the claimed items. The shipping address that the new items will be shipped to

Parameters

Name	Type	Description
data	any	the object containing all data required to create a claim

Returns

any

created claim

Defined in

services/claim.js:159

---

createFulfillment

▸ createFulfillment(id, config?): Claim

Parameters

Name	Type	Description
id	string	the object containing all data required to create a claim
config	Object	config object
config.metadata	any	config metadata
config.no_notification	undefined | boolean	config no notification

Returns

Claim

created claim

Defined in

services/claim.js:378

---

createShipment

▸ createShipment(id, fulfillmentId, trackingLinks, config?): Promise<any>

Parameters

Name	Type	Default value
id	any	undefined
fulfillmentId	any	undefined
trackingLinks	any	undefined
config	Object	undefined
config.metadata	Object	{}
config.no_notification	undefined	undefined

Returns

Promise<any>

Defined in

services/claim.js:577

---

deleteMetadata

▸ deleteMetadata(orderId, key): Promise<any>

Dedicated method to delete metadata for an order.

Parameters

Name	Type	Description
orderId	string	the order to delete metadata from.
key	string	key for metadata field

Returns

Promise<any>

resolves to the updated result.

Defined in

services/claim.js:734

---

list

▸ list(selector, config?): Promise<any>

Parameters

Name	Type	Description
selector	any	the query object for find
config	any	the config object containing query settings

Returns

Promise<any>

the result of the find operation

Defined in

services/claim.js:696

---

processRefund

▸ processRefund(id): Promise<any>

Parameters

Name	Type
id	any

Returns

Promise<any>

Defined in

services/claim.js:535

---

retrieve

▸ retrieve(claimId, config?): Promise<Order>

Gets an order by id.

Parameters

Name	Type	Description
claimId	string	id of order to retrieve
config	any	the config object containing query settings

Returns

Promise<Order>

the order document

Defined in

services/claim.js:711

---

update

▸ update(id, data): any

Parameters

Name	Type
id	any
data	any

Returns

any

Defined in

services/claim.js:80

---

withTransaction

▸ withTransaction(manager): ClaimService

Parameters

Name	Type
manager	any

Returns

ClaimService

Defined in

services/claim.js:52