発注データをダウンロードする
発注データをダウンロードする際の、リクエストとレスポンスの記述内容について説明します。
得意先コードや登録日時などの検索条件を付けて、必要なデータだけダウンロードすることもできます。
指定できる検索条件は、Pittaly Order Webアプリのデータダウンロード画面と同じです。
例えば、リクエストボディで得意先コードを指定すると、データダウンロード画面で得意先コードを指定した場合と同じ結果を得ることができます。
発注データは、1回につき500件までダウンロードできます。500件を1ページとして、必要なページを指定してください。500件を超えるデータをダウンロードする場合は、ページをずらして繰り返しダウンロードしてください。
例："page": 1を指定した場合、最初の1件～500件目のデータをダウンロードします。
"page": 2を指定した場合、501件～1000件目のデータをダウンロードします。
リクエスト
| 項目 | 説明 |
|---|---|
| URL |
https://pittaly-order.uskcloud.com/api/v2/downloadResults.json
|
| HTTPメソッド | GET |
| ヘッダ | content-type: application/json Authorization: Basic <Base64値> Base64値："<メールアドレス>:<パスワード>"をBase64で変換したもの。例：pittaly@usknet.co.jp:abcde123 →cGl0dGFseUB1c2tuZXQuY28uanA6YWJjZGUxMjM= |
| リクエストボディ | { "created_at_from": 登録日時（開始値）, "created_at_to": 登録日時（終了値）, "jobno_from": ジョブNo（開始値）, "jobno_to": ジョブNo（終了値）, "operation_cd_from": 業務区分コード（開始値）, "operation_cd_to": 業務区分コード（終了値）, "customer_cd": 得意先コード, "store_cd_from: 店舗コード（開始値）, "store_cd_to": 店舗コード（終了値）, "staff_cd_from": 担当者コード（開始値）, "staff_cd_to": 担当者コード（終了値）, "price_total_from": 合計金額（開始値）, "price_total_to": 合計金額（終了値）, "export": 出力済フラグ（0：未出力、1：出力済）, "page": ページ } "page"は必須条件です。 指定のない項目については、すべてのデータが対象になります。ただし、"export"については「0」が指定されます。 "export"で「0」を指定すると、ダウンロードしていないデータが対象となります。「1」を指定すると、ダウンロード済みのデータが対象となります。 |
レスポンス
| 項目 | 説明 |
|---|---|
| ステータス | 200:OK |
| レスポンスボディ | { "totalCount": 件数（ヒットしたデータ件数）, "current_page": 現在ページ数, "max_page": 最大ページ数（ヒットしたデータ件数÷500で小数点以下切上）, "results":[ { "result_date": 処理日付, "customer_cd": 得意先コード, "customer_name": 得意先名称, "store_cd": 店舗コード, "store_name": 店舗名称, "staff_cd": 担当者コード, "staff_name": 担当者名称, "operation_cd": 業務区分コード, "operation_name": 業務区分名称, "jobno": ジョブNo, "price_total": 合計金額, "reserved01": ヘッダ予備01, "reserved02": ヘッダ予備02, "reserved03": ヘッダ予備03, "reserved04": ヘッダ予備04, "reserved05": ヘッダ予備05, "reserved06": ヘッダ予備06, "reserved07": ヘッダ予備07, "reserved08": ヘッダ予備08, "reserved09": ヘッダ予備09, "reserved10": ヘッダ予備10, "reserved11": ヘッダ予備11, "reserved12": ヘッダ予備12, "reserved13": ヘッダ予備13, "reserved14": ヘッダ予備14, "reserved15": ヘッダ予備15, "uuid": 端末認証コード, "created_at": 登録日時, "bodies":[ { "row_number": 行番号, "result_time": 処理時刻, "item_cd": 商品コード, "jan_cd": JANコード, "name": 商品名称, "kind": 商品区分, "unit_price": 商品単価, "carton": 商品入数, "unit_quantity": ケース数, "quantity": バラ数, "quantity_total": 数量合計, "price": 金額, "reserved01": 明細予備01, "reserved02": 明細予備02, "reserved03": 明細予備03, "reserved04": 明細予備04, "reserved05": 明細予備05, "reserved06": 明細予備06, "reserved07": 明細予備07, "reserved08": 明細予備08, "reserved09": 明細予備09, "reserved10": 明細予備10, "reserved11": 明細予備11, "reserved12": 明細予備12, "reserved13": 明細予備13, "reserved14": 明細予備14, "reserved15": 明細予備15, }, { ※データ内の行数（明細）分、繰り返し } ] }, { ※ヒットしたデータ件数分、繰り返し } ] } 対象データがない場合は、"totalCount": 件数のみ |
発注データをダウンロードする場合は、検索対象の絞り込みに、比較演算子などは利用できません。
- "created_at_from"と"created_at_to"は、年月日（yyyy/MM/dd）または年月日＋時分秒（yyyy/MM/dd HH:mm:ss）の指定が可能です。
- 年月日のみ指定した場合は、以下のように時分秒が補完されます。
-"created_at_from": 指定の年月日＋"00:00:00"
-"created_at_to": 指定の年月日＋"23:59:59"
例1："created_at_from"に"2024/07/01"を指定した場合 →created_at_from＝"2024/07/01 00:00:00"となります。
例2："created_at_to"に"2024/07/15"を指定した場合 →created_at_to＝"2024/07/15 23:59:59"となります。
- 取得したデータの"export"の値は、「1」（出力済）に更新されます。
- ダウンロードした発注データの、各項目のデータ型や文字数については、「発注データの各項目のデータ型・文字数」を参照してください。
- 検索条件はURLに付加することもできます。詳細は、「検索条件をURLに付加するには？」を参照してください。
- エラー発生時のレスポンスについては、「エラーコードが返されたときは？」を参照してください。
レスポンスが返ってこなかった（タイムアウトした）場合、検索対象データの"export"の値が「1」（出力済）に更新されてしまう可能性があります。
再度リクエストを行う際に、"export"で「0」（未出力）を指定しても該当のデータがヒットしない場合は、「1」（出力済）を指定してください。