Dynamics 365 Commerce Merchandising (Preview)

The connector exposes actions to search and browse product related information like catalogs, inventory, price and recommendations. The connector connects to the Commerce Cloud Scale Unit (CSU) as a wrapper to provide the headless commerce APIs in simplified and easy way so businesses can easily consume and build Commerce applications.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Microsoft
URL https://support.microsoft.com/
Email abapi@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://dynamics.microsoft.com/en-us/commerce/overview/
Privacy policy https://privacy.microsoft.com/en-us/privacystatement
Supplemental terms https://go.microsoft.com/fwlink/?linkid=2105274
Categories Commerce;Finance

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Retail Server URL string URL of the Retail Server True
Rich media base URL string URL to use in case of channel not having properly configured profile/media server. Expected to be in form of "https://.../imageFileData/search?fileName= ".

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Get Catalogs

Get Catalogs.

Get Categories

Get Categories.

Get Channels

Get Channels.

Get Dimension values

The Dimension values with inventory availabilities for a Product based on the specified requirements.

Get Environment Configuration

Get the Environment Configuration.

Get image locations of Product

Get image locations of a Product.

Get Product Attributes

Get Attributes of a Product.

Get Product Inventory

Get Product Inventory in stores.

Get Product variant

Product variant search by dimensions.

Get Products by IDs

Product search By IDs.

Get recommended Products

A collection of Product recommendations given a collection of product identifiers.

Health Check

Health Check of the Retail Server.

Search Products

Product Search by keyword and category.

Get Catalogs

Get Catalogs.

Parameters

Name Key Required Type Description
Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

response
array of Catalog

Get Categories

Get Categories.

Parameters

Name Key Required Type Description
Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Get Channels

Get Channels.

Returns

response
array of Channel

Get Dimension values

The Dimension values with inventory availabilities for a Product based on the specified requirements.

Parameters

Name Key Required Type Description
Product ID
ProductId True integer

Identifier of the product whose dimension values are to be retrieved.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Get Environment Configuration

Get the Environment Configuration.

Returns

EnvironmentConfiguration entity class.

Get image locations of Product

Get image locations of a Product.

Parameters

Name Key Required Type Description
Product ID
ProductId True integer

Product ID.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Name Path Type Description
array of string

Get Product Attributes

Get Attributes of a Product.

Parameters

Name Key Required Type Description
Product ID
ProductId True integer

Product ID.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Get Product Inventory

Get Product Inventory in stores.

Parameters

Name Key Required Type Description
Product IDs
Product IDs integer
Longitude
Longitude double

Longitude. A value must be between -15069 and 15069 degrees, inclusive.

Latitude
Latitude double

Latitude. A value must be between -90 and 90 degrees, inclusive.

Radius
Radius double

Radius. A value must be non-negative.

Radius unit of measure
RadiusUnitOfMeasure string

Radius metrics like Miles or Kilometers. Default will be based on channel configuration.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Get Product variant

Product variant search by dimensions.

Parameters

Name Key Required Type Description
Product ID
ProductId True integer

Identifier of the master product.

Active date
ActiveDate date-time

Date that the price is needed for.

Type ID
TypeId True integer

Type identifier.

Value
Value True string

Dimension Value.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

Represents Product instance

Body
Product

Get Products by IDs

Product search By IDs.

Parameters

Name Key Required Type Description
Product IDs
Product IDs integer
Skip variant expansion
SkipVariantExpansion boolean

Returns variants in the search result if set to false, true will return only the master product.

Active date
ActiveDate date-time

Date that the price is needed for.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

response
array of Product

A collection of Product recommendations given a collection of product identifiers.

Parameters

Name Key Required Type Description
Customer ID
CustomerId string

Customer account number.

Product IDs
Product IDs integer
Active date
ActiveDate date-time

Date that the price is needed for.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

response
array of Product

Health Check

Health Check of the Retail Server.

Returns

Search Products

Product Search by keyword and category.

Parameters

Name Key Required Type Description
Keyword
Keyword string

Product search text.

Skip variant expansion
SkipVariantExpansion boolean

Returns variants in the search result if set to false, true will return only the master product.

Category ID
CategoryId integer

Category ID.

Active date
ActiveDate date-time

Date that the price is needed for.

Catalog ID
CatalogId integer

Catalog ID for the channel. Default will be Zero.

Channel
ChannelId True integer

Channel ID.

Language ID
LanguageId string

Language ID. By default it will be the channel language.

Returns

response
array of Product

Definitions

Catalog

Represents Catalog instance

Name Path Type Description
Id
Id integer

The ID.

Name
Name string

The name.

Description
Description string

The description.

ImageUrl
ImageUrl string

The image URL.

ExpiryDate
ExpiryDate date-time

The expire date.

Category

Represents Category instance

Name Path Type Description
Id
Id integer

The ID.

Name
Name string

The name.

ImageUrl
ImageUrl string

The image URL.

ParentId
ParentId integer

The parent Category ID.

EnvironmentConfiguration

EnvironmentConfiguration entity class.

Name Path Type Description
EnvironmentId
EnvironmentId string

Gets or sets the EnvironmentId.

EnvironmentName
EnvironmentName string

Gets or sets the EnvironmentName.

TenantId
TenantId string

Gets or sets the TenantId.

ClientAppInsightsInstrumentationKey
ClientAppInsightsInstrumentationKey string

Gets or sets the ClientAppInsightsInstrumentationKey.

HardwareStationAppInsightsInstrumentationKey
HardwareStationAppInsightsInstrumentationKey string

Gets or sets the HardwareStationAppInsightsInstrumentationKey.

WindowsPhonePosAppInsightsInstrumentationKey
WindowsPhonePosAppInsightsInstrumentationKey string

Gets or sets the WindowsPhonePosAppInsightsInstrumentationKey.

BaseVersion
BaseVersion string

Gets or sets the BaseVersion.

ScaleUnit
ScaleUnit ScaleUnitConfiguration

ScaleUnitConfiguration entity class.

AADAuthority
AADAuthority string

Gets or sets the AADAuthority.

FrameworkName
FrameworkName string

Gets or sets the FrameworkName.

ScaleUnitConfiguration

ScaleUnitConfiguration entity class.

Name Path Type Description
Id
Id string

Gets or sets the Id.

Name
Name string

Gets or sets the Name.

Region
Region string

Gets or sets the Region.

Channel

Represents Channel instance

Name Path Type Description
Id
Id integer

The ID.

Name
Name string

The name.

OperatingUnitNumber
OperatingUnitNumber string

The Operating Unit Number.

DisplayName
DisplayName string

The display name.

HealthCheckResult

The HealthCheck result

Name Path Type Description
Name
Name string

The name of check.

Result
Result string

The result.

Attribute

Represents Attribute instance

Name Path Type Description
Id
Id integer

The ID.

Name
Name string

The name.

Value
Value string

The value.

ProductInventory

Represents Product Inventory instance

Name Path Type Description
ProductId
ProductId integer

Product ID.

TotalAvailableQuantity
TotalAvailableQuantity double

The total available quantity.

OrgUnitNumber
OrgUnitNumber string

The location ID.

OrgUnitName
OrgUnitName string

The location name.

Address
Address string

The address.

FormattedStoreHours
FormattedStoreHours string

The formatted store hours.

Distance
Distance double

The distance.

Product

Represents Product instance

Name Path Type Description
Id
Id integer

The record ID.

ItemId
ItemId string

The item ID.

Name
Name string

The name of the product.

Description
Description string

The description of the product.

PrimaryImageUrl
PrimaryImageUrl string

The primary image URL.

UnitOfMeasure
UnitOfMeasure string

The default unit of measure configured for the product.

Price
Price double

The price.

StrikePrice
StrikePrice double

The strike out price.

MinMaxPrice
MinMaxPrice string

The price range for the product.

CurrencyCode
CurrencyCode string

The currency code.

FormattedPrice
FormattedPrice string

The formatted price.

Discount
Discount double

The product discount.

Dimension

Represents Dimension instance

Name Path Type Description
TypeId
TypeId integer

The type ID.

TypeName
TypeName string

The type name.

Values
Values array of DimensionValue

The collection of Dimension values.

DimensionValue

Represents DimensionValue instance

Name Path Type Description
DimensionId
DimensionId string

The ID.

Value
Value string

The value.

Description
Description string

The description.

ProductIds
ProductIds array of integer

The collection of Product IDs.