Admin APICustomers
Get a customer
The customer record: profile, lifecycle stage, first-touch acquisition,
saved addresses, the 50 most recent timeline entries and the 50 most
recent orders with their payment method and shipments. To find the
customer of an order, read the order's customer_id.
Authorization
bearer_auth AuthorizationBearer <token>
Authorization: Bearer <token>. Either a session access token from POST /auth/login (refresh it with POST /auth/refresh) or a store API token (mobi_st_…). A store API token works only for the store it was issued in, and can do at most what its issuing user can there, narrowed to the scopes it was issued with.
In: header
Path Parameters
store_id*string
Store id
Format
uuidcustomer_id*string
Customer id
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"acquisition": {},
"company": "string",
"created_at": "2019-08-24T14:15:22Z",
"date_of_birth": "2019-08-24",
"document": "string",
"email": "string",
"email_verified": true,
"first_name": "string",
"gender": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"last_login_at": "2019-08-24T14:15:22Z",
"last_name": "string",
"last_order_at": "2019-08-24T14:15:22Z",
"lifecycle": "new",
"marketing_opt_in": true,
"notes": "string",
"phone": "string",
"phone_verified": true,
"store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
"tags": [
"string"
],
"total_orders": 0,
"total_spent": 0,
"updated_at": "2019-08-24T14:15:22Z",
"addresses": [
{
"address_line_1": "string",
"address_line_2": "string",
"address_type": "string",
"city": "string",
"company": "string",
"country": "string",
"created_at": "2019-08-24T14:15:22Z",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default": true,
"last_name": "string",
"phone": "string",
"postal_code": "string",
"state": "string",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"orders": [
{
"created_at": "2019-08-24T14:15:22Z",
"currency": "string",
"danfe_url": "string",
"fulfillment_method": "string",
"fulfillment_status": null,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"nfe_number": "string",
"number": "string",
"payer_document": "string",
"payment_method": null,
"payment_status": null,
"shipments": [
{
"carrier_name": "string",
"delivered_at": "2019-08-24T14:15:22Z",
"freight_external_order_code": "string",
"status": "draft",
"tracking_code": "string",
"tracking_events": [
{
"comment": "string",
"datetime": "string",
"event": "string",
"occurred_at": "2019-08-24T14:15:22Z"
}
]
}
],
"status": "draft",
"total_cents": 0
}
],
"recent_interactions": [
{
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"description": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"interaction_type": "string",
"is_private": true,
"metadata": {},
"title": "string"
}
]
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}