プロモーションコードを作成する

post

https://api.smartpay.co/v1/promotion-codes

プロモーションコードは、お客様がクーポンと引き換えることができるコードです。1つのクーポンに対して複数のコードを作成することができます。

エラー

すべての API エンドポイントに当てはまるエラーに加え、以下はプロモーションコードの作成時にのみ返されるエラーです。

ステータスコード	エラーコード	説明
404	coupon.not-found	条件に合うクーポンが見つかりませんでした。正しい coupon id と API キーを使用してください。`テスト`モードのオブジェクトには、テストキーを使用してのみアクセスすることができ、`ライブ`モードのオブジェクトには、ライブキーを使用してのみアクセスできます。
409	promotion-code.exists	このプロモーションコード `{code}` は既に存在しています。すべてのプロモーションコードが一意である必要があります。

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create Promotion Code

active

boolean

Defaults to false

Has the value true (default) if the promotion code is active and can be used, or the value false if it is not.

code

string

required

length between 1 and 80

The customer-facing code. Regardless of case, this code must be unique across all your promotion codes.

coupon

string

required

The unique identifier for the Coupon object.

currency

string

Three-letter ISO currency code, in uppercase. Must be a supported currency.

expiresAt

integer

Time at which the Promotion Code expires. Measured in milliseconds since the Unix epoch.

firstTimeTransaction

boolean

Defaults to false

A Boolean indicating if the Promotion Code should only be redeemed for customers without any successful order with the merchant. Defaults to false if not set.

maxRedemptionCount

integer

Maximum number of times this Promotion Code can be redeemed, in total, across all customers, before it is no longer valid.

metadata

object

Set of up to 20 key-value pairs that you can attach to the object.

minimumAmount

number

The minimum amount required to redeem this Promotion Code (e.g., the amount of the order must be ¥10,000 or more to be applicable).

onePerCustomer

boolean

Defaults to false

A Boolean indicating if the Promotion Code should only be redeemed once by any given customer. Defaults to false if not set.

Responses

200Promotion Code

401Unauthorized

404Coupon Not Found

409Promotion Code Exists