Retrieve Buyer Supplier Associations For Export

Overview

Searches for buyer/supplier relationship for export.

Resource Access

GET https://<hostname>/buyer/v1/buyer/relationship/export

Parameters

The requested criteria can be a combination of one or more of the following fields:

Keys	Values
filter	%7B%7D
search	<field user wants to search>
size	10
from	Defines the number of records to offset
fields	Allows the search to target specific fields
buyerId	Buyers internal ID for which association is to be searched
supplierId	Suppliers internal ID for which association is to be searched, if supplierId is not passed, system returns all buyer supplier associations associated with the buyer
sort	created%3Adesc

Example Request

🚧
GET https://<hostname>/buyer/v1/buyer/relationship/export

Example Response



{
   "_scroll_id": "eyJhbGciOiJFUzI1NiJ9.eyJzY3JvbGxJZCI6IkZHbHVZMngxWkdWZlkyOXVkR1Y0ZEY5MWRXbGtEWEYxWlhKNVFXNWtSbVYwWTJnQkZrNVVTM0ZTUVVSalVsbExVRUp1Wm04NWJYaHFObmNBQUFBQUFCUnRUaFptWjJnNVRTMTJUbFJvY1VSeFZuVm9kbGMwT0VwQiIsInRlbmFudElkIjoiNUQ0Q0QxRUEtNzI0Qi00NkFDLUE4NzgtMEIwNjhFMjM5RTAyIiwidmlydHVhbEVudiI6ImF3cy1udi1jcHhxYSIsInVzZXJJZCI6IjQwNGI4NjFjLTc0ZGYtNWUyOS1iNzBjLTVlOWMxM2MwOTk4NCJ9.yFYGaODYnV-h63zo2wugKT2bxvbDY_aPU_LZDZqOGtf_-3tVYX43_nqQHUhC_f-pVcVW6e8FqxcW4zOxvyfCVA",
   "totalRecords": 131394,
   "totalType": "exact",
   "recordCount": 10,
   "records": [
       {
           "acl": [
               "pps:cpx-acquiring",
               "supplier:33937471-de69-526e-8be1-e238677501cb",
               "buyer:42d6bc78-6a04-54a9-beb9-9aaab2d0db40",
               "institution:e7f301e8-75c8-5a6e-9d7e-ef9cb6109251",
               "network:b5027e31-b9d6-577c-b600-69c03c1f7c90"
           ],
           "buyer": {
               "id": "42d6bc78-6a04-54a9-beb9-9aaab2d0db40",
               "name": "Load Test"
           },
           "created": "2023-05-24T05:51:29.723Z",
           "creator": {
               "id": "e24bda88-d9ed-5730-a311-05488b7d65ed",
               "username": "john.doe+critical"
           },
           "deleted": false,
           "id": "86586ff0-967d-56da-9f02-7a5d54f295d9",
           "modified": "2023-05-24T05:55:09.788Z",
           "modifier": {
               "id": "50335456-0300-45cc-b01c-37c5f20f69b2",
               "username": "system"
           },
           "sid": "a2865",
           "supplier": {
               "id": "33937471-de69-526e-8be1-e238677501cb",
               "name": "test 1136"
           },
           "createdNotificationSent": "2023-05-24T05:55:09.788Z"
       }
   ]
}