(36) Invoice status change
1. Trigger scenario
This webhook is triggered when the status of an invoice upload changes after using the POST Upload Invoice endpoint. Note: The POST Upload Invoice API is currently only applicable to the Brazil market.
2. Data business parameters
| Parameter name | Data type | Sample | Description |
|---|---|---|---|
| shop_id | string | "7494049642642441621" | The TikTok Shop ID. |
| type | int64 | 36 | The ID of this webhook topic, which is 36. |
| tts_notification_id | string | "7327112393057371910" | The ID of this webhook notification. |
| timestamp | int64 | 1644412885 | The time when this webhook is triggered. Unix timestamp. |
| data | object | ||
| └ package_id | string | "123456" | The ID of the package. |
| └ order_ids | []string | ["152523", "532123"] | List of order IDs in the corresponding package_id. |
| └ invoice_status | string | "SUCCESS" | The status of the invoice upload. Possible values: * SUCCESS * PROCESSING * FAILED * INVALID |
| └ invalid_reason | string | "NOT_FOUND" | The reason why invoice_status = INVALID. Possible values: * UNKNOWN: Internal system error. Please try again later. * FAILED: The NFe file or access key is invalid. Please check the XML file for correctness. * NOT_FOUND: The NFe was not found. This may be due to data delay. Please try again later. * NOT_AUTHORIZED: The NFe is not legally authorized. It may not have been issued or has been canceled. * ACCESS_KEY_DUPLICATE: The access key already exists. You cannot upload an invoice with duplicate access key. * CNPJ_NOT_MATCH：Ensure the NF-e has the same 8-digit prefix as the CNPJ you provided during onboarding. * UF_Inconsistent_Required: NF-e validation failed: The CNPJ used to issue the NF-e is registered in a different state from your warehouse. * UF_Inconsistent_Dismisse_Retirada_missing: NF-e validation failed: The CNPJ used to issue the NF-e is registered in a different state from your warehouse. To issue a valid NF-e with this CNPJ, include warehouse information (Pickup Location Identification) in your NF-e. * UF_Inconsistent_Dismissed_Retirada_Inconsistent: The CNPJ used to issue the NF-e is registered in a different state from your warehouse. To issue a valid NF-e with this CNPJ, include warehouse information (Pickup Location Identification) in your NF-e. |
Event example
JSONWord Wrap
{
"type": 36,
"tts_notification_id": "7327112393057371910",
"shop_id": "7494049642642441621",
"timestamp": 1644412885,
"data": {
"package_id": "123456",
"order_ids": [
"152523",
"532123"
],
"invoice_status": "INVALID",
"invalid_reason": "NOT_FOUND"
}
}