Katalog API

Sattığınız veya randevuya açtığınız her şey — ürünler, hizmetler, fiyatlar, kategoriler ve markalar.

Modül kodu catalog · 25 işlem · 9 veri modeli · 19 olay. Bir anahtar ya da token, arkasındaki kişinin bu modülde yapabildiğinden fazlasını asla yapamaz; satır düzeyindeki güvenlik uygulamadakiyle birebir aynıdır. Yetki kapsamları: catalog (hepsi), catalog:read (yalnız okuma) ya da catalog:<yetenek>.

Kaynaklar

Listeler limit (en çok 200), cursor, order (ör. -created_at), fields ve q alır; diğer her sorgu parametresi bir sütun süzgecidir: ?status=paid, ?total[gte]=100, ?id[in]=a,b, ?x=null.

İşlemler

catalog.activate

Yeniden sun — Listeye geri koyar.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.activate

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.activated

Neye yazar: item (update) — Marks it active

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.activated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.activate("PRODUCT_ID")

era products activate PRODUCT_ID

{
  "name": "era__catalog__activate",
  "arguments": {
    "id": "PRODUCT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_active · 429 çok sık istek

catalog.assign_images

Görsel ata — Seçilen görseli seçili her hizmet ya da ürüne ekler; mevcut galeriler korunur.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.assign_images

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.files_changed

Neye yazar: item_file (insert) — Appends an image, keeping the existing gallery

curl -X POST https://app.getera.io/api/v1/product_files/actions/assign_images \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"ids":{},"fileId":"FILE_ID"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.files_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productFiles.assignImages({
  ids: {},
  fileId: "FILE_ID"
})

era product_files assign_images --data '{"ids":{},"fileId":"FILE_ID"}'

{
  "name": "era__catalog__assign_images",
  "arguments": {
    "ids": {},
    "fileId": "FILE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_items, file_not_found, image_required, not_found · 429 çok sık istek

catalog.attach_file

Görsel veya dosya ekle — Bir fotoğraf, video, teknik belge veya indirme — ürüne ya da tek bir varyanta.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.attach_file

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.files_changed

Neye yazar: item_file (insert) — Attaches the file

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.files_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productFiles.attachFile({
  itemId: "ITEM_ID"
})

era product_files attach_file \
  --item-id "ITEM_ID"

{
  "name": "era__catalog__attach_file",
  "arguments": {
    "itemId": "ITEM_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, nothing_to_attach, file_not_found, variant_not_on_item · 429 çok sık istek

catalog.bulk_update_items

Birden çok ürünü değiştir — Listeden yayımla, yayından kaldır, listeye koy veya çıkar ya da bir kategoriye taşı.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.bulk_update_items

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.published, catalog.unpublished, catalog.activated, catalog.deactivated, catalog.item_updated

Neye yazar: item (update) — Writes the change on each item it applies to

curl -X POST https://app.getera.io/api/v1/products/actions/bulk_update_items \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"itemIds":{},"operation":"publish"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.published",
    "catalog.unpublished",
    "catalog.activated",
    "catalog.deactivated",
    "catalog.item_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.bulkUpdateItems({
  itemIds: {},
  operation: "publish"
})

era products bulk_update_items --data '{"itemIds":{},"operation":"publish"}'

{
  "name": "era__catalog__bulk_update_items",
  "arguments": {
    "itemIds": {},
    "operation": "publish"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_items, not_found, category_not_found · 429 çok sık istek

catalog.create_category

Kategori ekle — Kataloğu bu ekranda ve mağaza sitesinde gruplar.

Gereken izin catalog:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.create_category

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.category_created

Neye yazar: item_category (insert) — Creates the category

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.category_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.categories.createCategory("CATEGORY_ID", {
  name: "Name"
})

era categories create_category CATEGORY_ID \
  --name "Name"

{
  "name": "era__catalog__create_category",
  "arguments": {
    "parentId": "CATEGORY_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_name, slug_taken, parent_not_found · 429 çok sık istek

catalog.create_item

Kataloğa ekle — Satılabilecek veya rezerve edilebilecekler listesine ilk varyantıyla yeni bir şey koyar.

Gereken izin catalog:write · veriyi değiştirir

• REST kısayolu: POST /api/v1/products
• Asıl adres: POST /api/v1/actions/catalog.create_item

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.item_created, catalog.files_changed, catalog.published

Neye yazar: item (insert) — Creates the catalogue entry; item_variant (insert) — Creates its default variant; item_file (insert) — Attaches the picture, when one is given

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.item_created",
    "catalog.files_changed",
    "catalog.published"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.create({
  name: "Name"
})

era products create \
  --name "Name"

{
  "name": "era__catalog__create_item",
  "arguments": {
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_name, store_missing, file_not_found, slug_taken, fulfilment_not_allowed_for_kind, duration_on_product, category_not_found, brand_not_found · 429 çok sık istek

catalog.deactivate

Sunmayı durdur — Listeden çıkarır; onun için alınmış randevuları belirtir.

Gereken izin catalog:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/catalog.deactivate

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.deactivated

Neye yazar: item (update) — Marks it inactive

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.deactivated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.deactivate("PRODUCT_ID", {
  force: true
})

era products deactivate PRODUCT_ID \
  --force true

{
  "name": "era__catalog__deactivate",
  "arguments": {
    "id": "PRODUCT_ID",
    "force": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_inactive, has_upcoming · 429 çok sık istek

catalog.delete_items

Ürünleri sil — Kalıcı olarak kaldırır. Siparişler dondurulmuş adlarını korur; randevu ve paketler buna izin vermez.

Gereken izin catalog:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/catalog.delete_items

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.item_deleted

Neye yazar: item (delete) — Removes the items and their variants

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.item_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.deleteItems({
  itemIds: {}
})

era products delete_items --data '{"itemIds":{}}'

{
  "name": "era__catalog__delete_items",
  "arguments": {
    "itemIds": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 no_items, not_found, item_in_use · 429 çok sık istek

catalog.detach_file

Eki kaldır — Kaldırılmak üzere sıraya koyar.

Gereken izin catalog:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır) · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/catalog.detach_file

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.files_changed

Neye yazar: item_file (update) — Marks it for removal

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.files_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productFiles.detachFile("PRODUCT_FILE_ID")

era product_files detach_file PRODUCT_FILE_ID

{
  "name": "era__catalog__detach_file",
  "arguments": {
    "id": "PRODUCT_FILE_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 attachment_not_found · 429 çok sık istek

catalog.email_product_export

Ürün dışa aktarımını e-postayla gönder — Seçilen XLSX dosyasını arka planda hazırlar ve e-postaya ek olarak gönderir.

Gereken izin catalog:export · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.export_queued

curl -X POST https://app.getera.io/api/v1/actions/catalog.email_product_export \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"email":"Recipient","fields":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.export_queued"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.actions.run("catalog.email_product_export", {
  email: "Recipient",
  fields: {}
})

era catalog email_product_export --data '{"email":"Recipient","fields":{}}'

{
  "name": "era__catalog__email_product_export",
  "arguments": {
    "email": "Recipient",
    "fields": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:export izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_export_email, invalid_export_fields · 429 çok sık istek

catalog.move_category

Kategoriyi taşı — Bir kategoriyi başka birinin içine ya da en üst seviyeye koyar.

Gereken izin catalog:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.move_category

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.category_moved

Neye yazar: item_category (update) — Moves the category

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.category_moved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.categories.moveCategory("CATEGORY_ID", {
  parentId: "ITEM_CATEGORY_ID"
})

era categories move_category CATEGORY_ID \
  --parent-id "ITEM_CATEGORY_ID"

{
  "name": "era__catalog__move_category",
  "arguments": {
    "id": "CATEGORY_ID",
    "parentId": "ITEM_CATEGORY_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, parent_not_found, cycle · 429 çok sık istek

catalog.publish

Yayımla — Mağaza sitesine koyar.

Gereken izin catalog:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/catalog.publish

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.published

Neye yazar: item (update) — Stamps published_at

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.published"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.publish("PRODUCT_ID")

era products publish PRODUCT_ID

{
  "name": "era__catalog__publish",
  "arguments": {
    "id": "PRODUCT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, already_published, no_variant, no_price · 429 çok sık istek

catalog.remove_variant

Varyantı kaldır — Bir varyantı bırakır; sonuncusu değilse veya ona bağlı bir şey yoksa.

Gereken izin catalog:delete · siler ya da geri alınamaz · Era çalıştırırken bir kişiye onaylatır

• Asıl adres: POST /api/v1/actions/catalog.remove_variant

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.variant_removed

Neye yazar: item_variant (delete) — Removes the variant

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.variant_removed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.variants.removeVariant("VARIANT_ID")

era variants remove_variant VARIANT_ID

{
  "name": "era__catalog__remove_variant",
  "arguments": {
    "id": "VARIANT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:delete izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 variant_not_found, last_variant, variant_in_use · 429 çok sık istek

catalog.reorder_files

Görselleri sırala — Mağaza sitesinin onları gösterdiği sıra.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.reorder_files

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.files_changed

Neye yazar: item_file (update) — Writes the order

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.files_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productFiles.reorderFiles({
  itemId: "ITEM_ID",
  attachmentIds: {}
})

era product_files reorder_files --data '{"itemId":"ITEM_ID","attachmentIds":{}}'

{
  "name": "era__catalog__reorder_files",
  "arguments": {
    "itemId": "ITEM_ID",
    "attachmentIds": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, attachment_not_on_item · 429 çok sık istek

catalog.save_brand

Marka ekle veya düzenle — Ürünün kime ait olduğu — kendi sayfası, sitesi ve logosuyla.

Gereken izin catalog:manage · veriyi değiştirir

• REST kısayolu: PATCH /api/v1/brands/{id}
• Asıl adres: POST /api/v1/actions/catalog.save_brand

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.brand_created, catalog.brand_updated

Neye yazar: item_brand (upsert) — Writes the brand

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.brand_created",
    "catalog.brand_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.brands.saveBrand("BRAND_ID", {
  name: "Name"
})

era brands save_brand BRAND_ID \
  --name "Name"

{
  "name": "era__catalog__save_brand",
  "arguments": {
    "id": "BRAND_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 invalid_name, slug_taken, parent_not_found, cycle, not_found · 429 çok sık istek

catalog.save_variant

Varyant ekle veya düzenle — Gerçekte satılan şey: stok kodu, fiyat, süre, kapasite ve seçenekler.

Gereken izin catalog:write · veriyi değiştirir

• REST kısayolu: PATCH /api/v1/variants/{id}
• Asıl adres: POST /api/v1/actions/catalog.save_variant

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.variant_changed

Neye yazar: item_variant (upsert) — Writes the variant; item_variant_option (upsert) — Writes which axes it sits on

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.variant_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.variants.saveVariant("VARIANT_ID", {
  itemId: "ITEM_ID"
})

era variants save_variant VARIANT_ID \
  --item-id "ITEM_ID"

{
  "name": "era__catalog__save_variant",
  "arguments": {
    "id": "VARIANT_ID",
    "itemId": "ITEM_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, variant_not_found, sku_taken, weight_on_unshipped, duration_on_product, option_value_not_on_item, variant_combination_exists · 429 çok sık istek

catalog.set_brand_visibility

Markayı göster veya gizle — Ürün geçmişini korurken markanın seçicilerde ve vitrinlerde görünüp görünmeyeceğini belirler.

Gereken izin catalog:manage · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.set_brand_visibility

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.brand_updated

Neye yazar: item_brand (update) — Changes storefront visibility

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.brand_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.brands.setBrandVisibility("BRAND_ID", {
  isActive: true
})

era brands set_brand_visibility BRAND_ID \
  --is-active true

{
  "name": "era__catalog__set_brand_visibility",
  "arguments": {
    "id": "BRAND_ID",
    "isActive": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found · 429 çok sık istek

catalog.set_options

Varyant seçeneklerini belirle — Bir varyantı diğerinden ayıran şey — beden, renk, uzunluk.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.set_options

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.options_changed

Neye yazar: item_option (upsert) — Replaces the axes; item_option_value (upsert) — Replaces their values

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.options_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productOptions.setOptions({
  itemId: "ITEM_ID",
  options: {}
})

era product_options set_options --data '{"itemId":"ITEM_ID","options":{}}'

{
  "name": "era__catalog__set_options",
  "arguments": {
    "itemId": "ITEM_ID",
    "options": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, invalid_options, option_in_use_by_variant · 429 çok sık istek

catalog.set_package_contents

Paketin içeriğini belirle — Paketin içeriğini değiştirir — varyantlar, miktarlarıyla ve sırasıyla.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.set_package_contents

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.package_changed

Neye yazar: item_component (upsert) — Replaces the package contents

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.package_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productComponents.setPackageContents({
  packageItemId: "ITEM_ID",
  contents: "Contents"
})

era product_components set_package_contents \
  --package-item-id "ITEM_ID" \
  --contents "Contents"

{
  "name": "era__catalog__set_package_contents",
  "arguments": {
    "packageItemId": "ITEM_ID",
    "contents": "Contents"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, not_a_package, package_empty, invalid_quantity, component_not_found, self_component, component_is_package · 429 çok sık istek

catalog.set_price

Fiyat belirle — Bir varyantın liste fiyatı. İmzalanmış sözleşmeler onunla değişmez.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.set_price

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.price_changed

Neye yazar: item_variant (update) — Writes the price

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.price_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.variants.setPrice("VARIANT_ID", {
  priceAmount: 1
})

era variants set_price VARIANT_ID \
  --price-amount 1

{
  "name": "era__catalog__set_price",
  "arguments": {
    "variantId": "VARIANT_ID",
    "priceAmount": 1
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 variant_not_found, currency_mismatch · 429 çok sık istek

catalog.unpublish

Yayından kaldır — İç listeden çıkarmadan taslağa geri alır.

Gereken izin catalog:write · dışarıya ulaşır (gönderir, yayımlar ya da ücret alır)

• Asıl adres: POST /api/v1/actions/catalog.unpublish

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.unpublished

Neye yazar: item (update) — Clears published_at

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.unpublished"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.unpublish("PRODUCT_ID")

era products unpublish PRODUCT_ID

{
  "name": "era__catalog__unpublish",
  "arguments": {
    "id": "PRODUCT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, not_published · 429 çok sık istek

catalog.update_category

Kategoriyi düzenle — Kategorinin metnini, adresini, içeriğini ve sitede görünürlüğünü günceller.

Gereken izin catalog:manage · veriyi değiştirir

• REST kısayolu: PATCH /api/v1/categories/{id}
• Asıl adres: POST /api/v1/actions/catalog.update_category

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.category_updated

Neye yazar: item_category (update) — Updates the category

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.category_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.categories.updateCategory("CATEGORY_ID", {
  name: "Name"
})

era categories update_category CATEGORY_ID \
  --name "Name"

{
  "name": "era__catalog__update_category",
  "arguments": {
    "id": "CATEGORY_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, invalid_name, slug_taken · 429 çok sık istek

catalog.update_file

Görseli tanımla — Alternatif metni ve hangi varyantı gösterdiği.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.update_file

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.files_changed

Neye yazar: item_file (update) — Writes the alt text and variant

curl -X POST https://app.getera.io/api/v1/product_files/PRODUCT_FILE_ID/actions/update_file \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"alt":"Alt text"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.files_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.productFiles.updateFile("PRODUCT_FILE_ID", {
  alt: "Alt text"
})

era product_files update_file PRODUCT_FILE_ID \
  --alt "Alt text"

{
  "name": "era__catalog__update_file",
  "arguments": {
    "id": "PRODUCT_FILE_ID",
    "alt": "Alt text"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 attachment_not_found, variant_not_on_item · 429 çok sık istek

catalog.update_item

Katalog kaydını düzenle — Adı, adresi, gruplaması, metni ve SEO bilgisi.

Gereken izin catalog:write · veriyi değiştirir

• REST kısayolu: PATCH /api/v1/products/{id}
• Asıl adres: POST /api/v1/actions/catalog.update_item

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.item_updated

Neye yazar: item (update) — Updates the catalogue entry

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.item_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.updateItem("PRODUCT_ID", {
  name: "Name"
})

era products update_item PRODUCT_ID \
  --name "Name"

{
  "name": "era__catalog__update_item",
  "arguments": {
    "id": "PRODUCT_ID",
    "name": "Name"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found, invalid_name, slug_taken, fulfilment_not_allowed_for_kind, category_not_found, brand_not_found · 429 çok sık istek

catalog.update_item_metadata

Ürün ek bilgilerini düzenle — Kaydın anahtar → değer ek bilgilerini, herkese açık veya gizli olarak yeniden yazar.

Gereken izin catalog:write · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/catalog.update_item_metadata

Girdi

Ön koşullar

Koşul tutmazsa işlem 409 ve şu kodlardan biriyle reddedilir:

Yayımladığı olaylar: catalog.item_updated

Neye yazar: item (update) — Writes the metadata

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

{
  "ok": true,
  "result": "…",
  "events": [
    "catalog.item_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.products.updateItemMetadata("PRODUCT_ID", {
  metadata: {}
})

era products update_item_metadata PRODUCT_ID --data '{"metadata":{}}'

{
  "name": "era__catalog__update_item_metadata",
  "arguments": {
    "id": "PRODUCT_ID",
    "metadata": {}
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde catalog:write izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 not_found · 429 çok sık istek

Veri modelleri

ItemBrand

Tablo item_brand · Kaynak brands

• GET /api/v1/brands
• GET /api/v1/brands/{id}
• PATCH /api/v1/brands/{id} → catalog.save_brand

Birincil anahtar: id

Tekil: workspace_id, slug

ItemCategory

Tablo item_category · Kaynak categories

• GET /api/v1/categories
• GET /api/v1/categories/{id}
• PATCH /api/v1/categories/{id} → catalog.update_category

Birincil anahtar: id

Tekil: workspace_id, slug

ItemComponent

Tablo item_component · Kaynak product_components

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

Birincil anahtar: id