Tutorial

Framework creation

Only markets with 5th accreditation level can create frameworks. ProcuringEntity can have only central kind. Framework can be created only for cpb that have active: true status https://prozorroukr.github.io/standards/organizations/authorized_cpb.json

Let’s create a framework:

Request

POST /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "contactPoint": {
        "telephone": "+0440000000",
        "name": "Назва організації(ЦЗО)",
        "email": "aa@aa.com"
      },
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "kind": "central",
      "address": {
        "countryName": "Україна",
        "postalCode": "01220",
        "region": "м. Київ",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ"
      },
      "name": "Повна назва юридичної організації."
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "classification": {
      "scheme": "ДК021",
      "description": "Mustard seeds",
      "id": "03111600-8"
    },
    "title": "Узагальнена назва закупівлі",
    "description": "Назва предмета закупівлі",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00"
    }
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/7a229c4d310842c39ef98821651b267b

{
  "data": {
    "status": "draft",
    "title": "Узагальнена назва закупівлі",
    "description": "Назва предмета закупівлі",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00"
    },
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000000",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "prettyID": "UA-F-2023-10-10-000001",
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-10T01:00:00+03:00",
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "access": {
    "token": "797fdae523914449922546561e43242f",
    "transfer": "a70857eea6424855a90eec83bfe040a4"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

We have 201 Created response code, Location header and body with extra properties.

Framework was created in draft status. In this status any field, except technical, can be changed using PATCH method.

Request

PATCH /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "procuringEntity": {
      "contactPoint": {
        "telephone": "+0440000001"
      }
    },
    "title": "updated in draft status"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "prettyID": "UA-F-2023-10-10-000001",
    "title": "updated in draft status",
    "description": "Назва предмета закупівлі",
    "status": "draft",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-10T01:00:00+03:00",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00"
    },
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000001",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

Uploading documentation

Procuring entity can upload files into the created framework. Uploading should follow the Documents Uploading rules.

Request

POST /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "framework.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=S4ZIJmRAPa9iDj895YM90wsfSUlBfNExiNKevl9fJdtqw9PkVqhLZP4i7c8sxPSUlRFaQu7puJZzjJwxAF%2BfBg%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents/6e3c9989ef844c53b6b202f3c5d3af28

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "6e3c9989ef844c53b6b202f3c5d3af28",
    "datePublished": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-10T01:00:00+03:00"
  }
}

201 Created response code and Location header confirm document creation. We can additionally query the documents collection API endpoint to confirm the action:

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "hash": "md5:00000000000000000000000000000000",
      "title": "framework.doc",
      "format": "application/msword",
      "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "6e3c9989ef844c53b6b202f3c5d3af28",
      "datePublished": "2023-10-10T01:00:00+03:00",
      "dateModified": "2023-10-10T01:00:00+03:00"
    }
  ]
}

And again we can confirm that there are two documents uploaded.

Request

POST /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "framework_additional_docs.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=Jm4GFi%2B6QNs2HfsaJbxzcUM4LvKg4LV5EqnlplQKL8wXIIFTUt9UUosrTwTZJlIS%2BVTktc8TzCUrffuIxejoCA%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents/1e3e5196731a48e48ca51152eb00c4ba

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework_additional_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "1e3e5196731a48e48ca51152eb00c4ba",
    "datePublished": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-10T01:00:00+03:00"
  }
}

In case we made an error, we can reupload the document over the older version:

Request

PUT /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents/1e3e5196731a48e48ca51152eb00c4ba?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "framework_additional_docs.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=qk9TBbp52f8gzFVdjIl6Sm4v1myg%2FUxF4n2zhcsUB6YmpifdDt5vTooiZ83jFGBnMjsw6vYlTTvnXk7AEFemDg%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "id": "1e3e5196731a48e48ca51152eb00c4ba",
    "datePublished": "2023-10-10T01:00:00+03:00",
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework_additional_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
    "dateModified": "2023-10-10T01:00:00+03:00",
    "language": "uk"
  }
}

And we can see that it is overriding the original version:

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/documents/1e3e5196731a48e48ca51152eb00c4ba?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "id": "1e3e5196731a48e48ca51152eb00c4ba",
    "datePublished": "2023-10-10T01:00:00+03:00",
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework_additional_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
    "dateModified": "2023-10-10T01:00:00+03:00",
    "language": "uk",
    "previousVersions": [
      {
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
        "language": "uk",
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "dateModified": "2023-10-10T01:00:00+03:00"
      }
    ]
  }
}

Framework activation

The second step is moving the framework to active status.

qualificationPeriod.endDate should be in between 30 and 1095 days from activation moment.

There should be at least 1 document in addition to sign document.

Request

PATCH /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "active"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "prettyID": "UA-F-2023-10-10-000001",
    "title": "updated in draft status",
    "description": "Назва предмета закупівлі",
    "status": "active",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "documents": [
      {
        "id": "6e3c9989ef844c53b6b202f3c5d3af28",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-10T01:00:00+03:00",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00",
      "startDate": "2023-10-10T01:00:00+03:00"
    },
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000001",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "enquiryPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-10-25T00:00:00+03:00",
      "clarificationsUntil": "2023-10-28T00:00:00+03:00"
    },
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-09T00:00:00+02:00"
    },
    "next_check": "2023-11-08T00:00:00+02:00",
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

After framework activation frameworks periods was calculated:

enquiryPeriod - first 10 full working days after activation.

period - period when suppliers can add submissions.

qualificationPeriod - last 30 full calendar days of framework when suppliers cannot add submissions but still can be qualified based on previous submissions.

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "prettyID": "UA-F-2023-10-10-000001",
    "title": "updated in draft status",
    "description": "Назва предмета закупівлі",
    "status": "active",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "documents": [
      {
        "id": "6e3c9989ef844c53b6b202f3c5d3af28",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00",
      "startDate": "2023-10-10T01:00:00+03:00"
    },
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000001",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "enquiryPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-10-25T00:00:00+03:00",
      "clarificationsUntil": "2023-10-28T00:00:00+03:00"
    },
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-09T00:00:00+02:00"
    },
    "next_check": "2023-11-08T00:00:00+02:00",
    "agreementID": "6d10ffd01e7a4ab8a94915d9f6eebbdb",
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

Let’s check what framework registry contains:

Request

GET /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "7a229c4d310842c39ef98821651b267b"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/frameworks?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0"
  }
}

We do see the internal id of a framework and its dateModified datestamp.

Modifying framework

In active status only some fields can be changed: telephone, name, email for procuringEntity.contactPoint, endDate for qualificationPeriod, description and documents.

If qualificationPeriod.endDate was changed all periods will be recalculated.

Request

PATCH /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "procuringEntity": {
      "contactPoint": {
        "telephone": "+0440000002",
        "name": "зміна",
        "email": "ab@aa.com"
      }
    },
    "description": "Назва предмета закупівлі1",
    "qualificationPeriod": {
      "endDate": "2023-12-24T01:00:00+03:00"
    }
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "prettyID": "UA-F-2023-10-10-000001",
    "title": "updated in draft status",
    "description": "Назва предмета закупівлі1",
    "status": "active",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "documents": [
      {
        "id": "6e3c9989ef844c53b6b202f3c5d3af28",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "agreementID": "6d10ffd01e7a4ab8a94915d9f6eebbdb",
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-24T00:00:00+02:00"
    },
    "qualificationPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-12-24T01:00:00+03:00"
    },
    "enquiryPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-10-25T00:00:00+03:00",
      "clarificationsUntil": "2023-10-28T00:00:00+03:00"
    },
    "next_check": "2023-11-08T00:00:00+02:00",
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "зміна",
        "telephone": "+0440000002",
        "email": "ab@aa.com"
      },
      "kind": "central"
    },
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

Additionally, the dateModified property was updated to reflect the last modification datestamp.

Checking the listing again reflects the new modification date:

Request

GET /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "7a229c4d310842c39ef98821651b267b"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/frameworks?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0"
  }
}

Registering submission

After activating framework, users can register their submissions in period from framework.period.startDate to framework.period.endDate:

Request

POST /api/2.5/submissions HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "tenderers": [
      {
        "address": {
          "countryName": "Україна",
          "locality": "м. Вінниця",
          "postalCode": "21100",
          "region": "Вінницька область",
          "streetAddress": "вул. Островського, 33"
        },
        "contactPoint": {
          "email": "soleksuk@gmail.com",
          "name": "Сергій Олексюк",
          "telephone": "+380432216930"
        },
        "identifier": {
          "scheme": "UA-EDR",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/"
        },
        "name": "ДКП «Школяр»",
        "scale": "micro"
      }
    ],
    "frameworkID": "7a229c4d310842c39ef98821651b267b"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f

{
  "data": {
    "tenderers": [
      {
        "name": "ДКП «Школяр»",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
        },
        "address": {
          "countryName": "Україна",
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "telephone": "+380432216930",
          "email": "soleksuk@gmail.com"
        }
      }
    ],
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "draft",
    "submissionType": "electronicCatalogue",
    "owner": "broker",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "id": "7c37a548e4db48a0ac3c1b4d9ead2c5f"
  },
  "access": {
    "token": "680e74861490448a9177bf199cb6395b",
    "transfer": "2c7416d6b206452588a7e3956cad175d"
  },
  "config": {
    "restricted": false
  }
}

We have 201 Created response code, Location header and body with extra properties.

Uploading Submission documentation

Documents can be uploaded/changed only for submission in draft status.

Documents operations is same like in framework:

Request

POST /api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f/documents?acc_token=680e74861490448a9177bf199cb6395b HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "submission_docs.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/d9006a35da3b4389bf1be5cd34a3071a?Signature=AAVs8klPItfOgpXmSLKSdPVkqkyurE0Cb6Ert1YivEQN3KXJ33xrlDNzdtvxaxnnzkmwnZThFNaJoHXuxs4%2FBQ%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f/documents/51eb561eb78c4fa49dad5d1097e9c7cc

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "submission_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/d9006a35da3b4389bf1be5cd34a3071a?Signature=i8SHbMgp8F%2BDTPKCmPFxk0f7CTww8xsbmAdwhOky%2FgyFcAIuTveMDAT69TBjFyLOOYgdCosl%2FL%2FQ6JWzoPq%2BCA%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "51eb561eb78c4fa49dad5d1097e9c7cc",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00"
  }
}

Request

GET /api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "hash": "md5:00000000000000000000000000000000",
      "title": "submission_docs.doc",
      "format": "application/msword",
      "url": "http://public-docs-sandbox.prozorro.gov.ua/get/d9006a35da3b4389bf1be5cd34a3071a?Signature=i8SHbMgp8F%2BDTPKCmPFxk0f7CTww8xsbmAdwhOky%2FgyFcAIuTveMDAT69TBjFyLOOYgdCosl%2FL%2FQ6JWzoPq%2BCA%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "51eb561eb78c4fa49dad5d1097e9c7cc",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00"
    }
  ]
}

Deleting submission

Submission can be deleted only in draft status:

Request

PATCH /api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f?acc_token=680e74861490448a9177bf199cb6395b HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "deleted"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "tenderers": [
      {
        "name": "НАЗВА",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
        },
        "address": {
          "countryName": "Україна",
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "telephone": "+380432216930",
          "email": "soleksuk@gmail.com"
        }
      }
    ],
    "documents": [
      {
        "id": "51eb561eb78c4fa49dad5d1097e9c7cc",
        "datePublished": "2023-10-26T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "submission_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/d9006a35da3b4389bf1be5cd34a3071a?Signature=i8SHbMgp8F%2BDTPKCmPFxk0f7CTww8xsbmAdwhOky%2FgyFcAIuTveMDAT69TBjFyLOOYgdCosl%2FL%2FQ6JWzoPq%2BCA%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "deleted",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "electronicCatalogue",
    "id": "7c37a548e4db48a0ac3c1b4d9ead2c5f"
  },
  "config": {
    "restricted": false
  }
}

Updating Submission

Submission can be changed only in draft status:

Request

PATCH /api/2.5/submissions/7c37a548e4db48a0ac3c1b4d9ead2c5f?acc_token=680e74861490448a9177bf199cb6395b HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "tenderers": [
      {
        "address": {
          "countryName": "Україна",
          "locality": "м. Вінниця",
          "postalCode": "21100",
          "region": "Вінницька область",
          "streetAddress": "вул. Островського, 33"
        },
        "contactPoint": {
          "email": "soleksuk@gmail.com",
          "name": "Сергій Олексюк",
          "telephone": "+380432216930"
        },
        "identifier": {
          "scheme": "UA-EDR",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/"
        },
        "name": "НАЗВА",
        "scale": "micro"
      }
    ]
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "tenderers": [
      {
        "name": "НАЗВА",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
        },
        "address": {
          "countryName": "Україна",
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "telephone": "+380432216930",
          "email": "soleksuk@gmail.com"
        }
      }
    ],
    "documents": [
      {
        "id": "51eb561eb78c4fa49dad5d1097e9c7cc",
        "datePublished": "2023-10-26T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "submission_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/d9006a35da3b4389bf1be5cd34a3071a?Signature=i8SHbMgp8F%2BDTPKCmPFxk0f7CTww8xsbmAdwhOky%2FgyFcAIuTveMDAT69TBjFyLOOYgdCosl%2FL%2FQ6JWzoPq%2BCA%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "draft",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "electronicCatalogue",
    "id": "7c37a548e4db48a0ac3c1b4d9ead2c5f"
  },
  "config": {
    "restricted": false
  }
}

Submission activation

Submission can be activated before period.endDate

Request

PATCH /api/2.5/submissions/5e1269d73d184f65bf1f889a1abc9974?acc_token=b30af78ba8964a839295518c1e083123 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "active"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "tenderers": [
      {
        "name": "ДКП «Школяр»",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "uri": "http://www.sc.gov.ua/",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
        },
        "address": {
          "countryName": "Україна",
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "telephone": "+380432216930",
          "email": "soleksuk@gmail.com"
        }
      }
    ],
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "active",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "electronicCatalogue",
    "qualificationID": "6fce332a98dc49939a6a6f0dc2fa33c6",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "id": "5e1269d73d184f65bf1f889a1abc9974"
  },
  "config": {
    "restricted": false
  }
}

After activating the submission, a qualification object is automatically created and submission qualificationID field is filled.

Let’s check what submission registry contains:

Request

GET /api/2.5/submissions HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "5e1269d73d184f65bf1f889a1abc9974"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/submissions?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0"
  }
}

Let’s check created qualification object:

Request

GET /api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "submissionID": "5e1269d73d184f65bf1f889a1abc9974",
    "qualificationType": "electronicCatalogue",
    "status": "pending",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "id": "6fce332a98dc49939a6a6f0dc2fa33c6"
  },
  "config": {
    "restricted": false
  }
}

All operations with qualification object can do only framework_owner.

Uploading qualification documentation

Documents can be uploaded/changed only for qualification in pending status.

Documents operations is same like in framework:

Request

POST /api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6/documents?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "qualification.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3cd211e97f284e79b39a6dbba518a484?Signature=G0iQnXOb8ERMANs4d%2F1v67Ah85fwi%2BBr3e40dr3%2Fufmg3O%2BN1dgK%2FmScN%2F7KWFMzOUReuDcqRdenVrM0o5ewCw%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6/documents/29d3b10680d242959acdfc88d5a205c5

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "qualification.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3cd211e97f284e79b39a6dbba518a484?Signature=L6flukUBvXZ%2F18tixcMYbXP%2F1CyvbCcYjz6wA0fqGvgls51%2BUXwcEHzTFtNicsz8iz2sObTsvwwOOOQ7bW7NDA%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "29d3b10680d242959acdfc88d5a205c5",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00"
  }
}

Request

GET /api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "hash": "md5:00000000000000000000000000000000",
      "title": "qualification.doc",
      "format": "application/msword",
      "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3cd211e97f284e79b39a6dbba518a484?Signature=L6flukUBvXZ%2F18tixcMYbXP%2F1CyvbCcYjz6wA0fqGvgls51%2BUXwcEHzTFtNicsz8iz2sObTsvwwOOOQ7bW7NDA%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "29d3b10680d242959acdfc88d5a205c5",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00"
    }
  ]
}

Canceled qualification

Qualification can be cancelled only in pending status.

Request

PATCH /api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "unsuccessful"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "documents": [
      {
        "id": "29d3b10680d242959acdfc88d5a205c5",
        "datePublished": "2023-10-26T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "qualification.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/3cd211e97f284e79b39a6dbba518a484?Signature=L6flukUBvXZ%2F18tixcMYbXP%2F1CyvbCcYjz6wA0fqGvgls51%2BUXwcEHzTFtNicsz8iz2sObTsvwwOOOQ7bW7NDA%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "submissionID": "5e1269d73d184f65bf1f889a1abc9974",
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "unsuccessful",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationType": "electronicCatalogue",
    "id": "6fce332a98dc49939a6a6f0dc2fa33c6"
  },
  "config": {
    "restricted": false
  }
}

After cancelling qualification, related submission changed status from active to complete.

Let’s check what happen with submissions after cancelling qualification:

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/submissions HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "tenderers": [
        {
          "name": "ДКП «Школяр»",
          "scale": "micro",
          "identifier": {
            "scheme": "UA-EDR",
            "id": "00137256",
            "uri": "http://www.sc.gov.ua/",
            "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
          },
          "address": {
            "countryName": "Україна",
            "streetAddress": "вул. Островського, 33",
            "locality": "м. Вінниця",
            "region": "Вінницька область",
            "postalCode": "21100"
          },
          "contactPoint": {
            "name": "Сергій Олексюк",
            "telephone": "+380432216930",
            "email": "soleksuk@gmail.com"
          }
        }
      ],
      "frameworkID": "7a229c4d310842c39ef98821651b267b",
      "status": "complete",
      "dateCreated": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00",
      "date": "2023-10-26T01:00:00+03:00",
      "qualificationID": "6fce332a98dc49939a6a6f0dc2fa33c6",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "id": "5e1269d73d184f65bf1f889a1abc9974"
    },
    {
      "tenderers": [
        {
          "name": "ДКП «Школяр»",
          "scale": "micro",
          "identifier": {
            "scheme": "UA-EDR",
            "id": "00137256",
            "uri": "http://www.sc.gov.ua/",
            "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
          },
          "address": {
            "countryName": "Україна",
            "streetAddress": "вул. Островського, 33",
            "locality": "м. Вінниця",
            "region": "Вінницька область",
            "postalCode": "21100"
          },
          "contactPoint": {
            "name": "Сергій Олексюк",
            "telephone": "+380432216930",
            "email": "soleksuk@gmail.com"
          }
        }
      ],
      "frameworkID": "7a229c4d310842c39ef98821651b267b",
      "status": "complete",
      "dateCreated": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00",
      "date": "2023-10-26T01:00:00+03:00",
      "qualificationID": "2efd8f11d2914763ab331e36e358d306",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "id": "4693711d52b14347b47af79c501fbd5f"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/submissions?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0"
  }
}

Approve qualification

Qualification can be approved only in pending status.

Request

PATCH /api/2.5/qualifications/2efd8f11d2914763ab331e36e358d306?acc_token=797fdae523914449922546561e43242f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "status": "active"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "submissionID": "4693711d52b14347b47af79c501fbd5f",
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "status": "active",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationType": "electronicCatalogue",
    "id": "2efd8f11d2914763ab331e36e358d306"
  },
  "config": {
    "restricted": false
  }
}

After approving qualification, if it was first active qualification system create agreement with contract otherwise system add contract to agreement.

Let’s check current framework

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "prettyID": "UA-F-2023-10-10-000001",
    "title": "updated in draft status",
    "description": "Назва предмета закупівлі",
    "status": "active",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "documents": [
      {
        "id": "6e3c9989ef844c53b6b202f3c5d3af28",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/e38e94f4fbab44ecb6f74b90a27e6181?Signature=eYTcMLrU9pbzXw3zQawemAR2B5P4wH7q9Oi%2BaSrfd8yz0GREYrG3PD2aGzaBcLE443%2FXz7h48KBhMQ9rMl8HDw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/dc4a665229114a72993b89bb20d7874b?Signature=cdTNyz3oB7rPP2%2Fou8SnYPoxabwo%2BQcAzgKapCGy9PY%2Fo3NSfRnJlvm9jzPX3Maq8xi6wTSODTEEEXWyEhYpCg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "1e3e5196731a48e48ca51152eb00c4ba",
        "datePublished": "2023-10-10T01:00:00+03:00",
        "hash": "md5:00000000000000000000000000000000",
        "title": "framework_additional_docs.doc",
        "format": "application/msword",
        "url": "http://public-docs-sandbox.prozorro.gov.ua/get/0f4300d9a1594cfc800f2ea11c9a38d1?Signature=%2FEIDl4zhMc%2FQIlBBsuAcBovf0l1hIzOWn0E%2BS7E45QoXJ0ZAOOPKXmO2jUWxMhgObJloZ9%2FVLIiar4eop2K7Dg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "owner": "broker",
    "date": "2023-10-10T01:00:00+03:00",
    "dateCreated": "2023-10-10T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00",
      "startDate": "2023-10-10T01:00:00+03:00"
    },
    "frameworkType": "electronicCatalogue",
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000001",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "enquiryPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-10-25T00:00:00+03:00",
      "clarificationsUntil": "2023-10-28T00:00:00+03:00"
    },
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-09T00:00:00+02:00"
    },
    "next_check": "2023-11-08T00:00:00+02:00",
    "agreementID": "6d10ffd01e7a4ab8a94915d9f6eebbdb",
    "id": "7a229c4d310842c39ef98821651b267b"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

You can see that agreementID appeared in current framework, so let’s check that agreement:

Request

GET /api/2.5/agreements/6d10ffd01e7a4ab8a94915d9f6eebbdb HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "agreementID": "UA-2023-10-26-000001",
    "frameworkID": "7a229c4d310842c39ef98821651b267b",
    "agreementType": "electronicCatalogue",
    "status": "active",
    "period": {
      "startDate": "2023-10-26T01:00:00+03:00",
      "endDate": "2023-12-09T01:00:00+03:00"
    },
    "procuringEntity": {
      "name": "Повна назва юридичної організації.",
      "identifier": {
        "scheme": "UA-EDR",
        "id": "40996564",
        "legalName": "Назва організації(ЦЗО)"
      },
      "address": {
        "countryName": "Україна",
        "streetAddress": "вул. Банкова, 11, корпус 1",
        "locality": "м. Київ",
        "region": "м. Київ",
        "postalCode": "01220"
      },
      "contactPoint": {
        "name": "Назва організації(ЦЗО)",
        "telephone": "+0440000001",
        "email": "aa@aa.com"
      },
      "kind": "central"
    },
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "contracts": [
      {
        "id": "835a18a5042142a1b24c75b5e938446e",
        "qualificationID": "2efd8f11d2914763ab331e36e358d306",
        "submissionID": "4693711d52b14347b47af79c501fbd5f",
        "status": "active",
        "suppliers": [
          {
            "name": "ДКП «Школяр»",
            "scale": "micro",
            "identifier": {
              "scheme": "UA-EDR",
              "id": "00137256",
              "uri": "http://www.sc.gov.ua/",
              "legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
            },
            "address": {
              "countryName": "Україна",
              "streetAddress": "вул. Островського, 33",
              "locality": "м. Вінниця",
              "region": "Вінницька область",
              "postalCode": "21100"
            },
            "contactPoint": {
              "name": "Сергій Олексюк",
              "telephone": "+380432216930",
              "email": "soleksuk@gmail.com"
            }
          }
        ],
        "milestones": [
          {
            "id": "c2fe71f3d39b44068cc0a2d10cfb61fc",
            "status": "scheduled",
            "type": "activation",
            "dueDate": "2023-12-09T01:00:00+03:00",
            "dateModified": "2023-10-26T01:00:00+03:00"
          }
        ],
        "date": "2023-10-26T01:00:00+03:00"
      }
    ],
    "owner": "broker",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "next_check": "2023-12-09T01:00:00+03:00",
    "dateCreated": "2023-10-26T01:00:00+03:00",
    "id": "6d10ffd01e7a4ab8a94915d9f6eebbdb"
  },
  "config": {
    "restricted": false
  }
}

As you can see agreement now in active status, and already have contract, so we can see that agreement in agreement feed:

Request

GET /api/2.5/agreements HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "6d10ffd01e7a4ab8a94915d9f6eebbdb"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/agreements?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/agreements?offset=1698271200.0"
  }
}

Let’s check what qualification registry contains:

Request

GET /api/2.5/qualifications HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "6fce332a98dc49939a6a6f0dc2fa33c6"
    },
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "2efd8f11d2914763ab331e36e358d306"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/qualifications?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0"
  }
}

Let’s check all qualifications for current framework:

Request

GET /api/2.5/frameworks/7a229c4d310842c39ef98821651b267b/qualifications HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": [
    {
      "documents": [
        {
          "id": "29d3b10680d242959acdfc88d5a205c5",
          "datePublished": "2023-10-26T01:00:00+03:00",
          "hash": "md5:00000000000000000000000000000000",
          "title": "qualification.doc",
          "format": "application/msword",
          "url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/6fce332a98dc49939a6a6f0dc2fa33c6/documents/29d3b10680d242959acdfc88d5a205c5?download=3cd211e97f284e79b39a6dbba518a484",
          "dateModified": "2023-10-26T01:00:00+03:00",
          "language": "uk"
        }
      ],
      "submissionID": "5e1269d73d184f65bf1f889a1abc9974",
      "frameworkID": "7a229c4d310842c39ef98821651b267b",
      "status": "unsuccessful",
      "date": "2023-10-26T01:00:00+03:00",
      "dateCreated": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "6fce332a98dc49939a6a6f0dc2fa33c6"
    },
    {
      "submissionID": "4693711d52b14347b47af79c501fbd5f",
      "frameworkID": "7a229c4d310842c39ef98821651b267b",
      "status": "active",
      "date": "2023-10-26T01:00:00+03:00",
      "dateCreated": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "2efd8f11d2914763ab331e36e358d306"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/qualifications?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0"
  }
}

Framework completing

Framework is completed automatically at qualificationPeriod.endDate moment.

PATCH with new qualificationPeriod.endDate allow to complete framework earlier than was planned, but not earlier than 30 full calendar days from change moment.