POST api/Inventory/Adjust

Applies inventory adjustments in the authenticated user's current warehouse.

Request Information

URI Parameters

None.

Body Parameters

Inventory adjustments to apply. Each adjustment requires InventoryUnitId or SKU + Location, AdjustmentType, and Amount.

Name	Description	Type	Additional information
Reason	Default reason written to InventoryAdjustments when an adjustment row does not provide one.	string	None.
Adjustments	Inventory adjustment rows to apply.	Collection of InventoryAdjustmentDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "Reason": "sample string 1",
  "Adjustments": [
    {
      "InventoryUnitId": 1,
      "SKU": "sample string 1",
      "Location": "sample string 2",
      "AdjustmentType": "sample string 3",
      "Amount": 1,
      "Reason": "sample string 4"
    },
    {
      "InventoryUnitId": 1,
      "SKU": "sample string 1",
      "Location": "sample string 2",
      "AdjustmentType": "sample string 3",
      "Amount": 1,
      "Reason": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<InventoryAdjustmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <Adjustments>
    <InventoryAdjustmentDetail>
      <AdjustmentType>sample string 3</AdjustmentType>
      <Amount>1</Amount>
      <InventoryUnitId>1</InventoryUnitId>
      <Location>sample string 2</Location>
      <Reason>sample string 4</Reason>
      <SKU>sample string 1</SKU>
    </InventoryAdjustmentDetail>
    <InventoryAdjustmentDetail>
      <AdjustmentType>sample string 3</AdjustmentType>
      <Amount>1</Amount>
      <InventoryUnitId>1</InventoryUnitId>
      <Location>sample string 2</Location>
      <Reason>sample string 4</Reason>
      <SKU>sample string 1</SKU>
    </InventoryAdjustmentDetail>
  </Adjustments>
  <Reason>sample string 1</Reason>
</InventoryAdjustmentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InventoryAdjustmentResponse

Name	Type	Additional information
Message	string	None.
RequestedAdjustments	integer	None.
AdjustedUnits	integer	None.
Adjustments	Collection of InventoryAdjustmentResult	None.

Response Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "RequestedAdjustments": 2,
  "AdjustedUnits": 3,
  "Adjustments": [
    {
      "InventoryUnitId": 1,
      "ItemId": 2,
      "SKU": "sample string 3",
      "Location": "sample string 4",
      "PreviousQuantity": 5,
      "NewQuantity": 6,
      "AdjustmentQuantity": 7,
      "Deactivated": true
    },
    {
      "InventoryUnitId": 1,
      "ItemId": 2,
      "SKU": "sample string 3",
      "Location": "sample string 4",
      "PreviousQuantity": 5,
      "NewQuantity": 6,
      "AdjustmentQuantity": 7,
      "Deactivated": true
    }
  ]
}

application/xml, text/xml

Sample:

<InventoryAdjustmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Controllers">
  <AdjustedUnits>3</AdjustedUnits>
  <Adjustments>
    <InventoryAdjustmentResult>
      <AdjustmentQuantity>7</AdjustmentQuantity>
      <Deactivated>true</Deactivated>
      <InventoryUnitId>1</InventoryUnitId>
      <ItemId>2</ItemId>
      <Location>sample string 4</Location>
      <NewQuantity>6</NewQuantity>
      <PreviousQuantity>5</PreviousQuantity>
      <SKU>sample string 3</SKU>
    </InventoryAdjustmentResult>
    <InventoryAdjustmentResult>
      <AdjustmentQuantity>7</AdjustmentQuantity>
      <Deactivated>true</Deactivated>
      <InventoryUnitId>1</InventoryUnitId>
      <ItemId>2</ItemId>
      <Location>sample string 4</Location>
      <NewQuantity>6</NewQuantity>
      <PreviousQuantity>5</PreviousQuantity>
      <SKU>sample string 3</SKU>
    </InventoryAdjustmentResult>
  </Adjustments>
  <Message>sample string 1</Message>
  <RequestedAdjustments>2</RequestedAdjustments>
</InventoryAdjustmentResponse>