Starsza (niezależny wydawca) (wersja zapoznawcza)
Interfejs REST dla kupców Firmy do odbierania, przetwarzania i zarządzania swoimi zamówieniami.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Microsoft Dynamics |
| adres URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| Metadane łącznika | |
|---|---|
| Publisher | Ray Bennett (MSFT) |
| Witryna internetowa | https://www.shopify.com/ |
| Zasady ochrony prywatności | https://www.shopify.com/legal/privacy |
| Kategorie | Produktywność |
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.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API | securestring | Token dostępu dla tego interfejsu API. | Prawda |
| Adres URL sklepu | ciąg | Adres URL sklepu w Usłudze Store | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizuje zamówienie |
Aktualizuje zamówienie przy użyciu podanych informacji. |
| Anulowanie zamówienia |
Anuluj zamówienie według identyfikatora. |
| Pobiera listę klientów |
Pobiera listę klientów spełniających określone kryteria |
| Pobiera listę zamówień |
Pobiera listę zamówień spełniających określone kryteria |
Aktualizuje zamówienie
Aktualizuje zamówienie przy użyciu podanych informacji.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia
|
order_id | True | string |
Identyfikator zamówienia, który zostanie zaktualizowany. |
|
|
object |
Zwraca
Zamówienie
- Body
- order
Anulowanie zamówienia
Anuluj zamówienie według identyfikatora.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator zamówienia
|
order_id | True | string |
Identyfikator zamówienia, które zostanie anulowane. |
|
Zwrot rzeczywistej kwoty
|
amount | string |
Kwota zwrotu. W przypadku ustawienia Firma podejmie próbę unieważnienia lub zwrotu płatności, w zależności od jego stanu. Zwrot pieniędzy za pośrednictwem bramy ręcznej w przypadkach, gdy oryginalna transakcja nie została wykonana w Sieci. Zwroty za pośrednictwem bramy ręcznej są rejestrowane jako zwrot kosztów w Usłudze, ale klient nie jest zwracany. |
|
|
Waluta zwrotu pieniędzy
|
currency | string |
Waluta zwrotu, która jest wystawiana po anulowaniu zamówienia. Wymagane w przypadku zamówień wielowalutowych za każdym razem, gdy zostanie podana właściwość amount. |
|
|
Ponowne uzupełnianie zwrotów przedmiotów
|
restock | string |
Czy ponownie uzupełnić zwroty produktów z powrotem do zapasów sklepu. |
|
|
Przyczyna anulowania zamówienia
|
reason | string |
Przyczyna anulowania zamówienia. Prawidłowe wartości: klient, spis, oszustwa, odrzucone i inne. |
|
|
Wiadomość e-mail z anulowaniem
|
string |
Czy wysłać wiadomość e-mail do klienta z powiadomieniem o anulowaniu. |
||
|
Zwrot
|
refund | string |
Transakcje zwrotu do wykonania. |
|
|
|
object |
Zwraca
Zamówienie
- Body
- order
Pobiera listę klientów
Pobiera listę klientów spełniających określone kryteria
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikatory klientów
|
ids | string |
Ogranicz wyniki do klientów określonych przez rozdzielaną przecinkami listę identyfikatorów. |
|
|
Od identyfikatora
|
since_id | string |
Ogranicz wyniki po określonym identyfikatorze. |
|
|
Utworzono w minucie
|
created_at_min | string |
Pokaż klientów utworzonych po określonej dacie (format: 2014-04-25T16:15:47-04:00). |
|
|
Utworzono maksymalnie
|
created_at_max | string |
Pokaż klientów utworzonych przed określoną datą (format: 2014-04-25T16:15:47-04:00). |
|
|
Zaktualizowano o minutę
|
updated_at_min | string |
Pokaż ostatnią aktualizację klientów po określonej dacie (format: 2014-04-25T16:15:47-04:00). |
|
|
Zaktualizowano maksymalnie
|
updated_at_max | string |
Pokaż ostatnią aktualizację klientów przed określoną datą (format: 2014-04-25T16:15:47-04:00). |
|
|
Ograniczenie
|
limit | string |
Maksymalna liczba wyników do wyświetlenia. (wartość domyślna: 50)(maksimum: 250). |
|
|
Pola formularza
|
fields | string |
Pokaż tylko niektóre pola określone przez rozdzielaną przecinkami listę pól. |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
customers
|
customers | array of customer |
Pobiera listę zamówień
Pobiera listę zamówień spełniających określone kryteria
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikatory zamówień
|
ids | string |
Pobieraj tylko zamówienia określone przez rozdzielaną przecinkami listę identyfikatorów zamówień. |
|
|
Ograniczenie
|
limit | string |
Maksymalna liczba wyników do wyświetlenia na stronie. |
|
|
Od identyfikatora
|
since_id | string |
Pokaż zamówienia po określonym identyfikatorze. |
|
|
Utworzono w minucie
|
created_at_min | string |
Pokaż zamówienia utworzone w dniu lub po dacie (format: 2014-04-25T16:15:47-04:00). |
|
|
Utworzono maksymalnie
|
created_at_max | string |
Pokaż zamówienia utworzone w dniu lub przed datą (format: 2014-04-25T16:15:47-04:00). |
|
|
Zaktualizowano o minutę
|
updated_at_min | string |
Pokaż zamówienia ostatnio zaktualizowane o datę lub po dacie (format: 2014-04-25T16:15:47-04:00). |
|
|
Zaktualizowano maksymalnie
|
updated_at_max | string |
Pokaż zamówienia ostatnio zaktualizowane o datę lub przed datą (format: 2014-04-25T16:15:47-04:00). |
|
|
Przetworzone w minucie
|
processed_at_min | string |
Pokaż zamówienia zaimportowane w dniu lub po dacie (format: 2014-04-25T16:15:47-04:00). |
|
|
Przetworzone o maksymalnej godzinie
|
processed_at_max | string |
Pokaż zamówienia zaimportowane w dniu lub przed datą (format: 2014-04-25T16:15:47-04:00). |
|
|
Identyfikator aplikacji przypisywania autorstwa
|
attribution_app_id | string |
Pokaż zamówienia przypisane do określonej aplikacji określonej przez identyfikator aplikacji. |
|
|
Stan zamówienia
|
status | string |
Filtruj zamówienia według ich stanu. |
|
|
Stan finansowy
|
financial_status | string |
Filtruj zamówienia według ich stanu finansowego. |
|
|
Stan realizacji
|
fulfillment_status | string |
Filtruj zamówienia według stanu realizacji. |
|
|
Pola formularza
|
fields | string |
Pobieraj tylko niektóre pola określone przez rozdzielaną przecinkami listę pól. |
|
|
Kolejność sekwencji rekordów
|
order | string |
Pole i kierunek sortowania zamówień. Aby określić kierunek, dodaj ciąg "asc" lub "desc" na końcu parametru zapytania. Np. "order=updated_at asc". |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
orders
|
orders | array of order |
Definicje
porządek
Zamówienie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator aplikacji, która utworzyła zamówienie. |
|
e-mail
|
string |
Adres e-mail klienta. |
|
|
closed_at
|
closed_at | string |
Data i godzina (format ISO 8601) po zamknięciu zamówienia. Zwraca wartość null, jeśli zamówienie nie jest zamknięte. |
|
utworzono_o
|
created_at | string |
Trzyliterowy kod (format ISO 4217) waluty sklepu. |
|
updated_at
|
updated_at | string |
Data i godzina (format ISO 8601) podczas ostatniej modyfikacji zamówienia. |
|
Liczba
|
number | integer |
Pozycja zamówienia w liczbie zamówień w sklepie. Liczby są sekwencyjne i zaczynają się od 1. |
|
nuta
|
note | string |
Opcjonalna uwaga, że właściciel sklepu może dołączyć do zamówienia. |
|
kod przedpłaty
|
token | string |
Unikatowa wartość podczas odwoływania się do zamówienia. |
|
brama
|
gateway | string |
Użyto bramy płatności. |
|
test
|
test | boolean |
Czy jest to kolejność testów. |
|
total_price
|
total_price | string |
Suma wszystkich cen produktów liniowych, rabatów, wysyłki, podatków i wskazówek w walucie sklepu. Musi być dodatnia. |
|
subtotal_price
|
subtotal_price | string |
Cena zamówienia w walucie sklepu po rabatach, ale przed wysyłką, cłami, podatkami i wskazówkami. |
|
total_weight
|
total_weight | integer |
Suma wszystkich wag elementów liniowych w gramach. Suma nie jest dostosowywana, ponieważ elementy są usuwane z zamówienia. |
|
total_tax
|
total_tax | string |
Suma wszystkich podatków stosowanych do zamówienia w walucie sklepu. Musi być dodatnia. |
|
taxes_included
|
taxes_included | boolean |
Czy podatki są uwzględniane w sumach częściowych zamówienia. |
|
waluta
|
currency | string |
Trzyliterowy kod (format ISO 4217) waluty sklepu. |
|
financial_status
|
financial_status | string |
Stan płatności skojarzonych z zamówieniem. Można ustawić tylko po utworzeniu zamówienia. |
|
Potwierdzone
|
confirmed | boolean |
Zamówienie zostało potwierdzone. |
|
total_discounts
|
total_discounts | string |
Łączne rabaty stosowane do ceny zamówienia w walucie sklepu. |
|
total_line_items_price
|
total_line_items_price | string |
Suma wszystkich cen produktów w walucie sklepu. |
|
cart_token
|
cart_token | string |
Unikatowa wartość podczas odwoływania się do koszyka skojarzonego z zamówieniem. |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
Czy klient wyraził zgodę na otrzymywanie aktualizacji e-mail ze sklepu. |
|
nazwa
|
name | string |
Nazwa zamówienia wygenerowana przez połączenie właściwości order_number z prefiksem zamówienia i sufiksem ustawionym w ustawieniach ogólnych sprzedawcy. |
|
referring_site
|
referring_site | string |
Witryna internetowa, w której klient kliknął link do sklepu. |
|
landing_site
|
landing_site | string |
Adres URL strony, na której kupujący wylądował po wejściu do sklepu. |
|
anulowano_o
|
cancelled_at | string |
Data i godzina anulowania zamówienia. Zwraca wartość null, jeśli zamówienie nie zostało anulowane. |
|
cancel_reason
|
cancel_reason | string |
Powód anulowania zamówienia. |
|
total_price_usd
|
total_price_usd | string |
Łączna cena USD. |
|
checkout_token
|
checkout_token | string |
Unikatowa wartość podczas odwoływania się do wyewidencjonowania skojarzonego z zamówieniem. |
|
odwołanie
|
reference | string |
Odwołanie do zamówienia. |
|
user_id
|
user_id | integer |
Identyfikator użytkownika zalogował się do usługi PoS w Usłudze Intune, który przetworzył zamówienie, jeśli ma to zastosowanie. |
|
location_id
|
location_id | integer |
Identyfikator lokalizacji fizycznej, w której zamówienie zostało przetworzone. Jeśli musisz odwołać się do lokalizacji względem zamówienia, użyj zasobu FulfillmentOrder. |
|
source_identifier
|
source_identifier | string |
Identyfikator źródła. |
|
source_url
|
source_url | string |
Źródłowy adres URL. |
|
processed_at
|
processed_at | string |
Data i godzina (format ISO 8601) podczas przetwarzania zamówienia. |
|
device_id
|
device_id | string |
Identyfikator urządzenia. |
|
phone
|
phone | string |
Numer telefonu klienta do odbierania powiadomień SMS. |
|
customer_locale
|
customer_locale | string |
Dwuliterowy kod języka, po którym opcjonalnie następuje modyfikator regionu. |
|
app_id
|
app_id | integer |
Identyfikator aplikacji, która utworzyła zamówienie. |
|
browser_ip
|
browser_ip | string |
Adres IP przeglądarki używanej przez klienta podczas składania zamówienia. |
|
landing_site_ref
|
landing_site_ref | string |
Adres ref witryny docelowej. |
|
order_number
|
order_number | integer |
Pozycja zamówienia w liczbie zamówień w sklepie, począwszy od 1001 roku. |
|
discount_applications
|
discount_applications | discount_applications |
Opis wniosku rabatowego, zgodnie z definicją kupca lub Skryptu Wykupu. |
|
discount_codes
|
discount_codes | discount_codes |
Lista rabatów stosowanych do zamówienia. |
|
note_attributes
|
note_attributes | note_attributes |
Dodatkowe informacje dodawane do zamówienia. |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
Lista bram płatności używanych do zamówienia. |
|
processing_method
|
processing_method | string |
Sposób przetwarzania płatności. |
|
checkout_id
|
checkout_id | integer |
Identyfikator wyewidencjonowania. |
|
source_name
|
source_name | string |
Gdzie pochodzi zamówienie. |
|
fulfillment_status
|
fulfillment_status | string |
Stan zamówienia pod względem spełnionych elementów wiersza. |
|
tax_lines
|
tax_lines | tax_lines |
Lista obiektów wierszy podatkowych, z których każda zawiera szczegóły podatku stosowanego do przedmiotu. |
|
tags
|
tags | string |
Tagi dołączone do zamówienia sformatowane jako ciąg wartości rozdzielanych przecinkami. Tagi to dodatkowe krótkie deskryptory, często używane do filtrowania i wyszukiwania. |
|
contact_email
|
contact_email | string |
Kontaktowy adres e-mail. |
|
order_status_url
|
order_status_url | string |
Adres URL wskazujący stronę internetową ze stanem zamówienia, jeśli ma to zastosowanie. |
|
presentment_currency
|
presentment_currency | string |
Waluta prezentowania, która została użyta do wyświetlania cen dla klienta. |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
|
shipping_lines
|
shipping_lines | shipping_lines |
Szczegóły używanej metody wysyłki. |
|
billing_address
|
billing_address | billing_address |
Adres wysyłkowy skojarzony z formą płatności. Ten adres jest polem opcjonalnym, które nie będzie dostępne w zamówieniach, które nie wymagają formy płatności. |
|
shipping_address
|
shipping_address | shipping_address |
Adres wysyłkowy do miejsca wysłania zamówienia. Ten adres jest opcjonalny i nie będzie dostępny w przypadku zamówień, które nie wymagają wysyłki. |
|
client_details
|
client_details | client_detail |
Informacje o przeglądarce używanej przez klienta podczas składania zamówienia. |
|
payment_details
|
payment_details | payment_detail |
Obiekt zawierający informacje o płatności. |
|
klient
|
customer | customer |
Informacje o kliencie. |
|
line_items
|
line_items | line_items | |
|
realizacji
|
fulfillments | fulfillments |
Tablica realizacji skojarzona z zamówieniem. |
|
Refundacji
|
refunds | refunds |
Refundacji |
klient
Informacje o kliencie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator klienta. |
|
e-mail
|
string |
Unikatowy adres e-mail klienta. Próba przypisania tego samego adresu e-mail do wielu klientów zwraca błąd. |
|
|
accepts_marketing
|
accepts_marketing | boolean |
Czy klient wyraził zgodę na otrzymywanie materiałów marketingowych za pośrednictwem poczty e-mail. |
|
utworzono_o
|
created_at | string |
Data i godzina (format ISO 8601) podczas tworzenia klienta. |
|
updated_at
|
updated_at | string |
Data i godzina (format ISO 8601) po ostatniej aktualizacji informacji o kliencie. |
|
first_name
|
first_name | string |
Imię klienta. |
|
last_name
|
last_name | string |
Nazwisko klienta. |
|
orders_count
|
orders_count | integer |
Liczba zamówień skojarzonych z tym klientem. |
|
stan
|
state | string |
Stan konta klienta ze sklepem. Wartość domyślna: wyłączone. |
|
total_spent
|
total_spent | string |
Łączna kwota pieniędzy wydana przez klienta w historii zamówień. |
|
last_order_id
|
last_order_id | integer |
Identyfikator ostatniego zamówienia klienta. |
|
nuta
|
note | string |
Uwaga dotycząca klienta. |
|
verified_email
|
verified_email | boolean |
Czy klient zweryfikował swój adres e-mail. |
|
multipass_identifier
|
multipass_identifier | string |
Unikatowy identyfikator klienta, który jest używany z logowaniem multipass. |
|
tax_exempt
|
tax_exempt | boolean |
Czy klient jest zwolniony z płacenia podatków od zamówienia. Jeśli to prawda, podatki nie zostaną zastosowane do zamówienia podczas wyewidencjonowania. Jeśli wartość false, podatki zostaną zastosowane podczas wyewidencjonowania. |
|
phone
|
phone | string |
Unikatowy numer telefonu (format E.164) dla tego klienta. Próba przypisania tego samego numeru telefonu do wielu klientów zwraca błąd. |
|
tags
|
tags | string |
Tagi dołączone przez właściciela sklepu do klienta, sformatowane jako ciąg wartości rozdzielonych przecinkami. Klient może mieć do 250 tagów. Każdy tag może mieć maksymalnie 255 znaków. |
|
last_order_name
|
last_order_name | string |
Nazwa ostatniego zamówienia klienta. Jest to bezpośrednio związane z polem nazwy w zasobie Order. |
|
waluta
|
currency | string |
Trzyliterowy kod (format ISO 4217) dla waluty używanej przez klienta podczas płatności za ostatnie zamówienie. |
|
addresses
|
addresses | addresses |
Lista dziesięciu ostatnio zaktualizowanych adresów klienta. |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
Data i godzina (format ISO 8601), gdy klient wyraził zgodę lub sprzeciwił się otrzymaniu materiałów marketingowych pocztą e-mail. |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
Poziom zgody subskrypcji marketingowej, który klient udzielił, gdy wyraził zgodę na otrzymywanie materiałów marketingowych pocztą e-mail. |
|
tax_exemptions
|
tax_exemptions | array of |
Czy klient jest zwolniony z płacenia określonych podatków od zamówienia. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
|
default_address
|
default_address | default_address |
default_address
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator adresu. |
|
customer_id
|
customer_id | integer |
Unikatowy identyfikator klienta. |
|
first_name
|
first_name | string |
Imię klienta. |
|
last_name
|
last_name | string |
Nazwisko klienta. |
|
firma
|
company | string |
Firma klienta. |
|
adres1
|
address1 | string |
Pierwszy wiersz adresu wysyłkowego klienta. |
|
adres2
|
address2 | string |
Dodatkowe pole dla adresu e-mail klienta. |
|
city
|
city | string |
Miasto, miasto lub wioska klienta. |
|
prowincja
|
province | string |
Nazwa regionu klienta. Zazwyczaj prowincja, stan lub prefektura. |
|
country
|
country | string |
Kraj klienta. |
|
zip
|
zip | string |
Kod pocztowy klienta, znany również jako kod pocztowy, kod pocztowy, kod Eircode itp. |
|
phone
|
phone | string |
Numer telefonu klienta pod tym adresem. |
|
nazwa
|
name | string |
Imię i nazwisko klienta. |
|
province_code
|
province_code | string |
Dwuliterowy kod regionu klienta. |
|
country_code
|
country_code | string |
Dwuliterowy kod kraju odpowiadający krajowi klienta. |
|
country_name
|
country_name | string |
Znormalizowana nazwa kraju klienta. |
|
domyślny
|
default | boolean |
Zwraca wartość true dla każdego adresu domyślnego. |
shipping_address
Adres wysyłkowy do miejsca wysłania zamówienia. Ten adres jest opcjonalny i nie będzie dostępny w przypadku zamówień, które nie wymagają wysyłki.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
first_name
|
first_name | string |
Imię osoby skojarzonej z adresem wysyłkowym. |
|
adres1
|
address1 | string |
Adres ulicy adresu wysyłkowego. |
|
phone
|
phone | string |
Numer telefonu pod adresem wysyłkowym. |
|
city
|
city | string |
Miasto, miasto lub wioska adresu wysyłkowego. |
|
zip
|
zip | string |
Kod pocztowy (na przykład zip, kod pocztowy lub Eircode) adresu wysyłkowego. |
|
prowincja
|
province | string |
Nazwa regionu (na przykład prowincja, stan lub prefektura) adresu wysyłkowego. |
|
country
|
country | string |
Nazwa kraju adresu wysyłkowego. |
|
last_name
|
last_name | string |
Nazwisko osoby skojarzonej z adresem wysyłkowym. |
|
adres2
|
address2 | string |
Opcjonalne dodatkowe pole dla adresu ulicznego adresu wysyłkowego. |
|
firma
|
company | string |
Firma osoby skojarzonej z adresem wysyłkowym. |
|
szerokość geograficzna
|
latitude | float |
Szerokość geograficzna adresu wysyłkowego. |
|
długość
|
longitude | float |
Długość geograficzna adresu wysyłkowego. |
|
nazwa
|
name | string |
Imię i nazwisko osoby skojarzonej z formą płatności. |
|
country_code
|
country_code | string |
Dwuliterowy kod (format ISO 3166-1) dla kraju adresu wysyłkowego. |
|
province_code
|
province_code | string |
Dwuliterowy skrót regionu adresu wysyłkowego. |
billing_address
Adres wysyłkowy skojarzony z formą płatności. Ten adres jest polem opcjonalnym, które nie będzie dostępne w zamówieniach, które nie wymagają formy płatności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
first_name
|
first_name | string |
Imię osoby skojarzonej z formą płatności. |
|
adres1
|
address1 | string |
Adres ulicy adresu rozliczeniowego. |
|
phone
|
phone | string |
Numer telefonu pod adresem rozliczeniowym. |
|
city
|
city | string |
Miasto, miasto lub wioska adresu rozliczeniowego. |
|
zip
|
zip | string |
Kod pocztowy (na przykład zip, kod pocztowy lub kod Eircode) adresu rozliczeniowego. |
|
prowincja
|
province | string |
Nazwa regionu (na przykład prowincja, stan lub prefektura) adresu rozliczeniowego. |
|
country
|
country | string |
Nazwa kraju adresu rozliczeniowego. |
|
last_name
|
last_name | string |
Nazwisko osoby skojarzonej z formą płatności. |
|
adres2
|
address2 | string |
Opcjonalne dodatkowe pole dla adresu ulicznego adresu rozliczeniowego. |
|
firma
|
company | string |
Firma osoby skojarzonej z adresem rozliczeniowym. |
|
szerokość geograficzna
|
latitude | float |
Szerokość geograficzna adresu rozliczeniowego. |
|
długość
|
longitude | float |
Długość geograficzna adresu rozliczeniowego. |
|
nazwa
|
name | string |
Imię i nazwisko osoby skojarzonej z formą płatności. |
|
country_code
|
country_code | string |
Dwuliterowy kod (format ISO 3166-1) dla kraju adresu rozliczeniowego. |
|
province_code
|
province_code | string |
Dwuliterowy skrót regionu adresu rozliczeniowego. |
addresses
Lista dziesięciu ostatnio zaktualizowanych adresów klienta.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
default_address |
shipping_line
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator globalny. |
|
title
|
title | string |
Tytuł metody wysyłki. |
|
cena
|
price | string |
Cena tej metody wysyłki w walucie sklepu. |
|
kod
|
code | string |
Odwołanie do metody wysyłki. |
|
przesłać źródło
|
source | string |
Źródło metody wysyłki. |
|
phone
|
phone | string |
Numer telefonu pod adresem wysyłkowym. |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
Odwołanie do usługi realizacji, która jest żądana dla metody wysyłki. Obecny, jeśli metoda wysyłki wymaga przetwarzania przez usługę realizacji innej firmy; wartość null w przeciwnym razie. |
|
delivery_category
|
delivery_category | string |
Kategoria dostarczania. |
|
carrier_identifier
|
carrier_identifier | string |
Odwołanie do usługi przewoźnika, która dostarczyła stawkę. Obecny, gdy stawka została obliczona przez usługę przewoźnika innej firmy. |
|
discounted_price
|
discounted_price | string |
Cena metody wysyłki po zastosowaniu rabatów na poziomie wiersza. Nie odzwierciedla rabatów na poziomie koszyka ani na poziomie zamówienia. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Uporządkowana lista kwot przydzielonych przez aplikacje rabatowe. |
|
tax_lines
|
tax_lines | tax_lines |
Lista obiektów wierszy podatkowych, z których każda zawiera szczegóły podatku stosowanego do przedmiotu. |
client_detail
Informacje o przeglądarce używanej przez klienta podczas składania zamówienia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
Adres IP przeglądarki. |
|
accept_language
|
accept_language | string |
Języki i ustawienia regionalne, które rozumie przeglądarka. |
|
user_agent
|
user_agent | string |
Szczegółowe informacje o kliencie przeglądania, w tym o oprogramowaniu i wersjach operacyjnych. |
|
session_hash
|
session_hash | string |
Skrót sesji. |
|
browser_width
|
browser_width | integer |
Szerokość ekranu przeglądarki w pikselach, jeśli jest dostępna. |
|
browser_height
|
browser_height | integer |
Wysokość ekranu przeglądarki w pikselach, jeśli jest dostępna. |
payment_detail
Obiekt zawierający informacje o płatności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
Numer identyfikacyjny wystawcy (IIN), wcześniej znany jako numer identyfikacyjny banku (BIN) karty kredytowej klienta. |
|
avs_result_code
|
avs_result_code | string |
Kod odpowiedzi z systemu weryfikacji adresów (AVS). Kod jest pojedynczą literą. |
|
cvv_result_code
|
cvv_result_code | string |
Kod odpowiedzi firmy zajmującej się kartą kredytową wskazujący, czy klient poprawnie wprowadził kod zabezpieczający karty (wartość weryfikacji karty). Kod jest jedną literą lub pustym ciągiem. |
|
credit_card_number
|
credit_card_number | string |
Numer karty kredytowej klienta z większością cyfr wiodących zredagowany. |
|
credit_card_company
|
credit_card_company | string |
Nazwa firmy, która wystawiła kartę kredytową klienta. |
subtotal_tax_discount_price_set
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kwota
|
shop_money.amount | string |
Rzeczywista kwota. |
|
currency_code
|
shop_money.currency_code | string |
W formacie ISO 4217. |
|
kwota
|
presentment_money.amount | string |
Rzeczywista kwota. |
|
currency_code
|
presentment_money.currency_code | string |
W formacie ISO 4217. |
line_item_property
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Nazwa produktu. |
|
value
|
value | string |
Wartość produktu. |
line_item_properties
Właściwości.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
line_item_property |
Spełnienie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator realizacji. |
|
order_id
|
order_id | integer |
Unikatowy identyfikator liczbowy zamówienia. |
|
stan
|
status | string |
Stan realizacji. |
|
utworzono_o
|
created_at | string |
Data i godzina utworzenia realizacji. |
|
usługa
|
service | string |
Typ używanej usługi. |
|
updated_at
|
updated_at | string |
Data i godzina (format ISO 8601) po ostatniej modyfikacji realizacji. |
|
tracking_company
|
tracking_company | string |
Nazwa firmy śledzącej. |
|
shipment_status
|
shipment_status | string |
Bieżący stan wysyłki realizacji. |
|
location_id
|
location_id | integer |
Unikatowy identyfikator lokalizacji, dla którego należy przetworzyć realizację. |
|
tracking_number
|
tracking_number | string |
Numer śledzenia dostarczony przez firmę wysyłkową. |
|
tracking_numbers
|
tracking_numbers | array of string |
Lista numerów śledzenia dostarczonych przez firmę wysyłkową. |
|
tracking_url
|
tracking_url | string |
Adres URL strony śledzenia realizacji. |
|
tracking_urls
|
tracking_urls | array of string |
Adresy URL stron śledzenia realizacji. |
|
paragon
|
receipt | receipt |
Pole tekstowe zawierające informacje o paragonie. |
|
nazwa
|
name | string |
Unikatowa nazwa realizacji. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
|
line_items
|
line_items | line_items |
realizacji
Tablica realizacji skojarzona z zamówieniem.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
fulfillment |
transakcja
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator transakcji. |
|
order_id
|
order_id | integer |
Identyfikator zamówienia, z którą jest skojarzona transakcja. |
|
rodzaj
|
kind | string |
Typ transakcji. |
|
brama
|
gateway | string |
Nazwa bramy, za pośrednictwem którego została wystawiona transakcja. |
|
stan
|
status | string |
Stan transakcji. |
|
komunikat
|
message | string |
Ciąg wygenerowany przez dostawcę płatności z dodatkowymi informacjami o tym, dlaczego transakcja zakończyła się powodzeniem lub niepowodzeniem. |
|
utworzono_o
|
created_at | string |
Data i godzina (format ISO 8601) podczas tworzenia transakcji. |
|
test
|
test | boolean |
Czy transakcja jest transakcją testową. |
|
autoryzacja
|
authorization | string |
Kod autoryzacji skojarzony z transakcją. |
|
location_id
|
location_id | string |
Identyfikator lokalizacji fizycznej, w której transakcja została przetworzona. |
|
user_id
|
user_id | string |
Identyfikator użytkownika, który zalogował się na urządzeniu PoS w Sieci, gdy zamówienie zostało przetworzone, jeśli ma to zastosowanie. |
|
parent_id
|
parent_id | integer |
Identyfikator skojarzonej transakcji. |
|
processed_at
|
processed_at | string |
Data i godzina (format ISO 8601) podczas przetwarzania transakcji. |
|
device_id
|
device_id | string |
Identyfikator urządzenia. |
|
error_code
|
error_code | string |
Ustandaryzowany kod błędu, niezależny od dostawcy płatności. |
|
source_name
|
source_name | string |
Źródło transakcji. Jest on ustawiany przez Firmę i nie można go zastąpić. |
|
kwota
|
amount | string |
Kwota pieniędzy uwzględniona w transakcji. |
|
waluta
|
currency | string |
Trzyliterowy kod (format ISO 4217) dla waluty używanej do płatności. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
transakcje
Lista transakcji zaangażowanych w zwrot kosztów.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
transaction |
tax_line
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
cena
|
price | string |
Kwota podatku naliczona w walucie sklepu. |
|
tempo
|
rate | float |
Stawka podatku do zastosowania. |
|
title
|
title | string |
Nazwa podatku. |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
Lista obiektów wierszy podatkowych, z których każda zawiera szczegóły podatku stosowanego do przedmiotu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
tax_line |
Refundacji
Refundacji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
refund |
zwrot
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Unikatowy identyfikator zwrotu pieniędzy. |
|
order_id
|
order_id | integer |
Identyfikator zamówienia używany do celów interfejsu API. |
|
utworzono_o
|
created_at | string |
Data i godzina (format ISO 8601) podczas tworzenia zwrotu pieniędzy. |
|
nuta
|
note | string |
Opcjonalna notatka dołączona do zwrotu pieniędzy. |
|
user_id
|
user_id | integer |
Unikatowy identyfikator użytkownika, który wykonał zwrot kosztów. |
|
processed_at
|
processed_at | string |
Data i godzina (format ISO 8601) podczas importowania zwrotu. |
|
ponowne zapasy
|
restock | boolean |
Czy dodać elementy wiersza z powrotem do spisu sklepu. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
|
transakcje
|
transactions | transactions |
Lista transakcji zaangażowanych w zwrot kosztów. |
|
order_adjustments
|
order_adjustments | array of |
Lista korekt zamówień dołączonych do zwrotu. |
line_item
Lista obiektów elementów wiersza, z których każda zawiera informacje o elemencie w kolejności.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | integer |
Identyfikator elementu wiersza. |
|
variant_id
|
variant_id | integer |
Identyfikator wariantu produktu. |
|
title
|
title | string |
Tytuł produktu. |
|
ilość
|
quantity | integer |
Liczba zakupionych elementów. |
|
sku
|
sku | string |
Jednostka SKU elementu (jednostka magazynowa). |
|
variant_title
|
variant_title | string |
Tytuł wariantu produktu. |
|
sprzedawca
|
vendor | string |
Nazwa dostawcy elementu. |
|
fulfillment_service
|
fulfillment_service | string |
Dostawca usług, który spełnia ten element. |
|
product_id
|
product_id | integer |
Identyfikator produktu, do którego należy element wiersza. |
|
requires_shipping
|
requires_shipping | boolean |
Czy przedmiot wymaga wysyłki. |
|
Opodatkowaniu
|
taxable | boolean |
Czy przedmiot jest podlegający opodatkowaniu. |
|
gift_card
|
gift_card | boolean |
Czy element wiersza jest kartą upominkową. |
|
nazwa
|
name | string |
Nazwa wariantu produktu. |
|
variant_inventory_management
|
variant_inventory_management | string |
Nazwa usługi zarządzania zapasami. |
|
properties
|
properties | line_item_properties |
Właściwości. |
|
product_exists
|
product_exists | boolean |
Czy produkt istnieje. |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
Kwota dostępna do spełnienia. |
|
Gramów
|
grams | integer |
Waga produktu w gramach. |
|
cena
|
price | string |
Cena przedmiotu przed zastosowaniem rabatów w walucie sklepu. |
|
total_discount
|
total_discount | string |
Łączna kwota rabatu przydzielonego do pozycji liniowej w walucie sklepu. |
|
fulfillment_status
|
fulfillment_status | string |
Stan zamówienia w odniesieniu do elementów wiersza, które są spełnione. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
Uporządkowana lista kwot przydzielonych przez aplikacje rabatowe. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Identyfikator interfejsu API graphql dla administratorów. |
|
tax_lines
|
tax_lines | tax_lines |
Lista obiektów wierszy podatkowych, z których każda zawiera szczegóły podatku stosowanego do przedmiotu. |
line_items
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
line_item |
Lista obiektów elementów wiersza, z których każda zawiera informacje o elemencie w kolejności. |
shipping_lines
Szczegóły używanej metody wysyłki.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
shipping_line |
payment_gateway_names
Lista bram płatności używanych do zamówienia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
string |
note_attribute
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
nazwa
|
name | string |
Zanotuj nazwę atrybutu. |
|
value
|
value | string |
Zanotuj wartość atrybutu. |
note_attributes
Dodatkowe informacje dodawane do zamówienia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
note_attribute |
discount_code
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
kod
|
code | string |
Gdy skojarzona aplikacja rabatu jest kodem typu, ta właściwość zwraca kod rabatu wprowadzony podczas wyewidencjonowania. |
|
kwota
|
amount | string |
Kwota odliczana od sumy zamówienia. Podczas tworzenia zamówienia ta wartość jest wartością procentową lub kwotą pieniężną do odliczenia. |
|
typ
|
type | string |
Typ rabatu. |
discount_codes
Lista rabatów stosowanych do zamówienia.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
discount_code |
discount_application
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
typ
|
type | string |
Typ aplikacji rabatu. |
|
value
|
value | string |
Wartość aplikacji rabatu jako dziesiętna. Reprezentuje to intencję aplikacji rabatu. |
|
value_type
|
value_type | string |
Typ wartości. |
|
allocation_method
|
allocation_method | string |
Metoda, za pomocą której wartość aplikacji rabatowej została przydzielona do uprawnionych wierszy. |
|
target_selection
|
target_selection | string |
Wiersze w kolejności, typu zdefiniowanego przez target_type, że rabat zostanie przydzielony. |
|
target_type
|
target_type | string |
Typ wiersza w zamówieniu, którego dotyczy rabat. |
|
kod
|
code | string |
Kod rabatu, który został użyty do zastosowania rabatu. Dostępne tylko dla aplikacji z kodem rabatu. |
discount_applications
Opis wniosku rabatowego, zgodnie z definicją kupca lub Skryptu Wykupu.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
discount_application |
paragon
Pole tekstowe zawierające informacje o paragonie.
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
testowe
|
testcase | boolean |
Czy realizacja była testem. |
|
autoryzacja
|
authorization | string |
Kod autoryzacji. |