🎟️ Promotion Codes

Promotion code creation and validation endpoints. 6 endpoints available.

🎯 Quick Stats

Total Endpoints: 6
Base URL: https://api.market.decenctype.com
Authentication: Bearer Token / API Key

📊 Methods

📝 POST: 2 endpoints
🔍 GET: 2 endpoints
✏️ PUT: 1 endpoints
🗑️ DELETE: 1 endpoints

🔐 Authentication

All endpoints in this section use the same authentication methods. Choose one:

🔑 Bearer Token (Recommended)

For user session authentication

Add to request headers:

Authorization: Bearer YOUR_TOKEN

🔧 API Key

For server-side authentication

Add to request headers:

X-API-KEY: YOUR_API_KEY

⚠️ Important: Do not use both authentication methods simultaneously in the same request.

🔗 Endpoints Overview

Method	Endpoint	Description
📝 `POST`	`/promotion-code`	Create promotion code
🔍 `GET`	`/promotion-code`	Get promotion code list
🔍 `GET`	`/promotion-code/{code}`	Get promotion code by code
✏️ `PUT`	`/promotion-code/{code}`	Update promotion code
🗑️ `DELETE`	`/promotion-code/{code}`	Delete promotion code
📝 `POST`	`/promotion-code/validate`	Validate promotion code

📖 Detailed Documentation

Create promotion code

POST/promotion-code

Full URL

https://api.market.decenctype.com/promotion-code

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	促销代码
`discountAmount`	`number`	✅	Discount amount
`currency`	`string`	✅	货币 (默认: USD)
`maxUsage`	`number`	✅	Maximum usage limit (默认: 1)
`status`	`string (active, inactive, expired)`	✅	Status (默认: active)
`expirationDate`	`string`	✅	Expiration date
`agentId`	`string`	✅	Agent ID
`merchantId`	`string`	✅	Merchant ID

Description: Create promotion code

Operation ID: createPromotionCode

Response Status:

✅ 201: Promotion code created successfully
❌ 400: Bad request

📋 Response Examples

response.json

1{
2  "id": "example-id",
3  "code": "example-code",
4  "discountAmount": 1,
5  "userId": "example-id",
6  "agentId": "example-id",
7  "merchantId": "example-id",
8  "currency": "example-currency",
9  "usageCount": 1,
10  "maxUsage": 1,
11  "status": "active",
12  "expirationDate": "2024-01-01T12:00:00Z",
13  "createdAt": "2024-01-01T12:00:00Z",
14  "updatedAt": "2024-01-01T12:00:00Z",
15  "user": "example-user"
16}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/promotion-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "example-code",
  "discountAmount": 1,
  "currency": "USD",
  "maxUsage": 1,
  "status": "active",
  "expirationDate": "example-expirationDate",
  "agentId": "example-id",
  "merchantId": "example-id"
}'

Get promotion code list

GET/promotion-code

Full URL

https://api.market.decenctype.com/promotion-code

📋 Query Parameters

Parameter	Type	Required	Description
`page`	`number`	❌	Page number
`pageSize`	`number`	❌	Page size
`status`	`string`	❌	Filter by status

Description: Get promotion code list

Operation ID: getPromotionCodeList

Response Status:

✅ 200: Promotion code list

📋 Response Examples

response.json

1{
2  "items": [
3    {
4      "id": "example-id",
5      "code": "example-code",
6      "discountAmount": 1,
7      "userId": "example-id",
8      "agentId": "example-id",
9      "merchantId": "example-id",
10      "currency": "example-currency",
11      "usageCount": 1,
12      "maxUsage": 1,
13      "status": "active",
14      "expirationDate": "2024-01-01T12:00:00Z",
15      "createdAt": "2024-01-01T12:00:00Z",
16      "updatedAt": "2024-01-01T12:00:00Z",
17      "user": "example-user"
18    }
19  ],
20  "meta": "example-meta"
21}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/promotion-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Get promotion code by code

GET/promotion-code/{code}

Full URL

https://api.market.decenctype.com/promotion-code/{code}

🎯 Path Parameters

code (string) - ✅ Required: Promotion code

Description: Get promotion code by code

Operation ID: getPromotionCodeByCode

Response Status:

✅ 200: Promotion code details
❌ 404: Promotion code not found

📋 Response Examples

response.json

1{
2  "id": "example-id",
3  "code": "example-code",
4  "discountAmount": 1,
5  "userId": "example-id",
6  "agentId": "example-id",
7  "merchantId": "example-id",
8  "currency": "example-currency",
9  "usageCount": 1,
10  "maxUsage": 1,
11  "status": "active",
12  "expirationDate": "2024-01-01T12:00:00Z",
13  "createdAt": "2024-01-01T12:00:00Z",
14  "updatedAt": "2024-01-01T12:00:00Z",
15  "user": "example-user"
16}

📝 Example Request

curl -X GET "https://api.market.decenctype.com/promotion-code/example-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Update promotion code

PUT/promotion-code/{code}

Full URL

https://api.market.decenctype.com/promotion-code/{code}

🎯 Path Parameters

code (string) - ✅ Required: Promotion code

📝 Request Body Parameters

Parameter	Type	Required	Description
`discountAmount`	`number`	✅	Discount amount
`currency`	`string`	✅	货币
`maxUsage`	`number`	✅	Maximum usage limit
`status`	`string (active, inactive, expired)`	✅	Status
`expirationDate`	`string`	✅	Expiration date
`agentId`	`string`	✅	Agent ID
`merchantId`	`string`	✅	Merchant ID

Description: Update promotion code

Operation ID: updatePromotionCode

Response Status:

✅ 200: Promotion code updated successfully
❌ 404: Promotion code not found

📋 Response Examples

response.json

1{
2  "id": "example-id",
3  "code": "example-code",
4  "discountAmount": 1,
5  "userId": "example-id",
6  "agentId": "example-id",
7  "merchantId": "example-id",
8  "currency": "example-currency",
9  "usageCount": 1,
10  "maxUsage": 1,
11  "status": "active",
12  "expirationDate": "2024-01-01T12:00:00Z",
13  "createdAt": "2024-01-01T12:00:00Z",
14  "updatedAt": "2024-01-01T12:00:00Z",
15  "user": "example-user"
16}

📝 Example Request

curl -X PUT "https://api.market.decenctype.com/promotion-code/example-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "discountAmount": 1,
  "currency": "example-currency",
  "maxUsage": 1,
  "status": "active",
  "expirationDate": "example-expirationDate",
  "agentId": "example-id",
  "merchantId": "example-id"
}'

Delete promotion code

DELETE/promotion-code/{code}

Full URL

https://api.market.decenctype.com/promotion-code/{code}

🎯 Path Parameters

code (string) - ✅ Required: Promotion code

Description: Delete promotion code

Operation ID: deletePromotionCode

Response Status:

✅ 200: Promotion code deleted successfully
❌ 404: Promotion code not found

📝 Example Request

curl -X DELETE "https://api.market.decenctype.com/promotion-code/example-code" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json"

Validate promotion code

POST/promotion-code/validate

Full URL

https://api.market.decenctype.com/promotion-code/validate

📝 Request Body Parameters

Parameter	Type	Required	Description
`code`	`string`	✅	促销代码
`orderAmount`	`number`	✅	Order amount

Description: Validate promotion code

Operation ID: validatePromotionCode

Response Status:

✅ 200: Promotion code validation result
✅ 201: Success

📋 Response Examples

response.json

1{
2  "valid": false,
3  "discountAmount": 0,
4  "promotionCode": "example-promotionCode",
5  "error": "Promotion code not found"
6}

📝 Example Request

curl -X POST "https://api.market.decenctype.com/promotion-code/validate" \\
  -H "Authorization: Bearer YOUR_TOKEN" \\
  -H "Content-Type: application/json" \\
  -d '{
  "code": "example-code",
  "orderAmount": 1
}'

🎟️ Promotion Codes

🎯 Quick Stats

📊 Methods

🔑 Bearer Token (Recommended)

🔧 API Key

On this page