> For the complete documentation index, see [llms.txt](https://developer.emporix.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.emporix.io/api-references/api-guides/utilities/sequential-id/api-reference/sequential-ids-management.md).

# Sequential IDs Management

## Retrieving all sequence schemas

> Gets all sequence schemas.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_view"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"schemas":{"SequenceSchemas":{"type":"array","items":{"$ref":"#/components/schemas/SequenceSchema"}},"SequenceSchema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SequenceSchemaCreate"},{"properties":{"active":{"type":"boolean","description":"Flag indicating whether the schema is active."},"id":{"type":"string","description":"ID of the sequence schema."},"counter":{"type":"number","description":"Number of created IDs based on the selected schema."},"metadata":{"type":"object","properties":{"createdAt":{"type":"string","format":"date","description":"Date of creation."},"modifiedAt":{"type":"string","format":"date","description":"Date of last modification."},"version":{"type":"number","description":"The version number."}}}}}]},"SequenceSchemaCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence schema."},"schemaType":{"type":"string","pattern":"^[a-zA-Z0-9]*$","description":"The schema type corresponding to the entity it is used for. Possible values are:\n- `orderNoSequence`\n- `invoiceNoSequence`\n- `quoteNoSequence`\n- `pickPackNoSequence`\n- `orderHoldingAreaNoSequence`\n"},"preText":{"type":"string","description":"The prefix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"postText":{"type":"string","description":"The suffix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"startValue":{"type":"number","description":"The starting value of the sequence. It is used to generate the first ID.\nThe starting value is incremented for each subsequent ID.\n"},"maxValue":{"type":"number","description":"The maximum value of the sequence. It is used to limit the range of generated IDs.\nIf the maximum value is reached, the sequence will not generate any more IDs.\n"},"numberOfDigits":{"type":"number","description":"The number of digits in the generated ID. It is used to format the ID.\nIf the number of digits is less than the maximum value, leading zeros are added.\n"},"placeholders":{"$ref":"#/components/schemas/Placeholders"}},"required":["name","startValue","maxValue","numberOfDigits"]},"Placeholders":{"type":"object","description":"Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.","additionalProperties":{"type":"object","description":"Properties used as placeholders.","properties":{"required":{"type":"boolean","description":"Flag indicating whether the placeholder must be resolved when generating an ID."},"default":{"type":"string","description":"Replacement used when the placeholder is not set in the request. Used only when `required` is `false`."},"sitePath":{"type":"string","description":"Dotted path into the site or site mixins response. Resolved when `siteCode` is provided."},"arrayLimit":{"type":"integer","minimum":1,"description":"Maximum array elements to include. Defaults to `3`. Ignored for scalars."},"delimiter":{"type":"string","description":"Separator for joined array elements. Defaults to `-`. Ignored for scalars."}},"required":["required"]}},"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/sequential-id/{tenant}/schemas":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceSchemas"}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"}},"summary":"Retrieving all sequence schemas","description":"Gets all sequence schemas.","operationId":"GET-sequential-id-retrieve-tenant-schemas","tags":["Sequential IDs management"]}}}}
```

## Creating a sequence schema

> Creates a new sequence schema.\
> \
> Placeholder names must start and end with \`\_\_\`, for example \`\_\_year\_\_\` or \`\_\_region\_\_\`.\
> \
> Built-in placeholders that Sequential ID can resolve  when \`siteCode\` is provided:\
> \* \`\_\_year\_\_\`, \`\_\_month\_\_\`, \`\_\_day\_\_\`, \`\_\_hour\_\_\`, \`\_\_minute\_\_\`, \`\_\_second\_\_\` — based on \`homeBase.timezone\`. Default timezone is \`UTC\`.\
> \* \`\_\_country\_\_\` — based on \`homeBase.address.country\`. Default country is \`DE\`.\
> \
> Custom placeholders must declare \`sitePath\`.\
> Paths that start with \`mixins.\` are resolved from \[Retrieving site mixins]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins>) and are format-validated only at creation.\
> Other paths are resolved from \[Retrieving a site]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode>) and must match the Site schema, for example \`homeBase.address.country\`. Paths that target \`metadata\` or the bare \`mixins\` root are rejected.\
> \
> For array values, \`arrayLimit\` (default \`3\`) and \`delimiter\` (default \`-\`) control how elements are joined. Both are ignored for scalar values. Resolved values longer than 100 characters are truncated.\
> To access array elements, use the \`sitePath\` with the index, for example \`mixins.customConfig.regions.2\` or \`mixins.customConfig.regions.2.name\`. Array index starts at \`0\`.\
> Omit the array index to access all elements, which will then be joined with the \`delimiter\` and limited to \`arrayLimit\` elements. Joining of object array elements is not supported.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"SequenceSchemaCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence schema."},"schemaType":{"type":"string","pattern":"^[a-zA-Z0-9]*$","description":"The schema type corresponding to the entity it is used for. Possible values are:\n- `orderNoSequence`\n- `invoiceNoSequence`\n- `quoteNoSequence`\n- `pickPackNoSequence`\n- `orderHoldingAreaNoSequence`\n"},"preText":{"type":"string","description":"The prefix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"postText":{"type":"string","description":"The suffix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"startValue":{"type":"number","description":"The starting value of the sequence. It is used to generate the first ID.\nThe starting value is incremented for each subsequent ID.\n"},"maxValue":{"type":"number","description":"The maximum value of the sequence. It is used to limit the range of generated IDs.\nIf the maximum value is reached, the sequence will not generate any more IDs.\n"},"numberOfDigits":{"type":"number","description":"The number of digits in the generated ID. It is used to format the ID.\nIf the number of digits is less than the maximum value, leading zeros are added.\n"},"placeholders":{"$ref":"#/components/schemas/Placeholders"}},"required":["name","startValue","maxValue","numberOfDigits"]},"Placeholders":{"type":"object","description":"Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.","additionalProperties":{"type":"object","description":"Properties used as placeholders.","properties":{"required":{"type":"boolean","description":"Flag indicating whether the placeholder must be resolved when generating an ID."},"default":{"type":"string","description":"Replacement used when the placeholder is not set in the request. Used only when `required` is `false`."},"sitePath":{"type":"string","description":"Dotted path into the site or site mixins response. Resolved when `siteCode` is provided."},"arrayLimit":{"type":"integer","minimum":1,"description":"Maximum array elements to include. Defaults to `3`. Ignored for scalars."},"delimiter":{"type":"string","description":"Separator for joined array elements. Defaults to `-`. Ignored for scalars."}},"required":["required"]}}}},"paths":{"/sequential-id/{tenant}/schemas":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"type":"string","description":"ID of the created sequence schema."}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"}},"summary":"Creating a sequence schema","description":"Creates a new sequence schema.\n\nPlaceholder names must start and end with `__`, for example `__year__` or `__region__`.\n\nBuilt-in placeholders that Sequential ID can resolve  when `siteCode` is provided:\n* `__year__`, `__month__`, `__day__`, `__hour__`, `__minute__`, `__second__` — based on `homeBase.timezone`. Default timezone is `UTC`.\n* `__country__` — based on `homeBase.address.country`. Default country is `DE`.\n\nCustom placeholders must declare `sitePath`.\nPaths that start with `mixins.` are resolved from [Retrieving site mixins](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins) and are format-validated only at creation.\nOther paths are resolved from [Retrieving a site](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode) and must match the Site schema, for example `homeBase.address.country`. Paths that target `metadata` or the bare `mixins` root are rejected.\n\nFor array values, `arrayLimit` (default `3`) and `delimiter` (default `-`) control how elements are joined. Both are ignored for scalar values. Resolved values longer than 100 characters are truncated.\nTo access array elements, use the `sitePath` with the index, for example `mixins.customConfig.regions.2` or `mixins.customConfig.regions.2.name`. Array index starts at `0`.\nOmit the array index to access all elements, which will then be joined with the `delimiter` and limited to `arrayLimit` elements. Joining of object array elements is not supported.","operationId":"POST-sequential-id-create-tenant-schema","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceSchemaCreate"}}},"required":true},"tags":["Sequential IDs management"]}}}}
```

## Retrieving a sequence schema

> Gets a sequence schema by its ID.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_view"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"schemas":{"SequenceSchema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SequenceSchemaCreate"},{"properties":{"active":{"type":"boolean","description":"Flag indicating whether the schema is active."},"id":{"type":"string","description":"ID of the sequence schema."},"counter":{"type":"number","description":"Number of created IDs based on the selected schema."},"metadata":{"type":"object","properties":{"createdAt":{"type":"string","format":"date","description":"Date of creation."},"modifiedAt":{"type":"string","format":"date","description":"Date of last modification."},"version":{"type":"number","description":"The version number."}}}}}]},"SequenceSchemaCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence schema."},"schemaType":{"type":"string","pattern":"^[a-zA-Z0-9]*$","description":"The schema type corresponding to the entity it is used for. Possible values are:\n- `orderNoSequence`\n- `invoiceNoSequence`\n- `quoteNoSequence`\n- `pickPackNoSequence`\n- `orderHoldingAreaNoSequence`\n"},"preText":{"type":"string","description":"The prefix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"postText":{"type":"string","description":"The suffix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"startValue":{"type":"number","description":"The starting value of the sequence. It is used to generate the first ID.\nThe starting value is incremented for each subsequent ID.\n"},"maxValue":{"type":"number","description":"The maximum value of the sequence. It is used to limit the range of generated IDs.\nIf the maximum value is reached, the sequence will not generate any more IDs.\n"},"numberOfDigits":{"type":"number","description":"The number of digits in the generated ID. It is used to format the ID.\nIf the number of digits is less than the maximum value, leading zeros are added.\n"},"placeholders":{"$ref":"#/components/schemas/Placeholders"}},"required":["name","startValue","maxValue","numberOfDigits"]},"Placeholders":{"type":"object","description":"Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.","additionalProperties":{"type":"object","description":"Properties used as placeholders.","properties":{"required":{"type":"boolean","description":"Flag indicating whether the placeholder must be resolved when generating an ID."},"default":{"type":"string","description":"Replacement used when the placeholder is not set in the request. Used only when `required` is `false`."},"sitePath":{"type":"string","description":"Dotted path into the site or site mixins response. Resolved when `siteCode` is provided."},"arrayLimit":{"type":"integer","minimum":1,"description":"Maximum array elements to include. Defaults to `3`. Ignored for scalars."},"delimiter":{"type":"string","description":"Separator for joined array elements. Defaults to `-`. Ignored for scalars."}},"required":["required"]}},"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"parameters":{"trait_tenant":{"name":"tenant","in":"path","required":true,"description":"The name of your tenant.\n\n**Note**: The tenant name should always be provided in lowercase.\n","schema":{"pattern":"^[a-z][a-z0-9]+$","minLength":3,"maxLength":16,"type":"string"}}}},"paths":{"/sequential-id/{tenant}/schemas/{schemaId}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceSchema"}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"}},"summary":"Retrieving a sequence schema","description":"Gets a sequence schema by its ID.","operationId":"GET-sequential-id-retrieve-schema","parameters":[{"$ref":"#/components/parameters/trait_tenant"}],"tags":["Sequential IDs management"]}}}}
```

## Deleting a sequence schema

> Deletes a sequence schema by its ID.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"responses":{"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"common_response_InternalServerError_500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/coreError"}}}}},"schemas":{"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"coreError":{"type":"object","properties":{"status":{"type":"string","description":"HTTP Status."},"message":{"type":"string","description":"Error message."}}}},"parameters":{"trait_tenant":{"name":"tenant","in":"path","required":true,"description":"The name of your tenant.\n\n**Note**: The tenant name should always be provided in lowercase.\n","schema":{"pattern":"^[a-z][a-z0-9]+$","minLength":3,"maxLength":16,"type":"string"}}}},"paths":{"/sequential-id/{tenant}/schemas/{schemaId}":{"delete":{"responses":{"204":{"description":"Successful schema removal"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"},"500":{"$ref":"#/components/responses/common_response_InternalServerError_500"}},"summary":"Deleting a sequence schema","description":"Deletes a sequence schema by its ID.","operationId":"DELETE-sequential-id-remove-schema","parameters":[{"$ref":"#/components/parameters/trait_tenant"}],"tags":["Sequential IDs management"]}}}}
```

## Activating a sequence schema

> Sets the schema as active in the system.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_manage"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"trait_yaasAware_404":{"description":"Resource does not exist.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}}},"parameters":{"trait_tenant":{"name":"tenant","in":"path","required":true,"description":"The name of your tenant.\n\n**Note**: The tenant name should always be provided in lowercase.\n","schema":{"pattern":"^[a-z][a-z0-9]+$","minLength":3,"maxLength":16,"type":"string"}}}},"paths":{"/sequential-id/{tenant}/schemas/{schemaId}/setActive":{"post":{"responses":{"200":{"description":"Schema set to active"},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"},"404":{"$ref":"#/components/responses/trait_yaasAware_404"}},"summary":"Activating a sequence schema","description":"Sets the schema as active in the system.","operationId":"POST-sequential-id-activate-schema","parameters":[{"$ref":"#/components/parameters/trait_tenant"}],"tags":["Sequential IDs management"]}}}}
```

## Retrieving all sequence schema types

> Gets all sequence schemas.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_view"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"schemas":{"SequenceSchemas":{"type":"array","items":{"$ref":"#/components/schemas/SequenceSchema"}},"SequenceSchema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SequenceSchemaCreate"},{"properties":{"active":{"type":"boolean","description":"Flag indicating whether the schema is active."},"id":{"type":"string","description":"ID of the sequence schema."},"counter":{"type":"number","description":"Number of created IDs based on the selected schema."},"metadata":{"type":"object","properties":{"createdAt":{"type":"string","format":"date","description":"Date of creation."},"modifiedAt":{"type":"string","format":"date","description":"Date of last modification."},"version":{"type":"number","description":"The version number."}}}}}]},"SequenceSchemaCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the sequence schema."},"schemaType":{"type":"string","pattern":"^[a-zA-Z0-9]*$","description":"The schema type corresponding to the entity it is used for. Possible values are:\n- `orderNoSequence`\n- `invoiceNoSequence`\n- `quoteNoSequence`\n- `pickPackNoSequence`\n- `orderHoldingAreaNoSequence`\n"},"preText":{"type":"string","description":"The prefix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"postText":{"type":"string","description":"The suffix of the ID. It can contain placeholders, which are replaced with their values.\nPlaceholders are defined in the `placeholders` property.\n"},"startValue":{"type":"number","description":"The starting value of the sequence. It is used to generate the first ID.\nThe starting value is incremented for each subsequent ID.\n"},"maxValue":{"type":"number","description":"The maximum value of the sequence. It is used to limit the range of generated IDs.\nIf the maximum value is reached, the sequence will not generate any more IDs.\n"},"numberOfDigits":{"type":"number","description":"The number of digits in the generated ID. It is used to format the ID.\nIf the number of digits is less than the maximum value, leading zeros are added.\n"},"placeholders":{"$ref":"#/components/schemas/Placeholders"}},"required":["name","startValue","maxValue","numberOfDigits"]},"Placeholders":{"type":"object","description":"Placeholder definitions used in `preText` and `postText`. Names must start and end with `__`.","additionalProperties":{"type":"object","description":"Properties used as placeholders.","properties":{"required":{"type":"boolean","description":"Flag indicating whether the placeholder must be resolved when generating an ID."},"default":{"type":"string","description":"Replacement used when the placeholder is not set in the request. Used only when `required` is `false`."},"sitePath":{"type":"string","description":"Dotted path into the site or site mixins response. Resolved when `siteCode` is provided."},"arrayLimit":{"type":"integer","minimum":1,"description":"Maximum array elements to include. Defaults to `3`. Ignored for scalars."},"delimiter":{"type":"string","description":"Separator for joined array elements. Defaults to `-`. Ignored for scalars."}},"required":["required"]}},"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/sequential-id/{tenant}/schemas/types/{schemaType}":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SequenceSchemas"}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"}},"summary":"Retrieving all sequence schema types","description":"Gets all sequence schemas.","operationId":"GET-sequential-id-retrieve-schema-types","tags":["Sequential IDs management"]}}}}
```

## Creating a nextId for a sequence schema type

> Creates and returns the \`nextId\` according to the specified sequence.\
> If you specify the \`sequenceKey\` in request body, the \`nextId\` number is generated for this sequence, otherwise default pool is used.\
> \
> When \`siteCode\` is provided and a placeholder value is missing from the request body, Sequential ID resolves it from site data:\
> \* Built-in placeholders \`\_\_year\_\_\`, \`\_\_month\_\_\`, \`\_\_day\_\_\`, \`\_\_hour\_\_\`, \`\_\_minute\_\_\`, \`\_\_second\_\_\` use \`homeBase.timezone\`. Default timezone is \`UTC\`.\
> \* Built-in \`\_\_country\_\_\` uses \`homeBase.address.country\` from site data.\
> \* Custom placeholders with \`sitePath\` are resolved from \[Retrieving a site]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode>), or from \[Retrieving site mixins]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins>) when the path starts with \`mixins.\`.\
> \
> Values supplied in the request body take precedence over site resolution.\
> Arrays of scalars are joined using \`delimiter\` (default \`-\`), limited to \`arrayLimit\` elements (default \`3\`).\
> Paths that resolve to an object, an empty array, or a missing value do not populate the placeholder. Required placeholders then fail with \`400 Bad Request\`.\
> \`siteCode\` is required when a required \`sitePath\` placeholder is not supplied in the request body.\
> Placeholders that resolve to a value longer than 100 characters are truncated.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_view"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"schemas":{"NextIdResponse":{"type":"object","properties":{"id":{"type":"string","description":"The created nextID according to the selected schema."}}},"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"NextIdCommandRequest":{"type":"object","properties":{"sequenceKey":{"type":"string","description":"The pattern to follow for the nextID."},"placeholders":{"additionalProperties":{"type":"string","description":"Additional property used as a placeholder."},"description":"The filler text for values based on certain properties or settings in the system."}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"trait_yaasAware_404":{"description":"Resource does not exist.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}}},"paths":{"/sequential-id/{tenant}/schemas/types/{schemaType}/nextId":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextIdResponse"}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"},"404":{"$ref":"#/components/responses/trait_yaasAware_404"}},"summary":"Creating a nextId for a sequence schema type","description":"Creates and returns the `nextId` according to the specified sequence.\nIf you specify the `sequenceKey` in request body, the `nextId` number is generated for this sequence, otherwise default pool is used.\n\nWhen `siteCode` is provided and a placeholder value is missing from the request body, Sequential ID resolves it from site data:\n* Built-in placeholders `__year__`, `__month__`, `__day__`, `__hour__`, `__minute__`, `__second__` use `homeBase.timezone`. Default timezone is `UTC`.\n* Built-in `__country__` uses `homeBase.address.country` from site data.\n* Custom placeholders with `sitePath` are resolved from [Retrieving a site](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode), or from [Retrieving site mixins](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins) when the path starts with `mixins.`.\n\nValues supplied in the request body take precedence over site resolution.\nArrays of scalars are joined using `delimiter` (default `-`), limited to `arrayLimit` elements (default `3`).\nPaths that resolve to an object, an empty array, or a missing value do not populate the placeholder. Required placeholders then fail with `400 Bad Request`.\n`siteCode` is required when a required `sitePath` placeholder is not supplied in the request body.\nPlaceholders that resolve to a value longer than 100 characters are truncated.","operationId":"POST-sequential-id-create-schema-type-nextId","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextIdCommandRequest"}}},"required":true},"tags":["Sequential IDs management"]}}}}
```

## Creating nextIds for sequence schema types

> Creates and returns multiple \`nextIds\` for the specified sequence schemas.\
> If you specify the \`sequenceKey\` in request body, the \`nextIds\` numbers are generated for this sequence, otherwise default pool is used.\
> \
> When \`siteCode\` is provided and a placeholder value is missing from the request body, Sequential ID resolves it from site data:\
> \* Built-in placeholders \`\_\_year\_\_\`, \`\_\_month\_\_\`, \`\_\_day\_\_\`, \`\_\_hour\_\_\`, \`\_\_minute\_\_\`, \`\_\_second\_\_\` use \`homeBase.timezone\`. Default timezone is \`UTC\`.\
> \* Built-in \`\_\_country\_\_\` uses \`homeBase.address.country\` from site data.\
> \* Custom placeholders with \`sitePath\` are resolved from \[Retrieving a site]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode>), or from \[Retrieving site mixins]\(<https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins>) when the path starts with \`mixins.\`.\
> \
> Values supplied in the request body take precedence over site resolution.\
> Arrays of scalars are joined using \`delimiter\` (default \`-\`), limited to \`arrayLimit\` elements (default \`3\`).\
> Paths that resolve to an object, an empty array, or a missing value do not populate the placeholder. Required placeholders then fail with \`400 Bad Request\`.\
> \`siteCode\` is required when a required \`sitePath\` placeholder is not supplied in the request body.\
> Placeholders that resolve to a value longer than 100 characters are truncated.

```json
{"openapi":"3.0.0","info":{"title":"Sequential ID Service","version":"0.0.1"},"tags":[{"name":"Sequential IDs management"}],"servers":[{"url":"https://api.emporix.io"}],"security":[{"OAuth2":["sequentialid.schema_view"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.emporix.io/oauth/token","scopes":{"sequentialid.schema_view":"schema_view","sequentialid.schema_manage":"schema_manage"}}}}},"schemas":{"SchemaBatchNextIdResponse":{"type":"object","additionalProperties":{"type":"object","description":"Properties used as placeholders.","properties":{"ids":{"type":"array","items":{"type":"string"},"description":"The sequence ID(s) created according to the selected schema."}}}},"error":{"description":"Schema for API specified errors.","type":"object","properties":{"status":{"minimum":100,"maximum":599,"description":"original HTTP error code, should be consistent with the response HTTP code","type":"integer"},"type":{"pattern":"[a-z]+[a-z_]*[a-z]+","description":"classification of the error type, lower case with underscore eg validation_failure","type":"string"},"message":{"description":"descriptive error message for debugging","type":"string"},"error":{"type":"string"},"timestamp":{"type":"string","format":"date"},"errorDetails":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"field":{"type":"string"}}}}}},"SchemaBatchNextIdRequest":{"type":"object","additionalProperties":{"type":"object","properties":{"numberOfIds":{"type":"number","minimum":1,"description":"The number of IDs to create sequentially in one request."},"sequenceKey":{"type":"string","description":"The pattern to follow for the nextID."},"placeholders":{"additionalProperties":{"type":"string","description":"Additional property used as a placeholder."},"description":"The filler text for values based on certain properties or settings in the system."}}}}},"responses":{"trait_yaasAware_400":{"description":"Request syntactically incorrect. Details of the error are included in the response payload.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}},"Unauthorized_401":{"description":"Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.","content":{"application/json":{"schema":{"type":"object","properties":{"fault":{"type":"object","properties":{"faultstring":{"type":"string"},"detail":{"type":"object","properties":{"errorcode":{"type":"string"}}}}}}}}}},"trait_yaasAware_403":{"description":"Given authorization scopes are not sufficient and do not match required scopes.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"parameters":{"trait_siteCode":{"name":"siteCode","in":"query","required":false,"description":"Site code used to resolve placeholders from [Retrieving a site](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode) and [Retrieving site mixins](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins).\n\nPlaceholders such as **\\_\\_year__**, **\\_\\_month__**, **\\_\\_day__**, **\\_\\_hour__**, **\\_\\_minute__**, **\\_\\_second__**, and **\\_\\_country__**, \nwhich are defined in the schema, can have default values computed when their counterparts are missing in the request body.\n\nThe default values are derived from the `site`. Specifically:\n- All date-related placeholders are computed based on the `site.homeBase.timezone` field.\n- The **__country__** placeholder is replaced with the value of `site.homeBase.address.country`.\n\nIf these values are missing in `site`, the following defaults are used:\n- `UTC` for `timezone`\n- `DE` for `country`\n","schema":{"type":"string"}}}},"paths":{"/sequential-id/sequenceSchemaBatch/nextIds":{"post":{"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaBatchNextIdResponse"}}}},"400":{"$ref":"#/components/responses/trait_yaasAware_400"},"401":{"$ref":"#/components/responses/Unauthorized_401"},"403":{"$ref":"#/components/responses/trait_yaasAware_403"}},"summary":"Creating nextIds for sequence schema types","description":"Creates and returns multiple `nextIds` for the specified sequence schemas.\nIf you specify the `sequenceKey` in request body, the `nextIds` numbers are generated for this sequence, otherwise default pool is used.\n\nWhen `siteCode` is provided and a placeholder value is missing from the request body, Sequential ID resolves it from site data:\n* Built-in placeholders `__year__`, `__month__`, `__day__`, `__hour__`, `__minute__`, `__second__` use `homeBase.timezone`. Default timezone is `UTC`.\n* Built-in `__country__` uses `homeBase.address.country` from site data.\n* Custom placeholders with `sitePath` are resolved from [Retrieving a site](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/site-settings#get-site-tenant-sites-sitecode), or from [Retrieving site mixins](https://developer.emporix.io/api-references/api-guides/configuration/site-settings-service/api-reference/mixins#get-site-tenant-sites-sitecode-mixins) when the path starts with `mixins.`.\n\nValues supplied in the request body take precedence over site resolution.\nArrays of scalars are joined using `delimiter` (default `-`), limited to `arrayLimit` elements (default `3`).\nPaths that resolve to an object, an empty array, or a missing value do not populate the placeholder. Required placeholders then fail with `400 Bad Request`.\n`siteCode` is required when a required `sitePath` placeholder is not supplied in the request body.\nPlaceholders that resolve to a value longer than 100 characters are truncated.","parameters":[{"$ref":"#/components/parameters/trait_siteCode"}],"operationId":"POST-sequential-id-create-schema-types-nextIds","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaBatchNextIdRequest"}}},"required":true},"tags":["Sequential IDs management"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.emporix.io/api-references/api-guides/utilities/sequential-id/api-reference/sequential-ids-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.