Схеми на данните: Складови наличности

Схеми на данните: Складови наличности. Полета, типове и ограничения на данните, приемани или връщани от 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"

Допълнителни полета: Не