/customersList: Customers List

URL:
https://[root]/portals/[portalID]/customersList
Methods:
GET

Example usage

The following is a sample ArcGIS Online request URL used to access the customersList resource:

Use dark colors for code blocksCopy
1
https://org.arcgis.com/sharing/rest/portals/0123456789ABCDEF/customersList?includeListing=true&f=pjson

Description

The customersList resource returns a list of purchases, trials, and interests expressed by customers for items listed by this organization in the marketplace. This operation allows filtering and sorting of provisions.

Request parameters

ParameterDetails

status

Status of the provisions to be returned. The default is all.

  • active: Only provisions that are currently active will be returned.
  • expired: Only provisions that have already expired will be returned.
  • all active: Both active and expired provisions will be returned.

Values: all | expired | active

type

Access type of the provisions to be returned:

  • REQUEST: Only provisions that have been requested will be returned.
  • TRIAL: Only trial provisions will be returned.
  • PURCHASE: Only subscription provisions will be returned.
  • REQUESTANDTRIAL: Both provisions that have been requested and trial provisions will be returned.
  • REQUESTANDPURCHASE: Both provisions that have been requested and subscriptions will be returned.
  • TRIALANDPURCHASE: Both trial provisions and subscriptions will be returned.

Values: REQUEST | TRIAL | PURCHASE | REQUESTANDTRIAL | REQUESTANDPURCHASE | TRIALANDPURCHASE

itemId

The item ID of the provision to be returned.

orgname

Purchaser organization name of the provisions to be returned.

modified

The last modified date of the provisions to be returned. The date specified should be in milliseconds from epoch.

Example

Use dark colors for code blocksCopy
1
modified=1454392931000

sortFields

The fields to sort provisions by. The allowed sort field names are orgname, created, endDate, and modified.

sortOrder

Describes whether the order returns in ascending or descending order.

Values: asc | desc

includeListing

If true, listing objects are included in the provision response. The default is true.

Values: true | false

num

The maximum number of provisions to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The start parameter, along with the num parameter, can be used to paginate the query results. Note that the actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num.

Example

Use dark colors for code blocksCopy
1
num=50

start

The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1. (i.e. the first search result). The start parameter, along with the num parameter, can be used to paginate the query results.

Example

Use dark colors for code blocksCopy
1
start=11

f

The response format. The default format is html.

Values: html | json | pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "total": <total number of results>,
  "start": <results in first set>,
  "num": <number of results per page>,
  "nextStart": <result number of next page>,
  "provisions": [
    {
      "provision": {<provision1>},
      "customer": {<customer1>},
      "listing": {<listing1>}
    },
    {
      "provision": {<provision2>},
      "customer": {<customer2>},
      "listing": {<listing2>}
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
  "total": 28,
  "start": 1,
  "num": 10,
  "nextStart": 11,
  "provisions": [
    {
      "provision": {
        "itemId": "448772a88d4b498d064ce2e8c6ff6b",
        "provisionedItemId": "448772a88d4b498d064ce2e8c6ff6b",
        "accountId": "HwhoSWTiJyaB0VDi",
        "purchaserOrgId": "sWwd06TnJR4lHopc",
        "purchaserUsername": "purchaser",
        "purchaserFullName": "Test Full Name",
        "purchaserEmail": "test@esri.com",
        "purchaserPhone": "9097932853",
        "startDate": 1454392931000,
        "endDate": -1,
        "purchased": true,
        "trial": false,
        "interested": false,
        "created": 1454392922000,
        "modified": 1454392931000,
        "title": "TEST Listing"
      },
      "customer": {
        "id": "sWwd06TnJR4lHopc",
        "name": "nebul1",
        "description": "<br>",
        "thumbnail": "thumbnail.jpg"
      },
      "listing": {
        "itemId": "448772a88d4b498d064ce2e8c6ff6b",
        "licenseType": "ela",
        "priceDesc": "100$",
        "creditsPerTransaction": 0,
        "listingAccess": "public",
        "trialSupported": false,
        "ecommerceEnabled": false,
        "licenseBy": "licenseByUser",
        "type": "Web Mapping Application",
        "typeKeywords": ["JavaScript", "Map", "Mapping Site", "Online Map", "Ready To Use", "Web Map", "Registered App"],
        "title": "TEST Listing",
        "tags": ["test"],
        "thumbnail": "thumbnail/ago_downloaded.png",
        "appCategories": [],
        "industries": [],
        "languages": [],
        "screenshots": [],
        "owner": "provider-admin-username",
        "created": 1454392915000,
        "avgRating": 0,
        "numComments": 0,
        "numRatings": 0,
        "vendor": {
          "id": "HwhosSWTiJyaagbB0VDi",
          "name": "My Org Name",
          "description": "My Org description",
          "thumbnail": "thumbnail.jpg",
          "orgEmail": "emailIdInMyOrgContact@myOrgdomain.com",
          "orgPhone": "111-1111-1111",
          "orgUrl": "https://myorgurl/contactus.html"
        }
      }
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.