Codeunit 30177 Shpfy Product Events

Shopify Connector, Microsoft.Integration.Shopify

src/Apps/W1/Shopify/App/src/Products/Codeunits/ShpfyProductEvents.Codeunit.al455 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace Microsoft.Integration.Shopify;using Microsoft.Inventory.Item;/// <summary>/// Codeunit Shpfy Product Events (ID 30177)./// </summary>codeunit 30177 "Shpfy Product Events"{    /// <summary>     /// Description for OnAfterSetProductTitle.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="LanguageCode">Parameter of type Code[10].</param>    /// <param name="Title">Parameter of type Text.</param>    [InternalEvent(false)]    internal procedure OnAfterSetProductTitle(Item: Record Item; LanguageCode: Code[10]; var Title: Text)    begin    end;    /// <summary>     /// Raised After Create Item.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCreateItem(Shop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var Item: Record Item);    begin    end;    /// <summary>     /// Raised After Create Item Variant.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCreateItemVariant(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; var ItemVariant: Record "Item Variant");    begin    end;    /// <summary>     /// Raised After Temp Shopify Product and Variant are created.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="ShopifyTag">Parameter of type Record "Shopify Tag".</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCreateTempShopifyProduct(Item: Record Item; var ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; var ShopifyTag: Record "Shpfy Tag")    begin    end;    /// <summary>     /// Raised After Temp Shopify Variant from Item is created.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCreateTempShopifyVariant(Item: Record Item; var ShopifyVariant: Record "Shpfy Variant")    begin    end;    /// <summary>     /// Raised After Create Product Body Html.    /// </summary>    /// <param name="ItemNo">Parameter of type Code[20].</param>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ProductBodyHtml">Parameter of type Text.</param>    /// <param name="LanguageCode">Parameter of type Code[10].</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCreateProductBodyHtml(ItemNo: Code[20]; ShopifyShop: Record "Shpfy Shop"; var ProductBodyHtml: Text; LanguageCode: Code[10])    begin    end;    /// <summary>    /// Raised before updating product metafields in Shopify.    /// </summary>    /// <param name="ProductId">The Shopify product Id.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeUpdateProductMetafields(ProductId: BigInteger)    begin    end;#pragma warning disable AS0027    /// <summary>     /// Raised After Find Item Template.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="TemplateCode">Parameter of type Code[20].</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterFindItemTemplate(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var TemplateCode: Code[20]);    begin    end;#pragma warning restore AS0027    [IntegrationEvent(false, false)]    internal procedure OnAfterGetCommaSeparatedTags(ShopifyProduct: Record "Shpfy Product"; var Tags: Text)    begin    end;    /// <summary>     /// Description for OnAfterGetBarcode.    /// </summary>    /// <param name="ItemNo">Parameter of type Code[20].</param>    /// <param name="VariantCode">Parameter of type Code[10].</param>    /// <param name="UoM">Parameter of type Code[10].</param>    /// <param name="Barcode">Parameter of type Text.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterGetBarcode(ItemNo: Code[20]; VariantCode: Code[10]; UoM: Code[10]; var Barcode: Text)    begin    end;    /// <summary>     /// Raised Before Create Item.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeCreateItem(Shop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var Item: Record Item; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised Before Create Item Variant.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeCreateItemVariant(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; var ItemVariant: Record "Item Variant"; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised Before Create Item Variant Code.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariantCode">Parameter of type Code[10].</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeCreateItemVariantCode(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; var ItemVariantCode: Code[10]; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised Before Create Product Body Html.    /// </summary>    /// <param name="ItemNo">Parameter of type Code[20].</param>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ProductBodyHtml">Parameter of type Text.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    /// <param name="LanguageCode">Parameter of type Code[10].</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeCreateProductBodyHtml(ItemNo: Code[20]; ShopifyShop: Record "Shpfy Shop"; var ProductBodyHtml: Text; var Handled: Boolean; LanguageCode: Code[10])    begin    end;#pragma warning disable AS0027    /// <summary>     /// Raised Before Find Item Template.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="TemplateCode">Parameter of type Code[20].</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeFindItemTemplate(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var TemplateCode: Code[20]; var Handled: Boolean);    begin    end;#pragma warning restore AS0027    /// <summary>     /// Description for OnBeforGetBarcode.    /// </summary>    /// <param name="ItemNo">Parameter of type Code[20].</param>    /// <param name="VariantCode">Parameter of type Code[10].</param>    /// <param name="UoM">Parameter of type Code[10].</param>    /// <param name="Barcode">Parameter of type Text.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforGetBarcode(ItemNo: Code[20]; VariantCode: Code[10]; UoM: Code[10]; var Barcode: Text; var Handled: Boolean)    begin    end;    /// <summary>     /// Description for OnBeforSetProductTitle.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="LanguageCode">Parameter of type Code[10].</param>    /// <param name="Title">Parameter of type Text.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforSetProductTitle(Item: Record Item; LanguageCode: Code[10]; var Title: Text; var Handled: Boolean)    begin    end;    /// <summary>     /// Raised Before Find Mapping.    /// </summary>    /// <param name="Direction">Parameter of type enum "Shopify Mapping Direction".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeFindProductMapping(Direction: Enum "Shpfy Mapping Direction"; var ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; var Item: Record Item; var ItemVariant: Record "Item Variant"; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised After Calculate Unit Price.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="VariantCode">Parameter of type Code[20].</param>    /// <param name="UnitOfMeasure">Parameter of type Code[20].</param>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="Catalog">Parameter of type Record "Shopify Catalog".</param>    /// <param name="UnitCost">Parameter of type Decimal.</param>    /// <param name="Price">Parameter of type Decimal.</param>    /// <param name="ComparePrice">Parameter of type Decimal.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterCalculateUnitPrice(Item: Record Item; VariantCode: Code[20]; UnitOfMeasure: Code[20]; ShopifyShop: Record "Shpfy Shop"; Catalog: Record "Shpfy Catalog"; var UnitCost: Decimal; var Price: Decimal; var ComparePrice: Decimal)    begin    end;    /// <summary>     /// Raised Before Calculate Unit Price.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="VariantCode">Parameter of type Code[20].</param>    /// <param name="UnitOfMeasure">Parameter of type Code[20].</param>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="Catalog">Parameter of type Record "Shopify Catalog".</param>    /// <param name="UnitCost">Parameter of type Decimal.</param>    /// <param name="Price">Parameter of type Decimal.</param>    /// <param name="ComparePrice">Parameter of type Decimal.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeCalculateUnitPrice(Item: Record Item; VariantCode: Code[20]; UnitOfMeasure: Code[20]; ShopifyShop: Record "Shpfy Shop"; Catalog: Record "Shpfy Catalog"; var UnitCost: Decimal; var Price: Decimal; var ComparePrice: Decimal; var Handled: Boolean)    begin    end;    /// <summary>     /// Raised After Update Item.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterUpdateItem(Shop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var Item: Record Item);    begin    end;    /// <summary>     /// Raised After Update Item Variant.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterUpdateItemVariant(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; var ItemVariant: Record "Item Variant");    begin    end;    /// <summary>     /// Raised Before Update Item.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeUpdateItem(Shop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; ShopifyVariant: Record "Shpfy Variant"; var Item: Record Item; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised Before Update Item Variant.    /// </summary>    /// <param name="Shop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    /// <param name="Handled">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeUpdateItemVariant(Shop: Record "Shpfy Shop"; ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; var ItemVariant: Record "Item Variant"; var Handled: Boolean);    begin    end;    /// <summary>     /// Raised Before Send Create Shopify Product.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeSendCreateShopifyProduct(ShopifyShop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; var ShopifyVariant: Record "Shpfy Variant"; var ShpfyTag: Record "Shpfy Tag")    begin    end;    /// <summary>     /// Raised Before Send Update Shopify Product.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shopify Product".</param>    /// <param name="xShopifyProduct">Parameter of type Record "Shopify Product".</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeSendUpdateShopifyProduct(ShopifyShop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; xShopifyProduct: Record "Shpfy Product")    begin    end;    /// <summary>     /// Raised Before Send Add Shopify Product Variant.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeSendAddShopifyProductVariant(ShopifyShop: Record "Shpfy Shop"; var ShopifyVariant: Record "Shpfy Variant")    begin    end;    /// <summary>     /// Raised Before Send Update Shopify Product Variant.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shopify Variant".</param>    /// <param name="xShopifyVariant">Parameter of type Record "Shopify Variant".</param>    [IntegrationEvent(false, false)]    internal procedure OnBeforeSendUpdateShopifyProductVariant(ShopifyShop: Record "Shpfy Shop"; var ShopifyVariant: Record "Shpfy Variant"; xShopifyVariant: Record "Shpfy Variant")    begin    end;    /// <summary>     /// Raised Before Modify on Items.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyProduct">Parameter of type Record "Shpfy Product".</param>    /// <param name="Item">Parameter of type Record "Item".</param>    /// <param name="IsModified">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnDoUpdateItemBeforeModify(var ShopifyShop: Record "Shpfy Shop"; var ShopifyProduct: Record "Shpfy Product"; var Item: Record Item; var IsModifiedByEvent: Boolean);    begin    end;    /// <summary>     /// Raised Before Modify Items Variant.    /// </summary>    /// <param name="ShopifyShop">Parameter of type Record "Shopify Shop".</param>    /// <param name="ShopifyVariant">Parameter of type Record "Shpfy Variant".</param>    /// <param name="ItemVariant">Parameter of type Record "Shpfy Variant".</param>    /// <param name="IsModified">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnDoUpdateItemVariantBeforeModify(var ShopifyShop: Record "Shpfy Shop"; var ShopifyVariant: Record "Shpfy Variant"; var ItemVariant: Record "Item Variant"; var IsModifiedByEvent: Boolean);    begin    end;    /// <summary>     /// Raised After Modify Item Picture.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ImageUrl">Parameter of type Text.</param>    /// <param name="InStream">Parameter of type InStream.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterUpdateItemPicture(var Item: Record Item; ImageUrl: Text; InStream: InStream)    begin    end;    /// <summary>     /// Raised After Modify Item Variant Picture.    /// </summary>    /// <param name="ItemVariant">Parameter of type Record "Item Variant".</param>    /// <param name="ImageUrl">Parameter of type Text.</param>    /// <param name="InStream">Parameter of type InStream.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterUpdateItemVariantPicture(var ItemVariant: Record "Item Variant"; ImageUrl: Text; InStream: InStream)    begin    end;    /// <summary>     /// Raised After Shopify Product fields are filled from Business Central Item. These fields are sent to Shopify when creating or updating a product.    /// </summary>    /// <param name="Item">Parameter of type Record Item.</param>    /// <param name="ShopifyProduct">Parameter of Record "Shopify Product".</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterFillInShopifyProductFields(Item: Record Item; var ShopifyProduct: Record "Shpfy Product")    begin    end;    /// <summary>    /// Raised after products to export are filtered.    /// </summary>    /// <param name="ShopifyProduct">Parameter of type Record "Shpfy Product".</param>    /// <param name="Shop">Parameter of type Record "Shpfy Shop".</param>    /// <param name="OnlyUpdatePrice">Parameter of type Boolean.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterProductsToSynchronizeFiltersSet(var ShopifyProduct: Record "Shpfy Product"; Shop: Record "Shpfy Shop"; OnlyUpdatePrice: Boolean)    begin    end;    /// <summary>    /// Raised after the product variant data has been filled from Business Central Item, Item Variant, and Item Unit of Measure.    /// This event allows customization of the Shopify variant after all standard fields are set, but only when an Item Variant is present.    /// </summary>    /// <param name="ShopifyVariant">The Shopify variant record to be customized.</param>    /// <param name="Item">The source Item record.</param>    /// <param name="ItemVariant">The source Item Variant record.</param>    /// <param name="ItemUnitofMeasure">The source Item Unit of Measure record.</param>    /// <param name="Shop">The Shopify shop context.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterFillInProductVariantDataFromVariant(var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; ItemVariant: Record "Item Variant"; ItemUnitofMeasure: Record "Item Unit of Measure"; Shop: Record "Shpfy Shop")    begin    end;    /// <summary>    /// Raised after the product variant data has been filled from Business Central Item and Item Variant (without Unit of Measure).    /// This event allows customization of the Shopify variant after all standard fields are set.    /// </summary>    /// <param name="ShopifyVariant">The Shopify variant record to be customized.</param>    /// <param name="Item">The source Item record.</param>    /// <param name="ItemVariant">The source Item Variant record.</param>    /// <param name="Shop">The Shopify shop context.</param>    [IntegrationEvent(false, false)]    internal procedure OnAfterFillInProductVariantData(var ShopifyVariant: Record "Shpfy Variant"; Item: Record Item; ItemVariant: Record "Item Variant"; Shop: Record "Shpfy Shop")    begin    end;}