Skip to content

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
Languages
Servers
Mock server
https://docs.apiera.io/_mock/openapi/
http://localhost:5281/

Tags

Operations

Skus

Operations

Sku Dimensions

Operations

Set SKU dimensions

Request

Sets dimensions for a SKU. Values are provided in the organization's base dimension unit.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
lengthnumber(double)required

Length measurement in the organization's base dimension unit. Maximum: 99999999999999.9999.

widthnumber(double)required

Width measurement in the organization's base dimension unit. Maximum: 99999999999999.9999.

heightnumber(double)required

Height measurement in the organization's base dimension unit. Maximum: 99999999999999.9999.

curl -i -X POST \
  'https://docs.apiera.io/_mock/openapi/v1/skus/{skuUuid}/dimension' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "length": 0.1,
    "width": 0.1,
    "height": 0.1
  }'

Responses

Dimensions set successfully.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU these dimensions belong to.

unitstringrequired

Base unit of measurement for the dimension values.

Enum"millimeter""centimeter""meter""inch""foot"
lengthnumber(double)required

Length measurement in the base unit.

widthnumber(double)required

Width measurement in the base unit.

heightnumber(double)required

Height measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured dimension units. Keys are unit identifiers, values contain converted measurements.

conversions.​property name*object(DimensionValues)additional property

Dimension measurements converted to a specific unit.

Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "millimeter", "length": 350, "width": 250, "height": 25, "conversions": { "centimeter": {}, "inch": {} } }

Get SKU dimensions

Request

Retrieves dimensions for a SKU including system-calculated conversions.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

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

Responses

Successfully retrieved dimensions.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU these dimensions belong to.

unitstringrequired

Base unit of measurement for the dimension values.

Enum"millimeter""centimeter""meter""inch""foot"
lengthnumber(double)required

Length measurement in the base unit.

widthnumber(double)required

Width measurement in the base unit.

heightnumber(double)required

Height measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured dimension units. Keys are unit identifiers, values contain converted measurements.

conversions.​property name*object(DimensionValues)additional property

Dimension measurements converted to a specific unit.

Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "millimeter", "length": 350, "width": 250, "height": 25, "conversions": { "centimeter": {}, "inch": {} } }

Update SKU dimensions

Request

Updates dimensions for a SKU. Only provided fields are updated.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
lengthnumber or null(double)

Updated length measurement. Maximum: 99999999999999.9999.

widthnumber or null(double)

Updated width measurement. Maximum: 99999999999999.9999.

heightnumber or null(double)

Updated height measurement. Maximum: 99999999999999.9999.

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

Responses

Dimensions updated successfully.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU these dimensions belong to.

unitstringrequired

Base unit of measurement for the dimension values.

Enum"millimeter""centimeter""meter""inch""foot"
lengthnumber(double)required

Length measurement in the base unit.

widthnumber(double)required

Width measurement in the base unit.

heightnumber(double)required

Height measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured dimension units. Keys are unit identifiers, values contain converted measurements.

conversions.​property name*object(DimensionValues)additional property

Dimension measurements converted to a specific unit.

Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "millimeter", "length": 400, "width": 320, "height": 30, "conversions": { "centimeter": {}, "inch": {} } }

Delete SKU dimensions

Request

Removes dimensions from a SKU.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

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

Responses

Dimensions deleted successfully.

Response
No content

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