@speakeasy-sdks/pim-sdk
v3.1.0
Published
<div align="center"> <picture> <img src="https://user-images.githubusercontent.com/68016351/222832872-23483018-514d-4cbc-9948-939a0133a829.png" width="500"> </picture> <p>Node SDK for Fabric PIM API.</p> <a href="https://knowledgebas
Downloads
6
Maintainers
Keywords
Readme
As brands and retailers grow, they often expand their product catalogs, resulting in the need to enrich and manage more product data. fabric product information management (PIM) solution alleviates the burden of managing large amounts of product data by means of a central storage repository. fabric PIM helps you with improved data quality, consistent customer experience, reduced time to market, easy integration with external systems, reduced management costs and risks, faster and easier updates, and easy scaling. You can create, import, enrich, validate, distribute, and manage complex product information, centrally. As a result, you deliver product experiences that drive sales through every channel.
More information on the Fabric PIM API can be found here
SDK Installation
NPM
npm add @speakeasy-sdks/pim-sdk
Yarn
yarn add @speakeasy-sdks/pim-sdk
Authentication
For more details on getting access to the Fabric API please see here
SDK Example Usage
import {
ModifyAttributeGroupsRequest,
ModifyAttributeGroupsResponse
} from "@speakeasy-sdks/pim-sdk/dist/sdk/models/operations";
import { AxiosError } from "axios";
import { Fabric } from "@speakeasy-sdks/pim-sdk";
const sdk = new Fabric();
const req: ModifyAttributeGroupsRequest = {
headers: {
xSiteContext: {
account: "unde",
channel: 5928.45,
date: "porro",
stage: "nulla",
},
},
request: {
attributeGroup: [
{
action: "undefined",
description: "perspiciatis",
editableAttributes: [
{
action: "UPDATE",
id: "fuga",
order: 6458.94,
},
{
action: "UPDATE",
id: "iusto",
order: 2975.34,
},
{
action: "undefined",
id: "inventore",
order: 9636.63,
},
{
action: "UPDATE",
id: "eum",
order: 4776.65,
},
],
id: "autem",
name: "vel",
priorityOrder: 5288.95,
type: "COLLECTION",
},
{
action: "DELETE",
description: "reprehenderit",
editableAttributes: [
{
action: "undefined",
id: "quasi",
order: 3373.96,
},
{
action: "ADD",
id: "est",
order: 202.18,
},
{
action: "UPDATE",
id: "fugiat",
order: 9571.56,
},
{
action: "undefined",
id: "eos",
order: 8700.13,
},
],
id: "accusamus",
name: "reiciendis",
priorityOrder: 4736.08,
type: "undefined",
},
{
action: "undefined",
description: "praesentium",
editableAttributes: [
{
action: "undefined",
id: "soluta",
order: 1182.74,
},
{
action: "DELETE",
id: "rerum",
order: 5820.2,
},
{
action: "ADD",
id: "sed",
order: 9446.69,
},
],
id: "possimus",
name: "occaecati",
priorityOrder: 1059.07,
type: "COLLECTION",
},
],
transactional: true,
},
};
sdk.attributes.modifyAttributeGroups(req).then((res: ModifyAttributeGroupsResponse | AxiosError) => {
// handle response
});
SDK Available Operations
attributes
modifyAttributeGroups
- Create, update and delete attribute groupsmodifyAttributeMappings
- Create and Update attribute mappingspostCategoryAttributeBulk
- Create, update and delete category attributespostProductAttributeBulk
- Create update and delete item attributessearchAttributeGroups
- Find attribute groupssearchAttributeMappings
- Find attribute mapping
bulkImport
itemAttributeFileSearch
- Get imported files for item attributesitemBundleFileSearch
- Get imported files for bundlesfileSearch
- Get imported files for itemsgenerateCSVfile
- Generate CSV template file for itemsgenerateItemAttributeCSVfile
- Generate CSV template for item attributesgenerateItemAttributeS3url
- Generate S3 bucket URL for item attribute importgenerateItemBundleCSVfile
- Generate CSV template for bundlesgenerateItemBundleS3url
- Generate S3 bucket URL for bundle importgenerateS3url
- Generate S3 bucket URL for item importgetFileStatus
- Get file upload status
category
categoryCreate
- Create categorycategoryModify
- Modify categorygetCategoriesById
- Get categoriesgetCategoriesNodeSourceExclusions
- Get category source exclusionsgetCategoriesNodeSources
- Get category source inclusionsgetCategoryAttributesByID
- Get assigned category attributesgetCategoryItemAttributes
- Get assigned item attributesgetCategoryItemAttributesCondition
- Get item attribute conditionsgetCategorySKUs
- Get SKUs in a categorygetCategoryTree
- Get category treemodifyCategoriesNodeSourceExclusions
- Add and remove category source exclusionsmodifyCategoriesNodeSources
- Add and remove category source inclusionspostCategoryAttributeByID
- Assign and unassign category attributespostCategoryItemAttributeByID
- Add and remove item attribute conditionspostCategoryItemibuteByID
- Assign and unassign item attributessearchCategories
- Find categories
product
createProducts
- Create items and bundlesgetProductAttribute
- Get item attributesgetProducts
- Get items and children itemsgetProductsV2
- Get items and limited children itemsproductSearch
- Find itemsupdateBundles
- Update items in bundleupdateProducts
- Update items and bundlesupsertProducts
- Upsert items and bundles