Mağaza API

Satış kanalları, stok, kargo ve siparişler — sepetten kapıya.

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

retail.adjust_stock

Stoğu düzelt — Bir depoya bir miktar mal girişi veya çıkışı; defter için bir nedenle.

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

• Asıl adres: POST /api/v1/actions/retail.adjust_stock

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.stock_changed, retail.stock_low

Neye yazar: stock (upsert) — Moves the count by the amount, in the statement; stock_movement (insert) — Records the movement and its reason

curl -X POST https://app.getera.io/api/v1/stocks/actions/adjust_stock \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"warehouseId":"WAREHOUSE_ID","itemVariantId":"ITEM_VARIANT_ID","delta":1,"reason":"count"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.stock_changed",
    "retail.stock_low"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.stocks.adjustStock({
  warehouseId: "WAREHOUSE_ID",
  itemVariantId: "ITEM_VARIANT_ID",
  delta: 1,
  reason: "count"
})

era stocks adjust_stock \
  --warehouse-id "WAREHOUSE_ID" \
  --item-variant-id "ITEM_VARIANT_ID" \
  --delta 1 \
  --reason "count"

{
  "name": "era__retail__adjust_stock",
  "arguments": {
    "warehouseId": "WAREHOUSE_ID",
    "itemVariantId": "ITEM_VARIANT_ID",
    "delta": 1,
    "reason": "count"
  }
}

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

retail.approve_fulfilment

Gönderiyi onayla — Yalnızca mağaza gönderileri otomatik onaylamıyorsa gerekir.

Gereken izin retail:approve · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/retail.approve_fulfilment

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.fulfilment_approved

Neye yazar: fulfilment (update) — Marks it fulfilled

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.fulfilment_approved"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.fulfilments.approveFulfilment("FULFILMENT_ID")

era fulfilments approve_fulfilment FULFILMENT_ID

{
  "name": "era__retail__approve_fulfilment",
  "arguments": {
    "id": "FULFILMENT_ID"
  }
}

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

retail.attach_gift_card

Hediye kartıyla öde — Harcamayı bekliyor olarak kaydeder ve hediye kartından düşülmesini ister; ret olursa başarısız işaretlenir ve tutar geri konur.

Gereken izin retail:write · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/retail.attach_gift_card

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.gift_card_requested, retail.gift_card_applied

Neye yazar: sales_order_gift_card (insert) — Records the spend (pending until redeemed); sales_order_gift_card (delete) — A failed try of the same card gives way to the new one; sales_order (update) — Lowers the amount due

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.gift_card_requested",
    "retail.gift_card_applied"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.attachGiftCard("ORDER_ID", {
  amount: 1
})

era orders attach_gift_card ORDER_ID \
  --amount 1

{
  "name": "era__retail__attach_gift_card",
  "arguments": {
    "id": "ORDER_ID",
    "amount": 1
  }
}

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

retail.bulk_update_prices

Toplu fiyatla — Bir kanaldaki birçok varyanta tek bir kural — belirle, tutar veya yüzde olarak artır ya da azalt.

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

• Asıl adres: POST /api/v1/actions/retail.bulk_update_prices

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.channel_price_changed

Neye yazar: item_variant_channel_listing (upsert) — Writes each new channel price or cost

curl -X POST https://app.getera.io/api/v1/variant_listings/actions/bulk_update_prices \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"channelId":"CHANNEL_ID","itemVariantIds":{},"mode":"set","value":1}'

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.channel_price_changed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.variantListings.bulkUpdatePrices({
  channelId: "CHANNEL_ID",
  itemVariantIds: {},
  mode: "set",
  value: 1
})

era variant_listings bulk_update_prices --data '{"channelId":"CHANNEL_ID","itemVariantIds":{},"mode":"set","value":1}'

{
  "name": "era__retail__bulk_update_prices",
  "arguments": {
    "channelId": "CHANNEL_ID",
    "itemVariantIds": {},
    "mode": "set",
    "value": 1
  }
}

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

retail.cancel_fulfilment

Gönderiyi iptal et — Mallar çıktıkları rafa geri döner.

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

• Asıl adres: POST /api/v1/actions/retail.cancel_fulfilment

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.fulfilment_canceled

Neye yazar: fulfilment (update) — Marks it cancelled; stock (update) — Puts the goods back; sales_order_line (update) — Lowers quantity_fulfilled

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.fulfilment_canceled"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.fulfilments.cancelFulfilment("FULFILMENT_ID")

era fulfilments cancel_fulfilment FULFILMENT_ID

{
  "name": "era__retail__cancel_fulfilment",
  "arguments": {
    "id": "FULFILMENT_ID"
  }
}

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

retail.cancel_order

Siparişi iptal et — Tuttuğu her şeyi serbest bırakır. Mallar raftan hiç çıkmadı.

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

• Asıl adres: POST /api/v1/actions/retail.cancel_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.order_canceled, retail.gift_card_removed, retail.customer_notification_requested

Neye yazar: sales_order (update) — Marks it cancelled; allocation (delete) — Releases the stock it held; stock (update) — Lowers the allocated count; sales_order_gift_card (delete) — Gives every gift card back (gift_cards refunds it, a reaction)

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.order_canceled",
    "retail.gift_card_removed",
    "retail.customer_notification_requested"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.cancelOrder("ORDER_ID", {
  reason: "Reason"
})

era orders cancel_order ORDER_ID \
  --reason "Reason"

{
  "name": "era__retail__cancel_order",
  "arguments": {
    "id": "ORDER_ID",
    "reason": "Reason"
  }
}

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

retail.close_return

İadeyi kapat — Bu iade için başka işlem yapılmayacak.

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

• Asıl adres: POST /api/v1/actions/retail.close_return

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.return_closed

Neye yazar: order_return (update) — Marks it closed

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.return_closed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orderReturns.closeReturn("ORDER_RETURN_ID")

era order_returns close_return ORDER_RETURN_ID

{
  "name": "era__retail__close_return",
  "arguments": {
    "id": "ORDER_RETURN_ID"
  }
}

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

retail.complete_checkout

Siparişi ver — Sepeti siparişe çevirir, stok ayırır ve sepeti kapatır — bir kez.

Gereken izin retail:write · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/retail.complete_checkout

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.order_placed, retail.customer_notification_requested, retail.stock_low, retail.order_discounts_applied

Neye yazar: sales_order (insert) — Writes the order; sales_order_line (insert) — Writes its lines, frozen; allocation (insert) — Promises stock to the order; stock (update) — Raises the allocated count; stock_reservation (update) — Commits the basket hold into the order allocation; checkout (delete) — Closes the basket

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.order_placed",
    "retail.customer_notification_requested",
    "retail.stock_low",
    "retail.order_discounts_applied"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.completeCheckout({
  token: "TOKEN_ID"
})

era orders complete_checkout \
  --token "TOKEN_ID"

{
  "name": "era__retail__complete_checkout",
  "arguments": {
    "token": "TOKEN_ID"
  }
}

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

retail.complete_draft_order

Taslak siparişi ver — Stok ayırır ve taslağı sipariş sürecine taşır.

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

• Asıl adres: POST /api/v1/actions/retail.complete_draft_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.order_placed, retail.order_discounts_applied, retail.customer_notification_requested, retail.stock_low

Neye yazar: sales_order (update) — Moves it out of draft; sales_order_line (update) — Freezes the discount snapshot; sales_order_discount (insert) — Records what was applied; allocation (insert) — Promises stock to the order; preorder_allocation (insert) — Promises preorders; stock (update) — Raises the allocated count

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.order_placed",
    "retail.order_discounts_applied",
    "retail.customer_notification_requested",
    "retail.stock_low"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.completeDraftOrder("ORDER_ID")

era orders complete_draft_order ORDER_ID

{
  "name": "era__retail__complete_draft_order",
  "arguments": {
    "id": "ORDER_ID"
  }
}

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

retail.confirm_gift_card

Hediye kartı kullanımını onayla — Otomatik: kart kullanıldı, siparişteki bekleyen satır uygulanır.

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

• Asıl adres: POST /api/v1/actions/retail.confirm_gift_card

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.gift_card_applied

Neye yazar: sales_order_gift_card (update) — Applies the pending row

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

retail.confirm_order

Siparişi onayla — Yalnızca kanal otomatik onaylamıyorsa var olan adım.

Gereken izin retail:approve · veriyi değiştirir

• Asıl adres: POST /api/v1/actions/retail.confirm_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.order_confirmed

Neye yazar: sales_order (update) — Moves it to unfulfilled

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.order_confirmed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.confirmOrder("ORDER_ID")

era orders confirm_order ORDER_ID

{
  "name": "era__retail__confirm_order",
  "arguments": {
    "id": "ORDER_ID"
  }
}

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

retail.create_checkout

Sepet aç — Bir kanalda, bir müşteri veya misafir için sepet.

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

• REST kısayolu: POST /api/v1/checkouts
• Asıl adres: POST /api/v1/actions/retail.create_checkout

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.checkout_created

Neye yazar: checkout (insert) — Opens the basket; checkout_line (upsert) — Writes its lines; stock_reservation (upsert) — Holds tracked stock for fifteen minutes

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.checkout_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.checkouts.create({
  channelId: "CHANNEL_ID"
})

era checkouts create \
  --channel-id "CHANNEL_ID"

{
  "name": "era__retail__create_checkout",
  "arguments": {
    "channelId": "CHANNEL_ID"
  }
}

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

retail.create_draft_order

Taslak sipariş başlat — Mağaza çalışanının sepeti: henüz kimsenin vermediği bir sipariş.

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

• REST kısayolu: POST /api/v1/orders
• Asıl adres: POST /api/v1/actions/retail.create_draft_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.draft_order_created

Neye yazar: sales_order (insert) — Writes the draft

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.draft_order_created"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.create({
  channelId: "CHANNEL_ID"
})

era orders create \
  --channel-id "CHANNEL_ID"

{
  "name": "era__retail__create_draft_order",
  "arguments": {
    "channelId": "CHANNEL_ID"
  }
}

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

retail.create_warehouse

Depo aç — Stoğun tutulduğu ve siparişlerin gönderildiği bir yer.

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

• REST kısayolu: POST /api/v1/warehouses
• Asıl adres: POST /api/v1/actions/retail.create_warehouse

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.warehouse_saved

Neye yazar: warehouse (insert) — Creates the warehouse

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.warehouse_saved"
  ]
}

import { createEra } from "@getera/sdk"

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

era warehouses create \
  --name "Name"

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

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

retail.delete_channel

Kanalı sil — Yalnızca hiç sipariş veya sepet almamış bir kanal; satış yapmış olan kapatılır.

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

• REST kısayolu: DELETE /api/v1/sales_channels/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_channel

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.channel_deleted

Neye yazar: channel (delete) — Removes the channel and its listings

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.channel_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.salesChannels.deleteChannel("SALES_CHANNEL_ID")

era sales_channels delete_channel SALES_CHANNEL_ID

{
  "name": "era__retail__delete_channel",
  "arguments": {
    "id": "SALES_CHANNEL_ID"
  }
}

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

retail.delete_collection

Koleksiyonu sil — Liste gider; içindeki ürünler katalogdadır ve kalır.

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

• REST kısayolu: DELETE /api/v1/collections/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_collection

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.collection_deleted

Neye yazar: item_collection (delete) — Removes the collection

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.collection_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.collections.deleteCollection("COLLECTION_ID")

era collections delete_collection COLLECTION_ID

{
  "name": "era__retail__delete_collection",
  "arguments": {
    "id": "COLLECTION_ID"
  }
}

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

retail.delete_draft_order

Taslak siparişi at — Bir sipariş taslağını yalnızca verilmeden önce kaldırır.

Gereken izin retail:delete · siler ya da geri alınamaz

• REST kısayolu: DELETE /api/v1/orders/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_draft_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.draft_order_deleted

Neye yazar: sales_order (delete) — Removes the draft and its lines

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.draft_order_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.deleteDraftOrder("ORDER_ID")

era orders delete_draft_order ORDER_ID

{
  "name": "era__retail__delete_draft_order",
  "arguments": {
    "id": "ORDER_ID"
  }
}

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

retail.delete_draft_orders

Taslakları at — Sipariş listesinden birden çok taslak tek seferde. Hepsi ya da hiçbiri.

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

• Asıl adres: POST /api/v1/actions/retail.delete_draft_orders

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.draft_order_deleted

Neye yazar: sales_order (delete) — Removes the drafts

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.draft_order_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.deleteDraftOrders({
  ids: {}
})

era orders delete_draft_orders --data '{"ids":{}}'

{
  "name": "era__retail__delete_draft_orders",
  "arguments": {
    "ids": {}
  }
}

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

retail.delete_shipping_method

Teslimat ücretini sil — Geçmiş siparişler satıldıkları adı korur.

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

• REST kısayolu: DELETE /api/v1/shipping_methods/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_shipping_method

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.shipping_method_deleted

Neye yazar: shipping_method (delete) — Removes the rate

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.shipping_method_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.shippingMethods.deleteShippingMethod("SHIPPING_METHOD_ID")

era shipping_methods delete_shipping_method SHIPPING_METHOD_ID

{
  "name": "era__retail__delete_shipping_method",
  "arguments": {
    "id": "SHIPPING_METHOD_ID"
  }
}

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

retail.delete_shipping_zone

Kargo bölgesini sil — Yalnızca boş bir bölge silinebilir; ücretleri siparişleri ücretsiz bırakırdı.

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

• REST kısayolu: DELETE /api/v1/shipping_zones/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_shipping_zone

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.shipping_zone_deleted

Neye yazar: shipping_zone (delete) — Removes the zone

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.shipping_zone_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.shippingZones.deleteShippingZone("SHIPPING_ZONE_ID")

era shipping_zones delete_shipping_zone SHIPPING_ZONE_ID

{
  "name": "era__retail__delete_shipping_zone",
  "arguments": {
    "id": "SHIPPING_ZONE_ID"
  }
}

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

retail.delete_warehouse

Depoyu kapat — Depo ve adresi birlikte kaldırılır.

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

• REST kısayolu: DELETE /api/v1/warehouses/{id}
• Asıl adres: POST /api/v1/actions/retail.delete_warehouse

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.warehouse_deleted

Neye yazar: warehouse (delete) — Removes the warehouse and its stock rows

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.warehouse_deleted"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.warehouses.deleteWarehouse("WAREHOUSE_ID")

era warehouses delete_warehouse WAREHOUSE_ID

{
  "name": "era__retail__delete_warehouse",
  "arguments": {
    "id": "WAREHOUSE_ID"
  }
}

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

retail.detach_gift_card

Hediye kartını çıkar — Hediye kartını siparişten kaldırır; para karta geri yüklenir.

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

• Asıl adres: POST /api/v1/actions/retail.detach_gift_card

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.gift_card_removed

Neye yazar: sales_order_gift_card (delete) — Removes the spend; sales_order_gift_card (update) — Marks a refused redemption failed; sales_order (update) — Raises the amount due again

curl -X POST https://app.getera.io/api/v1/order_gift_cards/ORDER_GIFT_CARD_ID/actions/detach_gift_card \
  -H "Authorization: Bearer $ERA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"failure":"Why the card was refused (compensation)"}'

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.gift_card_removed"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orderGiftCards.detachGiftCard("ORDER_GIFT_CARD_ID", {
  failure: "Why the card was refused (compensation)"
})

era order_gift_cards detach_gift_card ORDER_GIFT_CARD_ID \
  --failure "Why the card was refused (compensation)"

{
  "name": "era__retail__detach_gift_card",
  "arguments": {
    "id": "ORDER_GIFT_CARD_ID",
    "failure": "Why the card was refused (compensation)"
  }
}

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

retail.duplicate_order

Yeniden sipariş ver — Aynı müşteri, adresler ve satırlarla, bugünün kanal fiyatlarından yeni bir taslak.

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

• Asıl adres: POST /api/v1/actions/retail.duplicate_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.draft_order_created, retail.order_lines_changed, retail.order_discounts_applied

Neye yazar: sales_order (insert) — Writes the new draft; sales_order_line (insert) — Copies the lines at today’s prices; sales_order_discount (insert) — Records what applies to the new draft

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.draft_order_created",
    "retail.order_lines_changed",
    "retail.order_discounts_applied"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.duplicateOrder("ORDER_ID")

era orders duplicate_order ORDER_ID

{
  "name": "era__retail__duplicate_order",
  "arguments": {
    "id": "ORDER_ID"
  }
}

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

retail.end_preorder

Ön siparişi bitir — Mallar geldi: her ön sipariş raftaki gerçek bir ayırmaya dönüşür — hepsi ya da hiçbiri.

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

• Asıl adres: POST /api/v1/actions/retail.end_preorder

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.preorder_ended, retail.stock_low

Neye yazar: preorder_allocation (delete) — Releases the preorders; variant_preorder (delete) — Ends the preorder; allocation (insert) — Promises the shelf instead; stock (update) — Raises the allocated count

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.preorder_ended",
    "retail.stock_low"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.allocations.endPreorder({
  itemVariantId: "ITEM_VARIANT_ID"
})

era allocations end_preorder \
  --item-variant-id "ITEM_VARIANT_ID"

{
  "name": "era__retail__end_preorder",
  "arguments": {
    "itemVariantId": "ITEM_VARIANT_ID"
  }
}

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

retail.expire_order

Onaylanmamış siparişi düşür — Otomatik: mağaza taraması, zamanında onaylanmamış siparişi stoğu ve kuponuyla bırakır.

Gereken izin retail:handle · siler ya da geri alınamaz

• Asıl adres: POST /api/v1/actions/retail.expire_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.order_expired

Neye yazar: sales_order (update) — Marks it expired; allocation (delete) — Releases the stock it held; stock (update) — Lowers the allocated count

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.order_expired"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.orders.expireOrder("ORDER_ID")

era orders expire_order ORDER_ID

{
  "name": "era__retail__expire_order",
  "arguments": {
    "id": "ORDER_ID"
  }
}

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

retail.expire_stock_reservations

Süresi dolan stok ayırmalarını bırak — Sistem işlemi: on beş dakikadan eski ödeme stok ayırmalarını serbest bırakır.

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

• Asıl adres: POST /api/v1/actions/retail.expire_stock_reservations

Girdi

Bu işlem girdi almaz.

Yayımladığı olaylar: retail.stock_reservations_expired

Neye yazar: stock_reservation (update) — Marks expired claims released

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.stock_reservations_expired"
  ]
}

import { createEra } from "@getera/sdk"

const era = createEra({ apiKey: process.env.ERA_API_KEY })
const res = await era.stockReservations.expireStockReservations()

era stock_reservations expire_stock_reservations

{
  "name": "era__retail__expire_stock_reservations",
  "arguments": {}
}

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

retail.fulfil_order

Siparişi gönder — Mallar belirli bir raftan çıkar. Sayı gerçekten burada düşer.

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

• Asıl adres: POST /api/v1/actions/retail.fulfil_order

Girdi

Ön koşullar

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

Yayımladığı olaylar: retail.fulfilment_created, retail.customer_notification_requested, retail.stock_low

Neye yazar: fulfilment (insert) — Records the despatch; fulfilment_line (insert) — Records which shelf each line left from; stock (update) — Lowers the count and the allocation; sales_order_line (update) — Raises quantity_fulfilled; sales_order (update) — Settles the order status

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

{
  "ok": true,
  "result": "…",
  "events": [
    "retail.fulfilment_created",
    "retail.customer_notification_requested",
    "retail.stock_low"
  ]
}