POST 3dCartWebAPI/v1/Categories


Adds a new category to the system

Request Information

URI Parameters

None.

Body Parameters

A Json or XML object containing the new category

Category
NameDescriptionTypeAdditional information
CategoryID

Primary key. Auto-incremented. database reference = category.id

integer

None.

CategoryName

database reference = category.category_name

string

String length: inclusive between 0 and 150

Link

database reference = category.link

string

String length: inclusive between 0 and 255

CategoryDescription

database reference = category.category_description

string

String length: inclusive between 0 and 65535

CategoryIcon

database reference = category.iconimage

string

String length: inclusive between 0 and 100

CategoryMain

database reference = category.category_main

boolean

None.

CategoryParent

database reference = category.category_parent

integer

None.

Sorting

database reference = category.sorting

integer

None.

Hide

database reference = category.reference

boolean

None.

UserID

database reference = category.userid

string

String length: inclusive between 0 and 50

LastUpdate

database reference = category.last_update

date

None.

CategoryMenuGroup

database reference = category.menu_group

integer

None.

HomeSpecialCategory

database reference = category.homespecial

boolean

None.

FilterCategory

database reference = category.isFilter

boolean

None.

TemplateCategoryPage

database reference = category.category_displaytype

integer

None.

DefaultProductsSorting

database reference = category.category_defaultsorting

integer

None.

SubcategoryColumnsCategorySpecials

database reference = category.category_columnum

integer

None.

ProductColumnsCategorySpecials

database reference = category.special_columnum

integer

None.

ProductColumnsCategoryGeneralItems

database reference = category.columnum

integer

None.

ItemsPerPageCategorySpecialItems

database reference = category.special_numtolist

integer

None.

ItemsPerPageCategoryGeneralItems

database reference = category.numtolist

integer

None.

DisplayTypeCategorySpecialItems

database reference = category.special_displaytype

integer

None.

DisplayTypeCategoryGeneralProducts

database reference = category.displaytype

integer

None.

AllowAccess

database reference = category.accessgroup

string

String length: inclusive between 0 and 250

OnFailRedirectTo

database reference = category.redirectto

string

String length: inclusive between 0 and 150

HideLeftBar

database reference = category.hide_left

boolean

None.

HideRightBar

database reference = category.hide_right

boolean

None.

HideTopMenu

database reference = category.hide_framemenu

boolean

None.

SmartCategories

database reference = category.smartcategory

integer

None.

SmartCategoriesSearchKeyword

database reference = category.smartcategory_keyword

string

String length: inclusive between 0 and 255

SmartCategoriesLinkTarget

database reference = category.link_target

string

String length: inclusive between 0 and 50

TemplateProductPage

database reference = category.listing_displaytype

integer

None.

ProductColumnsRelatedProducts

database reference = category.related_columnum

integer

None.

ProductColumnsUpsellProducts

database reference = category.upsellitems_columnum

integer

None.

DisplayTypeRelatedItems

database reference = category.related_displaytype

integer

None.

DisplayTypeUpsellItems

database reference = category.upsellitems_displaytype

integer

None.

OptionSetList

Collection of OptionSet

None.

Title

database reference = category.category_title

string

String length: inclusive between 0 and 65535

CustomFileName

database reference = category.filename

string

String length: inclusive between 0 and 255

MetaTags

database reference = category.category_meta

string

String length: inclusive between 0 and 65535

CategoryHeader

database reference = category.category_header

string

String length: inclusive between 0 and 65535

CategoryFooter

database reference = category.category_footer

string

String length: inclusive between 0 and 65535

AdditionalKeywords

database reference = category.keywords

string

String length: inclusive between 0 and 65535

CategoryExternalIdsList

Collection of CategoryExternalId

None.

Request Formats

application/json, text/json

Sample:
{
  "CategoryID": 1,
  "CategoryName": "sample string 1",
  "Link": "sample string 2",
  "CategoryDescription": "sample string 3",
  "CategoryIcon": "sample string 4",
  "CategoryMain": true,
  "CategoryParent": 1,
  "Sorting": 1,
  "Hide": true,
  "UserID": "sample string 5",
  "LastUpdate": "08/23/2017 05:29",
  "CategoryMenuGroup": 1,
  "HomeSpecialCategory": true,
  "FilterCategory": true,
  "TemplateCategoryPage": 1,
  "DefaultProductsSorting": 1,
  "SubcategoryColumnsCategorySpecials": 1,
  "ProductColumnsCategorySpecials": 1,
  "ProductColumnsCategoryGeneralItems": 1,
  "ItemsPerPageCategorySpecialItems": 1,
  "ItemsPerPageCategoryGeneralItems": 1,
  "DisplayTypeCategorySpecialItems": 1,
  "DisplayTypeCategoryGeneralProducts": 1,
  "AllowAccess": "sample string 6",
  "OnFailRedirectTo": "sample string 7",
  "HideLeftBar": true,
  "HideRightBar": true,
  "HideTopMenu": true,
  "SmartCategories": 1,
  "SmartCategoriesSearchKeyword": "sample string 8",
  "SmartCategoriesLinkTarget": "sample string 9",
  "TemplateProductPage": 1,
  "ProductColumnsRelatedProducts": 1,
  "ProductColumnsUpsellProducts": 1,
  "DisplayTypeRelatedItems": 1,
  "DisplayTypeUpsellItems": 1,
  "OptionSetList": [
    {
      "OptionSetID": 1,
      "OptionSetName": "sample string 1",
      "OptionSorting": 1.1,
      "OptionRequired": true,
      "OptionType": "sample string 2",
      "OptionURL": "sample string 3",
      "OptionAdditionalInformation": "sample string 4",
      "OptionSizeLimit": 1,
      "OptionList": [
        {
          "OptionID": 1,
          "OptionName": "sample string 1",
          "OptionSelected": true,
          "OptionHide": true,
          "OptionValue": 1.1,
          "OptionPartNumber": "sample string 2",
          "OptionSorting": 1.1,
          "OptionImagePath": "sample string 3",
          "OptionBundleCatalogId": 1,
          "OptionBundleQuantity": 1
        },
        {
          "OptionID": 1,
          "OptionName": "sample string 1",
          "OptionSelected": true,
          "OptionHide": true,
          "OptionValue": 1.1,
          "OptionPartNumber": "sample string 2",
          "OptionSorting": 1.1,
          "OptionImagePath": "sample string 3",
          "OptionBundleCatalogId": 1,
          "OptionBundleQuantity": 1
        }
      ]
    },
    {
      "OptionSetID": 1,
      "OptionSetName": "sample string 1",
      "OptionSorting": 1.1,
      "OptionRequired": true,
      "OptionType": "sample string 2",
      "OptionURL": "sample string 3",
      "OptionAdditionalInformation": "sample string 4",
      "OptionSizeLimit": 1,
      "OptionList": [
        {
          "OptionID": 1,
          "OptionName": "sample string 1",
          "OptionSelected": true,
          "OptionHide": true,
          "OptionValue": 1.1,
          "OptionPartNumber": "sample string 2",
          "OptionSorting": 1.1,
          "OptionImagePath": "sample string 3",
          "OptionBundleCatalogId": 1,
          "OptionBundleQuantity": 1
        },
        {
          "OptionID": 1,
          "OptionName": "sample string 1",
          "OptionSelected": true,
          "OptionHide": true,
          "OptionValue": 1.1,
          "OptionPartNumber": "sample string 2",
          "OptionSorting": 1.1,
          "OptionImagePath": "sample string 3",
          "OptionBundleCatalogId": 1,
          "OptionBundleQuantity": 1
        }
      ]
    }
  ],
  "Title": "sample string 10",
  "CustomFileName": "sample string 11",
  "MetaTags": "sample string 12",
  "CategoryHeader": "sample string 13",
  "CategoryFooter": "sample string 14",
  "AdditionalKeywords": "sample string 15",
  "CategoryExternalIdsList": [
    {
      "ID": 1,
      "CategoryID": 1,
      "ExternalId1": "sample string 1",
      "ExternalIdType": "sample string 2"
    },
    {
      "ID": 1,
      "CategoryID": 1,
      "ExternalId1": "sample string 1",
      "ExternalIdType": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<Category xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CategoryID>1</CategoryID>
  <CategoryName>sample string 1</CategoryName>
  <Link>sample string 2</Link>
  <CategoryDescription>sample string 3</CategoryDescription>
  <CategoryIcon>sample string 4</CategoryIcon>
  <CategoryMain>true</CategoryMain>
  <CategoryParent>1</CategoryParent>
  <Sorting>1</Sorting>
  <Hide>true</Hide>
  <UserID>sample string 5</UserID>
  <LastUpdate>2017-08-23T05:29:07.3843332-04:00</LastUpdate>
  <CategoryMenuGroup>1</CategoryMenuGroup>
  <HomeSpecialCategory>true</HomeSpecialCategory>
  <FilterCategory>true</FilterCategory>
  <TemplateCategoryPage>1</TemplateCategoryPage>
  <DefaultProductsSorting>1</DefaultProductsSorting>
  <SubcategoryColumnsCategorySpecials>1</SubcategoryColumnsCategorySpecials>
  <ProductColumnsCategorySpecials>1</ProductColumnsCategorySpecials>
  <ProductColumnsCategoryGeneralItems>1</ProductColumnsCategoryGeneralItems>
  <ItemsPerPageCategorySpecialItems>1</ItemsPerPageCategorySpecialItems>
  <ItemsPerPageCategoryGeneralItems>1</ItemsPerPageCategoryGeneralItems>
  <DisplayTypeCategorySpecialItems>1</DisplayTypeCategorySpecialItems>
  <DisplayTypeCategoryGeneralProducts>1</DisplayTypeCategoryGeneralProducts>
  <AllowAccess>sample string 6</AllowAccess>
  <OnFailRedirectTo>sample string 7</OnFailRedirectTo>
  <HideLeftBar>true</HideLeftBar>
  <HideRightBar>true</HideRightBar>
  <HideTopMenu>true</HideTopMenu>
  <SmartCategories>1</SmartCategories>
  <SmartCategoriesSearchKeyword>sample string 8</SmartCategoriesSearchKeyword>
  <SmartCategoriesLinkTarget>sample string 9</SmartCategoriesLinkTarget>
  <TemplateProductPage>1</TemplateProductPage>
  <ProductColumnsRelatedProducts>1</ProductColumnsRelatedProducts>
  <ProductColumnsUpsellProducts>1</ProductColumnsUpsellProducts>
  <DisplayTypeRelatedItems>1</DisplayTypeRelatedItems>
  <DisplayTypeUpsellItems>1</DisplayTypeUpsellItems>
  <OptionSetList>
    <OptionSet>
      <OptionSetID>1</OptionSetID>
      <OptionSetName>sample string 1</OptionSetName>
      <OptionSorting>1.1</OptionSorting>
      <OptionRequired>true</OptionRequired>
      <OptionType>sample string 2</OptionType>
      <OptionURL>sample string 3</OptionURL>
      <OptionAdditionalInformation>sample string 4</OptionAdditionalInformation>
      <OptionSizeLimit>1</OptionSizeLimit>
      <OptionList>
        <Options>
          <OptionID>1</OptionID>
          <OptionName>sample string 1</OptionName>
          <OptionSelected>true</OptionSelected>
          <OptionHide>true</OptionHide>
          <OptionValue>1.1</OptionValue>
          <OptionPartNumber>sample string 2</OptionPartNumber>
          <OptionSorting>1.1</OptionSorting>
          <OptionImagePath>sample string 3</OptionImagePath>
          <OptionBundleCatalogId>1</OptionBundleCatalogId>
          <OptionBundleQuantity>1</OptionBundleQuantity>
        </Options>
        <Options>
          <OptionID>1</OptionID>
          <OptionName>sample string 1</OptionName>
          <OptionSelected>true</OptionSelected>
          <OptionHide>true</OptionHide>
          <OptionValue>1.1</OptionValue>
          <OptionPartNumber>sample string 2</OptionPartNumber>
          <OptionSorting>1.1</OptionSorting>
          <OptionImagePath>sample string 3</OptionImagePath>
          <OptionBundleCatalogId>1</OptionBundleCatalogId>
          <OptionBundleQuantity>1</OptionBundleQuantity>
        </Options>
      </OptionList>
    </OptionSet>
    <OptionSet>
      <OptionSetID>1</OptionSetID>
      <OptionSetName>sample string 1</OptionSetName>
      <OptionSorting>1.1</OptionSorting>
      <OptionRequired>true</OptionRequired>
      <OptionType>sample string 2</OptionType>
      <OptionURL>sample string 3</OptionURL>
      <OptionAdditionalInformation>sample string 4</OptionAdditionalInformation>
      <OptionSizeLimit>1</OptionSizeLimit>
      <OptionList>
        <Options>
          <OptionID>1</OptionID>
          <OptionName>sample string 1</OptionName>
          <OptionSelected>true</OptionSelected>
          <OptionHide>true</OptionHide>
          <OptionValue>1.1</OptionValue>
          <OptionPartNumber>sample string 2</OptionPartNumber>
          <OptionSorting>1.1</OptionSorting>
          <OptionImagePath>sample string 3</OptionImagePath>
          <OptionBundleCatalogId>1</OptionBundleCatalogId>
          <OptionBundleQuantity>1</OptionBundleQuantity>
        </Options>
        <Options>
          <OptionID>1</OptionID>
          <OptionName>sample string 1</OptionName>
          <OptionSelected>true</OptionSelected>
          <OptionHide>true</OptionHide>
          <OptionValue>1.1</OptionValue>
          <OptionPartNumber>sample string 2</OptionPartNumber>
          <OptionSorting>1.1</OptionSorting>
          <OptionImagePath>sample string 3</OptionImagePath>
          <OptionBundleCatalogId>1</OptionBundleCatalogId>
          <OptionBundleQuantity>1</OptionBundleQuantity>
        </Options>
      </OptionList>
    </OptionSet>
  </OptionSetList>
  <Title>sample string 10</Title>
  <CustomFileName>sample string 11</CustomFileName>
  <MetaTags>sample string 12</MetaTags>
  <CategoryHeader>sample string 13</CategoryHeader>
  <CategoryFooter>sample string 14</CategoryFooter>
  <AdditionalKeywords>sample string 15</AdditionalKeywords>
  <CategoryExternalIdsList>
    <CategoryExternalId>
      <ID>1</ID>
      <CategoryID>1</CategoryID>
      <ExternalId1>sample string 1</ExternalId1>
      <ExternalIdType>sample string 2</ExternalIdType>
    </CategoryExternalId>
    <CategoryExternalId>
      <ID>1</ID>
      <CategoryID>1</CategoryID>
      <ExternalId1>sample string 1</ExternalId1>
      <ExternalIdType>sample string 2</ExternalIdType>
    </CategoryExternalId>
  </CategoryExternalIdsList>
</Category>

Sample Request


Please click here to download the C# Rest API Client project from GitHub.
not yet available
not yet available

Response Information

application/json, text/json

Sample:
[
  {
    "Key":"CategoryID",
    "Value":"1234",
    "Status":"201",
    "Message":"Created successfully",
  }
]
							

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.