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

dataCodeContentData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"code":"DEMO-ONE","delivery_id":null,"kind":"code","payload_id":"00000000-0000-4000-8000-000000000004","unit_id":"00000000-0000-4000-8000-000000000003"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

dataDigitalUploadData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"consumer_id":"00000000-0000-4000-8000-000000000001","consumer_kind":"digital_import","expires_at":"2026-11-03T13:00:00Z","filename":"codes.txt","id":"00000000-0000-4000-8000-000000000002","product_id":"example","purpose":"digital_import","received_bytes":18,"sha256":"636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a","size_bytes":18,"status":"ready"}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

dataImportData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"delivery_id":null,"delivery_status":null,"delivery_version":null,"expected_count":2,"expires_at":"2026-11-03T13:00:00Z","id":"00000000-0000-4000-8000-000000000001","kind":"code","product_id":"example","status":"validated","validated_count":2,"validation_digest":"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb","version":2}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

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

dataPoolData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"configured":true,"counts":{"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0},"email_mode":"order_link","enabled":true,"order_version":2,"product_id":"example","retention_days":null,"version":1}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

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

dataUnitsData Wymagane

Dane poprawnej odpowiedzi.

Przykład: {"order_version":2,"total":1,"units":[{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Wymagane

Metadane odpowiedzi.

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

Dodatkowe pola: Nie

codeTekstWymagane

Dokładna treść kodu cyfrowego. Zachowaj wielkość liter i spacje wewnątrz kodu.

minLength: 1maxLength: 512

Przykład: "DEMO-ONE"

delivery_idTekst | nullOpcjonalne

Identyfikator dostawy albo przydziału wskazanego przez tę operację.

Tekst:format: "uuid"

Przykład: null

kindTekstOpcjonalne

Rodzaj struktury danych określony dozwolonymi wartościami.

const: "code"

Wartość domyślna: "code"Przykład: "code"

payload_idTekstWymagane

Identyfikator dokładnej rewizji kodu albo pliku. Nie jest publicznym adresem pobierania.

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000004"

unit_idTekstWymagane

Identyfikator jednego indywidualnego kodu albo pliku w puli produktu.

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000003"

Dodatkowe pola: Nie

consumer_idTekstWymagane

Identyfikator importu albo jednostki, do której przypisano upload.

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000001"

consumer_kindTekstWymagane

Typ odbiorcy uploadu: digital_import albo digital_unit.

Ograniczenia

enum

["digital_import", "digital_unit"]

Przykład: "digital_import"

filenameTekstWymagane

Plik

minLength: 1maxLength: 255

Przykład: "codes.txt"

purposeTekstWymagane

digital_import dla list kodów TXT/CSV; digital_unit dla plików sprzedawanych indywidualnie.

Ograniczenia

enum

["digital_unit", "digital_import"]

Przykład: "digital_import"

sha256TekstWymagane

SHA-256 (hex, 64)

Ograniczenia

pattern

"^[0-9a-f]{64}$"

Przykład: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

minimum: 1maximum: 262144000

Przykład: 18

Dodatkowe pola: Nie

consumer_idTekstWymagane

Identyfikator importu albo jednostki, do której przypisano upload.

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000001"

consumer_kindTekstWymagane

Typ odbiorcy uploadu: digital_import albo digital_unit.

Ograniczenia

enum

["digital_import", "digital_unit"]

Przykład: "digital_import"

expires_atTekstWymagane

Termin wygaśnięcia tego uploadu lub importu.

format: "date-time"

Przykład: "2026-11-03T13:00:00Z"

filenameTekstWymagane

Plik

Przykład: "codes.txt"

idTekstWymagane

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

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000002"

product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"

purposeTekstWymagane

digital_import dla list kodów TXT/CSV; digital_unit dla plików sprzedawanych indywidualnie.

Ograniczenia

enum

["digital_unit", "digital_import"]

Przykład: "digital_import"

received_bytesLiczba całkowitaWymagane

Przesyłanie… · Rozmiar w bajtach

Przykład: 18

sha256TekstWymagane

SHA-256 (hex, 64)

Przykład: "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a"

size_bytesLiczba całkowitaWymagane

Rozmiar w bajtach

Przykład: 18

statusTekstWymagane

Status obsługiwany przez daną operację.

Przykład: "ready"

Dodatkowe pola: Nie

delivered_atTekstWymagane

Data i czas dostawy.

format: "date-time"

Przykład: "2026-11-03T12:00:00Z"

expected_delivery_versionLiczba całkowitaWymagane

Bieżąca wersja dostawy magazynowej albo 0 przy tworzeniu dostawy.

minimum: 0maximum: 0

Przykład: 0

expected_sales_limit_versionLiczba całkowita | nullOpcjonalne

Bieżąca wersja limitu sprzedaży; wymagana wyłącznie przy publish_for_sale=true.

Liczba całkowita:minimum: 0maximum: 9223372036854775807

Przykład: 0

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 2

location_idTekstWymagane

Identyfikator lokalizacji magazynowej.

Ograniczenia

pattern

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

Przykład: "location-digital"

publish_for_saleWartość logicznaOpcjonalne

true zwiększa również skończony limit sprzedaży o przyjętą ilość; false pozostawia limit bez zmian.

Wartość domyślna: falsePrzykład: true

statusTekstWymagane

Status obsługiwany przez daną operację.

Ograniczenia

enum

["planned", "received"]

Przykład: "received"

validation_digestTekstWymagane

Suma kontrolna zwrócona przez walidację. Przekaż ją bez zmian do zatwierdzenia.

Ograniczenia

pattern

"^[0-9a-f]{64}$"

Przykład: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

warehouse_idTekstWymagane

Identyfikator magazynu.

Ograniczenia

pattern

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

Przykład: "warehouse-main"

Dodatkowe pola: Nie

countLiczba całkowitaWymagane

Dokładna liczba jednostek oczekiwanych w tym imporcie.

minimum: 1maximum: 1000

Przykład: 2

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum

["code", "file"]

Przykład: "code"

Dodatkowe pola: Nie

delivery_idTekst | nullWymagane

Identyfikator dostawy albo przydziału wskazanego przez tę operację.

Przykład: null

delivery_statusTekst | nullWymagane

Stan dostawy magazynowej: planned albo received; null przed zatwierdzeniem.

Przykład: null

delivery_versionLiczba całkowita | nullWymagane

Bieżąca wersja dostawy magazynowej; użyj jej przy przyjęciu lub korekcie tej dostawy.

Przykład: null

expected_countLiczba całkowitaWymagane

Zadeklarowana liczba jednostek w partii. Walidacja musi zaakceptować całą partię.

Przykład: 2

expires_atTekstWymagane

Termin wygaśnięcia tego uploadu lub importu.

format: "date-time"

Przykład: "2026-11-03T13:00:00Z"

idTekstWymagane

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

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000001"

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum

["code", "file"]

Przykład: "code"

product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"

statusTekstWymagane

Status obsługiwany przez daną operację.

Przykład: "validated"

validated_countLiczba całkowitaWymagane

Liczba jednostek zaakceptowanych przez ostatnią udaną walidację.

Przykład: 2

validation_digestTekst | nullWymagane

Suma kontrolna zwrócona przez walidację. Przekaż ją bez zmian do zatwierdzenia.

Przykład: "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"

versionLiczba całkowitaWymagane

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

Przykład: 2

Dodatkowe pola: Nie

expected_delivery_versionLiczba całkowitaWymagane

Bieżąca wersja dostawy magazynowej albo 0 przy tworzeniu dostawy.

minimum: 1maximum: 9223372036854775807

Przykład: 1

expected_sales_limit_versionLiczba całkowita | nullOpcjonalne

Bieżąca wersja limitu sprzedaży; wymagana wyłącznie przy publish_for_sale=true.

Liczba całkowita:minimum: 0maximum: 9223372036854775807

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 3

publish_for_saleWartość logicznaOpcjonalne

true zwiększa również skończony limit sprzedaży o przyjętą ilość; false pozostawia limit bez zmian.

Wartość domyślna: false

Dodatkowe pola: Nie

code_columnTekst | nullOpcjonalne

Kolumna CSV zawierająca kody; użyj code. Pomiń dla TXT i partii plików.

Tekst:const: "code"

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 1

formatTekst | nullOpcjonalne

Format listy kodów: txt albo csv. Partie plików używają zamiast tego upload_ids.

Ograniczenia · Tekst 1

enum

["txt", "csv"]

Przykład: "txt"

source_upload_idTekst | nullOpcjonalne

Gotowy prywatny upload TXT/CSV należący do tego importu.

Tekst:format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000002"

upload_idsTablica <Tekst> | nullOpcjonalne

Gotowe prywatne uploady plików należące do tego importu; 1–100 identyfikatorów.

Tablica:minItems: 1maxItems: 100

Tablica / Tablica:format: "uuid"

Dodatkowe pola: Nie

expected_delivery_versionLiczba całkowitaWymagane

Bieżąca wersja dostawy magazynowej albo 0 przy tworzeniu dostawy.

minimum: 1maximum: 9223372036854775807

Przykład: 1

expected_order_versionLiczba całkowitaWymagane

Bieżąca wersja kolejności przydzielania w puli, a nie wersja zamówienia klienta.

minimum: 0maximum: 9223372036854775807

Przykład: 1

expected_versionLiczba całkowitaWymagane

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

minimum: 1maximum: 9223372036854775807

Przykład: 3

reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500

Przykład: "Withdraw a revoked license"

Dodatkowe pola: Nie

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

email_modeTekstOpcjonalne

disabled nie wysyła wiadomości; order_link wysyła odnośnik do zamówienia; code_text może dodać kody w treści.

Ograniczenia

enum

["disabled", "order_link", "code_text"]

Wartość domyślna: "disabled"Przykład: "order_link"

enabledWartość logicznaWymagane

Czy ustawienie jest włączone.

Przykład: true

expected_versionLiczba całkowitaWymagane

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

minimum: 0maximum: 9223372036854775807

Przykład: 0

retention_daysLiczba całkowita | nullOpcjonalne

null zachowuje pliki bezterminowo; 1–3650 usuwa je po tylu dniach od pierwszego udostępnienia. Kody nie są usuwane automatycznie.

Liczba całkowita:minimum: 1maximum: 3650

Przykład: null

Dodatkowe pola: Nie

availableLiczba całkowitaWymagane

Liczba wolnych jednostek, które nie zostały zarezerwowane ani wydane.

Przykład: 1

heldLiczba całkowitaWymagane

Jednostki zarezerwowane dla zamówień, lecz jeszcze niewydane kupującym.

Przykład: 0

issuedLiczba całkowitaWymagane

Jednostki, które zostały już wydane w opłaconych zakupach.

Przykład: 1

plannedLiczba całkowitaWymagane

Jednostki w zatwierdzonych dostawach, których jeszcze nie przyjęto.

Przykład: 0

retiredLiczba całkowitaWymagane

Wycofane jednostki zachowane w historii magazynu.

Przykład: 0

stagedLiczba całkowitaWymagane

Jednostki w nieukończonych importach, jeszcze niedostępne w magazynie.

Przykład: 0

Dodatkowe pola: Nie

configuredWartość logicznaWymagane

Czy produkt ma zapisane ustawienia puli. Nie określa dostępności funkcji w planie.

Przykład: true

countsPoolCounts Wymagane

Liczby jednostek według stanu magazynowego; bez kodów i zawartości plików.

Przykład: {"available":1,"held":0,"issued":1,"planned":0,"retired":0,"staged":0}

email_modeTekstWymagane

disabled nie wysyła wiadomości; order_link wysyła odnośnik do zamówienia; code_text może dodać kody w treści.

Ograniczenia

enum

["disabled", "order_link", "code_text"]

Przykład: "order_link"

enabledWartość logicznaWymagane

Czy ustawienie jest włączone.

Przykład: true

order_versionLiczba całkowitaWymagane

Wersja kolejności przydzielania w puli. Przekaż ją jako expected_order_version przy zmianie kolejności.

Przykład: 2

product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"

retention_daysLiczba całkowita | nullWymagane

null zachowuje pliki bezterminowo; 1–3650 usuwa je po tylu dniach od pierwszego udostępnienia. Kody nie są usuwane automatycznie.

Przykład: null

versionLiczba całkowitaWymagane

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

Przykład: 1

Dodatkowe pola: Nie

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

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

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

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

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

content_stateTekstWymagane

Stan zawartości: present, deleting albo deleted. Wpis historii może pozostać po usunięciu.

Przykład: "present"

delivery_idTekst | nullWymagane

Identyfikator dostawy albo przydziału wskazanego przez tę operację.

Przykład: "delivery-example"

filenameTekst | nullWymagane

Plik

Przykład: null

idTekstWymagane

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

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000003"

issued_atTekst | nullWymagane

Czas pierwszego wydania jednostki albo null, jeśli jeszcze jej nie wydano.

Tekst:format: "date-time"

Przykład: null

kindTekstWymagane

Rodzaj struktury danych określony dozwolonymi wartościami.

Ograniczenia

enum

["file", "code"]

Przykład: "code"

location_idTekst | nullWymagane

Identyfikator lokalizacji magazynowej.

Przykład: "location-digital"

mime_typeTekst | nullWymagane

Typ zawartości zasobu multimedialnego.

Przykład: null

payload_idTekstWymagane

Identyfikator dokładnej rewizji kodu albo pliku. Nie jest publicznym adresem pobierania.

format: "uuid"

Przykład: "00000000-0000-4000-8000-000000000004"

product_idTekstWymagane

Identyfikator produktu.

Przykład: "example"

size_bytesLiczba całkowita | nullWymagane

Rozmiar w bajtach

Przykład: null

sort_orderLiczba całkowitaWymagane

Pozycja w uporządkowanej kolekcji.

Przykład: 1

stateTekstWymagane

Status

Przykład: "available"

versionLiczba całkowitaWymagane

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

Przykład: 1

warehouse_idTekst | nullWymagane

Identyfikator magazynu.

Przykład: "warehouse-main"

Dodatkowe pola: Nie

expected_versionLiczba całkowitaWymagane

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

minimum: 1

Przykład: 1

reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500

Przykład: "Withdraw a revoked license"

Dodatkowe pola: Nie

expected_order_versionLiczba całkowitaWymagane

Bieżąca wersja kolejności przydzielania w puli, a nie wersja zamówienia klienta.

minimum: 1

Przykład: 1

unit_idsTablica <Tekst> Wymagane

Wszystkie jednostki z niefiltrowanej strony, ułożone w żądanej kolejności.

minItems: 2maxItems: 100

Tablica:format: "uuid"

Przykład: ["00000000-0000-4000-8000-000000000008","00000000-0000-4000-8000-000000000003"]

window_cursorTekst | nullOpcjonalne

Kursor wskazujący pełną niefiltrowaną stronę, której kolejność zmieniasz; null dla pierwszej strony.

Tekst:maxLength: 1024

Dodatkowe pola: Nie

codeTekst | nullOpcjonalne

Dokładna treść kodu cyfrowego. Zachowaj wielkość liter i spacje wewnątrz kodu.

Tekst:minLength: 1maxLength: 512

Przykład: "SYNTHETIC-REPLACEMENT"

expected_versionLiczba całkowitaWymagane

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

minimum: 1

Przykład: 1

reasonTekstWymagane

Powód zapisany dla zmiany.

minLength: 1maxLength: 500

Przykład: "Replace an invalid activation code"

upload_idTekst | nullOpcjonalne

Identyfikator zasobu; zachowaj wartość zwróconą przez API. · upload_id

Tekst:format: "uuid"

Dodatkowe pola: Nie

order_versionLiczba całkowitaWymagane

Wersja kolejności przydzielania w puli. Przekaż ją jako expected_order_version przy zmianie kolejności.

Przykład: 2

totalLiczba całkowitaWymagane

Łączna kwota.

Przykład: 1

unitsTablica <UnitData > Wymagane

Strona metadanych jednostek. Kody wymagają osobnego, uwierzytelnionego żądania treści.

Przykład: [{"content_state":"present","delivery_id":"delivery-example","filename":null,"id":"00000000-0000-4000-8000-000000000003","issued_at":null,"kind":"code","location_id":"location-digital","mime_type":null,"payload_id":"00000000-0000-4000-8000-000000000004","product_id":"example","size_bytes":null,"sort_order":1,"state":"available","version":1,"warehouse_id":"warehouse-main"}]

Dodatkowe pola: Tak