v1

latestOpenAPI 3.1.02026-07-241120379.1 KB

Read customer details

This endpoint allows you to retrieve detailed information about a specific customer, including subscriptions, payment methods, and addresses.

get/2023-10/customer/{customerShopifyId}

Path parameters

customerShopifyIdinteger required

The unique identifier of the customer in Shopify, used to fetch their detailed information.

Response

200

successboolean

messagestring

codestring

{"stackTrail":"paths:/2023-10/customer/{customerShopifyId}:get:responses:200:content:application/json:schema:properties:pageInfo","oasType":"schema","type":"unknown"}

Example response

{
  "success": true,
  "message": "Customer fetched successfully",
  "data": {
    "id": 31068806,
    "customerShopifyId": 7523851698491,
    "firstName": "Mohit",
    "lastName": "Gulati",
    "fullName": "Mohit Gulati",
    "email": "mohit.gulati@loopwork.co",
    "activeSubscriptions": 8,
    "pausedSubscriptions": 4,
    "cancelledSubscriptions": 46,
    "expiredSubscriptions": 9,
    "paymentMethods": [
      {
        "id": 1197767,
        "type": "CustomerCreditCard",
        "card": {
          "brand": "visa",
          "expiryYear": 28,
          "expiryMonth": 1,
          "lastDigits": "4242"
        },
        "status": "safe",
        "source": "Credit card (Primary gateway)"
      }
    ],
    "addresses": [
      {
        "id": 14945239,
        "lastName": "Gulati",
        "address1": "123 William Street",
        "city": "New York",
        "province": "New York",
        "country": "United States",
        "zip": "10038",
        "provinceCode": "NY",
        "countryCode": "US"
      }
    ]
  },
  "code": "SUCCESS"
}