Sequences

Create Sequence

POST

`/v1/sequences`

Creating a sequence requires two parameters: prefix and sequence, the combination of which must be unique per resource. By default, resource is set to asset.


prefix `string` (required) The prefix to prepend to each generated identifier. For example, `PX-AST-`
sequence `string` (required) The sequential counter pattern. For example, `001`
resource `string` The resource type for which this sequence is used. Defaults to `asset`

        const data = {
  prefix: "PX-AST-",
  sequence: "001",
};

const res = await fetch(`https://api.packagex.io/v1/sequences`, {
  method: "POST",
  headers: {
    "PX-API-KEY": process.env.PX_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(data),
}).then((res) => res.json());

const sequence = res.data;

A sequence cannot be updated once created. However, different sequences for the same resource can share either the prefix or the sequence value. For example, prefix PX-AST- can have sequences 001 and A01. Likewise, sequence 001 can belong to both PX-AST- and PX-UNIT-.

Creating a sequence with an existing prefix and sequence combination for the same resource will return the existing sequence with the message "Existing sequence returned".

As sequences are finite in length they may eventually be exhausted. For example, a sequence of 1 for prefix PX-AST- allows only 9 unique values before collisions occur. A sequence of 001 allows 999 values.