ACME Developers

TABLE OF CONTENTS

• List Customers
• Advanced Search
• Get Customer (By Import ID)
• Get Customer (By ID)
• Update Customer (By ID)
• Customer Object

List Customers

GET /v2/b2b/customers

List all customers matching the search criteria. The search looks for matching names or emails. When the search criteria is null, it returns all the customers.

Input

• search:  Optional. The string(s) you are looking for. 
• page: Optional. The page that you want returned, default is 1.
• pageSize: Optional. The number of items you want returned in a  page. Default is 100.
• sortField: Optional. The filed that you want to sort by 
• updatedAfter: Optional, ISO8601 date string, Only returns customers that were updated after the specified date.
• ignoreMyUpdates: Optional, boolean, defaults to false. When set to true, ignores the customers that were last updated by the current user.
• includeAddress: Optional, boolean, defaults to false. When set to true, include customer address in the response.
• includeAttrs: Optional, boolean, default to false. When set to true, include customer attrs if available. 

Returns

a paginated list of Customer objects. A sample paginated list response is attached below.

Sample Request:

https://sand10-api.acmeticketing.net/v2/b2b/customers?updatedAfter=2016-04-31T00:00:00Z&ignoreMyUpdates=false

HEADERS:

x-acme-session: XXXX
x-acme-api-version: 1
Content-Type: application/json

Advanced Search

GET /v2/b2b/customers/advancedsearch

List all customers matching the search criteria. The search looks for matching names or emails. When the search criteria is null, it returns all the customers.

Input

• page: Optional. The page that you want returned, default is 1.
• pageSize: Optional. The number of items you want returned in a  page.  Default is 100.
• sortField: Optional. The filed that you want to sort by 
• sortDirection: Optional 
• firstName: Optional
• lastName: Optional
• email: Optional
• phone: Optional
• address: Optional
• zip: Optional

Returns

a paginated list of Customer objects. A sample paginated list response is attached below.

Note: Doesn't include customer Attributes

Sample Request:

https://sand10-api.acmeticketing.net/v2/b2b/customers/advancedsearch?pageSize=50&page=1&sortField=createdOn&sortDirection=desc&firstName=Daario

Sample Response: 

Get Customer (By Import ID)

GET /v2/b2b/customers/external/{importId}

Get a customer. Tenant specific.

Input

• importId, Path variable. String, the customer import Id.
• includeAssociatedMemberships. optional. boolean. When set to true, includes all associated memberships for this customer.

Returns

The customer object.

Note: Doesn't include customer Attributes

Get Customer (By ID)

GET /v2/b2b/customers/{id}

Get a customer. Tenant specific.

Input

Returns: The customer object.

* Available with the 11.37.0 Release in July 2024

Update Customer (By ID)

PUT /v2/b2b/customers

To make a brand *new* customer with this API, then you must send:

firstName

lastName

and one of email, phoneNumber, address

and do *NOT* send a value for id, customerId, or externalCustomerId

To update an existing customer, then you must send:

externalCustomerImportId

Be very careful with this API. If ACME has a value for a field and you do not send it in the API call, then ACME will remove whatever value we previously had. For example, if the Customer has an email but in the PUT API call, the email is not included, then ACME will remove the email on the Customer Record.

Example Payload:

{
    "id":7239363,
    "firstName":"Comet",
    "lastName":"Bright",
    "email":"comet@bright.com",
    "phoneNumber":"33998585",
    "externalCustomerImportId":"ACME202559303",
    "address":[
        {
            "id":19154531,
            "streetAddress1":"9383 W 34th St",
            "city":"Philadelphia",
            "state":"Pennsylvania",
            "zipCode":"83898",
            "country":"United States",
            "type":"primary",
            "isPrimary":true
        }
    ]
}

{
    "id": 15722551,
    "customerSource": "acme",
    "customerId": "281240759",
    "externalCustomerImportId": "ACME202559303",
    "email": "comet@bright.com",
    "firstName": "Comet",
    "lastName": "Bright",
    "phoneNumber": "33998585",
    "solicitationCodes": [],
    "address": [],
    "attributes": [],
    "version": 1,
    "createdOn": "2024-08-13T17:49:33-07:00",
    "updatedOn": "2024-08-14T08:48:21-07:00",
    "updatedBy": 340,
    "obfuscated": false
}

Customer Object