Shopify (nezávislý vydavatel) (Preview)
Rozhraní REST pro obchodníky Společnosti Shopify k přijímání, zpracování a správě jejich objednávek.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| Metadata konektoru | |
|---|---|
| Vydavatel | Ray Bennett (MSFT) |
| Internetová stránka | https://www.shopify.com/ |
| Zásady ochrany osobních údajů | https://www.shopify.com/legal/privacy |
| Kategorie | Produktivita |
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč rozhraní API | securestring | Přístupový token pro toto rozhraní API. | Pravdivé |
| Adresa URL obchodu | řetězec | Adresa URL obchodu Shopify | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizuje objednávku. |
Aktualizuje objednávku s poskytnutými informacemi. |
| Načte seznam objednávek. |
Načte seznam objednávek, které splňují zadaná kritéria. |
| Načte seznam zákazníků. |
Načte seznam zákazníků, kteří splňují zadaná kritéria. |
| Zrušení objednávky |
Zrušení objednávky podle ID |
Aktualizuje objednávku.
Aktualizuje objednávku s poskytnutými informacemi.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID objednávky
|
order_id | True | string |
ID objednávky, která se aktualizuje. |
|
|
object |
Návraty
Objednávka
- Body
- order
Načte seznam objednávek.
Načte seznam objednávek, které splňují zadaná kritéria.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID objednávek
|
ids | string |
Umožňuje načíst pouze objednávky určené čárkami odděleným seznamem ID objednávek. |
|
|
Omezení
|
limit | string |
Maximální počet výsledků, které se mají zobrazit na stránce. |
|
|
Vzhledem k ID
|
since_id | string |
Zobrazí objednávky po zadaném ID. |
|
|
Vytvořeno v minutě
|
created_at_min | string |
Zobrazit objednávky vytvořené k datu nebo po datu (formát: 2014-04-25T16:15:47-04:00). |
|
|
Vytvořeno při maximálním počtu
|
created_at_max | string |
Zobrazit objednávky vytvořené k datu nebo před datem (formát: 2014-04-25T16:15:47-04:00). |
|
|
Aktualizováno v minutě
|
updated_at_min | string |
Zobrazit objednávky naposledy aktualizované k datu nebo po datu (formát: 2014-04-25T16:15:47-04:00). |
|
|
Aktualizováno maximálně
|
updated_at_max | string |
Zobrazit objednávky naposledy aktualizované k datu nebo před datem (formát: 2014-04-25T16:15:47-04:00). |
|
|
Zpracováno za minutu
|
processed_at_min | string |
Zobrazit objednávky importované k datu nebo po datu (formát: 2014-04-25T16:15:47-04:00). |
|
|
Zpracováno při maximálním počtu
|
processed_at_max | string |
Zobrazí objednávky importované k datu nebo před datem (formát: 2014-04-25T16:15:47-04:00). |
|
|
ID aplikace pro přiřazení
|
attribution_app_id | string |
Umožňuje zobrazit objednávky přiřazené určité aplikaci určené ID aplikace. |
|
|
Stav objednávky
|
status | string |
Filtrování objednávek podle jejich stavu |
|
|
Finanční stav
|
financial_status | string |
Filtrovat objednávky podle jejich finančního stavu. |
|
|
Stav plnění
|
fulfillment_status | string |
Vyfiltrujte objednávky podle jejich stavu plnění. |
|
|
Fields
|
fields | string |
Umožňuje načíst pouze určitá pole určená čárkami odděleným seznamem polí. |
|
|
Pořadí sekvencí záznamů
|
order | string |
Pole a směr řazení. Pokud chcete určit směr, přidejte na konec parametru dotazu asc nebo desc. Například order=updated_at asc. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
orders
|
orders | array of order |
Načte seznam zákazníků.
Načte seznam zákazníků, kteří splňují zadaná kritéria.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID zákazníků
|
ids | string |
Omezit výsledky na zákazníky určené čárkami oddělený seznam ID. |
|
|
Vzhledem k ID
|
since_id | string |
Omezit výsledky po zadaném ID |
|
|
Vytvořeno v minutě
|
created_at_min | string |
Zobrazí zákazníky vytvořené po zadaném datu (formát: 2014-04-25T16:15:47-04:00). |
|
|
Vytvořeno při maximálním počtu
|
created_at_max | string |
Zobrazí zákazníky vytvořené před zadaným datem (formát: 2014-04-25T16:15:47-04:00). |
|
|
Aktualizováno v minutě
|
updated_at_min | string |
Show customers last updated after a specified date (format: 2014-04-25T16:15:47-04:00). |
|
|
Aktualizováno maximálně
|
updated_at_max | string |
Zobrazit zákazníky naposledy aktualizované před zadaným datem (formát: 2014-04-25T16:15:47-04:00). |
|
|
Omezení
|
limit | string |
Maximální počet výsledků, které se mají zobrazit. (výchozí: 50)(maximálně: 250). |
|
|
Fields
|
fields | string |
Umožňuje zobrazit pouze určitá pole určená čárkami odděleným seznamem polí. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
customers
|
customers | array of customer |
Zrušení objednávky
Zrušení objednávky podle ID
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID objednávky
|
order_id | True | string |
ID objednávky, která bude zrušena. |
|
Refundace skutečné částky
|
amount | string |
Částka, která se má vrátit. Pokud je tato možnost nastavená, Shopify se pokusí platbu zrušit nebo refundovat v závislosti na jejím stavu. Vrácení peněz prostřednictvím ruční brány v případech, kdy původní transakce nebyla provedena v Shopify. Refundace prostřednictvím ruční brány se zaznamenávají jako refundace na Shopify, ale zákazník se nevrací. |
|
|
Refundace měny
|
currency | string |
Měna refundace vydané při zrušení objednávky. Vyžaduje se pro objednávky s více měnami vždy, když je k dispozici vlastnost částky. |
|
|
Vrácené položky se zbožím
|
restock | string |
Zda se mají vrátit refundované položky zpět do inventáře obchodu. |
|
|
Důvod zrušení objednávky
|
reason | string |
Důvod zrušení objednávky. Platné hodnoty: zákazník, inventář, podvod, odmítnutý a další. |
|
|
E-mail se zrušením
|
string |
Jestli chcete zákazníkovi poslat e-mail s oznámením o zrušení. |
||
|
Náhrada
|
refund | string |
Transakce refundace, které se mají provést. |
|
|
|
object |
Návraty
Objednávka
- Body
- order
Definice
pořadí
Objednávka
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
ID aplikace, která vytvořila objednávku. |
|
e-mail
|
string |
E-mailová adresa zákazníka. |
|
|
closed_at
|
closed_at | string |
Datum a čas (formát ISO 8601) při uzavření objednávky. Vrátí hodnotu null, pokud není objednávka uzavřena. |
|
datum_vytvoření
|
created_at | string |
Třímísmenný kód (formát ISO 4217) pro měnu obchodu. |
|
updated_at
|
updated_at | string |
Datum a čas (formát ISO 8601), kdy byla objednávka naposledy změněna. |
|
číslo
|
number | integer |
Pozice objednávky v počtu objednávek v obchodě. Čísla jsou sekvenční a začínají na 1. |
|
poznámka
|
note | string |
Volitelná poznámka, že vlastník obchodu se může připojit k objednávce. |
|
token
|
token | string |
Jedinečná hodnota při odkazování na pořadí. |
|
brána
|
gateway | string |
Používá se platební brána. |
|
test
|
test | boolean |
Určuje, jestli se jedná o testovací pořadí. |
|
total_price
|
total_price | string |
Součet všech cen řádkových položek, slev, dopravy, daní a tipů v měně obchodu. Musí být pozitivní. |
|
subtotal_price
|
subtotal_price | string |
Cena objednávky v obchodě měna po slevách, ale před expedicí, cla, daněmi a tipy. |
|
total_weight
|
total_weight | integer |
Součet hmotností všech položek řádku v gramech. Součet se neupraví, protože položky se odeberou z objednávky. |
|
total_tax
|
total_tax | string |
Součet všech daní použitých na objednávku v měně obchodu. Musí být pozitivní. |
|
taxes_included
|
taxes_included | boolean |
Zda jsou daně zahrnuty do mezisoučtu objednávky. |
|
měna
|
currency | string |
Třímísmenný kód (formát ISO 4217) pro měnu obchodu. |
|
financial_status
|
financial_status | string |
Stav plateb přidružených k objednávce. Lze nastavit pouze při vytvoření objednávky. |
|
potvrzený
|
confirmed | boolean |
Objednávka byla potvrzena. |
|
total_discounts
|
total_discounts | string |
Celkové slevy uplatněné na cenu objednávky v měně obchodu. |
|
total_line_items_price
|
total_line_items_price | string |
Součet všech cen řádkových položek v měně obchodu. |
|
cart_token
|
cart_token | string |
Jedinečná hodnota při odkazování na košík, který je přidružený k objednávce. |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
Jestli zákazník souhlasil s příjmem e-mailových aktualizací z obchodu. |
|
název
|
name | string |
Název objednávky vygenerovaný kombinací vlastnosti order_number s předponou objednávky a příponou nastavenou v obecném nastavení obchodníka. |
|
referring_site
|
referring_site | string |
Web, na kterém zákazník klikl na odkaz na obchod. |
|
landing_site
|
landing_site | string |
Adresa URL stránky, kde kupující přistál při vstupu do obchodu. |
|
zrušeno_v
|
cancelled_at | string |
Datum a čas zrušení objednávky. Vrátí hodnotu null, pokud se objednávka nezruší. |
|
cancel_reason
|
cancel_reason | string |
Důvod zrušení objednávky. |
|
total_price_usd
|
total_price_usd | string |
Celková cena USD. |
|
checkout_token
|
checkout_token | string |
Jedinečná hodnota při odkazování na rezervaci, která je přidružená k objednávce. |
|
odkazovat
|
reference | string |
Odkaz na objednávku. |
|
user_id
|
user_id | integer |
ID uživatele přihlášeného do Shopify POS, který objednávku zpracoval, pokud je to možné. |
|
location_id
|
location_id | integer |
ID fyzického umístění, ve kterém byla objednávka zpracována. Pokud potřebujete odkazovat na umístění v objednávce, použijte prostředek FulfillmentOrder. |
|
source_identifier
|
source_identifier | string |
Identifikátor zdroje |
|
source_url
|
source_url | string |
Zdrojová adresa URL |
|
processed_at
|
processed_at | string |
Datum a čas (formát ISO 8601) při zpracování objednávky. |
|
device_id
|
device_id | string |
ID zařízení. |
|
telefon
|
phone | string |
Telefonní číslo zákazníka pro příjem oznámení SMS. |
|
customer_locale
|
customer_locale | string |
Kód jazyka se dvěma nebo třemi písmeny, volitelně následovaný modifikátorem oblasti. |
|
app_id
|
app_id | integer |
ID aplikace, která vytvořila objednávku. |
|
browser_ip
|
browser_ip | string |
IP adresa prohlížeče používaného zákazníkem při zadání objednávky. |
|
landing_site_ref
|
landing_site_ref | string |
Referenční dokumentace cílové lokality. |
|
order_number
|
order_number | integer |
Pozice objednávky v počtu objednávek od roku 1001. |
|
discount_applications
|
discount_applications | discount_applications |
Popis slevové aplikace, jak je definováno obchodníkem nebo Shopify Script. |
|
discount_codes
|
discount_codes | discount_codes |
Seznam slev uplatněných na objednávku |
|
note_attributes
|
note_attributes | note_attributes |
Další informace, které jsou přidány do objednávky. |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
Seznam platebních bran použitých pro objednávku. |
|
processing_method
|
processing_method | string |
Způsob zpracování platby |
|
checkout_id
|
checkout_id | integer |
ID rezervace |
|
source_name
|
source_name | string |
Kde vznikla objednávka. |
|
fulfillment_status
|
fulfillment_status | string |
Stav objednávky z hlediska splněných řádkových položek. |
|
tax_lines
|
tax_lines | tax_lines |
Seznam objektů daňového řádku, z nichž každý podrobně popisuje daň uplatněnou na položku. |
|
tags
|
tags | string |
Značky připojené k objednávce formátované jako řetězec hodnot oddělených čárkami. Značky jsou další krátké popisovače, které se běžně používají k filtrování a vyhledávání. |
|
contact_email
|
contact_email | string |
Kontaktní e-mail. |
|
order_status_url
|
order_status_url | string |
Adresa URL odkazující na webovou stránku stavu objednávky( pokud je k dispozici). |
|
presentment_currency
|
presentment_currency | string |
Prezentující měna, která byla použita k zobrazení cen zákazníkovi. |
|
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 |
ID rozhraní API pro správu Graphql |
|
shipping_lines
|
shipping_lines | shipping_lines |
Podrobnosti o způsobu dopravy, který se použil. |
|
billing_address
|
billing_address | billing_address |
Poštovní adresa přidružená k způsobu platby. Tato adresa je volitelné pole, které nebude k dispozici u objednávek, které nevyžadují způsob platby. |
|
shipping_address
|
shipping_address | shipping_address |
Poštovní adresa, do které bude objednávka odeslána. Tato adresa je nepovinná a nebude dostupná u objednávek, které nevyžadují expedici. |
|
client_details
|
client_details | client_detail |
Informace o prohlížeči, který zákazník použil při zadání objednávky. |
|
payment_details
|
payment_details | payment_detail |
Objekt obsahující informace o platbě. |
|
Zákazník
|
customer | customer |
Informace o zákazníkovi. |
|
line_items
|
line_items | line_items | |
|
plnění
|
fulfillments | fulfillments |
Pole plnění přidružených k objednávce. |
|
náhrady
|
refunds | refunds |
Náhrady |
Zákazník
Informace o zákazníkovi.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor zákazníka. |
|
e-mail
|
string |
Jedinečná e-mailová adresa zákazníka. Pokus o přiřazení stejné e-mailové adresy více zákazníkům vrátí chybu. |
|
|
accepts_marketing
|
accepts_marketing | boolean |
Jestli zákazník souhlasil s příjmem marketingového materiálu prostřednictvím e-mailu. |
|
datum_vytvoření
|
created_at | string |
Datum a čas (formát ISO 8601) při vytvoření zákazníka. |
|
updated_at
|
updated_at | string |
Datum a čas (formát ISO 8601), kdy byly informace o zákazníci naposledy aktualizovány. |
|
first_name
|
first_name | string |
Jméno zákazníka. |
|
last_name
|
last_name | string |
Příjmení zákazníka. |
|
orders_count
|
orders_count | integer |
Počet objednávek přidružených k tomuto zákazníkovi. |
|
stav
|
state | string |
Stav účtu zákazníka v obchodě. Výchozí hodnota: zakázáno. |
|
total_spent
|
total_spent | string |
Celková částka peněz, kterou zákazník utratil v historii objednávek. |
|
last_order_id
|
last_order_id | integer |
ID poslední objednávky zákazníka. |
|
poznámka
|
note | string |
Poznámka o zákazníkovi. |
|
verified_email
|
verified_email | boolean |
Jestli zákazník ověřil svoji e-mailovou adresu. |
|
multipass_identifier
|
multipass_identifier | string |
Jedinečný identifikátor zákazníka, který se používá s přihlášením multipassu. |
|
tax_exempt
|
tax_exempt | boolean |
Zda je zákazník osvobozen od placení daní na objednávku. Pokud ano, daně se na objednávku při pokladně nepoužijí. Pokud je false, daně se použijí při pokladně. |
|
telefon
|
phone | string |
Jedinečné telefonní číslo (formát E.164) pro tohoto zákazníka. Pokus o přiřazení stejného telefonního čísla více zákazníkům vrátí chybu. |
|
tags
|
tags | string |
Značky, které vlastník obchodu připojil k zákazníkovi, formátovaný jako řetězec hodnot oddělených čárkami. Zákazník může mít až 250 značek. Každá značka může mít až 255 znaků. |
|
last_order_name
|
last_order_name | string |
Jméno poslední objednávky zákazníka. To přímo souvisí s polem názvu zdroje Objednávky. |
|
měna
|
currency | string |
Třímísmenný kód (formát ISO 4217) pro měnu, kterou zákazník použil při placení za poslední objednávku. |
|
addresses
|
addresses | addresses |
Seznam deset naposledy aktualizovaných adres pro zákazníka. |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
Datum a čas (formát ISO 8601), kdy zákazník souhlasil nebo objektoval na příjem marketingového materiálu e-mailem. |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
Úroveň výslovného souhlasu s marketingovým předplatným, kterou zákazník zadal, když souhlasil s příjmem marketingového materiálu e-mailem. |
|
tax_exemptions
|
tax_exemptions | array of |
Zda je zákazník osvobozen od placení konkrétních daní na objednávku. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
ID rozhraní API pro správu Graphql |
|
default_address
|
default_address | default_address |
default_address
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor adresy. |
|
customer_id
|
customer_id | integer |
Jedinečný identifikátor zákazníka. |
|
first_name
|
first_name | string |
Jméno zákazníka. |
|
last_name
|
last_name | string |
Příjmení zákazníka. |
|
společnost
|
company | string |
Společnost zákazníka. |
|
adresa1
|
address1 | string |
První řádek poštovní adresy zákazníka. |
|
adresa2
|
address2 | string |
Další pole pro poštovní adresu zákazníka. |
|
město
|
city | string |
Město, město nebo vesnice zákazníka. |
|
provincie
|
province | string |
Název oblasti zákazníka. Obvykle provincie, stát nebo prefektura. |
|
země
|
country | string |
Země zákazníka. |
|
zip (jako formát souboru)
|
zip | string |
PSČ zákazníka, označovaný také jako PSČ, PSČ, Eircode atd. |
|
telefon
|
phone | string |
Telefonní číslo zákazníka na této adrese. |
|
název
|
name | string |
Jméno a příjmení zákazníka. |
|
province_code
|
province_code | string |
Dvoumísmenný kód oblasti zákazníka. |
|
country_code
|
country_code | string |
Dvoumísmenný kód země odpovídající zemi zákazníka. |
|
country_name
|
country_name | string |
Normalizovaný název země zákazníka. |
|
výchozí
|
default | boolean |
Vrátí hodnotu true pro každou výchozí adresu. |
shipping_address
Poštovní adresa, do které bude objednávka odeslána. Tato adresa je nepovinná a nebude dostupná u objednávek, které nevyžadují expedici.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
Jméno osoby přidružené k expediční adrese. |
|
adresa1
|
address1 | string |
Adresa ulice expediční adresy. |
|
telefon
|
phone | string |
Telefonní číslo na dodací adrese. |
|
město
|
city | string |
Město, město nebo vesnice dodací adresy. |
|
zip (jako formát souboru)
|
zip | string |
PSČ (například PSČ, PSČ nebo Eircode) dodací adresy. |
|
provincie
|
province | string |
Název oblasti (například provincie, stát nebo prefektura) dodací adresy. |
|
země
|
country | string |
Název země expediční adresy. |
|
last_name
|
last_name | string |
Příjmení osoby přidružené k expediční adrese. |
|
adresa2
|
address2 | string |
Volitelné další pole pro adresu ulice dodací adresy. |
|
společnost
|
company | string |
Společnost osoby přidružené k expediční adrese. |
|
zeměpisná šířka
|
latitude | float |
Zeměpisná šířka dodací adresy. |
|
longitude
|
longitude | float |
Zeměpisná délka dodací adresy. |
|
název
|
name | string |
Celé jméno osoby přidružené k způsobu platby. |
|
country_code
|
country_code | string |
Dvoumísmenný kód (formát ISO 3166-1) pro zemi dodací adresy. |
|
province_code
|
province_code | string |
Dvoumísmenná zkratka oblasti dodací adresy. |
billing_address
Poštovní adresa přidružená k způsobu platby. Tato adresa je volitelné pole, které nebude k dispozici u objednávek, které nevyžadují způsob platby.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
Jméno osoby přidružené k způsobu platby. |
|
adresa1
|
address1 | string |
Adresa fakturační adresy. |
|
telefon
|
phone | string |
Telefonní číslo na fakturační adrese. |
|
město
|
city | string |
Město, město nebo vesnice fakturační adresy. |
|
zip (jako formát souboru)
|
zip | string |
PSČ (například PSČ, PSČ nebo Eircode) fakturační adresy. |
|
provincie
|
province | string |
Název oblasti (například provincie, stát nebo prefektura) fakturační adresy. |
|
země
|
country | string |
Název země fakturační adresy. |
|
last_name
|
last_name | string |
Příjmení osoby přidružené k způsobu platby. |
|
adresa2
|
address2 | string |
Volitelné další pole pro poštovní adresu fakturační adresy. |
|
společnost
|
company | string |
Společnost osoby přidružené k fakturační adrese. |
|
zeměpisná šířka
|
latitude | float |
Zeměpisná šířka fakturační adresy. |
|
longitude
|
longitude | float |
Zeměpisná délka fakturační adresy. |
|
název
|
name | string |
Celé jméno osoby přidružené k způsobu platby. |
|
country_code
|
country_code | string |
Dvoumísmenný kód (formát ISO 3166-1) pro zemi fakturační adresy. |
|
province_code
|
province_code | string |
Dvoumísmenná zkratka oblasti fakturační adresy. |
addresses
Seznam deset naposledy aktualizovaných adres pro zákazníka.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
default_address |
shipping_line
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Globálně jedinečný identifikátor. |
|
title
|
title | string |
Název metody expedice. |
|
cena
|
price | string |
Cena této metody dopravy v měně obchodu. |
|
kód
|
code | string |
Odkaz na metodu expedice. |
|
odeslat k provedení
|
source | string |
Zdroj metody expedice. |
|
telefon
|
phone | string |
Telefonní číslo na dodací adrese. |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
Odkaz na službu plnění, která se požaduje pro metodu expedice. Prezentovat, pokud způsob dopravy vyžaduje zpracování službou plnění třetí strany; v opačném případě hodnota null. |
|
delivery_category
|
delivery_category | string |
Kategorie doručení. |
|
carrier_identifier
|
carrier_identifier | string |
Odkaz na službu dopravce, která poskytla sazbu. K dispozici, když byla sazba vypočítána službou operátora třetí strany. |
|
discounted_price
|
discounted_price | string |
Cena způsobu dopravy po uplatnění slev na úrovni řádku. Neodráží slevy na úrovni košíku ani na úrovni objednávky. |
|
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 |
Seřazený seznam částek přidělených aplikacemi slev. |
|
tax_lines
|
tax_lines | tax_lines |
Seznam objektů daňového řádku, z nichž každý podrobně popisuje daň uplatněnou na položku. |
client_detail
Informace o prohlížeči, který zákazník použil při zadání objednávky.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
IP adresa prohlížeče. |
|
accept_language
|
accept_language | string |
Jazyky a národní prostředí, kterým prohlížeč rozumí. |
|
user_agent
|
user_agent | string |
Podrobnosti o klientovi procházení, včetně softwaru a operačních verzí |
|
session_hash
|
session_hash | string |
Hodnota hash relace. |
|
browser_width
|
browser_width | integer |
Šířka obrazovky prohlížeče v pixelech, pokud je k dispozici. |
|
browser_height
|
browser_height | integer |
Výška obrazovky prohlížeče v pixelech, pokud je k dispozici. |
payment_detail
Objekt obsahující informace o platbě.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
Identifikační číslo vystavitele (IIN), dříve označované jako bankovní identifikační číslo (BIN), platební karty zákazníka. |
|
avs_result_code
|
avs_result_code | string |
Kód odpovědi ze systému ověřování adres (AVS). Kód je jedno písmeno. |
|
cvv_result_code
|
cvv_result_code | string |
Kód odpovědi od společnosti s platební kartou označující, jestli zákazník zadal správně bezpečnostní kód karty (hodnotu ověření karty). Kód je jedno písmeno nebo prázdný řetězec. |
|
credit_card_number
|
credit_card_number | string |
Číslo platební karty zákazníka s většinou počátečních číslic, které jsou redakčně upraveny. |
|
credit_card_company
|
credit_card_company | string |
Jméno společnosti, která vydala platební kartu zákazníka. |
subtotal_tax_discount_price_set
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
částky
|
shop_money.amount | string |
Skutečná částka. |
|
currency_code
|
shop_money.currency_code | string |
Ve formátu ISO 4217. |
|
částky
|
presentment_money.amount | string |
Skutečná částka. |
|
currency_code
|
presentment_money.currency_code | string |
Ve formátu ISO 4217. |
line_item_property
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
název
|
name | string |
Název produktu. |
|
value
|
value | string |
Hodnota produktu. |
line_item_properties
Vlastnosti.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
line_item_property |
naplnění
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
ID plnění. |
|
order_id
|
order_id | integer |
Jedinečný číselný identifikátor objednávky. |
|
stav
|
status | string |
Stav plnění. |
|
datum_vytvoření
|
created_at | string |
Datum a čas vytvoření plnění. |
|
služba
|
service | string |
Typ použité služby. |
|
updated_at
|
updated_at | string |
Datum a čas (formát ISO 8601) při poslední změně plnění. |
|
tracking_company
|
tracking_company | string |
Název sledovací společnosti. |
|
shipment_status
|
shipment_status | string |
Aktuální stav dodávky. |
|
location_id
|
location_id | integer |
Jedinečný identifikátor umístění, pro které má být plnění zpracováno. |
|
tracking_number
|
tracking_number | string |
Sledovací číslo, které poskytla přepravní společnost. |
|
tracking_numbers
|
tracking_numbers | array of string |
Seznam sledovacích čísel, která poskytuje přepravní společnost. |
|
tracking_url
|
tracking_url | string |
Adresa URL stránky sledování pro plnění. |
|
tracking_urls
|
tracking_urls | array of string |
Adresy URL sledovacích stránek pro plnění. |
|
paragon
|
receipt | receipt |
Textové pole, které poskytuje informace o potvrzení. |
|
název
|
name | string |
Jedinečný název plnění. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
ID rozhraní API pro správu Graphql |
|
line_items
|
line_items | line_items |
plnění
Pole plnění přidružených k objednávce.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
fulfillment |
transakce
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
ID transakce. |
|
order_id
|
order_id | integer |
ID objednávky, ke které je transakce přidružena. |
|
laskavý
|
kind | string |
Typ transakce. |
|
brána
|
gateway | string |
Název brány, prostřednictvím které transakce byla vydána. |
|
stav
|
status | string |
Stav transakce. |
|
zpráva
|
message | string |
Řetězec vygenerovaný poskytovatelem plateb s dalšími informacemi o tom, proč transakce proběhla úspěšně nebo selhala. |
|
datum_vytvoření
|
created_at | string |
Datum a čas (formát ISO 8601) při vytvoření transakce. |
|
test
|
test | boolean |
Zda transakce je testovací transakce. |
|
autorizace
|
authorization | string |
Autorizační kód přidružený k transakci. |
|
location_id
|
location_id | string |
ID fyzického umístění, kde byla transakce zpracována. |
|
user_id
|
user_id | string |
ID uživatele, který byl přihlášen k zařízení Shopify POS při zpracování objednávky, pokud je k dispozici. |
|
parent_id
|
parent_id | integer |
ID přidružené transakce. |
|
processed_at
|
processed_at | string |
Datum a čas (formát ISO 8601) při zpracování transakce. |
|
device_id
|
device_id | string |
ID zařízení. |
|
error_code
|
error_code | string |
Standardizovaný kód chyby nezávislý na poskytovateli plateb. |
|
source_name
|
source_name | string |
Původ transakce. Toto nastavení nastavuje Shopify a nedá se přepsat. |
|
částky
|
amount | string |
Částka peněz zahrnutá v transakci. |
|
měna
|
currency | string |
Třímísmenný kód (formát ISO 4217) pro měnu použitou pro platbu. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
ID rozhraní API pro správu Graphql |
transakcí
Seznam transakcí zahrnutých v refundaci.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
transaction |
tax_line
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
cena
|
price | string |
Částka daně, která se má účtovat v měně obchodu. |
|
sazba
|
rate | float |
Sazba daně, která se má uplatnit. |
|
title
|
title | string |
Název daně. |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
Seznam objektů daňového řádku, z nichž každý podrobně popisuje daň uplatněnou na položku.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
tax_line |
náhrady
Náhrady
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
refund |
náhrada
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
Jedinečný identifikátor refundace. |
|
order_id
|
order_id | integer |
ID objednávky, které se používá pro účely rozhraní API. |
|
datum_vytvoření
|
created_at | string |
Datum a čas (formát ISO 8601) při vytvoření refundace. |
|
poznámka
|
note | string |
Volitelná poznámka připojená k refundaci. |
|
user_id
|
user_id | integer |
Jedinečný identifikátor uživatele, který refundaci provedl. |
|
processed_at
|
processed_at | string |
Datum a čas (formát ISO 8601) při importu refundace. |
|
doplnit zásoby
|
restock | boolean |
Zda se mají řádkové položky přidat zpět do inventáře obchodu. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
ID rozhraní API pro správu Graphql |
|
transakcí
|
transactions | transactions |
Seznam transakcí zahrnutých v refundaci. |
|
order_adjustments
|
order_adjustments | array of |
Seznam úprav objednávek připojených k refundaci. |
line_item
Seznam objektů řádkové položky, z nichž každý obsahuje informace o položce v pořadí.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | integer |
ID řádkové položky. |
|
variant_id
|
variant_id | integer |
ID varianty produktu. |
|
title
|
title | string |
Název produktu. |
|
množství
|
quantity | integer |
Počet zakoupených položek. |
|
sku
|
sku | string |
Skladová položka (skladová jednotka). |
|
variant_title
|
variant_title | string |
Název varianty produktu. |
|
prodejce
|
vendor | string |
Název dodavatele položky. |
|
fulfillment_service
|
fulfillment_service | string |
Poskytovatel služeb, který tuto položku plní. |
|
product_id
|
product_id | integer |
ID produktu, do kterého řádek položka patří. |
|
requires_shipping
|
requires_shipping | boolean |
Zda položka vyžaduje expedici. |
|
zdanitelný
|
taxable | boolean |
Zda je položka zdanitelná. |
|
gift_card
|
gift_card | boolean |
Určuje, jestli je řádková položka dárkovou kartou. |
|
název
|
name | string |
Název varianty produktu. |
|
variant_inventory_management
|
variant_inventory_management | string |
Název služby správy inventáře. |
|
vlastnosti
|
properties | line_item_properties |
Vlastnosti. |
|
product_exists
|
product_exists | boolean |
Zda produkt existuje. |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
Částka, která je k dispozici ke splnění. |
|
gramy
|
grams | integer |
Hmotnost položky v gramech. |
|
cena
|
price | string |
Cena položky před uplatněním slev v měně obchodu. |
|
total_discount
|
total_discount | string |
Celková částka slevy přidělené řádkové položce v měně obchodu. |
|
fulfillment_status
|
fulfillment_status | string |
Stav objednávky z hlediska plnění řádkových položek. |
|
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 |
Seřazený seznam částek přidělených aplikacemi slev. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
ID rozhraní API pro správu Graphql |
|
tax_lines
|
tax_lines | tax_lines |
Seznam objektů daňového řádku, z nichž každý podrobně popisuje daň uplatněnou na položku. |
line_items
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
line_item |
Seznam objektů řádkové položky, z nichž každý obsahuje informace o položce v pořadí. |
shipping_lines
Podrobnosti o způsobu dopravy, který se použil.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
shipping_line |
payment_gateway_names
Seznam platebních bran použitých pro objednávku.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
string |
note_attribute
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
název
|
name | string |
Název atributu poznámky |
|
value
|
value | string |
Všimněte si hodnoty atributu. |
note_attributes
Další informace, které jsou přidány do objednávky.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
note_attribute |
discount_code
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
kód
|
code | string |
Pokud je přidružená sleva aplikace typu kód, tato vlastnost vrátí kód slevy, který byl zadán při pokladně. |
|
částky
|
amount | string |
Částka, která se odečte od součtu objednávky. Při vytváření objednávky je tato hodnota procentuální nebo peněžní částka, která se má odečíst. |
|
typ
|
type | string |
Typ slevy. |
discount_codes
Seznam slev uplatněných na objednávku
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
discount_code |
discount_application
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
typ
|
type | string |
Typ aplikace slevy. |
|
value
|
value | string |
Hodnota slevové aplikace jako desetinné číslo. Představuje záměr uplatnění slevy. |
|
value_type
|
value_type | string |
Typ hodnoty. |
|
allocation_method
|
allocation_method | string |
Metoda, podle které byla hodnota uplatnění slevy přidělena oprávněným řádkům. |
|
target_selection
|
target_selection | string |
Řádky v objednávce typu definovaného target_type, které je sleva přidělena. |
|
target_type
|
target_type | string |
Typ řádku objednávky, na kterou se sleva vztahuje. |
|
kód
|
code | string |
Kód slevy, který se použil k uplatnění slevy. K dispozici pouze pro aplikace s kódem slevy. |
discount_applications
Popis slevové aplikace, jak je definováno obchodníkem nebo Shopify Script.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Položky
|
discount_application |
paragon
Textové pole, které poskytuje informace o potvrzení.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
testovací případ
|
testcase | boolean |
Zda bylo plnění testovacím případem. |
|
autorizace
|
authorization | string |
Autorizační kód. |