Coupons
Coupons - Update
Atualização parcial de cupom (PATCH): altere apenas os campos enviados no corpo.
Atualização parcial de cupom (PATCH): altere apenas os campos enviados no corpo.
Authorization
SelectKeyAuth selectkey<token>
API key for all authenticated requests. Send your key in the selectkey header (e.g. sandbox sl_test_…, production sl_live_…).
In: header
Path Parameters
couponId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/coupons/dis_01hqzvabc" \ -H "Content-Type: application/json" \ -d '{ "id": "dis_abc123", "name": "Summer Sale", "enabled": true, "code": "SUMMER2026", "type": "flat", "value": 500, "minCartAmount": 10000, "maxCartAmount": 1, "usageLimit": 1000, "limitOneUsePerCustomer": true, "initDate": "2026-04-01T00:00:00Z", "endDate": "2026-12-31T23:59:59Z", "allowedItemIds": [ "item1", "item2" ], "allowedCustomerIds": [ "item1", "item2" ], "usageQuantity": 1, "minCartItems": 1, "maxCartItems": 1, "isCumulative": true }'{
"id": "dis_01hqzvabc",
"name": "Black Friday 25%",
"enabled": true,
"code": "BLACKFRIDAY25",
"type": "percentage",
"value": 25,
"minCartAmount": 10000,
"maxCartAmount": null,
"usageLimit": 100,
"limitOneUsePerCustomer": true,
"initDate": "2026-04-01T00:00:00.000Z",
"endDate": "2026-04-30T23:59:59.000Z",
"allowedItemIds": null,
"allowedCustomerIds": null,
"usageQuantity": 0,
"minCartItems": 0,
"maxCartItems": 0,
"isCumulative": false,
"updatedAt": "2026-04-12T17:56:33.000Z",
"createdAt": "2026-04-12T17:56:33.000Z"
}{
"error": {
"status": "Bad Request",
"statusCode": 400,
"category": "validation",
"message": "Validation errors occurred",
"details": "One or more parameters are invalid or out of range. Please check the parameters and try again.",
"params": [
{
"payment[currency]": "currency must be one of [BRL]"
},
{
"amount": "amount is required"
}
],
"code": "invalidParameters",
"resource": "client"
}
}{
"error": {
"status": "Unauthorized",
"statusCode": 401,
"category": "authentication",
"message": "Unauthorized",
"details": "Authentication failed. The provided API key is invalid or does not have permission to operate.",
"code": "unauthorized"
}
}{
"error": {
"status": "Forbidden",
"statusCode": 403,
"category": "authorization",
"message": "Forbidden",
"details": "Access denied. This may be due to IP blocks, domain restrictions, or insufficient permissions.",
"code": "forbidden"
}
}{
"error": {
"status": "Not Found",
"statusCode": 404,
"category": "client",
"message": "Not Found",
"details": "The requested resource was not found on the server.",
"code": "notFound"
}
}{
"error": {
"status": "Unprocessable Entity",
"statusCode": 422,
"category": "validation",
"message": "Unprocessable Entity",
"details": "The request was understood, but contains invalid data that could not be processed.",
"code": "unprocessableEntity"
}
}{
"error": {
"status": "Too Many Requests",
"statusCode": 429,
"category": "rate_limit",
"message": "Too Many Requests",
"details": "The number of requests exceeded the limit allowed for the IP or user.",
"retryAfterMinutes": 60,
"code": "tooManyRequests"
}
}{
"error": {
"status": "Internal Server Error",
"statusCode": 500,
"category": "server",
"message": "Server error.",
"details": "An internal server error occurred. Please try again later.",
"code": "serverError",
"resource": "server"
}
}