クーポンステータス更新 (クーポン使用)

このエンドポイントのAPIドキュメント

エンドポイントパス

PUT <BASE_URL>/put/update-coupon-status

リクエストパラメータ

種類	名前	必須	例
リクエストボディ	coupon_code	必須	ABC123XYZ

リクエストボディ

{
  "coupon_code": "ABC123XYZ"
}

レスポンスステータス

ステータスコード	意味
200	成功
400	不正なリクエスト
401	認証エラー
404	データが見つかりません
500	サーバー内部エラー

レスポンスボディ

成功

{
  "message": "Success"
}

不正なリクエスト

{
  "error_msg": "Coupon code ABC123XYZ has no remaining quantity left"
}

認証エラー

{
  "error_msg": "API-KEY is invalid"
}

データが見つかりません

{
  "error_msg": "Coupon code ABC123XYZ is not exist"
}

サーバー内部エラー

{
  "error_msg": "Internal error occured, please check with our team"
}

エンドポイントへのリクエストコード例

cURL

curl -X PUT "<BASE_URL>/put/update-coupon-status" \
     -H "Content-Type: application/json" \
     -H "API-KEY: <YOUR_API_KEY>" \
     -d '{
           "coupon_code": "ABC123XYZ"
         }'

Python

import requests

url = "<BASE_URL>/put/update-coupon-status"
headers = {
    "Content-Type": "application/json",
    "API-KEY": "<YOUR_API_KEY>"
}

data = {
    "coupon_code": "ABC123XYZ"
}

response = requests.put(url, json=data, headers=headers)
print(response.json())

PHP

<?php

$url = "<BASE_URL>/put/update-coupon-status";

$data = array(
    "coupon_code" => "ABC123XYZ"
);

$headers = array(
    "Content-Type: application/json",
    "API-KEY: <YOUR_API_KEY>"
);

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // to capture response as a string
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT"); // use PUT method
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data)); // attach JSON body
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); // set headers

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Request Error: ' . curl_error($ch);
} else {
    $responseData = json_decode($response, true);
    print_r($responseData); // print decoded JSON response
}

curl_close($ch);
?>