仕入先商品登録

POST

/suppliers/{supplier_id}/products

• サンドボックス
• 本番

仕入先商品を登録します。

対象プラン

• スタンダード
• プレミアム
• プレミアムプラス
• フードビジネス
• リテールビジネス

Authorizations

• AppAccessToken
  pos.suppliers:write
• UserAccessToken
  pos.suppliers:write

Parameters

Path Parameters

supplier_id

required

string

仕入先ID

Request Body

object

categoryId

部門ID

部門ID：仕入先で取り扱っている部門のID
※部門IDと商品IDのいずれか必須。（複数指定不可。複数設定された場合はエラー）

string format: int

>= 1 <= 999999999

productId

商品ID

商品ID：仕入先で取り扱っている商品のID
※部門IDと商品IDのいずれか必須。（複数指定不可。複数設定された場合はエラー）

string format: int

>= 1 <= 999999999999999

Example

{
  "categoryId": "123456789",
  "productId": "123456789012345"
}

Responses

200

更新成功

object

supplierId

仕入先ID

string

categoryId

部門ID：仕入先で取り扱っている部門のID。
商品IDで登録された仕入先商品の場合、nullを設定。

string

productId

商品ID：仕入先で取り扱っている商品のID。
部門IDで登録された仕入先商品の場合、nullを設定。

string

insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string

Example

{
  "supplierId": "string",
  "categoryId": "string",
  "productId": "string",
  "insDateTime": "string"
}

400

• 指定された商品IDが存在しない場合
• 指定された部門IDが存在しない場合
• 指定された仕入先で、既に同じ仕入先商品が登録されている場合
• 部門ID、商品IDのいずれも指定されていない場合
• 部門ID、商品IDの両方を指定された場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[productId] 指定された商品IDは存在しません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[categoryId] 指定された部門IDは存在しません。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された仕入先商品はすでに存在しています。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[categoryId] [productId] 部門ID、商品IDのいずれかは必須です。",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "[categoryId] [productId] 部門ID、商品IDはいずれか1つのみ設定してください。",
  "status": 400
}

404

• 指定されたIDが存在しない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}