Download OpenAPI specification:
beatcloudへAPIを介した商品情報の取得、注文などを行うための仕様書です。
システムバージョン: 1.1.2
[- {
- "id": 10,
- "name": "Your Brand",
}
]商品の一覧を取得します。商品の名称や画像URL、価格、在庫数などを取得できます。
| brand | integer <int64> ブランドID。複数ある場合はカンマ区切りで指定します。 |
[- {
- "brand_id": 10,
- "brand_name": "Your Brand",
- "id": 10,
- "name": "Your Product Name",
- "market_price": 50000,
- "market_sale_price": 45000,
- "deal_price": 30000,
- "deal_sale_price": 25000,
- "stock": 5,
}
]IDを指定して商品を取得します。商品の名称や画像URL、価格、在庫数などを取得できます。
| productId required | integer <int64> 商品ID |
{- "brand_id": 10,
- "brand_name": "Your Brand",
- "id": 10,
- "name": "Your Product Name",
- "market_price": 50000,
- "market_sale_price": 45000,
- "deal_price": 30000,
- "deal_sale_price": 25000,
- "stock": 5,
}指定した商品の注文可否を確認します。在庫切れや販売停止中の商品が含まれている場合、エラーが返されます。注文自体は行われません。orderエンドポイントでも同様のチェックは行われます。
注文内容。商品IDと数量を指定します。
required | Array of objects (OrderRequestItem) |
{- "items": [
- {
- "product_id": 10,
- "qty": 7
}
]
}{- "errors": {
- "dealer_order_id": [
- "alpha_dash"
], - "items.*.product_id": [
- "required",
- "product_not_available:{product_id}"
], - "items.*.qty": [
- "required",
- "invalid",
- "min:{min}",
- "product_not_available:{product_id}",
- "max:{product_id},{max}"
]
}
}新しい注文を行います。注文が成功すると、注文IDとライセンスキーが一括で返されます。
注文内容。商品IDと数量を指定します。
| dealer_order_id | string 店舗側の注文ID。beatcloudの注文と店舗側の注文とを紐づけるのに利用します。受け付ける文字は半角英数、、ダッシュ |
required | Array of objects (OrderRequestItem) |
{- "dealer_order_id": 101111,
- "items": [
- {
- "product_id": 10,
- "qty": 7
}
]
}{- "id": 33,
- "pending": false,
- "subtotal": 227990,
- "tax_rate": 10,
- "tax": 22799,
- "total": 250789,
- "dealer_order_id": 101111,
- "items": [
- {
- "id": 10,
- "order_id": 10,
- "name": "Your Product Name",
- "product_id": 10,
- "jan": 4530027947492,
- "price": 32570,
- "qty": 7,
- "subtotal": 227990,
- "appendix": "IK Multimedia製品をお買い上げいただき、ありがとうございます。\n\n\nhttps://www.ikmultimedia.com/contact-support/sw/\n\nInteger posuere erat a ante venenatis dapibus posuere velit aliquet. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nullam id dolor id nibh ultricies vehicula ut id elit.\n\n\n www.ikmultimedia.com/pm\n2. Manage My Products > Software > MODO BASS欄にて「Install」、「Authorize」を実行\n",
- "licenses": [
- "xxxxx-xxxxxxx0-xx2",
- 2,
- 3,
- 4,
- 5,
- 6,
- 7
]
}
]
}注文IDを指定して単一の注文情報を取得します。
| orderId required | integer <int64> ID of order that needs to be fetched |
{- "id": 33,
- "pending": false,
- "subtotal": 227990,
- "tax_rate": 10,
- "tax": 22799,
- "total": 250789,
- "dealer_order_id": 101111,
- "items": [
- {
- "id": 10,
- "order_id": 10,
- "name": "Your Product Name",
- "product_id": 10,
- "jan": 4530027947492,
- "price": 32570,
- "qty": 7,
- "subtotal": 227990,
- "appendix": "IK Multimedia製品をお買い上げいただき、ありがとうございます。\n\n\nhttps://www.ikmultimedia.com/contact-support/sw/\n\nInteger posuere erat a ante venenatis dapibus posuere velit aliquet. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nullam id dolor id nibh ultricies vehicula ut id elit.\n\n\n www.ikmultimedia.com/pm\n2. Manage My Products > Software > MODO BASS欄にて「Install」、「Authorize」を実行\n",
- "licenses": [
- "xxxxx-xxxxxxx0-xx2",
- 2,
- 3,
- 4,
- 5,
- 6,
- 7
]
}
]
}