PUT api/inventory/InventoryDetail

Edit details of specific Inventory item.

Request Information

URI Parameters

None.

Body Parameters

InventoryDetailViewModel
NameDescriptionTypeAdditional information
ProductID

This is a brief description of the item which is limited to 20 characters and can also identify how an item is tracked in a warehouse.

string

None.

Description

string

None.

Explanation

Identifies the alternate text that will appear on the shopping cart when the item is listed with other items.

string

None.

LongExplanation

Can be used to provide a lengthy item description and will appear when a customer or rep selects to view more details on a particular product.

string

None.

CategoryID

Identifies the category that is associated with the item.

integer

None.

SubCategoryID

If the item has subcategory, this is the CategoryID of the SubCategory.

integer

None.

TaxCodeID

Identifies the tax category that is associated with the item. Only one tax category can be selected per item.

string

None.

CurrencyTypeID

Identifies the currency type associated with the item. Common values can be United States Dollar (USD) or Canada (Can). Actual currency type is applied when the shipping country is applied.

integer

None.

VirtualItem

Identifies if the item is exempt from shipping charges. This field was previously labeled - Virtual Item.

boolean

None.

FreeShipping

Turn this field ON if youwould like this product to NOT be factored into the formula when calculating shipping.For example, if you calculate by Percentage of Total, when you check this field on, the price of this product will not be used in the formula.

boolean

None.

HandlingFee

Sets the handling fee for this item and will only show when Handling Fee Aware is set and will be added to the order when appropriate.

decimal number

None.

ShippingSurcharge

Use this field to add additional dollars to the shipping amount automatically calculated. This is useful if you generally sell lighter items all in the same price range and you charge by Percentage of Total. Then, after shipping rates are established, a low cost, heavy item is added to your product line. To keep from changing your shipping schedule, you could add a dollar amount in this field. This calculated shipping amount would then increase by this amount (multiplied by quantity). The amount added to the shipping cost is performed after the maximum and minimum shipping amount are calculated. This field is only effective for shipping methods of 'Percentage of Total' and 'Weight'. For instance, if your shipping amount for a particular order was computed to $6, and you entered $10 in this field, if this product (with a quantity of 1) was on that order, the new shipping rate would then be $16.

decimal number

None.

Weight

This field is only used for purposes of calculating shipping costs if shipping is setup to be calculated based on 'Weight'. Each product inventory should be reported in the same weight scale. For instance, if you have ounces and pounds, put everything in ounces. It is important to have the units using a single scale. Clients utilizing Ship methods with real-time rate lookups need to assign uniform pound (lbs)-based weight assignments.

decimal number

None.

SubjectToPartyRetainedEarnings

Retained earnings are what a Rep earns back immediately from a party.

boolean

None.

SubjectToHostessRewards

Hostess rewards are rewards a party hostess earns based on party sales. Unchecking this box will remove this item from rewards calculations.

boolean

None.

Active

Inventory needs to be set to active for it to be visible in back office.

boolean

None.

IsAutoshipTemplateItem

Indicate if item is configure in Autoship Template.

boolean

None.

IsResellable

Indicate if item is resellable

boolean

None.

MinResellablePrice

Indicate the minimum resellable Price

decimal number

None.

IsAutoshipDefaultOption

Indicate that Autoship is the default selected option in the shopping cart

boolean

None.

Request Formats

application/xml, text/xml

Sample:
<InventoryDetailViewModel>
  <ProductID>sample string 1</ProductID>
  <Description>sample string 2</Description>
  <Explanation>sample string 3</Explanation>
  <LongExplanation>sample string 4</LongExplanation>
  <CategoryID>5</CategoryID>
  <SubCategoryID>1</SubCategoryID>
  <TaxCodeID>sample string 6</TaxCodeID>
  <CurrencyTypeID>7</CurrencyTypeID>
  <VirtualItem>True</VirtualItem>
  <FreeShipping>True</FreeShipping>
  <HandlingFee>1</HandlingFee>
  <ShippingSurcharge>1</ShippingSurcharge>
  <Weight>1</Weight>
  <SubjectToPartyRetainedEarnings>True</SubjectToPartyRetainedEarnings>
  <SubjectToHostessRewards>True</SubjectToHostessRewards>
  <Active>True</Active>
  <IsAutoshipTemplateItem>True</IsAutoshipTemplateItem>
  <IsResellable>True</IsResellable>
  <MinResellablePrice>14</MinResellablePrice>
  <IsAutoshipDefaultOption>True</IsAutoshipDefaultOption>
</InventoryDetailViewModel>

application/json, text/json

Sample:
{
  "ProductID": "sample string 1",
  "Description": "sample string 2",
  "Explanation": "sample string 3",
  "LongExplanation": "sample string 4",
  "CategoryID": 5,
  "SubCategoryID": 1,
  "TaxCodeID": "sample string 6",
  "CurrencyTypeID": 7,
  "VirtualItem": true,
  "FreeShipping": true,
  "HandlingFee": 1.0,
  "ShippingSurcharge": 1.0,
  "Weight": 1.0,
  "SubjectToPartyRetainedEarnings": true,
  "SubjectToHostessRewards": true,
  "Active": true,
  "IsAutoshipTemplateItem": true,
  "IsResellable": true,
  "MinResellablePrice": 14.0,
  "IsAutoshipDefaultOption": true
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'InventoryDetailViewModel'.

Response Information

Resource Description

InventoryDetailViewModel
NameDescriptionTypeAdditional information
ProductID

This is a brief description of the item which is limited to 20 characters and can also identify how an item is tracked in a warehouse.

string

None.

Description

string

None.

Explanation

Identifies the alternate text that will appear on the shopping cart when the item is listed with other items.

string

None.

LongExplanation

Can be used to provide a lengthy item description and will appear when a customer or rep selects to view more details on a particular product.

string

None.

CategoryID

Identifies the category that is associated with the item.

integer

None.

SubCategoryID

If the item has subcategory, this is the CategoryID of the SubCategory.

integer

None.

TaxCodeID

Identifies the tax category that is associated with the item. Only one tax category can be selected per item.

string

None.

CurrencyTypeID

Identifies the currency type associated with the item. Common values can be United States Dollar (USD) or Canada (Can). Actual currency type is applied when the shipping country is applied.

integer

None.

VirtualItem

Identifies if the item is exempt from shipping charges. This field was previously labeled - Virtual Item.

boolean

None.

FreeShipping

Turn this field ON if youwould like this product to NOT be factored into the formula when calculating shipping.For example, if you calculate by Percentage of Total, when you check this field on, the price of this product will not be used in the formula.

boolean

None.

HandlingFee

Sets the handling fee for this item and will only show when Handling Fee Aware is set and will be added to the order when appropriate.

decimal number

None.

ShippingSurcharge

Use this field to add additional dollars to the shipping amount automatically calculated. This is useful if you generally sell lighter items all in the same price range and you charge by Percentage of Total. Then, after shipping rates are established, a low cost, heavy item is added to your product line. To keep from changing your shipping schedule, you could add a dollar amount in this field. This calculated shipping amount would then increase by this amount (multiplied by quantity). The amount added to the shipping cost is performed after the maximum and minimum shipping amount are calculated. This field is only effective for shipping methods of 'Percentage of Total' and 'Weight'. For instance, if your shipping amount for a particular order was computed to $6, and you entered $10 in this field, if this product (with a quantity of 1) was on that order, the new shipping rate would then be $16.

decimal number

None.

Weight

This field is only used for purposes of calculating shipping costs if shipping is setup to be calculated based on 'Weight'. Each product inventory should be reported in the same weight scale. For instance, if you have ounces and pounds, put everything in ounces. It is important to have the units using a single scale. Clients utilizing Ship methods with real-time rate lookups need to assign uniform pound (lbs)-based weight assignments.

decimal number

None.

SubjectToPartyRetainedEarnings

Retained earnings are what a Rep earns back immediately from a party.

boolean

None.

SubjectToHostessRewards

Hostess rewards are rewards a party hostess earns based on party sales. Unchecking this box will remove this item from rewards calculations.

boolean

None.

Active

Inventory needs to be set to active for it to be visible in back office.

boolean

None.

IsAutoshipTemplateItem

Indicate if item is configure in Autoship Template.

boolean

None.

IsResellable

Indicate if item is resellable

boolean

None.

MinResellablePrice

Indicate the minimum resellable Price

decimal number

None.

IsAutoshipDefaultOption

Indicate that Autoship is the default selected option in the shopping cart

boolean

None.

Response Formats

application/xml, text/xml

Sample:
<InventoryDetailViewModel>
  <ProductID>sample string 1</ProductID>
  <Description>sample string 2</Description>
  <Explanation>sample string 3</Explanation>
  <LongExplanation>sample string 4</LongExplanation>
  <CategoryID>5</CategoryID>
  <SubCategoryID>1</SubCategoryID>
  <TaxCodeID>sample string 6</TaxCodeID>
  <CurrencyTypeID>7</CurrencyTypeID>
  <VirtualItem>True</VirtualItem>
  <FreeShipping>True</FreeShipping>
  <HandlingFee>1</HandlingFee>
  <ShippingSurcharge>1</ShippingSurcharge>
  <Weight>1</Weight>
  <SubjectToPartyRetainedEarnings>True</SubjectToPartyRetainedEarnings>
  <SubjectToHostessRewards>True</SubjectToHostessRewards>
  <Active>True</Active>
  <IsAutoshipTemplateItem>True</IsAutoshipTemplateItem>
  <IsResellable>True</IsResellable>
  <MinResellablePrice>14</MinResellablePrice>
  <IsAutoshipDefaultOption>True</IsAutoshipDefaultOption>
</InventoryDetailViewModel>

application/json, text/json

Sample:
{
  "ProductID": "sample string 1",
  "Description": "sample string 2",
  "Explanation": "sample string 3",
  "LongExplanation": "sample string 4",
  "CategoryID": 5,
  "SubCategoryID": 1,
  "TaxCodeID": "sample string 6",
  "CurrencyTypeID": 7,
  "VirtualItem": true,
  "FreeShipping": true,
  "HandlingFee": 1.0,
  "ShippingSurcharge": 1.0,
  "Weight": 1.0,
  "SubjectToPartyRetainedEarnings": true,
  "SubjectToHostessRewards": true,
  "Active": true,
  "IsAutoshipTemplateItem": true,
  "IsResellable": true,
  "MinResellablePrice": 14.0,
  "IsAutoshipDefaultOption": true
}