Download OpenAPI specification:Download
fabric PIM resource helps you with your products resource management. From product search, product category and getting SKUs to bulk inserts, PIM allows you to manage the end to end products.
Categories (also known as nodes) form hierarchies. These hierarchies are used to organize products. For example, the "Computers" category may contain several sub-categories, like "Laptops" and "PCs". A Macbook Pro is a product that would then fit inside the "Laptops" category.
Each category has an ID. This endpoint accepts one or more category IDs, to return the categories associated with those IDs. Alternatively, the endpoint can return all categories if size
and page
(for pagination) are provided and/or filter categories, usually for a keyword in the names of the categories.
By default, categories will be filtered by Active ALTERNATE Hierarchies
object The If this header is omitted, the |
The requested categories.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "categories": [
- {
- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 16,
- "name": "PCs",
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "breadcrumbs": [
- {
- "id": "6196b44a5cb04b7ce167cb34",
- "nodeId": 10,
- "name": "Computers",
- "level": 0,
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [
- {
- "id": "619973877a22c466eee93219",
- "name": "Apple",
- "breadcrumbs": [
- {
- "id": "6196b44a5cb04b7ce167cb34",
- "nodeId": 10,
- "name": "Computers",
- "level": 0,
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [ ]
}
], - "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
]
}
Categories (also known as nodes) form hierarchies. These hierarchies are used to organize products. For example, the "Computers" category may contain several sub-categories, like "Laptops" and "PCs". A Macbook Pro is a product that would then fit inside the "Laptops" category.
This endpoint accepts the name, parent, and type of a category, and creates it.
Created category.
A generic client error.
Internal server error.
{- "name": "notes",
- "active": true,
- "parentNodeId": 1,
- "order": 3,
- "type": "ALTERNATE"
}
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "createdOn": "2021-12-01T00:00:00.000Z",
- "modifiedOn": "2021-12-01T00:00:00.000Z",
- "attributes": [ ],
- "children": [ ],
- "breadcrumbs": [ ]
}
Categories (also known as nodes) form hierarchies. These hierarchies are used to organize products. For example, the "Computers" category may contain several sub-categories, like "Laptops" and "PCs". A Macbook Pro is a product that would then fit inside the "Laptops" category.
This endpoint allows the name, parent, or order (within category siblings) of a category to be changed.
Updated category.
A generic client error.
Internal server error.
{- "name": "Furniture",
- "active": true,
- "parentNodeId": 1,
- "order": 3
}
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "createdOn": "2021-12-01T00:00:00.000Z",
- "modifiedOn": "2021-12-01T00:00:00.000Z",
- "attributes": [ ],
- "children": [ ],
- "breadcrumbs": [ ]
}
Search categories, usually for a keyword in the names of the categories.
Searching categories will be done with one of ids
, nodeIds
, keyword
, status
or type
. If all of these are missing, then this will return all results in a paginated form, thus requiring page
and size
.
GET /v1/category
is a much preferable call to this one, as this call is more expensive. Please refrain from using this call without good reason.
object The If this header is omitted, the |
List of requested categories.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "categories": [
- {
- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 16,
- "name": "PCs",
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "breadcrumbs": [
- {
- "id": "6196b44a5cb04b7ce167cb34",
- "nodeId": 10,
- "name": "Computers",
- "level": 0,
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [
- {
- "id": "619973877a22c466eee93219",
- "name": "Apple",
- "breadcrumbs": [
- {
- "id": "6196b44a5cb04b7ce167cb34",
- "nodeId": 10,
- "name": "Computers",
- "level": 0,
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [ ]
}
], - "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
]
}
Get a tree of categories. Categories have parents and children, forming a hierarchy. This call returns the tree of categories rooted in the category identified by id
or nodeId
.
object The If this header is omitted, the |
The category tree.
A generic client error.
Internal server error.
{- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 16,
- "name": "PCs",
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [
- {
- "id": "619973877a22c466eee93219",
- "name": "Apple",
- "breadcrumbs": [
- {
- "id": "6196b44a5cb04b7ce167cb34",
- "nodeId": 10,
- "name": "Computers",
- "level": 0,
- "hierarchy": "ALTERNATE",
- "isActive": true,
- "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
], - "children": [ ]
}
], - "createdOn": "2022-03-09T23:37:54.086Z",
- "modifiedOn": "2022-03-09T23:37:54.086Z"
}
This will return the SKUs of all products that belong to a particular category.
object The If this header is omitted, the |
List of SKUs associated with given category.
A generic client error.
Internal server error.
{- "totalSize": 3,
- "pageSize": 10,
- "pages": 1,
- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 2,
- "name": "electronics",
- "skus": [
- "mobo12001",
- "mobo12002",
- "mobo12003"
]
}
Usually you'll get a category's details with a call to /v1/category, but this is an alternative if you have a category's ID, and want the attributes only.
object The If this header is omitted, the |
List of category's attributes.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "id": "619a8ba6f1875f6dbcaf0521",
- "nodeId": 2,
- "name": "electronics",
- "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "Notes for this particular category.",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand."
}
]
}
Categories have attributes that are attached to themselves specifically, rather than the products that belong to categories. This call allows modification of those attributes.
The category's attributes.
A generic client error.
Internal server error.
{- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 25,
- "attributes": [
- {
- "action": "SET",
- "attributeId": "609ac75051f11a0007cf38b3",
- "value": true
}
]
}
{- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 25,
- "name": "notes",
- "attributes": [
- {
- "id": "61ba11481a29d52cb284252f",
- "name": "active",
- "type": "BOOLEAN",
- "value": true
}
]
}
Create or update multiple category attributes in one call.
While POST /v1/category/attribute supports a singular update to an attribute, this supports both create and update for multiple attributes at the same time.
Bulk attribute response.
A generic client error.
Internal server error.
[- {
- "action": "UPDATE",
- "id": "61ba11691a29d52cb2842541",
- "name": "weight",
- "description": "Weight of item in KG.",
- "type": "INTEGER",
- "textSubType": "HTML",
- "serialStart": 1000,
- "optionsType": "DATETIME",
- "format": "YYYY-MM-DD",
- "formula": "`${item.weightValue} ${item.weightUnit}`",
- "validation": {
- "required": true,
- "inheritable": true,
- "inverse": true,
- "unique": true,
- "exact": "string",
- "attributeTypes": [
- "TEXT"
], - "contains": "string",
- "range": {
- "min": "string",
- "max": "string"
}, - "formula": "value < 10 || value > 20",
- "oneOf": [
- "string"
]
}
}
]
{- "attributes": {
- "success": [
- {
- "id": "622932439c73c975335cb654",
- "name": "name",
- "message": "Attribute created successfully."
}
], - "failed": [
- {
- "name": "ITEM_ATTRIBUTE_VALUE_IS_INVALID",
- "errors": [
- "Attribute value is invalid"
]
}
]
}
}
A category specifies the required and optional attributes that all products (aka items) within that category must have. This call returns the attributes those products support for the requested category.
Be aware that categories can inherit attributes for their products from the category's parents as well.
object The If this header is omitted, the |
Item attributes for this category.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "itemAttributes": [
- {
- "id": "61701259125b7225cbfb21b9",
- "mapping": "image",
- "name": "picture",
- "type": "TEXT",
- "required": true
}
]
}
A category specifies the required and optional attributes that all products (aka items) within that category must have. This call modifies the attributes those products support for the requested category.
The category's item attributes.
A generic client error.
Internal server error.
{- "id": "619a8ba6f1875f6dbcaf0521",
- "nodeId": 25,
- "itemAttributes": [
- {
- "action": "SET",
- "attributeId": "609ac75051f11a0007cf38b3",
- "mandatory": false
}
]
}
{- "id": "619a8ba6f1875f6dbcaf0521",
- "nodeId": 25,
- "name": "electronics",
- "itemAttributes": [
- {
- "id": "61ba11691a29d52cb2842541",
- "name": "published",
- "type": "BOOLEAN",
- "required": false
}
]
}
Get available Node Sources.
object The If this header is omitted, the |
The node sources
A generic client error
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "sources": [
- {
- "id": "61701259125b7225cbfb21b9",
- "nodeId": 12,
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
]
}
Modify Node Sources by ID.
Created category.
A generic client error.
Internal server error.
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "sources": [
- {
- "id": "61701259125b7225cbfb21b9",
- "nodeId": 24,
- "action": "SET"
}
]
}
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "sources": [
- {
- "id": "61701259125b7225cbfb21b9",
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
], - "sourceExclusions": [
- {
- "id": "61701259125b7225cbfb21b9",
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
]
}
Get available Node Source Exclusions.
object The If this header is omitted, the |
The node sources
A generic client error
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "sourceExclusions": [
- {
- "id": "61701259125b7225cbfb21b9",
- "nodeId": 12,
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
]
}
Modify Node Source Exclusions by ID.
Created category.
A generic client error.
Internal server error.
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "sourceExclusions": [
- {
- "id": "61701259125b7225cbfb21b9",
- "nodeId": 12,
- "action": "SET"
}
]
}
{- "id": "6170135a49b4af38190970fe",
- "nodeId": 12,
- "name": "Furniture",
- "sources": [
- {
- "id": "61701259125b7225cbfb21b9",
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
], - "sourceExclusions": [
- {
- "id": "61701259125b7225cbfb21b9",
- "name": "picture",
- "breadcrumbString": "PRIMARY/Furniture/Chairs"
}
]
}
A category specifies the required and optional attributes that all products (aka items) within that category must have. This call returns the attributes those products support for the requested category.
Be aware that categories can inherit attributes for their products from the category's parents as well.
Item attributes for this category.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 25,
- "name": "electronics",
- "itemAttributeConditions": [
- { }
]
}
A category specifies the required and optional attributes that all products (aka items) within that category must have. This call modifies the attributes those products support for the requested category.
The category's item attributes.
A generic client error.
Internal server error.
{- "id": "6196b45b5cb04b7ce167cb46",
- "nodeId": 25,
- "itemAttributeConditions": [
- {
- "action": "SET",
- "attributeId": "609ac75051f11a0007cf38b3",
- "condition": {
- "type": "CONTAINS",
- "value": "shoe"
}
}
]
}
{- "id": "619a8ba6f1875f6dbcaf0521",
- "nodeId": 25,
- "itemAttributeConditions": [ ]
}
Get products, supports both ITEMS & BUNDLES.
One of the following are required in the query parameters.
page
and size
, or array of SKUs
, or array of itemIds
.
Note, status
and date
query parameters will work only with pagination.
Response samples, multiple examples have been added, click on the examples dropdown for respective response contract.
The products (type ITEMS)
A generic client error
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "products": [
- {
- "sku": "MOBO-X570",
- "itemId": 4,
- "children": [
- {
- "sku": "string",
- "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "string",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand.",
- "mapping": "description"
}
]
}
], - "type": "ITEM",
- "status": true,
- "categories": [
- {
- "id": "621c121bff2e4507c199b7cb",
- "name": "electronics",
- "breadcrumbs": [
- {
- "id": "621c10f3ff2e4507c199b66b",
- "name": "PRIMARY",
- "attributes": [
- null
]
}
]
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "string",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand.",
- "mapping": "description"
}
], - "createdOn": "2022-03-07T22:50:10.668Z",
- "modifiedOn": "2022-03-07T22:52:01.720Z"
}
]
}
Search products by SKU, ItemId or title.
The products.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "products": [
- {
- "sku": "MSI-Z490",
- "itemId": 2,
- "type": "ITEM",
- "categories": [
- {
- "id": "621c121bff2e4507c199b7cb",
- "name": "electronics",
- "breadcrumbs": [
- {
- "id": "621c10f3ff2e4507c199b66b",
- "name": "PRIMARY",
- "attributes": [
- null
]
}
]
}
], - "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "string",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand.",
- "mapping": "description"
}
], - "dependents": [
- [
- "MyChild"
]
], - "createdOn": "2021-05-28T16:36:50.055Z",
- "modifiedOn": "2021-05-28T16:36:50.055Z",
- "children": [
- {
- "sku": "string",
- "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "string",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand.",
- "mapping": "description"
}
]
}
]
}
]
}
Get product attributes by SKU or ItemId.
The product attributes.
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "attributes": [
- {
- "id": "619a8ba6f1875f6dbcaf0521",
- "name": "notes",
- "description": "string",
- "type": "TEXT",
- "value": "All vendors are currently unable to fulfill demand.",
- "mapping": "description"
}
]
}
Create or update product attributes in bulk.
Bulk attribute response.
A generic client error.
Internal server error.
[- {
- "action": "UPDATE",
- "id": "621c1122ff2e4507c199b75d",
- "name": "Weight",
- "description": "Example description.",
- "mapping": "title",
- "type": "TEXT",
- "textSubType": "SMALL_TEXT",
- "target": "ITEM",
- "serialStart": 1,
- "optionsType": "TEXT",
- "format": "YYYY-MM-DD",
- "formula": "`${item.weightValue} ${item.weightUnit}`",
- "validation": {
- "required": true,
- "inheritable": true,
- "inverse": true,
- "unique": true,
- "exact": "string",
- "attributeTypes": [
- "TEXT"
], - "contains": "string",
- "startWith": 1,
- "incrementBy": 1,
- "range": {
- "min": "string",
- "max": "string"
}, - "formula": "value < 10 || value > 20",
- "oneOf": [
- "string"
]
}
}
]
{- "attributes": {
- "success": [
- {
- "id": "622932439c73c975335cb654",
- "name": "name",
- "message": "Attribute created successfully."
}
], - "failed": [
- {
- "name": "ITEM_ATTRIBUTE_VALUE_IS_INVALID",
- "errors": [
- "Attribute value is invalid"
]
}
]
}
}
Create, update or delete attribute groups
Attribute group response.
A generic client error.
Internal server error.
{- "transactional": true,
- "attributeGroup": {
- "action": "UPDATE",
- "type": "COLLECTION",
- "description": "Weight of item in KG.",
- "name": "weight",
- "target": "ITEM",
- "priorityOrder": 1,
- "id": "6259ec8d006b0d00092b3189",
- "editableAttributes": [
- {
- "action": "UPDATE",
- "id": "6245f16d11ae770009f19292",
- "order": 0
}
]
}
}
[- {
- "_id": "6259ec8d006b0d00092b3189",
- "description": "Weight of item in KG.",
- "type": "COLLECTION",
- "name": "weight",
- "target": "ITEM",
- "priorityOrder": 1,
- "createdOn": "2022-04-15T22:07:09.921Z",
- "modifiedOn": "2022-04-15T22:10:05.427Z",
- "attributes": [
- {
- "_id": "6259ec8defc2116dd6c0f3fc",
- "attributeGroupId": "6259ec8d006b0d00092b3189",
- "attributeId": "6245f16d11ae770009f19292",
- "isEditable": true,
- "createdOn": "2022-04-15T22:07:09.932Z",
- "modifiedOn": "2022-04-15T22:10:05.444Z",
- "order": 0
}
]
}
]
Search for attribute groups
Attribute group response.
A generic client error.
Internal server error.
{- "page": 0,
- "size": 10,
- "include": {
- "attributes": true
}, - "match": {
- "target": "ITEM",
- "or": [
- {
- "name": "weight"
}
]
}, - "sort": [
- {
- "field": "priorityOrder",
- "direction": "DESC"
}
]
}
{- "totalSize": 7,
- "pageSize": 10,
- "pages": 1,
- "attributeGroups": [
- {
- "_id": "6259ec8d006b0d00092b3189",
- "description": "Weight of item in KG.",
- "type": "COLLECTION",
- "name": "weight",
- "target": "ITEM",
- "priorityOrder": 1,
- "createdOn": "2022-04-15T22:07:09.921Z",
- "modifiedOn": "2022-04-15T22:10:05.427Z",
- "totalAttributes": 1,
- "EditableAttributes": [
- {
- "_id": "6259ec8defc2116dd6c0f3fc",
- "attributeGroupId": "6259ec8d006b0d00092b3189",
- "attributeId": "6245f16d11ae770009f19292",
- "isEditable": true,
- "createdOn": "2022-04-15T22:07:09.932Z",
- "modifiedOn": "2022-04-15T22:10:05.444Z",
- "order": 0,
- "attribute": [
- {
- "_id": "6259ec8defc2116dd6c0f3fc",
- "description": "Weight of item in KG.",
- "formulaManuallyOverWritten": false,
- "formula": null,
- "type": "TEXT",
- "target": "ITEM",
- "name": "weight",
- "textSubType": "SMALL_TEXT",
- "attributeValidationId": "624d92f8caa34e0009b5d849",
- "modifiedBy": "60aad2c835c5fb000885f679",
- "createdOn": "2022-04-15T22:07:09.932Z",
- "modifiedOn": "2022-04-15T22:10:05.444Z"
}
]
}
], - "ReadOnlyAttributes": [
- {
- "_id": "6259ec8defc2116dd6c0f3fc",
- "attributeGroupId": "6259ec8d006b0d00092b3189",
- "attributeId": "6245f16d11ae770009f19292",
- "isEditable": true,
- "createdOn": "2022-04-15T22:07:09.932Z",
- "modifiedOn": "2022-04-15T22:10:05.444Z",
- "order": 0,
- "attribute": [
- {
- "_id": "6259ec8defc2116dd6c0f3fc",
- "description": "Weight of item in KG.",
- "formulaManuallyOverWritten": false,
- "formula": null,
- "type": "TEXT",
- "target": "ITEM",
- "name": "weight",
- "textSubType": "SMALL_TEXT",
- "attributeValidationId": "624d92f8caa34e0009b5d849",
- "modifiedBy": "60aad2c835c5fb000885f679",
- "createdOn": "2022-04-15T22:07:09.932Z",
- "modifiedOn": "2022-04-15T22:10:05.444Z"
}
]
}
], - "WorkflowAttributes": [
- null
], - "ImpactedAttributes": [
- null
]
}
]
}
Create products in bulk with attribute values.
The products.
A generic client error.
The failing items.
Internal server error.
[- {
- "sku": "sku_abc",
- "type": "ITEM",
- "nodeName": "PRIMARY->electronics",
- "parentSku": "sku123",
- "attributeValues": [
- {
- "name": "title",
- "value": "AMD X570 mobo"
}
], - "bundleItems": [
- {
- "sku": "sku123",
- "quantity": 6
}
]
}
]
{- "success": [
- {
- "sku": "sku1",
- "itemId": "611686da50fb7e0c5df78c2e",
- "itemIdSeq": 12,
- "message": "SKU created successfully.",
- "errorAttributes": [
- {
- "name": "active",
- "message": "Attribute value is invalid."
}
], - "errorBundles": [
- {
- "name": "string",
- "message": "string"
}
]
}
], - "failed": [
- {
- "sku": "sku1",
- "message": "Failed because of validation."
}
], - "itemIds": [
- "611686da50fb7e0c5df78c2e"
]
}
Update products in bulk with attribute values.
The products.
A generic client error.
The failing items.
Internal server error.
{- "skus": [
- "sku12"
], - "type": "ITEM",
- "action": "UPDATE",
- "parentSku": "sku234",
- "attributeValues": [
- {
- "name": "title",
- "value": "AMD X570 mobo"
}
]
}
{- "success": [
- {
- "sku": "sku1",
- "itemId": "611686da50fb7e0c5df78c2e",
- "itemIdSeq": 12,
- "message": "SKU created successfully.",
- "errorAttributes": [
- {
- "name": "active",
- "message": "Attribute value is invalid."
}
], - "errorBundles": [
- {
- "name": "string",
- "message": "string"
}
]
}
], - "failed": [
- {
- "sku": "sku1",
- "message": "Failed because of validation."
}
], - "itemIds": [
- "611686da50fb7e0c5df78c2e"
]
}
Upsert products in bulk with attribute values.
The products.
A generic client error.
The failing items.
Internal server error.
{- "skus": [
- "sku12"
], - "type": "ITEM",
- "action": "UPDATE",
- "parentSku": "sku234",
- "attributeValues": [
- {
- "name": "title",
- "value": "AMD X570 mobo"
}
]
}
{- "success": [
- {
- "sku": "sku1",
- "itemId": "611686da50fb7e0c5df78c2e",
- "itemIdSeq": 12,
- "message": "SKU created successfully.",
- "errorAttributes": [
- {
- "name": "active",
- "message": "Attribute value is invalid."
}
], - "errorBundles": [
- {
- "name": "string",
- "message": "string"
}
]
}
], - "failed": [
- {
- "sku": "sku1",
- "message": "Failed because of validation."
}
], - "itemIds": [
- "611686da50fb7e0c5df78c2e"
]
}
Update bundles in bulk, adding or removing items and changing quantities.
The products.
A generic client error.
Internal server error.
{- "action": "UPDATE",
- "bundles": [
- {
- "action": "SET",
- "bundleSku": "iPhoneBundle",
- "itemSku": "iPhone12",
- "quantity": 1
}
]
}
[- {
- "id": "625367673ab7402268d8cccf",
- "itemId": "624d94fb27c894222534b260",
- "bundleId": "624d939227c894222534b247",
- "quantity": 1,
- "createdOn": "2022-04-08T23:25:27.753Z",
- "modifiedOn": "2022-04-08T23:25:27.753Z"
}
]
Create vendor API. It supports creating a single vendor or multiple vendors in single request.
The vendor response.
A generic client error.
Internal server error.
[- {
- "attributes": [
- {
- "name": "name",
- "value": "ACME Ltd",
- "action": "SET"
}
], - "action": "CREATE"
}
]
{- "vendorResponse": {
- "status": "SUCCESS",
- "id": "6113a632b91cb600089eea4d",
- "action": "CREATE",
- "errorAttributes": [
- {
- "id": "6113a632b91cb600089eea4d",
- "mapping": "vendorId",
- "name": "Vendor Id",
- "message": "Field not mapped"
}
], - "attributes": [
- {
- "attributeId": "6113a632b91cb600089eea4d",
- "mapping": "vendorName",
- "name": "Vendor name",
- "description": "Company's registered name.",
- "type": "TEXT",
- "textSubType": "SMALL_TEXT",
- "valueRaw": "ACME Ltd",
- "valueText": "ACME Ltd",
- "validation": { }
}
]
}
}
Search vendors by Query.
The vendors
A generic client error.
Internal server error.
{- "totalSize": 100,
- "pageSize": 10,
- "pages": 10,
- "vendors": [
- {
- "id": "6227bca91b03a5654a3cbfd4",
- "vendorId": 6,
- "vendorStatus": "true",
- "attributes": [
- {
- "attributeId": "6113a632b91cb600089eea4d",
- "mapping": "vendorName",
- "name": "Vendor name",
- "description": "Company's registered name.",
- "type": "TEXT",
- "textSubType": "SMALL_TEXT",
- "valueRaw": "ACME Ltd",
- "valueText": "ACME Ltd",
- "validation": { }
}
], - "contacts": [
- {
- "contactId": 100,
- "emailId": "john.doe@example.com",
- "label": "Main Contact",
- "name": "John Doe",
- "phoneNumber": "1(123)456-7890"
}
], - "locations": [
- {
- "locationId": 101,
- "label": "Main Office",
- "addressLine1": "12345 Main Street",
- "addressLine2": "Grand Suburb",
- "city": "San Francisco",
- "state": "California",
- "zipCode": 12345,
- "country": "United States"
}
], - "statuses": [
- "string"
], - "createdBy": "61095b16ca806c0008f26085",
- "createdOn": "2022-03-08T21:20:02.237Z",
- "modifiedBy": "61095b16ca806c0008f26085",
- "modifiedOn": "2022-03-08T21:20:02.237Z",
- "publishedBy": "61095b16ca806c0008f26085",
- "publishedOn": "2022-03-08T21:20:02.237Z"
}
]
}
Update Vendor API. It supports both bulk and single update requests.
The vendors.
A generic client error.
Internal server error.
[- {
- "id": "622924be9c73c975335cb603",
- "action": "UPDATE",
- "attributes": [
- {
- "action": "SET",
- "name": "Vendor name",
- "value": "ACME Ltd"
}
]
}
]
{- "vendorResponse": {
- "status": "SUCCESS",
- "id": "6113a632b91cb600089eea4d",
- "action": "UPDATE",
- "errorAttributes": [
- {
- "id": "6113a632b91cb600089eea4d",
- "mapping": "vendorId",
- "name": "Vendor Id",
- "message": "Field not mapped"
}
], - "attributes": [
- {
- "id": "6113a632b91cb600089eea4d",
- "mapping": "vendorName",
- "name": "Vendor name",
- "value": "ACME Ltd"
}
]
}
}
Get Vendor By Vendor Id.
The vendors.
A generic client error.
Internal server error.
{- "id": "6227bca91b03a5654a3cbfd4",
- "vendorId": 6,
- "vendorStatus": "true",
- "attributes": [
- {
- "attributeId": "6113a632b91cb600089eea4d",
- "mapping": "vendorName",
- "name": "Vendor name",
- "description": "Company's registered name.",
- "type": "TEXT",
- "textSubType": "SMALL_TEXT",
- "valueRaw": "ACME Ltd",
- "valueText": "ACME Ltd",
- "validation": { }
}
], - "contacts": [
- {
- "contactId": 100,
- "emailId": "john.doe@example.com",
- "label": "Main Contact",
- "name": "John Doe",
- "phoneNumber": "1(123)456-7890"
}
], - "locations": [
- {
- "locationId": 101,
- "label": "Main Office",
- "addressLine1": "12345 Main Street",
- "addressLine2": "Grand Suburb",
- "city": "San Francisco",
- "state": "California",
- "zipCode": 12345,
- "country": "United States"
}
], - "statuses": [
- "string"
], - "createdBy": "61095b16ca806c0008f26085",
- "createdOn": "2022-03-08T21:20:02.237Z",
- "modifiedBy": "61095b16ca806c0008f26085",
- "modifiedOn": "2022-03-08T21:20:02.237Z",
- "publishedBy": "61095b16ca806c0008f26085",
- "publishedOn": "2022-03-08T21:20:02.237Z"
}
Get all vendor attributes.
The vendor attributes.
A generic client error.
Internal server error.
{- "attributes": [
- {
- "attributeId": "6113a632b91cb600089eea4d",
- "mapping": "vendorName",
- "name": "Vendor name",
- "description": "Company's registered name.",
- "type": "TEXT",
- "textSubType": "SMALL_TEXT",
- "valueRaw": "ACME Ltd",
- "valueText": "ACME Ltd",
- "validation": { }
}
]
}
Create or Update Attributes for Vendor in bulk.
Bulk attribute response.
A generic client error.
Internal server error.
[- {
- "action": "UPDATE",
- "id": "622932439c73c975335cb654",
- "name": "name",
- "description": "Vendor name",
- "mapping": "name",
- "type": "TEXT",
- "subTextType": "SMALL_TEXT",
- "serialStart": 0,
- "optionsType": "TEXT",
- "format": "YYYY-MM-DD",
- "formula": "`${item.weightValue} ${item.weightUnit}`",
- "validation": {
- "required": true,
- "inverse": true,
- "unique": true,
- "exact": "string",
- "attributeTypes": [
- "TEXT"
], - "contains": "string",
- "range": {
- "min": "string",
- "max": "string"
}, - "formula": "value < 10 || value > 20",
- "oneOf": [
- "string"
]
}
}
]
{- "attributes": {
- "success": [
- {
- "id": "622932439c73c975335cb654",
- "name": "name",
- "message": "Attribute created successfully."
}
], - "failed": [
- {
- "name": "ITEM_ATTRIBUTE_VALUE_IS_INVALID",
- "errors": [