PUT api/v1/inventory/item/{code}

Update an inventory item

Request Information

URI Parameters

Name	Description	Type	Additional information
code	Inventory item that will be updated	string	Required

Body Parameters

Inventory item object that needs to be updated

InventoryItem

Name	Description	Type	Additional information
Code	Gets or Sets Code	string	Required String length: inclusive between 0 and 20
Status	Gets or Sets Status	StatusEnum	None.
Description	Gets or Sets Description	string	String length: inclusive between 0 and 50
Added	Gets or Sets Added	date	None.
FMV	Gets or Sets Fmv	decimal number	None.
Cost	Gets or Sets Cost	decimal number	None.
Retail	Gets or Sets Retail	decimal number	None.
Offer	Gets or Sets Offer	decimal number	None.
Restricted	Gets or Sets Restricted	date	None.
OfferDescription	Gets or Sets Offerdescription	string	String length: inclusive between 0 and 50
Type	Gets or Sets Type	string	String length: inclusive between 0 and 2
Category	Gets or Sets Category	string	String length: inclusive between 0 and 2
Vendor	Gets or Sets Vendor	string	String length: inclusive between 0 and 10
Comments	Gets or Sets Comments	string	None.
Keywords	Gets or Sets Keywords	string	String length: inclusive between 0 and 500
Author	Gets or Sets Author	string	String length: inclusive between 0 and 250
Copyright	Gets or Sets Copyright	string	None.
Weight	Gets or Sets Weight	decimal number	None.
Expiration	Gets or Sets Expiration	date	None.
LastUpdated	Gets LastUpdated	date	None.
LastUpdatedBy	Gets or Sets LastUpdatedBy	string	String length: inclusive between 0 and 200
Created	Gets Created	date	None.
CreatedBy	Gets or Sets CreatedBy	string	String length: inclusive between 0 and 200
Personalization	Gets or Sets Personalization	InventoryItemPersonalization	None.
Locations		Collection of InventoryItemLocations	None.
Attributes	Gets or Sets Attributes	InventoryItemAttributes	None.

Request Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "Status": "D",
  "Description": "sample string 2",
  "Added": "2025-09-04T15:04:25.318",
  "FMV": 1.0,
  "Cost": 1.0,
  "Retail": 1.0,
  "Offer": 1.0,
  "Restricted": "2025-09-04T15:04:25.318",
  "OfferDescription": "sample string 3",
  "Type": "sample string 4",
  "Category": "sample string 5",
  "Vendor": "sample string 6",
  "Comments": "sample string 7",
  "Keywords": "sample string 8",
  "Author": "sample string 9",
  "Copyright": "sample string 10",
  "Weight": 1.1,
  "Expiration": "2025-09-04T15:04:25.318",
  "LastUpdated": "2025-09-04T15:04:25.318",
  "LastUpdatedBy": "sample string 11",
  "Created": "2025-09-04T15:04:25.318",
  "CreatedBy": "sample string 12",
  "Personalization": {
    "MaxLength": 1,
    "ApprovalWeeks": 1
  },
  "Locations": [
    {
      "Location": "sample string 1",
      "IsActive": 2,
      "IsDefault": 3
    },
    {
      "Location": "sample string 1",
      "IsActive": 2,
      "IsDefault": 3
    }
  ],
  "Attributes": {
    "Intangible": true,
    "MediaMailEligible": true,
    "FutureItem": true,
    "AvailableForAnyGift": true,
    "Numbered": true,
    "ShipByItself": true,
    "MayBeBackordered": true
  }
}

application/xml, text/xml

Sample:

<InventoryItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Added>2025-09-04T15:04:25.3184237+00:00</Added>
  <Attributes>
    <AvailableForAnyGift>true</AvailableForAnyGift>
    <FutureItem>true</FutureItem>
    <Intangible>true</Intangible>
    <MayBeBackordered>true</MayBeBackordered>
    <MediaMailEligible>true</MediaMailEligible>
    <Numbered>true</Numbered>
    <ShipByItself>true</ShipByItself>
  </Attributes>
  <Author>sample string 9</Author>
  <Category>sample string 5</Category>
  <Code>sample string 1</Code>
  <Comments>sample string 7</Comments>
  <Copyright>sample string 10</Copyright>
  <Cost>1</Cost>
  <Created>2025-09-04T15:04:25.3184237+00:00</Created>
  <CreatedBy>sample string 12</CreatedBy>
  <Description>sample string 2</Description>
  <Expiration>2025-09-04T15:04:25.3184237+00:00</Expiration>
  <FMV>1</FMV>
  <Keywords>sample string 8</Keywords>
  <LastUpdated>2025-09-04T15:04:25.3184237+00:00</LastUpdated>
  <LastUpdatedBy>sample string 11</LastUpdatedBy>
  <Locations>
    <InventoryItemLocations>
      <IsActive>2</IsActive>
      <IsDefault>3</IsDefault>
      <Location>sample string 1</Location>
    </InventoryItemLocations>
    <InventoryItemLocations>
      <IsActive>2</IsActive>
      <IsDefault>3</IsDefault>
      <Location>sample string 1</Location>
    </InventoryItemLocations>
  </Locations>
  <Offer>1</Offer>
  <OfferDescription>sample string 3</OfferDescription>
  <Personalization>
    <ApprovalWeeks>1</ApprovalWeeks>
    <MaxLength>1</MaxLength>
  </Personalization>
  <Restricted>2025-09-04T15:04:25.3184237+00:00</Restricted>
  <Retail>1</Retail>
  <Status>DEnum</Status>
  <Type>sample string 4</Type>
  <Vendor>sample string 6</Vendor>
  <Weight>1.1</Weight>
</InventoryItem>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.