在庫スイートクラウドAPI

●APIで出来ること

在庫スイートクラウドAPIを使えば、お客様が独自に作成されたシステムから在庫スイートクラウドのデータへのアクセスが可能になります。
例えば Webアプリによる在庫参照、基幹システムとの自動連携、オリジナルのスマートフォンアプリの開発などにも活用できます。

重要な注意事項
本APIの利用には以下の技術スキルや知識が必要となります。
- RESTful APIの基本的な概念とHTTPメソッド（GET,POST,PUT,DELETEなど）の知識
- JSON（JavaScript Object Notation）データフォーマットに関する基本的な知識
- 開発言語に関する基本的な知識（例：Java, C#, Python など）
これらに関する技術的なサポートは提供いたしません。
以上をご理解いただいた上で本APIや関連ドキュメントをご利用ください。

●機能一覧

作業	機能	HTTPメソッド	リソース名	Pro	Lite	棚卸
認証	ログイン	POST	login	○	○	○
認証	ログアウト	POST	logout	○	○	○
システム設定	取得	GET	system_settings	○	○	○
項目名設定	取得	GET	item_names	○	○	○
入荷予定	新規登録	POST	arrival_indications	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	arrival_indications/{伝票番号}
	削除	DELETE	arrival_indications/{伝票番号}
入荷実績	新規登録	POST	arrival_results	○	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	arrival_results/{伝票番号}
	削除	DELETE	arrival_results/{伝票番号}
	倉庫間入荷テンプレート取得	GET	arrival_results/from_shipment/{倉庫間出荷伝票番号}
出荷指示	新規登録	POST	shipment_indications	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	shipment_indications/{伝票番号}
	削除	DELETE	shipment_indications/{伝票番号}
出荷引当	新規登録	POST	shipment_reservations	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	shipment_reservations/{伝票番号}
	削除	DELETE	shipment_reservations/{伝票番号}
出荷指示&出荷引当	新規登録(Draft版)	POST	shipment_indication_reservations	○
出荷実績	新規登録	POST	shipment_results	○	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	shipment_results/{伝票番号}
	削除	DELETE	shipment_results/{伝票番号}
振替	新規登録	POST	transfers	○	○
	更新	PUT
	検索(ヘッダー)	GET
	取得(ヘッダー＋明細)	GET	transfers/{伝票番号}
	削除	DELETE	transfers/{伝票番号}
在庫参照	詳細検索	GET	stocks	○	○	○
在庫参照	品目別検索	GET	stocks_summary	○	○	○
履歴参照	検索	GET	traceability	○	○	○
棚卸	検索(ヘッダー)	GET	inventories	○	○	○
	登録	PUT	inventories
	検索(明細)	GET	inventory_details/{棚卸番号}
品目台帳	登録	PUT	articles	○	○	○
	一部登録	PATCH
	検索	GET
	取得	GET	articles/{Keyコード}
	削除	DELETE	articles/{Keyコード}
倉庫台帳	検索	GET	warehouses	○	○	○
倉庫台帳	取得	GET	warehouses/{倉庫コード}	○	○	○
ロケーション台帳	検索	GET	locations	○	○	○
ロケーション台帳	取得	GET	locations/{ロケーションコード}	○	○	○
仕入先台帳	検索	GET	suppliers	○	○
仕入先台帳	取得	GET	suppliers/{仕入先コード}	○	○
出荷先台帳	検索	GET	customers	○	○
出荷先台帳	取得	GET	customers/{出荷先コード}	○	○
直送先台帳	検索	GET	receivers	○	○
直送先台帳	取得	GET	receivers/{直送先コード}	○	○
理由台帳	検索	GET	reasons	○	○
理由台帳	取得	GET	reasons/{理由コード}	○	○
ユーザー台帳	検索	GET	users	○	○	○
ユーザー台帳	取得	GET	users/{ユーザーID}	○	○	○
API処理の進捗情報	取得	GET	progress_info	○	○	○
API処理の進捗情報	削除	DELETE	progress_info	○	○	○

※各APIの具体的な使用方法や詳細なパラメーターについての最新情報はこちらの開発者ポータルを参照してください。
(APIオプションご契約ユーザーのみ)

●ご利用の前に

在庫スイートクラウドAPIをご利用いただくには、現在のご契約に「APIオプション」のお申込みが必要です。
費用のお見積りやお申込み手続き等については、弊社営業担当までお問い合わせください。
なお、APIオプションご利用の際には、API管理責任者氏名とメールアドレスをご登録いただきます。

API管理責任者

APIオプションの管理・開発・サポート等の御社側窓口となるご担当者様です。
本契約の管理者様と同じ方・別の方いずれでも構いません。
途中での変更も可能です。

メールアドレス

API管理責任者様との各種連絡やプッシュ通知に使用するメールアドレスです。
メールアドレスはサブスクリプションキーと紐づきます。
API管理責任者様を変更される場合もメールアドレスの変更は原則不可能です。
そのため、個人のアドレスではなく組織内の共有アドレスを推奨いたします。
（"zsc_api@xxx.co.jp"など）

やむを得ずメールアドレスを変更される場合は有償対応（3万円（税別））となります。
また、サブスクリプションキーの再発行を伴うため、御社のAPI呼出しプログラムへの反映が必要となります。

●共通仕様

基本的にRESTをベースとした仕様です。

プロトコル
HTTPS
データ形式
JSON（文字コード:UTF-8 エスケープ文字:\）
認証
サブスクリプションキーと在庫スイートクラウドログインによる認証
メソッド
GET(検索・取得) / POST(新規登録) / PUT(更新・登録) / DELETE(削除)
リクエストURL
https://zaikos.azure-api.net/zsc/v1/{リソース名}
レスポンス
HTTPステータスコード 200 は成功。
400以上はエラー。

●制限事項

流量制限

同時接続数上限:20
超過時はエラーレスポンス429（Concurrency limit exceeded）が返ります。
しばらく待ってリトライしてください。
1日のリクエスト回数上限:10,000回
超過時は弊社サポートよりAPI管理責任者様へご連絡させていただきます。
その後サービスのご利用を制限させていただく場合がございます。
※現在のコール回数は、開発者ポータルで確認できます。（サインイン後、上部の「Reports」をクリック）

データ件数の上限

検索時の上限
クエリパラメータを指定して実行する検索では、レスポンスのデータ件数の上限は1,000件です。
検索の該当データが1,000件以上ある場合、オフセットでスキップする件数を指定することで1,000件目以降のデータを検索できます。
オフセットの上限は10万です。
例：10万件分のデータを検索するには、1,000件ずつオフセットを増やしながら100回のAPI呼出を実行。
- 在庫参照のみZIP形式でのダウンロードに対応しております。
  ZIPダウンロード指定時は上限10万件まで一括取得可能です。（オフセット上限は100万）
取得時の上限
URLパスで対象データを複数指定してデータを一括取得する際、指定するキー項目（伝票番号等）のリストの文字数上限は260文字です。
260文字を超えた場合、エラーレスポンス400(Bad Request)が返ります。
リクエストヘッダーで対象データを指定する場合は、上限1,000件まで可能です。
1,000件を超えるデータを取得する際は繰り返しAPI呼出を実行してください。
登録時の上限
一括で登録できるデータ件数の上限は100,000件です。
但し、伝票登録の場合は伝票数ではなく明細数の合計で計算します。
例えば1伝票当たり10明細なら、10,000伝票が一括登録可能です。
これを超えた場合、エラーレスポンス400(BadRequest)が返ります。

仕様変更の可能性

項目追加
リクエストおよびレスポンスのパラメータ・ヘッダー・JSONデータには、今後予告無く項目が追加される可能性があります。
（互換性を考慮し、既存項目の削除や変更がされることはありません。）
機能追加
在庫スイートクラウドの機能追加に伴い、APIの機能も今後予告無く追加される可能性があります。
（互換性を考慮し、既存の機能が削除・変更がされることはありません。）

サービス提供時間

在庫スイートクラウドと同じく、サーバーメンテナンス中はAPIをご利用できません。
その際は原則として事前に契約管理者様へメールでお知らせいたします。
サービス提供に関する詳細は、在庫スイートクラウドサービス約款をご確認ください。

●認証

サブスクリプションキー（固定のトークン）と在庫スイートクラウドログイン（一時的なトークン）の２つを併用した認証方式となります。

サブスクリプションキー

弊社からご契約お客様毎に発行する固定のトークンです。
全ユーザーの全リクエストヘッダーにセットしてください。

ヘッダー名	Ocp-Apim-Subscription-Key
値の例	a8b02e31c7604ec75f6af2e17ddb59da

在庫スイートクラウドログイン

在庫スイートクラウドに登録されたユーザー情報による認証です。
ログインAPIへ下記ヘッダーでID・パスワードを渡すことで、ワンタイムのログイントークンを取得できます。
（※以降、特に表記の無い限り "トークン" はログイントークンを指します）

ヘッダー名	X-Zsc-Authorization
値の例	c3V6dWtpOjAwMDA=	「ID:パスワード」をBASE64変換

トークン例	7a24288e-6299-468d-8d3d-c28ba61e43dd

ログイン後、各リクエストヘッダーにサブスクリプションキーと共にこのトークンをセットしてください。

ヘッダー名	X-Zsc-Token
値の例	7a24288e-6299-468d-8d3d-c28ba61e43dd

トークンの有効期限は24時間です。
期限切れの状態で使用するとエラー401が返ります。
再ログインし、トークンを更新してください。

認証用ヘッダ使用手順イメージ

	サブスクリプションキー認証用ヘッダ	在庫スイートクラウドログイン認証用ヘッダ
ログイン呼出時	Ocp-Apim-Subscription-Key	X-Zsc-Authorization
以降のAPI呼出時	Ocp-Apim-Subscription-Key	X-Zsc-Token

●ユーザー権限

利用可能な権限

在庫スイートの全てのユーザーはAPIを利用可能(ログイン可能)です。
ユーザーの権限により使用できる機能は、PCやスマートフォンアプリ使用時と同じです。
権限と機能の関係については、在庫スイートクラウドマニュアルをご確認ください。

API専用権限について

自動連携用エージェントのような、人の手で操作せず自動でログインするプログラムでは、在庫スイートクラウドのユーザー台帳でAPI専用権限のユーザーを作成してご利用ください。

API専用権限は、全てのAPI機能を使用できますが、標準のPC・スマートフォンアプリではログインできない特殊な権限です。
誤ってそれら端末でログインしてしまうことでトークンが無効になりエージェントが動作しなくなることを防げます。

ユーザー権限	APIの使用	標準のPC・スマートフォンアプリの使用
API専用権限	○ （機能制限なし）	×
その他の権限	○ （権限による制限あり）	○

●一括処理

伝票の新規登録および台帳の登録では、複数データの一括登録に対応しています。
一括登録に関する共通仕様は次の通りです。

登録内容のコミットはAPIコール単位です。
例えば、5件の伝票を一括登録しようとして3件目でエラーが発生した場合、1～2件目の登録はキャンセルされます。
また、もし4～5件目の伝票にエラーがあっても、エラーメッセージは3件目の内容のみが返ります。
一括登録実行中は、同種のデータの一括登録（インポート含む）を同時に行うことはできません。
例えば、APIによる出荷指示の一括登録中はPCアプリによる出荷指示のインポートはできません。
その逆も同様です。
なおこの時、PCアプリ画面からの単票登録は可能です。
その場合一括登録した伝票の伝票番号は連番になりません。
同一ユーザーが同時に複数の一括登録を実行することはできません。
例えば、出荷指示の一括登録中に入荷予定の一括登録を開始することはできません。

なお、削除についても複数データの一括処理に対応しています。
一括削除の場合、一括登録とは異なりコミットがデータ単位になります。
途中で削除できないデータ（例：元々存在しない・在庫がある品目等）があってもエラー終了せず処理が続行されます。

●エラー対応

アクセスログ

APIの呼出し履歴は、在庫スイートクラウドのアクセスログ画面で確認できます。
クライアントVer. ＝ "ZSC API V1 Rev.1" （数字部分はバージョンアップにより更新）
の形式で記録されますので、API呼出のみへの絞り込み検索が可能です。
開発時の検証にご活用ください。

在庫スイートクラウドアクセスログ画面例

HTTPエラーログ

上記アクセスログはAPI側で実行された呼出しの履歴であり、通信エラーが発生した場合は記録されません。
例えば、URLの誤りによるエラーはアクセスログでは分かりません。障害発生時の問題切り分けのため、貴社で開発されるプログラムにて送受信のエラーログ （特にHTTPのエラー内容）を記録されることを強く推奨いたします。

●基本的な使い方

在庫情報の取得と出荷指示の登録・取得を行う場合の基本的な使い方について、リクエストとレスポンスの具体例と共に説明します。
以下の流れでAPIを呼び出します。

ログイン（認証）
在庫情報（詳細在庫）の検索
出荷指示の新規登録
出荷指示の検索と取得
出荷指示の更新
ログアウト

1．ログイン（認証）

サブスクリプションキー「a8b02e31c7604ec75f6af2e17ddb59da」で、ID「suzuki」パスワード「0000」のユーザーがログインする場合

リクエスト：

    POST https://zaikos.azure-api.net/zsc/v1/login
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Authorization: 「ユーザーID:パスワード」をBASE64変換したもの（例：suzuki:0000 は c3V6dWtpOjAwMDA=）
    ボディ
        なし

レスポンス：

    {
        "token": トークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    }

このトークンを使用して以降のAPIを呼び出します。

2．在庫情報（詳細在庫）の検索

この例では、倉庫コード「10」の倉庫に存在するKeyコード「1234」の在庫を検索します。

リクエスト：

    GET https://zaikos.azure-api.net/zsc/v1/stocks?warehouseCode=10&keycode=1234
        「?warehouseCode=10&keycode=1234」の部分が検索条件を指定するクエリパラメータ
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

レスポンス：

3件の在庫情報があった場合の例

    {
        "records": [
            {
                "article": {
                    "keycode": "1234",
                    "articleCode": "0001",
                    "name1": "テスト品目1234",
                    "name2": "",
                    "category": {
                        "code": "01",
                        "name": "部品"
                    },
                    "unit": "個",
                    "image1Url": "",
                    "image2Url": "",
                    "image3Url": "",
                    "thumbnailUrl": ""
                },
                "lot1": "",
                "lot2": "",
                "status": {
                    "code": "00",
                    "name": "通常品"
                },
                "warehouse": {
                    "code": "10",
                    "name": "自社倉庫"
                },
                "location": {
                    "code": "A-03",
                    "zone": {
                        "code": "",
                        "name": ""
                    }
                },
                "existingQuantity": 100,
                "reservedQuantity": 0,
                "unreservedQuantity": 100,
                "updateTime": "2020/01/08 11:30:20"
            },
            {
                "article": {
                    "keycode": "1234",
                    "articleCode": "0001",
                    "name1": "テスト品目1234",
                    "name2": "",
                    "category": {
                        "code": "01",
                        "name": "部品"
                    },
                    "unit": "個",
                    "image1Url": "",
                    "image2Url": "",
                    "image3Url": "",
                    "thumbnailUrl": ""
                },
                "lot1": "",
                "lot2": "",
                "status": {
                    "code": "00",
                    "name": "通常品"
                },
                "warehouse": {
                    "code": "10",
                    "name": "自社倉庫"
                },
                "location": {
                    "code": "A-05",
                    "zone": {
                        "code": "",
                        "name": ""
                    }
                },
                "existingQuantity": 30,
                "reservedQuantity": 0,
                "unreservedQuantity": 30,
                "updateTime": "2020/01/08 11:30:20"
            },
            {
                "article": {
                    "keycode": "1234",
                    "articleCode": "0001",
                    "name1": "テスト品目1234",
                    "name2": "",
                    "category": {
                        "code": "01",
                        "name": "部品"
                    },
                    "unit": "個",
                    "image1Url": "",
                    "image2Url": "",
                    "image3Url": "",
                    "thumbnailUrl": ""
                },
                "lot1": "",
                "lot2": "",
                "status": {
                    "code": "01",
                    "name": "不良品"
                },
                "warehouse": {
                    "code": "10",
                    "name": "自社倉庫"
                },
                "location": {
                    "code": "B-01",
                    "zone": {
                        "code": "",
                        "name": ""
                    }
                },
                "existingQuantity": 12,
                "reservedQuantity": 0,
                "unreservedQuantity": 12,
                "updateTime": "2020/01/08 11:30:20"
            }
        ],
        "matchedCount": 3
    }

検索のレスポンスのレコード件数上限は1,000件のため、検索結果が大量にある場合はオフセットを指定することで1,000件目以降を取得できます。
以下は、検索結果の先頭1,000件をスキップし1,001件目から1,300件目までの300件分を取得する例です。

1,000件目以降を取得するリクエスト例：

    GET https://zaikos.azure-api.net/zsc/v1/stocks?warehouseCode=10&offset=1000&limit=300
        「offset=1000」の部分がオフセット（スキップする件数）を指定するクエリパラメータ
        「limit=300」の部分が取得する件数を指定するクエリパラメータ
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

なお、在庫参照（品目別・詳細）ではZIP形式でのダウンロードを指定することで、レコード件数上限10万件まで一括取得可能です（オフセット上限100万）。
この場合、まず検索処理の開始を示すレスポンスが返り、その後「GET progress_info」によりZIPファイルのダウンロードURLを取得できます。
ZIPファイルには検索結果(JSON形式)が格納されています。ダウンロードの有効期限は、検索完了から24時間です。
（GET progress_info による進捗情報取得方法は、次の「3．出荷指示の新規登録」をご覧ください。）

在庫参照のZIPダウンロード指定リクエスト例：

    GET https://zaikos.azure-api.net/zsc/v1/stocks?warehouseCode=10&zip=true
        「zip=true」によりZIPダウンロードを指定
    ヘッダー指定は他と同様。

ZIPダウンロードURL取得例（検索完了時の進捗情報）：

    {
        "id": "t_yamada",
        "processName": "在庫参照(詳細)(API)",
        "status": "完了",
        "startTime": "2021/03/15 15:38:35",
        "endTime": "2021/03/15 15:38:36",
        "totalCount": 103,
        "doneCount": 103,
        "resultValue": "2476 Bytes",
        "resultUri": "https://zaikosc.blob.core.windows.net/download/stocks_4df024ee-8603-4362-82fa-55f5d3a2e4f7.zip",
        "errorMessage": null,
        "option": null
    }

3．出荷指示の新規登録

この例では、倉庫コード「10」の倉庫に、2件の出荷指示を登録します。

1件目は出荷先コード「004」へ、品目「1234」100個と品目「5678」50個の2明細の出荷指示。
2件目は出荷先コード「006」へ、品目「9876」1,000個の1明細の出荷指示です。

リクエスト：

    POST https://zaikos.azure-api.net/zsc/v1/shipment_indications
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
        X-Zsc-Warehouse: 登録先倉庫の倉庫コード（この例では 10）
    ボディ
    [
        {
            "customer": {
                "code": "004"
            },
            "details": [
                {
                    "article": {
                        "keycode": "1234"
                    },
                    "quantity": 100
                },
                {
                    "article": {
	                    "keycode": "5678"
                    },
                    "quantity": 50
                }
            ]
        },
        {
            "customer": {
                "code": "006"
            },
            "details": [
                {
                    "article": {
                        "keycode": "9876"
                    },
                    "quantity": 1000
                }
            ]
        }
    ]

レスポンス：

ユーザー「user1」が実行した場合の例

    {
        "id": "user1",
        "processName": "出荷指示登録(API)",
        "status": null,
        "startTime": "2020/04/03 15:21:10",
        "endTime": "",
        "totalCount": 2,
        "doneCount": 0,
        "resultValue": null,
        "resultUri": null,
        "errorMessage": null,
        "option": null
    }

このレスポンスは出荷指示2件の登録処理が 2020/04/03 15:21:10 に開始されたことを示しています。
その後、処理の進捗と結果を GET progress_info で取得する必要があります。

登録処理進捗情報取得リクエスト：

    GET https://zaikos.azure-api.net/zsc/v1/progress_info
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

登録処理進捗情報取得レスポンス：

登録成功時の例（"resultValue"に登録された伝票の伝票番号がセットされます）

    {
        "id": "user1",
        "processName": "出荷指示登録(API)",
        "status": null,
        "startTime": "2020/08/17 15:21:10",
        "endTime": "2020/08/17 15:21:14",
        "totalCount": 2,
        "doneCount": 2,
        "resultValue": "伝票番号:3050,3051"
        "resultUri": null,
        "errorMessage": null,
        "option": null
    }

エラー時の例（2件目の伝票のKeyコード「9876」が品目台帳に未登録だった場合）

    {
        "id": "user1",
        "processName": "出荷指示登録(API)",
        "status": null,
        "startTime": "2020/08/17 15:21:10",
        "endTime": "2020/08/17 15:21:13",
        "totalCount": 2,
        "doneCount": 1,
        "resultValue": null,
        "resultUri": null,
        "errorMessage": "2番目の伝票の登録に失敗しました。 明細1行目：　指定されたKeyコードは台帳に未登録です。[9876]",
        "option": null
    }

コミットはAPIコール単位のため、この場合1件目の伝票も登録されません。

4．出荷指示の検索と取得

この例では、まず倉庫コード「10」にある未作業の出荷指示を検索し、次にそれらの明細を含む情報を取得します。

検索のリクエスト：

    GET https://zaikos.azure-api.net/zsc/v1/shipment_indications?warehouseCode=10&workingStatus=未作業
        ※実際には「未作業」等の日本語はURLエンコードされたものを送信してください。
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

レスポンス：

2件の出荷指示が該当した場合の例

    {
        "records": [
            {
                "slipNumber": 3050,
                "workNumber": "",
                "originalNumber": "",
                "slipType": "出荷",
                "slipDate": "2020/08/17",
                "scheduledDate": "2020/08/20",
                "deliveryDate": "2020/08/24",
                "warehouse":{
                    "code": "10",
                    "name": "自社倉庫"
                },
                "user":{
                    "id": "yamada",
                    "name": "山田太郎"
                },
                "customer":{
                    "code": "004",
                    "name1": "出荷先Ａ",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": ""
                },
                "receiver":{
                    "code": "",
                    "name1": "",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": "",
                    "customerCode": ""
                },
                "salesManagement":{
                    "orderNumber": "",
                    "orderOutputDate": "",
                    "shopCode": "",
                    "shopName": "",
                    "customerMail": "",
                    "customerDivision": "",
                    "wholesalerCode": "",
                    "tax": "",
                    "fee": "",
                    "postage": "",
                    "otherCosts": "",
                    "points": "",
                    "paymentTotal": "",
                    "paymentType": "",
                    "paymentMethod": "",
                    "deliveryNoteInstruction": "",
                    "deliveryType": "",
                    "deliveryMethod": "",
                    "deliveryTimeCategory": "",
                    "deliverySlipRemark": "",
                    "giftFlag": "",
                    "deliverySlipNumber": ""
                },
                "invoiceType": "",
                "codPrice": "",
                "destinationWarehouse":{
                    "code": "",
                    "name": ""
                },
                "workingStatus": "未作業",
                "difference": "差異あり",
                "resultSlipNumbers":[],
                "details":[ ],
                "outline": "",
                "registeredDate": "2020/08/17 15:21:14",
                "updatedDate": "2020/08/17 15:21:14"
            },
            {
                "slipNumber": 3051,
                "workNumber": "",
                "originalNumber": "",
                "slipType": "出荷",
                "slipDate": "2020/08/17",
                "scheduledDate": "2020/08/20",
                "deliveryDate": "2020/08/24",
                "warehouse":{
                    "code": "10",
                    "name": "自社倉庫"
                },
                "user":{
                    "id": "yamada",
                    "name": "山田太郎"
                },
                "customer":{
                    "code": "006",
                    "name1": "出荷先Ｂ",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": ""
                },
                "receiver":{
                    "code": "",
                    "name1": "",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": "",
                    "customerCode": ""
                },
                "salesManagement":{
                    "orderNumber": "",
                    "orderOutputDate": "",
                    "shopCode": "",
                    "shopName": "",
                    "customerMail": "",
                    "customerDivision": "",
                    "wholesalerCode": "",
                    "tax": "",
                    "fee": "",
                    "postage": "",
                    "otherCosts": "",
                    "points": "",
                    "paymentTotal": "",
                    "paymentType": "",
                    "paymentMethod": "",
                    "deliveryNoteInstruction": "",
                    "deliveryType": "",
                    "deliveryMethod": "",
                    "deliveryTimeCategory": "",
                    "deliverySlipRemark": "",
                    "giftFlag": "",
                    "deliverySlipNumber": ""
                },
                "invoiceType": "",
                "codPrice": "",
                "destinationWarehouse":{
                    "code": "",
                    "name": ""
                },
                "workingStatus": "未作業",
                "difference": "差異あり",
                "resultSlipNumbers":[],
                "details":[ ],
                "outline": "",
                "registeredDate": "2020/08/17 15:21:14",
                "updatedDate": "2020/08/17 15:21:14"
            }
        ],
        "matchedCount": 2
    }

このレスポンスから、未作業状態の出荷指示は先程登録した2件（伝票番号3050と3051）であることが分かりました。
次に、それらの出荷指示の明細を含む伝票情報全体を取得します。

取得のリクエスト：

    GET https://zaikos.azure-api.net/zsc/v1/shipment_indications/3050,3051
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

レスポンス：

1件目（伝票番号3050）は2明細、2件目（伝票番号3051）は1明細の場合の例

    {
        "records": [
            {
                "slipNumber": 3050,
                "workNumber": "",
                "originalNumber": "",
                "slipType": "出荷",
                "slipDate": "2020/08/17",
                "scheduledDate": "2020/08/20",
                "deliveryDate": "2020/08/24",
                "warehouse":{
                    "code": "10",
                    "name": "自社倉庫"
                },
                "user":{
                    "id": "yamada",
                    "name": "山田太郎"
                },
                "customer":{
                    "code": "004",
                    "name1": "出荷先Ａ",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": ""
                },
                "receiver":{
                    "code": "",
                    "name1": "",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": "",
                    "customerCode": ""
                },
                "salesManagement":{
                    "orderNumber": "",
                    "orderOutputDate": "",
                    "shopCode": "",
                    "shopName": "",
                    "customerMail": "",
                    "customerDivision": "",
                    "wholesalerCode": "",
                    "tax": "",
                    "fee": "",
                    "postage": "",
                    "otherCosts": "",
                    "points": "",
                    "paymentTotal": "",
                    "paymentType": "",
                    "paymentMethod": "",
                    "deliveryNoteInstruction": "",
                    "deliveryType": "",
                    "deliveryMethod": "",
                    "deliveryTimeCategory": "",
                    "deliverySlipRemark": "",
                    "giftFlag": "",
                    "deliverySlipNumber": ""
                },
                "invoiceType": "",
                "codPrice": "",
                "destinationWarehouse":{
                    "code": "",
                    "name": ""
                },
                "workingStatus": "未作業",
                "difference": "差異あり",
                "resultSlipNumbers":[],
                "details":[
                    {
                        "detailNumber": 1,
                        "article":{
                            "keycode": "1234",
                            "articleCode": "",
                            "name1": "商品1234",
                            "name2": "",
                            "packagedQuantity": 0.000,
                            "unit": "個"
                        },
                        "lot1": "",
                        "lot2": "",
                        "stockStatus":{
                            "code": "00",
                            "name": "通常品"
                        },
                        "locationCode": "",
                        "boxes": 0,
                        "quantity": 100.000,
                        "remark": "",
                        "undoneQuantity": 100.000,
                        "reservationUndoneQuantity": 0.0,
                        "sellingUnitPrice": "",
                        "updatedDate": "2020/08/17 18:01:44"
                    },
                    {
                        "detailNumber": 2,
                        "article":{
                            "keycode": "5678",
                            "articleCode": "",
                            "name1": "テスト品目5678",
                            "name2": "",
                            "packagedQuantity": 0.000,
                            "unit": ""
                        },
                        "lot1": "",
                        "lot2": "",
                        "stockStatus":{
                            "code": "00",
                            "name": "通常品"
                        },
                        "locationCode": "",
                        "boxes": 0,
                        "quantity": 50.000,
                        "remark": "",
                        "undoneQuantity": 50.000,
                        "reservationUndoneQuantity": 0.0,
                        "sellingUnitPrice": "",
                        "updatedDate": "2020/08/17 15:21:14"
                    }
                ],
                "outline": "",
                "registeredDate": "2020/08/17 15:21:14",
                "updatedDate": "2020/08/17 15:21:14"
            },
            {
                "slipNumber": 3051,
                "workNumber": "",
                "originalNumber": "",
                "slipType": "出荷",
                "slipDate": "2020/08/17",
                "scheduledDate": "2020/08/20",
                "deliveryDate": "2020/08/24",
                "warehouse":{
                    "code": "10",
                    "name": "自社倉庫"
                },
                "user":{
                    "id": "yamada",
                    "name": "山田太郎"
                },
                "customer":{
                    "code": "006",
                    "name1": "出荷先Ｂ",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": ""
                },
                "receiver":{
                    "code": "",
                    "name1": "",
                    "name2": "",
                    "kana": "",
                    "shortName": "",
                    "person": "",
                    "respectName": "",
                    "postalCode": "",
                    "address1": "",
                    "address2": "",
                    "tel": "",
                    "fax": "",
                    "customerCode": ""
                },
                "salesManagement":{
                    "orderNumber": "",
                    "orderOutputDate": "",
                    "shopCode": "",
                    "shopName": "",
                    "customerMail": "",
                    "customerDivision": "",
                    "wholesalerCode": "",
                    "tax": "",
                    "fee": "",
                    "postage": "",
                    "otherCosts": "",
                    "points": "",
                    "paymentTotal": "",
                    "paymentType": "",
                    "paymentMethod": "",
                    "deliveryNoteInstruction": "",
                    "deliveryType": "",
                    "deliveryMethod": "",
                    "deliveryTimeCategory": "",
                    "deliverySlipRemark": "",
                    "giftFlag": "",
                    "deliverySlipNumber": ""
                },
                "invoiceType": "",
                "codPrice": "",
                "destinationWarehouse":{
                    "code": "",
                    "name": ""
                },
                "workingStatus": "未作業",
                "difference": "差異あり",
                "resultSlipNumbers":[],
                "details":[
                    {
                        "detailNumber": 1,
                        "article":{
                            "keycode": "9876",
                            "articleCode": "",
                            "name1": "テスト品目9876",
                            "name2": "",
                            "packagedQuantity": 0.000,
                            "unit": "個"
                        },
                        "lot1": "",
                        "lot2": "",
                        "stockStatus":{
                            "code": "00",
                            "name": "通常品"
                        },
                        "locationCode": "",
                        "boxes": 0,
                        "quantity": 1,000.000,
                        "remark": "",
                        "undoneQuantity": 1,000.000,
                        "reservationUndoneQuantity": 0.0,
                        "sellingUnitPrice": "",
                        "updatedDate": "2020/08/17 15:21:14"
                    }
                ],
                "outline": "",
                "registeredDate": "2020/08/17 15:21:14",
                "updatedDate": "2020/08/17 15:21:14"
            }
        ],
        "matchedCount": 2
    }

5．出荷指示の更新

この例では、出荷指示の検索と取得で取得した2件目の伝票（伝票番号3051）を次のように変更します。

作業番号(workNumber) なし → "ABC012"
数量(quantity) 1,000 → 2,000

リクエストボディのJSONデータには、更新しない項目も省略せずセットしてください。
省略された項目は、新規登録時と同じルールでデフォルト値または空になります。
そのため、基本的には下記例のように、取得したJSONデータをそのまま変更して使用することをお薦めします。
（作業状態(workingStatus)や更新日時(updatedDate)など、登録/更新不可の項目は無視されます。）

なお、更新は複数データ一括登録に対応していません。
JSONデータの形式は共通ですが、含められるデータは伝票一件のみです。

リクエスト：

    POST https://zaikos.azure-api.net/zsc/v1/shipment_indications
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
        X-Zsc-Warehouse: 登録先倉庫の倉庫コード（この例では 10）
    ボディ
    [
        {
            "slipNumber": 3051,
            "workNumber": "ABC012",
            "originalNumber": "",
            "slipType": "出荷",
            "slipDate": "2020/08/17",
            "scheduledDate": "2020/08/20",
            "deliveryDate": "2020/08/24",
            "warehouse":{
                "code": "10",
                "name": "自社倉庫"
            },
            "user":{
                "id": "yamada",
                "name": "山田太郎"
            },
            "customer":{
                "code": "006",
                "name1": "出荷先Ｂ",
                "name2": "",
                "kana": "",
                "shortName": "",
                "person": "",
                "respectName": "",
                "postalCode": "",
                "address1": "",
                "address2": "",
                "tel": "",
                "fax": ""
            },
            "receiver":{
                "code": "",
                "name1": "",
                "name2": "",
                "kana": "",
                "shortName": "",
                "person": "",
                "respectName": "",
                "postalCode": "",
                "address1": "",
                "address2": "",
                "tel": "",
                "fax": "",
                "customerCode": ""
            },
            "salesManagement":{
                "orderNumber": "",
                "orderOutputDate": "",
                "shopCode": "",
                "shopName": "",
                "customerMail": "",
                "customerDivision": "",
                "wholesalerCode": "",
                "tax": "",
                "fee": "",
                "postage": "",
                "otherCosts": "",
                "points": "",
                "paymentTotal": "",
                "paymentType": "",
                "paymentMethod": "",
                "deliveryNoteInstruction": "",
                "deliveryType": "",
                "deliveryMethod": "",
                "deliveryTimeCategory": "",
                "deliverySlipRemark": "",
                "giftFlag": "",
                "deliverySlipNumber": ""
            },
            "invoiceType": "",
            "codPrice": "",
            "destinationWarehouse":{
                "code": "",
                "name": ""
            },
            "workingStatus": "未作業",
            "difference": "差異あり",
            "resultSlipNumbers":[],
            "details":[
                {
                    "detailNumber": 1,
                    "article":{
                        "keycode": "9876",
                        "articleCode": "",
                        "name1": "テスト品目9876",
                        "name2": "",
                        "packagedQuantity": 0.000,
                        "unit": "個"
                    },
                    "lot1": "",
                    "lot2": "",
                    "stockStatus":{
                        "code": "00",
                        "name": "通常品"
                    },
                    "locationCode": "",
                    "boxes": 0,
                    "quantity": 2,000,
                    "remark": "",
                    "undoneQuantity": 1,000.000,
                    "reservationUndoneQuantity": 0.0,
                    "sellingUnitPrice": "",
                    "updatedDate": "2020/08/17 15:21:14"
                }
            ],
            "outline": "",
            "registeredDate": "2020/08/17 15:21:14",
            "updatedDate": "2020/08/17 15:21:14"
        }
    ]

レスポンス：

    {
        "id": "user1",
        "processName": "出荷指示登録(API)",
        "status": null,
        "startTime": "2020/08/20 15:21:10",
        "endTime": "",
        "totalCount": 1,
        "doneCount": 0,
        "resultValue": null,
        "resultUri": null,
        "errorMessage": null,
        "option": null
    }

レスポンスの内容は新規登録時と同様です。
また、処理結果の取得方法(GET progress_info)も同様です。

6．ログアウト

プログラム終了等のタイミングでログアウトします。

リクエスト：

    POST https://zaikos.azure-api.net/zsc/v1/logout
    ヘッダー
        Ocp-Apim-Subscription-Key: サブスクリプションキー（例：a8b02e31c7604ec75f6af2e17ddb59da）
        X-Zsc-Token: ログインで取得したトークン（例：7a24288e-6299-468d-8d3d-c28ba61e43dd）
    ボディ
        なし

レスポンス：

    {
        "message": "Success"
    }

●サポート

詳細なAPIリファレンス

開発者ポータル（APIオプションご契約ユーザーのみ）
各APIの具体的な使用方法や詳細なパラメーターについてはこちらの開発者ポータルを参照してください。

PDFファイル
PDF形式のAPIリファレンスです。
ダウンロード後、ZIPを展開してご覧ください。
- APIオプションご契約ユーザー様は上記開発者ポータルをご覧ください。

バージョン履歴

APIオプションのバージョン情報はこちらを参照してください。

お問い合わせ

APIオプション契約の詳細については、弊社営業担当までお問合せください。

TEL：045-472-0938
メール：trial@infusion.co.jp

APIの技術的なご質問については、上記開発者ポータルの問合せフォーム（推奨）へご入力いただくか、弊社サポートメールにて受け付けております。（APIオプション契約ユーザーのみ）

サポート範囲：APIの仕様・動作・稼働状況について
期待通りの結果が得られない場合、HTTPリクエストやエラーレスポンス等の具体的な内容（URL・ヘッダ・ボディ）をご連絡ください。
※API呼び出し側のプログラムの言語仕様・開発環境・動作環境等についてはサポート対象外です。
回答はAPI管理責任者のメールアドレス宛てに返信いたします。
一次回答は翌営業日中にお送りします。
電話によるお問合せは受付けておりません。
弊社サポートメール support@infusion.co.jp

目次

●APIで出来ること

●機能一覧

●ご利用の前に

API管理責任者

メールアドレス

●共通仕様

●制限事項

流量制限

データ件数の上限

仕様変更の可能性

サービス提供時間

●認証

サブスクリプションキー

在庫スイートクラウドログイン

認証用ヘッダ使用手順イメージ

●ユーザー権限

利用可能な権限

API専用権限について

●一括処理

●エラー対応

アクセスログ

HTTPエラーログ

●基本的な使い方

1．ログイン（認証）

リクエスト：

レスポンス：

2．在庫情報（詳細在庫）の検索

リクエスト：

レスポンス：

1,000件目以降を取得するリクエスト例：

在庫参照のZIPダウンロード指定リクエスト例：

ZIPダウンロードURL取得例（検索完了時の進捗情報）：

3．出荷指示の新規登録

リクエスト：

レスポンス：

登録処理進捗情報取得リクエスト：

登録処理進捗情報取得レスポンス：

4．出荷指示の検索と取得

検索のリクエスト：

レスポンス：

取得のリクエスト：

レスポンス：

5．出荷指示の更新

リクエスト：

レスポンス：

6．ログアウト

リクエスト：

レスポンス：

●サポート

詳細なAPIリファレンス

バージョン履歴

お問い合わせ