JUjumpseller
Customers

Retrieve a Customer List from a query.

Changed on

Searches the store's Customers. Endpoint example:

https://api.jumpseller.com/v1/customers/search.json?query=john&order=desc
get/customers/search.json

Request

  • Base URL
    https://api.jumpseller.com/v1
  • URL
    https://api.jumpseller.com/v1/customers/search.json
  • Auth
    • HTTP basic
    • or API key in query parameter login and API key in query parameter authtoken
    • or OAuth 2
      Authorization code: https://accounts.jumpseller.com/oauth/authorize
      Token URL: https://accounts.jumpseller.com/oauth/token scopes: read_customers

Query parameters

querystring required

Text to query for the Customer. If empty, returns all Customers.

order'asc' | 'desc'

Sort Customers by id: 'asc' for ascending order or 'desc' for descending order.

limitinteger

Number of objects per page (maximum 100).

pageinteger

Page number, starting at 1.

Response

Total number of matches and the requested page of Customers

countinteger

Total number of Customers matching the query

Changes

  • 53dc9f2c1329Revision changes
    • breaking

      the query request parameter order was restricted to a list of enum values

    • breaking

      the response's body type changed from array to object for status

    • warning

      for the query request parameter limit, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • info

      added the new enum value asc to the query request parameter order

    • info

      added the new enum value desc to the query request parameter order

    • info

      for the query request parameter limit, the format was generalized from integer to no format

    • info

      for the query request parameter order, the format was generalized from string to no format

    • info

      for the query request parameter page, the format was generalized from integer to no format

    • info

      for the query request parameter query, the format was generalized from string to no format

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status