Advanced administration

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 organizations 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 Use workflows to import data.

{
  "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"
  }
}

API payload examples

Kustomer's API documentation is an extensive resource around many of the API calls you can leverage to manage your Kustomer data. While the payloads may be different depending on the type of call you are looking to make, you can view the data structure of different API calls as a reference for creating different types of integrations with other systems you may use internally. 

To view these example payloads:

1. Go to our API documentation to a specific API call that you want to learn more about how the data is structured. In this example, we can use our GET call for conversation information.

2. Once on the next page, select the ‘200’ number within the Response section in the right-hand column.

This will display a JSON example for a successful call to this API endpoint. You can use that information to understand the structure of how your data will look when Kustomer is communicating with your other systems.