Creates a shipment carrier.

POST /inventory/shipment-carriers

Group: Inventory › Shipment Carriers · Operation ID: createShipmentCarrier

Creates one shipment carrier. name is the only required field and is not checked for uniqueness, so a second carrier with an existing name is allowed. active defaults to true, so the carrier can be selected on new shipments as soon as it exists. The response contains only the new carrier's id. Read the record with GET inventory/shipment-carriers/:id. To create many carriers at once, use POST inventory/shipment-carriers/bulk.

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.

Request body

Required, application/json: createShipmentCarrierInput.

Field	Type	Required	Description
`name`	string	yes	The name of the carrier, for example 'DHL Express'. It is not checked for uniqueness.
`active`	boolean	no	Whether the carrier can be selected on new shipments. Defaults to true.
`vendorId`	string	no	The unique identifier for the vendor this carrier bills through. Omit for a carrier with no vendor. An identifier matching no vendor fails the call with VENDOR_NOT_FOUND. See id on GET accounting/vendors/:id.

Example:

{
  "name": "DHL Express",
  "active": true,
  "vendorId": "d4a71e08-6b95-4f23-b7c1-52e08a936d47"
}

Response

200 Success

Under data (createShipmentCarrierOutput):

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

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`VENDOR_NOT_FOUND`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: VENDOR_NOT_FOUND
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error