Customer Data Type

End customer who placed a production order. Contains contact details, shipping address, and customer identification.

Available Since
1.3.0
Properties
Name Type Description
id number A unique identifier for the customer.
firstName string The customer's first name.
lastName string The customer's last name.
email string The email address of the customer.
phone string The phone number (E.164 format) for this customer.
acceptsMarketing boolean Whether the customer has consented to receive marketing material via email.
billingAddress Address The mailing address associated with the payment method.
shippingAddress Address The mailing address to where the order will be shipped.
Customer (JSON) 
{
  "customer" : {
    "id" : 12345,
    "firstName" : "John",
    "lastName" : "Doe",
    "email" : "john.doe@emailservice.com",
    "phone" : "+44208269323",
    "acceptsMarketing" : true,
    "billingAddress" : {
      "id" : 12345,
      "street" : "Golborne Road",
      "streetNo" : "45",
      "address2" : "...",
      "city" : "London",
      "company" : "...",
      "country" : "United Kingdom",
      "firstName" : "John",
      "lastName" : "Doe",
      "latitude" : 45.41685,
      "longitude" : -71.6822,
      "name" : "John Doe",
      "phone" : "+44208269323",
      "email" : "john.doe@emailservice.com",
      "province" : "...",
      "zip" : "WC2N 5DU",
      "countryCode" : "UK",
      "provinceCode" : "...",
      "stateCode" : "CA",
      "stateName" : "California"
    },
    "shippingAddress" : {
      "id" : 12345,
      "street" : "Golborne Road",
      "streetNo" : "45",
      "address2" : "...",
      "city" : "London",
      "company" : "...",
      "country" : "United Kingdom",
      "firstName" : "John",
      "lastName" : "Doe",
      "latitude" : 45.41685,
      "longitude" : -71.6822,
      "name" : "John Doe",
      "phone" : "+44208269323",
      "email" : "john.doe@emailservice.com",
      "province" : "...",
      "zip" : "WC2N 5DU",
      "countryCode" : "UK",
      "provinceCode" : "...",
      "stateCode" : "CA",
      "stateName" : "California"
    }
  }
}
Customer Data Type

End customer who placed a production order. Contains contact details, shipping address, and customer identification.

Available Since
1.3.0
Properties
Name Type Description
acceptsMarketing boolean Whether the customer has consented to receive marketing material via email.
billingAddress Address The mailing address associated with the payment method.
email string The email address of the customer.
firstName string The customer's first name.
id int A unique identifier for the customer.
lastName string The customer's last name.
phone string The phone number (E.164 format) for this customer.
shippingAddress Address The mailing address to where the order will be shipped.
Customer (XML) 
<customer>
  <id>...</id>
  <firstName>John</firstName>
  <lastName>Doe</lastName>
  <email>john.doe@emailservice.com</email>
  <phone>+44208269323</phone>
  <acceptsMarketing>...</acceptsMarketing>
  <billingAddress>
    <id>...</id>
    <street>Golborne Road</street>
    <streetNo>45</streetNo>
    <address2>...</address2>
    <city>London</city>
    <company>...</company>
    <country>United Kingdom</country>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <latitude>45.41685</latitude>
    <longitude>-71.6822</longitude>
    <name>John Doe</name>
    <phone>+44208269323</phone>
    <email>john.doe@emailservice.com</email>
    <province>...</province>
    <zip>WC2N 5DU</zip>
    <countryCode>UK</countryCode>
    <provinceCode>...</provinceCode>
    <stateCode>CA</stateCode>
    <stateName>California</stateName>
  </billingAddress>
  <shippingAddress>
    <id>...</id>
    <street>Golborne Road</street>
    <streetNo>45</streetNo>
    <address2>...</address2>
    <city>London</city>
    <company>...</company>
    <country>United Kingdom</country>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <latitude>45.41685</latitude>
    <longitude>-71.6822</longitude>
    <name>John Doe</name>
    <phone>+44208269323</phone>
    <email>john.doe@emailservice.com</email>
    <province>...</province>
    <zip>WC2N 5DU</zip>
    <countryCode>UK</countryCode>
    <provinceCode>...</provinceCode>
    <stateCode>CA</stateCode>
    <stateName>California</stateName>
  </shippingAddress>
</customer>