Staff

Last updated 1 year ago

Was this helpful?

Returns all staff members or based on specific filters

get

Scope: visitor and above

This endpoint retrieves staff details and implements pagination using a cursor-based approach.

You can optionally include a email or code parameter to filter the results based on staff member records. If no filter is provided, all staff details are returned without any condition.

The endpoint supports cursor pagination, where a cursor value is included in the response to facilitate navigation through the results. The maximum number of records per page is limited to 100.

Authorizations

Query parameters

emailstringOptional

Look up staff members using their email address

codestringOptional

Look up staff members using their code

after_cursorstringOptional

Returns staff members that come after the specified cursor

Header parameters

X-DotApparel-NamestringRequired

An alias name that represents a particular brand that is using the API

shopstringRequired

Responses

200

Successful response

application/json

401

Unauthorized: The user is not authorized to perform this action.

get

GET /staff HTTP/1.1
Host: 
Authorization: Basic username:password
X-DotApparel-Name: text
shop: text
Accept: */*

{
  "data": [
    {
      "id": 1349,
      "averageSale": 349,
      "code": "JOHNSM00",
      "email": "john.smith@example.com",
      "firstName": "John",
      "surname": "Smith",
      "fullName": "John Smith",
      "jobTitle": "MR",
      "firstSale": "2021-10-19",
      "last30daysTransactions": 46,
      "last30DaysSales": 16092,
      "lastSale": "2024-03-01",
      "lastSaleStore": "Retail Store",
      "loginCode": "JohnR",
      "memidx": 1349,
      "service": "2.3 Years",
      "totalSales": 289814,
      "totalTransactions": 830,
      "uniqueCustomers": 549
    }
  ],
  "meta": {
    "hasNextPage": true,
    "endCursor": "string"
  }
}

Retrieve staff member by member ID

get

Scope: visitor and above

This endpoint retrieves staff member details by an associated member ID.

If the ID is valid, the endpoint retrieves the staff member's record and returns a success message with a JSON object containing their information.

Authorizations

Path parameters

staff_member_idnumberRequired

The staff member ID