v2.order.generate_fbs_invoices
POST /api/v2/order/generate_fbs_invoices
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.
Đường dẫn Endpoint
URL: https://partner.shopeemobile.com/api/v2/order/generate_fbs_invoices
Tham số chung
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID được gán khi đăng ký thành công. Bắt buộc cho tất cả các yêu cầu. |
| timestamp | timestamp | 1610000000 | Dùng để chỉ định thời điểm gửi yêu cầu. Bắt buộc cho tất cả các yêu cầu. Hết hạn sau 5 phút. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | Token dùng để truy cập API, xác định quyền của bạn. Có thể dùng nhiều lần và hết hạn sau 4 giờ. |
| shop_id | int | 600000 | Mã định danh duy nhất của Shopee cho một cửa hàng. Tham số bắt buộc cho hầu hết các API. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Chữ ký được tạo từ partner_id, đường dẫn api, timestamp, access_token, shop_id và partner_key qua thuật toán HMAC-SHA256. Chi tiết: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Tham số Request
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| batch_download | object | False | ||
| start | int64 | True | 20250601 | Format YYYYMMDD e.g. 20240101 |
| end | int64 | True | 20250601 | Format YYYYMMDD e.g. 20240101 |
| document_type | int32 | True | 1 | 1 = Remessa 2 = Return 3 = Symbolic Return 4 = Sale 5 = Entrada 6 = Symbolic Remessa 7 = all |
| file_type | int32 | True | 1 = xml only 2 = pdf only 3 = both | |
| document_status | int32 | False | 1= authorized only 2= cancelled Default: If document_status not passed or passed empty, means documents under ALL status (both authorized and cancelled) must be included |
Tham số Response
| Name | Type | Sample | Description |
|---|---|---|---|
| error | int32 | Cho biết loại lỗi nếu xảy ra. Trống nếu không có lỗi. | |
| error_msg | string | Error messages | |
| result_list | object[] | ||
| request_id | int64 | Unique task identifier that includes one or more tax documents to be downloaded according to the filters sent in the request. | |
| fail_error | string | Indicate error type if one element hit error. Empty if no error happened. | |
| fail_message | string | Indicate error details if one element hit error. Empty if no error happened. |
No Request Example Set.
No Response Example Set.