Update a landed cost item

Operation ID: updateLandedCostItem

Group: Inventory › Landed Cost Items

Open in the interactive reference

PATCH /inventory/landed-cost-items/{id}

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Updates a landed cost item with the fields you send. A field you leave out keeps its current value. You cannot remove a field's value, because null is not accepted.

Changing itemId or accountId to one that another landed cost item already uses fails, because each itemId and each accountId can be used by only one landed cost item.

The response contains only the id. To see the updated landed cost item, use GET inventory/landed-cost-items/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier of the landed cost item you want to update. Format: UUID.

Request body

Required, application/json: updateLandedCostItemInput.

Field Type Required Description
itemId string no The unique identifier of the item this landed cost item covers, such as a freight, handling, or insurance service item. Format: UUID. A vendor bill line for this item counts as a landed cost charge. See id on GET inventory/items/:id (getItem).
accountId string no The unique identifier of the general ledger account this landed cost item covers. Format: UUID. A vendor bill line with this expense account counts as a landed cost charge. See id on GET accounting/accounts/:id (getAccount).
allocationMode string no How a charge is spread (allocated) over the receipt lines. Changing it does not change the charges already on landed costs. Accepted values: 'Equal', 'Quantity', 'LineTotal', 'Weight', 'Volume'. Example: "Quantity".
costingElementTypeId string no The unique identifier of the costing element type for this landed cost item's charges. Format: UUID. A costing element type is a category of inventory cost, such as duties. When a landed cost is committed, its inventory revaluations for these charges get this costing element type.
active boolean no Whether the landed cost item is active. 
{
  "itemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "allocationMode": "Quantity",
  "costingElementTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active": true
}

Response

200 Success

Under data (updateLandedCostItemOutput):

Field Type Required Description
id string yes The unique identifier for the landed cost item. Format: UUID. Example: "9f3c71a4-2e58-4b06-8d19-5a7e0c34b2f1". 
{
  "data": {
    "id": "9f3c71a4-2e58-4b06-8d19-5a7e0c34b2f1"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
REFERENCE_NOT_FOUND 400
UNKNOWN_ALLOCATION_MODE 400
DUPLICATE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses