shipmentCustomerPhone

Requires permission sales:sales_order:ship.

Returns the phone number a booking falls back to: the shipping address phone, then the order's mobile, then the customer's contact. Give exactly one of salesOrderId or productReturnId. Null when there is none. Needs the delivery partners feature on your plan and the sales order ship permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ShipmentCustomerPhone {
  shipmentCustomerPhone
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShipmentCustomerPhone {\n  shipmentCustomerPhone\n}"
}
EOF

Response:

{
  "data": {
    "shipmentCustomerPhone": "string"
  }
}

shipmentCustomerPhone(
  productReturnId: ID
  salesOrderId: ID
): String

Arguments

shipmentCustomerPhone.productReturnId ● ID scalar

The ID of the product return, for a pickup.

shipmentCustomerPhone.salesOrderId ● ID scalar

The ID of the sales order, for a delivery.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.