Схеми даних: Складські залишки

Схеми даних: Складські залишки. Поля, типи й обмеження даних, які API приймає або повертає.

Схеми даних

Кількості, розподілені між місцями зберігання на складі

AllocationData · Схема · Схеми даних: Складські залишки

location_codeРядокОбов’язкове: Код місця зберігання на складі.

Приклад: "example"
location_idРядокОбов’язкове: Ідентифікатор місця зберігання на складі.

Приклад: "example"
location_nameРядокОбов’язкове: Назва місця зберігання на складі.

Приклад: "example"
on_handЦіле числоОбов’язкове: Фізична кількість на складі.

Приклад: 10

Додаткові поля: Ні

Отримати список · Залишки — Складські залишки — Відповідь

ApiResponse_list_StockData__ · Поля, типи й обмеження даних, які API приймає або повертає.

dataМасив <StockData > Обов’язкове: Приклад відповіді · ApiResponse_list_StockData__.

Приклад: [{"active":true,"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}]
metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове: Метадані відповіді.

Приклад: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Додаткові поля: Ні

Отримати · Залишки — Складські залишки — Відповідь

ApiResponse_StockDetailData_ · Поля, типи й обмеження даних, які API приймає або повертає.

dataStockDetailData Обов’язкове: Приклад відповіді · StockDetailData.

Приклад: {"active":true,"allocations":[{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}],"available":5,"id":"stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ","manual_reserved":2,"on_hand":10,"reserved":3,"sellable_limit":10,"target_id":"example","target_type":"product","total_reserved":5,"updated_at":"2026-01-01T12:00:00Z","version":1,"warehouse_id":"example"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Обов’язкове: Метадані відповіді.

Приклад: {"request_id":"example"}

Додаткові поля: Ні

Оновити · Ручне резервування — Складські залишки — Тіло запиту

ManualReservationUpdate · Поля, типи й обмеження даних, які API приймає або повертає.

expected_versionЦіле числоОбов’язкове: Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1
manual_reservedЦіле числоОбов’язкове: Кількість, зарезервована вручну.

minimum: 0maximum: 2147483647

Приклад: 1
reasonРядокНеобов’язкове: Записана причина зміни.

maxLength: 500

За замовчуванням: ""

Додаткові поля: Ні

Оновити · Ліміт продажів — Складські залишки — Тіло запиту

SalesLimitUpdate · Поля, типи й обмеження даних, які API приймає або повертає.

expected_versionЦіле числоОбов’язкове: Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1
reasonРядокНеобов’язкове: Записана причина зміни.

maxLength: 500

За замовчуванням: ""
sellable_limitЦіле числоОбов’язкове: Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

minimum: -1maximum: 2147483647

Приклад: 1

Додаткові поля: Ні

Створити · Коригування залишків — Складські залишки — Тіло запиту

StockAdjustmentCreate · Поля, типи й обмеження даних, які API приймає або повертає.

expected_versionЦіле числоОбов’язкове

Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 0maximum: 9223372036854775807

Приклад: 0

locationsМасив <LocationQuantity > Обов’язкове

Місця зберігання на складі.

minItems: 1maxItems: 100

Приклад: [{"location_id":"example","on_hand":1}]

reasonРядокОбов’язкове

Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Example"

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Обмеження

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum: ["product", "variant"]

Приклад: "product"

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Обмеження

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Приклад: "example"

Додаткові поля: Ні

Оновити · Залишки — Складські залишки — Тіло запиту

StockAdjustmentUpdate · Поля, типи й обмеження даних, які API приймає або повертає.

expected_versionЦіле числоОбов’язкове: Версія, прочитана перед записом; невідповідність блокує оновлення.

minimum: 1maximum: 9223372036854775807

Приклад: 1
locationsМасив <LocationQuantity > Обов’язкове: Місця зберігання на складі.

minItems: 1maxItems: 100

Приклад: [{"location_id":"example","on_hand":1}]
reasonРядокОбов’язкове: Записана причина зміни.

minLength: 1maxLength: 500

Приклад: "Example"

Додаткові поля: Ні

Отримати список · Залишки — Складські залишки — Відповідь

StockData · Поля, типи й обмеження даних, які API приймає або повертає.

activeЛогічне значенняОбов’язкове

Чи є ресурс активним.

Приклад: true

availableЦіле число nullОбов’язкове

Кількість, доступна для продажу; null означає необмежену кількість.

Приклад: 5

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (StockData).

Приклад: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedЦіле числоОбов’язкове

Кількість, зарезервована вручну.

Приклад: 2

on_handЦіле числоОбов’язкове

Фізична кількість на складі.

Приклад: 10

reservedЦіле числоОбов’язкове

Кількість, зарезервована замовленнями.

Приклад: 3

sellable_limitЦіле числоОбов’язкове

Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

Приклад: 10

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum: ["product", "variant"]

Приклад: "product"

total_reservedЦіле числоОбов’язкове

Загальна зарезервована кількість.

Приклад: 5

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

Додаткові поля: Ні

Отримати · Залишки — Складські залишки — Відповідь

StockDetailData · Поля, типи й обмеження даних, які API приймає або повертає.

activeЛогічне значенняОбов’язкове

Чи є ресурс активним.

Приклад: true

allocationsМасив <AllocationData > Обов’язкове

Кількості, розподілені між місцями зберігання на складі.

Приклад: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableЦіле число nullОбов’язкове

Кількість, доступна для продажу; null означає необмежену кількість.

Приклад: 5

idРядокОбов’язкове

Ідентифікатор ресурсу; зберігайте його в отриманому вигляді. (StockDetailData).

Приклад: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedЦіле числоОбов’язкове

Кількість, зарезервована вручну.

Приклад: 2

on_handЦіле числоОбов’язкове

Фізична кількість на складі.

Приклад: 10

reservedЦіле числоОбов’язкове

Кількість, зарезервована замовленнями.

Приклад: 3

sellable_limitЦіле числоОбов’язкове

Ліміт продажу: -1 означає відсутність ліміту, а 0 вимикає доступність продажу.

Приклад: 10

target_idРядокОбов’язкове

Ідентифікатор товару або варіанта, якого стосується операція.

Приклад: "example"

target_typeРядокОбов’язкове

Чи стосується операція товару або варіанта.

Обмеження

enum: ["product", "variant"]

Приклад: "product"

total_reservedЦіле числоОбов’язкове

Загальна зарезервована кількість.

Приклад: 5

updated_atРядокОбов’язкове

Час останнього оновлення.

format: "date-time"

Приклад: "2026-01-01T12:00:00Z"

versionЦіле числоОбов’язкове

Версія ресурсу для контролю одночасних змін.

Приклад: 1

warehouse_idРядокОбов’язкове

Ідентифікатор складу.

Приклад: "example"

Додаткові поля: Ні