Class ReturnsManager

Hierarchy (View Summary)

BaseManager
- ReturnsManager

Index

Constructors

Properties

Methods

acceptOffer cancelDispute confirm convertImage dispute getAvailableSolutions getReturnDetail getReturnDisputeReason getReturnList getReverseTrackingInfo getShippingCarrier offer queryProof uploadProof uploadShippingProof

Constructors

constructor

new ReturnsManager(config: ShopeeConfig): ReturnsManager
Parameters
- config: ShopeeConfig
Returns ReturnsManager
Overrides BaseManager.constructor
- Defined in src/managers/returns.manager.ts:39

Properties

`Protected`config

config: ShopeeConfig

Methods

acceptOffer

acceptOffer(params?: AcceptOfferRequest): Promise<AcceptOfferResponse>
v2.returns.accept_offer
Parameters
- Optionalparams: AcceptOfferRequest
  Request parameters
Returns Promise<AcceptOfferResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:48

cancelDispute

cancelDispute(params?: CancelDisputeRequest): Promise<CancelDisputeResponse>
Sellers can only cancel compensation disputes, not normal disputes. This means that sellers can only cancel disputes when the return_status is ACCEPTED and the compensation_status is COMPENSATION_REQUESTED.
Parameters
- Optionalparams: CancelDisputeRequest
  Request parameters
Returns Promise<CancelDisputeResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:61

confirm

confirm(params?: ConfirmRequest): Promise<ConfirmResponse>
Confirm refund
Parameters
- Optionalparams: ConfirmRequest
  Request parameters
Returns Promise<ConfirmResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:74

convertImage

convertImage(params?: ConvertImageRequest): Promise<ConvertImageResponse>
Convert a specific format and pictures within 10M into url.
Parameters
- Optionalparams: ConvertImageRequest
  Request parameters
Returns Promise<ConvertImageResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:87

dispute

dispute(params?: DisputeRequest): Promise<DisputeResponse>
Dispute return.

Support to raise dispute when return_status in REQUESTED / PROCESSING/ACCEPTED
Parameters
- Optionalparams: DisputeRequest
  Request parameters
Returns Promise<DisputeResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:102

getAvailableSolutions

getAvailableSolutions(
params?: GetAvailableSolutionsRequest,
): Promise<GetAvailableSolutionsResponse>
Get the available solutions offered to buyers.
Parameters
- Optionalparams: GetAvailableSolutionsRequest
  Request parameters
Returns Promise<GetAvailableSolutionsResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:115

getReturnDetail

getReturnDetail(
params?: GetReturnDetailRequest,
): Promise<GetReturnDetailResponse>
Use this api to get detail information of a return by return sn.
Parameters
- Optionalparams: GetReturnDetailRequest
  Request parameters
Returns Promise<GetReturnDetailResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:134

getReturnDisputeReason

getReturnDisputeReason(
params?: GetReturnDisputeReasonRequest,
): Promise<GetReturnDisputeReasonResponse>
To get the dispute return reason.
Parameters
- Optionalparams: GetReturnDisputeReasonRequest
  Request parameters
Returns Promise<GetReturnDisputeReasonResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:157

getReturnList

getReturnList(params?: GetReturnListRequest): Promise<GetReturnListResponse>
Use this api to get detail information of many return by shop id.
Parameters
- Optionalparams: GetReturnListRequest
  Request parameters
Returns Promise<GetReturnListResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:176

getReverseTrackingInfo

getReverseTrackingInfo(
params?: GetReverseTrackingInfoRequest,
): Promise<GetReverseTrackingInfoResponse>
Get reverse and post-return logistics information of return request. For Normal RR, return complete reverse logistics information, for In-transit RR and Return-on-the-Spot, only return latest reverse logistics status, without providing complete reverse logistics information. For seller_validation, only one segment of reverse (buyer to seller), use tracking_info, for warehouse_validation, two segment of reverse (buyer to warehouse and warehouse to seller), use post_return_logistics_tracking_info.
Parameters
- Optionalparams: GetReverseTrackingInfoRequest
  Request parameters
Returns Promise<GetReverseTrackingInfoResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:200

getShippingCarrier

getShippingCarrier(
params?: GetShippingCarrierRequest,
): Promise<GetShippingCarrierResponse>
Use this API to get the list of shipping carriers and request parameters needed before calling v2.returns.upload_shipping_proof. Only for TW and BR returns with is_seller_arrange = true.
Parameters
- Optionalparams: GetShippingCarrierRequest
  Request parameters
Returns Promise<GetShippingCarrierResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:227

offer

offer(params?: OfferRequest): Promise<OfferResponse>
v2.returns.offer
Parameters
- Optionalparams: OfferRequest
  Request parameters
Returns Promise<OfferResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:246

queryProof

queryProof(params?: QueryProofRequest): Promise<QueryProofResponse>
Support sellers to query the evidence uploaded through the upload evidence API.
Parameters
- Optionalparams: QueryProofRequest
  Request parameters
Returns Promise<QueryProofResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:259

uploadProof

uploadProof(params?: UploadProofRequest): Promise<UploadProofResponse>
Support sellers to upload evidence, including text and pictures and videos converted into URLs.
Parameters
- Optionalparams: UploadProofRequest
  Request parameters
Returns Promise<UploadProofResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:272

uploadShippingProof

uploadShippingProof(
params?: UploadShippingProofRequest,
): Promise<UploadShippingProofResponse>
Use this API to upload shipping proof (Only for TW and BR returns with is_seller_arrange = true). This is not to upload evidence for disputes.
Parameters
- Optionalparams: UploadShippingProofRequest
  Request parameters
Returns Promise<UploadShippingProofResponse>
Promise resolving to the response
- Defined in src/managers/returns.manager.ts:285

Class ReturnsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ReturnsManager

Properties

Protectedconfig

Methods

acceptOffer

Parameters

Returns Promise<AcceptOfferResponse>

cancelDispute

Parameters

Returns Promise<CancelDisputeResponse>

confirm

Parameters

Returns Promise<ConfirmResponse>

convertImage

Parameters

Returns Promise<ConvertImageResponse>

dispute

Parameters

Returns Promise<DisputeResponse>

getAvailableSolutions

Parameters

Returns Promise<GetAvailableSolutionsResponse>

getReturnDetail

Parameters

Returns Promise<GetReturnDetailResponse>

getReturnDisputeReason

Parameters

Returns Promise<GetReturnDisputeReasonResponse>

getReturnList

Parameters

Returns Promise<GetReturnListResponse>

getReverseTrackingInfo

Parameters

Returns Promise<GetReverseTrackingInfoResponse>

getShippingCarrier

Parameters

Returns Promise<GetShippingCarrierResponse>

offer

Parameters

Returns Promise<OfferResponse>

queryProof

Parameters

Returns Promise<QueryProofResponse>

uploadProof

Parameters

Returns Promise<UploadProofResponse>

uploadShippingProof

Parameters

Returns Promise<UploadShippingProofResponse>

Settings

On This Page

`Protected`config