Skip to main content

POST Upload Invoice

Upload Invoice Shop Required scope: seller.fulfillment.basic Upload the invoice document. Note: Applicable only for local sellers in the Brazil market. Version 202502

POST/fulfillment/202502/invoice/upload

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

PropertiesTypeDescription
invoices[]objectThe list of invoices to upload.

Example

CurlGoNode.jsJavaEnable word wrap

1234567891011121314curl-X POST 'https://open-api.tiktokglobalshop.com/fulfillment/202502/invoice/upload?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3' -H 'content-type: application/json' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -d '{ "invoices": [ { "package_id": "1161235029d14122252", "order_ids": "5361235029d14122252", "file_type": "XML", "file": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGL" } ]}'

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"code":0,"data":{"errors":[{"code":10007014,"message":"The invoice already exists in the upload. Please try again later","detail":{"package_id":"1231231231231","order_ids":["58747683456"]}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

Error Code

View common error codes

| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |

Is this content helpful?Helpful

Not Helpful

PreviousNext