Integration
Integrating your product data with CM.com's product feed
- Through integrations marketplace. CM.com allows you to integrate your product data from various sources through our integrations marketplace. For the most up to date list of supported sources, please contact CM.com
- Setting up a custom integration through Product Feed REST APIs
Setting up a custom integration through REST
Process of updating the product set information
Periodically uploading a new version of the product set
This is recommended when delta’s on the source of the product data are not readilly available
- Only first time: Create a new product set with a recognizable external key and display name. I.e. your company name. (Can be done by CM.com if desired)
- Create a new Product Set Version for the product set from step 1
- POST the products to this version with the
CREATE_OR_UPDATE
operation type - Update the target version for the Product Set from step 1 to the newly created version, created in step 2
Updating the products in-place within a product set version
- Only first time: Create a new product set with a recognizable external key and display name. I.e. your company name. (Can be done by CM.com if desired)
- Only first time: Create a new Product Set Version for the product set from step 1
- POST the products updates to this version with the correct operation type as described in the API documentation below
API documentation
Creating a new product set
POST https://api.cm.com/product-feed/accounts/{accountId}/product-sets
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
accountId | Path | The account id | True | Guid | 069973bc-19a9-4854-b387-306254c2412e |
X-CM-PRODUCTTOKEN | Header or Query parameter | Your product token | True | Guid | 746477d0-d396-4af0-8f8e-dfd257640727 |
Id | Body | Id of the to be created product set. If empty it is auto generated | False | Guid | json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "externalKey": "string", "displayName": "string" } |
externalKey | Body | Reference of the product set that can be use for bookkeeping in external applications | False | String | |
displayName | Body | User-readable name of the product set | False | String |
Creating a new product set version
POST https://api.cm.com/product-feed/accounts/{accountId}/product-sets-versions
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
accountId | Path | The account id | True | Guid | 069973bc-19a9-4854-b387-306254c2412e |
X-CM-PRODUCTTOKEN | Header or Query parameter | Your product token | True | Guid | 746477d0-d396-4af0-8f8e-dfd257640727 |
Id | Body | Id of the product set version. If empty, it is autogenerated | False | Guid | json { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "productSetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } |
productSetId | Body | Reference of the product set that can be use for bookkeeping in external applications | True | String |
Uploading products to product set version
POST https://api.cm.com/product-feed/accounts/{accountId}/product-sets-versions/{productSetIdOrExternalKey}/products
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
accountId | Path | The account id | True | Guid | 069973bc-19a9-4854-b387-306254c2412e |
X-CM-PRODUCTTOKEN | Header or Query parameter | Your product token | True | Guid | 746477d0-d396-4af0-8f8e-dfd257640727 |
productSetVersionId | Path | The product set version | True | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
Body | Body | Array of product updates | True | Json array | json [ { "operation": "CREATE_OR_UPDATE", "id": "string", "attributes": { "additionalProp1": {}, "additionalProp2": {}, "additionalProp3": {} }} ] |
Operation | Body | Update operation to be performed. Values: CREATE_OR_UPDATE DELETE | True | ENUM | |
Id | Body | Id of the product | True | String | |
Attributes | Body | Attributes of the product | True | Json object |
Update target version of a product set
PATCH https://api.cm.com/product-feed/accounts/{accountId}/product-sets
Name | In | Description | Required | Type | Example |
---|---|---|---|---|---|
accountId | Path | The account id | True | Guid | 069973bc-19a9-4854-b387-306254c2412e |
X-CM-PRODUCTTOKEN | Header or Query parameter | Your product token | True | Guid | 746477d0-d396-4af0-8f8e-dfd257640727 |
productSetId | Path | Product Set Id | True | Guid | 3fa85f64-5717-4562-b3fc-2c963f66afa6 |
targetVersionId | Body | Target version (i.e. the default used version) for the provided product set | True | Guid | json { "targetVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } |
Updated 4 months ago