API Integration

Access customer IDs via REST and GraphQL APIs.

REST API

Get Customer ID

GET /rest/V1/customers/{customerId}

Response includes:

{ "id": 123, "email": "customer@example.com", "custom_attributes": [ { "attribute_code": "customer_number", "value": "CUST-12345" } ] }

Search by Customer ID

GET /rest/V1/customers/search?searchCriteria[filter_groups][0][filters][0][field]=customer_number&searchCriteria[filter_groups][0][filters][0][value]=CUST-12345

Update Customer ID

PUT /rest/V1/customers/{customerId}
{ "customer": { "custom_attributes": [ { "attribute_code": "customer_number", "value": "CUST-99999" } ] } }

GraphQL

Query Customer

{ customer { customer_number email firstname lastname } }

ERP Integration

Common integration patterns:

  • Sync customer IDs to ERP
  • Import IDs from legacy system
  • Real-time ID lookup

Found an issue with this documentation? Let us know