---
title: "CustomerPhoneNumber"
description: "A phone number."
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-phone-number'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-phone-number.md'
---
# CustomerPhoneNumber

A phone number.

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Object

## Type Signature

`CustomerPhoneNumber`

## Fields

* `marketingState`

  [CustomerSmsMarketingState](https://developer.shopline.com/docs/admin-graph-ql-api/customers/enums/customer-sms-marketing-state.md)

  Customer SMS subscription status

* `phoneNumber`

  [String](https://developer.shopline.com/docs/admin-graph-ql-api/common/scalars/string.md)

  
  Customer phone number

## Schema Definition

```graphql
type CustomerPhoneNumber { 
	marketingState: CustomerSmsMarketingState
	phoneNumber: String 
}
```

## Field from

* [CustomerMergePreviewDefaultFields](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-merge-preview-default-fields.md).phoneNumber

  Telephone information (including subscription information)

* [CustomerMergePreviewAlternateFields](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-merge-preview-alternate-fields.md).phoneNumber

  Customer phone number information

* [CustomerSegmentMember](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-segment-member.md).defaultPhoneNumber

  Customer default phone number

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).