Entegrasyonlar API

Pazaryerleri, e-ticaret siteleri, kargo ve e-fatura — siparişleriniz, ürünleriniz, stoğunuz ve müşterilerinizle eşitlenir.

Modül kodu integrations · 22 işlem · 8 veri modeli · 22 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ı: integrations (hepsi), integrations:read (yalnız okuma) ya da integrations:<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

integrations.cancel_shipment

Kargoyu iptal et — Kargo firması henüz almadıysa iptal eder; firmaya arka planda bildirilir.

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

• Asıl adres: POST /api/v1/actions/integrations.cancel_shipment

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.shipment_updated

Neye yazar: carrier_shipment (update) — Marks it cancelled

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.shipment_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.carrierShipments.cancelShipment("CARRIER_SHIPMENT_ID")

era carrier_shipments cancel_shipment CARRIER_SHIPMENT_ID

{
  "name": "era__integrations__cancel_shipment",
  "arguments": {
    "id": "CARRIER_SHIPMENT_ID"
  }
}

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

integrations.connect

Eşitleme için bir uygulama bağla — Bağlantıyı (şifreli anahtarıyla) eşitlemeye bağlar: pazaryeri ya da mağaza için bir satış kanalı ve depo.

Gereken izin integrations:manage · 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/integrations.connect

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.connected

Neye yazar: integration_account (insert) — The account, with a fresh inbound-webhook token

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.connected"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.connect({
  provider: "App"
})

era integration_accounts connect \
  --provider "App"

{
  "name": "era__integrations__connect",
  "arguments": {
    "provider": "App"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:manage izni yok · 404 kayıt ya da modül erişim dışında · 422 geçersiz girdi (problems[]) · 409 unknown_provider, credential_not_found, provider_mismatch, credential_taken, channel_required, channel_taken, bad_config, bad_setting · 429 çok sık istek

integrations.create_shipment

Kargoya ver — Bağlı bir kargo firmasıyla (Yurtiçi, Aras, MNG, Sürat, HepsiJet) sipariş için kargo kaydı açar; takip kendiliğinden gelir.

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

• Asıl adres: POST /api/v1/actions/integrations.create_shipment

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.shipment_requested

Neye yazar: carrier_shipment (insert) — The parcel request; the worker books it at the carrier

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.shipment_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.carrierShipments.createShipment({
  orderId: "SALES_ORDER_ID"
})

era carrier_shipments create_shipment \
  --order-id "SALES_ORDER_ID"

{
  "name": "era__integrations__create_shipment",
  "arguments": {
    "orderId": "SALES_ORDER_ID"
  }
}

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

integrations.disconnect

Uygulama bağlantısını kes — Eşitleme kalıcı olarak durur. Siparişler, ürünler ve geçmiş kalır; anahtar bağlantıyla birlikte silinir.

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

• Asıl adres: POST /api/v1/actions/integrations.disconnect

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.disconnected

Neye yazar: integration_account (update) — Marks it disconnected; drops the webhook token

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.disconnected"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.disconnect("INTEGRATION_ACCOUNT_ID")

era integration_accounts disconnect INTEGRATION_ACCOUNT_ID

{
  "name": "era__integrations__disconnect",
  "arguments": {
    "id": "INTEGRATION_ACCOUNT_ID"
  }
}

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

integrations.issue_einvoice

Siparişi faturala (e-Arşiv / e-Fatura) — Bağlı e-fatura sağlayıcısından (Paraşüt, Uyumsoft ya da Logo eLogo) sipariş için fatura ister: e-Fatura mükellefine e-Fatura, diğerlerine e-Arşiv.

Gereken izin integrations: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/integrations.issue_einvoice

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.einvoice_requested

Neye yazar: einvoice_document (insert) — The request; the worker sends it to the provider

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.einvoice_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.einvoiceDocuments.issueEinvoice({
  orderId: "SALES_ORDER_ID"
})

era einvoice_documents issue_einvoice \
  --order-id "SALES_ORDER_ID"

{
  "name": "era__integrations__issue_einvoice",
  "arguments": {
    "orderId": "SALES_ORDER_ID"
  }
}

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

integrations.map_listing

İlanı bir ürüne bağla — Bir pazaryeri ilanının hangi Era varyantı olduğunu söyler; siparişleri stok düşer, Era stoğu ona gider.

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

• Asıl adres: POST /api/v1/actions/integrations.map_listing

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.listing_mapped

Neye yazar: channel_listing (update) — Sets (or clears) the variant; the next push sends its stock

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.listing_mapped"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.channelListings.mapListing("CHANNEL_LISTING_ID", {
  itemVariantId: "ITEM_VARIANT_ID"
})

era channel_listings map_listing CHANNEL_LISTING_ID \
  --item-variant-id "ITEM_VARIANT_ID"

{
  "name": "era__integrations__map_listing",
  "arguments": {
    "listingId": "CHANNEL_LISTING_ID",
    "itemVariantId": "ITEM_VARIANT_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations: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 · 429 çok sık istek

integrations.publish_listings

Ürün varyantlarını pazaryerinde yayınla — Katalogdaki varyantları bağlı Trendyol hesabına gönderir. Fiyat ve stok katalogdan alınır; marka, kategori ve nitelik kimlikleri belirtilir. Kuyruğa alınması yayınlandığı anlamına gelmez; sonuç uygulamanın işlem geçmişinde izlenir.

Gereken izin integrations: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/integrations.publish_listings

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.listing_publish_requested

Neye yazar: integration_run (insert) — Track the asynchronous publication request

curl -X POST https://app.getera.io/api/v1/integration_runs/actions/publish_listings \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"accountId":"INTEGRATION_ACCOUNT_ID","listings":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.listing_publish_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationRuns.publishListings({
  accountId: "INTEGRATION_ACCOUNT_ID",
  listings: {}
})

era integration_runs publish_listings --data '{"accountId":"INTEGRATION_ACCOUNT_ID","listings":{}}'

{
  "name": "era__integrations__publish_listings",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "listings": {}
  }
}

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

integrations.raise_issue

Eşitleme sorunu aç — Bir kişinin bakması gereken şey, Türkçe. Aynısı tekrar olursa sayısı artar.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.raise_issue

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.issue_raised

Neye yazar: integration_issue (upsert) — One open issue per (account, kind, thing)

curl -X POST https://app.getera.io/api/v1/integration_issues/actions/raise_issue \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"accountId":"INTEGRATION_ACCOUNT_ID","kind":"Kind","message":"Message"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.issue_raised"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationIssues.raiseIssue({
  accountId: "INTEGRATION_ACCOUNT_ID",
  kind: "Kind",
  message: "Message"
})

era integration_issues raise_issue \
  --account-id "INTEGRATION_ACCOUNT_ID" \
  --kind "Kind" \
  --message "Message"

{
  "name": "era__integrations__raise_issue",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "kind": "Kind",
    "message": "Message"
  }
}

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

integrations.record_einvoice

e-Fatura cevabını kaydet — e-Fatura sağlayıcısının istekle ne yaptığı.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_einvoice

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.einvoice_updated

Neye yazar: einvoice_document (update) — The provider’s answer

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.einvoice_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.einvoiceDocuments.recordEinvoice("EINVOICE_DOCUMENT_ID", {
  status: "Status"
})

era einvoice_documents record_einvoice EINVOICE_DOCUMENT_ID \
  --status "Status"

{
  "name": "era__integrations__record_einvoice",
  "arguments": {
    "id": "EINVOICE_DOCUMENT_ID",
    "status": "Status"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:handle 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

integrations.record_inbound

Webhook teslimatını kaydet — Her teslimat bir kez; kabul edilen bir eşitlemeyi tetikler (gövdesi asla veri olarak alınmaz).

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_inbound

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.webhook_received

Neye yazar: integration_inbound (insert) — The delivery, deduped on its id

curl -X POST https://app.getera.io/api/v1/integration_inbounds/actions/record_inbound \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"accountId":"INTEGRATION_ACCOUNT_ID","externalId":"Delivery","accepted":true}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.webhook_received"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationInbounds.recordInbound({
  accountId: "INTEGRATION_ACCOUNT_ID",
  externalId: "Delivery",
  accepted: true
})

era integration_inbounds record_inbound \
  --account-id "INTEGRATION_ACCOUNT_ID" \
  --external-id "Delivery" \
  --accepted true

{
  "name": "era__integrations__record_inbound",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "externalId": "Delivery",
    "accepted": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:handle 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

integrations.record_review_reply

Yorum cevabının sonucunu kaydet — Yorum sağlayıcısının cevabı yayımlayıp yayımlamadığı.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_review_reply

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.review_replied

Neye yazar: integration_review (update) — The provider’s answer

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.review_replied"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationReviews.recordReviewReply("INTEGRATION_REVIEW_ID", {
  ok: true
})

era integration_reviews record_review_reply INTEGRATION_REVIEW_ID \
  --ok true

{
  "name": "era__integrations__record_review_reply",
  "arguments": {
    "id": "INTEGRATION_REVIEW_ID",
    "ok": true
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:handle 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

integrations.record_reviews

Yorumları kaydet — Bağlı yorum sağlayıcısındaki güncel yorumlar: yeni gelenler, düzenlenenler ve Era dışında yazılan cevaplar.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_reviews

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.reviews_synced

Neye yazar: integration_review (insert) — One row per review, updated in place on the next sync

curl -X POST https://app.getera.io/api/v1/integration_reviews/actions/record_reviews \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"accountId":"INTEGRATION_ACCOUNT_ID","reviews":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.reviews_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationReviews.recordReviews({
  accountId: "INTEGRATION_ACCOUNT_ID",
  reviews: {}
})

era integration_reviews record_reviews --data '{"accountId":"INTEGRATION_ACCOUNT_ID","reviews":{}}'

{
  "name": "era__integrations__record_reviews",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "reviews": {}
  }
}

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

integrations.record_run

Eşitleme turunu kaydet — Bir turu açar ya da sayılarıyla ve tek bir Türkçe cümleyle kapatır; hesabın imleçlerini ve sağlığını günceller.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_run

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.run_finished

Neye yazar: integration_run (upsert) — The run row; integration_account (update) — Last sync times, cursors, health

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.run_finished"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.recordRun("INTEGRATION_ACCOUNT_ID", {
  runId: "RUN_ID"
})

era integration_accounts record_run INTEGRATION_ACCOUNT_ID \
  --run-id "RUN_ID"

{
  "name": "era__integrations__record_run",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "runId": "RUN_ID"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:handle 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

integrations.record_shipment

Kargo cevabını kaydet — Kargo firmasının kaydı, takip numarası, etiketi ya da son hareketi — ya da reddi.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_shipment

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.shipment_updated

Neye yazar: carrier_shipment (update) — What the carrier said

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.shipment_updated"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.carrierShipments.recordShipment("CARRIER_SHIPMENT_ID", {
  status: "Status"
})

era carrier_shipments record_shipment CARRIER_SHIPMENT_ID \
  --status "Status"

{
  "name": "era__integrations__record_shipment",
  "arguments": {
    "id": "CARRIER_SHIPMENT_ID",
    "status": "Status"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations:handle 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

integrations.record_stock_push

Stok gönderimini kaydet — Her ilana ne gönderildiği ve kanalın kabul edip etmediği.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.record_stock_push

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.stock_pushed

Neye yazar: channel_listing (update) — Last pushed quantity, or the refusal; integration_account (update) — Last push time

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.stock_pushed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.recordStockPush("INTEGRATION_ACCOUNT_ID", {
  results: {}
})

era integration_accounts record_stock_push INTEGRATION_ACCOUNT_ID --data '{"results":{}}'

{
  "name": "era__integrations__record_stock_push",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "results": {}
  }
}

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

integrations.record_test

Bağlantı testini kaydet — Sağlayıcıya yapılan zararsız çağrının sonucunu hesapta saklar.

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

• Asıl adres: POST /api/v1/actions/integrations.record_test

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.tested

Neye yazar: integration_account (update) — Last test time and result; integration_run (insert) — The test in the run history

curl -X POST https://app.getera.io/api/v1/integration_accounts/INTEGRATION_ACCOUNT_ID/actions/record_test \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"ok":true,"message":"What happened"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.tested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.recordTest("INTEGRATION_ACCOUNT_ID", {
  ok: true,
  message: "What happened"
})

era integration_accounts record_test INTEGRATION_ACCOUNT_ID \
  --ok true \
  --message "What happened"

{
  "name": "era__integrations__record_test",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "ok": true,
    "message": "What happened"
  }
}

Hatalar: 401 kimlik bilgisi yok ya da süresi dolmuş · 403 kimlik bilgisinde integrations: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

integrations.reply_review

Yoruma cevap ver — İşletmenin bir Google yorumuna herkese açık cevabını yayımlar (eski cevabın yerine geçer); arka planda gönderilir.

Gereken izin integrations: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/integrations.reply_review

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.review_reply_requested

Neye yazar: integration_review (update) — Keeps the reply and marks it on its way

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.review_reply_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationReviews.replyReview("INTEGRATION_REVIEW_ID", {
  text: "Reply"
})

era integration_reviews reply_review INTEGRATION_REVIEW_ID \
  --text "Reply"

{
  "name": "era__integrations__reply_review",
  "arguments": {
    "id": "INTEGRATION_REVIEW_ID",
    "text": "Reply"
  }
}

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

integrations.request_sync

Şimdi eşitle — Pazaryerinden ya da mağazadan yeni siparişleri ve ürünleri çeker, Era stoğunu geri gönderir — arka planda, saniyeler içinde.

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

• Asıl adres: POST /api/v1/actions/integrations.request_sync

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.sync_requested

Neye yazar: integration_run (insert) — The run, which the worker picks up

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.sync_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationRuns.requestSync({
  id: "INTEGRATION_ACCOUNT_ID"
})

era integration_runs request_sync \
  --id "INTEGRATION_ACCOUNT_ID"

{
  "name": "era__integrations__request_sync",
  "arguments": {
    "id": "INTEGRATION_ACCOUNT_ID"
  }
}

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

integrations.resolve_issue

Eşitleme sorununu kapat — Halledildi ya da önemsiz olarak işaretler.

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

• Asıl adres: POST /api/v1/actions/integrations.resolve_issue

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.issue_resolved

Neye yazar: integration_issue (update) — Closes it

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.issue_resolved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationIssues.resolveIssue("INTEGRATION_ISSUE_ID", {
  status: "resolved"
})

era integration_issues resolve_issue INTEGRATION_ISSUE_ID \
  --status "resolved"

{
  "name": "era__integrations__resolve_issue",
  "arguments": {
    "id": "INTEGRATION_ISSUE_ID",
    "status": "resolved"
  }
}

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

integrations.set_paused

Eşitlemeyi duraklat ya da sürdür — Duraklatılan hesapta her şey durur; sürdürülene kadar hiçbir şey çekilmez ya da gönderilmez.

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

• Asıl adres: POST /api/v1/actions/integrations.set_paused

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.paused, integrations.resumed

Neye yazar: integration_account (update) — Flips paused / active

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.paused",
    "integrations.resumed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.setPaused("INTEGRATION_ACCOUNT_ID", {
  paused: true
})

era integration_accounts set_paused INTEGRATION_ACCOUNT_ID \
  --paused true

{
  "name": "era__integrations__set_paused",
  "arguments": {
    "id": "INTEGRATION_ACCOUNT_ID",
    "paused": true
  }
}

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

integrations.update_settings

Eşitleme ayarlarını değiştir — Siparişler gelsin mi, ürünler okunsun mu, stok gitsin mi, güvenlik stoğu, ne kadar geriye bakılsın.

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

• Asıl adres: POST /api/v1/actions/integrations.update_settings

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.settings_changed

Neye yazar: integration_account (update) — Merges the settings

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

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.settings_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.integrationAccounts.updateSettings("INTEGRATION_ACCOUNT_ID", {
  settings: {}
})

era integration_accounts update_settings INTEGRATION_ACCOUNT_ID --data '{"settings":{}}'

{
  "name": "era__integrations__update_settings",
  "arguments": {
    "id": "INTEGRATION_ACCOUNT_ID",
    "settings": {}
  }
}

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

integrations.upsert_listings

İlanları kaydet — Kanalın sattıklarını saklar ve her ilanı stok kodu, barkod ya da dış anahtarla bir Era varyantına bağlar.

Gereken izin integrations:handle · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/integrations.upsert_listings

Girdi

Ön koşullar

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

Yayımladığı olaylar: integrations.listings_synced

Neye yazar: channel_listing (upsert) — One row per listing; a match is never undone by a re-read

curl -X POST https://app.getera.io/api/v1/channel_listings/actions/upsert_listings \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"accountId":"INTEGRATION_ACCOUNT_ID","listings":{}}'

{
  "ok": true,
  "result": "…",
  "events": [
    "integrations.listings_synced"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.channelListings.upsertListings({
  accountId: "INTEGRATION_ACCOUNT_ID",
  listings: {}
})

era channel_listings upsert_listings --data '{"accountId":"INTEGRATION_ACCOUNT_ID","listings":{}}'

{
  "name": "era__integrations__upsert_listings",
  "arguments": {
    "accountId": "INTEGRATION_ACCOUNT_ID",
    "listings": {}
  }
}

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

Veri modelleri

CarrierShipment

Tablo carrier_shipment · Kaynak carrier_shipments

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

Birincil anahtar: id

Tekil: account_id, reference

Denetimler:

• CHECK (((cod_amount IS NULL) OR (cod_amount >= 0)))
• CHECK ((pieces >= 1))
• CHECK ((reference ~ '^[A-Za-z0-9-]{4,40}$'::text))

ChannelListing

Tablo channel_listing · Kaynak channel_listings

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

Birincil anahtar: id

Tekil: account_id, external_key

Denetimler:

• CHECK ((length(external_key) > 0))
• CHECK (((remote_price IS NULL) OR (remote_price >= 0)))

EinvoiceDocument

Tablo einvoice_document · Kaynak einvoice_documents

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

Birincil anahtar: id

IntegrationAccount

Tablo integration_account · Kaynak integration_accounts

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

Birincil anahtar: id

Tekil: webhook_token

Denetimler:

• CHECK ((consecutive_failures >= 0))
• CHECK ((length(TRIM(BOTH FROM label)) > 0))
• CHECK ((provider ~ '^[a-z][a-z0-9_]{1,40}$'::text))

IntegrationInbound

Tablo integration_inbound · Kaynak integration_inbounds

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

Birincil anahtar: id

Tekil: account_id, external_id

IntegrationIssue

Tablo integration_issue · Kaynak integration_issues

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

Birincil anahtar: id

Denetimler:

• CHECK ((occurrences >= 1))

IntegrationReview

Tablo integration_review · Kaynak integration_reviews

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

Birincil anahtar: id

Denetimler:

• CHECK (((length(external_id) >= 1) AND (length(external_id) <= 500)))
• CHECK ((provider ~ '^[a-z][a-z0-9_]{1,40}$'::text))
• CHECK (((rating >= 1) AND (rating <= 5)))

IntegrationRun

Tablo integration_run · Kaynak integration_runs

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