Визначити перелік товарних позицій доступних до Повернення / Відправка Повернення (ініціатор Покупець (Дистриб’ютор))

Для роботи з цим методом користувач повинен бути авторизованим.

URL

Метод запиту

POST

URL запиту

/api/distribex/doc/retann?gln=9864065732327&period=90&producer=9864065732303&search_positions=true

URL параметри

gln (обов’язково) String - GLN Покупця (Дистрибʼютора)

producer (обов’язково) String - GLN Продавця (Виробника);

period (обов’язково) int - кількість днів, за які з документів робиться вибірка позицій, доступних до повернення (починаючи від поточного дня) - period=1 - за сьогодні, period=2 - за сьогодні та вчора і т.д.; максимум 90 днів, однак обмеження може змінюватись відповідно до наявності Лімітів зазначених Продавцем;

search_positions (опціонально) boolean:

  • якщо true, то у відповідь метода повертається список доступних до повернення позицій для зазначеного Покупця в межах періоду;

  • якщо false або параметр search_positions відсутній, то очікується тіло документа «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).

Headers

Authorization

SID - токен, отриманий при авторизації

Content-Type

application/json

REQUEST

JSON Body

Тіло запиту передається лише при search_positions=false або відсутності даного параметра: «Повідомлення про повернення» (RETANN) в json форматі уже разом із позиціями; при цьому документ одразу відправляється контрагенту (без створення чернетки).

RESPONSE

В тілі відповіді в залежності від параметра search_positions:

  • якщо true, то у відповідь метода повертається список доступних до Повернення позицій (масив об’єктів POSITION «Повідомлення про повернення» (RETANN)) для зазначеного Покупця в межах періоду;

  • якщо false або параметр search_positions відсутній, то повертається doc_uuid - унікальний ідентифікатор успішно відправленого «Повідомлення про повернення» (RETANN).

Приклади відповіді (успішний запит):

  1. При search_positions=true

[
    {
        "POSITIONNUMBER": 1,
        "PRODUCT": "4820022867421",
        "PRICE": 96.06,
        "PRODUCTIDSUPPLIER": "7127",
        "RETURNQUANTITYUNIT": "PCE",
        "DELIVEREDQUANTITYUNIT": "PCE",
        "DESCRIPTION": "\"Традиционный\"  400х12 зерновой кофе Жокей Укр",
        "AMOUNT": "3169.98",
        "RETURNQUANTITY": "33"
    }
]

  1. При search_positions=false

{doc_uuid:"e3dbf6e8-029e-4c3b-804b-9b2741d9f37d"}