商品マスタのデータを取得・変更する

商品マスタデータの取得と変更（追加・削除・更新・一括アップロード）について説明します。

商品マスタのデータを取得する

商品マスタのデータを取得する際の、リクエストとレスポンスの記述内容について説明します。

商品コードや更新日時などの検索条件を付けて、必要なデータだけ取得することもできます。

補足

マスタデータは、1回につき500件まで取得できます。500件を1ページとして、必要なページを指定してください。500件を超えるデータを取得する場合は、必要なページを指定して繰り返し取得してください。

例："page": 1を指定した場合、最初の1件～500件目のデータを取得します。

"page": 2を指定した場合、501件～1000件目のデータを取得します。

リクエスト


項目
説明
URL
 https://pittaly-order.uskcloud.com/api/v2/items
HTTPメソッド
GET
ヘッダ
content-type: application/json
Authorization: Basic <Base64値>

Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123　　→cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM=

リクエストボディ
{
　"item_cd": 商品コード,
　"barcode": バーコード,
　"name": 商品名称,
　"kind": 分類名称,
　"unit_price": 価格,
　"carton": 入数,
　"quantity_input_type": 数量入力区分（0：ケース／バラ、1：ケースのみ、2：バラのみ）,
　"created_at": 登録日時（yyyy/MM/dd HH:mm:ss）,
　"updated_at": 更新日時（yyyy/MM/dd HH:mm:ss）,
　"page": ページ
}

"page"は必須条件です。

指定のない項目については、すべてのデータが対象になります。

レスポンス


項目
説明
ステータス
200:OK
レスポンスボディ
{
　"totalCount": 件数（ヒットしたデータ件数）,
　"current_page": 現在ページ数,
　"max_page": 最大ページ数（ヒットしたデータ件数÷500で小数点以下切上）,
　"items":[
　　{
　　　"id": 商品のid,
　　　"item_cd": 商品コード,
　　　"barcode": バーコード,
　　　"name": 商品名称,
　　　"kind": 分類名称,
　　　"unit_price": 価格,
　　　"carton": 入数,
　　　"quantity_input_type": 数量入力区分,
　　　"created_at": 登録日時,
　　　"updated_at": 更新日時
　　},
　　{
　　　※ヒットしたデータ件数分、繰り返し
　　}
　]
}

対象データがない場合は、"totalCount": 件数のみ

補足

登録日時や更新日時などで、日付のみ指定して時分秒を指定しない場合、検索対象は以下のようになります。

例："created_at": "2024/01/01"→「2024/01/01 00:00:00と等しいデータ」

補足

商品マスタのデータを追加する

商品マスタのデータを追加する際の、リクエストとレスポンスの記述内容について説明します。

リクエスト


項目
説明
URL
 https://pittaly-order.uskcloud.com/api/v2/items
HTTPメソッド
POST
ヘッダ
content-type: application/json
Authorization: Basic <Base64値>

Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123　　→cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM=

リクエストボディ
{
　"item_cd": 商品コード,
　"barcode": バーコード,
　"name": 商品名称,
　"kind": 分類名称,
　"unit_price": 価格,
　"carton": 入数,
　"quantity_input_type": 数量入力区分（0：ケース／バラ、1：ケースのみ、2：バラのみ）
}

"kind"は省略可能です。

レスポンス


項目
説明
ステータス
201:Created
レスポンスボディ
{
　"id": 商品のid,
　"item_cd": 商品コード,
　"barcode": バーコード,
　"name": 商品名称,
　"kind": 分類名称,
　"unit_price": 価格,
　"carton": 入数,
　"quantity_input_type": 数量入力区分,
　"created_at": 登録日時,
　"updated_at": 更新日時
}

補足

商品マスタのデータを更新する

商品マスタのデータを更新する際の、リクエストとレスポンスの記述内容について説明します。

リクエスト


項目
説明
URL
 https://pittaly-order.uskcloud.com/api/v2/items/<id>

id：更新する商品のid

HTTPメソッド
PUT
ヘッダ
content-type: application/json
Authorization: Basic <Base64値>

Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123　　→cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM=

リクエストボディ
{
　"item_cd": 商品コード,
　"barcode": バーコード,
　"name": 商品名称,
　"kind": 分類名称,
　"unit_price": 価格,
　"carton": 入数,
　"quantity_input_type": 数量入力区分（0：ケース／バラ、1：ケースのみ、2：バラのみ）
}

"kind"は省略可能です。

レスポンス


項目
説明
ステータス
200:OK
レスポンスボディ
{
　"id": 商品のid,
　"item_cd": 商品コード,
　"barcode": バーコード,
　"name": 商品名称,
　"kind": 分類名称,
　"unit_price": 価格,
　"carton": 入数,
　"quantity_input_type": 数量入力区分,
　"created_at": 登録日時,
　"updated_at": 更新日時
}

補足

エラー発生時のレスポンスについては、「エラーコードが返されたときは？」を参照してください。

商品マスタのデータを削除する

商品マスタのデータを削除する際の、リクエストとレスポンスの記述内容について説明します。

リクエスト


項目
説明
URL
 https://pittaly-order.uskcloud.com/api/v2/items/<id>

id：削除する商品のid

HTTPメソッド
DELETE
ヘッダ
content-type: application/json
Authorization: Basic <Base64値>

Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123　　→cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM=

リクエストボディ

なし

レスポンス


項目
説明
ステータス
204:No Content
レスポンスボディ
{
}

補足

エラー発生時のレスポンスについては、「エラーコードが返されたときは？」を参照してください。

商品マスタのデータを一括アップロードする

商品マスタのデータを一括アップロード（追加・更新・削除）する際の、リクエストとレスポンスの記述内容について説明します。

リクエスト


項目
説明
URL
 https://pittaly-order.uskcloud.com/api/v2/items/batchUpload.json
HTTPメソッド
POST
ヘッダ
content-type: application/json
Authorization: Basic <Base64値>

Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123　　→cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM=

リクエストボディ
{
　"items":[
　　{
　　　"item_cd": 商品コード,
　　　"barcode": バーコード,
　　　"name": 商品名称,
　　　"kind": 分類名称,
　　　"unit_price": 価格,
　　　"carton": 入数,
　　　"quantity_input_type": 数量入力区分（0：ケース／バラ、1：ケースのみ、2：バラのみ）,
　　　"delete": 削除フラグ（0：削除しない、1：削除する）
　　},
　　{
　　　"id": 商品のid　※削除を行う場合の代わりの記述方法
　　},
　　{
　　　※追加・更新・削除するデータ件数分、繰り返し
　　}
　]
}

"kind"は省略可能です。

"delete"は省略可能です。その場合、データの追加または更新が行われます。

レスポンス


項目
説明
ステータス
200:OK
レスポンスボディ
{
　"totalCount": 処理件数（追加・更新・削除した件数）
}

補足

一括アップロードできるデータは、100件までです。

補足

エラー発生時のレスポンスについては、「エラーコードが返されたときは？」を参照してください。