See related
No related articles

Data payload examples

Last Update: Oct 2024 • Est. Read Time: 2 MIN
To check plan availability, see the pricing page.

Here are some JSON data payload examples for an order ingest or data connection, with comments for each section. Feel free to use this as a reference when sending in data payloads to a Kustomer webhook.

These example payloads are some suggestions based on what we've seen orgs use in past implementations. We offer these as a frame of reference to help you see how other organizations set up Kustomer, and may not be 100% accurate or relevant to your Kustomer setup. Your payload does not have to include all of these attributes, or match the same attribute names.

To learn more about importing data into Kustomer, please check out our help articles on Data Connect and Using Workflows to import data.

Notes:

  • Always ensure the object has a unique identifier order_number.
  • Include an attribute for customer information, as this is needed to associate an order to the appropriate customer timeline.
  • These examples include /* inline comments */ to illustrate functionality. You should remove these in production.
{
  "order_number": "AB-1234",
  "created_at": "2019-05-04T05:47:31+10:00",
  "status": "received",
  /* section for order customer information */
  "customer": {
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "janedoe@example.com",
    "phone": "(555) 555-1234"
  },
  /* section for order shipping information */
  "shipping": {
    "address": {
      "address1": "123 Main St",
      "address2": "Apt 4",
      "city": "Houston",
      "state": "TX",
      "country_code": "US",
      "zip": "77001"
    },
    "method": {
      "description": "Fast Shipping",
      "carrier": "FedEx",
      "carrier_code": "FDEG"
    }
  },
  /* section for order billing information (if applicable) */
  "billing_address": {
    "address1": "123 Main St",
    "address2": "Apt 4",
    "city": "Houston",
    "state": "TX",
    "country_code": "US",
    "zip": "77001"
  },
  /* section for order items */
  "line_items": [{
      "sku": "1234-01",
      "item_name": "Test-Item",
      "sku_name": "Test-Item-Sku",
      "quantity": 1,
      "weight": 1,
      "sale_price": 9.99,
      "subtotal": 0,
      "sales_tax_collected": 0
    },
    {
      "sku": "1234-02",
      "item_name": "Test-Item 2",
      "sku_name": "Test-Item-Sku-2",
      "quantity": 1,
      "weight": 1,
      "sale_price": 9.99,
      "subtotal": 0,
      "sales_tax_collected": 0
    }
  ],
  /* section for order cost information (if applicable) */
  "totals": {
    "items": 19.98,
    "shipping": 11.98,
    "additional shipping": 0,
    "tax": 4.04,
    "grand": 36
  },
  /* section for order payment details (if applicable) */
  "payment_details": {
    "brand": "Visa",
    "last_4": "1234",
    "status": "successful"
  }
}