得意先マスタのデータを取得・変更する

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

得意先マスタのデータを取得する

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

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

補足

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

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

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

リクエスト


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

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

リクエストボディ
{
　"cd": 得意先コード,
　"name": 得意先名称,
　"is_display_price": 単価金額表示フラグ（0：非表示、1：表示）,
　"is_item_control": 商品制御フラグ（0：制御しない、1：制御する）,
　"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で小数点以下切上）,
　"customers":[
　　{
　　　"id": 得意先のid,
　　　"cd": 得意先コード,
　　　"name": 得意先名称,
　　　"is_display_price": 単価金額表示フラグ,
　　　"is_item_control": 商品制御フラグ,
　　　"created_at": 登録日時,
　　　"updated_at": 更新日時
　　},
　　{
　　　※ヒットしたデータ件数分、繰り返し
　　}
　]
}

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

補足

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

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

補足

得意先マスタのデータを追加する

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

リクエスト


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

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

リクエストボディ
{
　"cd": 得意先コード,
　"name": 得意先名称,
　"is_display_price": 単価金額表示フラグ（0：非表示、1：表示）,
　"is_item_control": 商品制御フラグ（0：制御しない、1：制御する）
}

レスポンス


項目
説明
ステータス
201:Created
レスポンスボディ
{
　"id": 得意先のid,
　"cd": 得意先コード,
　"name": 得意先名称,
　"is_display_price": 単価金額表示フラグ,
　"is_item_control": 商品制御フラグ,
　"created_at": 登録日時,
　"updated_at": 更新日時
}

補足

得意先マスタのデータを更新する

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

リクエスト


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

id：更新する得意先のid

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

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

リクエストボディ
{
　"cd": 得意先コード,
　"name": 得意先名称,
　"is_display_price": 単価金額表示フラグ（0：非表示、1：表示）,
　"is_item_control": 商品制御フラグ（0：制御しない、1：制御する）
}

レスポンス


項目
説明
ステータス
200:OK
レスポンスボディ
{
　"id": 得意先のid,
　"cd": 得意先コード,
　"name": 得意先名称,
　"is_display_price": 単価金額表示フラグ,
　"is_item_control": 商品制御フラグ,
　"created_at": 登録日時,
　"updated_at": 更新日時
}

補足

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

得意先マスタのデータを削除する

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

補足

得意先を削除すると、その得意先に紐付いている、以下のマスタデータも削除されます。

  • 店舗マスタ
  • 担当者マスタ
  • 得意先別店舗別商品マスタ
  • 得意先別店舗別単価マスタ
  • 数量入力区分マスタ

リクエスト


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

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

リクエストボディ
{
　"customers":[
　　{
　　　"cd": 得意先コード,
　　　"name": 得意先名称,
　　　"is_display_price": 単価金額表示フラグ（0：非表示、1：表示）,
　　　"is_item_control": 商品制御フラグ（0：制御しない、1：制御する）,
　　　"delete": 削除フラグ（0：削除しない、1：削除する）
　　},
　　{
　　　"id": 得意先のid　※削除を行う場合の代わりの記述方法
　　},
　　{
　　　※追加・更新・削除するデータ件数分、繰り返し
　　}
　]
}

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

レスポンス


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

補足

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

補足

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