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

Update an inventory package

Request Information

URI Parameters

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

Body Parameters

Inventory package object that needs to be updated

InventoryPackage

Name	Description	Type	Additional information
Code	Gets or Sets Code	string	Required String length: inclusive between 0 and 20
Status	Gets or Sets Status	string	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.
Offer	Gets or Sets Offer	decimal number	None.
Restricted	Gets or Sets Restricted	date	None.
Comments	Gets or Sets Comments	string	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 CreatedBy	string	String length: inclusive between 0 and 200
Contents	Gets or Sets Contents	Collection of InventoryPackageContents	None.
Attributes	Gets or Sets Attributes	InventoryPackageAttributes	None.

Request Formats

application/json, text/json

Sample:

{
  "Code": "sample string 1",
  "Status": "sample string 2",
  "Description": "sample string 3",
  "Added": "2025-09-04T15:04:24.233",
  "FMV": 1.0,
  "Cost": 1.0,
  "Offer": 1.0,
  "Restricted": "2025-09-04T15:04:24.233",
  "Comments": "sample string 4",
  "Expiration": "2025-09-04T15:04:24.233",
  "LastUpdated": "2025-09-04T15:04:24.233",
  "LastUpdatedBy": "sample string 5",
  "Created": "2025-09-04T15:04:24.233",
  "CreatedBy": "sample string 6",
  "Contents": [
    {
      "Code": "sample string 1",
      "Quantity": 1,
      "Location": "sample string 2"
    },
    {
      "Code": "sample string 1",
      "Quantity": 1,
      "Location": "sample string 2"
    }
  ],
  "Attributes": {
    "MediaMailEligible": true,
    "AvailableForAnyGift": true,
    "ShipTogether": true
  }
}

application/xml, text/xml

Sample:

<InventoryPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DPCSWS.Models">
  <Added>2025-09-04T15:04:24.2330832+00:00</Added>
  <Attributes>
    <AvailableForAnyGift>true</AvailableForAnyGift>
    <MediaMailEligible>true</MediaMailEligible>
    <ShipTogether>true</ShipTogether>
  </Attributes>
  <Code>sample string 1</Code>
  <Comments>sample string 4</Comments>
  <Contents>
    <InventoryPackageContents>
      <Code>sample string 1</Code>
      <Location>sample string 2</Location>
      <Quantity>1</Quantity>
    </InventoryPackageContents>
    <InventoryPackageContents>
      <Code>sample string 1</Code>
      <Location>sample string 2</Location>
      <Quantity>1</Quantity>
    </InventoryPackageContents>
  </Contents>
  <Cost>1</Cost>
  <Created>2025-09-04T15:04:24.2330832+00:00</Created>
  <CreatedBy>sample string 6</CreatedBy>
  <Description>sample string 3</Description>
  <Expiration>2025-09-04T15:04:24.2330832+00:00</Expiration>
  <FMV>1</FMV>
  <LastUpdated>2025-09-04T15:04:24.2330832+00:00</LastUpdated>
  <LastUpdatedBy>sample string 5</LastUpdatedBy>
  <Offer>1</Offer>
  <Restricted>2025-09-04T15:04:24.2330832+00:00</Restricted>
  <Status>sample string 2</Status>
</InventoryPackage>

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.