V1Contracts

保証契約検索

GET
/v1/contracts
X-Proteger-Auth-Token<token>

In: header

Query Parameters

ids?string

ID(コンマ区切りで複数指定可能)

transactionIds?string

トランザクションID(コンマ区切りで複数指定可能)

transactionDateBegin?string

支払発生日時開始日時(指定日時以降を取得)RFC3339

transactionDateEnd?string

支払発生日時開始日時(指定日時以降を取得)RFC3339

customerId?string

Store様が発行するエンドユーザー様の一意なID

customerEmail?string

顧客メールアドレス

sortKey?string

ソートするキー

sortAsc?boolean

昇順にするか

limit?integer

取得数、最大100件

Header Parameters

X-Proteger-Auth-Token*string

protegerAccessToken

Content-Type*string

application/json

Accept*string

application/json

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/contracts?ids=c10a0882-2b11-633d-7de6-0563bbf9dbed%2C21966d7c-b2d8-01b9-738c-975f6d3734c0%2Cf1c59ae0-2482-d576-5f86-0b0ae61bc8ac&transactionIds=order01%2Corder02%2Corder03&transactionDateBegin=2021-01-31T13%3A16%3A06.239289%2B09%3A00&transactionDateEnd=2021-01-31T13%3A16%3A06.239289%2B09%3A00&customerEmail=customer%40helloproteger.com&sortKey=CreatedAt&sortAsc=false&limit=50" \  -H "X-Proteger-Auth-Token: string" \  -H "Content-Type: string" \  -H "Accept: string"
[  {    "id": "c10a0882-2b11-633d-7de6-0563bbf9dbed",    "inquiryCode": "892hv238",    "transactionId": "order0001",    "transactionTotal": 12000,    "transactionDate": "2021-01-31T13:16:06.239289+09:00",    "customer": {      "id": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "referenceId": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "name": "山田 太郎",      "email": "user@example.com",      "phone": "0120-XXXX-XXXX",      "billingAddress": {        "postalNumber": "227-0043",        "prefecture": "神奈川県",        "city": "横浜市青葉区藤が丘",        "address": "1-49-1",        "building": "XXXハイム 306"      },      "shippingAddress": {        "postalNumber": "227-0043",        "prefecture": "神奈川県",        "city": "横浜市青葉区藤が丘",        "address": "1-49-1",        "building": "XXXハイム 306"      }    },    "product": {      "id": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "referenceId": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "title": "ノートPC",      "price": 10000,      "imageUrl": "https://helloproteger.com/image/10vj12.png",      "category": "パソコン",      "brand": "Apple",      "purchasePrice": 10000,      "serialNumber": "12304981",      "createdAt": "2021-01-31T13:16:06.239289+09:00",      "updatedAt": "2021-01-31T13:16:06.239289+09:00"    },    "plan": {      "id": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "title": "1年延長保証",      "price": 2000,      "termLength": 12,      "serviceType": "Repair",      "protectionType": "Base",      "url": "string"    },    "store": {      "id": "c10a0882-2b11-633d-7de6-0563bbf9dbed",      "name": "proteger公式オンラインストア",      "webSite": "https://hi.helloproteger.com",      "logoUrl": "https://helloproteger.com/logo.png"    },    "isFulfilled": true,    "status": "Active",    "fraud": false,    "startedAt": "2021-01-31T13:16:06.239289+09:00",    "endedAt": "2021-01-31T13:16:06.239289+09:00",    "createdAt": "2021-01-31T13:16:06.239289+09:00",    "updatedAt": "2021-01-31T13:16:06.239289+09:00"  }]
{  "requestId": "kJZQv3lyB2rjHKNbeGBy5HMet4MO0nw9",  "code": "BadRequestException",  "error": "failed create contract: failed get product: not found"}