- Getting Started
- Data Ingestion
- Use Cases
Product Catalog User Guides
- Overview
- List
- Attributes
- Categories
- Collections
- Background Jobs
- Settings
Product Catalog API
- Overview
- API Authentication and Data Sync
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Developer Guide
Catalog Connector User Guides
- Overview
- Items
- Bundles
Catalog Connector API
- Files
- Jobs
- Operations
- POSTFind products
- Operations with SKU
- Operations with Product ID
- Operations with Item ID
- POST
Add a product
Use this endpoint to add a single product to Catalog Connector. You must specify the locale
in the query parameter and the product data in the request body. Only sku
is mandatory for product data. Optionally, you can specify the type
as item, variant, or bundle. The default setting for type
is item.
curl --request POST \
--url https://api.fabric.inc/v3/catalog-connector/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '{
"sku": "NIKE237765",
"productName": "Nike runner shoes",
"categoryName": "Sport Shoes",
"categoryId": "648014741adc8a9de14e1a68",
"images": [
"https://myawsomestore.com/is/image/nike/8801290_s7"
],
"attributes": [
{
"name": "Color",
"value": "black",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": false,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"type": "ITEM",
"variants": [
{
"sku": "NIKE237766",
"productName": "Nike runner white shoes",
"id": "648aa9280d7b561b4663038c",
"itemId": 2700538,
"images": [
"https://myawsomestore.com/is/image/nike/8801291_s7"
],
"attributes": [
{
"name": "Color",
"value": "White",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": true,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}
],
"categories": [
{
"name": "Sport Shoes",
"id": "648014741adc8a9de14e1a68",
"isRoot": false,
"attributes": [
{
"name": "Fit",
"value": "Relaxed Fit",
"id": "648014741adc8a9de14e1a00",
"type": "TEXT"
}
]
},
{
"name": "Shoes",
"id": "648aa9258fdef29675dbce42",
"isRoot": true,
"attributes": [
{
"name": "Material",
"value": "Mesh"
}
]
}
],
"collections": [
{
"name": "Flash sale",
"id": "648055dff4aa98d6c43e02da",
"hierarchy": [
{
"name": "Flash Sale",
"id": "648055dff4aa98d6c43e02da",
"isRoot": false,
"attributes": [
{
"name": "Duration",
"value": 600,
"type": "NUMBER"
}
]
},
{
"name": "Sales",
"id": "648055e0f4aa98d6c43e02f7",
"isRoot": true
}
]
}
]
}'
{
"sku": "NIKE237765",
"productName": "Nike runner shoes",
"id": "6482b9524ffa4978fd9cbf5c",
"itemId": 2700537,
"categoryName": "Sport Shoes",
"categoryId": "648014741adc8a9de14e1a68",
"images": [
"https://myawsomestore.com/is/image/nike/8801290_s7"
],
"attributes": [
{
"name": "Color",
"value": "black",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": false,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"type": "ITEM",
"variants": [
{
"sku": "NIKE237766",
"productName": "Nike runner white shoes",
"id": "648aa9280d7b561b4663038c",
"itemId": 2700538,
"images": [
"https://myawsomestore.com/is/image/nike/8801291_s7"
],
"attributes": [
{
"name": "Color",
"value": "White",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": true,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}
],
"categories": [
{
"name": "Sport Shoes",
"id": "648014741adc8a9de14e1a68",
"isRoot": false,
"attributes": [
{
"name": "Fit",
"value": "Relaxed Fit",
"id": "648014741adc8a9de14e1a00",
"type": "TEXT"
}
]
},
{
"name": "Shoes",
"id": "648aa9258fdef29675dbce42",
"isRoot": true,
"attributes": [
{
"name": "Material",
"value": "Mesh"
}
]
}
],
"collections": [
{
"name": "Flash sale",
"id": "648055dff4aa98d6c43e02da",
"hierarchy": [
{
"name": "Flash Sale",
"id": "648055dff4aa98d6c43e02da",
"isRoot": false,
"attributes": [
{
"name": "Duration",
"value": 600,
"type": "NUMBER"
}
]
},
{
"name": "Sales",
"id": "648055e0f4aa98d6c43e02f7",
"isRoot": true
}
]
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}
Authorizations
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.
Unique request ID
Query Parameters
The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).
The default value is en-US.
Body
A sample request to create a new product.
A sample request to create a new product.
A sample request to create a new product.
A sample request to create a new product.
Response
The details of a product based on the product type.
The details of a product based on the product type.
The details of a product based on the product type.
The details of a product based on the product type.
Was this page helpful?
curl --request POST \
--url https://api.fabric.inc/v3/catalog-connector/products \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
--data '{
"sku": "NIKE237765",
"productName": "Nike runner shoes",
"categoryName": "Sport Shoes",
"categoryId": "648014741adc8a9de14e1a68",
"images": [
"https://myawsomestore.com/is/image/nike/8801290_s7"
],
"attributes": [
{
"name": "Color",
"value": "black",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": false,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"type": "ITEM",
"variants": [
{
"sku": "NIKE237766",
"productName": "Nike runner white shoes",
"id": "648aa9280d7b561b4663038c",
"itemId": 2700538,
"images": [
"https://myawsomestore.com/is/image/nike/8801291_s7"
],
"attributes": [
{
"name": "Color",
"value": "White",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": true,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}
],
"categories": [
{
"name": "Sport Shoes",
"id": "648014741adc8a9de14e1a68",
"isRoot": false,
"attributes": [
{
"name": "Fit",
"value": "Relaxed Fit",
"id": "648014741adc8a9de14e1a00",
"type": "TEXT"
}
]
},
{
"name": "Shoes",
"id": "648aa9258fdef29675dbce42",
"isRoot": true,
"attributes": [
{
"name": "Material",
"value": "Mesh"
}
]
}
],
"collections": [
{
"name": "Flash sale",
"id": "648055dff4aa98d6c43e02da",
"hierarchy": [
{
"name": "Flash Sale",
"id": "648055dff4aa98d6c43e02da",
"isRoot": false,
"attributes": [
{
"name": "Duration",
"value": 600,
"type": "NUMBER"
}
]
},
{
"name": "Sales",
"id": "648055e0f4aa98d6c43e02f7",
"isRoot": true
}
]
}
]
}'
{
"sku": "NIKE237765",
"productName": "Nike runner shoes",
"id": "6482b9524ffa4978fd9cbf5c",
"itemId": 2700537,
"categoryName": "Sport Shoes",
"categoryId": "648014741adc8a9de14e1a68",
"images": [
"https://myawsomestore.com/is/image/nike/8801290_s7"
],
"attributes": [
{
"name": "Color",
"value": "black",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": false,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"type": "ITEM",
"variants": [
{
"sku": "NIKE237766",
"productName": "Nike runner white shoes",
"id": "648aa9280d7b561b4663038c",
"itemId": 2700538,
"images": [
"https://myawsomestore.com/is/image/nike/8801291_s7"
],
"attributes": [
{
"name": "Color",
"value": "White",
"id": "6480216349256438cb7d53b5",
"type": "TEXT"
},
{
"name": "Wide Fit",
"value": true,
"id": "640db94f9fc28b255d155a42",
"type": "BOOLEAN"
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}
],
"categories": [
{
"name": "Sport Shoes",
"id": "648014741adc8a9de14e1a68",
"isRoot": false,
"attributes": [
{
"name": "Fit",
"value": "Relaxed Fit",
"id": "648014741adc8a9de14e1a00",
"type": "TEXT"
}
]
},
{
"name": "Shoes",
"id": "648aa9258fdef29675dbce42",
"isRoot": true,
"attributes": [
{
"name": "Material",
"value": "Mesh"
}
]
}
],
"collections": [
{
"name": "Flash sale",
"id": "648055dff4aa98d6c43e02da",
"hierarchy": [
{
"name": "Flash Sale",
"id": "648055dff4aa98d6c43e02da",
"isRoot": false,
"attributes": [
{
"name": "Duration",
"value": 600,
"type": "NUMBER"
}
]
},
{
"name": "Sales",
"id": "648055e0f4aa98d6c43e02f7",
"isRoot": true
}
]
}
],
"createdAt": "2021-12-13T13:56:09.006Z",
"updatedAt": "2021-12-13T13:56:09.006Z"
}