Modele stanów magazynowych

Schematy stanów, korekt, limitów sprzedaży i rezerwacji ręcznych w Shopently API. Sprawdź wymagane pola oraz typy danych.

Schematy danych

Ilości przypisane do lokalizacji magazynowych

AllocationData · Schemat · Modele stanów magazynowych

location_codeTekstWymagane: Kod lokalizacji magazynowej.

Przykład: "example"
location_idTekstWymagane: Identyfikator lokalizacji magazynowej.

Przykład: "example"
location_nameTekstWymagane: Nazwa lokalizacji magazynowej.

Przykład: "example"
on_handLiczba całkowitaWymagane: Fizyczny stan magazynowy.

Przykład: 10

Dodatkowe pola: Nie

Pobierz listę stanów magazynowych — Odpowiedź

ApiResponse_list_StockData__ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataTablica <StockData > Wymagane: Przykład odpowiedzi · ApiResponse_list_StockData__.

Przykład: [{"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 Wymagane: Metadane odpowiedzi.

Przykład: {"pagination":{"has_more":false,"limit":20,"next_cursor":null},"request_id":"example"}

Dodatkowe pola: Nie

Pobierz stan magazynowy — Odpowiedź

ApiResponse_StockDetailData_ · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

dataStockDetailData Wymagane: Przykład odpowiedzi · StockDetailData.

Przykład: {"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 Wymagane: Metadane odpowiedzi.

Przykład: {"request_id":"example"}

Dodatkowe pola: Nie

Zmień rezerwację ręczną — Treść żądania

ManualReservationUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

expected_versionLiczba całkowitaWymagane: Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1
manual_reservedLiczba całkowitaWymagane: Ilość zarezerwowana ręcznie.

minimum: 0maximum: 2147483647

Przykład: 1
reasonTekstOpcjonalne: Powód zapisany dla zmiany.

maxLength: 500

Wartość domyślna: ""

Dodatkowe pola: Nie

Zmień limit sprzedaży — Treść żądania

SalesLimitUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

expected_versionLiczba całkowitaWymagane: Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1
reasonTekstOpcjonalne: Powód zapisany dla zmiany.

maxLength: 500

Wartość domyślna: ""
sellable_limitLiczba całkowitaWymagane: Limit sprzedaży: -1 oznacza brak limitu, a 0 wyłącza dostępną sprzedaż.

minimum: -1maximum: 2147483647

Przykład: 1

Dodatkowe pola: Nie

Utwórz korektę stanu magazynowego — Treść żądania

StockAdjustmentCreate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

expected_versionLiczba całkowitaWymagane

Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 0maximum: 9223372036854775807

Przykład: 0

locationsTablica <LocationQuantity > Wymagane

Lokalizacje magazynowe.

minItems: 1maxItems: 100

Przykład: [{"location_id":"example","on_hand":1}]

reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500

Przykład: "Example"

target_idTekstWymagane

Identyfikator produktu lub wariantu objętego operacją.

Ograniczenia

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

Przykład: "example"

target_typeTekstWymagane

Czy operacja dotyczy produktu, czy wariantu.

Ograniczenia

enum: ["product", "variant"]

Przykład: "product"

warehouse_idTekstWymagane

Identyfikator magazynu.

Ograniczenia

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

Przykład: "example"

Dodatkowe pola: Nie

Zmień stan magazynowy — Treść żądania

StockAdjustmentUpdate · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

expected_versionLiczba całkowitaWymagane: Wersja odczytana przed zapisem; niezgodność powoduje odrzucenie zmiany.

minimum: 1maximum: 9223372036854775807

Przykład: 1
locationsTablica <LocationQuantity > Wymagane: Lokalizacje magazynowe.

minItems: 1maxItems: 100

Przykład: [{"location_id":"example","on_hand":1}]
reasonTekstWymagane: Powód zapisany dla zmiany.

minLength: 1maxLength: 500

Przykład: "Example"

Dodatkowe pola: Nie

Pobierz listę stanów magazynowych — Odpowiedź

StockData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

activeWartość logicznaWymagane

Czy zasób jest aktywny.

Przykład: true

availableLiczba całkowita nullWymagane

Ilość dostępna do sprzedaży; null oznacza brak ograniczenia ilości.

Przykład: 5

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (StockData).

Przykład: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedLiczba całkowitaWymagane

Ilość zarezerwowana ręcznie.

Przykład: 2

on_handLiczba całkowitaWymagane

Fizyczny stan magazynowy.

Przykład: 10

reservedLiczba całkowitaWymagane

Ilość zarezerwowana przez zamówienia.

Przykład: 3

sellable_limitLiczba całkowitaWymagane

Limit sprzedaży: -1 oznacza brak limitu, a 0 wyłącza dostępną sprzedaż.

Przykład: 10

target_idTekstWymagane

Identyfikator produktu lub wariantu objętego operacją.

Przykład: "example"

target_typeTekstWymagane

Czy operacja dotyczy produktu, czy wariantu.

Ograniczenia

enum: ["product", "variant"]

Przykład: "product"

total_reservedLiczba całkowitaWymagane

Łączna zarezerwowana ilość.

Przykład: 5

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

warehouse_idTekstWymagane

Identyfikator magazynu.

Przykład: "example"

Dodatkowe pola: Nie

Pobierz stan magazynowy — Odpowiedź

StockDetailData · Pola, typy i ograniczenia danych przyjmowanych lub zwracanych przez API.

activeWartość logicznaWymagane

Czy zasób jest aktywny.

Przykład: true

allocationsTablica <AllocationData > Wymagane

Ilości przypisane do lokalizacji magazynowych.

Przykład: [{"location_code":"example","location_id":"example","location_name":"example","on_hand":10}]

availableLiczba całkowita nullWymagane

Ilość dostępna do sprzedaży; null oznacza brak ograniczenia ilości.

Przykład: 5

idTekstWymagane

Identyfikator zasobu; zachowaj wartość zwróconą przez API. (StockDetailData).

Przykład: "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ"

manual_reservedLiczba całkowitaWymagane

Ilość zarezerwowana ręcznie.

Przykład: 2

on_handLiczba całkowitaWymagane

Fizyczny stan magazynowy.

Przykład: 10

reservedLiczba całkowitaWymagane

Ilość zarezerwowana przez zamówienia.

Przykład: 3

sellable_limitLiczba całkowitaWymagane

Limit sprzedaży: -1 oznacza brak limitu, a 0 wyłącza dostępną sprzedaż.

Przykład: 10

target_idTekstWymagane

Identyfikator produktu lub wariantu objętego operacją.

Przykład: "example"

target_typeTekstWymagane

Czy operacja dotyczy produktu, czy wariantu.

Ograniczenia

enum: ["product", "variant"]

Przykład: "product"

total_reservedLiczba całkowitaWymagane

Łączna zarezerwowana ilość.

Przykład: 5

updated_atTekstWymagane

Data i czas ostatniej aktualizacji.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"

versionLiczba całkowitaWymagane

Wersja zasobu używana do kontroli współbieżności.

Przykład: 1

warehouse_idTekstWymagane

Identyfikator magazynu.

Przykład: "example"

Dodatkowe pola: Nie