Commerce Product Import Resource

Import products for a B2B or D2C store using a .csv file.

This resource is for synchronous product imports. It has been superseded by asynchronous product imports and will be removed in version 63.0. Use Commerce Import Product Job, Create to import products instead.

Note

Resource

1/commerce/management/webstores/webstoreId/product-import

Available version

52.0 –63.0

HTTP methods

POST

Request body for POST

Root XML tag

<productImport>

JSON example

1{
2   "importConfiguration":{
3      "importSource":{
4         "contentVersionId":"069RM0000008F4FYAU"
5      },
6      "importSettings":{
7         "category":{
8            "productCatalogId":"0ZSRM00000004Fk4AI"
9         },
10         "media":{
11            "cmsWorkspaceId":"0ZuRM0000000Fcz0AE"
12         },
13         "price":{
14            "pricebookAliasToIdMapping":{
15               "original":"01sRM000004aArJYAU",
16               "sales":"01sRM000004aArIYAU",
17               "wintersales":"01sRM000004aArKYAU"
18            }
19         },
20         "entitlement":{
21            "defaultEntitlementPolicyId":"1CeRM00000003o40AA"
22         }
23      }
24   }
25}

Properties

Name	Type	Description	Required or Optional	Available Version
`allOrNone`	Boolean	Specifies whether to stop processing if any row was not able to import (`true`) or to continue processing for a partial import (`false`). If unspecified, the default value is `false`.	Optional	52.0
`commerceEntitlementPolicyId`	String	ID of the entitlement policy to import to.	Optional	52.0–53.0
`cmsWorkspaceId`	String	ID of the CMS workspace. For stores created before Summer ’23, the CMS workspace can’t be an enhanced CMS workspace. If you specify a CMS workspace here, the value you specify overrides the default CMS workspace assigned to the store.	Optional	54.0
`importConfiguration`	Import Configuration	Configuration for a product import operation.	Required	54.0
`pricebookId`	String	ID of the pricebook to import to.	Optional	52.0–53.0
`productCatalogId`	String	ID of the product catalog to import to.	Optional	52.0–53.0
`sampleData`	String	Sample .csv file to import. Values are: `B2BSampleData`—B2B sample data set. `Camera`—Camera store sample data set. `Coffee`—Coffee store sample data set. `Hardware`—Hardware store sample data set. `NorthernTrail`—Outdoor goods store sample data set. `NorthernTrailLarge`—Larger outdoor goods store sample data set. `Simple`—Two-product sample data set.	Required if `contentVersionId` isn’t specified	52.0–53.0
`strikethroughPricebookId`	String	ID of the strikethrough pricebook to import to.	Optional	52.0–53.0

Response body for POST

Product Import

Connect REST API Developer Guide

Commerce Product Import Resource

See Also