Skip to content

Latest commit

 

History

History
56 lines (46 loc) · 1.47 KB

retrieve-customer-response.md

File metadata and controls

56 lines (46 loc) · 1.47 KB
Raw

Retrieve Customer Response

Defines the fields that are included in the response body of a request to the RetrieveCustomer endpoint.

Either errors or customer is present in a given response (never both).

Structure

RetrieveCustomerResponse

Fields

Name Type Tags Description
errors Error[] | undefined Optional Any errors that occurred during the request.
customer Customer | undefined Optional Represents a Square customer profile in the Customer Directory of a Square seller.

Example (as JSON)

{
  "customer": {
    "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": "2016-03-23T20:21:54.859Z",
    "creation_source": "THIRD_PARTY",
    "email_address": "[email protected]",
    "family_name": "Earhart",
    "given_name": "Amelia",
    "group_ids": [
      "545AXB44B4XXWMVQ4W8SBT3HHF"
    ],
    "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
    "note": "a customer",
    "phone_number": "1-212-555-4240",
    "preferences": {
      "email_unsubscribed": false
    },
    "reference_id": "YOUR_REFERENCE_ID",
    "segment_ids": [
      "1KB9JE5EGJXCW.REACHABLE"
    ],
    "updated_at": "2016-03-23T20:21:54.859Z",
    "version": 1
  }
}