Bulk create shipment carriers

Operation ID: bulkCreateShipmentCarriers

Group: Inventory › Shipment Carriers

Open in the interactive reference

POST /inventory/shipment-carriers/bulk

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

Creates multiple shipment carriers in one request. Each carrier in the request takes the same fields as the body of POST inventory/shipment-carriers.

If any carrier can't be created, none are, and the error gives that carrier's position in the request.

The response lists the created carriers in the order you sent them, each with only its 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.

Request body

Required, application/json: bulkCreateShipmentCarriersInput.

Field Type Required Description
shipmentCarriers array<object> yes The shipment carriers to create. If any row is invalid, the whole call is rejected and nothing is created. Example: [{"name":"DHL Express","vendorId":"d4a71e08-6b95-4f23-b7c1-52e08a936d47"},{"name":"In-house fleet","active":false}].
shipmentCarriers[].name string yes The name of the carrier, for example 'DHL Express'. It is not checked for uniqueness, within the batch or against existing carriers.
shipmentCarriers[].active boolean no Whether the carrier can be selected on new shipments. Defaults to true.
shipmentCarriers[].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 whole call with VENDOR_NOT_FOUND naming this row's index. See id on GET accounting/vendors/:id. 
{
  "shipmentCarriers": [
    {
      "name": "DHL Express",
      "vendorId": "d4a71e08-6b95-4f23-b7c1-52e08a936d47"
    },
    {
      "name": "In-house fleet",
      "active": false
    }
  ]
}

Response

200 Success

Under data (bulkCreateShipmentCarriersOutput):

Field Type Required Description
created array<object> yes The created shipment carriers, in the same order as the input. Example: [{"id":"5c2e9a71-3f48-4b02-8d6e-9a1c74b0e332"},{"id":"b81f4c60-27da-4e15-9f33-6c0a5d82e714"}].
created[].id string yes The unique identifier for the created shipment carrier. 
{
  "data": {
    "created": [
      {
        "id": "5c2e9a71-3f48-4b02-8d6e-9a1c74b0e332"
      },
      {
        "id": "b81f4c60-27da-4e15-9f33-6c0a5d82e714"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
VENDOR_NOT_FOUND 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses