feed-common 1.87.2 → 1.88.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (14) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/dist/types/product.types.d.ts +4 -3
  3. package/dist/types/product.types.d.ts.map +1 -1
  4. package/dist/utils/feed-templates/ebay-variant.template.d.ts +3 -0
  5. package/dist/utils/feed-templates/ebay-variant.template.d.ts.map +1 -0
  6. package/dist/utils/feed-templates/ebay-variant.template.js +848 -0
  7. package/dist/utils/feed-templates/ebay-variant.template.js.map +1 -0
  8. package/dist/utils/feed-templates/ebay.template.d.ts.map +1 -1
  9. package/dist/utils/feed-templates/ebay.template.js +190 -204
  10. package/dist/utils/feed-templates/ebay.template.js.map +1 -1
  11. package/package.json +1 -1
  12. package/src/types/product.types.ts +3 -2
  13. package/src/utils/feed-templates/ebay-variant.template.ts +897 -0
  14. package/src/utils/feed-templates/ebay.template.ts +192 -205
package/src/utils/feed-templates/ebay.template.ts CHANGED
@@ -99,54 +99,54 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
99
99
  // singleChoice: true,
100
100
  // fixedValue: true,
101
101
  // },
102
- {
103
- attribute: 'Item.Variations.Variation.SKU',
104
- label: 'SKU',
105
- description: 'The SKU of the variant',
106
- required: true,
107
- type: 'macro-input',
108
- defaultValue: makeMacroString(SOURCE_SHOPIFY_ID) + '-' + makeMacroString(SOURCE_SHOPIFY_VARIANT_ID),
109
- rules: { sections: [] },
110
- baseMode: true,
111
- fixedValue: false,
112
- singleChoice: true,
113
- },
114
- {
115
- attribute: 'Item.Variations.Variation.VariationProductListingDetails.EAN',
116
- label: 'EAN',
117
- description: 'The European Article Number',
118
- required: false,
119
- type: 'macro-input',
120
- defaultValue: '',
121
- rules: { sections: [] },
122
- baseMode: false,
123
- fixedValue: false,
124
- singleChoice: true,
125
- },
126
- {
127
- attribute: 'Item.Variations.Variation.VariationProductListingDetails.ISBN',
128
- label: 'ISBN',
129
- description: 'The International Standard Book Number',
130
- required: false,
131
- type: 'macro-input',
132
- defaultValue: '',
133
- rules: { sections: [] },
134
- baseMode: false,
135
- fixedValue: false,
136
- singleChoice: true,
137
- },
138
- {
139
- attribute: 'Item.Variations.Variation.VariationProductListingDetails.UPC',
140
- label: 'UPC',
141
- description: 'The Universal Product Code',
142
- required: false,
143
- type: 'macro-input',
144
- defaultValue: '',
145
- rules: { sections: [] },
146
- baseMode: false,
147
- fixedValue: false,
148
- singleChoice: true,
149
- },
102
+ // {
103
+ // attribute: 'Item.Variations.Variation.SKU',
104
+ // label: 'SKU',
105
+ // description: 'The SKU of the variant',
106
+ // required: true,
107
+ // type: 'macro-input',
108
+ // defaultValue: makeMacroString(SOURCE_SHOPIFY_ID) + '-' + makeMacroString(SOURCE_SHOPIFY_VARIANT_ID),
109
+ // rules: { sections: [] },
110
+ // baseMode: true,
111
+ // fixedValue: false,
112
+ // singleChoice: true,
113
+ // },
114
+ // {
115
+ // attribute: 'Item.Variations.Variation.VariationProductListingDetails.EAN',
116
+ // label: 'EAN',
117
+ // description: 'The European Article Number',
118
+ // required: false,
119
+ // type: 'macro-input',
120
+ // defaultValue: '',
121
+ // rules: { sections: [] },
122
+ // baseMode: false,
123
+ // fixedValue: false,
124
+ // singleChoice: true,
125
+ // },
126
+ // {
127
+ // attribute: 'Item.Variations.Variation.VariationProductListingDetails.ISBN',
128
+ // label: 'ISBN',
129
+ // description: 'The International Standard Book Number',
130
+ // required: false,
131
+ // type: 'macro-input',
132
+ // defaultValue: '',
133
+ // rules: { sections: [] },
134
+ // baseMode: false,
135
+ // fixedValue: false,
136
+ // singleChoice: true,
137
+ // },
138
+ // {
139
+ // attribute: 'Item.Variations.Variation.VariationProductListingDetails.UPC',
140
+ // label: 'UPC',
141
+ // description: 'The Universal Product Code',
142
+ // required: false,
143
+ // type: 'macro-input',
144
+ // defaultValue: '',
145
+ // rules: { sections: [] },
146
+ // baseMode: false,
147
+ // fixedValue: false,
148
+ // singleChoice: true,
149
+ // },
150
150
  {
151
151
  attribute: 'Item.Title',
152
152
  label: 'Title',
@@ -160,7 +160,7 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
160
160
  singleChoice: true,
161
161
  },
162
162
  {
163
- attribute: 'Item.Description', // TODO: CDATA it
163
+ attribute: 'Item.Description',
164
164
  label: 'Description',
165
165
  description: 'The description of the item',
166
166
  required: true,
@@ -197,50 +197,105 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
197
197
  fixedValue: false,
198
198
  singleChoice: true,
199
199
  },
200
+ // {
201
+ // attribute: 'Item.Variations.Pictures.VariationSpecificPictureSet.PictureURL',
202
+ // label: 'Variation Specific Picture Set',
203
+ // description: 'The URL of the pictures of variant. Can consist of up to 12 pictures',
204
+ // required: false,
205
+ // type: 'macro-input',
206
+ // defaultValue:
207
+ // makeMacroString(SOURCE_SHOPIFY_IMAGE) +
208
+ // ',' +
209
+ // makeMacroString(SOURCE_SHOPIFY_IMAGES) +
210
+ // makeMacroString(ACTION_ARRAY_FIRST_ITEMS, ['12']),
211
+ // rules: { sections: [] },
212
+ // baseMode: true,
213
+ // fixedValue: false,
214
+ // singleChoice: true,
215
+ // },
200
216
  {
201
- attribute: 'Item.Variations.Pictures.VariationSpecificPictureSet.PictureURL',
202
- label: 'Variation Specific Picture Set',
203
- description: 'The URL of the pictures of variant. Can consist of up to 12 pictures',
217
+ attribute: 'Item.PictureDetails.GalleryType',
218
+ label: 'Gallery Type',
219
+ description: 'The type of gallery image to use for the listing. Waring: Plus type implies additional fee',
204
220
  required: false,
205
221
  type: 'macro-input',
206
- defaultValue:
207
- makeMacroString(SOURCE_SHOPIFY_IMAGE) +
208
- ',' +
209
- makeMacroString(SOURCE_SHOPIFY_IMAGES) +
210
- makeMacroString(ACTION_ARRAY_FIRST_ITEMS, ['12']),
222
+ defaultValue: makeMacroString(SOURCE_EBAY_GALLERY_TYPE, ['Gallery']),
211
223
  rules: { sections: [] },
212
- baseMode: true,
213
- fixedValue: false,
224
+ baseMode: false,
225
+ fixedValue: true,
214
226
  singleChoice: true,
215
227
  },
228
+ // {
229
+ // attribute: 'Item.Variations.Variation.Quantity',
230
+ // label: 'Quantity',
231
+ // description: 'The number of items available for purchase',
232
+ // required: false,
233
+ // type: 'macro-input',
234
+ // defaultValue: makeMacroString(SOURCE_SHOPIFY_INVENTORY_QUANTITY),
235
+ // rules: { sections: [] },
236
+ // baseMode: true,
237
+ // fixedValue: false,
238
+ // singleChoice: true,
239
+ // },
240
+ // {
241
+ // attribute: 'Item.Variations.Variation.StartPrice',
242
+ // label: 'Price',
243
+ // description: 'The price of the variant',
244
+ // required: true,
245
+ // type: 'macro-input',
246
+ // defaultValue: makeMacroString(SOURCE_SHOPIFY_PRICE),
247
+ // rules: { sections: [] },
248
+ // baseMode: true,
249
+ // fixedValue: false,
250
+ // singleChoice: true,
251
+ // },
252
+ // {
253
+ // attribute: 'Item.Variations.Variation.DiscountPriceInfo.MinimumAdvertisedPrice',
254
+ // label: 'Discount Price',
255
+ // description: 'The discount price of the item',
256
+ // required: false,
257
+ // type: 'macro-input',
258
+ // defaultValue: makeMacroString(SOURCE_SHOPIFY_COMPARE_AT_PRICE),
259
+ // rules: { sections: [] },
260
+ // baseMode: false,
261
+ // fixedValue: false,
262
+ // singleChoice: true,
263
+ // },
216
264
  {
217
- attribute: 'Item.PictureDetails.GalleryType',
218
- label: 'Gallery Type',
219
- description: 'The type of gallery image to use for the listing. Waring: Plus type implies additional fee',
265
+ attribute: 'Item.PictureDetails.PictureURL',
266
+ label: 'Picture URL',
267
+ description:
268
+ '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',
220
269
  required: false,
221
270
  type: 'macro-input',
222
- defaultValue: makeMacroString(SOURCE_EBAY_GALLERY_TYPE, ['Gallery']),
271
+ defaultValue:
272
+ makeMacroString(SOURCE_SHOPIFY_IMAGE) +
273
+ ',' +
274
+ makeMacroString(SOURCE_SHOPIFY_IMAGES) +
275
+ makeMacroString(ACTION_ARRAY_FIRST_ITEMS, ['24']),
223
276
  rules: { sections: [] },
224
277
  baseMode: false,
225
278
  fixedValue: true,
226
279
  singleChoice: true,
227
280
  },
281
+ // TODO: if Item.InventoryTrackingMethod is set to SKU, this field is required
282
+ // if SKU is set on variation level, it should not be set on item level
228
283
  {
229
- attribute: 'Item.Variations.Variation.Quantity',
230
- label: 'Quantity',
231
- description: 'The number of items available for purchase',
284
+ attribute: 'Item.SKU',
285
+ label: 'Product SKU',
286
+ description: 'The SKU of the product',
232
287
  required: false,
233
288
  type: 'macro-input',
234
- defaultValue: makeMacroString(SOURCE_SHOPIFY_INVENTORY_QUANTITY),
289
+ defaultValue: makeMacroString(SOURCE_SHOPIFY_ID) + '-' + makeMacroString(SOURCE_SHOPIFY_VARIANT_ID),
235
290
  rules: { sections: [] },
236
- baseMode: true,
291
+ baseMode: false,
237
292
  fixedValue: false,
238
293
  singleChoice: true,
239
294
  },
240
295
  {
241
- attribute: 'Item.Variations.Variation.StartPrice',
296
+ attribute: 'Item.StartPrice',
242
297
  label: 'Price',
243
- description: 'The price of the variant',
298
+ description: 'The price of the item',
244
299
  required: true,
245
300
  type: 'macro-input',
246
301
  defaultValue: makeMacroString(SOURCE_SHOPIFY_PRICE),
@@ -249,61 +304,6 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
249
304
  fixedValue: false,
250
305
  singleChoice: true,
251
306
  },
252
- {
253
- attribute: 'Item.Variations.Variation.DiscountPriceInfo.MinimumAdvertisedPrice',
254
- label: 'Discount Price',
255
- description: 'The discount price of the item',
256
- required: false,
257
- type: 'macro-input',
258
- defaultValue: makeMacroString(SOURCE_SHOPIFY_COMPARE_AT_PRICE),
259
- rules: { sections: [] },
260
- baseMode: false,
261
- fixedValue: false,
262
- singleChoice: true,
263
- },
264
- // {
265
- // attribute: 'Item.PictureDetails.PictureURL',
266
- // label: 'Picture URL',
267
- // description:
268
- // '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',
269
- // required: false,
270
- // type: 'macro-input',
271
- // defaultValue:
272
- // makeMacroString(SOURCE_SHOPIFY_IMAGE) +
273
- // ',' +
274
- // makeMacroString(SOURCE_SHOPIFY_IMAGES) +
275
- // makeMacroString(ACTION_ARRAY_FIRST_ITEMS, ['24']),
276
- // rules: { sections: [] },
277
- // baseMode: false,
278
- // fixedValue: true,
279
- // singleChoice: true,
280
- // },
281
- // TODO: if Item.InventoryTrackingMethod is set to SKU, this field is required
282
- // if SKU is set on variation level, it should not be set on item level
283
- // {
284
- // attribute: 'Item.SKU',
285
- // label: 'Product SKU',
286
- // description: 'The SKU of the product',
287
- // required: false,
288
- // type: 'macro-input',
289
- // defaultValue: '',
290
- // rules: { sections: [] },
291
- // baseMode: false,
292
- // fixedValue: false,
293
- // singleChoice: true,
294
- // },
295
- // {
296
- // attribute: 'Item.StartPrice',
297
- // label: 'Price',
298
- // description: 'The price of the item',
299
- // required: true,
300
- // type: 'macro-input',
301
- // defaultValue: makeMacroString(SOURCE_SHOPIFY_PRICE),
302
- // rules: { sections: [] },
303
- // baseMode: true,
304
- // fixedValue: false,
305
- // singleChoice: true,
306
- // },
307
307
  // {
308
308
  // attribute: 'Item.Variations.Pictures.VariationSpecificName',
309
309
  // label: 'Variation Specific Name',
@@ -382,18 +382,18 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
382
382
  singleChoice: true,
383
383
  isHidden: true,
384
384
  },
385
- // {
386
- // attribute: 'Item.DiscountPriceInfo.MinimumAdvertisedPrice', // TODO: check if this is correct
387
- // label: 'Discount Price',
388
- // description: 'The discount price of the item',
389
- // required: false,
390
- // type: 'macro-input',
391
- // defaultValue: makeMacroString(SOURCE_SHOPIFY_DESCRIPTION_HTML),
392
- // rules: { sections: [] },
393
- // baseMode: false,
394
- // validator: v => validateIfNoMacro(v, z.coerce.number().positive()),
395
- // singleChoice: true,
396
- // },
385
+ {
386
+ attribute: 'Item.DiscountPriceInfo.MinimumAdvertisedPrice',
387
+ label: 'Discount Price',
388
+ description: 'The discount price of the item',
389
+ required: false,
390
+ type: 'macro-input',
391
+ defaultValue: makeMacroString(SOURCE_SHOPIFY_COMPARE_AT_PRICE),
392
+ rules: { sections: [] },
393
+ baseMode: false,
394
+ validator: v => validateIfNoMacro(v, z.coerce.number().positive()),
395
+ singleChoice: true,
396
+ },
397
397
  {
398
398
  attribute: 'Item.DispatchTimeMax',
399
399
  label: 'Dispatch Time Max',
@@ -409,18 +409,18 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
409
409
  },
410
410
  // TODO: add compatibility list items
411
411
  // TODO: add item specifics
412
- // {
413
- // attribute: 'Item.ListingDuration',
414
- // label: 'Listing Duration',
415
- // description: 'The length of time the listing will be active',
416
- // required: false,
417
- // type: 'macro-input',
418
- // defaultValue: '', // TODO: add source
419
- // rules: { sections: [] },
420
- // baseMode: false,
421
- // fixedValue: true,
422
- // singleChoice: true,
423
- // },
412
+ {
413
+ attribute: 'Item.ListingDuration',
414
+ label: 'Listing Duration',
415
+ description: 'The length of time the listing will be active',
416
+ required: false,
417
+ type: 'macro-input',
418
+ defaultValue: '', // TODO: add source
419
+ rules: { sections: [] },
420
+ baseMode: false,
421
+ fixedValue: true,
422
+ singleChoice: true,
423
+ },
424
424
  // {
425
425
  // attribute: 'Item.ListingType',
426
426
  // label: 'Listing Type',
@@ -456,36 +456,10 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
456
456
  baseMode: false,
457
457
  singleChoice: true,
458
458
  },
459
- {
460
- attribute: 'Item.ProductListingDetails.BrandMPN.Brand',
461
- label: 'Brand',
462
- description: 'The brand of the item',
463
- required: false,
464
- type: 'macro-input',
465
- defaultValue: '',
466
- rules: { sections: [] },
467
- validator: v => validateIfNoMacro(v, z.string().max(65).optional()),
468
- baseMode: false,
469
- fixedValue: false,
470
- singleChoice: true,
471
- },
472
- {
473
- attribute: 'Item.ProductListingDetails.BrandMPN.MPN',
474
- label: 'MPN',
475
- description: 'The Manufacturer Part Number of the item',
476
- required: false,
477
- type: 'macro-input',
478
- defaultValue: '',
479
- rules: { sections: [] },
480
- validator: v => validateIfNoMacro(v, z.string().max(65).optional()),
481
- baseMode: false,
482
- fixedValue: false,
483
- singleChoice: true,
484
- },
485
459
  // {
486
- // attribute: 'Item.ProductListingDetails.BrandMPN.MPN',
487
- // label: 'MPN',
488
- // description: 'The Manufacturer Part Number of the item',
460
+ // attribute: 'Item.ProductListingDetails.BrandMPN.Brand',
461
+ // label: 'Brand',
462
+ // description: 'The brand of the item',
489
463
  // required: false,
490
464
  // type: 'macro-input',
491
465
  // defaultValue: '',
@@ -496,41 +470,54 @@ export const eBayFeedTemplate: XmlFeedTemplateType = {
496
470
  // singleChoice: true,
497
471
  // },
498
472
  // {
499
- // attribute: 'Item.ProductListingDetails.EAN',
500
- // label: 'EAN',
501
- // description: 'The European Article Number of the item',
502
- // required: false,
503
- // type: 'macro-input',
504
- // defaultValue: '',
505
- // rules: { sections: [] },
506
- // baseMode: false,
507
- // fixedValue: false,
508
- // singleChoice: true,
509
- // },
510
- // {
511
- // attribute: 'Item.ProductListingDetails.UPC',
512
- // label: 'UPC',
513
- // description: 'The Universal Product Code of the item',
473
+ // attribute: 'Item.ProductListingDetails.BrandMPN.MPN',
474
+ // label: 'MPN',
475
+ // description: 'The Manufacturer Part Number of the item',
514
476
  // required: false,
515
477
  // type: 'macro-input',
516
478
  // defaultValue: '',
517
479
  // rules: { sections: [] },
480
+ // validator: v => validateIfNoMacro(v, z.string().max(65).optional()),
518
481
  // baseMode: false,
519
482
  // fixedValue: false,
520
483
  // singleChoice: true,
521
484
  // },
522
- // {
523
- // attribute: 'Item.Quantity',
524
- // label: 'Quantity',
525
- // description: 'The number of items available for purchase',
526
- // required: false,
527
- // type: 'macro-input',
528
- // defaultValue: '',
529
- // rules: { sections: [] },
530
- // baseMode: true,
531
- // fixedValue: false,
532
- // singleChoice: true,
533
- // },
485
+ {
486
+ attribute: 'Item.ProductListingDetails.EAN',
487
+ label: 'EAN',
488
+ description: 'The European Article Number of the item',
489
+ required: false,
490
+ type: 'macro-input',
491
+ defaultValue: '',
492
+ rules: { sections: [] },
493
+ baseMode: false,
494
+ fixedValue: false,
495
+ singleChoice: true,
496
+ },
497
+ {
498
+ attribute: 'Item.ProductListingDetails.UPC',
499
+ label: 'UPC',
500
+ description: 'The Universal Product Code of the item',
501
+ required: false,
502
+ type: 'macro-input',
503
+ defaultValue: '',
504
+ rules: { sections: [] },
505
+ baseMode: false,
506
+ fixedValue: false,
507
+ singleChoice: true,
508
+ },
509
+ {
510
+ attribute: 'Item.Quantity',
511
+ label: 'Quantity',
512
+ description: 'The number of items available for purchase',
513
+ required: false,
514
+ type: 'macro-input',
515
+ defaultValue: makeMacroString(SOURCE_SHOPIFY_INVENTORY_QUANTITY),
516
+ rules: { sections: [] },
517
+ baseMode: true,
518
+ fixedValue: false,
519
+ singleChoice: true,
520
+ },
534
521
  {
535
522
  attribute: 'Item.QuantityRestrictionPerBuyer.MaximumQuantity',
536
523
  label: 'Maximum Quantity Per Buyer',