Дані графіка замовлень (Response)

JSON:

{
    "id": 17,
    "producerId": 13200757,
    "name": "Test5",
    "dateCreated": 0,
    "dateChanged": 0,
    "dateStart": 1761516000,
    "dateEnd": 1768860000,
    "timeFrom": "09:00:00",
    "timeTo": "21:00:00",
    "block": false,
    "type": 1,
    "recurrenceRule":
    {
        "frequency": "WEEKLY",
        "interval": 1,
        "count": 50,
        "dateUntil": 0,
        "byDay":
        [
            1,
            2,
            4,
            6
        ]
    },
    "distributors":
    [
        13200791,
        13202863
    ],
    "dateClosest": 0
}

Таблиця 1 - Опис параметрів об’єкта Schedule

Параметр

Тип 1

Формат

Опис

Об’єкт Schedule

id

-/M

long

ідентифікатор графіка замовлень; параметр обов’язковий при оновленні графіка

producerId

long

ідентифікатор Виробника/Продавця

name

M

String

назва графіка замовлень

dateCreated

long

дата створення (Unix timestamp)

dateChanged

long

дата останньої зміни (Unix timestamp)

dateStart

M

long

дата початку графіка замовлень (Unix timestamp)

dateEnd

long

дата останньої події (Unix timestamp); примітка:

  • якщо значення=0 - це значить у графіка немає дати закінчення

  • якщо графік без повторів, то ця дата дорівнює даті початку графіка

timeFrom

M

String

час З якого можливо відправляти замовлення (ГГ:ХХ:СС)

timeTo

M

String

час ДО якого можливо відправляти замовлення (ГГ:ХХ:СС)

timeRemind

O

String

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

block

O

boolean

блокуємо (true) / не блокуємо (false) замовленя, які не задовільняють налаштуванням графіка; за замовчуванням false

type

O

int

тип графіка замовлень:

  • 1 - індивідуальний

  • 2 - загальний

Якщо не передається, то встановлюється автоматично за значенням distributors параметра

recurrenceRule

O

RecurrenceRule

об’єкт; правила повторів (передається, якщо Виробник/Продавець налаштував повтори)

distributors

O/M

List<Long>

масив; список GLN-ів Дистриб’юторів, обов’язковий при type=1

dateClosest

long

дата найближчої можливості відравки замовлень на сьогоднішній день - це поле динамічне (кожен день може змінюватись); якщо у продавця немає графіку або графік є, але він вже закінчився - даного параметра у відповіді не буде

Таблиця 2 - Опис параметрів об’єкта RecurrenceRule

Параметр

Тип 1

Формат

Опис

Об’єкт RecurrenceRule

frequency

M

enum

об’єкт; частота, допустимі значення:

  • DAILY

  • WEEKLY

interval

M

int

інтервал

count

O

int

кількість повторів події (значення розраховується: кількість з дати старту графіка)

dateUntil

O

long

дата до якої діють повтори - НЕ ЗАВЖДИ дата закінчення графіку (Unix timestamp)

byDay

-/M

List<Integer>

масив; список номерів днів тижня по яким можливо відправляти замовлення. Парамет обов’язковий для frequency=WEEKLY (тобто потібно обрати, як мінімум 1 день тижня)


1

Під визначенням колонки Тип поля мається на увазі скорочене позначення:

  • M (mandatory) — обов’язкові до заповнення поля;

  • O (optional) — необов’язкові (опціональні) до заповнення поля.