Class OrderManager

Hierarchy (View Summary)

BaseManager
- OrderManager

Constructors

constructor

new OrderManager(config: ShopeeConfig): OrderManager
Parameters
- config: ShopeeConfig
Returns OrderManager
Overrides BaseManager.constructor
- Defined in src/managers/order.manager.ts:53

Properties

`Protected`config

config: ShopeeConfig

Methods

cancelOrder

cancelOrder(params?: CancelOrderRequest): Promise<CancelOrderResponse>
Use this api to cancel an order. This action can only be performed before the order has been shipped.
Parameters
- Optionalparams: CancelOrderRequest
  Request parameters
Returns Promise<CancelOrderResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:62

downloadFbsInvoices

downloadFbsInvoices(
params?: DownloadFbsInvoicesRequest,
): Promise<DownloadFbsInvoicesResponse>
This API allows you to download FBS invoices. To use this API, the client must first call v2.order.generate_fbs_invoices to create a new shipping document task, followed by calling v2.order.get_fbs_invoices_result to check the task status. The document can only be downloaded once the task status is "READY."
Parameters
- Optionalparams: DownloadFbsInvoicesRequest
  Request parameters
Returns Promise<DownloadFbsInvoicesResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:76

downloadInvoiceDoc

downloadInvoiceDoc(
params?: DownloadInvoiceDocRequest,
): Promise<DownloadInvoiceDocResponse>
This endpoint only for PH and BR local seller. Seller can download the invoice uploaded before through this endpoint.
Parameters
- Optionalparams: DownloadInvoiceDocRequest
  Request parameters
Returns Promise<DownloadInvoiceDocResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:96

generateFbsInvoices

generateFbsInvoices(
params?: GenerateFbsInvoicesRequest,
): Promise<GenerateFbsInvoicesResponse>
This API creates a task to download a specific tax document (e.g., sales invoice, remessa invoice) for the seller's account, available only after the document is issued by the system as part of the Fulfilled by Shopee (FBS) process. The workflow is as follows: (1) v2.order.generate_fbs_invoices; (2) v2.order.get_fbs_invoices_result; (3) v2.order.download_fbs_invoices. Please note: The download link for the document will expire 30 minutes after being generated.
Parameters
- Optionalparams: GenerateFbsInvoicesRequest
  Request parameters
Returns Promise<GenerateFbsInvoicesResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:117

getBookingDetail

getBookingDetail(
params?: GetBookingDetailRequest,
): Promise<GetBookingDetailResponse>
Use this api to get booking detail.
Parameters
- Optionalparams: GetBookingDetailRequest
  Request parameters
Returns Promise<GetBookingDetailResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:136

getBookingList

getBookingList(params?: GetBookingListRequest): Promise<GetBookingListResponse>
Use this api to search bookings. You may also filter them by status, if needed.
Parameters
- Optionalparams: GetBookingListRequest
  Request parameters
Returns Promise<GetBookingListResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:156

getBuyerInvoiceInfo

getBuyerInvoiceInfo(
params?: GetBuyerInvoiceInfoRequest,
): Promise<GetBuyerInvoiceInfoResponse>
API to obtain buyer submitted invoice info for VN, TH and PH local sellers only.
Parameters
- Optionalparams: GetBuyerInvoiceInfoRequest
  Request parameters
Returns Promise<GetBuyerInvoiceInfoResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:169

getEstimateCancelValue

getEstimateCancelValue(
params?: GetEstimateCancelValueRequest,
): Promise<GetEstimateCancelValueResponse>
Returns the estimated refund value for a partial order cancellation given the specified items to cancel.
Parameters
- Optionalparams: GetEstimateCancelValueRequest
  Request parameters
Returns Promise<GetEstimateCancelValueResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:188

getFbsInvoicesResult

getFbsInvoicesResult(
params?: GetFbsInvoicesResultRequest,
): Promise<GetFbsInvoicesResultResponse>
This API allows you to consult the status of a previously requested batch download for FBS tax documents.
Parameters
- Optionalparams: GetFbsInvoicesResultRequest
  Request parameters
Returns Promise<GetFbsInvoicesResultResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:207

getOrderDetail

getOrderDetail(params?: GetOrderDetailRequest): Promise<GetOrderDetailResponse>
Use this api to get order detail.
Parameters
- Optionalparams: GetOrderDetailRequest
  Request parameters
Returns Promise<GetOrderDetailResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:226

getOrderList

getOrderList(params?: GetOrderListRequest): Promise<GetOrderListResponse>
Use this api to search orders. You may also filter them by status, if needed.
Parameters
- Optionalparams: GetOrderListRequest
  Request parameters
Returns Promise<GetOrderListResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:253

getPackageDetail

getPackageDetail(
params?: GetPackageDetailRequest,
): Promise<GetPackageDetailResponse>
Use this api to get package detail.
Parameters
- Optionalparams: GetPackageDetailRequest
  Request parameters
Returns Promise<GetPackageDetailResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:267

getPendingBuyerInvoiceOrderList

getPendingBuyerInvoiceOrderList(
params?: GetPendingBuyerInvoiceOrderListRequest,
): Promise<GetPendingBuyerInvoiceOrderListResponse>
This endpoint only for PH and BR local sellers only. This API is used for seller to retrieve a list of order IDs that are pending invoice upload.
Parameters
- Optionalparams: GetPendingBuyerInvoiceOrderListRequest
  Request parameters
Returns Promise<GetPendingBuyerInvoiceOrderListResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:288

getShipmentList

getShipmentList(
params?: GetShipmentListRequest,
): Promise<GetShipmentListResponse>
Use this api to get order list which order_status is READY_TO_SHIP or RETRY_SHIP to start process the whole shipping progress.
Parameters
- Optionalparams: GetShipmentListRequest
  Request parameters
Returns Promise<GetShipmentListResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:307

getWarehouseFilterConfig

getWarehouseFilterConfig(
params?: GetWarehouseFilterConfigRequest,
): Promise<GetWarehouseFilterConfigResponse>
For multi-warehouse shops, return all warehouses with packages that have not been SHIPPED including product_location_id and address_id. Compared to v2.shop.get_warehouse_detail, it covers some edge cases like warehouse that have been unlinked but still retain packages that have not been SHIPPED, and does not cover some cases like single warehouse with default product_location_id and FBS shop.
Parameters
- Optionalparams: GetWarehouseFilterConfigRequest
  Request parameters
Returns Promise<GetWarehouseFilterConfigResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:320

handleBuyerCancellation

handleBuyerCancellation(
params?: HandleBuyerCancellationRequest,
): Promise<HandleBuyerCancellationResponse>
Use this api to handle buyer's cancellation application.
Parameters
- Optionalparams: HandleBuyerCancellationRequest
  Request parameters
Returns Promise<HandleBuyerCancellationResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:339

handlePrescriptionCheck

handlePrescriptionCheck(
params?: HandlePrescriptionCheckRequest,
): Promise<HandlePrescriptionCheckResponse>
Use this API to approve or reject a prescription
Parameters
- Optionalparams: HandlePrescriptionCheckRequest
  Request parameters
Returns Promise<HandlePrescriptionCheckResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:359

searchPackageList

searchPackageList(
params?: SearchPackageListRequest,
): Promise<SearchPackageListResponse>
Use this API to search the list of packages that have not been SHIPPED to proceed arranging shipment, and it supports various filters and sort fields.
Parameters
- Optionalparams: SearchPackageListRequest
  Request parameters
Returns Promise<SearchPackageListResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:378

setNote

setNote(params?: SetNoteRequest): Promise<SetNoteResponse>
Use this api to set note for an order.
Parameters
- Optionalparams: SetNoteRequest
  Request parameters
Returns Promise<SetNoteResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:393

splitOrder

splitOrder(params?: SplitOrderRequest): Promise<SplitOrderResponse>
Use this api to split an order into multiple packages. Orders that include installation services cannot be split by quantity.
Parameters
- Optionalparams: SplitOrderRequest
  Request parameters
Returns Promise<SplitOrderResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:406

unsplitOrder

unsplitOrder(params?: UnsplitOrderRequest): Promise<UnsplitOrderResponse>
Use this ai to undo split of order. After undo split, the order will have only one package. It can only be used when order status still at READY_TO_SHIP.
Parameters
- Optionalparams: UnsplitOrderRequest
  Request parameters
Returns Promise<UnsplitOrderResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:419

uploadInvoiceDoc

uploadInvoiceDoc(
params?: UploadInvoiceDocRequest,
): Promise<UploadInvoiceDocResponse>
This endpoint is for PH and BR local seller. Upload the invoice document
Parameters
- Optionalparams: UploadInvoiceDocRequest
  Request parameters
Returns Promise<UploadInvoiceDocResponse>
Promise resolving to the response
- Defined in src/managers/order.manager.ts:432

Class OrderManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OrderManager

Properties

Protectedconfig

Methods

cancelOrder

Parameters

Returns Promise<CancelOrderResponse>

downloadFbsInvoices

Parameters

Returns Promise<DownloadFbsInvoicesResponse>

downloadInvoiceDoc

Parameters

Returns Promise<DownloadInvoiceDocResponse>

generateFbsInvoices

Parameters

Returns Promise<GenerateFbsInvoicesResponse>

getBookingDetail

Parameters

Returns Promise<GetBookingDetailResponse>

getBookingList

Parameters

Returns Promise<GetBookingListResponse>

getBuyerInvoiceInfo

Parameters

Returns Promise<GetBuyerInvoiceInfoResponse>

getEstimateCancelValue

Parameters

Returns Promise<GetEstimateCancelValueResponse>

getFbsInvoicesResult

Parameters

Returns Promise<GetFbsInvoicesResultResponse>

getOrderDetail

Parameters

Returns Promise<GetOrderDetailResponse>

getOrderList

Parameters

Returns Promise<GetOrderListResponse>

getPackageDetail

Parameters

Returns Promise<GetPackageDetailResponse>

getPendingBuyerInvoiceOrderList

Parameters

Returns Promise<GetPendingBuyerInvoiceOrderListResponse>

getShipmentList

Parameters

Returns Promise<GetShipmentListResponse>

getWarehouseFilterConfig

Parameters

Returns Promise<GetWarehouseFilterConfigResponse>

handleBuyerCancellation

Parameters

Returns Promise<HandleBuyerCancellationResponse>

handlePrescriptionCheck

Parameters

Returns Promise<HandlePrescriptionCheckResponse>

searchPackageList

Parameters

Returns Promise<SearchPackageListResponse>

setNote

Parameters

Returns Promise<SetNoteResponse>

splitOrder

Parameters

Returns Promise<SplitOrderResponse>

unsplitOrder

Parameters

Returns Promise<UnsplitOrderResponse>

uploadInvoiceDoc

Parameters

Returns Promise<UploadInvoiceDocResponse>

Settings

`Protected`config