Skip to content
API Reference
/
/
Create SKU

Apiera REST API (1.0.0)

The Apiera REST API provides programmatic access to the Apiera platform, enabling seamless integration with your existing systems and workflows.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi/
http://localhost:5281/

Tags

Operations

Skus

Operations

List SKUs

Request

Retrieves a paginated list of SKUs with optional filtering.

Security
Bearer
Query
code[eq]string

Filter by exact code match.

code[contains]string

Filter by partial code match.

code[starts]string

Filter by code prefix.

code[ends]string

Filter by code suffix.

code[order]string

Sort order for code field. Values: asc, desc.

status[eq]string

Filter by exact status match.

Enum"draft""published""unpublished""removed"
status[order]string

Sort order for status field. Values: asc, desc.

createdAt[eq]string(date-time)

Filter by exact creation timestamp.

Example: createdAt[eq]=2025-11-23T14:15:22.123456Z
createdAt[min]string(date-time)

Filter by minimum creation timestamp.

Example: createdAt[min]=2025-11-23T14:15:22.123456Z
createdAt[max]string(date-time)

Filter by maximum creation timestamp.

Example: createdAt[max]=2025-11-23T14:15:22.123456Z
createdAt[order]string

Sort order for creation timestamp. Values: asc, desc.

updatedAt[eq]string(date-time)

Filter by exact update timestamp.

Example: updatedAt[eq]=2025-11-23T14:15:22.123456Z
updatedAt[min]string(date-time)

Filter by minimum update timestamp.

Example: updatedAt[min]=2025-11-23T14:15:22.123456Z
updatedAt[max]string(date-time)

Filter by maximum update timestamp.

Example: updatedAt[max]=2025-11-23T14:15:22.123456Z
updatedAt[order]string

Sort order for update timestamp. Values: asc, desc.

isRemoved[eq]boolean

Filter by removed status. Values: true, false.

pageinteger(int32)

Page number for pagination. Default is 1.

sizeinteger(int32)

Page size for pagination. Default is 20.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/skus?code%5Beq%5D=string&code%5Bcontains%5D=string&code%5Bstarts%5D=string&code%5Bends%5D=string&code%5Border%5D=string&status%5Beq%5D=draft&status%5Border%5D=string&createdAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&createdAt%5Border%5D=string&updatedAt%5Beq%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmin%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Bmax%5D=2025-11-23T14%3A15%3A22.123456Z&updatedAt%5Border%5D=string&isRemoved%5Beq%5D=true&page=0&size=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved paginated list of SKUs.

Bodyapplication/json
itemsArray of objects(SkuResponse)required
items[].​uuidstring(uuid)required

Unique identifier for this SKU.

items[].​createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
items[].​updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
items[].​removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
items[].​statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
items[].​codestringrequired

Unique code identifying this SKU.

paginationobject(PaginationResult)required
pagination.​pageinteger(int32)required
pagination.​sizeinteger(int32)required
pagination.​totalItemsinteger(int32)required
pagination.​totalPagesinteger(int32)required
Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "code": "SKU-LAPTOP-001"
}

Create SKU

Request

Creates a new SKU.

Security
Bearer
Bodyapplication/jsonrequired
codestring<= 55 charactersrequired

Unique code identifying the SKU.

curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/skus \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string"
  }'

Responses

SKU created successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "draft",
  "code": "SKU-LAPTOP-001"
}

Bulk create SKUs

Request

Creates multiple SKUs in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
codestring<= 55 charactersrequired

Unique code identifying the SKU.

]
curl -i -X POST \
  https://docs.apiera.io/_mock/openapi/v1/skus/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "code": "string"
    }
  ]'

Responses

SKUs created successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

]
Response
application/json
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "createdAt": "2025-11-23T14:15:22.123456Z",
    "updatedAt": "2025-11-23T14:15:22.123456Z",
    "removedAt": "2025-11-23T14:15:22.123456Z",
    "status": "draft",
    "code": "string"
  }
]

Bulk update SKUs

Request

Updates multiple SKUs in a single operation.

Security
Bearer
Bodyapplication/jsonrequiredArray [
uuidstring(uuid)required

Identifier of the SKU to update.

codestring or null<= 55 characters

Updated code for the SKU.

]
curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/skus/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "code": "string"
    }
  ]'

Responses

SKUs updated successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

]
Response
application/json
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "createdAt": "2025-11-23T14:15:22.123456Z",
    "updatedAt": "2025-11-23T14:15:22.123456Z",
    "removedAt": "2025-11-23T14:15:22.123456Z",
    "status": "draft",
    "code": "string"
  }
]

Get SKU

Request

Retrieves complete details for a single SKU.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

curl -i -X GET \
  'https://docs.apiera.io/_mock/openapi/v1/skus/{skuUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved SKU.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "code": "SKU-LAPTOP-001"
}

Update SKU

Request

Updates an existing SKU. Only provided fields are updated.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
codestring or null<= 55 characters

Updated code for the SKU.

curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/skus/{skuUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "string"
  }'

Responses

SKU updated successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "code": "SKU-LAPTOP-001-V2"
}

Delete SKU

Request

Permanently deletes a SKU. Cannot be undone.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

curl -i -X DELETE \
  'https://docs.apiera.io/_mock/openapi/v1/skus/{skuUuid}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

SKU deleted successfully.

Response
No content

Transition SKU lifecycle

Request

Transitions a SKU to a different lifecycle state. Valid transitions depend on current status.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply. Valid transitions depend on current status.

Enum"remove""restore""publish""unpublish"
curl -i -X PATCH \
  'https://docs.apiera.io/_mock/openapi/v1/skus/{skuUuid}/actions/lifecycle' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "remove"
  }'

Responses

SKU transitioned successfully.

Bodyapplication/json
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

Response
application/json
{
  "uuid": "123e4567-e89b-12d3-a456-426614174001",
  "createdAt": "2025-11-20T08:15:00.000000Z",
  "updatedAt": "2025-11-23T15:45:00.000000Z",
  "status": "published",
  "code": "SKU-LAPTOP-001"
}

Bulk transition SKU lifecycle

Request

Transitions multiple SKUs to a different lifecycle state in a single operation.

Security
Bearer
Bodyapplication/jsonrequired
transitionstringrequired

Lifecycle transition to apply to all specified SKUs.

Enum"remove""restore""publish""unpublish"
uuidsArray of strings(uuid)required

List of SKU identifiers to transition.

curl -i -X PATCH \
  https://docs.apiera.io/_mock/openapi/v1/skus/bulk/actions/lifecycle \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transition": "remove",
    "uuids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

SKUs transitioned successfully.

Bodyapplication/jsonArray [
uuidstring(uuid)required

Unique identifier for this SKU.

createdAtstring(date-time)required

Timestamp when this SKU was created.

Example: "2025-11-23T14:15:22.123456Z"
updatedAtstring(date-time)required

Timestamp when this SKU was last modified.

Example: "2025-11-23T14:15:22.123456Z"
removedAtstring or null(date-time)

Timestamp when this SKU was removed. Null if not removed.

Example: "2025-11-23T14:15:22.123456Z"
statusstringrequired

Current lifecycle status of this SKU.

Enum"draft""published""unpublished""removed"
codestringrequired

Unique code identifying this SKU.

]
Response
application/json
[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "createdAt": "2025-11-23T14:15:22.123456Z",
    "updatedAt": "2025-11-23T14:15:22.123456Z",
    "removedAt": "2025-11-23T14:15:22.123456Z",
    "status": "draft",
    "code": "string"
  }
]

Sku Dimensions

Operations

Sku Weights

Operations

Family Attributes

Operations

Family Categories

Operations

Families

Operations

Organization Members

Operations

Organizations

Operations

Organization Roles

Operations

Categories

Operations

Attributes

Operations

Attribute Terms

Operations

Assets

Operations

Asset Files

Operations

Asset Metadata

Operations
© 2025 Apiera AS