GetCode

[POST] .../v1/item/getcode

Returns an available item code. Use this method when the client wants the server to suggest the next available item code before creating a new item. It requires a request body, checks item select permission, delegates code generation to the catalog persistent layer and returns the generated code in result. The the request supports filters, but this implementation does not use filter criteria when generating the next code. Business errors such as a missing request body, denied access or persistent code-generation errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.

Filterable Fields

Field Type Description
code int Available item code.

Request Example

{
  "filters": [
    {
      "Field": "code",
      "Operator": "Equal",
      "Value": "string"
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result ItemCodeGet Result object.

Response Example

{
  "ok": true,
  "result": {
    "filters": [
      {
        "Field": "string",
        "Operator": "Equal",
        "Value": "string"
      }
    ]
  }
}