Customer Export API

The Customer Export API allows an outside CRM to pull in data for all customers that have been added after a certain date.

Customer Data Format

CODE

{
    "Customers": [
        {
            "Key": "",
            "PairValue": {
                "CustomerFirstName": "Ronnie",
                "CustomerLastName": "Onin",
                "CustomerGender": "Male",
                "CustomerNotes": "",
                "CustomerID": 0,
                "CustomerStoreID": 0,
                "CustomerKey": "",
                "CustomerBirthDate": "1994-09-13 00:00:00",
                "CustomerSpouseBirthDate": "1994-09-13 00:00:00",
                "CustomerWeddingAnniv": null,
                "Addresses": [
                    {
                        "Key": "Billing",
                        "PairValue": {
                            "AddressCustKey": "",
                            "AddressType": "Billing",
                            "AddressCompany": "Punchmark",
                            "AddressStreet": "1805 Sardis Rd",
                            "AddressStreet2": "Ste 140",
                            "AddressCity": "Charlotte",
                            "AddressState": "NC",
                            "AddressZip": "28270",
                            "AddressCountry": "United States"
                        }
                    },
                    {
                        "Key": "Shipping",
                        "PairValue": {
                            "AddressCustKey": "",
                            "AddressType": "Shipping",
                            "AddressCompany": "Punchmark",
                            "AddressStreet": "1805 Sardis Rd North",
                            "AddressStreet2": "Ste 140",
                            "AddressCity": "Charlotte",
                            "AddressState": "NC",
                            "AddressZip": "28270",
                            "AddressCountry": "United States"
                        }
                    }
                ],
                "Emails": [
                    {
                        "Key": "PMarkLogin",
                        "PairValue": {
                            "EmailType": "PMarkLogin",
                            "EmailEmail": "chewwyrocks@gmail.com"
                        }
                    }
                ],
                "Phones": [
                    {
                        "Key": "Billing",
                        "PairValue": {
                            "PhoneCustKey": "",
                            "PhoneType": "Billing",
                            "PhonePhone": "7049804774",
                            "PhoneCustAccountKey": ""
                        }
                    },
                    {
                        "Key": "Shipping",
                        "PairValue": {
                            "PhoneCustKey": "",
                            "PhoneType": "Shipping",
                            "PhonePhone": "9807044774",
                            "PhoneCustAccountKey": ""
                        }
                    }
                ],
                "CustomerPrefEmail": "PMarkLogin",
                "CustomerTransfer": {
                    "WebTransferWebID": "customer-100"
                }
            }
        }, ...
    ]
}

Endpoint

https://{WEBSITE_DOMAIN}/api/async.php?t=user&m=customer&a=export_edt_customer_data&authKey={AUTH_KEY}

Note that this API keeps a record of the last time it was used, so that you don't have to pass in a lastExported query string. Every time you hit this API, it will give you all the records since the last time you called it.

Reset Endpoint

Because you'll need to test with this data, we've provided an API for you to reset the internal date, so that you can get the full results again:

https://{WEBSITE_DOMAIN}/api/async.php?t=user&m=customer&a=reset_edt_customer_data&authKey={AUTH_KEY}