POST api/products/sync

Request Information

URI Parameters

None.

Body Parameters

Collection of ProductDto
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

MetaKeywords

string

None.

MetaTitle

string

None.

Sku

string

None.

ManufacturerPartNumber

string

None.

Gtin

string

None.

RequiredProductIds

string

None.

AllowedQuantities

string

None.

ProductTypeId

integer

None.

ParentGroupedProductId

integer

None.

VisibleIndividually

boolean

None.

ShortDescription

string

None.

FullDescription

string

None.

AdminComment

string

None.

ProductTemplateId

integer

None.

VendorId

integer

None.

ShowOnHomepage

boolean

None.

MetaDescription

string

None.

AllowCustomerReviews

boolean

None.

ApprovedRatingSum

integer

None.

NotApprovedRatingSum

integer

None.

ApprovedTotalReviews

integer

None.

NotApprovedTotalReviews

integer

None.

SubjectToAcl

boolean

None.

LimitedToStores

boolean

None.

IsGiftCard

boolean

None.

GiftCardTypeId

integer

None.

OverriddenGiftCardAmount

decimal number

None.

RequireOtherProducts

boolean

None.

AutomaticallyAddRequiredProducts

boolean

None.

IsDownload

boolean

None.

DownloadId

integer

None.

UnlimitedDownloads

boolean

None.

MaxNumberOfDownloads

integer

None.

DownloadExpirationDays

integer

None.

DownloadActivationTypeId

integer

None.

HasSampleDownload

boolean

None.

SampleDownloadId

integer

None.

HasUserAgreement

boolean

None.

UserAgreementText

string

None.

IsRecurring

boolean

None.

RecurringCycleLength

integer

None.

RecurringCyclePeriodId

integer

None.

RecurringTotalCycles

integer

None.

IsRental

boolean

None.

RentalPriceLength

integer

None.

RentalPricePeriodId

integer

None.

IsShipEnabled

boolean

None.

IsFreeShipping

boolean

None.

ShipSeparately

boolean

None.

AdditionalShippingCharge

decimal number

None.

DeliveryDateId

integer

None.

IsTaxExempt

boolean

None.

TaxCategoryId

integer

None.

IsTelecommunicationsOrBroadcastingOrElectronicServices

boolean

None.

ManageInventoryMethodId

integer

None.

ProductAvailabilityRangeId

integer

None.

UseMultipleWarehouses

boolean

None.

WarehouseId

integer

None.

StockQuantity

integer

None.

DisplayStockAvailability

boolean

None.

DisplayStockQuantity

boolean

None.

MinStockQuantity

integer

None.

LowStockActivityId

integer

None.

NotifyAdminForQuantityBelow

integer

None.

BackorderModeId

integer

None.

AllowBackInStockSubscriptions

boolean

None.

OrderMinimumQuantity

integer

None.

OrderMaximumQuantity

integer

None.

AllowAddingOnlyExistingAttributeCombinations

boolean

None.

NotReturnable

boolean

None.

DisableBuyButton

boolean

None.

DisableWishlistButton

boolean

None.

AvailableForPreOrder

boolean

None.

PreOrderAvailabilityStartDateTimeUtc

date

None.

CallForPrice

boolean

None.

Price

decimal number

None.

OldPrice

decimal number

None.

ProductCost

decimal number

None.

CustomerEntersPrice

boolean

None.

MinimumCustomerEnteredPrice

decimal number

None.

MaximumCustomerEnteredPrice

decimal number

None.

BasepriceEnabled

boolean

None.

BasepriceAmount

decimal number

None.

BasepriceUnitId

integer

None.

BasepriceBaseAmount

decimal number

None.

BasepriceBaseUnitId

integer

None.

MarkAsNew

boolean

None.

MarkAsNewStartDateTimeUtc

date

None.

MarkAsNewEndDateTimeUtc

date

None.

HasTierPrices

boolean

None.

HasDiscountsApplied

boolean

None.

Weight

decimal number

None.

Length

decimal number

None.

Width

decimal number

None.

Height

decimal number

None.

AvailableStartDateTimeUtc

date

None.

AvailableEndDateTimeUtc

date

None.

DisplayOrder

integer

None.

Published

boolean

None.

Deleted

boolean

None.

CreatedOnUtc

date

None.

UpdatedOnUtc

date

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "MetaKeywords": "sample string 3",
    "MetaTitle": "sample string 4",
    "Sku": "sample string 5",
    "ManufacturerPartNumber": "sample string 6",
    "Gtin": "sample string 7",
    "RequiredProductIds": "sample string 8",
    "AllowedQuantities": "sample string 9",
    "ProductTypeId": 10,
    "ParentGroupedProductId": 11,
    "VisibleIndividually": true,
    "ShortDescription": "sample string 13",
    "FullDescription": "sample string 14",
    "AdminComment": "sample string 15",
    "ProductTemplateId": 16,
    "VendorId": 17,
    "ShowOnHomepage": true,
    "MetaDescription": "sample string 19",
    "AllowCustomerReviews": true,
    "ApprovedRatingSum": 21,
    "NotApprovedRatingSum": 22,
    "ApprovedTotalReviews": 23,
    "NotApprovedTotalReviews": 24,
    "SubjectToAcl": true,
    "LimitedToStores": true,
    "IsGiftCard": true,
    "GiftCardTypeId": 28,
    "OverriddenGiftCardAmount": 1.0,
    "RequireOtherProducts": true,
    "AutomaticallyAddRequiredProducts": true,
    "IsDownload": true,
    "DownloadId": 32,
    "UnlimitedDownloads": true,
    "MaxNumberOfDownloads": 34,
    "DownloadExpirationDays": 1,
    "DownloadActivationTypeId": 35,
    "HasSampleDownload": true,
    "SampleDownloadId": 37,
    "HasUserAgreement": true,
    "UserAgreementText": "sample string 39",
    "IsRecurring": true,
    "RecurringCycleLength": 41,
    "RecurringCyclePeriodId": 42,
    "RecurringTotalCycles": 43,
    "IsRental": true,
    "RentalPriceLength": 45,
    "RentalPricePeriodId": 46,
    "IsShipEnabled": true,
    "IsFreeShipping": true,
    "ShipSeparately": true,
    "AdditionalShippingCharge": 50.0,
    "DeliveryDateId": 51,
    "IsTaxExempt": true,
    "TaxCategoryId": 53,
    "IsTelecommunicationsOrBroadcastingOrElectronicServices": true,
    "ManageInventoryMethodId": 55,
    "ProductAvailabilityRangeId": 56,
    "UseMultipleWarehouses": true,
    "WarehouseId": 58,
    "StockQuantity": 59,
    "DisplayStockAvailability": true,
    "DisplayStockQuantity": true,
    "MinStockQuantity": 62,
    "LowStockActivityId": 63,
    "NotifyAdminForQuantityBelow": 64,
    "BackorderModeId": 65,
    "AllowBackInStockSubscriptions": true,
    "OrderMinimumQuantity": 67,
    "OrderMaximumQuantity": 68,
    "AllowAddingOnlyExistingAttributeCombinations": true,
    "NotReturnable": true,
    "DisableBuyButton": true,
    "DisableWishlistButton": true,
    "AvailableForPreOrder": true,
    "PreOrderAvailabilityStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "CallForPrice": true,
    "Price": 75.0,
    "OldPrice": 76.0,
    "ProductCost": 77.0,
    "CustomerEntersPrice": true,
    "MinimumCustomerEnteredPrice": 79.0,
    "MaximumCustomerEnteredPrice": 80.0,
    "BasepriceEnabled": true,
    "BasepriceAmount": 82.0,
    "BasepriceUnitId": 83,
    "BasepriceBaseAmount": 84.0,
    "BasepriceBaseUnitId": 85,
    "MarkAsNew": true,
    "MarkAsNewStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "MarkAsNewEndDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "HasTierPrices": true,
    "HasDiscountsApplied": true,
    "Weight": 89.0,
    "Length": 90.0,
    "Width": 91.0,
    "Height": 92.0,
    "AvailableStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "AvailableEndDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "DisplayOrder": 93,
    "Published": true,
    "Deleted": true,
    "CreatedOnUtc": "2025-12-05T20:15:11.8927891-08:00",
    "UpdatedOnUtc": "2025-12-05T20:15:11.8927891-08:00"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "MetaKeywords": "sample string 3",
    "MetaTitle": "sample string 4",
    "Sku": "sample string 5",
    "ManufacturerPartNumber": "sample string 6",
    "Gtin": "sample string 7",
    "RequiredProductIds": "sample string 8",
    "AllowedQuantities": "sample string 9",
    "ProductTypeId": 10,
    "ParentGroupedProductId": 11,
    "VisibleIndividually": true,
    "ShortDescription": "sample string 13",
    "FullDescription": "sample string 14",
    "AdminComment": "sample string 15",
    "ProductTemplateId": 16,
    "VendorId": 17,
    "ShowOnHomepage": true,
    "MetaDescription": "sample string 19",
    "AllowCustomerReviews": true,
    "ApprovedRatingSum": 21,
    "NotApprovedRatingSum": 22,
    "ApprovedTotalReviews": 23,
    "NotApprovedTotalReviews": 24,
    "SubjectToAcl": true,
    "LimitedToStores": true,
    "IsGiftCard": true,
    "GiftCardTypeId": 28,
    "OverriddenGiftCardAmount": 1.0,
    "RequireOtherProducts": true,
    "AutomaticallyAddRequiredProducts": true,
    "IsDownload": true,
    "DownloadId": 32,
    "UnlimitedDownloads": true,
    "MaxNumberOfDownloads": 34,
    "DownloadExpirationDays": 1,
    "DownloadActivationTypeId": 35,
    "HasSampleDownload": true,
    "SampleDownloadId": 37,
    "HasUserAgreement": true,
    "UserAgreementText": "sample string 39",
    "IsRecurring": true,
    "RecurringCycleLength": 41,
    "RecurringCyclePeriodId": 42,
    "RecurringTotalCycles": 43,
    "IsRental": true,
    "RentalPriceLength": 45,
    "RentalPricePeriodId": 46,
    "IsShipEnabled": true,
    "IsFreeShipping": true,
    "ShipSeparately": true,
    "AdditionalShippingCharge": 50.0,
    "DeliveryDateId": 51,
    "IsTaxExempt": true,
    "TaxCategoryId": 53,
    "IsTelecommunicationsOrBroadcastingOrElectronicServices": true,
    "ManageInventoryMethodId": 55,
    "ProductAvailabilityRangeId": 56,
    "UseMultipleWarehouses": true,
    "WarehouseId": 58,
    "StockQuantity": 59,
    "DisplayStockAvailability": true,
    "DisplayStockQuantity": true,
    "MinStockQuantity": 62,
    "LowStockActivityId": 63,
    "NotifyAdminForQuantityBelow": 64,
    "BackorderModeId": 65,
    "AllowBackInStockSubscriptions": true,
    "OrderMinimumQuantity": 67,
    "OrderMaximumQuantity": 68,
    "AllowAddingOnlyExistingAttributeCombinations": true,
    "NotReturnable": true,
    "DisableBuyButton": true,
    "DisableWishlistButton": true,
    "AvailableForPreOrder": true,
    "PreOrderAvailabilityStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "CallForPrice": true,
    "Price": 75.0,
    "OldPrice": 76.0,
    "ProductCost": 77.0,
    "CustomerEntersPrice": true,
    "MinimumCustomerEnteredPrice": 79.0,
    "MaximumCustomerEnteredPrice": 80.0,
    "BasepriceEnabled": true,
    "BasepriceAmount": 82.0,
    "BasepriceUnitId": 83,
    "BasepriceBaseAmount": 84.0,
    "BasepriceBaseUnitId": 85,
    "MarkAsNew": true,
    "MarkAsNewStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "MarkAsNewEndDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "HasTierPrices": true,
    "HasDiscountsApplied": true,
    "Weight": 89.0,
    "Length": 90.0,
    "Width": 91.0,
    "Height": 92.0,
    "AvailableStartDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "AvailableEndDateTimeUtc": "2025-12-05T20:15:11.8927891-08:00",
    "DisplayOrder": 93,
    "Published": true,
    "Deleted": true,
    "CreatedOnUtc": "2025-12-05T20:15:11.8927891-08:00",
    "UpdatedOnUtc": "2025-12-05T20:15:11.8927891-08:00"
  }
]

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.