Manage orders - Create a transfer

Usługa:
Partner Center Rest
Wersja interfejsu API:
v1

Tworzy nową jednostkę transferu.

POST https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/transfers

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
customer_id
 path True

string

Identyfikator klienta.
version
 path True

string

Numer wersji API.

Nagłówek żądania

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa Wymagane Typ Opis
Authorization True

string

Token elementu nośnego autoryzacji
ms-correlationid

string

Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania
ms-cv

string

Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania
ms-requestid

string

Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania

Treść żądania

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Nazwa Typ Opis
alternateId

string

Alternatywny identyfikator dla podmiotu transferowego. Wartość to zazwyczaj GUID.
attributes

ResourceAttributes

Dodatkowe atrybuty związane z encją transferu.
completedTime

string (date-time)

Czas ukończenia dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
createdTime

string (date-time)

Data i godzina utworzenia podmiotu transferowego, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
customerEmailId

string

Unikalny identyfikator adresu e-mail klienta. Wartość to zazwyczaj GUID.
customerName

string

Nazwa klienta dla podmiotu transferowego.
customerTenantId

string

Unikalny identyfikator najemcy klienta. Wartość to zazwyczaj GUID.
expirationTime

string (date-time)

Czas wygaśnięcia dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
id

string

Unikalny identyfikator dla podmiotu transferowego. Wartość to zazwyczaj GUID.
ignoreEligibilityCheck

boolean

Czy ten podmiot transferowy ignoruje sprawdzenie kwalifikacji.
lastModifiedTime

string (date-time)

Ostatni zmodyfikowany czas dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
lastModifiedUser

string

Użytkownik, który ostatnio zmodyfikował encję transferu.
lineItems

TransferLineItem[]

Zbiór pozycji linijowych powiązanych z tym podmiotem transferowym.
links

ResourceLinks

Linki do powiązanych źródeł.
participants

StringStringKeyValuePair[]

Uczestnicy związani z tym przedmiotem.
partnerOnRecord

string

Partner zarejestrowany w przypadku podmiotu transferowego.
partnertenantid

string

Unikalny identyfikator podmiotu transferowego. Wartość to zazwyczaj GUID.
sourcePartnerEmailId

string

Unikalny identyfikator e-maila partnera źródłowego. Wartość to zazwyczaj GUID.
sourcePartnerName

string

Nazwa partnera źródłowego dla podmiotu transferowego.
sourcePartnerTenantId

string

Unikalny identyfikator źródłowego tenanta partnera. Wartość to zazwyczaj GUID.
status

string

Aktualny status podmiotu transferowego.
targetPartnerEmailId

string

Unikalny identyfikator e-maila docelowego partnera. Wartość to zazwyczaj GUID.
targetPartnerName

string

Nazwa docelowego partnera dla podmiotu transferowego.
targetPartnerTenantId

string

Unikalny identyfikator docelowego tenanta partnera. Wartość to zazwyczaj GUID.
targetProductTypes

string[]

Zbiór typów produktów docelowych związanych z tym podmiotem transferowym.
transferDirection enum:
  • 0 (int32)
  • 1 (int32)
  • 2 (int32)

Kierunek przeniesienia dla podmiotu transferowego. Możliwe wartości to: 0, 1, 2.
transferType enum:
  • 0 (int32)
  • 1 (int32)
  • 2 (int32)
  • 3 (int32)
  • 4 (int32)
  • 5 (int32)

Rodzaj transferu, wysyłany jako liczba całkowita. Możliwe wartości to: 0 (Nieznane), 1 (EaToCsp), 2 (DirectToIndirect), 3 (ModernAzure), 4 (PartnerToPartner), 5 (NewCommerce).

Odpowiedzi

Nazwa Typ Opis
201 Created

TransferEntity

Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera informacje o transferze.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request

Brak danych wejściowych lub nieprawidłowy. Treść odpowiedzi udostępni szczegóły błędu.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized

Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden

Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma praw do jego wywołania.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found

Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error

Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definicje

Nazwa Opis
LastKnownBillingDetails

Reprezentuje ostatni znany zasób szczegółów rozliczeniowych.
LastKnownBillingPeriod

Reprezentuje ostatni znany zasób okresu rozliczeniowego.
Link

Reprezentuje zasób linkowy.
ResourceAttributes

Reprezentuje zasób atrybutów zasobów.
ResourceLinks

Reprezentuje zasób powiązany z zasobami.
StringStringKeyValuePair

Reprezentuje zasób pary wartości klucz.
TransferEntity

Reprezentuje zasób podmiotu transferowego.
TransferItemType

Reprezentuje typ przesyłanego elementu, wysyłany jako liczba całkowita. Możliwe wartości to: 0 (AzureSubscription), 1 (AzureReservation), 2 (ModernAzureSubscription), 3 (LegacyAzureSubscription), 4 (AzureSavingsPlan), 5 (OnlineServicesNCE), 6 (Software), 7 (SaaS).
TransferLineItem

Reprezentuje zasób z pozycji liniowej transferu.
TransferLineItemError

Reprezentuje zasób błędu pozycji liniowej transferu.
TransferLineItemPrice

Reprezentuje cenę pozycji przenoszonej.

LastKnownBillingDetails

Objekt

Reprezentuje ostatni znany zasób szczegółów rozliczeniowych.

Nazwa Typ Opis
billingAmount

number (double)

Kwota rozliczeń za ostatnie znane szczegóły rozliczeniowe.
billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • unknown

Częstotliwość rozliczeń. Możliwe wartości to: 'nieznane', 'miesięczne', 'roczne', 'brak', 'one_time'.
billingPeriod

LastKnownBillingPeriod

Dodatkowy okres rozliczeniowy związany z ostatnimi znanymi szczegółami rozliczeniowymi.
billingType enum:
  • license
  • none
  • usage

Typ rozliczeń to ostatnie znane szczegóły rozliczeniowe. Możliwe wartości to: 'brak', 'użycie', 'licencja'.
currency

string

Trzyliterowy kod walutowy ISO.

LastKnownBillingPeriod

Objekt

Reprezentuje ostatni znany zasób okresu rozliczeniowego.

Nazwa Typ Opis
endDate

string (date-time)

Data zakończenia tego dokumentu, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
startDate

string (date-time)

Data rozpoczęcia tego zapisu, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
Objekt

Reprezentuje zasób linkowy.

Nazwa Typ Opis
body

string

Ciało do linku.
headers

StringStringKeyValuePair[]

Zbiór nagłówków powiązanych z tym linkiem.
method

string

Metoda linku.
uri

string

URI dla powiązanego źródła.

ResourceAttributes

Objekt

Reprezentuje zasób atrybutów zasobów.

Nazwa Typ Opis
etag

string

Tag podmiotu używany do kontroli współbieżności.
objectType

string

Typ obiektu dla atrybutów zasobów.
Objekt

Reprezentuje zasób powiązany z zasobami.

Nazwa Typ Opis
next

Link

Dodatkowe powiązania to linki do zasobów.
previous

Link

Dodatkowe powiązania z linkami do zasobów.
self

Link

Dodatkowe powiązania z linkami do zasobów.

StringStringKeyValuePair

Objekt

Reprezentuje zasób pary wartości klucz.

Nazwa Typ Opis
key

string

Klucz do pary klucz i wartość.
value

string

Wartość pary klucz wartość.

TransferEntity

Objekt

Reprezentuje zasób podmiotu transferowego.

Nazwa Typ Opis
alternateId

string

Alternatywny identyfikator dla podmiotu transferowego. Wartość to zazwyczaj GUID.
attributes

ResourceAttributes

Dodatkowe atrybuty związane z encją transferu.
completedTime

string (date-time)

Czas ukończenia dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
createdTime

string (date-time)

Data i godzina utworzenia podmiotu transferowego, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
customerEmailId

string

Unikalny identyfikator adresu e-mail klienta. Wartość to zazwyczaj GUID.
customerName

string

Nazwa klienta dla podmiotu transferowego.
customerTenantId

string

Unikalny identyfikator najemcy klienta. Wartość to zazwyczaj GUID.
expirationTime

string (date-time)

Czas wygaśnięcia dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
id

string

Unikalny identyfikator dla podmiotu transferowego. Wartość to zazwyczaj GUID.
ignoreEligibilityCheck

boolean

Czy ten podmiot transferowy ignoruje sprawdzenie kwalifikacji.
lastModifiedTime

string (date-time)

Ostatni zmodyfikowany czas dla podmiotu transferowego. Używa formatu data i czasu ISO 8601.
lastModifiedUser

string

Użytkownik, który ostatnio zmodyfikował encję transferu.
lineItems

TransferLineItem[]

Zbiór pozycji linijowych powiązanych z tym podmiotem transferowym.
links

ResourceLinks

Linki do powiązanych źródeł.
participants

StringStringKeyValuePair[]

Uczestnicy związani z tym przedmiotem.
partnerOnRecord

string

Partner zarejestrowany w przypadku podmiotu transferowego.
partnertenantid

string

Unikalny identyfikator podmiotu transferowego. Wartość to zazwyczaj GUID.
sourcePartnerEmailId

string

Unikalny identyfikator e-maila partnera źródłowego. Wartość to zazwyczaj GUID.
sourcePartnerName

string

Nazwa partnera źródłowego dla podmiotu transferowego.
sourcePartnerTenantId

string

Unikalny identyfikator źródłowego tenanta partnera. Wartość to zazwyczaj GUID.
status

string

Aktualny status podmiotu transferowego.
targetPartnerEmailId

string

Unikalny identyfikator e-maila docelowego partnera. Wartość to zazwyczaj GUID.
targetPartnerName

string

Nazwa docelowego partnera dla podmiotu transferowego.
targetPartnerTenantId

string

Unikalny identyfikator docelowego tenanta partnera. Wartość to zazwyczaj GUID.
targetProductTypes

string[]

Zbiór typów produktów docelowych związanych z tym podmiotem transferowym.
transferDirection enum:
  • 0 (int32)
  • 1 (int32)
  • 2 (int32)

Kierunek przeniesienia dla podmiotu transferowego. Możliwe wartości to: 0, 1, 2.
transferType enum:
  • 0 (int32)
  • 1 (int32)
  • 2 (int32)
  • 3 (int32)
  • 4 (int32)
  • 5 (int32)

Rodzaj transferu, wysyłany jako liczba całkowita. Możliwe wartości to: 0 (Nieznane), 1 (EaToCsp), 2 (DirectToIndirect), 3 (ModernAzure), 4 (PartnerToPartner), 5 (NewCommerce).

TransferItemType

Wyliczenie

Reprezentuje typ przesyłanego elementu, wysyłany jako liczba całkowita. Możliwe wartości to: 0 (AzureSubscription), 1 (AzureReservation), 2 (ModernAzureSubscription), 3 (LegacyAzureSubscription), 4 (AzureSavingsPlan), 5 (OnlineServicesNCE), 6 (Software), 7 (SaaS).

Wartość Opis
0
1
2
3
4
5
6
7

TransferLineItem

Objekt

Reprezentuje zasób z pozycji liniowej transferu.

Nazwa Typ Opis
addonItems

TransferLineItem[]

Zbiór elementów dodatkowych związanych z tym elementem liniowym transferu.
billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • unknown

Częstotliwość rozliczeń. Możliwe wartości to: 'nieznane', 'miesięczne', 'roczne', 'brak', 'one_time'.
billingDetails

LastKnownBillingDetails

Dodatkowe szczegóły rozliczeniowe związane z pozycją liniową transferu.
currencyCode

string

Trzyliterowy kod walutowy ISO.
errors

TransferLineItemError[]

Zbiór błędów związanych z tym pozycją przenoszenia.
friendlyName

string

Przyjazna nazwa wyświetlana dla tego produktu.
id

integer (int32)

Unikalny identyfikator dla pozycji liniowej transferu.
offerId

string

Unikalny identyfikator oferty. Wartość to zazwyczaj GUID.
orderId

string

Unikalny identyfikator zamówienia. Wartość to zazwyczaj GUID.
partnerIdOnRecord

string

Identyfikator partnera w rejestrze dla pozycji przenoszowej.
price

TransferLineItemPrice

Cena związana z tym produktem.
productType

TransferItemType (int32)

Dodatkowy typ produktu związany z pozycją przenoszącą.
quantity

integer (int32)

Liczba jednostek.
sourceSubscriptionTermEndDate

string (date-time)

Data i godzina końca okresu subskrypcji źródłowej w UTC.
sourceSubscriptionTermStartDate

string (date-time)

Data rozpoczęcia okresu subskrypcji źródłowej, w formacie ISO 8601. Używa formatu data i czasu ISO 8601.
status

string

Aktualny status pozycji linii transferowej.
subscriptionId

string

Unikalny identyfikator (GUID) subskrypcji. Wartość to zazwyczaj GUID.
transferError

string

Błąd transferu dla pozycji liniowej transferu.
transferGroupId

string

Unikalny identyfikator grupy transferowej. Wartość to zazwyczaj GUID.

TransferLineItemError

Objekt

Reprezentuje zasób błędu pozycji liniowej transferu.

Nazwa Typ Opis
code

string

Kod do błędu pozycji przenoszącej pozycję.
description

string

Opis tego przedmiotu.

TransferLineItemPrice

Objekt

Reprezentuje cenę pozycji przenoszonej.

Nazwa Typ Opis
currencyCode

string

Trzyliterowy kod walutowy ISO.
discountedPrice

number (double)

Zniżkowa cena za cenę pozycji przenoszącej.
erpPrice

number (double)

Szacowana cena detaliczna (ERP). Pojedyncza ilość szacunkowa cena detaliczna podana w katalogu przed zastosowaniem jakichkolwiek modyfikatorów cenowych, w walucie pozycji pozycji. Jest to pełna cena detaliczna na termin, gdy określony jest okres dostępności. Kwota jest przed opodatkowaniem, z wyjątkiem krajów lub regionów objętych opodatkowaniem, gdzie cena obejmuje podatek. Ta nieruchomość jest obecnie wdrażana i nie jest zwracana wszystkim partnerom.
extendedPrice

number (double)

Rozszerzona cena za cenę pozycji przenoszącej.
listPrice

number (double)

Cena katalogowa przed zastosowaniem rabatów.
price

number (double)

Cena związana z tym produktem.
proratedPrice

number (double)

Cena proporcjonalna do ceny pozycji przenoszonej.