POST api/ItemDatas

Creates an item.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ItemId	Unique identifier from the BGS system that is assigned at item creation, and it can be used as an id parameter.	integer	None.
SKU	Unique SKU identifier from your system.	string	Required String length: inclusive between 0 and 40
SKU2	Alternate SKU identifier from your system.	string	None.
ItemName	Description for the item.	string	Required String length: inclusive between 0 and 100
Weight	Weight is in lbs.	decimal number	None.
Length	Dimensions are in inches.	decimal number	None.
Width	Dimensions are in inches.	decimal number	None.
Height	Dimensions are in inches.	decimal number	None.
ItemNotes	Text submitted here will be seen by the warehouse employees when viewing the item list.	string	String length: inclusive between 0 and 255
DeclaredValue	The declared value for international customs paperwork purposes.	decimal number	None.
HTSCode	The Harmonized Tariff Schedule Code for international customs paperwork purposes.	string	None.
CaseQuantity	The number of units that fit inside of a master carton.	integer	None.
IsVirtual	Default value is false. If the item is a virtual (non-fulfillable) item, then use true. If the item is an inventoriable fulfillable item, then use false.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ItemId": 2,
  "SKU": "sample string 3",
  "SKU2": "sample string 4",
  "ItemName": "sample string 5",
  "Weight": 1.0,
  "Length": 1.0,
  "Width": 1.0,
  "Height": 1.0,
  "ItemNotes": "sample string 6",
  "DeclaredValue": 1.0,
  "HTSCode": "sample string 7",
  "CaseQuantity": 1,
  "IsVirtual": true
}

application/xml, text/xml

Sample:

<ItemData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <CaseQuantity>1</CaseQuantity>
  <DeclaredValue>1</DeclaredValue>
  <HTSCode>sample string 7</HTSCode>
  <Height>1</Height>
  <IsVirtual>true</IsVirtual>
  <ItemDataId>1</ItemDataId>
  <ItemId>2</ItemId>
  <ItemName>sample string 5</ItemName>
  <ItemNotes>sample string 6</ItemNotes>
  <Length>1</Length>
  <SKU>sample string 3</SKU>
  <SKU2>sample string 4</SKU2>
  <Weight>1</Weight>
  <Width>1</Width>
</ItemData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ResultItem

Name	Description	Type	Additional information
SKU	Unique item identifier submitted from your system.	string	None.
ItemName	Description for the item.	string	None.
ResultDetail	If Success, then there will only by one record returned for the item. If Error, then there will be a record returned for each error caught.	Collection of ResultDetail_Item	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "SKU": "sample string 3",
    "ItemName": "sample string 4",
    "ResultDetail": [
      {
        "Status": "sample string 3",
        "Details": "sample string 4"
      },
      {
        "Status": "sample string 3",
        "Details": "sample string 4"
      }
    ]
  },
  {
    "SKU": "sample string 3",
    "ItemName": "sample string 4",
    "ResultDetail": [
      {
        "Status": "sample string 3",
        "Details": "sample string 4"
      },
      {
        "Status": "sample string 3",
        "Details": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfResultItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCBGSAPI.Models">
  <ResultItem>
    <ItemName>sample string 4</ItemName>
    <OrderItemResultId>2</OrderItemResultId>
    <ResultDetail>
      <ResultDetail_Item>
        <Details>sample string 4</Details>
        <ResultDetail_ItemId>1</ResultDetail_ItemId>
        <ResultItemId>2</ResultItemId>
        <Status>sample string 3</Status>
      </ResultDetail_Item>
      <ResultDetail_Item>
        <Details>sample string 4</Details>
        <ResultDetail_ItemId>1</ResultDetail_ItemId>
        <ResultItemId>2</ResultItemId>
        <Status>sample string 3</Status>
      </ResultDetail_Item>
    </ResultDetail>
    <ResultItemId>1</ResultItemId>
    <SKU>sample string 3</SKU>
  </ResultItem>
  <ResultItem>
    <ItemName>sample string 4</ItemName>
    <OrderItemResultId>2</OrderItemResultId>
    <ResultDetail>
      <ResultDetail_Item>
        <Details>sample string 4</Details>
        <ResultDetail_ItemId>1</ResultDetail_ItemId>
        <ResultItemId>2</ResultItemId>
        <Status>sample string 3</Status>
      </ResultDetail_Item>
      <ResultDetail_Item>
        <Details>sample string 4</Details>
        <ResultDetail_ItemId>1</ResultDetail_ItemId>
        <ResultItemId>2</ResultItemId>
        <Status>sample string 3</Status>
      </ResultDetail_Item>
    </ResultDetail>
    <ResultItemId>1</ResultItemId>
    <SKU>sample string 3</SKU>
  </ResultItem>
</ArrayOfResultItem>