Modele magazynów i lokalizacji

Schematy magazynów oraz ich lokalizacji w Shopently API. Poznaj pola identyfikatorów, strukturę lokalizacji i typy odpowiedzi.

Schematy danych

Pobierz lokalizacje magazynu — Odpowiedź

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

dataTablica <LocationData > Wymagane: Przykład odpowiedzi · ApiResponse_list_LocationData__.

Przykład: [{"code":"example","created_at":"2026-01-01T12:00:00Z","id":"example","is_leaf":true,"location_type":"zone","name":"Example","parent_id":null,"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 listę magazynów — Odpowiedź

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

dataTablica <WarehouseData > Wymagane: Przykład odpowiedzi · ApiResponse_list_WarehouseData__.

Przykład: [{"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}]
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 magazyn — Odpowiedź

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

dataWarehouseData Wymagane: Przykład odpowiedzi · WarehouseData.

Przykład: {"active":true,"address_line":"example","city":"example","code":"example","country_code":"PL","created_at":"2026-01-01T12:00:00Z","customer_visible":false,"id":"example","name":"Example","postal_code":"example","updated_at":"2026-01-01T12:00:00Z","version":1}
metaContextPageMeta ContextMeta PageMeta RequestMeta Wymagane: Metadane odpowiedzi.

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

Dodatkowe pola: Nie

Pobierz lokalizacje magazynu — Odpowiedź

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

codeTekstWymagane

Stały kod przeznaczony do przetwarzania przez integrację.

Przykład: "example"

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

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

idTekstWymagane

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

Przykład: "example"

is_leafWartość logicznaWymagane

Czy kategoria nie ma kategorii podrzędnych.

Przykład: true

location_typeTekstWymagane

Typ lokalizacji magazynowej.

Ograniczenia

enum: ["zone", "rack", "shelf", "bin"]

Przykład: "zone"

nameTekstWymagane

Nazwa zasobu we właściwym kontekście.

Przykład: "Example"

parent_idTekst nullWymagane

Identyfikator kategorii nadrzędnej.

Przykład: null

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

Lokalizacje magazynowe

LocationQuantity · Schemat · Modele magazynów i lokalizacji

location_idTekstWymagane

Identyfikator lokalizacji magazynowej.

Ograniczenia

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

Przykład: "example"

on_handLiczba całkowitaWymagane

Fizyczny stan magazynowy.

minimum: 0maximum: 2147483647

Przykład: 1

Dodatkowe pola: Nie

Pobierz magazyn — Odpowiedź

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

activeWartość logicznaWymagane: Czy zasób jest aktywny.

Przykład: true
address_lineTekst nullWymagane: Wiersz adresu.

Przykład: "example"
cityTekst nullWymagane: Miasto lub miejscowość.

Przykład: "example"
codeTekstWymagane: Stały kod przeznaczony do przetwarzania przez integrację.

Przykład: "example"
country_codeTekstWymagane: Kod kraju.

Przykład: "PL"
created_atTekstWymagane: Data i czas utworzenia.

format: "date-time"

Przykład: "2026-01-01T12:00:00Z"
customer_visibleWartość logicznaWymagane: Czy status jest widoczny dla klienta.

Przykład: false
idTekstWymagane: Identyfikator zasobu; zachowaj wartość zwróconą przez API. (WarehouseData).

Przykład: "example"
nameTekstWymagane: Nazwa zasobu we właściwym kontekście.

Przykład: "Example"
postal_codeTekst nullWymagane: Kod pocztowy.

Przykład: "example"
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

Dodatkowe pola: Nie