次の方法で共有

Commerce Scale Unit の顧客およびコンシューマー API

ノート

Dynamics 365 Commerce の小売関連グループは、Yammer から Viva Engage に移行しました。 新しいViva Engage コミュニティにアクセスできない場合は、追加するフォーム (https://aka.ms/JoinD365commerceVivaEngageCommunity) に入力し、最新のディスカッションに参加してください。

この記事では、さまざまなロールで使用でき、さまざまなクライアントが使用できるコマース スケール ユニット (CSU) アプリケーション プログラミング インターフェイス (API) の概要について説明します。 中心は、顧客フェーシング アプリケーション クライアントと eコマース クライアントについてです。

  • 接続されているデバイスは、OData Web API を介して Commerce Scale Unit のビジネス データと操作にアクセスでき、従業員 (販売時点管理) シナリオと顧客 (オンライン ストア) シナリオの両方をサポートします。
  • 埋め込みコマース ランタイム (CRT) は、統合されたオムニチャネル プラットフォームを提供します。
  • API はステートレスであり、多くのチャネルからの要求を処理できます。
  • API では、線形スケールアウト モデル ("ブリック" スケールアウト) が使用されます。
  • プラグアンドプレイのカスタマイズに対して、合成パターンを使用します。
  • API は、C# を使用して .NET スタック上に構築されます。

ロール

コマース スケール ユニットに対するすべての要求 (コマース プロキシ経由) では、次の主な役割が使用されます。

  • CommerceRole.Employee
  • CommerceRole.Anonymous
  • CommerceRole.Customer
  • CommerceRoleアプリケーション
  • CommerceRole.BusinessPartnerEmployee

匿名ロールと顧客ロールは、eコマース (顧客/コンシューマー) のシナリオに適用されます。 サインインしていない e コマース顧客を表す要求には、匿名ロールを使用します。 認証されてサインインした e コマース顧客を表す要求には、顧客ロールを使用します。 ロール フィルターは、CSU が公開するすべての API に適用されます。 電子商取引シナリオでは、関連する CommerceRole.Anonymous または CommerceRole.Customer ロールのいずれかを持つ API のみを使用することができます。 BusinessPartnerEmployee ロールは、企業間 (B2B2B) シナリオの販売者チャネルで働く請負業者を表す要求に使用します。

ノート

既定では、匿名アクセスは有効になっていません。 環境に対して匿名アクセスを有効にするには、 サポートにお問い合わせください。

顧客のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetOrderShipmentsHistory string accountNumber、QueryResultSettings queryResultSettings ページ結果注文出荷 従業員、顧客、アプリケーション 顧客からの注文の出荷履歴を取得します
CreateEntity 顧客 顧客 従業員、匿名、アプリケーション 顧客を作成します。
UpdateEntity 文字列キー、顧客の更新 顧客 従業員、顧客、アプリケーション 顧客を更新します。
GetOrderHistory string accountNumber、QueryResultSettings queryResultSettings ページ結果受注 従業員、顧客、アプリケーション 一群の販売注文を返します。
Search CustomerSearchCriteria customerSearchCriteria、QueryResultSettings queryResultSettings ページ結果グローバル顧客 従業員、アプリケーション 顧客を検索します
GetPurchaseHistory string accountNumber、QueryResultSettings queryResultSettings ページ結果購入履歴 従業員、顧客、アプリケーション 顧客の購入履歴を取得します
GetByAccountNumbers IEnumerablestring accountNumbers、int searchLocationValue、QueryResultSettings queryResultSettings IEnumerableCustomer 従業員、顧客、アプリケーション 顧客のアカウント番号一覧から顧客リストを取得します
GetCustomerSearchFields queryResultSettings IEnumerableCustomerSearchField 従業員、顧客、アプリケーション 本社の店舗セットが使用する顧客検索フィールドを取得します
SearchByFields 顧客エンティティ 全世界顧客情報結果ページ 従業員、顧客、アプリケーション 指定したフィールドで顧客を検索します
PostNonTransactionalActivityLoyaltyPoints loyaltyCardNumber string型, channelId Long型, affiliationId Long型, activityTypeId string型 無効 従業員、顧客、アプリケーション 非トランザクション アクティビティ ロイヤルティ ポイントを投稿する

販売注文のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetReceipts string ID、ReceiptRetrievalCriteria receiptRetrievalCriteria、QueryResultSettings queryResultSettings ページ結果レシート 従業員 印刷用の formTypes に基づいてレシートのセットを取得します。
GetGiftReceipts string ID、IEnumerabledecimal salesLineNumbers、ReceiptRetrievalCriteria receiptRetrievalCriteria、QueryResultSettings queryResultSettings ページ結果レシート 従業員 贈答品の受領を取得します
GetByReceiptId string receiptId、string orderStoreNumber、string orderTerminalId、QueryResultSettings queryResultSettings ページ結果受注 従業員 レシートIDから販売注文を取得します
サーチセールストランザクションズバイ- レシートID string receiptId、QueryResultSettings queryResultSettings ページ結果受注 従業員 レシートIDから販売取引を取得します
Search SalesOrderSearchCriteria salesOrderSearchCriteria、QueryResultSettings queryResultSettings ページ結果受注 従業員、顧客 指定された検索条件に一致する注文を検索します
SearchOrders OrderSearchCriteria orderSearchCriteria、QueryResultSettings queryResultSettings ページ結果受注 従業員、顧客 指定された検索条件に一致する注文を検索します。
GetInvoicesBySalesId string salesId、QueryResultSettings queryResultSettings ページ結果売上請求書 従業員 渡された販売IDに関連付けられている売上請求書を取得します
GetOrderInvoices string customerAccount、QueryResultSettings queryResultSettings ページ結果注文請求書 従業員 与えられた顧客IDに関連付けられている顧客に結びつく未処理の注文請求書を取得します
GetInvoices InvoiceSearchCriteria invoiceSearchCriteria、QueryResultSettings queryResultSettings PageResultOrderInvoice 従業員 検索条件に結びつく未処理の請求書を取得します
売上IDで請求済み売上行を取得する - SalesIds IEnumerablestring salesIds、QueryResultSettings queryResultSettings PageResultSalesLine 従業員 販売注文IDごとの請求済販売明細行の一覧を取得します
CreatePickingList [廃止 (かわりに CreatePickingListForItems を使用)] salesId string型 無効 従業員 販売注文のピッキングリストを作成します
CreatePickingListForItems string salesId、IEnumerable- PickAndPackSalesLineParameter pickAndPackSalesLineParameters 文字列 従業員 販売注文の選択された行のピッキング リストを作成する。
GetPickingLists string salesId、QueryResultSettings queryResultSettings PageResultピッキングリスト 従業員 Headquarters からの受注のピッキング リストを取得します。
CreatePackingSlip 無効 従業員 パッキングスリップを作成する
注文詳細を取得 - トランザクションIDによって transactionId string型, searchLocationValue int型 SalesOrder 従業員、顧客 取引IDごとの販売注文の詳細を取得します。
販売ID別売上注文詳細取得 - SalesId salesId string型 SalesOrder 従業員、顧客 販売IDごとの販売注文の詳細を取得します。
見積IDによる販売注文詳細取得 quotationId string型 SalesOrder 従業員、顧客 見積書IDごとの販売注文の詳細を取得します。
GetEntityByKey 文字列 transactionId SalesOrder 従業員 トランザクション識別子と一致する販売注文を取得します。
CreateEntity SalesOrder エンティティ SalesOrder 従業員、アプリケーション 支払/入金明細行を含む予約された販売注文をアップロードします。
CheckInForOrderPickup long channelId、文字列 packingSlipId、文字列 channelReferenceId、IEnumerableCommercePropertyextensionProperties CheckInForOrderPickupConfirmation 匿名、顧客 注文集荷のチェックイン操作。
GetInvoiceDetails 請求書詳細検索条件 InvoiceDetailsSearchCriteria SalesInvoice 従業員、顧客、アプリケーション 請求書の検索条件によって請求書の詳細 (明細行、請求、税金) を取得します。
SearchSalesTransactionsByReceiptId 文字列 receiptId、QueryResultSettings settings ページングの結果SalesOrder 従業員 レシート識別子から販売トランザクションを検索します。
SendReceipt SearchReceiptCriteria searchReceiptCriteria、IEnumerableElectronicAddressrecipientAddresses NullResponse 従業員 指定された条件を満たす取引レシートを最大 3 つの指定された電子アドレスに送信します。
GetOrderByChannelReferenceLookupCriteria ChannelReferenceLookupCriteria チャネル参照検索基準 SalesOrder 従業員、顧客、アプリケーション、匿名 指定されたチャネル参照 ID と追加の検索条件に基づいて販売注文を取得します。

カートのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
チェックアウト string id、string receiptEmail、TokenizedPaymentCard tokenizedPaymentCard、string receiptNumberSequence、IEnumerableCartTenderLine cartTenderLines、long? cartVersion SalesOrder 従業員、顧客、匿名、アプリケーション カートをチェックアウトします。
AddCartLines string ID、System.Collections.Generic.- IEnumerableCartLine cartLines、long? cartVersion カート 従業員、顧客、匿名、アプリケーション カートにカートの行を追加します。
VoidCartLines string ID、System.Collections.Generic.- IEnumerableCartLine cartLines カート 従業員 カート内のカート行を無効にします。
UpdateCartLines string ID、System.Collections.Generic.- IEnumerableCartLine cartLines カート 従業員、顧客、匿名、アプリケーション カート内のカート行を更新します。
RefillGiftCard string ID、string giftCardId、decimal amount、string currencyCode、string lineDescription) カート 従業員 ギフトカードに残額を加算
IssueGiftCard string ID、string giftCardId、decimal amount、string currencyCode、string lineDescription、string tenderTypeId カート 従業員 ギフト カードを発行する。
CashOutGiftCard string ID、string giftCardId、decimal amount、string currencyCode、string lineDescription カート 従業員 ギフト カードをキャッシュアウトします。
AddTenderLine string ID、CartTenderLine cartTenderLine、long? cartVersion カート 従業員 カートの入金明細行を追加します。
プレ加工追加- テンダーライン string ID、TenderLine preprocessedTenderLine、long? cartVersion カート 従業員 前処理された入札線を追加します。
照合決済-追加行 string ID、TenderLine tenderLine 無効 従業員 カートの入金明細行を確認します。
UpdateTenderLine- 署名 string ID、string tenderLineId、string signatureData カート 従業員 カートの入金明細行の署名を更新します。
VoidTenderLine string ID,string tenderLineId, System.Collections.Generic.- IEnumerableReasonCodeLine reasonCodeLines, bool? isPreprocessed = false, bool? forceVoid = false カート 従業員 カートの入金明細行を無効にします。
SuspendWithJournal string ID、string journalCartId、string receiptNumberSequence カート 従業員 カートを中断して仕訳入力を行います。
経歴 文字列 ID カート 従業員 保留中のカートを再開します。
ResumeFromReceiptId receiptId string型 カート 従業員 レシートIDに基づいて中断しているカートを再開します。
RecallOrder string transactionId,string salesId カート 従業員 顧客の注文を取り消します。
請求済み販売の追加 - カートへの行 transactionId string型, IEnumerablelong型 invoicedLineIds カート 従業員 請求された販売明細行をカートに追加します。
RecallQuote transactionId string型, string quoteId カート 従業員 見積を取り消します。
RecallSalesInvoice transactionId string型, invoiceId string型 カート 従業員 渡された請求書IDに関連付けられた請求書を示すカートを取得します。
AddOrderInvoice string ID、string invoiceId、string lineDescription カート 従業員 渡された請求書IDに関連付けられた請求書をカートに追加します。
AddInvoices key string型, IEnumerablestring型 invoiceIds カート 従業員 カートに請求書を追加します。
RecalculateOrder 文字列 ID カート 従業員 顧客注文の再計算をします。
更新手数料- 販売グループ transactionId string型, cartLineId string型, commissionSalesGroup string型, isUserInitiated bool型 カート 従業員 明細または取引のコミッション販売グループを更新します。
CartDeliveryPreferences 文字列 ID CartDeliveryPreferences 従業員、顧客、匿名、アプリケーション カート内のアイテムに基づいて、適用可能な配送設定タイプを取得します。
GetLineDeliveryOptions string ID、IEnumerable- LineShippingAddress lineShippingAddresses、 QueryResultSettings queryResultSettings PageResult- 販売ライン配達オプション 従業員、顧客、匿名、アプリケーション カートの配送明細オプションを取得します。
GetLineDeliveryOptionsBy-ChannelId (ゲットラインデリバリーオプションズバイチャネルID) string ID、IEnumerable- LineShippingAddress lineShippingAddresses、long channelId、QueryResultSettings queryResultSettings PageResult- 販売ライン配達オプション 従業員、顧客、匿名、アプリケーション チャンネルIDごとのカートの配送明細オプションを取得します。
GetPaymentsHistory 文字列 ID、QueryResultSettings queryResultSettings PageResultTenderLine 従業員 カートIDを指定して支払履歴を取得します。
GetDeliveryOptions string ID、Address shippingAddress、QueryResultSettings queryResultSettings PageResult- 配送オプション 従業員、顧客、匿名、アプリケーション カートの配送オプションを取得します。
UpdateLineDelivery- 仕様 string ID、System.Collections.Generic.- IEnumerable- LineDeliverySpecification lineDeliverySpecifications カート 従業員、顧客、匿名、アプリケーション カート明細ごとに配送仕様を更新します。
AddCharge cartId string型, moduleTypeValue int型, chargeCode string型, calculatedAmount decimal型 カート 従業員、アプリケーション カートに料金を追加します。
OverrideCharge cartId string型, chargeLineId string型, amount decimal型, IEnumerableReasonCodeLine reasonCodeLines カート 従業員、アプリケーション カート内の料金金額を変更します。
AddCartLineCharge cartId string型, cartLineId string型, moduleTypeValue int型, string chargeCode string型, calculatedAmount decimal型 カート 従業員、アプリケーション カートラインに料金を追加します。
OverrideCartLineCharge cartId string型, cartLineId string型, chargeLineId string型, amount decimal型, IEnumerableReasonCodeLine reasonCodeLines カート 従業員、アプリケーション カート内の明細手数料の金額を上書きします。
UpdateDelivery- 仕様 文字列 ID、デリバリー仕様 deliverySpecification カート 従業員、顧客、匿名、アプリケーション カート ヘッダーの配送仕様を更新します。
OverrideCartLinePrice 文字列 ID、文字列 cartLineId、10 進数の価格 カート 従業員 カートIDとバーコードスキャン情報を送信して、バーコードのワークフローを処理します。
GetPromotions 文字列 ID CartPromotions 従業員、顧客、匿名、アプリケーション 買い物カゴの宣伝商品を取得します。
AddDiscountCode 文字列 ID、ディスカウントコード カート 従業員、顧客、匿名、アプリケーション 割引コードをカートに追加します。
RemoveDiscountCodes string ID、IEnumerablestring discountCodes カート 従業員、顧客、匿名、アプリケーション カートから割引コードを削除します。
RemoveCartLines string ID,System.Collections.Generic.- IEnumerablestring cartLineIds カート 従業員、顧客、匿名、アプリケーション カートの明細行を削除します。
Search CartSearchCriteria cartSearchCriteria、QueryResultSettings queryResultSettings PageResultカート 顧客 カートを顧客別に取得します。
GetCardPayment - AcceptPoint string ID、CardPaymentAcceptSettings cardPaymentAcceptSettings CardPaymentAcceptPoint 従業員、顧客、匿名、アプリケーション Web ページなど、カード支払いの受け入れポイントを取得します。
RetrieveCardPayment - AcceptResult resultAccessCode string型 CardPayment - AcceptResult 従業員、顧客、匿名、アプリケーション 支払承認やカード トークンなど、カード支払いの受け入れ結果を取得します。
AddCoupons string ID,IEnumerablestring couponCodes, bool? isLegacyDiscountCode = false カート 従業員、顧客、匿名、アプリケーション クーポンをカートに追加します。
RemoveCoupons string ID、IEnumerablestring couponCodes カート 従業員、顧客、匿名、アプリケーション カートからクーポン コードを削除します。
GetChargeCodes QueryResultSettings 設定 ページ結果課金コード 従業員、アプリケーション すべての料金コードを取得します。
最大ロイヤルティポイントを取得して- 引換え- 取引残高 cartId string型, loyaltyCardNumber string型, redeemCurrency string型 LoyaltyPoint - RedemptionEstimate 従業員、顧客 ロイヤルティ カードがトランザクションの残高に適用できる最大通貨額と、その最大通貨金額の生成に使用される報酬ポイントの数量を含む LoyaltyPoint - RedemptionEstimate オブジェクトを取得します。
否認・無効-カード領収書 string cartId、TenderLine preprocessedTenderLine、ReceiptRetrievalCriteria criteria、QueryResultSettings queryResultSettings ページ結果レシート 従業員 カードの支払/入金が行われなかった明細行のギフトレシート群を取得します。
ResetAllCharges 文字列 ID カート 従業員、アプリケーション カートに対して手動で追加およびオーバーライドされたすべての料金の削除など、料金を再計算します。

アドレスのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetAddressPurposes QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果住所目的 従業員、顧客、匿名、アプリケーション 住所の目的を取得します

バーコードのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetBarcodeById barcodeId string型 バーコード 従業員 IDごとのバーコードを取得します。

現金申告のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCashDeclarations QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果現金申告 従業員 IDごとのバーコードを取得します。

市区町村のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCities string countryRegionId、string stateProvinceId、string countyId、QueryResultSettings queryResultSettings PageResultCityInfo 従業員 国/地域、州、都道府県、郡でフィルター処理されたすべての都市を取得します。

群のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCounties string countryRegionId、string stateProvinceId、QueryResultSettings queryResultSettings Page結果郡情報 従業員 国/地域の州と都道府県でフィルター処理されたすべての郡を取得します。

国/地域のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCountryRegionsForShipping QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果国と地域情報 従業員、顧客、匿名、アプリケーション 現在のチャネルに設定されている出荷モードで翻訳された国/地域を取得します。
国の地域を言語IDで取得する string languageId、QueryResultSettings queryResultSettings ページ結果国と地域情報 従業員、顧客、匿名、アプリケーション 言語IDでフィルタされたすべての国/地域を取得します。
GetCountryRegions QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果国と地域情報 従業員 すべての国/地域を取得します。

クレジット メモのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCreditMemoById creditMemoId string型 CreditMemo 従業員 IDを使ってクレジット メモを取得します。

配送オプションのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetDeliveryOptions string ID、Address shippingAddress、QueryResultSettings queryResultSettings PageResultDeliveryOption 従業員、顧客、匿名、アプリケーション チャネルの配送オプションを取得します。

顧客グループのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCustomerGroups QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果顧客グループ 従業員、顧客、匿名、アプリケーション 顧客グループ群を取得します。

通貨のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCurrenciesAmount string currencyCode、decimal amount、QueryResultSettings queryResultSettings PageResultCurrencyAmount (No translation is appropriate in this context) 従業員 通貨金額を取得します。
CalculateTotalCurrencyAmount System.Collections.Generic.IEnumerable CurrencyRequest 通貨の金額 CurrencyAmount 従業員 通貨の合計金額を計算します。

顧客残高のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCustomerBalance accountNumber string型, invoiceAccountNumber string型 CustomerBalances 従業員 顧客残高を取得します。

デバイス構成のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetDeviceConfiguration DeviceConfiguration 従業員 単体のデバイス構成を取得します。

地域 のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetDistricts string countryRegionId、string stateProvinceId、string countyId, string cityName、QueryResultSettings queryResultSettings ページ結果地区情報 従業員 国/地域、都道府県、郡、市区町村でフィルター処理されたすべての地区情報を取得します。

州 地域 のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetStateProvinces string countryRegionId、QueryResultSettings queryResultSettings ページ結果州県情報 従業員、顧客、匿名、アプリケーション 国/地域でフィルター処理されたすべての州または都道府県を取得します。

価格コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
CalculateSalesDocument カート salesDocument カート 従業員、顧客、匿名、アプリケーション 注文で一緒に購入した場合、特定の数量の製品の価格と割引を計算します。

郵便番号のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetZipCodes string countryRegionId、string stateProvinceId、string countyId、string cityName、string district、QueryResultSettings queryResultSettings PageResultZipCodeInfo 従業員 国/地域、州、都道府県、郡、市区町村、および地区でフィルター処理されたすべての郵便番号を取得します。
GetAddressFromZipCode string countryRegionId、string zipPostalCode、QueryResultSettings queryResultSettings PageResultZipCodeInfo 従業員、顧客、匿名、アプリケーション 国/地域でフィルター処理された郵便番号に関連付けられているアドレスの詳細を取得します。

中断されたカートのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetAllSuspendedCarts QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果一時停止されたカート 従業員 すべての保留中のカートを取得します。

支払/入金タイプのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetTenderTypes QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultTenderType 従業員、顧客、匿名、アプリケーション 支払/入金タイプを取得する
RoundAmountByTenderType amount decimal型, tenderTypeId string型 10 進 従業員 支払/入金タイプ別の丸め金額。

公開処理のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
SetOnlineChannelPublishStatus publishingStatus int型, publishingStatusMessage string型 無効 応募 オンライン チャネルの公開ステータスを更新します。

言語のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetLanguages QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResult対応言語 従業員 対応している言語群を取得します。

ローカライズされた文字列のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetLocalizedStrings string languageId、int? textId、QueryResultSettings queryResultSettings PageResultローカライズされた文字列 従業員 言語ID、テキストIDでフィルタされたすべてのローカライズされた文字列を取得します。

通知のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetNotifications サブスクライブドオペレーション、 クエリ結果設定 ICollection<NotificationItem> 従業員 通知を取得します。
AcknowledgeNotifications 最終プル日時 無効 従業員 通知を確認します。

番号シーケンスのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetLatestNumberSequence クエリ結果設定 PageResult<LocalizedString> 従業員 現在の端子の次の番号シーケンスを取得します。

ReasonCodes のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetReasonCodes queryResultSettings PageResult<ReasonCode> 従業員 理由コードを取得します。
GetReturnOrderReasonCodes queryResultSettings PageResult<ReasonCode> 従業員 返品依頼の理由コードを取得します。
GetReasonCodesById 文字列 reasonCodeGroupId, queryResultSettings PageResult<ReasonCode> 従業員 グループまたは単一のIDごとに理由コードを取得します。

レシートのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetReceiptMasks int? receiptTransactionType、 queryResultSettings PageResult<ReceiptMask> 従業員 受領マスクを取得します。
ValidatePrintReceiptCopyAllowed セールスオーダー印刷用 無効 従業員 受領コピーの印刷操作が許可されているかどうかを検証します。

レポートデータセットのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
SearchReportDataSet int? receiptTransactionType、QueryResultSettings queryResultSettings ReportDataSet 従業員 レポート識別子、パラメーター、ロケールでフィルター処理されたすべてのレポート データセットを検索します。
GetReportDataSetById (Since there are no context-driven reasons for any different treatment and they likely refer to specific product or technical identifiers, the original translation remains applicable.) SalesOrder salesOrderToPrint ReportDataSet 従業員 ID でレポート データ セットを取得します。
GetSrsReportDataSet ReportDataSet 従業員 SSRSレポートデータセットを取得します。

検索処理のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetSearchSuggestions SearchSuggestionCriteria suggestionCriteria, QueryResultSettings 設定 ページ結果検索候補 従業員、顧客、匿名、アプリケーション 検索候補を取得します。
GetSearchConfiguration SearchConfiguration 従業員、顧客、匿名、アプリケーション Azure Search からチャネル検索の構成を取得します

税金処理のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetTaxOverrides SearchSuggestionCriteria suggestionCriteria, QueryResultSettings 設定 PageResultTaxOverride 従業員 指定した検索条件に一致する税金の上書きを検索します。
GetSalesTaxGroups PageResult売上税グループ 従業員 売上税のグループを取得します。

支払/入金のドロップおよびオペレーション宣言のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
CreateDropAndDeclareTransaction DropAndDeclareTransaction ドロップアンドデクレアトランザクション DropAndDeclareTransaction 従業員 支払/入金の保存と、店舗の申告操作を実行します。

測定単位のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetUnitsOfMeasure QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultUnitOfMeasure 従業員 ストアでサポートされているすべての測定単位を取得します。

収入/経費勘定のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetIncomeExpenseAccounts int incomeExpenseAccountType（収入支出アカウントタイプ）, queryResultSettings（クエリ結果設定） PageResult<IncomeExpenseAccount> 従業員 収入勘定または経費勘定科目を取得します。

製品のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
Search ProductSearchCriteria productSearchCriteria、QueryResultSettings queryResultSettings IEnumerableProduct 従業員、顧客、匿名、アプリケーション OData クエリを使用して製品を検索します。
GetById recordId long型, channelId long型 SimpleProduct 従業員、顧客、匿名、アプリケーション レコードIDによって SimpleProduct を取得します。
取得 PageResult製品 従業員、顧客、店舗 製品を検索します。
GetByIds long channelId、IEnumerablelong productIds、QueryResultSettings queryResultSettings PageResultSimpleProduct 従業員、顧客、匿名、アプリケーション チャンネルIDとレコードIDに基づいて製品群を取得します。
GetRecommendedProducts IEnumerablelong productIds、string customerAccountNumber、QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション 一群のプロダクトIDが指定して、推奨された SimpleProduct 群を取得します。
比較 long channelId、long catalogId、IEnumerablelong productIds、QueryResultSettings queryResultSettings ページ結果- 製品比較ライン 従業員、顧客、匿名、アプリケーション 製品を比較します。
SearchByCategory channelId long型, catalogId long型, categoryId long型, QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション カテゴリに属している製品を直接、またはその子カテゴリを介して検索します。
SearchByText long channelId、long catalogId、string searchText、QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション 指定した検索テキストに関連付けられた製品を検索します。
GetSearchSuggestions channelId long型, catalogId long型, searchText string型, hitPrefix string型, hitSuffix string型, QueryResultSettings queryResultSettings ページ結果- 検索提案 従業員、顧客、匿名、アプリケーション (部分的な) 検索テキストに基づいて推奨される検索語句を取得します。
GetRefinersByCategory long catalogId、long categoryId、QueryResultSettings queryResultSettings ページ結果- プロダクトリファイナー 従業員、顧客、匿名、アプリケーション 指定されたカテゴリ製品で使用できる製品の絞り込み条件を取得します。
GetRefinersByText long catalogId、string searchText、QueryResultSettings queryResultSettings ページ結果- プロダクトリファイナー 従業員、顧客、匿名、アプリケーション 指定されたテキストを検索した結果、製品で使用可能なプロダクトリファイナーを取得します。
GetProductSearchRefiners ProductSearchCriteria searchCriteria、QueryResultSettings queryResultSettings ページ結果- プロダクトリファイナー 従業員、顧客、匿名、アプリケーション 使用されている絞り込み条件と検索テキスト/カテゴリ ID の組み合わせから得られる結果から、製品で使用できる製品の絞り込み条件を取得します。
GetRefinerValuesByCategory long catalogId、long categoryId、long refinerId、int refinerSourceValue、QueryResultSettings queryResultSettings ページ結果- ProductRefinerValue 従業員、顧客、匿名、アプリケーション 指定されたカテゴリ製品で使用できる製品の絞り込み条件を取得します。
GetRefinerValuesByText long catalogId、string searchText、long refinerId、int refinerSourceValue、QueryResultSettings queryResultSettings ページ結果- ProductRefinerValue 従業員、顧客、匿名、アプリケーション 指定されたテキストを検索した結果、製品で使用可能なプロダクトリファイナーの値を取得します。
RefineSearchByCategory long channelId、long catalogId、long categoryId、IEnumerable- ProductRefinerValue refinementCriteria、QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション カテゴリに属している製品を直接、またはその子カテゴリを介して検索します。
RefineSearchByText channelId long型, catalogId long型, searchText string型, IEnumerable- ProductRefinerValue refinementCriteria, QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション 指定された検索テキストに関連する製品に対して実行される検索を絞り込みます。
GetDimensionValues long recordId、long channelId、int dimension、IEnumerableProductDimension matchingDimensionValues、QueryResultSettings queryResultSettings ページ結果- ProductDimensionValue 従業員、顧客、匿名、アプリケーション 指定された要件に基づいて製品の分析コード値を取得します。
バリアント取得-ディメンション値別 long recordId、long channelId、IEnumerableProductDimension matchingDimensionValues、QueryResultSettings queryResultSettings PageResultSimpleProduct 従業員、顧客、匿名、アプリケーション 指定した要件に基づいて製品のバリエーションを取得します。
構成要素スロット内のバリアント取得（GetVariantsBy- ComponentsInSlots） recordId long型, channelId long型, IEnumerable- ComponentInSlotRelation matchingSlotTo- ComponentRelationship, QueryResultSettings queryResultSettings ページ結果シンプル製品 従業員、顧客、匿名、アプリケーション 指定したスロットの組み合わせのコンポーネントに基づいて、製品のバリエーションを取得します。
GetDefaultComponents long recordId、long channelId、QueryResultSettings queryResultSettings PageResult - ProductComponent 従業員、顧客、匿名、アプリケーション 指定したプロダクトを構成する既定の個々のパーツを取得します。
GetComponentByProduct- SlotRelation channelId long型, ComponentInSlotRelation componentRelation ProductComponent 従業員、顧客、匿名、アプリケーション 指定された ComponentIn- SlotRelation に基づいて特定の製品コンポーネントを取得します
GetSlotComponents long recordId、long channelId、long slotId、QueryResultSettings queryResultSettings PageResult - ProductComponent 従業員、顧客、匿名、アプリケーション プロダクトの構成を完了するためにプロダクトのスロットに適合する既定のの個別パーツを取得します。
GetFiltered- スロットコンポーネント long recordId、long channelId, long slotId、IEnumerable- ComponentInSlotRelation selectedComponents、QueryResultSettings queryResultSettings PageResult - ProductComponent 従業員、顧客、匿名、アプリケーション 以前に選択したコンポーネントのセットを指定すると、選択の可能性があるプロダクトコンポーネントを取得します。
GetAttributeValues long recordId、long channelId、long catalogId、QueryResultSettings queryResultSettings PageResult属性値 従業員、顧客、匿名、アプリケーション 指定された製品の属性値を取得します。
GetRelationTypes long recordId、long channelId、long catalogId、QueryResultSettings queryResultSettings PageResult- 製品関連タイプ 従業員、顧客、匿名、アプリケーション 指定した製品と他の製品との関係の種別を取得します。
GetRelatedProducts long recordId、long channelId、long catalogId、long relationTypeId、QueryResultSettings queryResultSettings PageResult- 製品検索結果 従業員、顧客、匿名、アプリケーション 指定した関係によって指定した製品に関連付けられている製品を検索します。
GetRefiners ProductSearchCriteria productSearchCriteria、QueryResultSettings queryResultSettings ページ結果製品リファイナー 従業員、顧客、匿名、アプリケーション OData クエリを使用して製品リファイナーを検索します。
変更 ChangedProductsSearchCriteria productSearchCriteria、QueryResultSettings queryResultSettings IEnumerableProduct 従業員、店舗 指定されたクエリ条件で、変更された製品を検索して取得します。
ReadChangedProducts ChangedProductsSearchCriteria productSearchCriteria、QueryResultSettings queryResultSettings PageResult製品 応募 指定されたクエリ条件で、変更された製品を検索して取得します。
GetDeletedListings catalogId long型, skip long型, top long型 DeletedListingsResult 応募 指定されたクエリ条件で、変更された製品を検索して取得します。
GetDeletedCatalogs QueryResultSettings クエリ結果設定 (QueryResultSettings) IEnumerablelong型 応募 削除されたカタログを取得します。
GetDeletedLanguages QueryResultSettings クエリ結果設定 (QueryResultSettings) IEnumerablestring型 応募 削除された言語を取得します。
DeleteListingsBy-カタログ削除 IEnumerablelong型 catalogIds 無効 応募 カタログごとの一覧を削除します。
DeleteListingsBy- 言語 IEnumerablestring型 languages 無効 応募 言語別の一覧を削除します。
開始読み込み - 変更された製品 変更製品検索基準 changedProductSearchCriteria 変更読み取り - 製品セッション 応募 変更された製品を読み取るセッションを開始します。
EndReadChangedProducts ReadChangedProductsSession セッション 無効 応募 変更された製品を読み取るセッションを終了します。
リスト更新 - 公開ステータス IEnumerableListingPublishStatus 公開ステータス 無効 応募 指定されたクエリ条件で、変更された製品を検索して取得します。
GetProductAvailabilities IEnumerablelong itemIds、long channelId、QueryResultSettings queryResultSettings ページ結果 - 製品利用可能数量 従業員、顧客、匿名、アプリケーション 特定のチャネルと顧客のアイテムの特定のリストで使用可能なインベントリを取得します。
GetPrices string itemId、string inventoryDimensionId、string barcode, string customerAccountNumber、string unitOfMeasureSymbol、decimal quantity、QueryResultSettings queryResultSettings Page結果製品価格 従業員 現在の顧客に関連する品目の価格を取得します。
GetPrice recordId long型, customerAccountNumber string型, unitOfMeasureSymbol string型 ProductPrice 従業員、顧客、匿名、アプリケーション 現在の顧客に関連する製品の価格を取得します。
CalculateProductPrice recordId long型, customerAccountNumber string型, unitOfMeasureSymbol string型, loyaltyCardId string型, IEnumerableAffiliationLoyaltyTier affiliationLoyaltyTiers ProductPrice 従業員、顧客、匿名、アプリケーション 価格を取得します。
GetActivePrices ProjectionDomain projectDomain、IEnumerablelong productIds、DateTimeOffset activeDate、string customerId、IEnumerableAffiliationLoyaltyTier affiliationLoyaltyTiers、bool? includeSimpleDiscountsIn- ContextualPrice、QueryResultSettings queryResultSettings Page結果製品価格 従業員、顧客、匿名、アプリケーション 価格を取得します。
GetMediaLocations long recordId、long channelId、long catalogId、QueryResultSettings queryResultSettings PageResultMediaLocation 従業員、顧客、匿名、アプリケーション 指定した製品のメディアの場所を取得します。
GetMediaBlobs long recordId、long channelId、long catalogId、QueryResultSettings queryResultSettings PageResultMediaBlob (ページ結果メディア・ブロブ) 従業員、顧客、匿名、アプリケーション 指定された製品のメディアブロブを取得します。
GetUnitsOfMeasure long recordId、QueryResultSettings queryResultSettings ページ結果単位 従業員、顧客、匿名、アプリケーション 指定した製品の測定単位を取得します。
チャンネル取得-製品属性 QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultAttributeProduct 従業員、顧客、匿名、アプリケーション チャネル製品属性を取得します。
GetProductRatings IEnumerablelong productIds、QueryResultSettings 設定 ページ結果製品評価 従業員、顧客、匿名、アプリケーション 製品識別子に基づく製品評価を取得します。
GetEstimatedAvailability 在庫可用性の検索基準 検索基準 ProductWarehouseInventoryInformation 従業員、顧客、匿名、アプリケーション 検索基準に基づいて、製品の在庫状況を予測します。
GetEstimatedProductWarehouseAvailability 在庫可用性の検索基準 検索基準 IEnumerableプロダクトウェアハウス 従業員、顧客、匿名、アプリケーション 特定の製品倉庫のペアに対して、予想される製品の在庫状況を取得します。
UpdateProductWarehouseAvailability IEnumerableProductWarehouseQuantity の数量 UpdateProductWarehouseAvailabilityResult BusinessPartnerEmployee、アプリケーション 特定の倉庫の製品または製品バリアントの在庫を更新します。

製品リストのコントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
Search ProductListSearchCriteria productListSearchCriteria、QueryResultSettings queryResultSettings ページ結果商品リスト 従業員、顧客、匿名 検索基準でフィルター処理された製品リストを取得します。
AddProductListLines 文字列 productListId、IEnumerableProductListLineproductListLines PagedResultProductListLine（ページ結果製品リストライン） 従業員、顧客、匿名 製品リストの製品リスト明細行を作成します。
UpdateProductListLines 文字列 productListId、IEnumerableProductListLineproductListLines PageResultProductListLine 従業員、顧客、匿名 製品リスト明細行を更新します。
GetProductListLines 文字列 productListId,、文字列 searchText、QueryResultSettings queryResultSettings PagedResultProductListLine 従業員、顧客、匿名 製品リスト明細行を取得します。
RemoveProductListLines 文字列 productListId、IEnumerableProductListLine 明細行 NullResponse 従業員、顧客、匿名 製品リストから明細行を削除します。
CopyCartToProductList 文字列 cartId、文字列 destinationProductListId、bool isRewrite、bool isQuantityAggregate ProductList 従業員、顧客 製品リスト明細行にカートの内容をコピーします。
GetEntityByKey 文字列 productListId ProductList 従業員、顧客 ID で 1 つの製品リストを取得します。
CreateEntity プロダクトリスト productList ProductList 従業員、顧客 製品リストを作成します。
PatchEntity プロダクトリスト productList ProductList 従業員、顧客 製品リストプロパティを更新します。 部分的な更新に使用されます。
UpdateEntity プロダクトリスト productList ProductList 従業員、顧客 製品リストプロパティを更新します。 部分的な更新に使用されます。
DeleteEntity 文字列 productListId NullResponse 従業員、顧客 製品リストを削除します。

販売注文履行 コントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
ShipFulfillmentLines fulfillmentLines 無効 従業員 フルフィルメント行を出荷します。 AX の請求書。
AcceptFulfillmentLines fulfillmentLines 無効 従業員 履行明細のステータスを 受入済 に更新します。
PickFulfillmentLines fulfillmentLines、 fulfillmentLines 無効 従業員 履行明細のステータスを ピッキング に更新します。
MarkAsPicked fulfillmentLines 無効 従業員 履行明細のステータスを ピック済 に更新します。
PackFulfillmentLines fulfillmentLines 無効 従業員 履行明細のステータスを 梱包済 または 一部梱包済 に更新します。
MarkFulfillmentLinesAsPacked fulfillmentLines 文字列 従業員 履行明細のステータスを 梱包済 または 一部梱包済 に更新します。
GetFulfillmentLines 条件、 設定 IEnumerable<FulfillmentLine> 従業員 履行明細を取得します。
GetFulfillmentPackingSlips IEnumerable<Receipt> 従業員 パッキングスリップを取得します。
GetFulfillmentPackingSlipsById salesId string型, packingSlipId string型, hardwareProfileId string型 IEnumerable<Receipt> 従業員 パッキングスリップIDおよび売上IDでパッキングスリップを取得します。
GetFulfillmentPickingLists pickingListFulfillmentLines、string hardwareProfileId、 queryResultSettings IEnumerable<Receipt> 従業員 ピッキング リストを取得する。
RejectFulfillmentLines fulfillmentLines 無効 従業員 履行明細のステータスを 否認 に更新します
GetPackingSlipsData salesId string型 IEnumerable<PackingSlipData> 従業員 売上IDを指定して、パッキングリスト データのリストを取得します。

ハードウェア プロファイル コントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetHardwareProfileById hardwareProfileId string型 HardwareProfile 従業員 IDからハードウェアプロファイルを取得します。
GetHardwareStationProfiles 照会結果設定 PageResult<HardwareStationProfile> 従業員 ハードウェアプロファイルを取得します。

収入/経費勘定のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetIncomeExpenseAccounts int incomeExpenseAccountType（収入支出アカウントタイプ）, queryResultSettings（クエリ結果設定） PageResult<IncomeExpenseAccount> 従業員 収入勘定または経費勘定科目を取得します。

キットのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
DisassembleKitTransactions KitTransaction KitTransaction 従業員 キット(分解)トランザクション操作を実行します。

ギフト カード コントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetGiftCardInquiry giftCardId string型 GiftCard 従業員、顧客、匿名、アプリケーション 識別子によって追加情報を含むギフトカードを取得します。

イメージのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetImageBlob imageId long型 MediaBlob 従業員、顧客、匿名、アプリケーション イメージIDごとのイメージBLOBを取得します。

店舗の金庫 コントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetStoreSafes QueryResultSettings 設定 ページ結果安全保管 Employee ストア セーフ リストを取得します。

ウェアハウスのコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
GetWarehouseById inventLocation string型 ページ結果安全保管 従業員、顧客 レコード識別子でウェアハウスを取得します。
SearchWarehouses searchText string型, QueryResultSettings queryResultSettings PageResult倉庫 アプリケーション、従業員、顧客 指定された検索テキストに一致するウェアハウスのリストを取得します。
GetLocations string inventLocation、QueryResultSettings queryResultSettings PageResult保管場所 アプリケーション、従業員、顧客 指定した倉庫の倉庫の場所を取得します。
SearchLocations inventLocation string型, searchText string型, QueryResultSettings queryResultSettings PageResult保管場所 アプリケーション、従業員、顧客 指定された検索テキストと一致する、指定された倉庫の場所の一覧を取得します。

推奨のコントロール

API パラメーター 戻り値 対応している商取引上の役割 内容
取得 ページ結果推奨 アプリケーション、従業員、顧客、匿名 推奨の一覧を取得します。
GetElements string listId、RecommendationCriteria criteria、QueryResultSettings queryResultSettings ページ結果推奨要素 アプリケーション、従業員、顧客、匿名 検索条件として指定されたコンテキスト情報 (省略可能) から推奨エレメントを取得します。

オーダーコントローラーの転送

API パラメーター 戻り値 対応している商取引上の役割 内容
取得 QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果伝票移管 従業員 店舗のオープン移動オーダーを取得します。
確定 文字列 orderId 無効 従業員 移動オーダーのコミット
GetTransferOrderJournals string orderId、QueryResultSettings queryResultSettings PageResult転送注文帳簿 従業員 指定された移動オーダーの移動オーダー帳を取得します。
GetTransferOrderLines string orderId、QueryResultSettings queryResultSettings PageResult（ページ結果）TransferOrderLine（転送オーダーライン） 従業員 移動オーダーの明細行を取得します。
CreateTransferOrderLines string orderId、IEnumerableTransferOrderLine transferOrderLines、QueryResultSettings queryResultSettings PageResult（ページ結果）TransferOrderLine（転送オーダーライン） 従業員 移動オーダーの明細行を作成します。
UpdateTransferOrderLines string orderId、IEnumerableTransferOrderLine transferOrderLines、QueryResultSettings queryResultSettings PageResult（ページ結果）TransferOrderLine（転送オーダーライン） 従業員 移動オーダーの明細行を転記します。
DeleteTransferOrderLines string orderId、IEnumerableTransferOrderLine transferOrderLines、QueryResultSettings queryResultSettings PageResult（ページ結果）TransferOrderLine（転送オーダーライン） 従業員 移動オーダーの明細行を削除します。
GetTransferOrderComments string orderId、QueryResultSettings queryResultSettings ページ結果コメント 従業員 指定された移動オーダーのコメントを取得します。
AddTransferOrderComment 文字列 orderId、文字列 commentedBy、文字列 comment コメント 従業員 指定された移動オーダーのコメントを取得します。
GetTransferPackingSlip 文字列 orderId、文字列 voucherId、ReceiptRetrievalCriteria 基準、QueryResultSettings queryResultSettings ページ結果レシート 従業員 指定の移動オーダー帳の梱包明細を取得します。
PatchEntity TransferOrder エンティティ TransferOrder 従業員 ローカルデータベースに移動オーダーを保存します。
GetEntityByKey 文字列 orderId TransferOrder 従業員 オーダー識別子で移動オーダーを取得します。
DeleteEntity TransferOrder エンティティ 無効 従業員 指定の移動オーダーを削除します。
CreateEntity TransferOrder エンティティ TransferOrder 従業員 移動オーダーを作成します。

オーダー コントローラーの購入

API パラメーター 戻り値 対応している商取引上の役割 内容
取得 QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果購入注文 従業員 店舗のオープンな発注書を取得します。
確定 文字列 orderId 無効 従業員 発注書をコミットします。
PatchEntity PurchaseOrder エンティティ PurchaseOrder 従業員 ローカルデータベースに発注書を保存します。
GetEntityByKey 文字列 orderId PurchaseOrder 従業員 注文 ID で発注書を取得します。

組織単位コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
取得 QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultOrgUnit アプリケーション、従業員、顧客、匿名 すべての組織を IQueryable として取得します。
GetOrgUnitLocationsByArea SearchArea searchArea、QueryResultSettings queryResultSettings PageResultOrgUnitLocation アプリケーション、従業員、顧客、匿名 定義された領域で店舗を検索します。
SearchOrgUnitLocations OrgUnitLocationSearchCriteria orgUnitLocationSearchCriteria、QueryResultSettings queryResultSettings PageResultOrgUnitLocation アプリケーション、従業員、顧客、匿名 現在のフルフィルメントグループ内に指定されたフィルタ基準を持つ店舗を検索します。
GetAvailableInventory string itemId、string variantId、string barcode、QueryResultSettings queryResultSettings ページ結果オーグユニット可用性 アプリケーション、従業員、顧客、匿名 品目 ID またはバーコードのすべての店舗で利用可能な在庫を取得します。
GetProductAvailability productId long型、QueryResultSettings queryResultSettings PageResultOrgUnitAvailability アプリケーション、従業員、顧客、匿名 製品のすべての店舗で利用可能な在庫を取得します。
SearchProductAvailability productId long型、OrgUnitAvailabilitySearchCriteria orgUnitAvailabilitySearchCriteria、QueryResultSettings queryResultSettings PageResultOrgUnitAvailability アプリケーション、従業員、顧客、匿名 製品のすべての店舗で利用可能な在庫を検索します。
GetAvailableInventoryNearby IEnumerableItemUnit itemIds、SearchArea searchArea、QueryResultSettings queryResultSettings ページ結果組織単位の可用性 アプリケーション、従業員、顧客、匿名 定義された検索領域で指定された品目の一覧に対して、利用可能な隣接する店舗の在庫を取得します。
GetTillLayout int? 高さ, int? 幅 TillLayout アプリケーション、従業員、顧客、匿名 単一のレジレイアウトを取得します。
GetOrgUnitConfiguration ChannelConfiguration アプリケーション、従業員、顧客、匿名 現在の組織単位の構成を取得します。
Search SearchStoreCriteria storeSearchCriteria、QueryResultSettings queryResultSettings PageResultOrgUnit アプリケーション、従業員、顧客、匿名 指定された検索クエリによって組織単位を検索します。
GetTerminalInfo 文字列 orgUnitNumber、int deviceType、QueryResultSettings queryResultSettings PageResultTerminalInfo Employee 店舗のターミナルおよびデバイスの関連情報データを復元します。
GetProductAvailabilityByDimensions IEnumerable文字列 inventLocationIds、productId long型、IEnumerableProductDimensionCombination productDimensionCombinations、QueryResultSettings queryResultSettings ページ結果組織単位の可用性 アプリケーション、従業員、顧客、匿名 指定された各在庫場所で、指定された製品分析コードに基づいて、orgUnit の使用可能性を取得します。
GetStoreHours 文字列 storeNumber StoreHours アプリケーション、従業員、顧客、匿名 特定の店舗番号の店舗時間を復元します。
GetEntityByKey 文字列 orgUnitNumber OrgUnit アプリケーション、従業員、顧客、匿名 キーを使って組織エンティティを取得します。

カタログコントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCatalogs channelId long型、bool activeOnly、QueryResultSettings queryResultSettings ページ結果製品カタログ アプリケーション、従業員、顧客、匿名 OData クエリでカタログを取得します。

カテゴリコントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCategories long channelId、QueryResultSettings queryResultSettings PageResultカテゴリ アプリケーション、従業員、顧客、匿名 OData クエリでカテゴリを取得します。
GetChildren channelId long型, categoryId long型, QueryResultSettings queryResultSettings PageResultカテゴリ アプリケーション、従業員、匿名 指定されたチャネル ID およびカテゴリ ID でサブカテゴリを取得します。
GetAttributes categoryId long型、QueryResultSettings queryResultSettings ページ結果属性カテゴリ 応募 OData クエリでカテゴリの属性を取得します。
取得 QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultカテゴリ アプリケーション、従業員、匿名 カテゴリの完全なリストを IQueryable として取得します。

AppInfo コントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
UpdateApplicationVersion 文字列 appVersion 無効 従業員 POS デバイスの現在のアプリケーションバージョンを更新します。

属性コントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetAttributeDefinitions AttributeDefinitionCriteria attributeDefinitionCriteria、QueryResultSettings queryResultSettings PageResult属性定義 従業員 属性グループ ID を使って属性定義を取得します。

属性グループコントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetAttributeGroupDefinitions AttributeGroupDefinitionCriteria attributeGroupDefinitionCriteria、QueryResultSettings queryResultSettings PageResultAttributeGroupDefinition 従業員 属性グループ ID のコレクションを使って属性グループ定義を取得します。

監査イベントコントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
RegisterAuditEvent 監査イベント AuditEvent 無効 従業員 監査イベントを保存します。
RegisterAndGetAuditEvent 監査イベント AuditEvent AuditEvent 匿名、顧客、デバイス、従業員、アプリケーション 監査イベントを保存します。

コントローラーのシフト

API パラメーター 戻り値 対応している商取引上の役割 内容
GetShift shiftId long型、文字列 terminalId シフト 従業員 シフト ID とターミナル ID でシフトを取得します。
GetByStatus int statusValue、QueryResultSettings queryResultSettings PageResultシフト 従業員 ステータスによるシフトを取得します。
GetByStatusFilterByUserRole Int statusValue、bool filterByUserRole、QueryResultSettings queryResultSettings PageResultシフト 従業員 ステータスによるシフトを取得します。
GetByRetrievalCriteria ShiftRetrievalCriteria shiftRetrievalCriteria、QueryResultSettings queryResultSettings PageResultシフト 従業員 取得条件によるシフトを取得します。
UpsertAndValidateShifts shiftId long型?、文字列 terminalId、IEnumerableシフト シフト ブール 従業員 指定されたシフトを挿入または更新し、検証します。
DeleteShifts ブール 従業員 削除シフトは、オンライン コンテキストではサポートされていません。
空いている シフト 従業員 新しいシフトを開きます。
終了 shiftId long型、文字列 terminalId、文字列 transactionId、bool forceClose シフト 従業員 指定されたターミナルのシフトを閉じます。
BlindClose shiftId long型、文字列 terminalId、文字列 transactionId、bool forceClose シフト 従業員 ブラインドがシフトをクローズします。
ForceDelete shiftId long型、文字列 terminalId、文字列 transactionId 無効 従業員 Forcefully はシフトを削除します。 無効なシフトを削除するために使用します。
経歴 shiftId long型、文字列 terminalId、文字列 cashDrawer シフト 従業員 シフトを再開します。
使用する shiftId long型、文字列 terminalId シフト 従業員 既存のシフトを使用します。
中断 shiftId long型、文字列 terminalId、文字列 transactionId シフト 従業員 シフトを中断します。
PostShift シフト シフト HttpResponseMessage 従業員 新しいシフトを作成するPOST要求を処理します
PatchShift shiftId long型、文字列 terminalId、Deltaシフト delta シフト 従業員 既存のシフトを更新するパッチ要求を処理します。
GetXReport shiftId long型、文字列 terminalId、文字列 transactionId、文字列 hardwareProfileId 受信 従業員 X レポートの受領書を取得します。
GetZReport 文字列 transactionId、文字列 hardwareProfileId 受信 従業員 Z レポートの受領書を取得します。
ValidateCashDrawerLimit 文字列 shiftTerminalId、shiftId long 型 無効 従業員 指定されたシフトのすべての中断中のカートを取得します。
GetSuspendedCartsByShift 文字列 shiftTerminalId、shiftId long型、QueryResultSettings queryResultSettings ページ結果一時停止されたカート 従業員 指定されたシフトの中断中のトランザクションを無効にします。
VoidSuspendedCarts shiftId long型、文字列 shiftTerminalId 無効 従業員 指定されたシフトの中断中のトランザクションを無効にします。

Async サービスコントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
GetDownloadInterval 文字列 dataStoreName 文字列 デバイス ダウンロードの間隔を取得します。
GetUploadInterval GetUploadInterval 文字列 デバイス アップロードの間隔を取得します。
GetTerminalDataStoreName 文字列 terminalId 文字列 デバイス データストア名を取得します。
GetDownloadLink 文字列 dataStoreName、downloadSessionId long型 文字列 デバイス ダウンロードリンクを取得します。
GetDownloadSessions 文字列 dataStoreName、QueryResultSettings queryResultSettings ページ結果ダウンロードセッション デバイス ダウンロード セッションを取得します。
GetInitialDownloadSessions 文字列 dataStoreName、QueryResultSettings queryResultSettings PageResultDownloadSession デバイス 初期のダウンロード セッションを取得します。
GetUploadJobDefinitions 文字列 dataStoreName、QueryResultSettings queryResultSettings IEnumerablestring型 デバイス ダウンロード セッションを取得します。
UpdateDownloadSession ダウンロードセッション DownloadSession ブール デバイス ダウンロード セッション状態を更新します。
PostOfflineTransactions IEnumerable文字列 offlineTransactionForMPOS ブール デバイス オフライン トランザクションを転記します。

カードタイプ コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCardTypes QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultCardTypeInfo アプリケーション、従業員、顧客、匿名 カードタイプの一覧を返します。
GetSupportedPaymentCardTypes QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResult文字列 アプリケーション、顧客、匿名 支払コネクタでサポートされている支払カードの一覧を返します。

コミッション売上グループのコントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
GetCommissionSalesGroups QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResult委託販売グループ 従業員 チャネルのコミッション売上グループのコレクションを取得します。
SearchCommissionSalesGroups searchText string型, QueryResultSettings queryResultSettings PageResult委託販売グループ 従業員 指定された検索テキストについて、チャネルのコミッション売上グループを検索します。

環境の構成コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
GetEnvironmentConfiguration EnvironmentConfiguration 匿名、従業員、アプリケーション 単体の環境構成を取得します。
GetExtensionProfile ExtensionProfile 匿名、従業員、アプリケーション 拡張機能パッケージのダウンロードとマイクロ サービスとの通信に使用できる拡張機能プロファイルを取得します。

拡張機能パッケージ定義コントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetExtensionPackageDefinitions QueryResultSettings クエリ結果設定 (QueryResultSettings) IEnumerableExtensionPackageDefinition デバイス、従業員、アプリケーション 構成されている拡張機能パッケージ定義を取得します。

拡張可能な列挙型パッケージ定義コントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetExtensibleEnumerations QueryResultSettings クエリ結果設定 (QueryResultSettings) IEnumerable拡張可能列挙コンテナ デバイス、従業員、アプリケーション、匿名、顧客、店舗 すべての拡張可能な列挙クラスを取得します。

ロイヤルティ カード コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
IssueLoyaltyCard ロイヤルティカード loyaltyCard LoyaltyCard 従業員、顧客 新しいロイヤルティ カードを発行します。
GetLoyaltyCard 文字列 cardNumber LoyaltyCard 従業員、顧客 ロイヤルティ カードを取得します。
GetCustomerLoyaltyCards string accountNumber、QueryResultSettings queryResultSettings PageResultポイントカード 従業員、顧客 顧客のロイヤルティカードを取得します。
GetLoyaltyCardTransactions 文字列 cardNumber、文字列 rewardPointId、QueryResultSettings queryResultSettings PageResultLoyaltyCardTransaction 従業員、顧客 ロイヤルティ カード トランザクションを取得します。
GetLoyaltyRewardPointActivityTimeline 文字列 cardNumber、文字列 rewardPointId、QueryResultSettings queryResultSettings PageResultLoyaltyRewardPointActivity 従業員、顧客 ロイヤルティカードの特典ポイントのタイムライン活動を取得します。
GetLoyaltyRewardPointActivityTimelineForExpiredPoints 文字列 cardNumber、文字列 rewardPointId、QueryResultSettings queryResultSettings ページ結果ロイヤルティリワードポイント活動 従業員、顧客 ロイヤルティカードの特典ポイントの期限切れポイントのタイムライン活動を取得します。
GetLoyaltyRewardPointsExpiringSoon 文字列 cardNumber、文字列 rewardPointId、int daysToExpiry、QueryResultSettings queryResultSettings ページ結果ロイヤルティポイント履歴 従業員、顧客 有効期限が近づいたロイヤルティカードの特典ポイントを取得します。

販売以外のトランザクションの支払/入金操作コントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
GetNonSalesTransactions 文字列 shiftId、文字列 shiftTerminalId、int nonSalesTenderTypeValue、QueryResultSettings queryResultSettings ページ結果非販売取引Note: This translation assumes the term should be more descriptive to Japanese-speaking users while maintaining its technical nature. 従業員 非販売の支払/入金操作の集計金額を取得します。
CreateNonSalesTransaction NonSalesTransaction (非売上トランザクション) NonSalesTransaction (非売上トランザクション) NonSalesTransaction 従業員 開始金額の申告、支払 / 入金の削除、釣銭入力などの工程のドロワー タイプの保存を実行します。
GetAffiliations QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果所属 従業員 所属を取得。

工程コントローラー

API パラメーター 戻り値 対応している商取引上の役割 内容
GetOperationPermissionById Int operationId OperationPermission 従業員 操作の ID を使用して、工程のアクセス許可を取得します。
GetOperationPermissions QueryResultSettings クエリ結果設定 (QueryResultSettings) PageResultOperationPermission 従業員 操作のアクセス許可のコレクションを返します。
SearchJournalTransactions TransactionSearchCriteria searchCriteria、QueryResultSettings queryResultSettings ページ結果トランザクション 従業員 指定された検索条件に一致するトランザクションのコレクションを返します。
GetInventoryAvailableToPromise long productId、文字列 itemId、文字列 inventoryLocationId、QueryResultSettings queryResultSettings 在庫利用可能性ページ結果 従業員 製品のすべての店舗で利用可能な在庫を取得します。
VoidSuspendedTransactions IEnumerable文字列 suspendedCartIds 無効 従業員 特定のカート ID で指定された中断されたトランザクションを無効にします。

調整行コントローラーのシフト

API パラメーター 戻り値 対応している商取引上の役割 内容
GetShiftReconciliationLines ShiftReconciliationLineRetrievalCriteria shiftReconciliationLineRetrievalCriteria、QueryResultSettings queryResultSettings PageResultシフト再精算行 従業員 ダウンロードの間隔を取得します。
ReconcileLines IEnumerableShiftReconciliationLine 行、文字列の説明 無効 従業員 行を調整します。
UndoReconciliation IEnumerableShiftReconciliationLine 行 無効 従業員 渡された行のうち、いずれかのグループに属するすべての行を再調整解除します。

在庫数履歴のコントローラ

API パラメーター 戻り値 対応している商取引上の役割 内容
取得 QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果在庫カウントジャーナル 従業員 StockCountJournal エンティティを IQueryable として取得します。
同期 QueryResultSettings クエリ結果設定 (QueryResultSettings) ページ結果在庫カウントジャーナル 従業員 AX からの在庫数仕訳帳を RetailServer DB へと同期して、DB から SC 履歴の現在のリストを取得します。
SyncTransactions 文字列 journalId、QueryResultSettings queryResultSettings ページ結果在庫計上ジャーナルトランザクション 従業員 AX からの在庫数仕訳帳を RetailServer へと同期して、履歴取引の現在のリストを取得します。
RemoveJournal 文字列 journalId 無効 従業員 在庫数棚卸仕訳帳をローカルから削除します。
RemoveTransaction 文字列 journalId、文字列 itemId、文字列 inventSizeId、文字列 inventColorId、文字列 inventStyleId、文字列 configId 無効 従業員 在庫数仕訳帳をローカルから削除します。
RemoveStockCountLineByLineId 文字列 journalId、stockCountLineId long型 無効 従業員 在庫数明細行 ID によって、ローカルから在庫数仕訳帳トランザクションから削除します。
RemoveStockCountLineByProductRecId 文字列 journalId、productRecId long型 無効 従業員 製品 ID によって、ローカルから在庫数仕訳帳トランザクションから削除します。
確定 文字列 journalId 無効 従業員 在庫仕訳帳トランザクションの一覧をに AX にコミットします。
GetEntityByKey 文字列 journalId StockCountJournal 従業員 仕訳帳エンティティを作成します。
UpdateEntity StockCountJournal エンティティ StockCountJournal 従業員 仕訳帳エンティティを更新します。
PatchEntity StockCountJournal エンティティ StockCountJournal 従業員 仕訳帳エンティティを部分的に更新します。

結果コントローラのスキャン

API パラメーター 戻り値 対応している商取引上の役割 内容
GetEntityByKey 文字列 scannedText ScanResult 従業員 キーにより ScanResult エンティティを取得します。
  • Last updated on