Integration API

Lista zamówień konta, od najnowszych. JSON jest taki sam jak GET dokumentu w EasyHub: positions.product wypełniony z katalogu, externalDocuments to pliki z kolekcji ExternalDocument (rollup ZK, bez zagnieżdżonych FA/WZ).

{
  "items": [
    {
      "_id": "6a6da0cd0ceabb38f6cade11",
      "id": "6a6da0cd0ceabb38f6cade11",
      "header": {
        "symbol": "ZK",
        "externalNumber": "SHOP-1001",
        "documentNumber": "ZK/2026/0001",
        "status": "new"
      },
      "positions": [],
      "externalDocuments": []
    }
  ]
}

curl -H "x-api-key: $API_KEY" \
  "https://integration-dev.ecommigo.com/v1/orders?limit=10"

Jedno zamówienie. {id} to identyfikator API, SHOP-1001 albo ZK/2026/0001. Odpowiedź jest zbliżona do dokumentu EasyHub: header, wypełniony positions.product, externalDocuments jako metadane plików (nie zagnieżdżone FA/WZ).

Odpowiedź 200

{
  "_id": "6adb5f26221a11a212042ad3",
  "id": "6adb5f26221a11a212042ad3",
  "header": {
    "symbol": "ZK",
    "externalNumber": "SHOP-1001",
    "documentNumber": "ZK/2026/0002",
    "status": "new",
    "customStatus": null
  },
  "contractor": { "name": "Acme Sp. z o.o.", "email": "ops@acme.test" },
  "payment": { "method": "bacs", "paid": false },
  "positions": [
    {
      "key": "a1b2c3d4",
      "name": "Sneakersy Beżowe 39",
      "sku": "SHBZ18835239",
      "quantity": 1,
      "price": 19.99,
      "product": {
        "_id": "6a6b4776a2ca9b8864f7645d",
        "id": "6a6b4776a2ca9b8864f7645d",
        "sku": "SHBZ18835239",
        "name": "Sneakersy Beżowe 39",
        "ean": "5901234567890"
      }
    }
  ],
  "customFields": [],
  "externalDocuments": [
    {
      "_id": "6adb5f26aaaa111122223333",
      "id": "6adb5f26aaaa111122223333",
      "documentNumber": "FA/2026/0012",
      "filename": "fa.pdf",
      "s3Url": "https://ecommigo-dev-private.s3.eu-central-1.amazonaws.com/fa.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900",
      "downloadUrl": "https://ecommigo-dev-private.s3.eu-central-1.amazonaws.com/fa.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900",
      "documentType": "invoice",
      "createdAt": "2026-01-02T00:00:00.000Z"
    }
  ],
  "logs": [],
  "createdAt": "2026-10-23T13:20:38.240Z",
  "updatedAt": "2026-10-23T13:20:38.240Z"
}

Tworzy zamówienie i nadaje documentNumber. Wymagane externalNumber. Ten sam numer przy ponownym POST zwraca istniejące zamówienie (200) zamiast tworzyć drugie.

Każda pozycja musi wskazywać produkt z katalogu: productId albo sku (ew. ean). Nieznany produkt → 400 unknown_product. Odpowiedź zwraca positions.product jako obiekt (id, sku, name, ean) oraz externalDocuments jako pliki ExternalDocument (bez zagnieżdżonego document).

{
  "externalNumber": "SHOP-1001",
  "status": "new",
  "contractor": {
    "name": "Acme Sp. z o.o.",
    "email": "ops@acme.test"
  },
  "payment": { "method": "bacs", "paid": false },
  "positions": [
    { "sku": "SHBZ18835239", "quantity": 2, "price": 19.99 }
  ],
  "customFields": [
    { "key": "source", "value": "shop" }
  ]
}

{
  "_id": "6adb5f26…",
  "id": "6adb5f26…",
  "header": { "symbol": "ZK", "externalNumber": "SHOP-1001", "documentNumber": "ZK/2026/0002", "status": "new" },
  "positions": [
    {
      "sku": "SHBZ18835239",
      "name": "Sneakersy Beżowe 39",
      "quantity": 2,
      "price": 19.99,
      "product": {
        "_id": "6a6b4776…",
        "id": "6a6b4776…",
        "sku": "SHBZ18835239",
        "name": "Sneakersy Beżowe 39",
        "ean": "5901234567890"
      }
    }
  ],
  "externalDocuments": []
}

Częściowa aktualizacja (status, płatność, pozycje, kontrahent, pola własne). Numer dokumentu i właściciel zamówienia się nie zmieniają.

Request

{
  "status": "paid",
  "payment": { "method": "bacs", "paid": true }
}

Usuwa zamówienie.

Odpowiedź 200

{ "deleted": true, "id": "SHOP-1001" }

Metody płatności konta. Pole payment.method na zamówieniu to key.

{
  "items": [
    {
      "id": "6a6b03e4…",
      "key": "bacs",
      "name": "Przelew tradycyjny",
      "isActive": true,
      "codAvailable": false
    }
  ]
}

Metody wysyłki. key wstawiasz jako metodę dostawy na zamówieniu.

{
  "items": [
    { "id": "…", "key": "inpost", "name": "InPost", "isActive": true, "iconUrl": null }
  ]
}

Statusy zdefiniowane na koncie. id możesz podać jako customStatus przy tworzeniu / aktualizacji.

Pola własne. Na zamówieniu: customFields: [{ "key", "value" }].