Promotion Codes
Retrieve Promotion Code
tolt.js
Guides / How To
Customers
Clicks
Commissions
Transactions
Promotion Codes
Retrieve Promotion Code
This endpoint retrieves a promotion code.
GET
/
v1
/
promotion-codes
/
:id
curl -X GET 'https://api.tolt.com/v1/promotion-codes/prc_dK9bzRGn46BhVgNFHD6fDgXW' \
-H 'Authorization: Bearer <API_KEY>'
{
"success": true,
"data": {
"id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
"code": "SUMMER2024",
"type": "percentage",
"value": 20,
"partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
}
}
Base URL https://api.tolt.com
Query Parameters
Specify which related objects to include in the response. Valid values are ‘partner’ and ‘program’. Use expand[]=partner or expand[]=program to include the related objects.
Response
Whether the request was successful
Unique identifier for the promotion code
The promotion code value
The type of discount
The discount value
ID of the partner who owns the code
ISO 8601 timestamp of creation
ISO 8601 timestamp of last update
Program ID the promotion code belongs to
Organization ID
curl -X GET 'https://api.tolt.com/v1/promotion-codes/prc_dK9bzRGn46BhVgNFHD6fDgXW' \
-H 'Authorization: Bearer <API_KEY>'
{
"success": true,
"data": {
"id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
"code": "SUMMER2024",
"type": "percentage",
"value": 20,
"partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
}
}
curl -X GET 'https://api.tolt.com/v1/promotion-codes/prc_dK9bzRGn46BhVgNFHD6fDgXW' \
-H 'Authorization: Bearer <API_KEY>'
{
"success": true,
"data": {
"id": "prc_dK9bzRGn46BhVgNFHD6fDgXW",
"code": "SUMMER2024",
"type": "percentage",
"value": 20,
"partner_id": "part_s7mbzRGn46BhVgNFHD6fDgXW",
"created_at": "2025-01-15T14:30:00.000Z",
"updated_at": "2025-01-15T14:30:00.000Z",
"program_id": "prg_YRsbPDAKhWfdqJbFACheh",
"organization_id": "org_JE3mfYNL9ci7sFaJazAv2"
}
}