Sequential ID Service

Download OpenAPI specification:Download

Create sequentially unique IDs for orders, invoices, customers or similar.


Key Features:

  • Custom sequence pattern / schemas
  • Pre-configured patterns for orders, invoices, and customers

Key Benefits:

  • Safely create unique IDs
  • Be tax compliant with unique invoices IDs

Sequential

Retrieving all schemas

Gets all SequenceSchemas.


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Responses
200
401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

get/sequenceSchemas
Request samples
Response samples
application/json
[
  • {
    }
]

Creating a schema

Creates a new Schema.


Required scopes

  • sequentialid.schema_manage
SecurityOAuth2
Request
Request Body schema: application/json
name
required
string
schemaType
string^[a-zA-Z0-9]*$
preText
string
postText
string
startValue
required
number
maxValue
required
number
numberOfDigits
required
number
object (Placeholders)
Responses
201
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

post/sequenceSchemas
Request samples
application/json
{
  • "name": "invoiceNoSequence",
  • "schemaType": "invoiceNoSequence",
  • "preText": "INV__num__",
  • "maxValue": 999999999,
  • "numberOfDigits": 4,
  • "startValue": 1000,
  • "placeholders": {
    }
}
Response samples
application/json
"string"

Creating a nextId

Creates and returns the nextId. If sequenceKey is specified in request body, nextId number will be generated for this sequence, otherwise default pool will be used.

SecurityOAuth2
Request
path Parameters
sequenceSchema
required
string

the sequenceSchema to generate the nextId wishlist

Request Body schema: application/json
numberOfIds
number >= 1
sequenceKey
string
object
Responses
201
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

Resource does not exist.

post/sequenceSchemas/{sequenceSchema}/nextIds
Request samples
application/json
{
  • "numberOfIds": 3,
  • "sequenceKey": "2016-05",
  • "placeholders": {
    }
}
Response samples
application/json
{
  • "ids": [
    ]
}

Retrieving all schemas

Gets all SequenceSchemas.


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Request
path Parameters
tenant
required
string [ 3 .. 16 ] characters [a-zA-Z0-9_-]+

Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.

Responses
200
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

get/{tenant}/schemas
Request samples
Response samples
application/json
[
  • {
    },
  • {
    }
]

Creating a schema

Creates a new Schema.


Required scopes

  • sequentialid.schema_manage
SecurityOAuth2
Request
path Parameters
tenant
required
string [ 3 .. 16 ] characters [a-zA-Z0-9_-]+

Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.

Request Body schema: application/json
name
required
string
schemaType
string^[a-zA-Z0-9]*$
preText
string
postText
string
startValue
required
number
maxValue
required
number
numberOfDigits
required
number
object (Placeholders)
Responses
201
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

post/{tenant}/schemas
Request samples
application/json
{
  • "name": "testSchema",
  • "schemaType": "orderNoSequence",
  • "preText": "C-__year__-__month__-__abo__-",
  • "postText": "-D",
  • "maxValue": 999999999,
  • "numberOfDigits": 9,
  • "startValue": 3,
  • "placeholders": {
    }
}
Response samples
application/json
"string"

Retrieving a schema

Get schema by id.


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Request
path Parameters
schemaId
required
string

the schemaId to get

tenant
required
string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

Responses
200
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

get/{tenant}/schemas/{schemaId}
Request samples
Response samples
application/json
{
  • "name": "testSchema",
  • "schemaType": "orderNoSequence",
  • "active": true,
  • "preText": "C-__year__-__month__-__abo__-",
  • "postText": "-D",
  • "startValue": 1,
  • "maxValue": 999999999,
  • "numberOfDigits": 9,
  • "counter": 45684,
  • "placeholders": {
    }
}

Activating a schema

Set the schema as active.


Required scopes

  • sequentialid.schema_manage
SecurityOAuth2
Request
path Parameters
schemaId
required
string

the schemaId to get

tenant
required
string [ 3 .. 16 ] characters ^[a-z][a-z0-9]+$

Your Emporix tenant's name.

Note: The tenant name should always be provided in lowercase.

Responses
200

Schema set to active

400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

Resource does not exist.

post/{tenant}/schemas/{schemaId}/setActive
Request samples
Response samples
application/json
{
  • "status": 400,
  • "message": "There are validation problems, see details section for more information"
}

Retrieving all schema types

Gets all types.


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Request
path Parameters
schemaType
required
string
tenant
required
string [ 3 .. 16 ] characters [a-zA-Z0-9_-]+

Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.

Responses
200
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

get/{tenant}/schemas/types/{schemaType}
Request samples
Response samples
application/json
[
  • {
    },
  • {
    }
]

Creating a nextId for schema type

Creates and returns the nextId. If sequenceKey is specified in request body, nextId number will be generated for this sequence, otherwise default pool will be used


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Request
path Parameters
schemaType
required
string
tenant
required
string [ 3 .. 16 ] characters [a-zA-Z0-9_-]+

Stands for the "project" that requests this resource. Must match the "project" that is associated with the access token in the Authorization header.

Request Body schema: application/json
sequenceKey
string
object
Responses
201
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

404

Resource does not exist.

post/{tenant}/schemas/types/{schemaType}/nextId
Request samples
application/json
{
  • "sequenceKey": "2016-05",
  • "placeholders": {
    }
}
Response samples
application/json
{
  • "id": "B7012562"
}

Creating nextIds for schema types

Creates and returns the nextId for the specified sequenceSchemas. If sequenceKey is specified in request body, nextId number will be generated for this sequence, otherwise default pool will be used.'


Required scopes

  • sequentialid.schema_view
SecurityOAuth2
Request
Request Body schema: application/json
additional property
object
Responses
201
400

Request syntactically incorrect. Any details will be provided within the response payload.

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

403

Given authorization scopes are not sufficient and do not match required scopes.

post/sequenceSchemaBatch/nextIds
Request samples
application/json
{
  • "testSchema": {
    },
  • "testSchema2": {
    }
}
Response samples
application/json
{
  • "testSchema": {
    }
}