Searching by customers as an agent assist

Last updated:
Edit on GitHub
You are browsing a previous version of the document. The latest version is 202212.0.

Search by customers to find out information about them. This endpoint is mostly used by agent assists to find out the customer reference needed to impersonate a customer.

Installation

For detailed information on the modules that provide the API functionality and related installation instructions, see:

Search by customers

To search by customers, send the request:

GET /agent-customer-search

Request

Header key Type Required Description
X-Agent-Authorization string ✓ String containing digits, letters, and symbols that authorize the agent assist. Authenticate as an agent assist to get the value.
String parameter Description Possible values
q The value to search for in the list of customers. If you enter a part of an email address, first name, or last name, the endpoint returns all the customer entries partially matching the search query. To search by a customer reference, enter full customer reference. {{customerEmail}}, {{firstName}}, {{customerReference}}, {{lastName}}
page[offset] The offset of the item at which to begin the response.
Works only together with page[limit].
To work correctly, the value should be devisable by the value of page[limit].
The default value is 0.		 From 0 to any.
page[limit] The maximum number of entries to return.
Works only together with page[offset].
The default value is 10.		 From 1 to any.
Request Usage
GET https://glue.mysprykershop.com/agent-customer-search Return the list of all customers.
GET https://glue.mysprykershop.com/agent-customer-search?page[limit]=5&page[offset]=5 Return a list of 5 customer entires starting from the 6th entry.
GET https://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com Search for the customer with the sonia@spryker.com email address.
GET https://glue.mysprykershop.com/agent-customer-search?q=spencor Search for the customer with the spencor name.
GET https://glue.mysprykershop.com/agent-customer-search?q=DE--5 Search for the customer with the DE--5 customer reference.

Response

Response sample 
{
    "data": [
        {
            "type": "agent-customer-search",
            "id": null,
            "attributes": {
                "customers": [
                    {
                        "customerReference": "DE--1",
                        "email": "spencor.hopkin@spryker.com",
                        "firstName": "Spencor",
                        "lastName": "Hopkin"
                    },
                    {
                        "customerReference": "DE--2",
                        "email": "maria.williams@spryker.com",
                        "firstName": "Maria",
                        "lastName": "Williams"
                    },
                    {
                        "customerReference": "DE--3",
                        "email": "maggie.may@spryker.com",
                        "firstName": "Maggie",
                        "lastName": "May"
                    },
                    {
                        "customerReference": "DE--4",
                        "email": "bill.martin@spryker.com",
                        "firstName": "Bill",
                        "lastName": "Martin"
                    },
                    {
                        "customerReference": "DE--5",
                        "email": "george.freeman@spryker.com",
                        "firstName": "George",
                        "lastName": "Freeman"
                    },
                    {
                        "customerReference": "DE--6",
                        "email": "henry.tudor@spryker.com",
                        "firstName": "Henry",
                        "lastName": "Tudor"
                    },
                    {
                        "customerReference": "DE--7",
                        "email": "anne.boleyn@spryker.com",
                        "firstName": "Anne",
                        "lastName": "Boleyn"
                    },
                    {
                        "customerReference": "DE--8",
                        "email": "andrew@ottom.de",
                        "firstName": "Andrew",
                        "lastName": "Wedner"
                    },
                    {
                        "customerReference": "DE--9",
                        "email": "Ahill@ottom.de",
                        "firstName": "Ahill",
                        "lastName": "Grant"
                    },
                    {
                        "customerReference": "DE--10",
                        "email": "Alexa@ottom.de",
                        "firstName": "Alexa",
                        "lastName": "Simons"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/agent-customer-search"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/agent-customer-search",
        "last": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=20&page[limit]=10",
        "first": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=10",
        "next": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=10"
    }
}
Response sample of search with page limit and page offset 
{
    "data": [
        {
            "type": "agent-customer-search",
            "id": null,
            "attributes": {
                "customers": [
                    {
                        "customerReference": "DE--6",
                        "email": "henry.tudor@spryker.com",
                        "firstName": "Henry",
                        "lastName": "Tudor"
                    },
                    {
                        "customerReference": "DE--7",
                        "email": "anne.boleyn@spryker.com",
                        "firstName": "Anne",
                        "lastName": "Boleyn"
                    },
                    {
                        "customerReference": "DE--8",
                        "email": "andrew@ottom.de",
                        "firstName": "Andrew",
                        "lastName": "Wedner"
                    },
                    {
                        "customerReference": "DE--9",
                        "email": "Ahill@ottom.de",
                        "firstName": "Ahill",
                        "lastName": "Grant"
                    },
                    {
                        "customerReference": "DE--10",
                        "email": "Alexa@ottom.de",
                        "firstName": "Alexa",
                        "lastName": "Simons"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=5&page[limit]=5",
        "last": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=25&page[limit]=5",
        "first": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5",
        "prev": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=0&page[limit]=5",
        "next": "https://glue.mysprykershop.com/agent-customer-search?page[offset]=10&page[limit]=5"
    }
}
Response sample of search by email address 
{
    "data": [
        {
            "type": "agent-customer-search",
            "id": null,
            "attributes": {
                "customers": [
                    {
                        "customerReference": "DE--21",
                        "email": "sonia@spryker.com",
                        "firstName": "Sonia",
                        "lastName": "Wagner"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com",
        "last": "https://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com&page[offset]=0&page[limit]=10",
        "first": "https://glue.mysprykershop.com/agent-customer-search?q=sonia@spryker.com&page[offset]=0&page[limit]=10"
    }
}
Response sample of search by name 
 {
    "data": [
        {
            "type": "agent-customer-search",
            "id": null,
            "attributes": {
                "customers": [
                    {
                        "customerReference": "DE--1",
                        "email": "spencor.hopkin@spryker.com",
                        "firstName": "Spencor",
                        "lastName": "Hopkin"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/agent-customer-search?q=spencor"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/agent-customer-search?q=spencor",
        "last": "https://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10",
        "first": "https://glue.mysprykershop.com/agent-customer-search?q=spencor&page[offset]=0&page[limit]=10"
    }
}
Response sample of search by customer reference 
{
    "data": [
        {
            "type": "agent-customer-search",
            "id": null,
            "attributes": {
                "customers": [
                    {
                        "customerReference": "DE--5",
                        "email": "george.freeman@spryker.com",
                        "firstName": "George",
                        "lastName": "Freeman"
                    }
                ]
            },
            "links": {
                "self": "https://glue.mysprykershop.com/agent-customer-search?q=de--5"
            }
        }
    ],
    "links": {
        "self": "https://glue.mysprykershop.com/agent-customer-search?q=de--5",
        "last": "https://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10",
        "first": "https://glue.mysprykershop.com/agent-customer-search?q=de--5&page[offset]=0&page[limit]=10"
    }
}
Attribute Type Description
customerReference string Unique customer identifier.
email string Email address of the customer.
firstName string First name of the customer.
lastName string Last name of the customer.

Possible errors

Code Reason
001 Access token is invalid.
4103 Agent access token is missing.

To view generic errors that originate from the Glue Application, see Reference information: GlueApplication errors.

Next steps

After you’ve found the reference of the customer you want to assist, impersonate the customer to perform any actions available to them. See Impersonating customers as an agent assist for details.