Dokumentacja REST API systemu Imker

https://{your-subdomain}.salescrm.pl/api/v1/

curl -H "X-API-KEY: your-api-key" \
  https://your-shop.salescrm.pl/api/v1/products

{
  "data": [...],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 100,
    "total_pages": 4
  }
}

{
  "error": "Unprocessable Entity",
  "errors": {
    "name": ["can't be blank"]
  }
}

{
  "data": [
    {
      "id": 1,
      "name": "E-book: Marketing",
      "sku": "EBOOK1",
      "price": "49.99",
      "vat_rate": 23,
      "active": true,
      "electronic": true,
      "distribution": "normal",
      "description": "<p>Opis produktu...</p>",
      "description_for_cart": "Krótki opis w koszyku",
      "category": "E-booki",
      "category_id": 5,
      "ean": null,
      "producer": "Imker",
      "invoice_item_name": "E-book Marketing",
      "pkwiu": null,
      "product_link": "https://example.com/product",
      "gtu_code": null,
      "regular_price_displayed": "69.99",
      "allow_price_change": false,
      "minimal_price": null,
      "allow_zero_minimal_price": false,
      "delivery_type_ids": [1, 3],
      "payment_type_ids": [2, 5],
      "cart_quantity_limit": null,
      "lump_code": "8.5",
      "product_category_ids": [12, 15],
      "feed_category_id": null,
      "photo_url": "https://twoj-sklep.salescrm.pl/rails/active_storage/...",
      "hide_in_xmls": false,
      "no_invoice": false,
      "hide_invoice_address_fields": false,
      "payment_return_url": null,
      "created_at": "2026-01-15T10:30:00Z",
      "updated_at": "2026-02-20T14:15:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

curl -H "X-API-KEY: your-key" \
  https://your-shop.salescrm.pl/api/v1/products/1

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"name":"New Product","price":"49.99","vat_rate":"23","active":true}' \
  https://your-shop.salescrm.pl/api/v1/products

curl -X PATCH \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"price":"59.99","active":false}' \
  https://your-shop.salescrm.pl/api/v1/products/1

{
  "data": {
    "id": 1,
    "deleted": false,
    "hidden": true,
    "message": "Product has orders and was hidden instead of deleted"
  }
}

{
  "data": [
    {
      "id": 1,
      "code": "LATO20",
      "name": "Letnia promocja",
      "discount_type": "percentage_discount",
      "value": "20.0",
      "case_sensitive": false,
      "minimum_amount": "50.0",
      "usages_limit": 100,
      "usages_per_customer_limit": 1,
      "usages": 42,
      "active": true,
      "start_date": "2026-06-01T00:00:00Z",
      "end_date": "2026-08-31T23:59:59Z",
      "combine_with_other_discount": true,
      "relation_with_products": "all_products",
      "product_ids": [],
      "product_category_ids": [],
      "relation_with_delivery_types": "all_delivery_types",
      "delivery_type_ids": [],
      "created_at": "2026-05-15T10:00:00Z",
      "updated_at": "2026-05-15T10:00:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

curl -H "X-API-KEY: your-key" \
  https://your-shop.salescrm.pl/api/v1/discount_codes/1

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"code":"LATO20","discount_type":"percentage_discount","value":"20","usages_limit":100}' \
  https://your-shop.salescrm.pl/api/v1/discount_codes

curl -X PATCH \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"value":"25","usages_limit":200}' \
  https://your-shop.salescrm.pl/api/v1/discount_codes/1

{
  "data": {
    "id": 1,
    "deleted": true
  }
}

{
  "data": [
    {
      "id": 4412,
      "kind": "normal",
      "content_title": null,
      "days_to_expire": 365,
      "usages_to_expire": 5,
      "watermark": "Egzemplarz dla {{IMIE}} {{NAZWISKO}}",
      "watermark_interval": 1,
      "distribute_via_sales_cas": false,
      "file": {
        "filename": "poradnik.pdf",
        "content_type": "application/pdf",
        "byte_size": 2481232
      },
      "created_at": "2026-08-05T22:30:00+02:00"
    }
  ]
}

curl -X POST "https://twoj-sklep.salescrm.pl/api/v1/products/18245/electronic_contents" \
  -H "X-API-KEY: TWOJ_KLUCZ" \
  -H "Content-Type: application/json" \
  -d '{
        "days_to_expire": 365,
        "usages_to_expire": 5,
        "watermark": "Egzemplarz dla {{IMIE}} {{NAZWISKO}}",
        "file": {
          "filename": "poradnik.pdf",
          "content_type": "application/pdf",
          "data": "JVBERi0xLjQK..."
        }
      }'

{
  "data": [
    {
      "id": 12,
      "name": "Pula 48h - newsletter",
      "activate_on_draw": true,
      "codes_total": 1000,
      "codes_drawn": 10,
      "codes_remaining": 990,
      "created_at": "2026-08-05T14:00:00+02:00"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

curl -X POST "https://twoj-sklep.salescrm.pl/api/v1/discount_code_pools/12/draw" \
  -H "X-API-KEY: TWOJ_KLUCZ" \
  -H "Content-Type: application/json" \
  -d '{"count": 1, "validity_hours": 48}'

{
  "data": [
    {
      "id": 84213,
      "code": "K7QM4XPB",
      "valid_from": "2026-08-05T14:12:00+02:00",
      "valid_until": "2026-08-07T14:12:00+02:00"
    }
  ]
}

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{
        "email": "ala@example.com",
        "discount_type": "unit_price_discount",
        "value": "99",
        "relation_with_products": "all_products"
      }' \
  https://your-shop.salescrm.pl/api/v1/email_address_discounts

{
  "data": {
    "id": 12,
    "discount_type": "unit_price_discount",
    "value": "99.0",
    "value_description": "99,00 zł / szt.",
    "usages_limit": null,
    "usages": 0,
    "active": true,
    "relation_with_products": "all_products",
    "product_ids": [],
    "product_category_ids": [],
    "email": "ala@example.com",
    "start_date": null,
    "end_date": null,
    "created_at": "2026-08-07T09:00:00Z",
    "updated_at": "2026-08-07T09:00:00Z"
  }
}

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{
        "email_domain": "firma.pl",
        "discount_type": "unit_price_discount",
        "value": "99",
        "relation_with_products": "all_products"
      }' \
  https://your-shop.salescrm.pl/api/v1/email_domain_discounts

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{
        "discount_type": "value_discount",
        "value": "20",
        "minimum_order_value": "100",
        "relation_with_products": "all_products"
      }' \
  https://your-shop.salescrm.pl/api/v1/newsletter_discounts

curl -X POST \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{
        "start_date": "2026-09-01T00:00:00Z",
        "end_date": "2026-09-07T23:59:59Z",
        "discount_type": "unit_price_discount",
        "value": "99",
        "relation_with_products": "all_products"
      }' \
  https://your-shop.salescrm.pl/api/v1/time_limited_discounts

{
  "data": [
    {
      "id": 7,
      "name": "Upsell e-booków",
      "title": "Dobierz do zamówienia",
      "subtitle": null,
      "active": true,
      "items": [
        {
          "id": 21,
          "product_id": 123,
          "product_name": "E-book – Metoda X",
          "title": null,
          "subtitle": null,
          "priority": 1,
          "invokes_recommendation": true,
          "is_recommended": true
        }
      ],
      "created_at": "2026-07-21T10:00:00Z",
      "updated_at": "2026-07-21T10:00:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

{
  "product_recommendation_group": {
    "name": "Upsell e-booków",
    "title": "Dobierz do zamówienia",
    "active": true,
    "items": [
      { "product_id": 123, "priority": 1, "invokes_recommendation": true, "is_recommended": true }
    ]
  }
}

{
  "data": [
    {
      "id": 4,
      "name": "Wybierz 3 książki",
      "slug": "wybierz-3-ksiazki",
      "price": "209.0",
      "active": true,
      "priority": 40,
      "auto_calculate_prices": true,
      "link_only_discount": false,
      "pool_mode": true,
      "pool_pick_count": 3,
      "custom_payment_types": false,
      "payment_type_ids": [],
      "expose_in_feeds": false,
      "feed_description": null,
      "ean": null,
      "google_product_category": null,
      "producer": null,
      "product_category_id": null,
      "items": [
        { "id": 11, "product_id": 123, "product_name": "Książka A", "quantity": 1, "custom_price": null },
        { "id": 12, "product_id": 124, "product_name": "Książka B", "quantity": 1, "custom_price": null }
      ],
      "created_at": "2026-08-04T10:00:00Z",
      "updated_at": "2026-08-04T10:00:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

{
  "product_set": {
    "name": "Wybierz 3 książki",
    "price": 209,
    "priority": 40,
    "pool_mode": true,
    "pool_pick_count": 3,
    "link_only_discount": false,
    "items": [
      { "product_id": 123 },
      { "product_id": 124 },
      { "product_id": 125 },
      { "product_id": 126 }
    ]
  }
}

{
  "data": [
    {
      "id": 3,
      "name": "Klub miesięczny",
      "automatic_renewal": true,
      "extension_strategy": "continuous",
      "free_delivery_minimum_amount": "0.0",
      "superseded_subscription_plan_id": null,
      "send_email_about_activation": false,
      "send_email_about_renewal": false,
      "send_email_about_expiration_in_one_day": true,
      "send_email_about_expiration_in_one_week": true,
      "products": [
        {
          "product_id": 123,
          "product_name": "Klub – dostęp miesięczny",
          "interval": 30,
          "renewals_limit": 0
        }
      ],
      "created_at": "2026-07-21T10:00:00Z",
      "updated_at": "2026-07-21T10:00:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

{
  "subscription_plan": {
    "name": "Klub miesięczny",
    "automatic_renewal": true,
    "extension_strategy": "continuous",
    "products": [
      { "product_id": 123, "interval": 30, "renewals_limit": 12 }
    ]
  }
}

curl -X PATCH "https://twojsklep.salescrm.pl/api/v1/subscribers/123" \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"renewal_items": [{"product_id": 19}]}'

{
  "data": [
    {
      "id": 42,
      "uuid": "9f8a2c1e-...-b7d4",
      "ordinal_number": "2026/03/001",
      "internal_status": "placed",
      "order_status": "Nowe",
      "order_status_id": 1,
      "email": "jan@example.com",
      "total": "149.99",
      "currency": "PLN",
      "paid": true,
      "delivery_method": "Kurier DPD",
      "placed_at": "2026-03-01T14:30:00Z",
      "created_at": "2026-03-01T14:25:00Z",
      "updated_at": "2026-03-01T14:30:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 25, "total": 1, "total_pages": 1 }
}

{
  "data": {
    "id": 42,
    "ordinal_number": "2026/03/001",
    "internal_status": "placed",
    "order_status": "Nowe",
    "order_status_id": 1,
    "email": "jan@example.com",
    "total": "149.99",
    "currency": "PLN",
    "paid": true,
    "delivery_method": "Kurier DPD",
    "placed_at": "2026-03-01T14:30:00Z",
    "products_cost": "129.99",
    "delivery_cost": "15.00",
    "delivery_vat_rate": 23,
    "payment_cost": "5.00",
    "payment_vat_rate": 23,
    "gift_packing_cost": "0.0",
    "total_discount": "0.0",
    "discount_code": "",
    "cash_on_delivery": false,
    "comment": "Proszę o szybką wysyłkę",
    "delivery_point_code": null,
    "tracking_number": "DPD123456",
    "tracking_url": "https://tracktrace.dpd.com.pl/parcelDetails?p1=DPD123456",
    "items": [
      {
        "id": 101,
        "product_id": 1,
        "name": "E-book: Marketing",
        "sku": "EBOOK1",
        "quantity": 1,
        "unit_price": "49.99",
        "vat_rate": 23,
        "price": "49.99",
        "discount": "0.0",
        "final_price": "49.99"
      }
    ],
    "delivery_address": {
      "first_name": "Jan",
      "last_name": "Kowalski",
      "company": null,
      "nip": null,
      "address": "ul. Główna 1",
      "postcode": "00-001",
      "city": "Warszawa",
      "country": "PL",
      "phone": "+48123456789",
      "email": "jan@example.com"
    },
    "invoice_address": {
      "first_name": "Jan",
      "last_name": "Kowalski",
      "company": "Firma Sp. z o.o.",
      "nip": "1234567890",
      "address": "ul. Firmowa 10",
      "postcode": "00-002",
      "city": "Warszawa",
      "country": "PL",
      "phone": "+48123456789",
      "email": "jan@example.com"
    },
    "invoice_recipient_name": "Szkoła Podstawowa nr 1",
    "order_attributes": [
      { "name": "Dedykacja", "value": "Dla Ani" }
    ],
    "notes": [
      { "content": "Klient prosił o fakturę z innym adresem", "created_at": "2026-03-01T15:00:00Z" },
      { "content": "Faktura wysłana mailem", "created_at": "2026-03-02T09:30:00Z" }
    ]
  }
}

curl -X PATCH \
  -H "X-API-KEY: your-key" \
  -H "Content-Type: application/json" \
  -d '{"order_status_id": 5}' \
  https://your-shop.salescrm.pl/api/v1/orders/42/status

curl -X PATCH \
  -H "X-API-KEY: your-key" \
  https://your-shop.salescrm.pl/api/v1/orders/42/clear

{
  "data": {
    "id": 42,
    "ordinal_number": "2026/04/001",
    "internal_status": "placed",
    "order_status": "Nowe",
    "email": "jan@example.com",
    "total": "149.99",
    "currency": "PLN",
    "paid": true,
    "cleared_at": "2026-04-22T10:30:00Z",
    "delivery_method": "Kurier DPD",
    "placed_at": "2026-04-20T14:30:00Z",
    "created_at": "2026-04-20T14:25:00Z",
    "updated_at": "2026-04-22T10:30:00Z"
  }
}

{
  "error": "Already Cleared",
  "message": "Zamówienie jest już rozliczone."
}

{
  "data": {
    "order_id": 1024,
    "reset_codes": [
      {
        "id": 55,
        "file_name": "ebook.pdf",
        "link": "https://your-shop.salescrm.pl/electronic_contents/download/abc123",
        "usages": 0,
        "usages_to_expire": 5
      }
    ]
  }
}

GET /api/v1/reports/sales?date_from=2026-04-01&date_to=2026-04-30

{
  "data": {
    "date_from": "2026-04-01",
    "date_to": "2026-04-30",
    "currency": "PLN",
    "total_revenue": "12450.00",
    "orders_count": 187,
    "paid_revenue": "10300.00",
    "paid_orders_count": 154,
    "avg_order_value": "66.58"
  }
}

GET /api/v1/reports/sales?date_from=2026-04-01&date_to=2026-04-30&group_by=day&product_id=42

{
  "data": {
    "date_from": "2026-04-01",
    "date_to": "2026-04-30",
    "currency": "PLN",
    "total_revenue": "3200.00",
    "orders_count": 64,
    "paid_revenue": "2950.00",
    "paid_orders_count": 59,
    "avg_order_value": "50.00",
    "buckets": [
      { "date": "2026-04-01", "orders_count": 3, "total_revenue": "150.00" },
      { "date": "2026-04-02", "orders_count": 5, "total_revenue": "275.00" }
    ]
  }
}

{
  "data": {
    "date_from": "2026-04-01",
    "date_to": "2026-04-30",
    "currency": "PLN",
    "total_paid": "10300.00",
    "count": 154,
    "by_payment_type": [
      { "payment_type": "Tpay - BLIK", "count": 92, "amount": "5800.00" },
      { "payment_type": "Tpay - karta", "count": 41, "amount": "3200.00" },
      { "payment_type": "Pobranie", "count": 21, "amount": "1300.00" }
    ]
  }
}

{
  "data": [
    {
      "id": 1,
      "name": "InPost Kurier",
      "name_displayed": "Kurier InPost",
      "default_price": "14.99",
      "vat_rate": 23
    }
  ]
}

{
  "data": [
    {
      "id": 3,
      "name": "Tpay",
      "name_displayed": "Przelew online",
      "default_price": "0.0",
      "vat_rate": 23,
      "cash_on_delivery": false
    }
  ]
}

{
  "data": [
    { "id": 1, "name": "Nowe" },
    { "id": 2, "name": "W realizacji" },
    { "id": 3, "name": "Wysłane" }
  ]
}

{
  "data": [
    { "id": 5, "name": "Elektronika", "parent_id": null },
    { "id": 12, "name": "Smartfony", "parent_id": 5 }
  ]
}