3.1.0 • Published 1 year ago

@speakeasy-sdks/pim-sdk v3.1.0

Weekly downloads
-
License
-
Repository
-
Last release
1 year ago

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 groups
  • modifyAttributeMappings - Create and Update attribute mappings
  • postCategoryAttributeBulk - Create, update and delete category attributes
  • postProductAttributeBulk - Create update and delete item attributes
  • searchAttributeGroups - Find attribute groups
  • searchAttributeMappings - Find attribute mapping

bulkImport

  • itemAttributeFileSearch - Get imported files for item attributes
  • itemBundleFileSearch - Get imported files for bundles
  • fileSearch - Get imported files for items
  • generateCSVfile - Generate CSV template file for items
  • generateItemAttributeCSVfile - Generate CSV template for item attributes
  • generateItemAttributeS3url - Generate S3 bucket URL for item attribute import
  • generateItemBundleCSVfile - Generate CSV template for bundles
  • generateItemBundleS3url - Generate S3 bucket URL for bundle import
  • generateS3url - Generate S3 bucket URL for item import
  • getFileStatus - Get file upload status

category

  • categoryCreate - Create category
  • categoryModify - Modify category
  • getCategoriesById - Get categories
  • getCategoriesNodeSourceExclusions - Get category source exclusions
  • getCategoriesNodeSources - Get category source inclusions
  • getCategoryAttributesByID - Get assigned category attributes
  • getCategoryItemAttributes - Get assigned item attributes
  • getCategoryItemAttributesCondition - Get item attribute conditions
  • getCategorySKUs - Get SKUs in a category
  • getCategoryTree - Get category tree
  • modifyCategoriesNodeSourceExclusions - Add and remove category source exclusions
  • modifyCategoriesNodeSources - Add and remove category source inclusions
  • postCategoryAttributeByID - Assign and unassign category attributes
  • postCategoryItemAttributeByID - Add and remove item attribute conditions
  • postCategoryItemibuteByID - Assign and unassign item attributes
  • searchCategories - Find categories

product

  • createProducts - Create items and bundles
  • getProductAttribute - Get item attributes
  • getProducts - Get items and children items
  • getProductsV2 - Get items and limited children items
  • productSearch - Find items
  • updateBundles - Update items in bundle
  • updateProducts - Update items and bundles
  • upsertProducts - Upsert items and bundles

SDK Generated by Speakeasy

3.1.0

1 year ago

3.0.5

1 year ago

3.0.3

1 year ago

3.0.2

1 year ago