Přejít na obsah
Dokumentace

Události objednávek

Poprvé uložené objednávky a uložené objednávky, které se změnily.

order.placed

Odesílá se, když Emailit poprvé uloží objednávku: z endpointu Vytvoření nebo úprava objednávky, z měřicího skriptu nebo z endpointu Hromadný import objednávek s historical nastaveným na false. Historické importy ji neodesílají. Stejná událost může spustit automatizaci. Viz E-commerce.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy order.placed.

objectobject

Objednávka, které se událost týká. Její pole jsou uvedena níže.

data.objectobject

Stejný objekt ještě jednou, v podobě, v jaké ho vrací API událostí v poli data.

Objekt objednávky

Stejný objekt, jaký vrací Načtení objednávky.

idstring

ID objednávky (ord_…).

objectstring

Vždy order.

external_idstring

ID objednávky ve vašem obchodě.

contact_idstring | null

Kontakt kupujícího (con_…), nebo null.

emailstring | null

Kontaktní e-mail kupujícího, malými písmeny.

statusstring

placed, paid, fulfilled, canceled nebo refunded.

currencystring

Třípísmenný kód ISO 4217 měny částek.

subtotal, discount, shipping, taxnumber | null

Částky objednávky, nebo null, když nebyly odeslány.

totalnumber

Celková částka objednávky.

refunded_amountnumber

Dosud vrácená částka.

coupon_codesstring[]

Kupony nebo slevové kódy použité v objednávce.

cart_idstring | null

ID košíku nebo pokladny ve vašem obchodě, ze kterého objednávka vznikla.

sourcestring

api, js (měřicí skript) nebo import.

placed_atstring

Kdy byla objednávka zadána, ve formátu ISO 8601 v UTC.

paid_at, fulfilled_at, canceled_at, refunded_atstring | null

Kdy měla objednávka v Emailitu daný stav poprvé.

attributionobject | null

Kampaňový nebo automatizační e-mail, kterému je objednávka připsaná, nebo null: email_id, campaign_id, campaign_name, variant_id, automation_id, automation_name, type (click, nebo open) a touched_at. Viz Jak se objednávky připisují e-mailům.

itemsobject[]

Položky objednávky, každá s product_id, variant_id, sku, title, quantity, unit_price, total, categories, url a image_url.

metadataobject

Vaše vlastní data z objednávky ve tvaru dvojic klíč–hodnota.

created_at, updated_atstring

Kdy Emailit objednávku uložil a kdy se naposledy změnila, ve formátu ISO 8601 v UTC.

JSON
{
  "event_id": "evt_381an2bijq9dF40JdqYLuJT43Z4",
  "type": "order.placed",
  "object": {
    "object": "order",
    "id": "ord_3aMEK4No62Zw8S1fcHNznAnnbfp",
    "external_id": "1042",
    "contact_id": "con_3EwrXnu9OaQWlfI1AyPUUEoYjQs",
    "email": "ada@example.com",
    "status": "paid",
    "currency": "USD",
    "subtotal": 107,
    "discount": 10.7,
    "shipping": 5,
    "tax": 0,
    "total": 101.3,
    "refunded_amount": 0,
    "coupon_codes": [
      "WELCOME-7KQ2M9XA"
    ],
    "cart_id": "c-58f1a2",
    "source": "api",
    "placed_at": "2026-10-08T14:32:10.000Z",
    "paid_at": "2026-10-08T14:32:11.204Z",
    "fulfilled_at": null,
    "canceled_at": null,
    "refunded_at": null,
    "attribution": {
      "email_id": "eml_3TSvDAUQi7vqxvAQ1UEVN7k4igq",
      "campaign_id": "cmp_3zNrBaNjAoPK1l0IL2GQ3pDkubN",
      "campaign_name": "October newsletter",
      "variant_id": null,
      "automation_id": null,
      "automation_name": null,
      "type": "click",
      "touched_at": "2026-10-08T09:41:52.000Z"
    },
    "items": [
      {
        "product_id": "8123456789",
        "variant_id": "42-blue",
        "sku": "TRS-BLU-42",
        "title": "Trail running shoe",
        "quantity": 1,
        "unit_price": 89,
        "total": 89,
        "categories": [
          "Shoes",
          "Running"
        ],
        "url": "https://shop.example.com/products/trail-running-shoe",
        "image_url": "https://shop.example.com/images/trail-running-shoe.jpg"
      }
    ],
    "metadata": {
      "channel": "web"
    },
    "created_at": "2026-10-08T14:32:11.204Z",
    "updated_at": "2026-10-08T14:32:11.204Z"
  },
  "data": {
    "object": {
      "object": "order",
      "id": "ord_3aMEK4No62Zw8S1fcHNznAnnbfp",
      "external_id": "1042",
      "contact_id": "con_3EwrXnu9OaQWlfI1AyPUUEoYjQs",
      "email": "ada@example.com",
      "status": "paid",
      "currency": "USD",
      "subtotal": 107,
      "discount": 10.7,
      "shipping": 5,
      "tax": 0,
      "total": 101.3,
      "refunded_amount": 0,
      "coupon_codes": [
        "WELCOME-7KQ2M9XA"
      ],
      "cart_id": "c-58f1a2",
      "source": "api",
      "placed_at": "2026-10-08T14:32:10.000Z",
      "paid_at": "2026-10-08T14:32:11.204Z",
      "fulfilled_at": null,
      "canceled_at": null,
      "refunded_at": null,
      "attribution": {
        "email_id": "eml_3TSvDAUQi7vqxvAQ1UEVN7k4igq",
        "campaign_id": "cmp_3zNrBaNjAoPK1l0IL2GQ3pDkubN",
        "campaign_name": "October newsletter",
        "variant_id": null,
        "automation_id": null,
        "automation_name": null,
        "type": "click",
        "touched_at": "2026-10-08T09:41:52.000Z"
      },
      "items": [
        {
          "product_id": "8123456789",
          "variant_id": "42-blue",
          "sku": "TRS-BLU-42",
          "title": "Trail running shoe",
          "quantity": 1,
          "unit_price": 89,
          "total": 89,
          "categories": [
            "Shoes",
            "Running"
          ],
          "url": "https://shop.example.com/products/trail-running-shoe",
          "image_url": "https://shop.example.com/images/trail-running-shoe.jpg"
        }
      ],
      "metadata": {
        "channel": "web"
      },
      "created_at": "2026-10-08T14:32:11.204Z",
      "updated_at": "2026-10-08T14:32:11.204Z"
    }
  }
}

order.updated

Odesílá se, když se změní objednávka, kterou Emailit už uložil:

Když se změnil stav, událost obsahuje také previous_status.

Požadavky webhooků obsahují pole JSON s událostmi, jako je tato; viz Požadavky webhooků.

Pole

event_idstring

ID události (evt_…). Opakovaný požadavek nese stejné ID, takže podle něj můžete přeskočit události, které jste už zpracovali. Událost můžete také dohledat přes endpoint Načtení události.

typestring

Vždy order.updated.

objectobject

Objednávka po změně. Má stejná pole jako v order.placed a v Načtení objednávky.

previous_statusstring

Stav objednávky před změnou. Uvádí se, jen pokud se stav změnil. Je vedle object, ne uvnitř.

dataobject

object a previous_status ještě jednou, v podobě, v jaké je vrací API událostí v poli data.

JSON
{
  "event_id": "evt_3sRH2D1JwRBeo2uyN9p2NM4VX3i",
  "type": "order.updated",
  "object": {
    "object": "order",
    "id": "ord_3aMEK4No62Zw8S1fcHNznAnnbfp",
    "external_id": "1042",
    "contact_id": "con_3EwrXnu9OaQWlfI1AyPUUEoYjQs",
    "email": "ada@example.com",
    "status": "fulfilled",
    "currency": "USD",
    "subtotal": 107,
    "discount": 10.7,
    "shipping": 5,
    "tax": 0,
    "total": 101.3,
    "refunded_amount": 0,
    "coupon_codes": [
      "WELCOME-7KQ2M9XA"
    ],
    "cart_id": "c-58f1a2",
    "source": "api",
    "placed_at": "2026-10-08T14:32:10.000Z",
    "paid_at": "2026-10-08T14:32:11.204Z",
    "fulfilled_at": "2026-10-09T11:05:43.019Z",
    "canceled_at": null,
    "refunded_at": null,
    "attribution": {
      "email_id": "eml_3TSvDAUQi7vqxvAQ1UEVN7k4igq",
      "campaign_id": "cmp_3zNrBaNjAoPK1l0IL2GQ3pDkubN",
      "campaign_name": "October newsletter",
      "variant_id": null,
      "automation_id": null,
      "automation_name": null,
      "type": "click",
      "touched_at": "2026-10-08T09:41:52.000Z"
    },
    "items": [
      {
        "product_id": "8123456789",
        "variant_id": "42-blue",
        "sku": "TRS-BLU-42",
        "title": "Trail running shoe",
        "quantity": 1,
        "unit_price": 89,
        "total": 89,
        "categories": [
          "Shoes",
          "Running"
        ],
        "url": "https://shop.example.com/products/trail-running-shoe",
        "image_url": "https://shop.example.com/images/trail-running-shoe.jpg"
      }
    ],
    "metadata": {
      "channel": "web"
    },
    "created_at": "2026-10-08T14:32:11.204Z",
    "updated_at": "2026-10-09T11:05:43.019Z"
  },
  "previous_status": "paid",
  "data": {
    "object": {
      "object": "order",
      "id": "ord_3aMEK4No62Zw8S1fcHNznAnnbfp",
      "external_id": "1042",
      "contact_id": "con_3EwrXnu9OaQWlfI1AyPUUEoYjQs",
      "email": "ada@example.com",
      "status": "fulfilled",
      "currency": "USD",
      "subtotal": 107,
      "discount": 10.7,
      "shipping": 5,
      "tax": 0,
      "total": 101.3,
      "refunded_amount": 0,
      "coupon_codes": [
        "WELCOME-7KQ2M9XA"
      ],
      "cart_id": "c-58f1a2",
      "source": "api",
      "placed_at": "2026-10-08T14:32:10.000Z",
      "paid_at": "2026-10-08T14:32:11.204Z",
      "fulfilled_at": "2026-10-09T11:05:43.019Z",
      "canceled_at": null,
      "refunded_at": null,
      "attribution": {
        "email_id": "eml_3TSvDAUQi7vqxvAQ1UEVN7k4igq",
        "campaign_id": "cmp_3zNrBaNjAoPK1l0IL2GQ3pDkubN",
        "campaign_name": "October newsletter",
        "variant_id": null,
        "automation_id": null,
        "automation_name": null,
        "type": "click",
        "touched_at": "2026-10-08T09:41:52.000Z"
      },
      "items": [
        {
          "product_id": "8123456789",
          "variant_id": "42-blue",
          "sku": "TRS-BLU-42",
          "title": "Trail running shoe",
          "quantity": 1,
          "unit_price": 89,
          "total": 89,
          "categories": [
            "Shoes",
            "Running"
          ],
          "url": "https://shop.example.com/products/trail-running-shoe",
          "image_url": "https://shop.example.com/images/trail-running-shoe.jpg"
        }
      ],
      "metadata": {
        "channel": "web"
      },
      "created_at": "2026-10-08T14:32:11.204Z",
      "updated_at": "2026-10-09T11:05:43.019Z"
    },
    "previous_status": "paid"
  }
}

Byla tato stránka užitečná?

Děkujeme za zpětnou vazbu.

Děkujeme, čteme každou zprávu.

Esc

Oblíbené

↑↓procházet↵otevřítEsczavřít