feed-common 1.77.4 → 1.77.6

package/src/utils/feed-templates/ebay.template.ts

@@ -4,14 +4,20 @@ import { validateIfNoMacro } from './common-schemas.js';
 import {
     ACTION_ARRAY_FIRST_ITEMS,
     SOURCE_EBAY_GALLERY_TYPE,
+    SOURCE_EBAY_INTERNATIONAL_REFUND_OPTIONS,
+    SOURCE_EBAY_INTERNATIONAL_RETURNS_ACCEPTED,
     SOURCE_EBAY_INVENTORY_TRACKING,
     SOURCE_EBAY_LISTING_TYPE,
+    SOURCE_EBAY_MEASUREMENT_UNITS,
+    SOURCE_EBAY_PAID_BY_COST,
     SOURCE_EBAY_YES_NO,
     SOURCE_SHOPIFY_DESCRIPTION_HTML,
     SOURCE_SHOPIFY_IMAGE,
     SOURCE_SHOPIFY_IMAGES,
     SOURCE_SHOPIFY_SHOP_COUNTRY,
     SOURCE_SHOPIFY_SHOP_CURRENCY,
+    SOURCE_SHOPIFY_SHOP_POSTAL_CODE,
+    SOURCE_SHOPIFY_VENDOR,
 } from '../../constants/profile.constants.js';
 import { SelectItem, XmlFeedTemplateType } from '../../types/profile.types.js';
 import { resolveSourceValue } from '../profile.js';
@@ -30,7 +36,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
     documentation: 'https://developer.ebay.com/devzone/xml/docs/reference/ebay/AddFixedPriceItem.html',
     mapping: [
         {
-            attribute: 'AutoPay',
+            attribute: ' Item.AutoPay',
             label: 'AutoPay',
             description: 'Indicates whether the seller requires immediate payment for the item',
             required: false,
@@ -43,7 +49,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'BestOfferEnabled',
+            attribute: 'Item.BestOfferEnabled',
             label: 'Best Offer Enabled',
             description: 'Indicates whether the seller is accepting Best Offers for the item',
             required: false,
@@ -56,7 +62,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'CategoryMappingAllowed',
+            attribute: 'Item.CategoryMappingAllowed',
             label: 'Category Mapping Allowed',
             description:
                 'This boolean field controls whether or not eBay automatically maps outdated Category ID(s) specified in a PrimaryCategory and/or SecondaryCategory container(s) to the updated Category ID(s) no longer exists in the current category structure',
@@ -70,7 +76,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'ConditionID',
+            attribute: 'Item.ConditionID',
             label: 'Condition',
             description: 'The condition of the item. For example, New, Used, or Refurbished',
             required: false,
@@ -81,7 +87,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'Country',
+            attribute: 'Item.Country',
             label: 'Country',
             description: 'The country where the item is located',
             required: true,
@@ -93,7 +99,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'Currency',
+            attribute: 'Item.Currency',
             label: 'Currency',
             description: 'The currency of the item price',
             required: true,
@@ -105,7 +111,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'Description',
+            attribute: 'Item.Description',
             label: 'Description',
             description: 'The description of the item',
             required: true,
@@ -117,8 +123,8 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'DiscountPrice',
-            label: 'Description',
+            attribute: 'Item.DiscountPriceInfo.MinimumAdvertisedPrice', // TODO: check if this is correct
+            label: 'Discount Price',
             description: 'The discount price of the item',
             required: false,
             type: 'macro-input',
@@ -129,7 +135,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'DispatchTimeMax',
+            attribute: 'Item.DispatchTimeMax',
             label: 'Dispatch Time Max',
             description:
                 'The maximum number of business days the seller commits to for shipping an item to a buyer after receiving a cleared payment',
@@ -142,7 +148,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'InventoryTrackingMethod',
+            attribute: 'Item.InventoryTrackingMethod',
             label: 'Inventory Tracking Method',
             description: 'The method used to track the inventory level of the item',
             required: false,
@@ -161,7 +167,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
         // TODO: add compatibility list items
         // TODO: add item specifics
         {
-            attribute: 'ListingDuration',
+            attribute: 'Item.ListingDuration',
             label: 'Listing Duration',
             description: 'The length of time the listing will be active',
             required: false,
@@ -173,7 +179,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             singleChoice: true,
         },
         {
-            attribute: 'ListingType',
+            attribute: 'Item.ListingType',
             label: 'Listing Type',
             description: 'The type of listing',
             required: true,
@@ -198,10 +204,10 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
         },
         // TODO: set PictureSource to Vendor
         {
-            attribute: 'PictureURL',
+            attribute: 'Item.PictureDetails.PictureURL',
             label: 'Picture URL',
             description:
-                'Contains the URL for a picture of the item. You can pass in up to 24 picture URLs for each listing. The Gallery image will be the first PictureURL in the list',
+                'Contains comma separated list of product picture URLs. You can pass in up to 24 picture URLs for each listing. The Gallery image will be the first PictureURL in the list',
             required: false,
             type: 'macro-input',
             defaultValue:
@@ -214,5 +220,352 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
             fixedValue: true,
             singleChoice: true,
         },
+        {
+            attribute: 'Item.PostalCode',
+            label: 'Postal Code',
+            description: 'The postal code where the item is located',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_SHOPIFY_SHOP_POSTAL_CODE),
+            rules: { sections: [] },
+            baseMode: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.PrimaryCategory.CategoryID',
+            label: 'Primary Category',
+            description: 'The primary category of the item',
+            required: true,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: true,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.SecondaryCategory.CategoryID',
+            label: 'Secondary Category',
+            description: 'The secondary category of the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: true,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ProductListingDetails.BrandMPN.Brand',
+            label: 'Brand',
+            description: 'The brand of the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_SHOPIFY_VENDOR),
+            rules: { sections: [] },
+            validator: v => validateIfNoMacro(v, z.string().max(65).optional()),
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ProductListingDetails.BrandMPN.MPN',
+            label: 'MPN',
+            description: 'The Manufacturer Part Number of the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: v => validateIfNoMacro(v, z.string().max(65).optional()),
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ProductListingDetails.EAN',
+            label: 'EAN',
+            description: 'The European Article Number of the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ProductListingDetails.UPC',
+            label: 'UPC',
+            description: 'The Universal Product Code of the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.Quantity',
+            label: 'Quantity',
+            description: 'The number of items available for purchase',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: true,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.QuantityRestrictionPerBuyer.MaximumQuantity',
+            label: 'Maximum Quantity Per Buyer',
+            description: 'The maximum number of items that a buyer can purchase',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+            validator: v => validateIfNoMacro(v, z.coerce.number().gte(0).optional()),
+        },
+        {
+            attribute: 'Item.SellerProfiles.SellerPaymentProfile.PaymentProfileID',
+            label: 'Business Policy Payment Profile',
+            description: 'The payment profile to use for the listing',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.SellerProfiles.SellerReturnProfile.ReturnProfileID',
+            label: 'Business Policy Return Profile',
+            description: 'The return profile to use for the listing',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.SellerProfiles.SellerShippingProfile.ShippingProfileID',
+            label: 'Business Policy Shipping Profile',
+            description: 'The shipping profile to use for the listing',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.InternationalRefundOption',
+            label: 'International Refund Option',
+            description: 'This field indicates how the seller compensates international buyers for returns',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_INTERNATIONAL_REFUND_OPTIONS, ['MoneyBack']),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.InternationalReturnsAcceptedOption',
+            label: 'International Returns Accepted Option',
+            description:
+                'The value in this field indicates whether or not the seller accepts returns from international buyers',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_INTERNATIONAL_RETURNS_ACCEPTED),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.InternationalReturnsWithinOption',
+            label: 'International Returns Within Option',
+            description:
+                'The value in this field indicates the number of days that an international buyer has to return an item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.InternationalShippingCostPaidByOption',
+            label: 'International Shipping Cost Paid By Option',
+            description:
+                'The value in this field indicates whether the buyer or seller is responsible for return shipping costs for international returns',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_PAID_BY_COST),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.RefundOption',
+            label: 'Refund Option',
+            description: 'This field indicates how the seller compensates buyers for returns',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_INTERNATIONAL_REFUND_OPTIONS, ['MoneyBack']),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.ReturnsAcceptedOption',
+            label: 'Returns Accepted Option',
+            description: 'This field indicates whether or not the seller accepts returns',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_INTERNATIONAL_RETURNS_ACCEPTED),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.ReturnsWithinOption',
+            label: 'Returns Within Option',
+            description: 'Specifies the amount of time the buyer has to return an item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '', // TODO: add source
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ReturnPolicy.ShippingCostPaidByOption',
+            label: 'Shipping Cost Paid By Option',
+            description: 'This option specifies whether the buyer or the seller pays for return shipping charges',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_PAID_BY_COST),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.SellerProvidedTitle',
+            label: 'Seller Provided Title',
+            description:
+                "A descriptive free-text title for a US or CA eBay Motors vehicle listing. This title appears below eBay's pre-filled listing title on the View Item page",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: false,
+            validator: v => validateIfNoMacro(v, z.string().max(80).optional()),
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.MeasurementUnit',
+            label: 'Measurement Unit',
+            description:
+                "The unit of measurement used to specify the dimensions of a shipping package. This field is required if the seller is specifying the dimensions of a shipping package in the 'ShippingPackageDetails' container",
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_MEASUREMENT_UNITS),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.PackageDepth',
+            label: 'Package Depth',
+            description: 'Depth of the package, in whole number of inches, needed to ship the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.PackageLength',
+            label: 'Package Length',
+            description: 'Length of the package, in whole number of inches, needed to ship the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetail.PackageWidth',
+            label: 'Package Width',
+            description: 'Width of the package, in whole number of inches, needed to ship the item',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.ShippingIrregular',
+            label: 'Shipping Irregular',
+            description:
+                'Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only',
+            required: false,
+            type: 'macro-input',
+            defaultValue: makeMacroString(SOURCE_EBAY_YES_NO),
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: true,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.WeightMajor',
+            label: 'Weight Major',
+            description:
+                'WeightMajor is used to specify the weight of the package in pounds (in US) or kilograms (all countries that use metric system). The value needs to by rounded up to the nearest whole number',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
+        {
+            attribute: 'Item.ShippingPackageDetails.WeightMinor',
+            label: 'Weight Minor',
+            description:
+                'WeightMinor is used to specify the weight of the package in ounces (in US) or grams (all countries that use metric system). The value needs to by rounded up to the nearest whole number',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            baseMode: false,
+            fixedValue: false,
+            singleChoice: true,
+        },
     ],
 };

package/src/utils/profile.ts

@@ -20,8 +20,12 @@ import {
     SOURCE_COUNTRY,
     SOURCE_CURRENCY,
     SOURCE_EBAY_GALLERY_TYPE,
+    SOURCE_EBAY_INTERNATIONAL_REFUND_OPTIONS,
+    SOURCE_EBAY_INTERNATIONAL_RETURNS_ACCEPTED,
     SOURCE_EBAY_INVENTORY_TRACKING,
     SOURCE_EBAY_LISTING_TYPE,
+    SOURCE_EBAY_MEASUREMENT_UNITS,
+    SOURCE_EBAY_PAID_BY_COST,
     SOURCE_EBAY_YES_NO,
     SOURCE_ENERGY_EFFICIENCY,
     SOURCE_FB_AGE_GROUP,
@@ -69,6 +73,10 @@ import { EbayYesNoSource } from '../sources/ebay-yes-no.source.js';
 import { eBayInventoryTrackingSource } from '../sources/ebay-inventory-tracking.source.js';
 import { EbayListingTypeSource } from '../sources/ebay-listing-type.source.js';
 import { EbayGalleryTypeSource } from '../sources/ebay-gallery-type.source.js';
+import { EbayInternationalRefundOptionsSource } from '../sources/ebay-refund-options.source.js';
+import { EbayInternationalReturnsAcceptedSource } from '../sources/ebay-returns-accepted.source.js';
+import { EbayPaidByCostSource } from '../sources/ebay-paid-by-cost.source.js';
+import { EbayMeasurementUnitsSource } from '../sources/ebay-measurement-units.source.js';
 
 /**
  * Check for rules duplication
@@ -421,6 +429,14 @@ export function resolveSourceValue(source: string): SelectItem[] | null {
             return EbayListingTypeSource;
         case SOURCE_EBAY_GALLERY_TYPE:
             return EbayGalleryTypeSource;
+        case SOURCE_EBAY_INTERNATIONAL_REFUND_OPTIONS:
+            return EbayInternationalRefundOptionsSource;
+        case SOURCE_EBAY_INTERNATIONAL_RETURNS_ACCEPTED:
+            return EbayInternationalReturnsAcceptedSource;
+        case SOURCE_EBAY_PAID_BY_COST:
+            return EbayPaidByCostSource;
+        case SOURCE_EBAY_MEASUREMENT_UNITS:
+            return EbayMeasurementUnitsSource;
         default:
             return null;
     }