whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
square
/
square
/
doc
/
models
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/square/square/doc/models/search-customers-response.md
# Search Customers Response Defines the fields that are included in the response body of a request to the `SearchCustomers` endpoint. Either `errors` or `customers` is present in a given response (never both). ## Structure `SearchCustomersResponse` ## Fields | Name | Type | Tags | Description | Getter | Setter | | --- | --- | --- | --- | --- | --- | | `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void | | `customers` | [`?(Customer[])`](../../doc/models/customer.md) | Optional | The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`).<br>Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`)<br>are included in the response. | getCustomers(): ?array | setCustomers(?array customers): void | | `cursor` | `?string` | Optional | A pagination cursor that can be used during subsequent calls<br>to `SearchCustomers` to retrieve the next set of results associated<br>with the original query. Pagination cursors are only present when<br>a request succeeds and additional results are available.<br><br>For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void | | `count` | `?int` | Optional | The total count of customers associated with the Square account that match the search query. Only customer profiles with<br>public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is<br>present only if `count` is set to `true` in the request. | getCount(): ?int | setCount(?int count): void | ## Example (as JSON) ```json { "cursor": "9dpS093Uy12AzeE", "customers": [ { "address": { "address_line_1": "505 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003" }, "created_at": "2018-01-23T20:21:54.859Z", "creation_source": "DIRECTORY", "email_address": "james.bond@example.com", "family_name": "Bond", "given_name": "James", "group_ids": [ "545AXB44B4XXWMVQ4W8SBT3HHF" ], "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4", "phone_number": "+1-212-555-4250", "preferences": { "email_unsubscribed": false }, "reference_id": "YOUR_REFERENCE_ID_2", "segment_ids": [ "1KB9JE5EGJXCW.REACHABLE" ], "updated_at": "2020-04-20T10:02:43.083Z", "version": 7, "cards": [ { "id": "id0", "card_brand": "DISCOVER", "last_4": "last_42", "exp_month": 146, "exp_year": 186 }, { "id": "id1", "card_brand": "DISCOVER_DINERS", "last_4": "last_43", "exp_month": 147, "exp_year": 187 } ] }, { "address": { "address_line_1": "500 Electric Ave", "address_line_2": "Suite 600", "administrative_district_level_1": "NY", "country": "US", "locality": "New York", "postal_code": "10003" }, "created_at": "2018-01-30T14:10:54.859Z", "creation_source": "THIRD_PARTY", "email_address": "amelia.earhart@example.com", "family_name": "Earhart", "given_name": "Amelia", "group_ids": [ "545AXB44B4XXWMVQ4W8SBT3HHF" ], "id": "A9641GZW2H7Z56YYSD41Q12HDW", "note": "a customer", "phone_number": "+1-212-555-9238", "preferences": { "email_unsubscribed": false }, "reference_id": "YOUR_REFERENCE_ID_1", "segment_ids": [ "1KB9JE5EGJXCW.REACHABLE" ], "updated_at": "2018-03-08T18:25:21.342Z", "version": 1, "cards": [ { "id": "id1", "card_brand": "DISCOVER_DINERS", "last_4": "last_43", "exp_month": 147, "exp_year": 187 }, { "id": "id2", "card_brand": "JCB", "last_4": "last_44", "exp_month": 148, "exp_year": 188 }, { "id": "id3", "card_brand": "CHINA_UNIONPAY", "last_4": "last_45", "exp_month": 149, "exp_year": 189 } ] } ], "errors": [ { "category": "REFUND_ERROR", "code": "MERCHANT_SUBSCRIPTION_NOT_FOUND", "detail": "detail1", "field": "field9" }, { "category": "MERCHANT_SUBSCRIPTION_ERROR", "code": "BAD_REQUEST", "detail": "detail2", "field": "field0" }, { "category": "EXTERNAL_VENDOR_ERROR", "code": "MISSING_REQUIRED_PARAMETER", "detail": "detail3", "field": "field1" } ], "count": 60 } ```
Copyright ©2021 || Defacer Indonesia