Customers

const customersApi = client.customersApi;

Class Name

CustomersApi

Methods

List Customers
Create Customer
Bulk Create Customers
Bulk Delete Customers
Bulk Retrieve Customers
Bulk Update Customers
Search Customers
Delete Customer
Retrieve Customer
Update Customer
Create Customer Card
Delete Customer Card
Remove Group From Customer
Add Group to Customer

List Customers

Lists customer profiles associated with a Square account.

Under normal operating conditions, newly created or updated customer profiles become available for the listing operation in well under 30 seconds. Occasionally, propagation of the new or updated profiles can take closer to one minute or longer, especially during network incidents and outages.

async listCustomers(  cursor?: string,
  limit?: number,
  sortField?: string,
  sortOrder?: string,
  count?: boolean,
requestOptions?: RequestOptions): Promise<ApiResponse<ListCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`cursor`	`string \| undefined`	Query, Optional	A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see Pagination.
`limit`	`number \| undefined`	Query, Optional	The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results. If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100. For more information, see Pagination.
`sortField`	`string \| undefined`	Query, Optional	Indicates how customers should be sorted. The default value is `DEFAULT`.
`sortOrder`	`string \| undefined`	Query, Optional	Indicates whether customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. The default value is `ASC`.
`count`	`boolean \| undefined`	Query, Optional	Indicates whether to return the total count of customers in the `count` field of the response. The default value is `false`. Default: `false`
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

ListCustomersResponse

Example Usage

const count = false;

try {
  const { result, ...httpResponse } = await customersApi.listCustomers(
  undefined,
  undefined,
  undefined,
  undefined,
  count
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Create Customer

Creates a new customer for a business.

You must provide at least one of the following values in your request to this endpoint:

given_name
family_name
company_name
email_address
phone_number

async createCustomer(  body: CreateCustomerRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<CreateCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`CreateCustomerRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

CreateCustomerResponse

Example Usage

const body: CreateCustomerRequest = {
  givenName: 'Amelia',
  familyName: 'Earhart',
  emailAddress: 'Amelia.Earhart@example.com',
  address: {
    addressLine1: '500 Electric Ave',
    addressLine2: 'Suite 600',
    locality: 'New York',
    administrativeDistrictLevel1: 'NY',
    postalCode: '10003',
    country: 'US',
  },
  phoneNumber: '+1-212-555-4240',
  referenceId: 'YOUR_REFERENCE_ID',
  note: 'a customer',
};

try {
  const { result, ...httpResponse } = await customersApi.createCustomer(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Bulk Create Customers

Creates multiple customer profiles for a business.

This endpoint takes a map of individual create requests and returns a map of responses.

You must provide at least one of the following values in each create request:

given_name
family_name
company_name
email_address
phone_number

async bulkCreateCustomers(  body: BulkCreateCustomersRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkCreateCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`BulkCreateCustomersRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

BulkCreateCustomersResponse

Example Usage

const body: BulkCreateCustomersRequest = {
  customers: {
    '8bb76c4f-e35d-4c5b-90de-1194cd9179f0': {
      givenName: 'Amelia',
      familyName: 'Earhart',
      emailAddress: 'Amelia.Earhart@example.com',
      address: {
        addressLine1: '500 Electric Ave',
        addressLine2: 'Suite 600',
        locality: 'New York',
        administrativeDistrictLevel1: 'NY',
        postalCode: '10003',
        country: 'US',
      },
      phoneNumber: '+1-212-555-4240',
      referenceId: 'YOUR_REFERENCE_ID',
      note: 'a customer',
    },
    'd1689f23-b25d-4932-b2f0-aed00f5e2029': {
      givenName: 'Marie',
      familyName: 'Curie',
      emailAddress: 'Marie.Curie@example.com',
      address: {
        addressLine1: '500 Electric Ave',
        addressLine2: 'Suite 601',
        locality: 'New York',
        administrativeDistrictLevel1: 'NY',
        postalCode: '10003',
        country: 'US',
      },
      phoneNumber: '+1-212-444-4240',
      referenceId: 'YOUR_REFERENCE_ID',
      note: 'another customer',
    }
  },
};

try {
  const { result, ...httpResponse } = await customersApi.bulkCreateCustomers(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Bulk Delete Customers

Deletes multiple customer profiles.

The endpoint takes a list of customer IDs and returns a map of responses.

async bulkDeleteCustomers(  body: BulkDeleteCustomersRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkDeleteCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`BulkDeleteCustomersRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

BulkDeleteCustomersResponse

Example Usage

const body: BulkDeleteCustomersRequest = {
  customerIds: [
    '8DDA5NZVBZFGAX0V3HPF81HHE0',
    'N18CPRVXR5214XPBBA6BZQWF3C',
    '2GYD7WNXF7BJZW1PMGNXZ3Y8M8'
  ],
};

try {
  const { result, ...httpResponse } = await customersApi.bulkDeleteCustomers(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Bulk Retrieve Customers

Retrieves multiple customer profiles.

This endpoint takes a list of customer IDs and returns a map of responses.

async bulkRetrieveCustomers(  body: BulkRetrieveCustomersRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkRetrieveCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`BulkRetrieveCustomersRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

BulkRetrieveCustomersResponse

Example Usage

const body: BulkRetrieveCustomersRequest = {
  customerIds: [
    '8DDA5NZVBZFGAX0V3HPF81HHE0',
    'N18CPRVXR5214XPBBA6BZQWF3C',
    '2GYD7WNXF7BJZW1PMGNXZ3Y8M8'
  ],
};

try {
  const { result, ...httpResponse } = await customersApi.bulkRetrieveCustomers(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Bulk Update Customers

Updates multiple customer profiles.

This endpoint takes a map of individual update requests and returns a map of responses.

You cannot use this endpoint to change cards on file. To make changes, use the Cards API or Gift Cards API.

async bulkUpdateCustomers(  body: BulkUpdateCustomersRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<BulkUpdateCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`BulkUpdateCustomersRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

BulkUpdateCustomersResponse

Example Usage

const body: BulkUpdateCustomersRequest = {
  customers: {
    '8DDA5NZVBZFGAX0V3HPF81HHE0': {
      emailAddress: 'New.Amelia.Earhart@example.com',
      phoneNumber: 'phone_number2',
      note: 'updated customer note',
      version: BigInt(2),
    },
    'N18CPRVXR5214XPBBA6BZQWF3C': {
      givenName: 'Marie',
      familyName: 'Curie',
      version: BigInt(0),
    }
  },
};

try {
  const { result, ...httpResponse } = await customersApi.bulkUpdateCustomers(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Search Customers

Searches the customer profiles associated with a Square account using one or more supported query filters.

Calling SearchCustomers without any explicit query filter returns all customer profiles ordered alphabetically based on given_name and family_name.

Under normal operating conditions, newly created or updated customer profiles become available for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated profiles can take closer to one minute or longer, especially during network incidents and outages.

async searchCustomers(  body: SearchCustomersRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<SearchCustomersResponse>>

Parameters

Parameter	Type	Tags	Description
`body`	`SearchCustomersRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

SearchCustomersResponse

Example Usage

const body: SearchCustomersRequest = {
  limit: BigInt(2),
  query: {
    filter: {
      creationSource: {
        values: [
          'THIRD_PARTY'
        ],
        rule: 'INCLUDE',
      },
      createdAt: {
        startAt: '2018-01-01T00:00:00-00:00',
        endAt: '2018-02-01T00:00:00-00:00',
      },
      emailAddress: {
        fuzzy: 'example.com',
      },
      groupIds: {
        all: [
          '545AXB44B4XXWMVQ4W8SBT3HHF'
        ],
      },
    },
    sort: {
      field: 'CREATED_AT',
      order: 'ASC',
    },
  },
};

try {
  const { result, ...httpResponse } = await customersApi.searchCustomers(body);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Delete Customer

Deletes a customer profile from a business. This operation also unlinks any associated cards on file.

To delete a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

async deleteCustomer(  customerId: string,
  version?: bigint,
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer to delete.
`version`	`bigint \| undefined`	Query, Optional	The current version of the customer profile. As a best practice, you should include this parameter to enable optimistic concurrency control. For more information, see Delete a customer profile.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

DeleteCustomerResponse

Example Usage

const customerId = 'customer_id8';

try {
  const { result, ...httpResponse } = await customersApi.deleteCustomer(customerId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Retrieve Customer

Returns details for a single customer.

async retrieveCustomer(  customerId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<RetrieveCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer to retrieve.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

RetrieveCustomerResponse

Example Usage

const customerId = 'customer_id8';

try {
  const { result, ...httpResponse } = await customersApi.retrieveCustomer(customerId);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Update Customer

Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are required in the request. To add or update a field, specify the new value. To remove a field, specify null.

To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

You cannot use this endpoint to change cards on file. To make changes, use the Cards API or Gift Cards API.

async updateCustomer(  customerId: string,
  body: UpdateCustomerRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<UpdateCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer to update.
`body`	`UpdateCustomerRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

UpdateCustomerResponse

Example Usage

const customerId = 'customer_id8';

const body: UpdateCustomerRequest = {
  emailAddress: 'New.Amelia.Earhart@example.com',
  phoneNumber: 'phone_number2',
  note: 'updated customer note',
  version: BigInt(2),
};

try {
  const { result, ...httpResponse } = await customersApi.updateCustomer(
  customerId,
  body
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Create Customer Card

This endpoint is deprecated.

Adds a card on file to an existing customer.

As with charges, calls to CreateCustomerCard are idempotent. Multiple calls with the same card nonce return the same card record that was created with the provided nonce during the first call.

async createCustomerCard(  customerId: string,
  body: CreateCustomerCardRequest,
requestOptions?: RequestOptions): Promise<ApiResponse<CreateCustomerCardResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The Square ID of the customer profile the card is linked to.
`body`	`CreateCustomerCardRequest`	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

CreateCustomerCardResponse

Example Usage

const customerId = 'customer_id8';

const body: CreateCustomerCardRequest = {
  cardNonce: 'YOUR_CARD_NONCE',
  billingAddress: {
    addressLine1: '500 Electric Ave',
    addressLine2: 'Suite 600',
    locality: 'New York',
    administrativeDistrictLevel1: 'NY',
    postalCode: '10003',
    country: 'US',
  },
  cardholderName: 'Amelia Earhart',
};

try {
  const { result, ...httpResponse } = await customersApi.createCustomerCard(
  customerId,
  body
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Delete Customer Card

This endpoint is deprecated.

Removes a card on file from a customer.

async deleteCustomerCard(  customerId: string,
  cardId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<DeleteCustomerCardResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer that the card on file belongs to.
`cardId`	`string`	Template, Required	The ID of the card on file to delete.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

DeleteCustomerCardResponse

Example Usage

const customerId = 'customer_id8';

const cardId = 'card_id4';

try {
  const { result, ...httpResponse } = await customersApi.deleteCustomerCard(
  customerId,
  cardId
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Remove Group From Customer

Removes a group membership from a customer.

The customer is identified by the customer_id value and the customer group is identified by the group_id value.

async removeGroupFromCustomer(  customerId: string,
  groupId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<RemoveGroupFromCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer to remove from the group.
`groupId`	`string`	Template, Required	The ID of the customer group to remove the customer from.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

RemoveGroupFromCustomerResponse

Example Usage

const customerId = 'customer_id8';

const groupId = 'group_id0';

try {
  const { result, ...httpResponse } = await customersApi.removeGroupFromCustomer(
  customerId,
  groupId
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Add Group to Customer

Adds a group membership to a customer.

The customer is identified by the customer_id value and the customer group is identified by the group_id value.

async addGroupToCustomer(  customerId: string,
  groupId: string,
requestOptions?: RequestOptions): Promise<ApiResponse<AddGroupToCustomerResponse>>

Parameters

Parameter	Type	Tags	Description
`customerId`	`string`	Template, Required	The ID of the customer to add to a group.
`groupId`	`string`	Template, Required	The ID of the customer group to add the customer to.
`requestOptions`	`RequestOptions \| undefined`	Optional	Pass additional request options.

Response Type

AddGroupToCustomerResponse

Example Usage

const customerId = 'customer_id8';

const groupId = 'group_id0';

try {
  const { result, ...httpResponse } = await customersApi.addGroupToCustomer(
  customerId,
  groupId
);
  // Get more response info...
  // const { statusCode, headers } = httpResponse;
} catch (error) {
  if (error instanceof ApiError) {
    const errors = error.result;
    // const { statusCode, headers } = error;
  }
}

Files

customers.md

Latest commit

History

customers.md

File metadata and controls

Customers

Class Name

Methods

List Customers

Parameters

Response Type

Example Usage

Create Customer

Parameters

Response Type

Example Usage

Bulk Create Customers

Parameters

Response Type

Example Usage

Bulk Delete Customers

Parameters

Response Type

Example Usage

Bulk Retrieve Customers

Parameters

Response Type

Example Usage

Bulk Update Customers

Parameters

Response Type

Example Usage

Search Customers

Parameters

Response Type

Example Usage

Delete Customer

Parameters

Response Type

Example Usage

Retrieve Customer

Parameters

Response Type

Example Usage

Update Customer

Parameters

Response Type

Example Usage

Create Customer Card

Parameters

Response Type

Example Usage

Delete Customer Card

Parameters

Response Type

Example Usage

Remove Group From Customer

Parameters

Response Type

Example Usage

Add Group to Customer

Parameters

Response Type

Example Usage