Modele dostaw magazynowych

Schematy tworzenia i odczytu dostaw magazynowych w Shopently API. Poznaj pozycje dostawy, statusy i strukturę odpowiedzi.

Schematy danych

Pobierz dostawę magazynową — Odpowiedź

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

dataDeliveryDetailData Wymagane: Przykład odpowiedzi · DeliveryDetailData.

Przykład: {"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","notes":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Pobierz listę dostaw magazynowych — Odpowiedź

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

dataTablica <DeliveryData > Wymagane: Przykład odpowiedzi · ApiResponse_list_DeliveryData__.

Przykład: [{"created_at":"2026-01-01T12:00:00Z","deleted_at":null,"delivered_at":"2026-01-01T12:00:00Z","id":"example","increases_stock":true,"location_id":"example","quantity":1,"received_at":null,"record_status":"active","status":"planned","stock_applied_at":null,"target_id":"example","target_type":"product","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

Utwórz dostawę magazynową — Treść żądania

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

delivered_atTekstWymagane

Data i czas dostawy.

format: "date-time"

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

increases_stockWartość logicznaOpcjonalne

Czy przyjęcie dostawy zwiększa stan magazynowy.

Wartość domyślna: true

location_idTekstWymagane

Identyfikator lokalizacji magazynowej.

Ograniczenia

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

Przykład: "example"

notesTekstOpcjonalne

Dodatkowe uwagi.

maxLength: 2000

Wartość domyślna: ""

quantityLiczba całkowitaWymagane

Liczba jednostek.

minimum: 1maximum: 2147483647

Przykład: 1

reasonTekstOpcjonalne

Powód zapisany dla zmiany.

maxLength: 500

Wartość domyślna: ""

statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia

enum: ["planned", "received"]

Przykład: "planned"

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

Pobierz listę dostaw magazynowych — Odpowiedź

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

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

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

deleted_atTekst nullWymagane

Data i czas usunięcia, jeśli występuje.

Tekst:format: "date-time"

Przykład: null

delivered_atTekstWymagane

Data i czas dostawy.

format: "date-time"

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

idTekstWymagane

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

Przykład: "example"

increases_stockWartość logicznaWymagane

Czy przyjęcie dostawy zwiększa stan magazynowy.

Przykład: true

location_idTekstWymagane

Identyfikator lokalizacji magazynowej.

Przykład: "example"

quantityLiczba całkowitaWymagane

Liczba jednostek.

Przykład: 1

received_atTekst nullWymagane

Data i czas przyjęcia dostawy.

Tekst:format: "date-time"

Przykład: null

record_statusTekstWymagane

Zapisany status rekordu.

Ograniczenia

enum: ["active", "deleted"]

Przykład: "active"

statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia

enum: ["planned", "received"]

Przykład: "planned"

stock_applied_atTekst nullWymagane

Data i czas zastosowania zmiany stanu z dostawy.

Tekst:format: "date-time"

Przykład: null

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"

updated_atTekst nullWymagane

Data i czas ostatniej aktualizacji.

Tekst: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 dostawę magazynową — Odpowiedź

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

created_atTekstWymagane

Data i czas utworzenia.

format: "date-time"

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

deleted_atTekst nullWymagane

Data i czas usunięcia, jeśli występuje.

Tekst:format: "date-time"

Przykład: null

delivered_atTekstWymagane

Data i czas dostawy.

format: "date-time"

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

idTekstWymagane

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

Przykład: "example"

increases_stockWartość logicznaWymagane

Czy przyjęcie dostawy zwiększa stan magazynowy.

Przykład: true

location_idTekstWymagane

Identyfikator lokalizacji magazynowej.

Przykład: "example"

notesTekst nullWymagane

Dodatkowe uwagi.

Przykład: "example"

quantityLiczba całkowitaWymagane

Liczba jednostek.

Przykład: 1

received_atTekst nullWymagane

Data i czas przyjęcia dostawy.

Tekst:format: "date-time"

Przykład: null

record_statusTekstWymagane

Zapisany status rekordu.

Ograniczenia

enum: ["active", "deleted"]

Przykład: "active"

statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia

enum: ["planned", "received"]

Przykład: "planned"

stock_applied_atTekst nullWymagane

Data i czas zastosowania zmiany stanu z dostawy.

Tekst:format: "date-time"

Przykład: null

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"

updated_atTekst nullWymagane

Data i czas ostatniej aktualizacji.

Tekst: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