Seznam datových modelů

Jaroslav Bouška Jaroslav Bouška
29. března 2023

ContactDataModel

{
    "contactId": 123,
    "guid": "4e19a13d-cab0-467b-8776-423eaee61f2b",
    "email": "example@example.com",
    "mobilePhone": "555-555-5555",
    "name": "John",
    "surname": "Doe",
    "title": "Mr.",
    "street": "123 Main St",
    "city": "Anytown",
    "zip": "12345",
    "sex": 1,
    "company": "Acme Inc.",
    "mujUzivatelskySloupec": "vase hodnota",
    "oblibenaKapela": "Red Hot Chili Peppers",
}

ProductFeedItemModel

{
  "productFeedItemId": 601126,
  "dataSourceId": 72,
  "itemExternalId": "653901",
  "itemGroupId": null,
  "name": "Kuchyně ",
  "description": "",
  "url": "",
  "imgUrl": "",
  "category": "3D Vizualizace",
  "price": 46999,
  "oldPrice": null,
  "manufacturer": "Nábytek",
  "availability": null,
  "delivery": null,
  "created": "2023-04-01T04:14:28.347Z",
  "updated": "2023-04-01T04:14:28.347Z",
  "priceSaleText": null,
  "customFields": {},
  "currency": null,
  "accessoryIds": null
}

RssFeedItem

{
  "title": "Název článku",
  "description": "Popis článku",
  "creator": "Autor",
  "url": "https://boldem.cz/",
  "externalGuid": null,
  "created": "2023-04-01T04:14:28.347Z"
}

OrderModel

{
    "orderId": 123,
    "cartId": 456,
    "orderExternalId": "ORD-1234",
    "email": "test@example.com",
    "phone": "1234567890",
    "price": 100.00,
    "priceVat": 120.00,
    "currency": 1,
    "status": "completed",
    "payment": "paypal",
    "shipping": "fedex",
    "created": "2023-03-31T09:00:00.0000000Z",
    "delivered": "2023-04-03T09:00:00.0000000Z",
    "createdExternal": "2023-03-24T09:00:00.0000000Z",
    "customFields": {
        "customField1": "value1",
        "customField2": "value2",
        "customField3": null,
        "customField4": null,
        "customField5": null
    },
    "orderItems": [
        {
            "orderItemId": 1,
            "orderId": 123,
            "externalId": "ITEM-123",
            "variant": "variant1",
            "quantity": 2,
            "name": "Item 1",
            "price": 50.00,
            "priceVat": 60.00,
            "manufacturer": "Manufacturer 1",
            "category": "Category 1",
            "url": "http://example.com/item1",
            "imageUrl": "http://example.com/item2/image",
            "customFields": {
                "customField1": "value1",
                "customField2": "value2",
                "customField3": "value3",
                "customField4": "value4",
                "customField5": "value5"
            }
        }
    ]
}

CartModel

{
    "cartId": 123,
    "orderId": 456,
    "email": "example@example.com",
    "phone": "123-456-7890",
    "price": 99.99,
    "priceVat": 119.99,
    "currency": 1,
    "created": "2023-03-31T12:00:00Z",
    "completed": null,
    "customFields": {
        "customField1": "value1",
        "customField2": "value2",
        "customField3": "value3",
        "customField4": "value4",
        "customField5": "value5"
    },
    "cartItems": [
        {
            "cartItemId": 1,
            "cartId": 123,
            "externalId": "item1",
            "variant": "variant1",
            "quantity": 2,
            "name": "Item 1",
            "price": 19.99,
            "priceVat": 23.99,
            "manufacturer": "Manufacturer 1",
            "category": "Category 1",
            "url": "http://example.com/item1",
            "imageUrl": "http://example.com/item1/image",
            "customFields": {
                "customField1": "value1",
                "customField2": "value2",
                "customField3": "value3",
                "customField4": "value4",
                "customField5": "value5"
            }
        }
    ]
}

CustomWebEventModel

{
  "customWebEventId": 123,
  "email": "example@example.com",
  "name": "Example name",
  "data": {
        "customField1": "value1",
        "customField2": "value2",
        "customField3": "value3",
        "customField4": "value4",
        "customField5": "value5",
        ......
    },
  "created": "2023-03-31T12:00:00Z",
}

AutomationStateDateModel

{
  "triggerBlockId": 123,
  "triggerMailingListId": 456,
  "orderId": 789,
  "customWebEventId": 1011,
  "cartId": 1213,
  "isTest": true,
  "contactConfirmed": "2023-04-20T09:30:00Z",
  "customEventData": "some custom data",
  "url": "https://www.example.com",
  "pageViewId": 1415,
  "sentEmails": {
    "1": "email1@example.com",
    "2": "email2@example.com"
  },
  "sentSms": {
    "1": "1234567890",
    "2": "0987654321"
  },
  "customData": {
    "key1": "value1",
    "key2": 123,
    "key3": true
  },
  "orderStatusNew": "processing"
}

CouponLastUsedModel

{
    "couponId": 0,
    "couponGroupId": null,
    "coupon": "string",
    "created": "2022-01-20T09:30:00Z",
    "validity": "2023-04-20T09:30:00Z",
    "used": "2023-04-20T09:30:00Z",
    "itemId": 150,
    "deleted": null,
    "to": "string",
    "generatorExecutionId": null,
    "itemGuid": "4e19a13d-cab0-467b-8776-423eaee61f2b",
    "messageType": 1,
    "applied": "2023-04-20T09:30:00Z"
}

ShoptetOrderModel

{
    "code": "ORDER001",
    "guid": "123e4567-e89b-12d3-a456-426614174000",
    "externalCode": "EXT001",
    "created": "2024-05-17T10:00:00",
    "updated": "2024-05-17T12:00:00",
    "email": "customer@example.com",
    "phone": "+123456789",
    "vatPayer": true,
    "customerGuid": "789e4567-e89b-12d3-a456-426614174000",
    "addressesEqual": true,
    "cashDeskOrder": false,
    "paid": null,
    "onlinePaymentLink": "http://example.com/pay",
    "language": "EN",
    "priceWithoutVat": "1000.00",
    "priceWitVat": "1200.00",
    "billingMethod": {
        "name": "Bank Transfer",
        "id": 1
    },
    "billingAddress": {
        "company": null,
        "fullName": "John Doe",
        "street": "123 Billing St",
        "houseNumber": "10",
        "city": "Billing City",
        "district": "Central",
        "additional": "Apartment 1A",
        "zip": "12345",
        "countryCode": "US",
        "regionName": "California",
        "regionShortcut": "CA",
        "companyId": "COMP001",
        "taxId": "TAX001",
        "vatId": "VAT001",
        "vatIdValidationStatus": "Valid"
    },
    "deliveryAddress": {
        "company": "Example Corp",
        "fullName": "Jane Smith",
        "street": "456 Delivery Ave",
        "houseNumber": "20",
        "city": "Delivery City",
        "district": "North",
        "additional": "Suite 2B",
        "zip": "67890",
        "countryCode": "US",
        "regionName": "New York",
        "regionShortcut": "NY"
    },
    "paymentMethod": {
        "guid": "890e4567-e89b-12d3-a456-426614174000",
        "name": "Credit Card"
    },
    "shipping": {
        "guid": "567e4567-e89b-12d3-a456-426614174000",
        "name": "Standard Shipping"
    },
    "items": [
        {
            "productGuid": "234e4567-e89b-12d3-a456-426614174000",
            "code": "PROD001",
            "itemType": "product",
            "name": "Example Product",
            "variantName": "Example Variant",
            "ean": "1234567890123",
            "brand": "Example Brand",
            "supplierName": "Example Supplier",
            "remark": "This is a remark.",
            "additionalField": "Additional info",
            "amount": 10.5,
            "amountUnit": "kg",
            "url": "http://example.com/product",
            "imgUrl": "http://example.com/product.jpg",
            "priceWithoutVat": 100.0,
            "priceWitVat": 120.0,
            "unitPriceWithoutVat": 10.0,
            "unitPriceWitVat": 12.0
        }
    ]
}