Merge pull request #2071 from EDI-N/Kolya_ua

RetailerRequestList
EDI-N · Feb 1, 2024 · f10c2da · f10c2da
2 parents fadf6b6 + b180378
commit f10c2da
Show file tree

Hide file tree

Showing 4 changed files with 143 additions and 0 deletions.
diff --git a/docs/integration_2_0/APIv2/Methods/EveryBody/RetailerRequestList.rst b/docs/integration_2_0/APIv2/Methods/EveryBody/RetailerRequestList.rst
@@ -0,0 +1,71 @@
+#############################################################################################
+**Список заявок на підключення до мережі (масив об'єктів RetailerRequest)**
+#############################################################################################
+
+**JSON:**
+
+.. code:: json
+
+    [
+        {
+            "accountId": 37663,
+            "retailerId": 7,
+            "status": 1,
+            "gln": "9864232607052",
+            "contractNumber": "yes",
+            "contractDate": "2023-12-20",
+            "dateCreated": "2023-12-20 17:09:53",
+            "fio": "Адвокат Адмінки",
+            "phone": "380685231489",
+            "email": "tw_ettn_v3@edin.ua",
+            "type": 1,
+            "inn": "111111111111",
+            "edrpou": "11111111",
+            "companyName": "TW_Вантажовідправник",
+            "id": 513,
+            "retailer":
+            {
+                "id": 7,
+                "accountId": 9549,
+                "name": "Варус (ОМЕГА)",
+                "gln": "9864119011415",
+                "aliasName": "Варус (ОМЕГА)",
+                "type": 1,
+                "countryId": 247,
+                "startDate": "2023-06-21",
+                "visible": true,
+                "special": false,
+                "emails": "test@edin.ua",
+                "docTypes":
+                [],
+                "services":
+                [],
+                "isNewPositions": false
+            }
+        }
+    ]
+
+Таблиця 1 - Опис параметрів об'єкта RetailerRequest
+
+.. csv-table:: 
+  :file: for_csv/RetailerRequest.csv
+  :widths:  1, 2, 12, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+Таблиця 2 - Опис параметрів об'єкта **Retailer**
+
+.. csv-table:: 
+  :file: /API_PC/Methods/EveryBody/for_csv/Retailer.csv
+  :widths:  1, 5, 19, 41
+  :header-rows: 1
+  :stub-columns: 0
+
+-------------------------
+
+.. [#] Під визначенням колонки **Тип поля** мається на увазі скорочене позначення:
+
+   * M (mandatory) — обов'язкові до заповнення поля;
+   * O (optional) — необов'язкові (опціональні) до заповнення поля.
+
+
diff --git a/docs/integration_2_0/APIv2/Methods/EveryBody/for_csv/RetailerRequest.csv b/docs/integration_2_0/APIv2/Methods/EveryBody/for_csv/RetailerRequest.csv
@@ -0,0 +1,29 @@
+Параметр,Тип [1]_,Формат,Опис
+.. _RetailerRequest: ,**Об'єкт RetailerRequest** ,
+accountId,,long,id акаунта
+retailerId,,long,id мережі
+status,,int,"статус заявки:
+
+- 0 - Чернетка
+- 1 - На розгляді
+- 2 - Прийнято
+- 3 - Відхилено"
+gln,,String,GLN номер
+contractNumber,,String,номер договору
+contractDate,,String,дата договору
+info,,String,додаткова інформація
+rejectComment,,String,коментар до відхилення заявки
+dateCreated,,String,дата створення
+fio,,String,ПІБ
+phone,,String,контактний телефон
+email,,String,email
+type,,int,"тип підключення
+
+- 1 - з ЮЗД
+- 2 - без ЮЗД"
+code,,String,Код (Для ТМ Розетка в поле обов'язково потрібно вказати код товару з сайту Розетки)
+inn,,String,код ІПН
+edrpou,,String,код ЄДРПОУ/КПП
+companyName,,String,назва компанії
+id,,long,id компанії
+**retailer**,,Retailer_,об'єкт; дані мережі
diff --git a/docs/integration_2_0/APIv2/Methods/GetRetailerRequests.csv b/docs/integration_2_0/APIv2/Methods/GetRetailerRequests.csv
@@ -0,0 +1,28 @@
+**URL**       ,
+Метод запиту  , GET
+URL запиту    , **/api/oas/retailers/requests?limit=21&offset=0&send_date_from=1380000400&send_date_to=1390006799&contract_number=yes&retailer_id=7**
+URL параметри ,"**retailer_id** (опціонально) long - id Торгової Мережі на платформі EDIN;
+
+**statuses** (опціонально) int - статус заявки:
+
+- 0 - Чернетка
+- 1 - На розгляді
+- 2 - Прийнято
+- 3 - Відхилено;
+
+**contract_number** (опціонально) String - номер договору;
+
+**contract_date_from** (опціонально) long (unix timestamp) - дата договору, починаючи з якої буде робитись вибірка;
+
+**contract_date_to** (опціонально) long (unix timestamp) - дата договору, що закриває кінцеві рамки в яких буде робитись вибірка;
+
+**send_date_from** (опціонально) long (unix timestamp) - дата відправки, починаючи з якої буде робитись вибірка;
+
+**send_date_to** (опціонально) long (unix timestamp) - дата відправки, що закриває кінцеві рамки в яких буде робитись вибірка;
+
+**limit** (опціонально) int - ліміт вибірки (за замовчуванням=20);
+
+**offset** (опціонально) int - зміщення відносно верхньої межі вибірки (за замовчуванням=0)"
+**Headers**   ,
+Authorization ,"**SID** - токен, отриманий при `авторизації <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__"
+Content-Type  , application/json
diff --git a/docs/integration_2_0/APIv2/Methods/GetRetailerRequests.rst b/docs/integration_2_0/APIv2/Methods/GetRetailerRequests.rst
@@ -0,0 +1,15 @@
+#######################################################################################################
+**Пошук заявки в "Підключення до мережі"**
+#######################################################################################################
+
+Для роботи з цим методом користувач повинен бути `авторизованим <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/Authorization.html>`__.
+
+.. csv-table:: 
+  :file: GetRetailerRequests.csv
+  :widths:  10, 41
+  :stub-columns: 0
+
+**RESPONSE**
+
+В тілі **відповіді** передається в json форматі масив зі `знайденими заявками на підключення до мережі <https://wiki.edin.ua/uk/latest/integration_2_0/APIv2/Methods/EveryBody/RetailerRequestList.html>`__.
+