Dynamics 365 Retail - List POS API exposed to perform functionality. - Song Nghia - #Open To Relocate

Dynamics 365 Outsourcing Service

Chủ Nhật, 18 tháng 9, 2022

Dynamics 365 Retail - List POS API exposed to perform functionality.

Dynamics 365 Retail - List POS API exposed to perform functionality.

Extending a transactional Retail Channel table

Nghia Song -  Microsoft Dynamics 365 Technical Consultant

Nghia Song

Tel - WhatsApp: +84967324794

Email: songnghia.uit@gmail.com


Cart

The following table lists APIs exposed to perform cart-related functionality.

POS APIDescriptionRelease
AddPreprocessedTenderLineToCartClientRequestAdds the pre-processed tender line to the cart.10.0.14
AddTenderLineToCartClientRequestAdds the tender line to the cart.10.0.14
ConcludeTransactionClientRequestConcludes the transaction.10.0.14
GetCurrentCartClientRequestGets the current cart.10.0.14
GetKeyedInPriceClientRequestGets the keyed in price.10.0.14
GetPickupDateClientRequestGets the pickup date.10.0.14
GetReasonCodeLinesClientRequestGets the reason code.10.0.14
GetReceiptEmailAddressClientRequestGets the receipt email address.10.0.14
GetShippingDateClientRequestGets the shipping date.10.0.14
RefreshCartClientRequestRefresh the current cart with the cart data from the server.10.0.14
ResumeSuspendedCartClientRequestResumes the suspended transaction based on the ID passed.10.0.14
SaveAttributesOnCartClientRequestSaves the attributes on the cart.10.0.14
SaveAttributesOnCartLinesClientRequestSaves the attributes on the cart line.10.0.14
SaveExtensionPropertiesOnCartClientRequestSaves the extension properties on the cart.10.0.14
SaveExtensionPropertiesOnCartLinesClientRequestSaves the extension properties on the cart line.10.0.14
SaveReasonCodeLinesOnCartClientRequestSaves the reason code lines on the cart.10.0.14
SaveReasonCodeLinesOnCartLinesClientRequestSaves the reason code lines on the cart line.10.0.14
SelectSalesLinesForPickUpClientRequestSelect the sales lines for pickup.10.0.14
SetCartAttributesClientRequestSets the cart attribute.10.0.14
ShowChangeDueClientRequestShows the change due dialog.10.0.14
AddAffiliationOperationRequestAdds affiliation to the cart.10.0.14
AddItemToCartOperationRequestAdd items to the cart.10.0.14
CalculateTotalOperationRequestCalculate the total for the cart.10.0.14
ChangeCartLineUnitOfMeasureOperationRequestChanges the cart line unit of measure.10.0.14
CreateCustomerOrderOperationRequestCreates the customer order.10.0.14
CreateCustomerQuoteOperationRequestCreates the customer quote.10.0.14
CustomerAccountDepositOperationRequest10.0.14
DepositOverrideOperationRequestOverrides the deposit amount.10.0.14
EditCustomerOrderOperationRequestEdit the customer order.10.0.14
LineDiscountAmountOperationRequestAdd line discount amount to the cart line.10.0.14
LineDiscountPercentOperationRequestAdd line discount percent to the cart line.10.0.14
OverrideLineTaxFromListOperationRequestOverride the cart line tax from the list.10.0.14
OverrideLineTaxOperationRequestOverride the cart line tax.10.0.14
OverrideTransactionTaxOperationRequestOverride the transaction tax.10.0.14
PickupAllOperationRequestPicks up the order.10.0.14
PriceOverrideOperationRequestOverride the price for the cart line.10.0.14
SetCartLineCommentOperationRequestSets the cart line comment.10.0.14
SetCartLineQuantityOperationRequestSets the cart line quantity.10.0.14
SetCustomerOnCartOperationRequestSets the customer on the cart.10.0.14
SetTransactionCommentOperationRequestSets the transaction comment.10.0.14
SuspendCurrentCartOperationRequestSuspends the current transaction.10.0.14
TotalDiscountAmountOperationRequestAdd total discount amount to the transaction.10.0.14
TotalDiscountPercentOperationRequestAdd total discount percent to the transaction.10.0.14
VoidCartLineOperationRequestVoids the cart line.10.0.14
VoidTenderLineOperationRequestVoids the tender line.10.0.14
VoidTransactionOperationRequestVoids the transaction.10.0.14
CreateEmptyCartServiceRequestCreates empty cart.10.0.14
GetTaxOverridesServiceRequestGets the tax override list.10.0.14
UpdateTenderLineSignatureServiceRequestUpdates the tender line signature data.10.0.14
CarryoutSelectedProductsOperationRequestMarks the selected line as carry out.10.0.14
AddCouponsOperationRequestAdd coupon to the transaction.10.0.14
CreateNonSalesTransactionServiceRequestCreate non sales transaction cart.10.0.14
ReturnTransactionOperationRequestReturns the transaction.10.0.14
AddLoyaltyCardToCartOperationRequestAdds loyalty card to the transaction.10.0.14
ReturnCartLineOperationRequestReturns the cart line.10.0.14
ReturnItemOperationRequestReturns the item.10.0.14
AddExpenseAccountLineToCartOperationRequestAdd expense account line to the cart.10.0.14
ShipAllCartLinesOperationRequestShips all the cart lines.10.0.14
ShipSelectedCartLinesOperationRequestShips the selected cart line.10.0.14
PickupSelectedOperationRequestMarks the included lines for pickup10.0.16

Payments

The following table lists APIs exposed to perform payment-related functionality.

POS APIDescriptionRelease
GetGiftCardByIdServiceRequestGets the gift card ID.10.0.12
GetPaymentCardTypeByBinRangeClientRequestGet the card type bin range.10.0.12
GetSignatureClientRequestShows the signature capture dialog in POS or sends the message to the signature capture device based on the configuration.10.0.15

Peripherals

The following table lists APIs exposed to perform peripheral-related functionality.

POS API
CardPaymentAuthorizePaymentRequest
CardPaymentBeginTransactionRequest
CardPaymentCapturePaymentRequest
CardPaymentEndTransactionRequest
CardPaymentEnquireGiftCardBalancePeripheralRequest
CardPaymentExecuteTaskRequest
CardPaymentRefundPaymentRequest
CardPaymentVoidPaymentRequest
CardPaymentAuthorizeCardTokenPeripheralRequest
CashDrawerIsOpenRequest
HardwareStationDeviceActionRequest
HardwareStationStatusRequest
LineDisplayDisplayLinesRequest
PaymentTerminalAuthorizePaymentActivityRequest
PaymentTerminalAuthorizePaymentRequest
PaymentTerminalBeginTransactionRequest
PaymentTerminalCancelOperationRequest
PaymentTerminalCapturePaymentRequest
PaymentTerminalEndTransactionRequest
PaymentTerminalEnquireGiftCardBalancePeripheralRequest
PaymentTerminalExecuteTaskRequest
PaymentTerminalRefundPaymentActivityRequest
PaymentTerminalRefundPaymentRequest
PaymentTerminalUpdateLinesRequest
PaymentTerminalVoidPaymentRequest
PaymentTerminalFetchTokenPeripheralRequest
PrinterPrintRequest
ScaleReadRequest

ScanResults

The following table lists APIs exposed to perform scan results-related functionality.

POS API
GetScanResultClientRequest

Customer

The following table lists APIs exposed to perform customer-related functionality.

POS API
GetCustomerClientRequest
CreateCustomerServiceRequest
UpdateCustomerServiceRequest
SelectCustomerClientRequest

Authentication

The following table lists APIs exposed to perform authentication-related functionality.

POS API
LogOffOperationRequest
LockRegisterOperationRequest

DataService

The following table lists APIs exposed to perform data service-related functionality.

POS API
DataServiceRequest

Device

The following table lists APIs exposed to perform device-related functionality.

POS API
GetDeviceConfigurationClientRequest
GetExtensionProfileClientRequest
GetHardwareProfileClientRequest
GetAuthenticationTokenClientRequest
GetConnectionStatusClientRequest
GetActiveHardwareStationClientRequest
GetApplicationVersionClientRequest
GetChannelConfigurationClientRequest

Diagnostics

The following table lists APIs exposed to perform diagnostics-related functionality.

POS API
GetSessionInfoClientRequest

Dialog

The following table lists APIs exposed to perform dialog-related functionality.

POS API
ShowMessageDialogClientRequest
IAlphanumericInputDialogResult
ShowAlphanumericInputDialogClientRequest
ShowNumericInputDialogClientRequest
ShowListInputDialogClientRequest
ShowTextInputDialogClientRequest

Employee

The following table lists APIs exposed to perform employee-related functionality.

POS APIDescriptionRelease
GetLoggedOnEmployeeClientRequestGets the current logged in POS employee details.10.0.14
SelectStoreEmployeeClientRequestGets the current store employee list for selection.10.0.16

Formatters

The following table lists APIs exposed to perform formatter-related functionality.

POS API
IBooleanFormatter
ICurrencyFormatter
IDateFormatter
ITransactionTypeFormatter
IPurchaseTransferOrderTypeFormatter

OrgUnits

The following table lists APIs exposed to perform org units-related functionality.

POS API
GetOrgUnitConfigurationClientRequest
GetOrgUnitTenderTypesClientRequest
InventoryLookupOperationRequest

Products

The following table lists APIs exposed to perform products-related functionality.

POS API
GetProductsByIdsClientRequest
GetCurrentProductCatalogStoreClientRequest
SelectProductVariantClientRequest
GetSerialNumberClientRequest
GetRefinerValuesByTextServiceRequest
SelectProductClientRequest
SelectProductVariantClientRequest
GetActivePricesServiceRequest

Categories

The following table lists APIs exposed to perform categories-related functionality.

POS API
GetCategoriesServiceRequest

SalesOrders

The following table lists APIs exposed to perform sales orders-related functionality.

POS API
GetReceiptsClientRequest
RegisterPrintReceiptCopyEventRequest
GetSalesOrderDetailsByTransactionIdClientRequest
GetGiftReceiptsClientRequest
RegisterPrintReceiptCopyEventRequest
MarkAsPickedServiceRequest
PrintPackingSlipClientRequest
PickUpCustomerOrderLinesClientRequest

Shifts

The following table lists APIs exposed to perform shifts-related functionality.

POS API
CloseShiftOperationRequest
CloseShiftOperationRequest

StockCountJournals

The following table lists APIs exposed to perform stock count journals-related functionality.

POS API
SyncAllStockCountJournalsClientRequest

StoreOperations

The following table lists APIs exposed to perform store operations-related functionality.

POS APIDescriptionRelease
DeclareStartingAmountClientRequestDeclare start amount using this request.10.0.14
GetSalesOrdersWithNoFiscalTransactionsRequestGets sales order with no fiscal transaction request.10.0.14
RegisterCustomAuditEventClientRequestRegister custom audit event request.10.0.14
GetOfflinePendingTransactionCountClientRequestGets the offline pending transaction count.10.0.14
SaveFiscalTransactionClientRequestSave fiscal transaction request.10.0.14
SafeDropOperationRequestSafe drop operation request.10.0.14
TenderDeclarationOperationRequestTender declaration operation request.10.0.14
TenderRemovalOperationRequestTender removal operation request.10.0.14
CreateBankDropTransactionClientRequestBank drop transaction request.10.0.14
CreateFloatEntryTransactionClientRequestFloat entry transaction request.10.0.14
CreateStartingAmountTransactionClientRequestCreate start amount transaction request.10.0.14
CreateTenderDeclarationTransactionClientRequestCreate tender declaration transaction request.10.0.14
CreateTenderRemovalTransactionClientRequestRemove tender declaration transaction request.10.0.14
GetDenominationTotalsClientRequestGets the denomination total request.10.0.14
SelectZipCodeInfoClientRequestSelects the Zip code information request.10.0.14
CreateSafeDropTransactionClientRequestCreate safe drop transaction request.10.0.14
GetTenderDetailsClientRequestGets the tender details.10.0.14
LoyaltyCardPointsBalanceOperationRequestGets the loyalty card balance.10.0.14
GetCommissionSalesGroupsServiceRequestGets the commission sales group.10.0.14
GetCurrenciesServiceRequestGets the store currencies.10.0.14
GetSrsReportDataSetServiceRequestGets the Srs report data.10.0.14
SearchCommissionSalesGroupsServiceRequestSearch commission sales groups request.10.0.14
IssueLoyaltyCardOperationRequestIssues loyalty card.10.0.14
GetPickingAndReceivingOrdersClientRequestGets the picking and receiving orders list.10.0.14
BankDropOperationRequestBank drop request.10.0.14
DeclareStartAmountOperationRequestDeclare start amount request.10.0.14
GetAllDiscountsServiceRequestGets the discount applicable for the current cart.10.0.16
Source: https://learn.microsoft.com/en-us/dynamics365/commerce/dev-itpro/POS-APIs