POST api/AddOrUpdateCommodity_V1

Add/Replace User/Client Commodity

Request Information

URI Parameters

None.

Body Parameters

The request is presented below!

WS_Repository.Models.Requests.Lists.AddCommodityRequest

Name	Description	Type	Additional information
WS_Key	(Mandatory) Client Or User Webservice Key provided by 2ship support - the type of the ws_key should be set by WSKeyLevel field	string	None.
WSKeyLevel	(Mandatory) Specify the WS_Key type ( User or Client)	WS_Repository.Models.Common.WSKeyLevelType	None.
Commodity	(Mandatory) Commodity to add or update	WS_Repository.Models.Requests.Lists.CommodityToAdd	None.
AddCommodityAsGlobal	(Optional) Specify to add the commodity as global regardless of WS_Key type	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "WS_Key": "sample string 1",
  "WSKeyLevel": 0,
  "Commodity": {
    "ID": "sample string 1",
    "Description": "sample string 2",
    "MadeInCountryCode": "sample string 3",
    "QuantityUnitOfMeasure": "sample string 4",
    "UnitValue": 1.0,
    "TaxPercentage": 1.0,
    "ItemWeight": 1.0,
    "ItemLength": 1.0,
    "ItemWidth": 1.0,
    "ItemHeight": 1.0,
    "ItemMeasurementsType": 0,
    "HarmonizedCode": "sample string 5",
    "Canada_HarmonizedCode": "sample string 6",
    "USA_HarmonizedCode": "sample string 7",
    "PartNumber": "sample string 8",
    "MarksOrNumbers": "sample string 9",
    "SKUOrItemOrUPC": "sample string 10",
    "ExportLicense": "sample string 11",
    "LicenseExpireDate": "2024-04-26T19:32:21.5043578-04:00",
    "NAFTA": true,
    "NAFTACommodityDetails": {
      "PreferenceCriterion": 0,
      "ProducerDetermination": 0,
      "NaftaNetCost": 0,
      "NetCostBeginDate": "2024-04-26T19:32:21.5053465-04:00",
      "NetCostEndDate": "2024-04-26T19:32:21.5053465-04:00"
    },
    "FDA": true,
    "FCC": true,
    "SenderIsProducer": true,
    "Textile": true,
    "TextileInformation": "sample string 12",
    "FCCEntryNumber": "sample string 13",
    "FCCPortOfEntry": "sample string 14",
    "FCCDeviceModel": "sample string 15",
    "FCCTradeName": "sample string 16",
    "FCCID": "sample string 17",
    "FCCDescribeRadioFrequency": "sample string 18",
    "FDADescription": "sample string 19",
    "IsDutiable": true,
    "Manufacturer": {
      "Id": "sample string 1",
      "PersonName": "sample string 2",
      "CompanyName": "sample string 3",
      "Country": "sample string 4",
      "State": "sample string 5",
      "City": "sample string 6",
      "PostalCode": "sample string 7",
      "Address1": "sample string 8",
      "Address2": "sample string 9",
      "Telephone": "sample string 10",
      "Email": "sample string 11",
      "TaxID": "sample string 12"
    },
    "ItemsPerBox": 1.0,
    "AccessionNumber": "sample string 20",
    "DangerousGoods": true,
    "DangerousGoodsInfo": {
      "Accessible": true,
      "RegulationSet": 0,
      "RegulationLevelCode": 0,
      "UN": "sample string 1",
      "Class": "sample string 2",
      "PackingGroup": 0,
      "Authorization": "sample string 3",
      "AdditionalHandlingInformation": "sample string 4",
      "TechnicalName": "sample string 5",
      "AdditionalDescription": "sample string 6",
      "PackagingContainerType": "sample string 7",
      "PackagingType": "sample string 8",
      "SignatureName": "sample string 9",
      "SignaturePlace": "sample string 10",
      "SignatureDate": "sample string 11",
      "SignatureTitle": "sample string 12",
      "TransportType": 0,
      "DGPackingType": 0,
      "Radioactive": true,
      "EmergencyPhone": "sample string 13",
      "EmergencyContact": "sample string 14",
      "AllPackedInOne": true,
      "OverPacked": true,
      "QValue": "sample string 15",
      "ChemicalRecord": "sample string 16",
      "HazardLabelRequired": "sample string 17",
      "SubRiskClass": "sample string 18",
      "TunelRestriction": true,
      "AirportDeparture": "sample string 19",
      "AirportDestination": "sample string 20",
      "ProperShippingName": "sample string 21"
    },
    "LTLClassId": "sample string 21",
    "NMFCItem": "sample string 22",
    "NMFCSub": "sample string 23",
    "MID": "sample string 24",
    "LBSLTSFactor": 1.0,
    "ShipAsItsOwnPackage": true,
    "ShipInAnyPackage": true,
    "ShipOnSkidOnly": true,
    "ShipInMultiplePieces": true,
    "MultiplePiecePackages": [
      {
        "Weight": 1.0,
        "Length": 2.0,
        "Width": 3.0,
        "Height": 4.0
      },
      {
        "Weight": 1.0,
        "Length": 2.0,
        "Width": 3.0,
        "Height": 4.0
      }
    ],
    "PlantArticle": true,
    "PlantArticleGenus": "sample string 25",
    "PlantArticleSpecies": "sample string 26",
    "PlantArticleQuantity": "sample string 27",
    "PlantArticlePercentRecycled": "sample string 28",
    "SerialNumber": "sample string 29",
    "ECCN": "sample string 30",
    "IsBundle": true,
    "BundleComponents": [
      {
        "CommodityID": "sample string 1",
        "Quantity": 2
      },
      {
        "CommodityID": "sample string 1",
        "Quantity": 2
      }
    ]
  },
  "AddCommodityAsGlobal": true
}

application/xml, text/xml

Sample:

<AddCommodityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Requests.Lists">
  <AddCommodityAsGlobal>true</AddCommodityAsGlobal>
  <Commodity>
    <AccessionNumber>sample string 20</AccessionNumber>
    <BundleComponents>
      <BundleComponents>
        <CommodityID>sample string 1</CommodityID>
        <Quantity>2</Quantity>
      </BundleComponents>
      <BundleComponents>
        <CommodityID>sample string 1</CommodityID>
        <Quantity>2</Quantity>
      </BundleComponents>
    </BundleComponents>
    <Canada_HarmonizedCode>sample string 6</Canada_HarmonizedCode>
    <DangerousGoods>true</DangerousGoods>
    <DangerousGoodsInfo>
      <Accessible>true</Accessible>
      <AdditionalDescription>sample string 6</AdditionalDescription>
      <AdditionalHandlingInformation>sample string 4</AdditionalHandlingInformation>
      <AirportDeparture>sample string 19</AirportDeparture>
      <AirportDestination>sample string 20</AirportDestination>
      <AllPackedInOne>true</AllPackedInOne>
      <Authorization>sample string 3</Authorization>
      <ChemicalRecord>sample string 16</ChemicalRecord>
      <Class>sample string 2</Class>
      <DGPackingType>OTHER</DGPackingType>
      <EmergencyContact>sample string 14</EmergencyContact>
      <EmergencyPhone>sample string 13</EmergencyPhone>
      <HazardLabelRequired>sample string 17</HazardLabelRequired>
      <OverPacked>true</OverPacked>
      <PackagingContainerType>sample string 7</PackagingContainerType>
      <PackagingType>sample string 8</PackagingType>
      <PackingGroup>NONE</PackingGroup>
      <ProperShippingName>sample string 21</ProperShippingName>
      <QValue>sample string 15</QValue>
      <Radioactive>true</Radioactive>
      <RegulationLevelCode>FullyRegulated</RegulationLevelCode>
      <RegulationSet>CFR</RegulationSet>
      <SignatureDate>sample string 11</SignatureDate>
      <SignatureName>sample string 9</SignatureName>
      <SignaturePlace>sample string 10</SignaturePlace>
      <SignatureTitle>sample string 12</SignatureTitle>
      <SubRiskClass>sample string 18</SubRiskClass>
      <TechnicalName>sample string 5</TechnicalName>
      <TransportType>PassengerAndCargoAircraft</TransportType>
      <TunelRestriction>true</TunelRestriction>
      <UN>sample string 1</UN>
    </DangerousGoodsInfo>
    <Description>sample string 2</Description>
    <ECCN>sample string 30</ECCN>
    <ExportLicense>sample string 11</ExportLicense>
    <FCC>true</FCC>
    <FCCDescribeRadioFrequency>sample string 18</FCCDescribeRadioFrequency>
    <FCCDeviceModel>sample string 15</FCCDeviceModel>
    <FCCEntryNumber>sample string 13</FCCEntryNumber>
    <FCCID>sample string 17</FCCID>
    <FCCPortOfEntry>sample string 14</FCCPortOfEntry>
    <FCCTradeName>sample string 16</FCCTradeName>
    <FDA>true</FDA>
    <FDADescription>sample string 19</FDADescription>
    <HarmonizedCode>sample string 5</HarmonizedCode>
    <ID>sample string 1</ID>
    <IsBundle>true</IsBundle>
    <IsDutiable>true</IsDutiable>
    <ItemHeight>1</ItemHeight>
    <ItemLength>1</ItemLength>
    <ItemMeasurementsType>Imperial</ItemMeasurementsType>
    <ItemWeight>1</ItemWeight>
    <ItemWidth>1</ItemWidth>
    <ItemsPerBox>1</ItemsPerBox>
    <LBSLTSFactor>1</LBSLTSFactor>
    <LTLClassId>sample string 21</LTLClassId>
    <LicenseExpireDate>2024-04-26T19:32:21.5043578-04:00</LicenseExpireDate>
    <MID>sample string 24</MID>
    <MadeInCountryCode>sample string 3</MadeInCountryCode>
    <Manufacturer>
      <Address1>sample string 8</Address1>
      <Address2>sample string 9</Address2>
      <City>sample string 6</City>
      <CompanyName>sample string 3</CompanyName>
      <Country>sample string 4</Country>
      <Email>sample string 11</Email>
      <Id>sample string 1</Id>
      <PersonName>sample string 2</PersonName>
      <PostalCode>sample string 7</PostalCode>
      <State>sample string 5</State>
      <TaxID>sample string 12</TaxID>
      <Telephone>sample string 10</Telephone>
    </Manufacturer>
    <MarksOrNumbers>sample string 9</MarksOrNumbers>
    <MultiplePiecePackages>
      <MultiplePiecePackage>
        <Height>4</Height>
        <Length>2</Length>
        <Weight>1</Weight>
        <Width>3</Width>
      </MultiplePiecePackage>
      <MultiplePiecePackage>
        <Height>4</Height>
        <Length>2</Length>
        <Weight>1</Weight>
        <Width>3</Width>
      </MultiplePiecePackage>
    </MultiplePiecePackages>
    <NAFTA>true</NAFTA>
    <NAFTACommodityDetails>
      <NaftaNetCost>NC</NaftaNetCost>
      <NetCostBeginDate>2024-04-26T19:32:21.5053465-04:00</NetCostBeginDate>
      <NetCostEndDate>2024-04-26T19:32:21.5053465-04:00</NetCostEndDate>
      <PreferenceCriterion>A</PreferenceCriterion>
      <ProducerDetermination>YES</ProducerDetermination>
    </NAFTACommodityDetails>
    <NMFCItem>sample string 22</NMFCItem>
    <NMFCSub>sample string 23</NMFCSub>
    <PartNumber>sample string 8</PartNumber>
    <PlantArticle>true</PlantArticle>
    <PlantArticleGenus>sample string 25</PlantArticleGenus>
    <PlantArticlePercentRecycled>sample string 28</PlantArticlePercentRecycled>
    <PlantArticleQuantity>sample string 27</PlantArticleQuantity>
    <PlantArticleSpecies>sample string 26</PlantArticleSpecies>
    <QuantityUnitOfMeasure>sample string 4</QuantityUnitOfMeasure>
    <SKUOrItemOrUPC>sample string 10</SKUOrItemOrUPC>
    <SenderIsProducer>true</SenderIsProducer>
    <SerialNumber>sample string 29</SerialNumber>
    <ShipAsItsOwnPackage>true</ShipAsItsOwnPackage>
    <ShipInAnyPackage>true</ShipInAnyPackage>
    <ShipInMultiplePieces>true</ShipInMultiplePieces>
    <ShipOnSkidOnly>true</ShipOnSkidOnly>
    <TaxPercentage>1</TaxPercentage>
    <Textile>true</Textile>
    <TextileInformation>sample string 12</TextileInformation>
    <USA_HarmonizedCode>sample string 7</USA_HarmonizedCode>
    <UnitValue>1</UnitValue>
  </Commodity>
  <WSKeyLevel>User</WSKeyLevel>
  <WS_Key>sample string 1</WS_Key>
</AddCommodityRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'System.Web.Http.ModelBinding.JQueryMvcFormUrlEncodedFormatter' to write type 'WS_Repository.Models.Requests.Lists.AddCommodityRequest'.

Response Information

Resource Description

WS_Repository.Models.Responses.Lists.AddCommodityResponse

Name	Description	Type	Additional information
Success	Specify if the import was successfully done	boolean	None.
ErrorMessage	The error message if the import get an error	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<AddCommodityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WS_Repository.Models.Responses.Lists">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Success>true</Success>
</AddCommodityResponse>