Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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."
Optionalparams: DownloadFbsInvoicesRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This endpoint only for PH and BR local seller. Seller can download the invoice uploaded before through this endpoint.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Optionalparams: GenerateFbsInvoicesRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get booking detail.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to search bookings. You may also filter them by status, if needed.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
API to obtain buyer submitted invoice info for VN, TH and PH local sellers only.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Returns the estimated refund value for a partial order cancellation given the specified items to cancel.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This API allows you to consult the status of a previously requested batch download for FBS tax documents.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get order detail.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to search orders. You may also filter them by status, if needed.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get package detail.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to get order list which order_status is READY_TO_SHIP or RETRY_SHIP to start process the whole shipping progress.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Optionalparams: GetWarehouseFilterConfigRequest
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to handle buyer's cancellation application.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this API to approve or reject a prescription
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to set note for an order.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to split an order into multiple packages. Orders that include installation services cannot be split by quantity.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
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.
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
This endpoint is for PH and BR local seller. Upload the invoice document
Request parameters
Optionaloptions: RequestOptions
Per-call options such as signal, timeout_ms and retry
Promise resolving to the response
Use this api to cancel an order. This action can only be performed before the order has been shipped.