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.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/order/generate_fbs_invoices
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
Request Parameters
| 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 |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | int32 | Indicate error type if hit error. Empty if no error happened. | |
| 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.