ReCORE.co-api

宅配買取ケース

宅配買取ケース検索

概要

宅配買取ケースの検索を行う

基本情報

リクエストパス: GET /bad_cases
JWTスコープ: bad_case:index
必須個別JWTパラメータ: なし
レートリミット: 5 rps

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
codes	ケースコード	カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
stocked_at_from	入庫日から	同上
stocked_at_to	入庫日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

Request

GET /bad_cases?codes=BD06IVE643UW

Response

[
  {
    "id": 34,
    "code": "BD06IVE643UW",
    "store": {
      "id": 1,
      "name": "本店"
    },
    "status": "CANCELED",
    "sub_status": null,
    "return_status": "RETURNED",
    "message_channel": null,
    "member_id": 215,
    "last_name": "てすと",
    "last_kana": "テスト",
    "first_name": "太郎",
    "first_kana": "タロウ",
    "postal_code": "5640051",
    "prefecture": "大阪府",
    "address1": "吹田市",
    "address2": "豊津町",
    "occupation": "会社員",
    "tel": "06-0000-0000",
    "sex": "MALE",
    "email": "demo@demo.com",
    "birthdate": "2024-09-05",
    "is_invoice_provider": true,
    "invoice_provider_number": "T1234567890123",
    "note": "kk",
    "needs_action": false,
    "customer_note": null,
    "offer_comment": null,
    "buyer_comment": null,
    "bank_code": "0033",
    "bank_branch_code": "001",
    "bank_account_number": "1234567",
    "bank_account_name": "テストタロウ",
    "payment": {
      "id": 6,
      "name": "銀行振込",
      "type": "BANK"
    },
    "offered_at": 1716445990,
    "assessed_at": 1728370660,
    "stocked_at": null,
    "created_at": 1716445979,
    "updated_at": 1728377319,
    "attachments":[
      {
        "id": 179,
        "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
        "tag": "PHOTO",
        "file_name": "photo.jpg",
        "url": "https://development-recore-private-files.s3.ap-northeast-1.amazonaws.com/PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg?response-content-disposition=filename%2A%3DUTF-8%27%27photo.jpg&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJEP2KIYCS4OSR6PQ%2F20241008%2Fap-northeast-1%2Fs3%2Faws4_request&X-Amz-Date=20241008T062723Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Signature=d952caf46dfe81d5f139d540ccc46979bc7e3e400f9780b1f4eed5c2e7a39ac8",
        "mime_type": "image/jpeg"
      }
    ],
    "coupons": [
      {
        "amount": 100,
        "coupon_id": 4
      }
    ],
    "goods":[
      {
        "id": 37,
        "serial": 1,
        "is_canceled": false,
        "quantity": 1,
        "grade":{
          "id": 2,
          "name": "中古A"
        },
        "condition_tags": [
          {
            "id": 3,
            "name": "aaa"
          }
        ],
        "condition_note": null,
        "note": null,
        "unit_price": 333,
        "selling_unit_price": 444,
        "unit_adjustment": 0,
        "case_adjustment": 200,
        "coupon_adjustment": 100,
        "tax": 0,
        "included_tax": 48,
        "tax_rate": 10,
        "tax_rate_type": "GENERAL",
        "attribute": null,
        "product_id": 157,
        "item_id": null
      }
    ],
    "summary":{
      "quantity": 1,
      "sub_total": 333,
      "case_adjustment": 200,
      "coupon_adjustment": 100,
      "total": 533,
      "taxes":[
        {
          "tax_rate_type": "GENERAL",
          "tax_rate": 10,
          "tax": 0,
          "included_tax": 48,
          "taxable_amount": 533
        }
      ]
    }
  }
]

key	type	説明
*	array<object>	ケース
*.id	int	ケースID
*.code	string	ケースコード
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.status	string	ステータス
*.sub_status	string \| null	サブテータス
*.return_status	string	返送ステータス
*.message_channel	string \| null	希望連絡方法
*.member_id	int \| null	会員ID
*.last_name	string \| null	姓
*.last_kana	string \| null	セイ
*.first_name	string \| null	名
*.first_kana	string \| null	メイ
*.postal_code	string \| null	郵便番号
*.prefecture	string \| null	都道府県
*.address1	string \| null	住所1
*.address2	string \| null	住所2
*.tel	string \| null	電話番号
*.sex	string \| null	性別
*.email	string \| null	メールアドレス
*.birthdate	string \| null	生年月日
*.is_invoice_provider	bool	適格事業者か
*.invoice_provider_number	string \| null	適格事業者番号
*.note	string \| null	ケースメモ
*.needs_action	bool	要対応か
*.customer_note	string \| null	顧客メモ
*.offer_comment	string \| null	申込時備考
*.buyer_comment	string \| null	バイヤーコメント
*.bank_code	string \| null	銀行コード
*.bank_branch_code	string \| null	銀行支店コード
*.bank_account_number	string \| null	銀行口座番号
*.bank_account_name	string \| null	銀行口座名義
*.payment	object \| null	金種
*.payment.id	int	金種ID
*.payment.name	string	金種名
*.payment.type	string	金種タイプ
*.offered_at	int \| null	申込日時
*.assessed_at	int \| null	査定日時
*.stocked_at	int \| null	入庫日時
*.created_at	int \| null	作成日時
*.updated_at	int \| null	更新日時
*.attachments	array<object>	ファイル
.attachments..id	int	ファイルID
.attachments..file_key	string	ファイルキー
.attachments..tag	string	タグ
.attachments..file_name	string \| null	ファイル名
.attachments..url	string	一時URL (*1)
.attachments..mime_type	string	MIMEタイプ
*.coupons	array<object>	クーポン
.coupons..coupon_id	int	クーポンID
.coupons..amount	int	適用額
*.goods	array<object>	買取明細
.goods..id	int	買取明細ID
.goods..serial	int	買取明細通し番号
.goods..product_id	int	カタログID
.goods..is_canceled	bool	単品キャンセルか
.goods..quantity	int	数量
.goods..grade	object	グレード
.goods..grade.id	int	グレードID
.goods..grade.name	string	グレード名
.goods..condition_tags	array<object>	コンディションタグ
.goods..condition_tags.*.id	int	コンディションタグID
.goods..condition_tags.*.name	string	コンディションタグ名
.goods..condition_note	string \| null	コンディション詳細
.goods..note	string \| null	商品メモ
.goods..unit_price	int	買取単価
.goods..selling_unit_price	int	販売単価
.goods..unit_adjustment	int	調整単価
.goods..case_adjustment	int	小計調整
.goods..coupon_adjustment	int	クーポン調整
.goods..tax	int	外税
.goods..included_tax	int	内税
.goods..tax_rate	int	税率
.goods..tax_rate_type	string	税区分
.goods..item_id	int \| null	在庫ID
.goods..attribute	object \| null	在庫属性
*.summary	object	ケースサマリー
*.summary.quantity	int	数量合計
*.summary.case_adjustment	int	小計調整合計
*.summary.coupon_adjustment	int	クーポン調整合計
*.summary.sub_total	int	小計
*.summary.total	int	合計
*.summary.taxes	array<object>	税
.summary.taxes..tax_rate_type	string	税区分
.summary.taxes..tax_rate	int	税率
.summary.taxes..tax	int	外税
.summary.taxes..included_tax	int	内税
.summary.taxes..taxable_amount	int	課税対象金額

*1) 一時的なURLなので保存等はしない
ステータス
- OFFERING 申込受付中
- OFFERED 申込確定
- RECEIVED 着荷済み
- ASSESSED 査定完了
- CONFIRMED 査定承認済み
- STOCKED 買取完了
- PAID 支払い済み
- CANCELED キャンセル
返送ステータス
- NOT_REQUIRED 返送の必要なし
- REQUIRED 返送の必要あり
- RETURNED 返送済み
税区分
- GENERAL 一般
- RELIEF 軽減税率
- NO_TAX 非課税

宅配買取ケース取得

概要

宅配買取ケースを1件取得する

基本情報

リクエストパス: GET /bad_cases/{case_id}
JWTスコープ: bad_case:show
必須個別JWTパラメータ: なし
レートリミット: 5 rps

例

Request

GET /bad_cases/44

Response

宅配買取ケース検索のresponse[0]と同様

宅配買取ケース作成

概要

宅配買取ケースを作成する

基本情報

リクエストパス: POST /bad_cases
JWTスコープ: bad_case:store
必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
レートリミット: 2 rps

body

key	type	説明	制約など
sub_status	?string \| null	サブステータス	30文字まで
message_channel	?string \| null	レジID	`EMAIL` `SMS` `LINE`のいずれか
payment_id	?int \| null	金種ID	-
member_id	?int \| null	会員ID	-
last_name	?string \| null	姓	50文字まで
last_kana	?string \| null	セイ	50文字まで
first_name	?string \| null	名	50文字まで
first_kana	?string \| null	メイ	50文字まで
postal_code	?string \| null	郵便番号	`/^[0-9]{3}-?[0-9]{4}$/`
prefecture	?string \| null	都道府県	10文字まで
address1	?string \| null	市区町村	-
address2	?string \| null	それ以降の住所	-
occupation	?string \| null	職業	20文字まで
tel	?string \| null	電話番号	`/^0[0-9]{9,10}$/`または`/^0[0-9]{1,3}-[0-9]{2,4}-[0-9]{3,4}$/`
sex	?string \| null	性別	`MALE` `FEMALE` `OTHER`のいずれか
email	?string \| null	メールアドレス	メールアドレス形式、256文字まで
birthdate	?string \| null	生年月日	`YYYY-MM-DD`形式
is_invoice_provider	?bool	適格事業者か	-
invoice_provider_number	?string \| null	適格事業者番号	`/^T[0-9]{13}$/`
offer_comment	?string \| null	申込時備考	-
buyer_comment	?string \| null	バイヤーコメント	-
customer_note	?string \| null	顧客メモ	-
note	?string \| null	ケースメモ	-
needs_action	?bool	要対応か	-
case_adjustment	?int	小計調整	99,999,999以下
coupon_ids	?array<int>	クーポンID	-
bank_code	?string \| null	銀行コード	4文字、数値のみ
bank_branch_code	?string \| null	銀行支店コード	3文字、数値のみ
bank_account_number	?string \| null	銀行口座番号	7文字、数値のみ
bank_account_name	?string \| null	銀行口座名義	30文字まで、ひらがなカタカナ英数字記号のみ
goods	?array<object>	買取明細	-
goods.*.product_id	int	カタログID	-
goods.*.is_canceled	bool	単品キャンセルか	-
goods.*.quantity	?int	数量	0以上 9,999以下
goods.*.grade_id	int	グレードID	-
goods.*.condition_tag_ids	?array<int>	コンディションタグID	-
goods.*.condition_note	?string \| null	コンディションメモ	-
goods.*.note	?string \| null	商品メモ	-
goods.*.unit_price	?int	買取単価	0以上 99,999,999以下
goods.*.unit_adjustment	?int	調整単価	-99,999,999以上 99,999,999以下
goods.*.selling_unit_price	?int	販売単価	0以上 99,999,999以下
goods.*.attribute	?object	在庫属性	-

例

Request

POST /bad_cases

{
  "note": "メモ",
  "goods": [
    {
      "product_id": 12,
      "is_canceled": false,
      "grade_id": 1
    }
  ]
}

Response

宅配買取ケース取得と同様

宅配買取ケース更新

概要

宅配買取ケースを更新する

基本情報

リクエストパス: PUT /bad_cases/{case_id}
JWTスコープ: bad_case:update
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

宅配買取ケース作成との差分のみ記載

key	type	説明	制約など
goods.*.action	string	アクション	`CREATE` `UPDATE` `DELETE`
goods.*.id	?int (*2)	買取明細ID	-
goods.*.product_id	?int (*1)	カタログID	-
goods.*.is_canceled	?bool (*1)	単品キャンセルか	-
goods.*.grade_id	?int (*1)	グレードID	-

*1) action: CREATEの場合必須
*2) action: UPDATE DELETEの場合必須
status: ASSESSED CONFIRMED STOCKEDの場合、金額や契約内容が変わるようなカラムの更新は無視されます
status: PAID CANCELEDの場合、ケースメモ以外の更新は無視されます

例

Request

PUT /bad_cases/44

{
  "note": null,
  "goods": [
    {
      "action": "CREATE",
      "product_id": 12,
      "is_canceled": false,
      "grade_id": 1
    },
    {
      "action": "UPDATE",
      "id": 234,
      "grade_id": 2
    },
    {
      "action": "DELETE",
      "id": 235
    }
  ]
}

Response

宅配買取ケース取得と同様

宅配買取ケース削除

概要

宅配買取ケースを削除する

基本情報

リクエストパス: DELETE /bad_cases/{case_id}
JWTスコープ: bad_case:destroy
必須個別JWTパラメータ: なし
レートリミット: 2 rps

例

Request

DELETE /bad_cases/44

Response

なし

宅配買取ステータス更新

概要

宅配買取ケースのステータスを更新する

基本情報

リクエストパス: PUT /bad_cases/{case_id}/status
JWTスコープ: bad_case:status:update
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
status	string	変更後ステータス	-

例

Request

PUT /bad_cases/44/status

{
  "status": "CONFIRMED"
}

Response

宅配買取ケース取得と同様

ケースファイル登録

概要

ファイルを登録する

基本情報

リクエストパス: POST /bad_cases/{case_id}/attachments
JWTスコープ: bad_case:attachment:store
必須個別JWTパラメータ: なし
レートリミット: 2 rps

body

key	type	説明	制約など
file_key	string	ファイルキー (*1)	-
tag	string	タグ	(*2)
file_name	?string \| null	ファイル名	100文字まで

*1) ファイルアップロード(機密ファイル)で取得したファイルキーを使用
*2) 使用できるタグ
- PHOTO 顧客顔写真
- BUYER 査定結果に添付するファイル

例

Request

POST /bad_cases/122/attachments

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "tag": "PHOTO",
  "file_name": "顔写真.jpg"
}

Response

宅配買取ケース取得のattachments[0]と同様

ケースファイル削除

概要

ファイルを削除する

基本情報

リクエストパス: DELETE /bad_cases/{case_id}/attachments/{attachment_id}
JWTスコープ: bad_case:attachment:destroy
必須個別JWTパラメータ: なし
レートリミット: 2 rps

例

Request

DELETE /bad_case/122/attachments/345

Response

(なし)