商品マスタ

プロパティ

プロパティ 説明
id [読取専用] ID
商品マスタをユニークに識別するための数値です。主に、APIでのアクセスに使用します。商品コードとは異なります。
code 商品コード
identification_code 識別コード
object_code ロジレスコード
model_number 型番
name [必須] 商品名
name_kana 商品名かな
article_type [必須] 商品区分 - デフォルトは Single
price 価格
tax_indicator 税区分 - デフォルトは Included
tax_rate 税率 - デフォルトは 8
list_price 定価
cost 原価
temperature_control 配送温度
width
height 高さ
depth 奥行き
weight 重さ
attr_1 フリー項目1
attr_2 フリー項目2
attr_3 フリー項目3
attr_4 フリー項目4
attr_5 フリー項目5
attr_6 フリー項目6
attr_7 フリー項目7
attr_8 フリー項目8
attr_9 フリー項目9
attr_10 フリー項目10
comment 備考欄
unit 数量単位
default_delivery_method デフォルトの配送方法
size_coefficient サイズ係数
contents_description 内容品欄
limiting_sales 販売制限数
reorder_point 発注点
created_at [読取専用] 登録日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)
updated_at [読取専用] 更新日時 - Y-m-d H:i:s形式 (例 : 2018-01-01 23:59:59)

エンドポイント

商品マスタの一覧を取得

リクエスト

GET /api/v1/merchant/#{merchant_id}/articles

パラメーター 説明
limit 取得する結果の数 - デフォルトは 20 最大値は 100
page ページ - デフォルトは 1

レスポンス

HTTP/1.1 200

{
  "data":[
    {
      "code": "article-1",
      "name": "商品(1)",
      "article_type": "Single",
      "price": 1000,
      "tax_indicator": "TaxIncluded",
      "temperature_control": "Normal",
      "unit": "個",
      "limiting_sales": 0,
      "created_at": "2017-12-14 16:57:06",
      "updated_at": "2018-01-26 18:56:01"
    }
  ],
  "current_page": 1,
  "limit": 20,
  "total_count": 1
}

商品マスタを登録

リクエスト

POST /api/v1/merchant/#{merchant_id}/articles/new

{
  "article": {
    "name":"商品(1)"
  }
}

レスポンス

HTTP/1.1 201 Created

{
  "id": "16467",
  "code": "2000000164670",
  "object_code": "2000000164670",
  "name": "テスト商品(1)",
  "article_type": "Single",
  "tax_indicator": "TaxIncluded",
  "temperature_control": "Normal",
  "unit": "個",
  "limiting_sales": 0,
  "created_at": "2018-02-07 22:11:16",
  "updated_at": "2018-02-07 22:11:16"
}

商品マスタを編集

リクエスト

PUT /api/v1/merchant/#{merchant_id}/articles/{id}

{
  "article": {
    "name":"テスト商品(1)_編集"
  }
}

レスポンス

HTTP/1.1 200

{
  "id": "16467",
  "code": "2000000164670",
  "object_code": "2000000164670",
  "name": "テスト商品(1)_編集",
  "article_type": "Single",
  "tax_indicator": "TaxIncluded",
  "temperature_control": "Normal",
  "unit": "個",
  "limiting_sales": 0,
  "created_at": "2018-02-07 22:11:16",
  "updated_at": "2018-02-07 22:11:16"
}