Customer Import Format

This section describes how to provide customer data to the import service.

{ 
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$ref": "#/definitions/customerSchema", 
  "definitions": { 
     "customerSchema": { 
       "type": "object", 
       "properties": { 
         "customers": { 
           "type": "array", 
           "items": { 
             "type": "object", 
             "properties": { 
               "customerId": { "type": "string", "minLength": 1 }, 
               "email": { "type": "string", "format": "email" }, 
               "firstName": { "type": "string" }, 
               "lastName": { "type": "string" } 
             }, 
             "required": ["customerId", "email", "firstName", "lastName"], 
             "additionalProperties": false 
           }, 
           "minItems": 1, 
           "description": "A list of customers" 
         }
       }, 
       "required": ["customers"], 
       "additionalProperties": false 
     }
  } 
}

Field Descriptions

• customerId - the customer ID from the merchant platform, as used when providing subscription data.

• email - the customer's email address.

• firstName - the customer's first name.

• lastName - the customer's last name (provide an empty string if none present).

Example

{
  "customers": [
    { 
      "customerId": "xxxx-yyyy-zzzz", 
      "email": "name@example.com", 
      "firstName": "Xyz", 
      "lastName": "Zyx" 
    },
    { 
      "customerId": "aaaa-bbbb-cccc", 
      "email": "other@example.com", 
      "firstName": "Abc", 
      "lastName": "Cba" 
    }
  ]
}

Additional requirements

• The customer ID must match the customer ID for at least one order.