Customers

Retrieves the customers.

get/v1/shops/{shopId}/customers

Request

Request body

pageinteger nullable

Page number.

perPageinteger nullable

Items per page, 1-100. Must be at least 1. Must not be greater than 100.

orderColumn'id' | 'email' | 'discord_id' | 'discord_username' | 'balance' | 'total_completed' | 'total_spent_usd' | 'last_completed_at' | 'newsletter_at' | 'affiliate_code' nullable
orderDirection'asc' | 'desc' nullable
idstring nullable

Filter by customer ID.

emailstring nullable

Filter by email.

usernamestring nullable

Filter by review username. Must not be greater than 20 characters.

discord_idstring nullable
discord_usernamestring nullable
subscribedstring nullable

Only newsletter subscribers.

affiliate_codestring nullable

Filter by affiliate code.

affiliate_referrer_emailstring nullable

Filter by referring affiliate email.

created_at_startstring nullable

Only customers created at or after this date. Must be a valid date.

created_at_endstring nullable

Only customers created at or before this date. Must be a valid date. Must be a date after <code>created_at_start</code>.

last_completed_at_startstring nullable

Only customers whose last completed order is at or after this date. Must be a valid date.

last_completed_at_endstring nullable

Only customers whose last completed order is at or before this date. Must be a valid date. Must be a date after <code>last_completed_at_start</code>.

total_spent_usd_minnumber nullable

Minimum total spent in USD. Must be at least 0.

total_spent_usd_maxnumber nullable

Maximum total spent in USD. Must be at least 0.

Example request

{
  "page": 1
}

Response

current_pageinteger
first_page_urlstring
frominteger
last_pageinteger
last_page_urlstring
next_page_urlstring nullable
pathstring
per_pageinteger
prev_page_urlstring nullable
tointeger
totalinteger

Example response

{
  "current_page": 1,
  "data": [
    {
      "id": 3,
      "email": "reseller@sellauth.test",
      "username": null,
      "anonymous_feedback": false,
      "username_locked_at": null,
      "discord_id": null,
      "discord_username": null,
      "balance": "100.00",
      "total_completed": 0,
      "total_spent_usd": "0.00",
      "last_completed_at": null,
      "newsletter_at": null,
      "affiliate_code": null,
      "affiliate_referrer_id": null,
      "affiliate_referrer": null
    },
    {
      "id": 2,
      "email": "customer-240@sellauth.test",
      "username": null,
      "anonymous_feedback": false,
      "username_locked_at": null,
      "discord_id": null,
      "discord_username": null,
      "balance": "0.00",
      "total_completed": 0,
      "total_spent_usd": "0.00",
      "last_completed_at": null,
      "newsletter_at": null,
      "affiliate_code": null,
      "affiliate_referrer_id": null,
      "affiliate_referrer": null
    },
    {
      "id": 1,
      "email": "customer@sellauth.test",
      "username": null,
      "anonymous_feedback": false,
      "username_locked_at": null,
      "discord_id": null,
      "discord_username": null,
      "balance": "100.00",
      "total_completed": 0,
      "total_spent_usd": "0.00",
      "last_completed_at": null,
      "newsletter_at": null,
      "affiliate_code": "PARTNER10",
      "affiliate_referrer_id": null,
      "affiliate_referrer": null
    }
  ],
  "first_page_url": "http://api.sellauth.test/v1/shops/1/customers?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://api.sellauth.test/v1/shops/1/customers?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "page": null,
      "active": false
    },
    {
      "url": "http://api.sellauth.test/v1/shops/1/customers?page=1",
      "label": "1",
      "page": 1,
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "page": null,
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://api.sellauth.test/v1/shops/1/customers",
  "per_page": 20,
  "prev_page_url": null,
  "to": 3,
  "total": 3
}

Changes

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      added the optional property // to the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property // to the 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