> For the complete documentation index, see [llms.txt](https://help.genser.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.genser.ai/ja/developers/action-data/api-references/jue-ji-purchase.md).

# 決済 (Purchase)

決済関連のユーザー行動収集API

## 決済開始

> 決済開始収集API

```json
{"openapi":"3.1.0","info":{"title":"Gelatto イベント収集API（基本）","version":"1.0.0"},"tags":[{"name":"決済 (Purchase)","description":"決済関連のユーザー行動収集API"}],"servers":[{"url":"https://api.gelatto.ai","description":"Production"},{"url":"https://api-dev.gelatto.ai","description":"Development"},{"url":"http://localhost","description":"Local Development (ポート80)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"APIキー"}},"schemas":{"ActionsPurchaseCheckoutEvent":{"title":"決済開始","description":"ユーザーが決済を開始する行動を収集します","type":"object","required":["time","source","data"],"properties":{"specversion":{"type":"string","description":"仕様バージョン","enum":["1.0.0"]},"id":{"type":"string","description":"イベントの一意識別子","enum":["EVT-START-CHECKOUT"]},"type":{"type":"string","description":"イベントタイプ","enum":["start_checkout"]},"time":{"type":"string","description":"ISO 8601 UTC イベント作成時刻","format":"date-time"},"source":{"type":"string","description":"イベント発生元"},"datacontenttype":{"type":"string","description":"データコンテンツタイプ","enum":["application/ld+json"]},"dataschema":{"type":"string","description":"データスキーマパス","enum":["https://api.gelatto.ai/schema/actions/purchase_checkout.json"]},"data":{"type":"object","description":"イベントデータオブジェクト","required":["agent","object"],"properties":{"@context":{"type":"string","description":"スキーマコンテキスト","enum":["https://schema.org/"]},"@type":{"type":"string","description":"アクションタイプ","enum":["CheckoutAction"]},"agent":{"type":"object","description":"実行者（Person）","required":["identifier"],"properties":{"@type":{"type":"string","enum":["Person"]},"identifier":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"type":"string","description":"値"}}},"type":"array","description":"実行者識別子リスト（userId、memberId、cookieIdは必須で追加する必要があります。属性の追加が必要な場合は協議）"},"gender":{"type":"string","enum":["Female","Male","https://schema.org/Female","https://schema.org/Male"]},"additionalProperty":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"追加属性"}}},"object":{"oneOf":[{"$ref":"#/components/schemas/ActionsPurchaseCheckoutOrderItem"},{"type":"array","items":{"$ref":"#/components/schemas/ActionsPurchaseCheckoutOrderItem"}}]},"target":{"type":"object","description":"エンドポイント情報","required":["urlTemplate"],"properties":{"@type":{"type":"string","enum":["EntryPoint"]},"urlTemplate":{"type":"string","description":"URL"}}}}}}},"ActionsPurchaseCheckoutOrderItem":{"description":"購入情報","type":"object","required":["orderedItem","orderQuantity"],"properties":{"@type":{"type":"string","enum":["OrderItem"]},"orderedItem":{"$ref":"#/components/schemas/ActionsPurchaseCheckoutProduct"},"orderQuantity":{"type":"number","description":"数量"}}},"ActionsPurchaseCheckoutProduct":{"description":"商品オブジェクト","type":"object","required":["sku","name","offers"],"properties":{"@type":{"type":"string","enum":["Product"]},"sku":{"type":"string","description":"商品一意識別子、商品コード（SKU）"},"name":{"description":"商品名","oneOf":[{"description":"単純文字列","type":"string"},{"description":"多言語オブジェクト","type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}},{"description":"多言語配列","type":"array","items":{"type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}}}]},"offers":{"$ref":"#/components/schemas/ActionsPurchaseCheckoutOffer"}}},"ActionsPurchaseCheckoutOffer":{"description":"数量/価格オブジェクト","type":"object","required":["price","priceCurrency"],"properties":{"@type":{"type":"string","enum":["Offer"]},"price":{"type":"number","description":"販売価格"},"priceCurrency":{"type":"string","description":"ISO 4217 通貨コード（例：KRW、USD、JPY）"}}}}},"paths":{"/actions/purchase/checkout":{"post":{"summary":"決済開始","description":"決済開始収集API","operationId":"collectPurchaseCheckout","tags":["決済 (Purchase)"],"parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","enum":["application/json"]},"description":"コンテンツタイプ"},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionsPurchaseCheckoutEvent"}}}},"responses":{"200":{"description":"収集成功"},"400":{"description":"不正なリクエスト"},"503":{"description":"一時的にサービスを利用できません"}}}}}}
```

## 決済完了

> 決済完了収集API

```json
{"openapi":"3.1.0","info":{"title":"Gelatto イベント収集API（基本）","version":"1.0.0"},"tags":[{"name":"決済 (Purchase)","description":"決済関連のユーザー行動収集API"}],"servers":[{"url":"https://api.gelatto.ai","description":"Production"},{"url":"https://api-dev.gelatto.ai","description":"Development"},{"url":"http://localhost","description":"Local Development (ポート80)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"APIキー"}},"schemas":{"ActionsPurchaseCompleteEvent":{"title":"決済完了","description":"ユーザーが決済を完了する行動を収集します","type":"object","required":["time","source","data"],"properties":{"specversion":{"type":"string","description":"仕様バージョン","enum":["1.0.0"]},"id":{"type":"string","description":"イベントの一意識別子","enum":["EVT-COMPLETE-PURCHASE"]},"type":{"type":"string","description":"イベントタイプ","enum":["complete_purchase"]},"time":{"type":"string","description":"ISO 8601 UTC イベント作成時刻","format":"date-time"},"source":{"type":"string","description":"イベント発生元"},"datacontenttype":{"type":"string","description":"データコンテンツタイプ","enum":["application/ld+json"]},"dataschema":{"type":"string","description":"データスキーマパス","enum":["https://api.gelatto.ai/schema/actions/purchase_complete.json"]},"data":{"type":"object","description":"イベントデータオブジェクト","required":["agent","object"],"properties":{"@context":{"type":"string","description":"スキーマコンテキスト","enum":["https://schema.org/"]},"@type":{"type":"string","description":"アクションタイプ","enum":["OrderAction"]},"agent":{"type":"object","description":"実行者（Person）","required":["identifier"],"properties":{"@type":{"type":"string","enum":["Person"]},"identifier":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"type":"string","description":"値"}}},"type":"array","description":"実行者識別子リスト（userId、memberId、cookieIdは必須で追加する必要があります。属性の追加が必要な場合は協議）"},"gender":{"type":"string","enum":["Female","Male","https://schema.org/Female","https://schema.org/Male"]},"additionalProperty":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"追加属性"}}},"object":{"oneOf":[{"$ref":"#/components/schemas/ActionsPurchaseCompleteOrderItem"},{"type":"array","items":{"$ref":"#/components/schemas/ActionsPurchaseCompleteOrderItem"}}]},"target":{"type":"object","description":"エンドポイント情報","required":["urlTemplate"],"properties":{"@type":{"type":"string","enum":["EntryPoint"]},"urlTemplate":{"type":"string","description":"URL"}}}}}}},"ActionsPurchaseCompleteOrderItem":{"description":"購入情報","type":"object","required":["orderedItem","orderQuantity"],"properties":{"@type":{"type":"string","enum":["OrderItem"]},"orderedItem":{"$ref":"#/components/schemas/ActionsPurchaseCompleteProduct"},"orderQuantity":{"type":"number","description":"数量"}}},"ActionsPurchaseCompleteProduct":{"description":"商品オブジェクト","type":"object","required":["sku","name","offers"],"properties":{"@type":{"type":"string","enum":["Product"]},"sku":{"type":"string","description":"商品一意識別子、商品コード（SKU）"},"name":{"description":"商品名","oneOf":[{"description":"単純文字列","type":"string"},{"description":"多言語オブジェクト","type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}},{"description":"多言語配列","type":"array","items":{"type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}}}]},"offers":{"$ref":"#/components/schemas/ActionsPurchaseCompleteOffer"}}},"ActionsPurchaseCompleteOffer":{"description":"数量/価格オブジェクト","type":"object","required":["price","priceCurrency"],"properties":{"@type":{"type":"string","enum":["Offer"]},"price":{"type":"number","description":"販売価格"},"priceCurrency":{"type":"string","description":"ISO 4217 通貨コード（例：KRW、USD、JPY）"}}}}},"paths":{"/actions/purchase/complete":{"post":{"summary":"決済完了","description":"決済完了収集API","operationId":"collectPurchaseComplete","tags":["決済 (Purchase)"],"parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","enum":["application/json"]},"description":"コンテンツタイプ"},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionsPurchaseCompleteEvent"}}}},"responses":{"200":{"description":"収集成功"},"400":{"description":"不正なリクエスト"},"503":{"description":"一時的にサービスを利用できません"}}}}}}
```

## 決済キャンセル

> 決済キャンセル収集API

```json
{"openapi":"3.1.0","info":{"title":"Gelatto イベント収集API（基本）","version":"1.0.0"},"tags":[{"name":"決済 (Purchase)","description":"決済関連のユーザー行動収集API"}],"servers":[{"url":"https://api.gelatto.ai","description":"Production"},{"url":"https://api-dev.gelatto.ai","description":"Development"},{"url":"http://localhost","description":"Local Development (ポート80)"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Api-Key","description":"APIキー"}},"schemas":{"ActionsPurchaseCancelEvent":{"title":"決済キャンセル","description":"ユーザーが決済をキャンセルする行動を収集します","type":"object","required":["time","source","data"],"properties":{"specversion":{"type":"string","description":"仕様バージョン","enum":["1.0.0"]},"id":{"type":"string","description":"イベントの一意識別子","enum":["EVT-CANCEL-PURCHASE"]},"type":{"type":"string","description":"イベントタイプ","enum":["cancel_purchase"]},"time":{"type":"string","description":"ISO 8601 UTC イベント作成時刻","format":"date-time"},"source":{"type":"string","description":"イベント発生元"},"datacontenttype":{"type":"string","description":"データコンテンツタイプ","enum":["application/ld+json"]},"dataschema":{"type":"string","description":"データスキーマパス","enum":["https://api.gelatto.ai/schema/actions/purchase_cancel.json"]},"data":{"type":"object","description":"イベントデータオブジェクト","required":["agent","object"],"properties":{"@context":{"type":"string","description":"スキーマコンテキスト","enum":["https://schema.org/"]},"@type":{"type":"string","description":"アクションタイプ","enum":["CancelAction"]},"agent":{"type":"object","description":"実行者（Person）","required":["identifier"],"properties":{"@type":{"type":"string","enum":["Person"]},"identifier":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"type":"string","description":"値"}}},"type":"array","description":"実行者識別子リスト（userId、memberId、cookieIdは必須で追加する必要があります。属性の追加が必要な場合は協議）"},"gender":{"type":"string","enum":["Female","Male","https://schema.org/Female","https://schema.org/Male"]},"additionalProperty":{"items":{"type":"object","required":["propertyID","value"],"properties":{"@type":{"type":"string","enum":["PropertyValue"]},"propertyID":{"type":"string","description":"プロパティID"},"value":{"oneOf":[{"type":"string"},{"type":"number"}],"description":"値"}}},"type":"array","description":"追加属性"}}},"object":{"oneOf":[{"$ref":"#/components/schemas/ActionsPurchaseCancelOrderItem"},{"type":"array","items":{"$ref":"#/components/schemas/ActionsPurchaseCancelOrderItem"}}]},"target":{"type":"object","description":"エンドポイント情報","required":["urlTemplate"],"properties":{"@type":{"type":"string","enum":["EntryPoint"]},"urlTemplate":{"type":"string","description":"URL"}}}}}}},"ActionsPurchaseCancelOrderItem":{"description":"購入情報","type":"object","required":["orderedItem","orderQuantity"],"properties":{"@type":{"type":"string","enum":["OrderItem"]},"orderedItem":{"$ref":"#/components/schemas/ActionsPurchaseCancelProduct"},"orderQuantity":{"type":"number","description":"数量"}}},"ActionsPurchaseCancelProduct":{"description":"商品オブジェクト","type":"object","required":["sku","name","offers"],"properties":{"@type":{"type":"string","enum":["Product"]},"sku":{"type":"string","description":"商品一意識別子、商品コード（SKU）"},"name":{"description":"商品名","oneOf":[{"description":"単純文字列","type":"string"},{"description":"多言語オブジェクト","type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}},{"description":"多言語配列","type":"array","items":{"type":"object","required":["@value","@language"],"properties":{"@value":{"type":"string","description":"商品名の値"},"@language":{"type":"string","description":"ISO 639-1 言語コード","enum":["ko","en","ja"]}}}}]},"offers":{"$ref":"#/components/schemas/ActionsPurchaseCancelOffer"}}},"ActionsPurchaseCancelOffer":{"description":"数量/価格オブジェクト","type":"object","required":["price","priceCurrency"],"properties":{"@type":{"type":"string","enum":["Offer"]},"price":{"type":"number","description":"販売価格"},"priceCurrency":{"type":"string","description":"ISO 4217 通貨コード（例：KRW、USD、JPY）"}}}}},"paths":{"/actions/purchase/cancel":{"post":{"summary":"決済キャンセル","description":"決済キャンセル収集API","operationId":"collectPurchaseCancel","tags":["決済 (Purchase)"],"parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string","enum":["application/json"]},"description":"コンテンツタイプ"},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","format":"uuid"},"description":"べき等性キー - クライアントが呼び出し時に渡す必要があります（UUID）"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionsPurchaseCancelEvent"}}}},"responses":{"200":{"description":"収集成功"},"400":{"description":"不正なリクエスト"},"503":{"description":"一時的にサービスを利用できません"}}}}}}
```