Product types API

Product types and reusable attributes such as colour, size and material.

Module code attributes · 14 actions · 8 data models · 10 events. A key or token never does more here than the person behind it can; row-level security applies exactly as in the app. Scopes: attributes (everything), attributes:read (read only) or attributes:<capability>.

Resources

Lists take limit (up to 200), cursor, order (e.g. -created_at), fields and q; every other query parameter is a column filter: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

Actions

attributes.assign_attributes

Add attributes to a type — At product level, or at variant level — optionally driving the variant picker.

Needs attributes:manage · changes data

• Canonical address: POST /api/v1/actions/attributes.assign_attributes

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.type_attributes_changed, attributes.variant_axes_synced

What it writes: attribute_item_option (upsert) — Maps a picker attribute onto the catalogue axis (item.md §9b); product_type_attribute (insert) — Assigns the attributes

curl -X POST https://app.getera.io/api/v1/attribute_item_options/actions/assign_attributes \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"productTypeId":"PRODUCT_TYPE_ID","attributeIds":{},"level":"product"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.type_attributes_changed",
    "attributes.variant_axes_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeItemOptions.assignAttributes({
  productTypeId: "PRODUCT_TYPE_ID",
  attributeIds: {},
  level: "product"
})

era attribute_item_options assign_attributes --data '{"productTypeId":"PRODUCT_TYPE_ID","attributeIds":{},"level":"product"}'

{
  "name": "era__attributes__assign_attributes",
  "arguments": {
    "productTypeId": "PRODUCT_TYPE_ID",
    "attributeIds": {},
    "level": "product"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, attribute_already_assigned, variant_only_attribute, variant_selection_not_allowed · 429 slow down

attributes.delete_attribute

Delete an attribute — Its choices, its assignments and every product’s value for it go with it.

Needs attributes:delete · removes or cannot be undone · asks a person to confirm when Era runs it

• REST alias: DELETE /api/v1/attributes/{id}
• Canonical address: POST /api/v1/actions/attributes.delete_attribute

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.attribute_deleted

What it writes: attribute (delete) — Removes it; the FKs remove what hangs off it

curl -X POST https://app.getera.io/api/v1/attributes/ATTRIBUTE_ID/actions/delete_attribute \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.attribute_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributes.deleteAttribute("ATTRIBUTE_ID")

era attributes delete_attribute ATTRIBUTE_ID

{
  "name": "era__attributes__delete_attribute",
  "arguments": {
    "id": "ATTRIBUTE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found · 429 slow down

attributes.delete_attribute_value

Remove a choice — Products that had it chosen lose that value.

Needs attributes:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• REST alias: DELETE /api/v1/attribute_values/{id}
• Canonical address: POST /api/v1/actions/attributes.delete_attribute_value

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.attribute_values_changed

What it writes: attribute_value (delete) — Removes the choice

curl -X POST https://app.getera.io/api/v1/attribute_values/ATTRIBUTE_VALUE_ID/actions/delete_attribute_value \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.attribute_values_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeValues.deleteAttributeValue("ATTRIBUTE_VALUE_ID")

era attribute_values delete_attribute_value ATTRIBUTE_VALUE_ID

{
  "name": "era__attributes__delete_attribute_value",
  "arguments": {
    "id": "ATTRIBUTE_VALUE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found · 429 slow down

attributes.delete_product_type

Delete a product type — Only while no item is of the type. Saleor would delete the products too; this refuses.

Needs attributes:delete · removes or cannot be undone · asks a person to confirm when Era runs it

• REST alias: DELETE /api/v1/product_types/{id}
• Canonical address: POST /api/v1/actions/attributes.delete_product_type

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.product_type_deleted

What it writes: product_type (delete) — Removes the type and its assignments

curl -X POST https://app.getera.io/api/v1/product_types/PRODUCT_TYPE_ID/actions/delete_product_type \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.product_type_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productTypes.deleteProductType("PRODUCT_TYPE_ID")

era product_types delete_product_type PRODUCT_TYPE_ID

{
  "name": "era__attributes__delete_product_type",
  "arguments": {
    "id": "PRODUCT_TYPE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:delete · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, product_type_in_use · 429 slow down

attributes.reorder_attribute_values

Reorder choices — The order a picker lists them in.

Needs attributes:manage · changes data

• Canonical address: POST /api/v1/actions/attributes.reorder_attribute_values

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.attribute_values_changed

What it writes: attribute_value (update) — Rewrites sort_order

curl -X POST https://app.getera.io/api/v1/attribute_values/actions/reorder_attribute_values \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"attributeId":"ATTRIBUTE_ID","valueIds":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.attribute_values_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeValues.reorderAttributeValues({
  attributeId: "ATTRIBUTE_ID",
  valueIds: {}
})

era attribute_values reorder_attribute_values --data '{"attributeId":"ATTRIBUTE_ID","valueIds":{}}'

{
  "name": "era__attributes__reorder_attribute_values",
  "arguments": {
    "attributeId": "ATTRIBUTE_ID",
    "valueIds": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, value_not_of_attribute · 429 slow down

attributes.reorder_type_attributes

Reorder a type’s attributes — The order the product and variant forms show them in.

Needs attributes:manage · changes data

• Canonical address: POST /api/v1/actions/attributes.reorder_type_attributes

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.type_attributes_changed

What it writes: product_type_attribute (update) — Rewrites sort_order

curl -X POST https://app.getera.io/api/v1/product_type_attributes/actions/reorder_type_attributes \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"productTypeId":"PRODUCT_TYPE_ID","level":"product","attributeIds":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.type_attributes_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productTypeAttributes.reorderTypeAttributes({
  productTypeId: "PRODUCT_TYPE_ID",
  level: "product",
  attributeIds: {}
})

era product_type_attributes reorder_type_attributes --data '{"productTypeId":"PRODUCT_TYPE_ID","level":"product","attributeIds":{}}'

{
  "name": "era__attributes__reorder_type_attributes",
  "arguments": {
    "productTypeId": "PRODUCT_TYPE_ID",
    "level": "product",
    "attributeIds": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, attribute_not_on_type · 429 slow down

attributes.save_attribute

Save an attribute — A reusable property — colour, size, material — and how it is entered and shown.

Needs attributes:manage · changes data

• REST alias: PATCH /api/v1/attributes/{id}
• Canonical address: POST /api/v1/actions/attributes.save_attribute

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.attribute_saved

What it writes: attribute (upsert) — Creates or edits the attribute; attribute_value (insert) — Writes the first choices on create

curl -X POST https://app.getera.io/api/v1/attributes/ATTRIBUTE_ID/actions/save_attribute \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.attribute_saved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributes.saveAttribute("ATTRIBUTE_ID", {
  name: "Name"
})

era attributes save_attribute ATTRIBUTE_ID \
  --name "Name"

{
  "name": "era__attributes__save_attribute",
  "arguments": {
    "id": "ATTRIBUTE_ID",
    "name": "Name"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 invalid_name, not_found, input_type_locked, slug_taken, entity_type_required, entity_type_not_allowed, unit_not_allowed, property_not_allowed, attribute_has_no_choices, value_name_taken · 429 slow down

attributes.save_attribute_value

Save a choice — One option of a dropdown, multi select or swatch.

Needs attributes:manage · changes data

• REST alias: PATCH /api/v1/attribute_values/{id}
• Canonical address: POST /api/v1/actions/attributes.save_attribute_value

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.attribute_values_changed, attributes.variant_axes_synced

What it writes: attribute_item_option (upsert) — Maps a picker attribute onto the catalogue axis (item.md §9b); attribute_value (upsert) — Creates or edits the choice

curl -X POST https://app.getera.io/api/v1/attribute_values/ATTRIBUTE_VALUE_ID/actions/save_attribute_value \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"attributeId":"ATTRIBUTE_ID","name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.attribute_values_changed",
    "attributes.variant_axes_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeValues.saveAttributeValue("ATTRIBUTE_VALUE_ID", {
  attributeId: "ATTRIBUTE_ID",
  name: "Name"
})

era attribute_values save_attribute_value ATTRIBUTE_VALUE_ID \
  --attribute-id "ATTRIBUTE_ID" \
  --name "Name"

{
  "name": "era__attributes__save_attribute_value",
  "arguments": {
    "id": "ATTRIBUTE_VALUE_ID",
    "attributeId": "ATTRIBUTE_ID",
    "name": "Name"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, attribute_has_no_choices, invalid_name, swatch_only_field, invalid_swatch, value_name_taken · 429 slow down

attributes.save_product_type

Save a product type — A kind of product, and the attribute set its products carry.

Needs attributes:manage · changes data

• REST alias: PATCH /api/v1/product_types/{id}
• Canonical address: POST /api/v1/actions/attributes.save_product_type

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.product_type_saved

What it writes: product_type (upsert) — Creates or edits the type

curl -X POST https://app.getera.io/api/v1/product_types/PRODUCT_TYPE_ID/actions/save_product_type \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name":"Name"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.product_type_saved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productTypes.saveProductType("PRODUCT_TYPE_ID", {
  name: "Name"
})

era product_types save_product_type PRODUCT_TYPE_ID \
  --name "Name"

{
  "name": "era__attributes__save_product_type",
  "arguments": {
    "id": "PRODUCT_TYPE_ID",
    "name": "Name"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 invalid_name, slug_taken, not_found, product_type_in_use · 429 slow down

attributes.set_item_attributes

Fill in an item’s attributes — The product-level values — material, brand line, care instructions.

Needs attributes:write · changes data

• Canonical address: POST /api/v1/actions/attributes.set_item_attributes

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.item_attributes_changed

What it writes: item_attribute_value (upsert) — Replaces the values of each attribute sent

curl -X POST https://app.getera.io/api/v1/product_attribute_values/actions/set_item_attributes \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"itemId":"ITEM_ID","values":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.item_attributes_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productAttributeValues.setItemAttributes({
  itemId: "ITEM_ID",
  values: {}
})

era product_attribute_values set_item_attributes --data '{"itemId":"ITEM_ID","values":{}}'

{
  "name": "era__attributes__set_item_attributes",
  "arguments": {
    "itemId": "ITEM_ID",
    "values": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 item_not_found, item_has_no_type, attribute_not_on_type, attribute_value_invalid, attribute_value_required · 429 slow down

attributes.set_item_type

Give an item its product type — Chosen once, as in Saleor — it decides which attributes the item carries.

Needs attributes:write · changes data

• Canonical address: POST /api/v1/actions/attributes.set_item_type

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.item_type_set, attributes.variant_axes_synced

What it writes: attribute_item_option (upsert) — Maps a picker attribute onto the catalogue axis (item.md §9b); item_product_type (insert) — Records the item’s type

curl -X POST https://app.getera.io/api/v1/attribute_item_options/actions/set_item_type \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"itemId":"ITEM_ID","productTypeId":"PRODUCT_TYPE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.item_type_set",
    "attributes.variant_axes_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeItemOptions.setItemType({
  itemId: "ITEM_ID",
  productTypeId: "PRODUCT_TYPE_ID"
})

era attribute_item_options set_item_type \
  --item-id "ITEM_ID" \
  --product-type-id "PRODUCT_TYPE_ID"

{
  "name": "era__attributes__set_item_type",
  "arguments": {
    "itemId": "ITEM_ID",
    "productTypeId": "PRODUCT_TYPE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 item_not_found, not_found, item_type_locked, type_does_not_fit_item · 429 slow down

attributes.set_variant_attributes

Fill in a variant’s attributes — The variant-level values — size, colour — including the ones that drive the picker.

Needs attributes:write · changes data

• Canonical address: POST /api/v1/actions/attributes.set_variant_attributes

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.variant_attributes_changed, attributes.variant_axes_synced

What it writes: attribute_item_option (upsert) — Maps a picker attribute onto the catalogue axis (item.md §9b); variant_attribute_value (upsert) — Replaces the values of each attribute sent

curl -X POST https://app.getera.io/api/v1/attribute_item_options/actions/set_variant_attributes \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"itemVariantId":"ITEM_VARIANT_ID","values":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.variant_attributes_changed",
    "attributes.variant_axes_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeItemOptions.setVariantAttributes({
  itemVariantId: "ITEM_VARIANT_ID",
  values: {}
})

era attribute_item_options set_variant_attributes --data '{"itemVariantId":"ITEM_VARIANT_ID","values":{}}'

{
  "name": "era__attributes__set_variant_attributes",
  "arguments": {
    "itemVariantId": "ITEM_VARIANT_ID",
    "values": {}
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:write · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 variant_not_found, item_has_no_type, attribute_not_on_type, attribute_value_invalid, attribute_value_required · 429 slow down

attributes.unassign_attribute

Remove an attribute from a type — The values that type’s products carried for it go too.

Needs attributes:manage · removes or cannot be undone · asks a person to confirm when Era runs it

• Canonical address: POST /api/v1/actions/attributes.unassign_attribute

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.type_attributes_changed

What it writes: product_type_attribute (delete) — Removes the assignment; item_attribute_value (delete) — Removes products’ values for it; variant_attribute_value (delete) — Removes variants’ values for it

curl -X POST https://app.getera.io/api/v1/product_type_attributes/actions/unassign_attribute \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"productTypeId":"PRODUCT_TYPE_ID","attributeId":"ATTRIBUTE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.type_attributes_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productTypeAttributes.unassignAttribute({
  productTypeId: "PRODUCT_TYPE_ID",
  attributeId: "ATTRIBUTE_ID"
})

era product_type_attributes unassign_attribute \
  --product-type-id "PRODUCT_TYPE_ID" \
  --attribute-id "ATTRIBUTE_ID"

{
  "name": "era__attributes__unassign_attribute",
  "arguments": {
    "productTypeId": "PRODUCT_TYPE_ID",
    "attributeId": "ATTRIBUTE_ID"
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, attribute_not_on_type · 429 slow down

attributes.update_assignment

Switch the variant picker — Whether a variant attribute appears as the storefront’s “Size: S M L” buttons.

Needs attributes:manage · changes data

• Canonical address: POST /api/v1/actions/attributes.update_assignment

Input

Preconditions

The action is refused with 409 and one of these codes:

Events it publishes: attributes.type_attributes_changed, attributes.variant_axes_synced

What it writes: attribute_item_option (upsert) — Maps a picker attribute onto the catalogue axis (item.md §9b); product_type_attribute (update) — Sets variant_selection

curl -X POST https://app.getera.io/api/v1/attribute_item_options/actions/update_assignment \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"productTypeId":"PRODUCT_TYPE_ID","attributeId":"ATTRIBUTE_ID","variantSelection":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "attributes.type_attributes_changed",
    "attributes.variant_axes_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.attributeItemOptions.updateAssignment({
  productTypeId: "PRODUCT_TYPE_ID",
  attributeId: "ATTRIBUTE_ID",
  variantSelection: true
})

era attribute_item_options update_assignment \
  --product-type-id "PRODUCT_TYPE_ID" \
  --attribute-id "ATTRIBUTE_ID" \
  --variant-selection true

{
  "name": "era__attributes__update_assignment",
  "arguments": {
    "productTypeId": "PRODUCT_TYPE_ID",
    "attributeId": "ATTRIBUTE_ID",
    "variantSelection": true
  }
}

Errors: 401 no or expired credential · 403 the credential does not hold attributes:manage · 404 the record or module is outside what it may reach · 422 invalid input (problems[]) · 409 not_found, attribute_not_on_type, variant_selection_not_allowed · 429 slow down

Data models

AttributeItemOption

Table attribute_item_option · Resource attribute_item_options

• GET /api/v1/attribute_item_options
• GET /api/v1/attribute_item_options/{id}

Primary key: id

Unique: item_id, attribute_id · item_option_id

AttributeValue

Table attribute_value · Resource attribute_values

• GET /api/v1/attribute_values
• GET /api/v1/attribute_values/{id}
• PATCH /api/v1/attribute_values/{id} → attributes.save_attribute_value
• DELETE /api/v1/attribute_values/{id} → attributes.delete_attribute_value

Primary key: id

Unique: attribute_id, slug

Checks:

• CHECK (((value = ''::text) OR (file_id IS NULL)))

Attribute

Table attribute · Resource attributes

• GET /api/v1/attributes
• GET /api/v1/attributes/{id}
• PATCH /api/v1/attributes/{id} → attributes.save_attribute
• DELETE /api/v1/attributes/{id} → attributes.delete_attribute

Primary key: id

Checks:

• CHECK (((input_type = ANY (ARRAY['reference'::text, 'single-reference'::text])) = (entity_type IS NOT NULL)))
• CHECK (((unit IS NULL) OR (input_type = 'numeric'::text)))

ItemAttributeValue

Table item_attribute_value · Resource product_attribute_values

• GET /api/v1/product_attribute_values
• GET /api/v1/product_attribute_values/{id}

Primary key: id

Checks:

• CHECK ((num_nonnulls(value_id, text_value, numeric_value, boolean_value, date_value, file_id, reference_item_id, reference_variant_id, reference_category_id) = 1))

ProductTypeAttribute

Table product_type_attribute · Resource product_type_attributes

• GET /api/v1/product_type_attributes
• GET /api/v1/product_type_attributes/{id}

Primary key: id

Unique: product_type_id, attribute_id

Checks:

• CHECK (((level = 'variant'::text) OR (NOT variant_selection)))

ItemProductType

Table item_product_type · Resource product_type_links

• GET /api/v1/product_type_links
• GET /api/v1/product_type_links/{id}

Primary key: id

Unique: item_id

ProductType

Table product_type · Resource product_types

• GET /api/v1/product_types
• GET /api/v1/product_types/{id}
• PATCH /api/v1/product_types/{id} → attributes.save_product_type
• DELETE /api/v1/product_types/{id} → attributes.delete_product_type

Primary key: id

Checks:

• CHECK ((weight_grams >= 0))

VariantAttributeValue

Table variant_attribute_value · Resource variant_attribute_values

• GET /api/v1/variant_attribute_values
• GET /api/v1/variant_attribute_values/{id}

Primary key: id

Checks:

• CHECK ((num_nonnulls(value_id, text_value, numeric_value, boolean_value, date_value, file_id, reference_item_id, reference_variant_id, reference_category_id) = 1))

Events

Workflows and webhooks react to these events.