ReCORE.co-api

宅配買取申込受付

概要

ReCORE外に設置される、任意の宅配買取申込フォームを制作するための仕様書
APIを叩くとReCORE内の宅配買取ケースが新規作成される
会員アプリ内に埋め込むことも可能
- この場合SDK経由でログイン中の会員情報が取得できる
- 会員を紐付けてケース作成が可能

API仕様

基本情報

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

body

最新

key	type	説明	制約など
is_pickup	?bool	同時に集荷依頼を行うか	任意、boolean `trueの場合`別途NOVASTOとの契約、設定が必須
pickups	?array<object>	集荷情報	`is_pickup: falseの場合`任意 `is_pickup: trueの場合`必須
pickups.*.pickup_date	?string \| null	希望集荷日	`is_pickup: falseの場合`nullable、YYYY-MM-DD形式 `is_pickup: trueの場合`必須、YYYY-MM-DD 形式
pickups.*.pickup_time	?string \| null	希望集荷時間帯	`is_pickup: falseの場合`nullable `is_pickup: trueの場合`任意、下記コード表を参照
pickups.*.size_code	?string \| null	梱包サイズ	`is_pickup: falseの場合`nullable `is_pickup: trueの場合`必須、下記コード表を参照
pickups.*.material_code	?string \| null	梱包資材	`is_pickup: falseの場合`nullable `is_pickup: trueの場合`任意、下記コード表を参照
pickups.*.name	string	集荷宛名	50文字まで (*1)
pickups.*.postal_code	string	集荷郵便番号	`/^[0-9]{3}-?[0-9]{4}$/` (*1)
pickups.*.prefecture	string	集荷都道府県	10文字まで (*1)
pickups.*.address1	string	集荷市区町村	50文字まで (*1)
pickups.*.address2	?string \| null	集荷それ以降の住所	50文字まで (*1)
pickups.*.tel	string	集荷電話番号	メールアドレス形式、256文字まで (*1)
pickups.*.email	?string \| null	集荷メールアドレス	`/^0[0-9]{9,10}$/`または`/^0[0-9]{1,3}-[0-9]{2,4}-[0-9]{3,4}$/` (*1)
last_name	?string \| null	姓	50文字まで
first_name	?string \| null	名	50文字まで
last_kana	?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	それ以降の住所	-
sex	?string \| null	性別	`MALE` `FEMALE` `OTHER`のいずれか
email	?string \| null	メールアドレス	メールアドレス形式、256文字まで
tel	?string \| null	電話番号	`/^0[0-9]{9,10}$/`または`/^0[0-9]{1,3}-[0-9]{2,4}-[0-9]{3,4}$/`
message_channel	?string \| null	希望の連絡方法	`EMAIL` `SMS` `LINE`のいずれか
payment_id	?int \| null	金種ID	-
comment	?string \| null	備考	-
member_jwt	?string \| null	会員JWT	-
goods	?array<object>	申し込み商品	-
goods.*.product_id	int	カタログID	-
goods.*.grade_id	int	グレードID	-
goods.*.quantity	int	数量	-
goods.*.attribute	?object	在庫属性	-

*1) 未指定の場合は、申し込み住所情報 (ルートのpostal_code等) から引用されます。

希望集荷時間帯 (pickup_time) コード表

時間指定しない場合はnullで送信する

コード	説明
AM	午前中
14	14時-16時
16	16時-18時
18	18時-21時

梱包サイズ (size_code) コード表

コード	説明
0601	宅急便着払60サイズ
0602	宅急便着払80サイズ
0603	宅急便着払100サイズ
0604	宅急便着払120サイズ
0605	宅急便着払140サイズ
0606	宅急便着払160サイズ
0607	宅急便着払180サイズ
0608	宅急便着払200サイズ

梱包資材 (material_code) コード表

資材不要の場合はnullで送信する

コード	説明
001	簡易袋
002	クッション袋A3
003	クッション袋A4
019	アートボックス
020	三角ケースL
021	三角ケースM
032	クロネコボックス12
033	クロネコボックス10
034	クロネコボックス8
035	クロネコボックス6
044	手さげ袋A3-1
046	手さげ袋B4
047	クロネコ袋A3
048	クロネコ袋B4
049	クロネコ袋A4
054	酒BOX(2本)
055	酒BOX(1本)
056	ボトルBOX(2本)
057	ボトルBOX(1本)
073	スーツケースカバー
077	スキーザックカバー
078	スキー板カバー
079	スノーボードカバー
080	簡易ゴルフカバーL
081	簡易ゴルフカバーM
082	ボストンバックカバーL
083	ボストンバックカバーM
084	スキーザックカバー
085	スキー板カバー
117	パソコンBOXA
118	パソコンBOXB
119	パソコンBOXC
120	パソコンBOXD
121	パソコンBOXE
122	精密機器ボックス6
123	精密機器ボックス8
124	薄型精密機器 BOX
129	パソコンBOXF
135	クロネコ書類ケース
136	クロネコボックス14
137	宅急便コンパクト専用BOX
138	宅急便コンパクト薄型専用BOX
139	タブレット対応薄型精密BOX
141	スマートフォン用フィットパック
142	スキー・スノーボードマルチカバー
143	簡易ゴルフカバーLL

例

Request

POST /bad/offer

{
    "is_pickup": true,
    "pickups": [{
       "pickup_date": "2021-07-21",
       "pickup_time": "AM",
       "size_code": "0601",
       "material_code": null
    }],
    "last_name": "髙橋",
    "first_name": "太郎",
    "last_kana": "タカハシ",
    "first_kana": "タロウ",
    "postal_code": "564-0051",
    "prefecture": "大阪府",
    "address1": "吹田市",
    "address2": "豊津町15-11 2F",
    "sex": "OTHER",
    "email": "example@domain.com",
    "tel": "090-1234-1234",
    "message_channel": "SMS",
    "comment": "集荷前に電話連絡あると助かります"
}

Response

{
  "id": 245,
  "code": "BD230905MA72"
}

key	type	説明
id	int	ケースID
code	string	ケースコード

SDK仕様

ページに組み込む

URLは各社毎に異なります

<script src="https://***.app.recore-member.com/sdk.js"></script>

初期化する

各メソッドを使用する前に必ず初期化関数を呼び出してください
originには各社の会員ページのoriginを指定します、文末のスラッシュは除いてください
常にSDKのURLのoriginと一致します

recore.member.init({
  origin: 'https://***.app.recore-member.com'
})

会員アプリから呼び出されているか判定する

会員アプリから呼び出されている場合はtrue、そうで無い場合はfalseが返ります

const embedded = recore.member.embedded()

true

会員情報を取得する

初期化が完了していない、会員アプリから呼び出されていない場合は例外が発生します

const member = await recore.member.message('member')

{
    "last_name": "髙橋",
    "first_name": "太郎",
    "last_kana": "タカハシ",
    "first_kana": "タロウ",
    "postal_code": "564-0051",
    "prefecture": "大阪府",
    "address1": "吹田市",
    "address2": "豊津町15-11 2F",
    "sex": "OTHER",
    "email": "example@domain.com",
    "tel": "090-1234-1234"
}

会員JWTを取得する

取得したJWTを、APIのmember_jwtとして送信することで、会員を紐付けた状態でケース作成が可能です
有効期限が1時間で設定されているため、送信処理の直前でJWTを取得することを推奨します
初期化が完了していない、会員アプリから呼び出されていない場合は例外が発生します

const jwt = await recore.member.message('jwt')

eyJh...