Bulk delete reason codes

Operation ID: bulkDeleteReasonCodes

Group: Inventory › Reason Codes

Open in the interactive reference

POST /inventory/reason-codes/bulk-delete

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

Deletes multiple reason codes in one request. If any reason code can't be deleted, none are deleted. The response lists each deleted reason code's id and code in the order you sent the ids.

A reason code that an inventory increase, inventory decrease, inventory revaluation, purchase return, or sales return still uses can't be deleted. To retire the reason code instead, set isActive to false with PATCH inventory/reason-codes/:id.

To delete a single reason code, use DELETE inventory/reason-codes/: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: bulkDeleteReasonCodesInput.

Field Type Required Description
ids array<string> yes The unique identifiers for the reason codes to delete. If any identifier matches nothing or its reason code is still named on a document, nothing is deleted and the whole call fails. Example: ["3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45","e57a0d34-9f62-4b18-bc25-71a6e8039d4b"]. 
{
  "ids": [
    "3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45",
    "e57a0d34-9f62-4b18-bc25-71a6e8039d4b"
  ]
}

Response

200 Success

Under data (bulkDeleteReasonCodesOutput):

Field Type Required Description
deleted array<object> yes The deleted reason codes, in the same order as the input. Match entries to inputs by index.
deleted[].id string yes The unique identifier for the deleted reason code.
deleted[].code string yes The business code the deleted reason code held. 
{
  "data": {
    "deleted": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "code": "<code>"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
REASON_CODE_IN_USE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses