Bulk create reason codes

Operation ID: bulkCreateReasonCodes

Group: Inventory › Reason Codes

Open in the interactive reference

POST /inventory/reason-codes/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 reason codes in one request. Send documentTypes with every reason code. It can be an empty list. If any reason code can't be created, none are. The response lists the new reason codes' ids in the order you sent them.

Each reason code is checked against existing reason codes and against the others in the request before anything is written.

To create a single reason code, use POST inventory/reason-codes.

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: bulkCreateReasonCodesInput.

Field Type Required Description
reasonCodes array<object> yes The reason codes to create. If any entry is invalid, nothing is created and the whole call fails. Example: [{"code":"DAMAGE","description":"Stock damaged in the warehouse","requiresApproval":true,"documentTypes":["InventoryDecrease","SalesReturn"]},{"code":"CYCLECOUNT","description":"Correction from a cycle count","documentTypes":["InventoryIncrease","InventoryDecrease"]}].
reasonCodes[].code string yes The business code of the reason code, for example 'DAMAGE'. Required. It must be unique within the tenant and within this request.
reasonCodes[].description string no A free-form description of what the reason code means. Omit for none.
reasonCodes[].isActive boolean no Whether the reason code can be selected on new documents. Defaults to true.
reasonCodes[].requiresApproval boolean no Whether documents using this reason code require approval before they take effect. Defaults to false.
reasonCodes[].documentTypes array<any> yes The document types this reason code may be selected on. Required, but may be empty. An unrecognized value fails the whole call with UNKNOWN_DOCUMENT_TYPES, which names this entry's index. 
{
  "reasonCodes": [
    {
      "code": "DAMAGE",
      "description": "Stock damaged in the warehouse",
      "requiresApproval": true,
      "documentTypes": [
        "InventoryDecrease",
        "SalesReturn"
      ]
    },
    {
      "code": "CYCLECOUNT",
      "description": "Correction from a cycle count",
      "documentTypes": [
        "InventoryIncrease",
        "InventoryDecrease"
      ]
    }
  ]
}

Response

200 Success

Under data (bulkCreateReasonCodesOutput):

Field Type Required Description
created array<object> yes The created reason codes, in the same order as the input. Match entries to inputs by index. Example: [{"id":"7a1c9e42-8b30-4d67-9f15-3c8e02a74b61"},{"id":"1f5b83d0-6c47-4a92-b8e1-0d472a95c3f6"}].
created[].id string yes The unique identifier for the created reason code. 
{
  "data": {
    "created": [
      {
        "id": "7a1c9e42-8b30-4d67-9f15-3c8e02a74b61"
      },
      {
        "id": "1f5b83d0-6c47-4a92-b8e1-0d472a95c3f6"
      }
    ]
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
DUPLICATE_CODE 400
DUPLICATE_CODE_IN_REQUEST 400
UNKNOWN_DOCUMENT_TYPES 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses