Open Supply Chain Platform (wersja zapoznawcza)
Usługa Open Supply Chain Platform (OSCP) udostępnia zaawansowany i rozbudowany interfejs API REST. Korzystając z tych interfejsów API, klient może utworzyć magazyn OrderFulfillment i zarządzać nim w środowisku OSCP. OSCP integruje się z wieloma partnerami, w tym detalistami, dostawcami logistycznymi i firmami magazynowymi, a także zapewni kompleksowe efektywność w całym łańcuchu dostaw, integrując dane, operacje i analizy między partnerami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Service | Klasa | Regiony |
|---|---|---|
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: - Azure Government regionów - Azure regionach Chin - Departament Obrony USA (DoD) |
| Kontakt biznesowy | |
|---|---|
| Nazwa | Microsoft |
| adres URL | https://azure.microsoft.com/support/ |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft Corporation |
| Witryna internetowa | https://azure.microsoft.com/ |
| Zasady ochrony prywatności | https://www.microsoft.com/en-in/trust-center/privacy |
| Kategorie | Kolaboracja; Dane |
Open Supply Chain Platform (OSCP) to usługa platformy Azure, która zapewnia rozszerzalną platformę umożliwiającą odnajdywanie, używanie i rozszerzanie wbudowanych aplikacji łańcucha dostaw utworzonych przez firmę Microsoft i partnerów. Te aplikacje ułatwiają organizacjom odblokowanie cennych informacji biznesowych i wydajności z danych w organizacji i poza nią.
Wymagania wstępne
Aby korzystać z tego łącznika, musisz być użytkownikiem aplikacji OSCP. Musisz mieć obszar roboczy utworzony w programie OSCP. Musisz użyć identyfikatora Entra firmy Microsoft.
Jak uzyskać poświadczenia
Aby dodać ten łącznik do przepływu pracy, musisz najpierw zalogować się do konta Microsoft Entra ID za pomocą roli OSCP (Contibutor/Reader) w aplikacji OSCP, z którą chcesz nawiązać połączenie.
Typowe błędy i środki zaradcze
Jeśli użytkownik nie ma dostępu do kontibutora OSCP w obszarze roboczym, użytkownik otrzyma błąd nie znaleziono obszaru roboczego (404). Aby rozwiązać ten problem, użytkownik musi mieć dostęp do programu OSCP contibutor dla obszaru roboczego.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Nazwa | Typ | Opis | Wymagane |
|---|---|---|---|
| Identyfikator obszaru roboczego | ciąg | Określ tylko identyfikator obszaru roboczego | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizuje plan realizacji |
Aktualizuje plan realizacji podany na podstawie identyfikatora obszaru roboczego, identyfikatora planu realizacji i ładunku planu realizacji. |
| Aktualizuje przesyłkę |
Aktualizuje przesyłkę. |
| Aktualizuje zamówienie wysyłki |
Aktualizuje zamówienie wysyłki. |
| Aktualizuje żądanie oferty wysyłki |
Aktualizuje żądanie oferty wysyłki. |
| Anuluje realizację zamówienia według identyfikatora realizacji zamówienia |
Anuluje realizację zamówienia według identyfikatora realizacji zamówienia. |
| Generuje opcje realizacji |
Generuje opcje realizacji dla danego identyfikatora obszaru roboczego i żądania realizacji |
| Pobiera element |
Pobiera element dla danego identyfikatora obszaru roboczego i jednostki SKU. |
| Pobiera element magazynu według identyfikatora magazynu i jednostki SKU elementu |
Pobiera element magazynu według identyfikatora magazynu i jednostki SKU elementu. |
| Pobiera listę planów realizacji z określonym stanem realizacji |
Pobiera listę planów realizacji z określonym stanem realizacji dla danego identyfikatora obszaru roboczego i identyfikatora magazynu. |
| Pobiera magazyn według identyfikatora magazynu |
Pobiera magazyn według identyfikatora magazynu. |
| Pobiera ofertę wysyłki |
Pobiera ofertę wysyłki. |
| Pobiera plan realizacji |
Pobiera plan realizacji dla danego identyfikatora obszaru roboczego i identyfikatora planu realizacji. |
| Pobiera podkatalogi zestawu danych |
Pobiera podkatalogi zestawu danych o określonej nazwie. |
| Pobiera przebieg przepływu danych dla identyfikatora przebiegu |
Pobiera przebieg przepływu danych dla danego identyfikatora przebiegu. |
| Pobiera przepływ danych |
Pobiera przepływ danych dla danej nazwy i obszaru roboczego. |
| Pobiera przepływ danych |
Pobiera przepływ danych dla danej nazwy i obszaru roboczego. |
| Pobiera przesyłkę według identyfikatora przesyłki |
Pobiera przesyłkę według identyfikatora przesyłki. |
| Pobiera przewoźnika z identyfikatorem operatora |
Pobiera przewoźnika z identyfikatorem operatora dla obszaru roboczego. |
| Pobiera realizację zamówienia według identyfikatora realizacji zamówienia |
Pobiera realizację zamówienia według identyfikatora realizacji zamówienia. |
| Pobiera szczegóły przebiegu dla danego przepływu danych i identyfikator uruchomienia |
Pobiera szczegóły przebiegu dla podanej nazwy przepływu danych i identyfikator uruchomienia. |
| Pobiera wszystkie magazyny dla obszaru roboczego |
Pobiera wszystkie magazyny dla obszaru roboczego. |
| Pobiera wszystkie przepływy danych |
Pobiera wszystkie przepływy danych dla danego obszaru roboczego. |
| Pobiera wszystkie przepływy danych dla obszaru roboczego |
Pobiera wszystkie przepływy danych dla danego obszaru roboczego. |
| Pobiera wszystkie zestawy danych dla obszaru roboczego |
Pobiera wszystkie zestawy danych dla obszaru roboczego. |
| Pobiera węzeł dostarczania |
Pobiera węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania. |
| Pobiera węzły dostarczania dla danego obszaru roboczego |
Pobiera węzły dostarczania dla danego identyfikatora obszaru roboczego. |
| Pobiera zamówienie wysyłki |
Pobiera zamówienie wysyłki. |
| Pobiera zestaw danych o określonej nazwie |
Pobiera zestaw danych o określonej nazwie. |
| Pobiera żądanie oferty wysyłki |
Pobiera żądanie oferty wysyłki. |
| Tworzy listę magazynów |
Tworzy listę magazynów dla danego identyfikatora obszaru roboczego i listę obiektów magazynu. |
| Tworzy listę zamówień wysyłki |
Tworzy listę zamówień wysyłki. |
| Tworzy lub aktualizuje element |
Tworzy lub aktualizuje element dla danego identyfikatora obszaru roboczego i jednostki SKU. |
| Tworzy lub aktualizuje element magazynu |
Tworzy lub aktualizuje element magazynu według identyfikatora magazynu i jednostki SKU elementu. |
| Tworzy lub aktualizuje listę elementów |
Tworzy lub aktualizuje listę elementów dla danego identyfikatora obszaru roboczego i jednostek SKU. |
| Tworzy lub aktualizuje listę elementów magazynu |
Tworzy lub aktualizuje listę elementów magazynu według identyfikatora magazynu i jednostki SKU elementu. |
| Tworzy lub aktualizuje listę węzłów dostarczania |
Tworzy lub aktualizuje listę węzłów dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania. |
| Tworzy lub aktualizuje magazyn |
Tworzy lub aktualizuje magazyn według identyfikatora magazynu. |
| Tworzy lub aktualizuje ofertę wysyłki |
Tworzy lub aktualizuje ofertę wysyłki. |
| Tworzy lub aktualizuje operatora przy użyciu identyfikatora operatora |
Tworzy lub aktualizuje operatora o identyfikatorze operatora dla obszaru roboczego. |
| Tworzy lub aktualizuje przepływ danych |
Tworzy lub aktualizuje przepływ danych dla obszaru roboczego. |
| Tworzy lub aktualizuje przepływ danych |
Tworzy lub aktualizuje przepływ danych dla obszaru roboczego. |
| Tworzy lub aktualizuje węzeł dostarczania |
Tworzy lub aktualizuje węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania. |
| Tworzy lub aktualizuje zestaw danych |
Tworzy lub aktualizuje zestaw danych o określonej nazwie. |
| Tworzy nowe zamówienie realizacji dla identyfikatora realizacji zamówienia |
Tworzy nowe zamówienie realizacji dla identyfikatora realizacji zamówienia. |
| Tworzy przesyłkę |
Tworzy przesyłkę. |
| Tworzy zamówienie wysyłki |
Tworzy zamówienie wysyłki. |
| Tworzy żądanie oferty wysyłki |
Tworzy żądanie oferty wysyłki. |
| Tworzy żądanie uruchomienia przepływu danych |
Tworzy żądanie uruchomienia przepływu danych dla obszaru roboczego. |
| Usuwa element dla danej jednostki SKU |
Usuwa element dla danej jednostki SKU. |
| Usuwa element magazynu według identyfikatora magazynu i jednostki SKU elementu |
Usuwa element magazynu według identyfikatora magazynu i jednostki SKU elementu. |
| Usuwa listę elementów dla danej jednostki SKU |
Usuwa listę elementów dla danej jednostki SKU. |
| Usuwa listę elementów magazynu według identyfikatorów magazynu |
Usuwa listę elementów magazynu według identyfikatorów magazynu. |
| Usuwa listę magazynów |
Usuwa listę magazynów dla danego identyfikatora obszaru roboczego i listę identyfikatorów magazynu |
| Usuwa listę węzłów dostarczania |
Usuwa węzły dostarczania dla podanych identyfikatorów węzłów dostarczania. |
| Usuwa magazyn według identyfikatora magazynu |
Usuwa magazyn według identyfikatora magazynu. |
| Usuwa przepływ danych |
Usuwa przepływ danych dla danej nazwy i obszaru roboczego. |
| Usuwa przepływ danych |
Usuwa przepływ danych dla danej nazwy i obszaru roboczego. |
| Usuwa przewoźnika z identyfikatorem operatora |
Usuwa operatora z identyfikatorem operatora dla obszaru roboczego. |
| Usuwa węzeł dostarczania |
Usuwa węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania. |
| Usuwa zestaw danych o określonej nazwie |
Usuwa zestaw danych o określonej nazwie. |
| Wyzwala przebieg dla wystąpienia przepływu danych |
Wyzwala przebieg dla wystąpienia przepływu danych dla danej nazwy. |
| Wyświetl listę wszystkich przebiegów dla danego przepływu danych |
Wyświetl listę wszystkich przebiegów dla danej nazwy przepływu danych. |
| Wyświetl listę wszystkich przebiegów dla danego przepływu danych |
Wyświetl listę wszystkich przebiegów dla podanej nazwy przepływu danych. |
Aktualizuje plan realizacji
Aktualizuje plan realizacji podany na podstawie identyfikatora obszaru roboczego, identyfikatora planu realizacji i ładunku planu realizacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator planu realizacji.
|
fulfillmentPlanId | True | string |
Identyfikator planu realizacji. |
|
id
|
id | string |
Unikatowy identyfikator realizacji. |
|
|
warehouseId
|
warehouseId | string |
Unikatowy identyfikator magazynu. |
|
|
scheduledExecutionTime
|
scheduledExecutionTime | string | ||
|
identyfikator zamówienia
|
orderId | True | string |
Unikatowy numer identyfikujący zamówienie. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementów. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
Najwcześniejsza data/godzina dostarczenia zamówienia. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Najpóźniejsza data/godzina dostarczenia zamówienia. |
|
id
|
id | True | string |
Unikatowy identyfikator przesyłki. |
|
stan
|
status | string |
Stan przesyłki. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
Lista identyfikatorów zamówień wysyłki, które są obsługiwane przez przesyłkę. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
trackingNumber (numer przesyłki)
|
trackingNumber | string |
Numer śledzenia |
|
|
trackingUrl
|
trackingUrl | string |
Adres URL śledzenia |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Adres URL etykiety wysyłki |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy przesyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o przesyłkach przechwycone jako pary klucz-wartość. |
|
|
carrierName
|
carrierName | string |
Nazwa przewoźnika dla przesyłki |
|
|
stan
|
status | string |
Stan planu realizacji. |
|
|
powód statusu
|
statusReason | string | ||
|
czasUtworzenia
|
creationTime | string |
Sygnatura czasowa utworzona przez plan realizacji. |
Zwraca
Planowane lub rzeczywiste działania związane z wykonaniem zamówienia. Te działania mogą obejmować tworzenie listy wyboru, wykonywanie listy wyboru, pakowanie i wysyłkę elementów do końcowego miejsca docelowego.
- Body
- FulfillmentPlan
Aktualizuje przesyłkę
Aktualizuje przesyłkę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przesyłki.
|
shipmentId | True | string |
Identyfikator przesyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator przesyłki. |
|
stan
|
status | string |
Stan przesyłki. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
Lista identyfikatorów zamówień wysyłki, które są obsługiwane przez przesyłkę. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
trackingNumber (numer przesyłki)
|
trackingNumber | string |
Numer śledzenia |
|
|
trackingUrl
|
trackingUrl | string |
Adres URL śledzenia |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Adres URL etykiety wysyłki |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy przesyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o przesyłkach przechwycone jako pary klucz-wartość. |
|
|
carrierName
|
carrierName | string |
Nazwa przewoźnika dla przesyłki |
Zwraca
Ilość przedmiotów, towarów lub ładunków zbiorczych, które są dostarczane razem.
- Body
- Shipment
Aktualizuje zamówienie wysyłki
Aktualizuje zamówienie wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia wysyłki.
|
shipmentOrderId | True | string |
Identyfikator zamówienia wysyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator zamówienia wysyłki. |
|
identyfikator wysyłki
|
shipmentId | string |
Identyfikator przesyłki, która wysyła to zamówienie wysyłki. |
|
|
stan
|
status | string |
Stan zamówienia wysyłki. |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy zamówienia wysyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o zamówieniu wysyłki przechwycone jako pary klucz-wartość. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp.
- Body
- ShipmentOrder
Aktualizuje żądanie oferty wysyłki
Aktualizuje żądanie oferty wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator żądania oferty wysyłki.
|
shipmentQuoteRequestId | True | string |
Identyfikator żądania oferty wysyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator żądania oferty wysyłki. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identyfikatory ofert wysyłki odpowiadające żądaniu oferty wysyłki |
|
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru przesyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy przesyłki. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Szczegóły żądania oferty wysyłki
- Body
- ShipmentQuoteRequest
Anuluje realizację zamówienia według identyfikatora realizacji zamówienia
Anuluje realizację zamówienia według identyfikatora realizacji zamówienia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator realizacji zamówienia.
|
orderFulfillmentId | True | string |
Identyfikator realizacji zamówienia. |
Zwraca
- Body
- OrderFulfillment
Generuje opcje realizacji
Generuje opcje realizacji dla danego identyfikatora obszaru roboczego i żądania realizacji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
identyfikator zamówienia
|
orderId | True | string |
Unikatowy numer identyfikujący zamówienie. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementów. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
Najwcześniejsza data/godzina dostarczenia zamówienia. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Najpóźniejsza data/godzina dostarczenia zamówienia. |
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
maxNumOfFulfillmentOptions
|
maxNumOfFulfillmentOptions | True | integer | |
|
nazwa
|
name | string |
Nazwa elementu. |
|
|
opis
|
description | string |
Opis elementu. |
|
|
wartość
|
value | True | string |
Wartość kodu kreskowego. |
|
standardName
|
standardName | True | string |
Standardowa nazwa kodu kreskowego. |
|
weight
|
weight | True | double |
Waga elementu standardowego. |
|
length
|
length | True | double |
Długość elementu standardowego. |
|
width
|
width | True | double |
Standardowa szerokość elementu. |
|
głębokość
|
depth | True | double |
Głębokość elementu standardowego. |
|
skrót
|
abbreviation | True | string |
Długość, szerokość i jednostka wysokości miary. |
|
skrót
|
abbreviation | True | string |
Jednostka wagi miary. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
sku
|
sku | True | string |
Identyfikator jednostki przechowywania zapasów, który jest zwykle używany do działań związanych z spisem. |
|
labels
|
labels | array of string |
Etykiety |
|
|
warehouseId
|
warehouseId | string | ||
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Ilość. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
warehouseId
|
warehouseId | string |
Jednostka SKU elementu. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniego uzyskania tego elementu WarehouseItem |
|
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
Zwraca
Pobiera element
Pobiera element dla danego identyfikatora obszaru roboczego i jednostki SKU.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Jednostka SKU elementu.
|
sku | True | string |
Jednostka SKU elementu. |
Zwraca
Coś, co jest spisane. Jednostka SKU, jednostka przechowywania zapasów, odnosi się do określonego elementu w określonej jednostce miary.
- Body
- Item
Pobiera element magazynu według identyfikatora magazynu i jednostki SKU elementu
Pobiera element magazynu według identyfikatora magazynu i jednostki SKU elementu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
Jednostka SKU elementu.
|
itemSKU | True | string |
Jednostka SKU elementu. |
Zwraca
- Body
- WarehouseItem
Pobiera listę planów realizacji z określonym stanem realizacji
Pobiera listę planów realizacji z określonym stanem realizacji dla danego identyfikatora obszaru roboczego i identyfikatora magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | string |
Identyfikator magazynu. |
|
|
Stan realizacji.
|
status | string |
Stan realizacji. |
Zwraca
- response
- array of FulfillmentPlan
Pobiera magazyn według identyfikatora magazynu
Pobiera magazyn według identyfikatora magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
Zwraca
- Body
- Warehouse
Pobiera ofertę wysyłki
Pobiera ofertę wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator oferty wysyłki.
|
shipmentQuoteId | True | string |
Identyfikator oferty wysyłki. |
Zwraca
Szczegóły oferty wysyłki
- Body
- ShipmentQuote
Pobiera plan realizacji
Pobiera plan realizacji dla danego identyfikatora obszaru roboczego i identyfikatora planu realizacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator planu realizacji.
|
fulfillmentPlanId | True | string |
Identyfikator planu realizacji. |
Zwraca
Planowane lub rzeczywiste działania związane z wykonaniem zamówienia. Te działania mogą obejmować tworzenie listy wyboru, wykonywanie listy wyboru, pakowanie i wysyłkę elementów do końcowego miejsca docelowego.
- Body
- FulfillmentPlan
Pobiera podkatalogi zestawu danych
Pobiera podkatalogi zestawu danych o określonej nazwie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa zestawu danych.
|
name | True | string |
Nazwa zestawu danych. |
Zwraca
- response
- array of Directory
Pobiera przebieg przepływu danych dla identyfikatora przebiegu
Pobiera przebieg przepływu danych dla danego identyfikatora przebiegu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
Identyfikator przebiegu przepływu danych.
|
dataInflowRunId | True | string |
Identyfikator przebiegu przepływu danych. |
Zwraca
- Body
- DataInflowRun
Pobiera przepływ danych
Pobiera przepływ danych dla danej nazwy i obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- Body
- DataInflow
Pobiera przepływ danych
Pobiera przepływ danych dla danej nazwy i obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- Body
- DataOutflow
Pobiera przesyłkę według identyfikatora przesyłki
Pobiera przesyłkę według identyfikatora przesyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przesyłki.
|
shipmentId | True | string |
Identyfikator przesyłki. |
Zwraca
Ilość przedmiotów, towarów lub ładunków zbiorczych, które są dostarczane razem.
- Body
- Shipment
Pobiera przewoźnika z identyfikatorem operatora
Pobiera przewoźnika z identyfikatorem operatora dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator operatora
|
carrierId | True | string |
Identyfikator operatora. |
Zwraca
- Body
- Carrier
Pobiera realizację zamówienia według identyfikatora realizacji zamówienia
Pobiera realizację zamówienia według identyfikatora realizacji zamówienia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator realizacji zamówienia.
|
orderFulfillmentId | True | string |
Identyfikator realizacji zamówienia. |
Zwraca
- Body
- OrderFulfillment
Pobiera szczegóły przebiegu dla danego przepływu danych i identyfikator uruchomienia
Pobiera szczegóły przebiegu dla podanej nazwy przepływu danych i identyfikator uruchomienia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
Obiekt uruchomienia przepływu danych.
|
dataOutflowRunId | True | string |
Obiekt uruchomienia przepływu danych. |
Zwraca
- Body
- DataOutflowRun
Pobiera wszystkie magazyny dla obszaru roboczego
Pobiera wszystkie przepływy danych
Pobiera wszystkie przepływy danych dla danego obszaru roboczego.
Zwraca
- response
- array of DataInflow
Pobiera wszystkie przepływy danych dla obszaru roboczego
Pobiera wszystkie przepływy danych dla danego obszaru roboczego.
Zwraca
- response
- array of DataOutflow
Pobiera wszystkie zestawy danych dla obszaru roboczego
Pobiera węzeł dostarczania
Pobiera węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator węzła dostarczania.
|
deliveryNodeId | True | string |
Identyfikator węzła dostarczania. |
Zwraca
Szczegóły operacyjne lokalizacji dostawy, na przykład lokalizacja, godziny pracy itp.
- Body
- DeliveryNode
Pobiera węzły dostarczania dla danego obszaru roboczego
Pobiera węzły dostarczania dla danego identyfikatora obszaru roboczego.
Zwraca
- response
- array of DeliveryNode
Pobiera zamówienie wysyłki
Pobiera zamówienie wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia wysyłki.
|
shipmentOrderId | True | string |
Identyfikator zamówienia wysyłki. |
Zwraca
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp.
- Body
- ShipmentOrder
Pobiera zestaw danych o określonej nazwie
Pobiera zestaw danych o określonej nazwie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa zestawu danych.
|
name | True | string |
Nazwa zestawu danych. |
Zwraca
- Body
- Dataset
Pobiera żądanie oferty wysyłki
Pobiera żądanie oferty wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator żądania oferty wysyłki.
|
shipmentQuoteRequestId | True | string |
Identyfikator żądania oferty wysyłki. |
Zwraca
Szczegóły żądania oferty wysyłki
- Body
- ShipmentQuoteRequest
Tworzy listę magazynów
Tworzy listę magazynów dla danego identyfikatora obszaru roboczego i listę obiektów magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | True | string |
Identyfikator węzła. |
|
dayOfWeekName
|
dayOfWeekName | string |
Dzień tygodnia. |
|
|
startTime
|
startTime | string |
Godzina rozpoczęcia. |
|
|
endTime
|
endTime | string |
Godzina zakończenia. |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
labels
|
labels | array of string |
Etykiety |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time | ||
|
pickAndPackLeadTime
|
pickAndPackLeadTime | True | integer |
Pobiera lub ustawia pickAndPackLeadTime, czyli liczbę godzin wymaganych przez magazyn do pobrania i spakowania elementu |
|
identyfikator operatora
|
carrierId | True | string |
Skojarzony identyfikator operatora |
|
cutoffTime
|
cutoffTime | True | string |
Czas odcięcia przewoźnika w stosunku do magazynu. |
|
servingNodeIds
|
servingNodeIds | array of string |
Obsługa identyfikatorów węzłów, która zawiera listę identyfikatorów węzłów, do których może służyć bieżący operator. Wartość null lub pusta lista oznacza, że ten operator może służyć do dowolnego węzła. |
Zwraca
- response
- array of BulkResponseItemOfWarehouse
Tworzy listę zamówień wysyłki
Tworzy listę zamówień wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | True | string |
Unikatowy identyfikator zamówienia wysyłki. |
|
identyfikator wysyłki
|
shipmentId | string |
Identyfikator przesyłki, która wysyła to zamówienie wysyłki. |
|
|
stan
|
status | string |
Stan zamówienia wysyłki. |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy zamówienia wysyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o zamówieniu wysyłki przechwycone jako pary klucz-wartość. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Tworzy lub aktualizuje element
Tworzy lub aktualizuje element dla danego identyfikatora obszaru roboczego i jednostki SKU.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Jednostka SKU elementu.
|
sku | True | string |
Jednostka SKU elementu. |
|
nazwa
|
name | string |
Nazwa elementu. |
|
|
opis
|
description | string |
Opis elementu. |
|
|
wartość
|
value | True | string |
Wartość kodu kreskowego. |
|
standardName
|
standardName | True | string |
Standardowa nazwa kodu kreskowego. |
|
weight
|
weight | True | double |
Waga elementu standardowego. |
|
length
|
length | True | double |
Długość elementu standardowego. |
|
width
|
width | True | double |
Standardowa szerokość elementu. |
|
głębokość
|
depth | True | double |
Głębokość elementu standardowego. |
|
skrót
|
abbreviation | True | string |
Długość, szerokość i jednostka wysokości miary. |
|
skrót
|
abbreviation | True | string |
Jednostka wagi miary. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
sku
|
sku | True | string |
Identyfikator jednostki przechowywania zapasów, który jest zwykle używany do działań związanych z spisem. |
|
labels
|
labels | array of string |
Etykiety |
Zwraca
Coś, co jest spisane. Jednostka SKU, jednostka przechowywania zapasów, odnosi się do określonego elementu w określonej jednostce miary.
- Body
- Item
Tworzy lub aktualizuje element magazynu
Tworzy lub aktualizuje element magazynu według identyfikatora magazynu i jednostki SKU elementu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
Jednostka SKU elementu.
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Ilość. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
warehouseId
|
warehouseId | string |
Jednostka SKU elementu. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniego uzyskania tego elementu WarehouseItem |
Zwraca
- Body
- WarehouseItem
Tworzy lub aktualizuje listę elementów
Tworzy lub aktualizuje listę elementów dla danego identyfikatora obszaru roboczego i jednostek SKU.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | string |
Nazwa elementu. |
|
|
opis
|
description | string |
Opis elementu. |
|
|
wartość
|
value | True | string |
Wartość kodu kreskowego. |
|
standardName
|
standardName | True | string |
Standardowa nazwa kodu kreskowego. |
|
weight
|
weight | True | double |
Waga elementu standardowego. |
|
length
|
length | True | double |
Długość elementu standardowego. |
|
width
|
width | True | double |
Standardowa szerokość elementu. |
|
głębokość
|
depth | True | double |
Głębokość elementu standardowego. |
|
skrót
|
abbreviation | True | string |
Długość, szerokość i jednostka wysokości miary. |
|
skrót
|
abbreviation | True | string |
Jednostka wagi miary. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
sku
|
sku | True | string |
Identyfikator jednostki przechowywania zapasów, który jest zwykle używany do działań związanych z spisem. |
|
labels
|
labels | array of string |
Etykiety |
Zwraca
- response
- array of BulkResponseItemOfItem
Tworzy lub aktualizuje listę elementów magazynu
Tworzy lub aktualizuje listę elementów magazynu według identyfikatora magazynu i jednostki SKU elementu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
availableToPromiseQuantity
|
availableToPromiseQuantity | True | integer |
Ilość. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
warehouseId
|
warehouseId | string |
Jednostka SKU elementu. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniego uzyskania tego elementu WarehouseItem |
Zwraca
Tworzy lub aktualizuje listę węzłów dostarczania
Tworzy lub aktualizuje listę węzłów dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
id
|
id | True | string |
Identyfikator węzła. |
|
dayOfWeekName
|
dayOfWeekName | string |
Dzień tygodnia. |
|
|
startTime
|
startTime | string |
Godzina rozpoczęcia. |
|
|
endTime
|
endTime | string |
Godzina zakończenia. |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
labels
|
labels | array of string |
Etykiety |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Zwraca
Tworzy lub aktualizuje magazyn
Tworzy lub aktualizuje magazyn według identyfikatora magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
id
|
id | True | string |
Identyfikator węzła. |
|
dayOfWeekName
|
dayOfWeekName | string |
Dzień tygodnia. |
|
|
startTime
|
startTime | string |
Godzina rozpoczęcia. |
|
|
endTime
|
endTime | string |
Godzina zakończenia. |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
labels
|
labels | array of string |
Etykiety |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time | ||
|
pickAndPackLeadTime
|
pickAndPackLeadTime | True | integer |
Pobiera lub ustawia pickAndPackLeadTime, czyli liczbę godzin wymaganych przez magazyn do pobrania i spakowania elementu |
|
identyfikator operatora
|
carrierId | True | string |
Skojarzony identyfikator operatora |
|
cutoffTime
|
cutoffTime | True | string |
Czas odcięcia przewoźnika w stosunku do magazynu. |
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
servingNodeIds
|
servingNodeIds | array of string |
Obsługa identyfikatorów węzłów, która zawiera listę identyfikatorów węzłów, do których może służyć bieżący operator. Wartość null lub pusta lista oznacza, że ten operator może służyć do dowolnego węzła. |
Zwraca
- Body
- Warehouse
Tworzy lub aktualizuje ofertę wysyłki
Tworzy lub aktualizuje ofertę wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator oferty wysyłki.
|
shipmentQuoteId | True | string |
Identyfikator oferty wysyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator oferty wysyłki. |
|
shipmentQuoteRequestId
|
shipmentQuoteRequestId | True | string |
Identyfikator żądania oferty wysyłki jest powiązany z ofertą wysyłki. |
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru przesyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy przesyłki. |
|
|
identyfikator operatora
|
carrierId | True | string |
Identyfikator operatora |
|
carrierName
|
carrierName | True | string |
Nazwa przewoźnika |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o ofertach wysyłki przechwycone jako pary klucz-wartość. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Szczegóły oferty wysyłki
- Body
- ShipmentQuote
Tworzy lub aktualizuje operatora przy użyciu identyfikatora operatora
Tworzy lub aktualizuje operatora o identyfikatorze operatora dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator operatora.
|
carrierId | True | string |
Identyfikator operatora. |
|
id
|
id | True | string |
Unikatowy identyfikator operatora. |
|
typ
|
type | True | string |
Typ operatora może być tylko tym, co obsługuje OSCP. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
Zwraca
- Body
- Carrier
Tworzy lub aktualizuje przepływ danych
Tworzy lub aktualizuje przepływ danych dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
nazwa
|
name | True | string |
Pobiera lub ustawia niezmienną nazwę przepływu danych i unikatową w obszarze roboczym. Jest to unikatowy identyfikator przepływu danych. Podany przez użytkownika jako obowiązkowy parametr adresu URL. |
|
nazwa wyświetlana
|
displayName | True | string |
Pobiera lub ustawia nazwę wyświetlaną przepływu danych |
|
Datasetname
|
datasetName | True | string |
Pobiera lub ustawia nazwę zestawu danych dla łącznika |
|
typ
|
type | True | string |
Typ łącznika. Przykład — CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | True | object |
Właściwości dotyczące typu łącznika |
|
We/Wy
|
output | object |
Zawiera parametry wyjściowe, które zostaną wyświetlone z powrotem do klienta. Na przykład w przypadku łącznika FilterAndCopy identyfikator zaproszenia i lokalizacja ADS zostaną zwrócone w ramach odpowiedzi. |
|
|
typ
|
type | string |
Typ transformatora |
|
|
typeProperties
|
typeProperties | object |
Właściwości odnoszące się do typu transformatora |
|
|
stan
|
state | string |
Pobiera lub ustawia stan przepływu danych |
Zwraca
- Body
- DataInflow
Tworzy lub aktualizuje przepływ danych
Tworzy lub aktualizuje przepływ danych dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
nazwa
|
name | True | string |
Nazwa przepływu danych, która jest niezmienna i unikatowa w obszarze roboczym. Jest to unikatowy identyfikator przepływu danych. Podany przez użytkownika jako obowiązkowy parametr adresu URL. |
|
nazwa wyświetlana
|
displayName | True | string |
Nazwa wyświetlana przepływu danych. |
|
opis
|
description | True | string |
Opis przepływu danych. |
|
Datasetname
|
datasetName | True | string |
Pobiera lub ustawia nazwę zestawu danych dla łącznika |
|
nazwa
|
name | True | string | |
|
nazwa
|
name | True | string | |
|
typ
|
type | True | string |
Typ łącznika. Przykład — CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | True | object |
Właściwości dotyczące typu łącznika |
|
We/Wy
|
output | object |
Zawiera parametry wyjściowe, które zostaną wyświetlone z powrotem do klienta. Na przykład w przypadku łącznika FilterAndCopy identyfikator zaproszenia i lokalizacja ADS zostaną zwrócone w ramach odpowiedzi. |
|
|
typ
|
type | string |
Typ transformatora |
|
|
typeProperties
|
typeProperties | object |
Właściwości odnoszące się do typu transformatora |
|
|
stan
|
state | string |
Stan przepływu danych. |
Zwraca
- Body
- DataOutflow
Tworzy lub aktualizuje węzeł dostarczania
Tworzy lub aktualizuje węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator węzła dostarczania.
|
deliveryNodeId | True | string |
Identyfikator węzła dostarczania. |
|
id
|
id | True | string |
Identyfikator węzła. |
|
dayOfWeekName
|
dayOfWeekName | string |
Dzień tygodnia. |
|
|
startTime
|
startTime | string |
Godzina rozpoczęcia. |
|
|
endTime
|
endTime | string |
Godzina zakończenia. |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
labels
|
labels | array of string |
Etykiety |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Zwraca
Szczegóły operacyjne lokalizacji dostawy, na przykład lokalizacja, godziny pracy itp.
- Body
- DeliveryNode
Tworzy lub aktualizuje zestaw danych
Tworzy lub aktualizuje zestaw danych o określonej nazwie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
nazwa
|
name | True | string |
Pobiera lub ustawia nazwę |
|
nazwa
|
name | True | string | |
|
nazwa
|
name | True | string | |
|
isDisabled (Wyłączone)
|
isDisabled | True | boolean |
Pobiera lub ustawia wartość wskazującą, czy pobiera, czy ustawia wartość isdisabled |
|
operationalType
|
operationalType | string |
Pobiera lub ustawia typ operacyjny : określa, czy dane są transakcyjne (Cosmos) czy długoterminowe (ADLS) |
|
|
dataModelId
|
dataModelId | True | string |
Pobiera lub ustawia identyfikator modelu danych |
|
dataModelVersion
|
dataModelVersion | string |
Pobiera lub ustawia element dataModelVersion |
|
|
dataModelType
|
dataModelType | string |
Pobiera lub ustawia typ dataModelType |
|
|
labels
|
labels | array of string |
Etykiety |
|
|
Nazwa zestawu danych.
|
name | True | string |
Nazwa zestawu danych. |
Zwraca
- Body
- Dataset
Tworzy nowe zamówienie realizacji dla identyfikatora realizacji zamówienia
Tworzy nowe zamówienie realizacji dla identyfikatora realizacji zamówienia.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator realizacji zamówienia.
|
orderFulfillmentId | True | string |
Identyfikator realizacji zamówienia. |
|
identyfikator zamówienia
|
orderId | True | string |
Unikatowy numer identyfikujący zamówienie. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementów. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
Najwcześniejsza data/godzina dostarczenia zamówienia. |
|
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | True | string |
Najpóźniejsza data/godzina dostarczenia zamówienia. |
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
shipmentToName
|
shipmentToName | string | ||
|
shipmentReceiverContact
|
shipmentReceiverContact | string | ||
|
stan
|
status | string | ||
|
id
|
id | string | ||
|
fulfillmentPlanIds
|
fulfillmentPlanIds | array of string | ||
|
czasUtworzenia
|
creationTime | True | date-time | |
|
czas ostatniej modyfikacji
|
lastModifiedTime | True | date-time | |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
Zwraca
- Body
- OrderFulfillment
Tworzy przesyłkę
Tworzy przesyłkę.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator przesyłki.
|
shipmentId | True | string |
Identyfikator przesyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator przesyłki. |
|
stan
|
status | string |
Stan przesyłki. |
|
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
Lista identyfikatorów zamówień wysyłki, które są obsługiwane przez przesyłkę. |
|
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
trackingNumber (numer przesyłki)
|
trackingNumber | string |
Numer śledzenia |
|
|
trackingUrl
|
trackingUrl | string |
Adres URL śledzenia |
|
|
shipLabelUrl
|
shipLabelUrl | string |
Adres URL etykiety wysyłki |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy przesyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o przesyłkach przechwycone jako pary klucz-wartość. |
|
|
carrierName
|
carrierName | string |
Nazwa przewoźnika dla przesyłki |
Zwraca
Ilość przedmiotów, towarów lub ładunków zbiorczych, które są dostarczane razem.
- Body
- Shipment
Tworzy zamówienie wysyłki
Tworzy zamówienie wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia wysyłki.
|
shipmentOrderId | True | string |
Identyfikator zamówienia wysyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator zamówienia wysyłki. |
|
identyfikator wysyłki
|
shipmentId | string |
Identyfikator przesyłki, która wysyła to zamówienie wysyłki. |
|
|
stan
|
status | string |
Stan zamówienia wysyłki. |
|
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
estimatedCost
|
estimatedCost | True | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | True | string |
Kod waluty |
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
|
|
totalComponentCharge
|
totalComponentCharge | True | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | True | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
|
isOptional (opcja opcjonalna)
|
isOptional | True | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
|
isFragile
|
isFragile | True | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | True | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy zamówienia wysyłki. |
|
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o zamówieniu wysyłki przechwycone jako pary klucz-wartość. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp.
- Body
- ShipmentOrder
Tworzy żądanie oferty wysyłki
Tworzy żądanie oferty wysyłki.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator żądania oferty wysyłki.
|
shipmentQuoteRequestId | True | string |
Identyfikator żądania oferty wysyłki. |
|
id
|
id | True | string |
Unikatowy identyfikator żądania oferty wysyłki. |
|
itemSKU
|
itemSKU | True | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | True | integer |
Ilość elementu. |
|
shipmentNodeType
|
shipmentNodeType | True | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
|
Wiersz adresu1
|
addressLine1 | True | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
|
cityName
|
cityName | True | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | True | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | True | string |
Nazwa kraju. |
|
postalCode
|
postalCode | True | string |
Kod pocztowy. |
|
nazwa
|
name | True | string |
Nazwa notatki. |
|
wartość
|
value | True | string |
Wartość notatki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
|
|
wysyłkaVolume
|
shipmentVolume | True | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | True | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
|
shipmentLength
|
shipmentLength | True | double |
Długość |
|
shipmentWidth
|
shipmentWidth | True | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | True | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
|
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identyfikatory ofert wysyłki odpowiadające żądaniu oferty wysyłki |
|
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru przesyłki. |
|
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy przesyłki. |
|
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Zwraca
Szczegóły żądania oferty wysyłki
- Body
- ShipmentQuoteRequest
Tworzy żądanie uruchomienia przepływu danych
Tworzy żądanie uruchomienia przepływu danych dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
dataInflowName
|
dataInflowName | string |
Pobiera lub ustawia niezmienną i unikatową nazwę przepływu danych w obszarze roboczym |
|
|
runParams
|
runParams | object |
Pobiera lub ustawia parametry wymagane do uruchomienia określonego dla typu łącznika |
|
|
dataInflowRunId
|
dataInflowRunId | string |
Pobiera lub ustawia identyfikator uruchomienia przepływu danych dla przebiegu przepływu danych |
|
|
triggeredAt
|
triggeredAt | date-time |
Pobiera lub ustawia wyzwalany czas uruchamiania przepływu danych |
|
|
completedAt
|
completedAt | date-time |
Pobiera lub ustawia ukończony czas uruchamiania przepływu danych |
|
|
stan
|
status | string |
Pobiera lub ustawia stan uruchomienia przepływu danych |
Zwraca
- Body
- DataInflowRun
Usuwa element dla danej jednostki SKU
Usuwa element dla danej jednostki SKU.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Jednostka SKU elementu.
|
sku | True | string |
Jednostka SKU elementu. |
Zwraca
- response
- file
Usuwa element magazynu według identyfikatora magazynu i jednostki SKU elementu
Usuwa element magazynu według identyfikatora magazynu i jednostki SKU elementu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
Jednostka SKU elementu.
|
itemSKU | True | string |
Jednostka SKU elementu. |
Zwraca
- response
- file
Usuwa listę elementów dla danej jednostki SKU
Usuwa listę elementów dla danej jednostki SKU.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
skus
|
skus | True | array of string |
Zwraca
- response
- array of BulkResponseItemOfString
Usuwa listę elementów magazynu według identyfikatorów magazynu
Usuwa listę elementów magazynu według identyfikatorów magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
|
itemSKUs
|
itemSKUs | True | array of string |
Zwraca
- response
- array of BulkResponseItemOfString
Usuwa listę magazynów
Usuwa listę magazynów dla danego identyfikatora obszaru roboczego i listę identyfikatorów magazynu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
warehouseIds
|
warehouseIds | True | array of string |
Zwraca
- response
- array of BulkResponseItemOfString
Usuwa listę węzłów dostarczania
Usuwa węzły dostarczania dla podanych identyfikatorów węzłów dostarczania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
deliveryNodeIds
|
deliveryNodeIds | True | array of string |
Zwraca
- response
- array of BulkResponseItemOfString
Usuwa magazyn według identyfikatora magazynu
Usuwa magazyn według identyfikatora magazynu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator magazynu.
|
warehouseId | True | string |
Identyfikator magazynu. |
Zwraca
- response
- file
Usuwa przepływ danych
Usuwa przepływ danych dla danej nazwy i obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- Body
- DataInflow
Usuwa przepływ danych
Usuwa przepływ danych dla danej nazwy i obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- Body
- DataOutflow
Usuwa przewoźnika z identyfikatorem operatora
Usuwa operatora z identyfikatorem operatora dla obszaru roboczego.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator operatora.
|
carrierId | True | string |
Identyfikator operatora. |
Zwraca
- response
- file
Usuwa węzeł dostarczania
Usuwa węzeł dostarczania dla danego identyfikatora obszaru roboczego i identyfikatora węzła dostarczania.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator węzła dostarczania.
|
deliveryNodeId | True | string |
Identyfikator węzła dostarczania. |
Zwraca
- response
- file
Usuwa zestaw danych o określonej nazwie
Usuwa zestaw danych o określonej nazwie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa zestawu danych.
|
name | True | string |
Nazwa zestawu danych. |
Zwraca
- Body
- Dataset
Wyzwala przebieg dla wystąpienia przepływu danych
Wyzwala przebieg dla wystąpienia przepływu danych dla danej nazwy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
|
dataOutflowName
|
dataOutflowName | string |
Pobiera lub ustawia nazwę przepływu danych |
|
|
dataOutflowRunId
|
dataOutflowRunId | string |
Pobiera lub ustawia identyfikator przebiegu przepływu danych |
|
|
runParams
|
runParams | object |
Pobiera lub ustawia parametry specyficzne dla typu łącznika |
|
|
stan
|
status | string |
Pobiera lub ustawia stan przebiegu przepływu danych |
|
|
triggeredAt
|
triggeredAt | date-time |
Pobiera lub ustawia wyzwalany czas uruchamiania przepływu danych |
|
|
completedAt
|
completedAt | date-time |
Pobiera lub ustawia ukończony czas uruchomienia przepływu danych |
|
|
triggeredBy
|
triggeredBy | string |
Pobierz lub ustawia mechanizm, za pomocą którego został wyzwolony ten przebieg. Obecnie za pośrednictwem interfejsu API lub zdarzenia uzupełniania pozyskiwania danych w zestawie datset. |
|
|
triggerId
|
triggerId | string |
Pobierz lub ustaw identyfikator mechanizmu wyzwalania. |
Zwraca
- Body
- DataOutflowRun
Wyświetl listę wszystkich przebiegów dla danego przepływu danych
Wyświetl listę wszystkich przebiegów dla danej nazwy przepływu danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- response
- array of DataInflowRun
Wyświetl listę wszystkich przebiegów dla danego przepływu danych
Wyświetl listę wszystkich przebiegów dla podanej nazwy przepływu danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Nazwa przepływu danych.
|
name | True | string |
Nazwa przepływu danych. |
Zwraca
- response
- array of DataOutflowRun
Definicje
Operator
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator operatora. |
|
typ
|
type | string |
Typ operatora może być tylko tym, co obsługuje OSCP. |
|
Notatki
|
notes | array of Note |
Identyfikator konta po stronie operatora, identyfikator miernika itp., który będzie używany podczas wykonywania zapytań względem operatora. |
Uwaga / Notatka
Obiekt ogólny, który zawiera parę wartości nazwy, może służyć do przechowywania właściwości lub metadanych innych niż pierwszej klasy.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa notatki. |
|
wartość
|
value | string |
Wartość notatki. |
Przepływ danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Pobiera lub ustawia niezmienną nazwę przepływu danych i unikatową w obszarze roboczym. Jest to unikatowy identyfikator przepływu danych. Podany przez użytkownika jako obowiązkowy parametr adresu URL. |
|
nazwa wyświetlana
|
displayName | string |
Pobiera lub ustawia nazwę wyświetlaną przepływu danych |
|
Datasetname
|
datasetName | string |
Pobiera lub ustawia nazwę zestawu danych dla łącznika |
|
łącznik
|
connector | Connector | |
|
Transformator
|
transformer | Transformer | |
|
stan
|
state | string |
Pobiera lub ustawia stan przepływu danych |
Connector
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ łącznika. Przykład — CustomIngestion, CustomExport, FilterAndCopy |
|
typeProperties
|
typeProperties | object |
Właściwości dotyczące typu łącznika |
|
We/Wy
|
output | object |
Zawiera parametry wyjściowe, które zostaną wyświetlone z powrotem do klienta. Na przykład w przypadku łącznika FilterAndCopy identyfikator zaproszenia i lokalizacja ADS zostaną zwrócone w ramach odpowiedzi. |
Transformator
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ transformatora |
|
typeProperties
|
typeProperties | object |
Właściwości odnoszące się do typu transformatora |
DataInflowRun
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dataInflowName
|
dataInflowName | string |
Pobiera lub ustawia niezmienną i unikatową nazwę przepływu danych w obszarze roboczym |
|
runParams
|
runParams | object |
Pobiera lub ustawia parametry wymagane do uruchomienia określonego dla typu łącznika |
|
dataInflowRunId
|
dataInflowRunId | string |
Pobiera lub ustawia identyfikator uruchomienia przepływu danych dla przebiegu przepływu danych |
|
triggeredAt
|
triggeredAt | date-time |
Pobiera lub ustawia wyzwalany czas uruchamiania przepływu danych |
|
completedAt
|
completedAt | date-time |
Pobiera lub ustawia ukończony czas uruchamiania przepływu danych |
|
stan
|
status | string |
Pobiera lub ustawia stan uruchomienia przepływu danych |
Przepływ danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa przepływu danych, która jest niezmienna i unikatowa w obszarze roboczym. Jest to unikatowy identyfikator przepływu danych. Podany przez użytkownika jako obowiązkowy parametr adresu URL. |
|
nazwa wyświetlana
|
displayName | string |
Nazwa wyświetlana przepływu danych. |
|
opis
|
description | string |
Opis przepływu danych. |
|
Datasetname
|
datasetName | string |
Pobiera lub ustawia nazwę zestawu danych dla łącznika |
|
filteredEntities
|
filteredEntities | array of DataSchema |
Pobiera lub ustawia podzbiór jednostek do wyeksportowania z nazwanego zestawu danych. Pominięcie tej właściwości spowoduje domyślne wyeksportowanie wszystkich jednostek. |
|
łącznik
|
connector | Connector | |
|
Transformator
|
transformer | Transformer | |
|
stan
|
state | string |
Stan przepływu danych. |
DataSchema
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string | |
|
attributes
|
attributes | array of DataSchemaAttribute |
DataSchemaAttribute
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
DataOutflowRun
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dataOutflowName
|
dataOutflowName | string |
Pobiera lub ustawia nazwę przepływu danych |
|
dataOutflowRunId
|
dataOutflowRunId | string |
Pobiera lub ustawia identyfikator przebiegu przepływu danych |
|
runParams
|
runParams | object |
Pobiera lub ustawia parametry specyficzne dla typu łącznika |
|
stan
|
status | string |
Pobiera lub ustawia stan przebiegu przepływu danych |
|
triggeredAt
|
triggeredAt | date-time |
Pobiera lub ustawia wyzwalany czas uruchamiania przepływu danych |
|
completedAt
|
completedAt | date-time |
Pobiera lub ustawia ukończony czas uruchomienia przepływu danych |
|
triggeredBy
|
triggeredBy | string |
Pobierz lub ustawia mechanizm, za pomocą którego został wyzwolony ten przebieg. Obecnie za pośrednictwem interfejsu API lub zdarzenia uzupełniania pozyskiwania danych w zestawie datset. |
|
triggerId
|
triggerId | string |
Pobierz lub ustaw identyfikator mechanizmu wyzwalania. |
Dataset
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Pobiera lub ustawia nazwę |
|
dataSchema
|
dataSchema | array of DataSchema |
Pobiera lub ustawia kolekcję jednostek będących częścią tego zestawu danych. Obecnie to pole jest opcjonalne, jednak w przyszłości będzie wymagana zmiana. |
|
isDisabled (Wyłączone)
|
isDisabled | boolean |
Pobiera lub ustawia wartość wskazującą, czy pobiera, czy ustawia wartość isdisabled |
|
operationalType
|
operationalType | string |
Pobiera lub ustawia typ operacyjny : określa, czy dane są transakcyjne (Cosmos) czy długoterminowe (ADLS) |
|
schemaReference
|
schemaReference | SchemaReference | |
|
labels
|
labels | array of string |
Etykiety |
SchemaReference
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dataModelId
|
dataModelId | string |
Pobiera lub ustawia identyfikator modelu danych |
|
dataModelVersion
|
dataModelVersion | string |
Pobiera lub ustawia element dataModelVersion |
|
dataModelType
|
dataModelType | string |
Pobiera lub ustawia typ dataModelType |
Katalog
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
ingestionTime
|
ingestionTime | string |
Pobiera lub ustawia wartość SnapshotTime |
|
incrementType
|
incrementType | string |
Pobiera lub ustawia typ inkrementacji |
Węzeł dostarczania
Szczegóły operacyjne lokalizacji dostawy, na przykład lokalizacja, godziny pracy itp.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator węzła. |
|
hoursOfOperations
|
hoursOfOperations | array of HoursOfOperation |
Lista czasów operacji. |
|
lokalizacja
|
location | Location |
Lokalizacja struktury fizycznej. |
|
labels
|
labels | array of string |
Etykiety |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
HoursOfOperation
Czas operacji w ciągu dnia tygodnia
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dayOfWeekName
|
dayOfWeekName | string |
Dzień tygodnia. |
|
startTime
|
startTime | string |
Godzina rozpoczęcia. |
|
endTime
|
endTime | string |
Godzina zakończenia. |
Lokalizacja
Lokalizacja struktury fizycznej.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
timeZoneName
|
timeZoneName | string |
Unikatowy identyfikator strefy czasowej. |
|
Wiersz adresu1
|
addressLine1 | string |
Adres podstawowy. |
|
Wiersz adresu2
|
addressLine2 | string |
Adres pomocniczy. |
|
cityName
|
cityName | string |
Składnik "miasto" lokalizacji. |
|
stateName
|
stateName | string |
Nazwa stanu lub prowincji. |
|
countryName
|
countryName | string |
Nazwa kraju. |
|
postalCode
|
postalCode | string |
Kod pocztowy. |
|
Notatki
|
notes | array of Note |
Lista notatek lokalizacja. |
BulkResponseItemOfDeliveryNode
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | DeliveryNode |
Szczegóły operacyjne lokalizacji dostawy, na przykład lokalizacja, godziny pracy itp. |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | DeliveryNode |
Szczegóły operacyjne lokalizacji dostawy, na przykład lokalizacja, godziny pracy itp. |
Errorobject
Kod i komunikat o błędzie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
Kod błędu. |
|
komunikat
|
message | string |
Czytelny dla człowieka komunikat o błędzie. |
BulkResponseItemOfString
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | string |
Obiekt odpowiedzi akcji zbiorczej typu T. |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | string |
Obiekt żądania typu T dla akcji zbiorczej. |
GenerateFulfillmentOptionsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
fulfillmentOptions
|
fulfillmentOptions | array of FulfillmentOption |
FulfillmentOption
Opcja realizacji.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
fulfillmentOptionId
|
fulfillmentOptionId | string |
Identyfikator opcji realizacji. |
|
shipmentToLocation
|
shipmentToLocation | Location |
Lokalizacja struktury fizycznej. |
|
ogólny koszt
|
overallCost | Amount |
Kwota w określonej walucie. |
|
earliestDeliveryTime
|
earliestDeliveryTime | string |
Najwcześniejszy czas dostawy. |
|
latestDeliveryTime
|
latestDeliveryTime | string |
Najnowszy czas dostawy. |
|
czas wygaśnięcia
|
expirationTime | string |
Czas wygaśnięcia opcji realizacji. |
|
fulfillmentPlans
|
fulfillmentPlans | array of FulfillmentPlan |
Lista planów realizacji w tej opcji realizacji. |
Kwota
Kwota w określonej walucie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wartość
|
value | double | |
|
waluta
|
currency | string |
FulfillmentPlan
Planowane lub rzeczywiste działania związane z wykonaniem zamówienia. Te działania mogą obejmować tworzenie listy wyboru, wykonywanie listy wyboru, pakowanie i wysyłkę elementów do końcowego miejsca docelowego.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator realizacji. |
|
warehouseId
|
warehouseId | string |
Unikatowy identyfikator magazynu. |
|
scheduledExecutionTime
|
scheduledExecutionTime | string | |
|
orderLines
|
orderLines | array of OrderLine |
Wiersze zamówienia, które mają zostać spełnione przez plan realizacji |
|
Przesyłek
|
shipments | array of Shipment |
Przesyłki planu realizacji |
|
stan
|
status | string |
Stan planu realizacji. |
|
powód statusu
|
statusReason | string | |
|
czasUtworzenia
|
creationTime | string |
Sygnatura czasowa utworzona przez plan realizacji. |
OrderLine
Dokument lub prowizja od klienta w celu zamówienia przedmiotu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator zamówienia
|
orderId | string |
Unikatowy numer identyfikujący zamówienie. |
|
itemSKU
|
itemSKU | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | integer |
Ilość elementów. |
|
plannedEarliestDeliveryDateTime
|
plannedEarliestDeliveryDateTime | string |
Najwcześniejsza data/godzina dostarczenia zamówienia. |
|
plannedLatestDeliveryDateTime
|
plannedLatestDeliveryDateTime | string |
Najpóźniejsza data/godzina dostarczenia zamówienia. |
Shipment
Ilość przedmiotów, towarów lub ładunków zbiorczych, które są dostarczane razem.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator przesyłki. |
|
stan
|
status | string |
Stan przesyłki. |
|
shipmentOrderIds
|
shipmentOrderIds | array of string |
Lista identyfikatorów zamówień wysyłki, które są obsługiwane przez przesyłkę. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Dane lokalizacji przesyłki. Obecnie obsługuje tylko typ lokalizacji Origin i Destination. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Dane pakowania przesyłki ze szczegółami pomiarów pakietu |
|
opłaty za przesyłkę
|
shipmentCharge | ShipmentCharge |
Szczegóły opłaty za przesyłkę |
|
shipmentReferenceData
|
shipmentReferenceData | ShipmentReferenceData |
Dane referencyjne wysyłki zawierające szczegółowe informacje dotyczące śledzenia pakietu. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Lista przedmiotów do wysłania w ramach przesyłki. |
|
estimatedPickupTime
|
estimatedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
estimatedEarliestPickupTime
|
estimatedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
estimatedLatestPickupTime
|
estimatedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
estimatedDeliveryTime
|
estimatedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
estimatedEarliestDeliveryTime
|
estimatedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
estimatedLatestDeliveryTime
|
estimatedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
shipmentContentData
|
shipmentContentData | ShipmentContentData |
Dane dotyczące zawartości przesyłki, które wskazują na obecność niektórych rodzajów przedmiotów, takich jak bateria lub kruche. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy przesyłki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o przesyłkach przechwycone jako pary klucz-wartość. |
|
carrierName
|
carrierName | string |
Nazwa przewoźnika dla przesyłki |
WysyłkaLokacja
Szczegóły lokalizacji wysyłki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
shipmentNodeType
|
shipmentNodeType | string |
Typ węzła wysyłki. Obecnie obsługiwane są tylko źródła i miejsce docelowe. |
|
locationType
|
locationType | string |
Typ lokalizacji określa, czy lokalizacja jest magazynem, klientem itp. |
|
contactName (nazwa kontaktu)
|
contactName | string |
Imię i nazwisko osoby powiązanej z lokalizacją |
|
contactNumber
|
contactNumber | string |
Numer kontaktowy osoby powiązanej z lokalizacją |
|
lokalizacja
|
location | Location |
Lokalizacja struktury fizycznej. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o lokalizacji wysyłki przechwycone jako pary klucz-wartość. |
ShipmentPackingData
Dane pakowania przesyłki ze szczegółami pomiarów pakietu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wysyłkaVolume
|
shipmentVolume | double |
Wolumin |
|
shipmentNetWeight
|
shipmentNetWeight | double |
Waga |
|
volumeUnitOfMeasure
|
volumeUnitOfMeasure | string |
Jednostka miary woluminu |
|
weightUnitOfMeasure
|
weightUnitOfMeasure | string |
Jednostka wagi miary |
|
shipmentLength
|
shipmentLength | double |
Długość |
|
shipmentWidth
|
shipmentWidth | double |
Szerokość |
|
shipmentHeight
|
shipmentHeight | double |
Wysokość |
|
lwhUnitOfMeasure
|
lwhUnitOfMeasure | string |
Jednostka miary długości, szerokości i wysokości |
|
shipmentPackingType
|
shipmentPackingType | string |
Typ pakowania przesyłki |
Opłaty za przesyłkę
Szczegóły opłaty za przesyłkę
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
estimatedCost
|
estimatedCost | double |
Szacowany koszt |
|
kod waluty
|
currencyCode | string |
Kod waluty |
|
billingData
|
billingData | BillingData |
Szczegóły rozliczeń |
|
componentCharges
|
componentCharges | array of ComponentCharge |
Dane dotyczące opłat za składnik |
Dane rozliczeniowe
Szczegóły rozliczeń
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
customerId (identyfikator klienta)
|
customerId | string |
Identyfikator klienta |
|
NazwaKlienta
|
customerName | string |
Nazwa klienta |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o danych rozliczeniowych przechwycone jako pary klucz-wartość |
ComponentCharge
Dane dotyczące opłat za składnik
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalComponentCharge
|
totalComponentCharge | double |
Łączna opłata |
|
chargeTypeId
|
chargeTypeId | string |
Identyfikator typu opłaty |
|
chargeTypeName
|
chargeTypeName | string |
Nazwa typu opłaty |
|
isOptional (opcja opcjonalna)
|
isOptional | boolean |
Flaga IsOptional ma wartość True, jeśli opłaty związane z składnikiem są opcjonalne. Inne — fałsz |
ShipmentReferenceData
Dane referencyjne wysyłki zawierające szczegółowe informacje dotyczące śledzenia pakietu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
trackingNumber (numer przesyłki)
|
trackingNumber | string |
Numer śledzenia |
|
trackingUrl
|
trackingUrl | string |
Adres URL śledzenia |
|
shipLabelUrl
|
shipLabelUrl | string |
Adres URL etykiety wysyłki |
ShipmentItem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
itemSKU
|
itemSKU | string |
Jednostka SKU elementu. |
|
ilość
|
quantity | integer |
Ilość elementu. |
ShipmentContentData
Dane dotyczące zawartości przesyłki, które wskazują na obecność niektórych rodzajów przedmiotów, takich jak bateria lub kruche.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
isFragile
|
isFragile | boolean |
Flaga IsFragile jest ustawiona na wartość true, jeśli istnieją kruche elementy. W przeciwnym razie fałsz. |
|
includesBattery
|
includesBattery | boolean |
Flaga IncludesBattery jest ustawiona na wartość true, jeśli bateria jest częścią pakietu. W przeciwnym razie fałsz. |
Produkt
Coś, co jest spisane. Jednostka SKU, jednostka przechowywania zapasów, odnosi się do określonego elementu w określonej jednostce miary.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa elementu. |
|
opis
|
description | string |
Opis elementu. |
|
kody kreskowe
|
barcodes | array of Barcode |
Lista kodów kreskowych elementu. |
|
weight
|
weight | double |
Waga elementu standardowego. |
|
length
|
length | double |
Długość elementu standardowego. |
|
width
|
width | double |
Standardowa szerokość elementu. |
|
głębokość
|
depth | double |
Głębokość elementu standardowego. |
|
skrót
|
lwhUnitOfMeasure.abbreviation | string |
Długość, szerokość i jednostka wysokości miary. |
|
skrót
|
weightUnitOfMeasure.abbreviation | string |
Jednostka wagi miary. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
|
sku
|
sku | string |
Identyfikator jednostki przechowywania zapasów, który jest zwykle używany do działań związanych z spisem. |
|
labels
|
labels | array of string |
Etykiety |
Kod kreskowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wartość
|
value | string |
Wartość kodu kreskowego. |
|
standardName
|
standardName | string |
Standardowa nazwa kodu kreskowego. |
WarehouseItem
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
availableToPromiseQuantity
|
availableToPromiseQuantity | integer |
Ilość. |
|
itemSKU
|
itemSKU | string |
Jednostka SKU elementu. |
|
warehouseId
|
warehouseId | string |
Jednostka SKU elementu. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniego uzyskania tego elementu WarehouseItem |
BulkResponseItemOfItem
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | Item |
Coś, co jest spisane. Jednostka SKU, jednostka przechowywania zapasów, odnosi się do określonego elementu w określonej jednostce miary. |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | Item |
Coś, co jest spisane. Jednostka SKU, jednostka przechowywania zapasów, odnosi się do określonego elementu w określonej jednostce miary. |
OrderFulfillment
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
orderLines
|
orderLines | array of OrderLine | |
|
shipmentToLocation
|
shipmentToLocation | Location |
Lokalizacja struktury fizycznej. |
|
shipmentToName
|
shipmentToName | string | |
|
shipmentReceiverContact
|
shipmentReceiverContact | string | |
|
stan
|
status | string | |
|
id
|
id | string | |
|
fulfillmentPlanIds
|
fulfillmentPlanIds | array of string | |
|
czasUtworzenia
|
creationTime | date-time | |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time | |
|
Notatki
|
notes | array of Note |
Zamówienie wysyłki
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator zamówienia wysyłki. |
|
identyfikator wysyłki
|
shipmentId | string |
Identyfikator przesyłki, która wysyła to zamówienie wysyłki. |
|
stan
|
status | string |
Stan zamówienia wysyłki. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Elementy wysyłki, które są częścią zamówienia wysyłki. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Dane lokalizacji zamówienia wysyłki. Obecnie obsługuje tylko typ lokalizacji Origin i Destination. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Dane pakowania przesyłki ze szczegółami pomiarów pakietu |
|
opłaty za przesyłkę
|
shipmentCharge | ShipmentCharge |
Szczegóły opłaty za przesyłkę |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru zamówienia wysyłki. |
|
plannedEarliestPickupTime
|
plannedEarliestPickupTime | string |
Planowany najwcześniejszy czas odbioru zamówienia wysyłki. |
|
plannedLatestPickupTime
|
plannedLatestPickupTime | string |
Planowany ostatni czas odbioru zamówienia wysyłki. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
plannedEarliestDeliveryTime
|
plannedEarliestDeliveryTime | string |
Planowany najwcześniejszy czas dostawy zamówienia wysyłki. |
|
plannedLatestDeliveryTime
|
plannedLatestDeliveryTime | string |
Planowany czas dostawy zamówienia wysyłki. |
|
shipmentContentData
|
shipmentContentData | ShipmentContentData |
Dane dotyczące zawartości przesyłki, które wskazują na obecność niektórych rodzajów przedmiotów, takich jak bateria lub kruche. |
|
deliveryInstructions
|
deliveryInstructions | object |
Instrukcje dostawy zamówienia wysyłki. |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o zamówieniu wysyłki przechwycone jako pary klucz-wartość. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
BulkResponseItemOfShipmentOrder
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | ShipmentOrder |
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp. |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | ShipmentOrder |
Zamówienie wysyłki ze szczegółami, takimi jak elementy do wysłania, informacje o lokalizacji początkowej/docelowej, opłaty itp. |
WysyłkaQuote
Szczegóły oferty wysyłki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator oferty wysyłki. |
|
shipmentQuoteRequestId
|
shipmentQuoteRequestId | string |
Identyfikator żądania oferty wysyłki jest powiązany z ofertą wysyłki. |
|
opłaty za przesyłkę
|
shipmentCharge | ShipmentCharge |
Szczegóły opłaty za przesyłkę |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru przesyłki. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy przesyłki. |
|
carrierData
|
carrierData | CarrierData |
Dane przewoźnika |
|
atrybuty customAttributes
|
customAttributes | object |
Dodatkowe informacje o ofertach wysyłki przechwycone jako pary klucz-wartość. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
CarrierData
Dane przewoźnika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator operatora
|
carrierId | string |
Identyfikator operatora |
|
carrierName
|
carrierName | string |
Nazwa przewoźnika |
WysyłkaQuoteRequest
Szczegóły żądania oferty wysyłki
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator żądania oferty wysyłki. |
|
shipmentItems
|
shipmentItems | array of ShipmentItem |
Elementy wysyłki, które są częścią zamówienia wysyłki. |
|
shipmentLocationData
|
shipmentLocationData | array of ShipmentLocation |
Dane lokalizacji odpowiadające żądaniu oferty wysyłki. Obecnie obsługuje tylko typ lokalizacji Origin i Destination. |
|
shipmentPackingData
|
shipmentPackingData | ShipmentPackingData |
Dane pakowania przesyłki ze szczegółami pomiarów pakietu |
|
shipmentQuoteIds
|
shipmentQuoteIds | array of string |
Identyfikatory ofert wysyłki odpowiadające żądaniu oferty wysyłki |
|
plannedPickupTime
|
plannedPickupTime | string |
Planowany czas odbioru przesyłki. |
|
plannedDeliveryTime
|
plannedDeliveryTime | string |
Planowany czas dostawy przesyłki. |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time |
Pobiera lub ustawia czas ostatniej modyfikacji |
Magazyn
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Identyfikator węzła. |
|
hoursOfOperations
|
hoursOfOperations | array of HoursOfOperation |
Lista czasów operacji. |
|
lokalizacja
|
location | Location |
Lokalizacja struktury fizycznej. |
|
labels
|
labels | array of string |
Etykiety |
|
czas ostatniej modyfikacji
|
lastModifiedTime | date-time | |
|
pickAndPackLeadTime
|
pickAndPackLeadTime | integer |
Pobiera lub ustawia pickAndPackLeadTime, czyli liczbę godzin wymaganych przez magazyn do pobrania i spakowania elementu |
|
carrierReferences
|
carrierReferences | array of CarrierReference |
Lista informacji o przewoźniku |
CarrierReference
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator operatora
|
carrierId | string |
Skojarzony identyfikator operatora |
|
cutoffTime
|
cutoffTime | string |
Czas odcięcia przewoźnika w stosunku do magazynu. |
|
servingLocations
|
servingLocations | array of Location |
Obsługa lokalizacji, która zawiera listę kodu pocztowego, do którego może służyć bieżący przewoźnik. Lista o wartości null lub pusta oznacza, że ten przewoźnik może służyć do dowolnego kodu pocztowego. |
|
servingNodeIds
|
servingNodeIds | array of string |
Obsługa identyfikatorów węzłów, która zawiera listę identyfikatorów węzłów, do których może służyć bieżący operator. Wartość null lub pusta lista oznacza, że ten operator może służyć do dowolnego węzła. |
BulkResponseItemOfWarehouse
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | Warehouse | |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | Warehouse |
BulkResponseItemOfWarehouseItemItem
Ogólny obiekt odpowiedzi zbiorczej typu T
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod statusu
|
statusCode | integer |
Kod stanu odpowiedzi akcji zbiorczej. |
|
response
|
response | WarehouseItem | |
|
błąd
|
error | ErrorObject |
Kod i komunikat o błędzie. |
|
żądanie
|
request | WarehouseItem |
plik
Jest to podstawowy typ danych "file".