Update Shipment Carrier

PATCH /inventory/shipment-carriers/{id}

Group: Inventory › Shipment Carriers · Operation ID: updateShipmentCarrier

Updates the shipment carrier with the given identifier. Only the fields in the request body change.

Only the fields in the request body change. name cannot be cleared and is not checked for uniqueness, so renaming a carrier onto a name another carrier already has is allowed. Setting active to false retires a carrier without deleting it, which is the alternative when DELETE refuses because shipments still reference it. The response contains only the id. Read the record with GET inventory/shipment-carriers/:id.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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 for the shipment carrier to update.

Request body

Required, application/json: updateShipmentCarrierInput.

Field Type Required Description
name string no The name of the carrier, for example 'DHL Express'. It cannot be cleared and is not checked for uniqueness.
active boolean no Whether the carrier can be selected on new shipments.
vendorId string or null no The unique identifier for the vendor this carrier bills through. Send a vendor's identifier to set or repoint the link, or send null to clear it. An identifier matching no vendor fails the call with VENDOR_NOT_FOUND. See id on GET accounting/vendors/:id.

Example:

{
  "name": "<name>",
  "active": false,
  "vendorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Under data (updateShipmentCarrierOutput):

Field Type Required Description
id string yes The unique identifier for the shipment carrier.

Response headers

Errors

Code Status
NOT_FOUND 400
VENDOR_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses