Supplier List

This endpoint enables you to query the entire list of suppliers that are a part of your company's portfolio based on the provided seller type.

Prerequisites

Querying the developer APIs involves sending an access_token as part of the Authorization header. For instructions on how to generate an access token, see Authorization.

Endpoint

GET https://public-api.productiv.com/pull/v1/suppliers

Required Scope https://api.productiv.com/apps.read

Request headers

Parameter	Value
Content-Type	application/json
Authorization	`Bearer access_token`

Query params

Parameter	Description
sellerType	Type of sellers you want to fetch. It's value can be either vendor or reseller

Response

If the request is successful, a JSON response is returned. The JSON object contains the following parameters:

Parameter	Datatype	Description
Suppliers	`array`	List of supplier objects (see definition below). If the query parameter `sellerType` is set to `vendor`, a list of Vendor objects (see definition below) are returned instead, else Reseller objects (see definition below) are returned.
AsOfDate	`string`	The date as of which information is being provided, in YYYY-MM-DD format. This is the latest date for which we have complete information for the set of apps in your portfolio.
ResponseTimeMs	`number`	Time taken by the server to process the request in milliseconds

Example response

Seller Type - Vendor

{
  "AsOfDate": "2022-07-01",
  "Suppliers": [
    {
      "VendorId": "productiv",
      "VendorName": "Productiv",
      "CustomFields": [
        {
          "FieldName": "field name",
          "FieldValue": ["value1", "value 2"],
          "FieldType": "multiselect",
          "FieldKey": "0c0hfki03gl3"
        }
      ],
      "SupplierType": "Vendor"
    },
    {
      "VendorId": "vendor",
      "VendorName": "Vendor",
      "CustomFields": [
        {
          "FieldName": "field name",
          "FieldValue": "some text",
          "FieldType": "text",
          "FieldKey": "xugk212iebn3"
        }
      ],
      "SupplierType": "Vendor"
    }
  ],
  "ResponseTimeMs": 2000
}

Seller Type - Reseller

{
  "AsOfDate": "2022-07-01",
  "Suppliers": [
    {
      "ResellerId": "productiv",
      "ResellerName": "Productiv",
      "CustomFields": [
        {
          "FieldName": "field name",
          "FieldValue": ["value1", "value 2"],
          "FieldType": "multiselect",
          "FieldType": "r848ww06nkk5"
        }
      ],
      "SupplierType": "Reseller"
    },
    {
      "ResellerId": "vendor",
      "ResellerName": "Vendor",
      "CustomFields": [
        {
          "FieldName": "field name",
          "FieldValue": "some text",
          "FieldType": "text",
          "FieldType": "0cx05r2m7iuh"
        }
      ],
      "SupplierType": "Reseller"
    }
  ],
  "ResponseTimeMs": 2000
}

Objects

This section lists the objects that can be returned in a successful query, and describes their properties.

Vendors

The vendors object is returned in the Supplier List API response when seller type is vendor. It represents a single suppliers, and contains a limited set of attributes for that app. These attributes are described below:

Parameter	Datatype	Description
VendorId	`string`	Unique identifier for the vendor
VendorName	`string`	Display name for the vendor
CustomFields	`array`	List of objects representing custom fields as configured in the product. See the CustomField definition below
SupplierType	`string`	Type of supplier - vendor

Resellers

The resellers object is returned in the Supplier List API response when seller type is reseller. It represents a single suppliers, and contains a limited set of attributes for that app. These attributes are described below:

Parameter	Datatype	Description
ResellerId	`string`	Unique identifier for the reseller
ResellerName	`string`	Display name for the reseller
CustomFields	`array`	List of objects representing custom fields as configured in the product. See the CustomField definition below
SupplierType	`string`	Type of supplier - reseller

CustomField

Property	Datatype	Description
FieldName	`string`	Name of the custom field
FieldValue	`FieldValue`	Value of the custom field
FieldType	`string`	Type of the custom field
FieldKey	`string`	The key that uniquely identifies the custom field

FieldValue

Custom fields can be one of the following types: singleselect, multiselect, text, number, date, currency, hyperlink. The datatype for value above depends on the type of custom field you are trying to edit.

Type	Datatype	Description
singleselect	`string`	The value must be one of the allowed values as configured in the product for the custom field.
multiselect	`array`	List of strings. Each value must be one of the allowed values for the field as configured in the product for the custom field.
text	`string`	Free-form text
number	`number`	Number
date	`string`	YYYY-MM-DD format
currency	`object`	See Currency object below
hyperlink	`object`	See Hyperlink object below

Currency

Property	Datatype	Description
currencyCode	`string`	ISO 4217 currency code
amount	`number`	Amount

Hyperlink

Property	Datatype	Description
label	`string`	Label for the hyperlink
url	`string`	URL for the hyperlink