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

Sku Weights

Operations

Set SKU weight

Request

Sets weight for a SKU. Value is provided in the organization's base weight unit.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
weightnumber(double)required

Weight measurement in the organization's base weight unit. Maximum: 99999999999999.9999.

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

Responses

Weight set successfully.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU this weight belongs to.

unitstringrequired

Base unit of measurement for the weight value.

Enum"gram""kilogram""pound""ounce"
weightnumber(double)required

Weight measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured weight units. Keys are unit identifiers, values are converted weights.

conversions.​property name*number(double)additional property
Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "gram", "weight": 1850, "conversions": { "kilogram": 1.85, "ounce": 65.26, "pound": 4.08 } }

Get SKU weight

Request

Retrieves weight 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}/weight' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successfully retrieved weight.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU this weight belongs to.

unitstringrequired

Base unit of measurement for the weight value.

Enum"gram""kilogram""pound""ounce"
weightnumber(double)required

Weight measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured weight units. Keys are unit identifiers, values are converted weights.

conversions.​property name*number(double)additional property
Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "gram", "weight": 1850, "conversions": { "kilogram": 1.85, "ounce": 65.26, "pound": 4.08 } }

Update SKU weight

Request

Updates weight for a SKU.

Security
Bearer
Path
skuUuidstring(uuid)required

Unique identifier of the SKU.

Bodyapplication/jsonrequired
weightnumber or null(double)

Updated weight measurement. Maximum: 99999999999999.9999.

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

Responses

Weight updated successfully.

Bodyapplication/json
skuUuidstring(uuid)required

Identifier of the SKU this weight belongs to.

unitstringrequired

Base unit of measurement for the weight value.

Enum"gram""kilogram""pound""ounce"
weightnumber(double)required

Weight measurement in the base unit.

conversionsobjectrequired

System-calculated conversions to other configured weight units. Keys are unit identifiers, values are converted weights.

conversions.​property name*number(double)additional property
Response
application/json
{ "skuUuid": "123e4567-e89b-12d3-a456-426614174001", "unit": "gram", "weight": 2500, "conversions": { "kilogram": 2.5, "ounce": 88.18, "pound": 5.51 } }

Delete SKU weight

Request

Removes weight 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}/weight' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Weight deleted successfully.

Response
No content

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