Submit Redemption Information

POST

/fulfillment/202601/redeem_info/callback

Submit redemption information for one or more line items in a TikTok Shop order so TikTok Shop can fulfill those items.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Request Body^required

Media typeapplication/json

object

order_id

required

TikTok Shop order ID.

string

order_info_list

required

Order line items for which to submit redemption information. Include at least one item. Each order_line_id must belong to the order specified by order_id and must appear only once in the list.

Array<object>

object

order_line_id

required

The unique identifier of the order line item.

string

redeem_info

required

The redemption information generated by your system for this order line item.

object

redeem_type

required

What redeem type that you callback. ‘CODE’ - type code ‘URL’ - type url ‘CODE_PIN’ - type pin and code

string

redeem_data

Set the redeem data to this field with the maximum number of characters 1200. The example of each type is shown below, CODE: abc12344 URL: https://{your_domain}/abc CODE_PIN(json format): {“type”: “CODE_PIN”,“code”: “12345”,“pin”: “abc”}

string

redeem_instruction_info

Additional redemption instruction in JSON format. Use instruction_url to specify a third-party website where the buyer completes redemption. This URL is included as a clickable link in the fulfillment email. Example: {“instruction_url”: “https://example.com/redeem"}

string

source_unique_id

Optional, a unique id related to the order line in the caller system

string

Example

{
  "order_id": "576461413038785752",
  "order_info_list": [
    {
      "order_line_id": "577086512123755123",
      "redeem_info": {
        "redeem_type": "CODE",
        "redeem_data": "abc12344",
        "redeem_instruction_info": "{\"instruction_url\": \"https://example.com/redeem\"}"
      },
      "source_unique_id": "134448484339393"
    }
  ]
}

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

order_statuses

Callback result.For partial failure usage, if some of order line id in the request fail, it will be recorded with a none zero status_code.

Array<object>

object

order_line_id

Line order id, same as the input line order id.

string

status_code

Callback status of this line order id. A none zero code represent a failure callback.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "order_statuses": [
      {
        "order_line_id": "577086512123755123",
        "status_code": 0
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}