Słownik danych dotyczących migracji sklepu

Słownik danych dotyczących migracji sklepu zawiera informacje o zasobach Customer, Order i Product interfejsu API panelu administracyjnego REST. Słownik danych stanowi dodatkowe źródło informacji dla doświadczonych partnerów, którzy przeprowadzają migrację sklepów do Shopify.

Customer : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu Customer interfejsu API panelu administracyjnego REST.

Dane dotyczące istotnych właściwości związanych z zasobem Customer REST
Właściwość Wartości Opis Typ danych Długość pola Dostęp do pola Wymagane pole krytyczne
accepts_marketing Domyślnie: 0 Określa, czy klient wyraził zgodę na otrzymywanie materiałów marketingowych. Wartość logiczna tinyint(1) Y
accepts_marketing_
updated_at
Data i godzina (w formacie ISO 8601) wyrażenia przez klienta zgody (lub sprzeciwu) na otrzymywanie materiałów marketingowych pocztą elektroniczną. Datetime
adresy Lista adresów powiązanych z klientem. [{ Address }]
currency Trzyliterowy kod w formacie ISO 4217 oznaczający walutę, w której klient dokonał płatności za swoje ostatnie zamówienie. Ciąg znaków Waluta sklepu tylko do odczytu
created_at Domyślnie: NULL Data i godzina (w formacie ISO 8601) dodania klienta do sklepu. Datetime datetime tylko do odczytu
default_address Adres domyślny klienta. { Address }
email Domyślnie: NULL Unikalny adres e-mail klienta. Ciąg znaków varchar(255)
first_name Domyślnie: NULL Imię klienta Ciąg znaków varchar(255)
id Domyślnie: NULL Identyfikator unikalny w skali światowej. (Wartość ta jest automatycznie zwiększana). Liczba całkowita bigint(20) Y
last_name Domyślnie: NULL Nazwisko klienta Ciąg znaków varchar(255)
last_order_id Domyślnie: NULL Identyfikator ostatniego zamówienia klienta. Liczba całkowita bigint(20) tylko do odczytu
last_order_name Domyślnie: NULL Nazwa ostatniego zamówienia klienta. Ciąg znaków tylko do odczytu
metapole Domyślnie: NULL Zwraca metapole według przestrzeni nazw i klucza, który należy do zasobu. { Metapole }
marketing_opt_
in_level
  • null
  • single_opt_in
  • confirmed_opt_in
  • unknown
Domyślnie: NULL
Poziom wyrażenia zgody na subskrypcję materiałów marketingowych (zgodnie z wytycznymi dotyczącymi najlepszych praktyk M3AAWG), który klient podał, wyrażając zgodę na otrzymywanie materiałów marketingowych pocztą elektroniczną. String, enum
multipass_identifier Domyślnie: NULL Unikalny identyfikator klienta, który jest używany przy logowaniu poprzez Multipass. Ciąg znaków varchar(255)
uwaga Domyślnie: NULL Uwaga dotycząca klienta. Ciąg znaków mediumtext
orders_count Domyślnie: 0 Liczba zamówień złożonych przez klienta w sklepie od momentu utworzenia konta. Liczba całkowita int(11) tylko do odczytu
telefon Domyślnie: NULL Unikalny (w sklepie) numer telefonu (format E.164) dla tego klienta. Ciąg znaków varchar(255)
sms_marketing_
consent
Domyślnie: NULL Bieżący stan marketingu SMS-owego dla numeru telefonu klienta. Ciąg znaków
state
  • disabled
  • invited
  • włączone
  • odrzucone
Domyślnie: disabled
Stan konta klienta w sklepie. String, enum varchar(255) tylko do odczytu
tagi Domyślnie: NULL Rozdzielona przecinkami lista zawierająca maksymalnie 250 tagów, które zostały dodane do klienta. Ciąg znaków 255 na każdy tag
tax_exempt Domyślnie: 0 Określa, czy klient jest zwolniony z podatków naliczanych dla zamówień. Wartość logiczna tinyint(1) Y
tax_exemptions Pełna lista wartości znajduje się w zasobie Customer. Lista zwolnień podatkowych zastosowanych wobec klienta. Ciąg znaków
total_spent Domyślnie: 0 Całkowita kwota, jaką klient wydał na zamówienia od momentu utworzenia konta. Wykazywana w walucie sklepu. Jeśli używasz wielu walut, kwota będzie wyświetlana w walucie domyślnej bez kursu wymiany. Liczba decimal(21,3) tylko do odczytu
updated_at Data i godzina ostatniej aktualizacji klienta. Na podstawie strefy czasowej sklepu. Datetime datetime tylko do odczytu
verified_email Domyślnie: 1 Wskazuje, czy klient zweryfikował swój adres e-mail. Domyślnie jest to wartość true, jeśli klient został utworzony za pośrednictwem panelu administracyjnego Shopify lub API. Wartość logiczna tinyint(1) tylko do odczytu

CustomerAddress : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu CustomerAddress interfejsu API panelu administracyjnego REST. Dla tego zasobu nie ma wymaganych pól krytycznych.

Dane dotyczące istotnych właściwości związanych z zasobem Customer Address REST
Właściwość Wartości Opis Typ danych Długość pola Dostęp do pola
address1 Domyślnie: NULL Adres pocztowy klienta. 100 na każde konto klienta. Ciąg znaków varchar(255)
address2 Domyślnie: NULL Dodatkowe pole dla adresu pocztowego klienta. Ciąg znaków varchar(255)
city Domyślnie: NULL Miasto lub wieś klienta. Ciąg znaków varchar(255)
company Domyślnie: NULL Firma klienta. Ciąg znaków varchar(255)
kraj Domyślnie: NULL Kraj klienta Ciąg znaków varchar(255)
first_name Domyślnie: NULL Imię klienta Ciąg znaków varchar(255)
country_code Dwuliterowy kod kraju odpowiadający krajowi klienta. Ciąg znaków tylko do odczytu
country_name Znormalizowana nazwa kraju klienta. Ciąg znaków
last_name Domyślnie: NULL Nazwisko klienta Ciąg znaków varchar(255)
nazwa Imię i nazwisko klienta. Ciąg znaków
telefon Domyślnie: NULL Numer telefonu klienta pod tym adresem. Ciąg znaków varchar(255)
province Domyślnie: NULL Nazwa regionu klienta. Zazwyczaj województwo, prowincja, stan lub prefektura. Ciąg znaków varchar(255)
province_code Dwuliterowy kod regionu klienta. Ciąg znaków tylko do odczytu
pocztowy Domyślnie: NULL Kod pocztowy klienta lub inny tego typu kod. Ciąg znaków varchar(255)

Order : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu Order interfejsu API panelu administracyjnego REST.

Dane dotyczące istotnych właściwości zasobu Order REST
Właściwość Wartości Opis Typ danych Długość pola Dostęp do pola Wymagane pole krytyczne
app_id Domyślnie: NULL ID aplikacji, która utworzyła zamówienie. integer bigint(20) tylko do odczytu
billing_address Domyślnie: NULL Adres pocztowy powiązany z metodą płatności. Adres ten jest opcjonalnym polem, które nie jest dostępne w zamówieniach niewymagających metody płatności. integer bigint(20)
browser_ip Adres IP przeglądarki używanej przez klienta podczas składania zamówienia. Obsługiwane są zarówno adresy IPv4, jak i IPv6. ciąg znaków varchar(255) tylko do odczytu
buyer_accepts_marketing Domyślnie: 0 Wskazuje, czy klient wyraził zgodę na otrzymywanie od sklepu aktualizacji pocztą elektroniczną. boolean tinyint(1)
cancel_reason
  • customer
  • oszustwo
  • zapasy
  • odrzucone
  • other
Domyślnie: NULL
Powód anulowania zamówienia ciąg znaków varchar(255)
cancelled_at Domyślnie: NULL Data i godzina anulowania zamówienia. Zwraca wartość null, jeśli zamówienie nie zostanie anulowane. date datetime tylko do odczytu
cart_token Domyślnie: NULL Unikalna wartość przy odwoływaniu się do koszyka powiązanego z zamówieniem. ciąg znaków varchar(255) tylko do odczytu
checkout_token Domyślnie: NULL Unikalna wartość przy odwoływaniu się do realizacji zakupu powiązanej z zamówieniem. ciąg znaków varchar(64) tylko do odczytu
client_details
  • accept_language
  • browser_height
  • browser_ip
  • browser_width
  • session_hash
  • user_agent
Informacje o przeglądarce użytej przez klienta podczas składania zamówienia:

accept_language: Języki i ustawienia regionalne, które rozumie przeglądarka.
browser_height: Wysokość ekranu przeglądarki w pikselach, jeśli jest dostępna.
browser_ip: Adres IP przeglądarki.
browser_width: Szerokość ekranu przeglądarki w pikselach, jeśli jest dostępna.
session_hash: Skrót sesji.
user_agent: Szczegóły klienta przeglądania, w tym oprogramowanie i wersje operacyjne.
object tylko do odczytu
closed_at Domyślnie: NULL Data i godzina (format ISO 8601) zamknięcia zamówienia. Zwraca wartość null, jeśli zamówienie nie zostanie zamknięte. date datetime tylko do odczytu
created_at Domyślnie: NULL Automatycznie wygenerowana data i godzina (format ISO 8601) utworzenia zamówienia w Shopify. Wartości tej właściwości nie można zmienić. date datetime(6) tylko do odczytu
currency Domyślnie: NULL Trzyliterowy kod (format ISO 4217) waluty sklepu. ciąg znaków (3)
current_subtotal_price Bieżąca cena cząstkowa zamówienia w walucie sklepu. Wartość tego pola odzwierciedla zmiany zamówienia, zwroty i zwroty kosztów. ciąg znaków varchar(255) tylko do odczytu
current_subtotal_price_set Bieżąca cena cząstkowa zamówienia w walucie sklepu i w walucie prezentacji. Wartości kwot związane z tym polem odzwierciedlają zmiany zamówienia, zwroty i zwroty kosztów. object tylko do odczytu
current_total_discounts Bieżąca suma rabatów udzielonych na zamówienie w walucie sklepu. Wartość tego pola odzwierciedla zmiany zamówienia, zwroty i zwroty kosztów. ciąg znaków varchar(255) tylko do odczytu
current_total_discounts_set Bieżąca suma rabatów udzielonych na zamówienie w walucie sklepu i prezentacji. Wartości kwot związane z tym polem odzwierciedlają zmiany zamówienia, zwroty i zwroty kosztów. object tylko do odczytu
current_total_duties_set Bieżąca suma opłat celnych naliczonych od zamówienia w walucie sklepu i walucie prezentacji. Wartości kwot związane z tym polem odzwierciedlają zmiany zamówienia, zwroty i zwroty kosztów. object tylko do odczytu
current_total_price Bieżąca łączna cena zamówienia w walucie sklepu. Wartość tego pola odzwierciedla zmiany zamówienia, zwroty i zwroty kosztów. ciąg znaków varchar(255) tylko do odczytu
current_total_price_set Bieżąca łączna cena zamówienia w walucie sklepu i w walucie prezentacji. Wartości kwot związane z tym polem odzwierciedlają zmiany zamówienia, zwroty i zwroty kosztów. object tylko do odczytu
current_total_tax Bieżąca łączna kwota podatków naliczonych od zamówienia w walucie sklepu. Wartość tego pola odzwierciedla zmiany zamówienia, zwroty lub zwroty kosztów. ciąg znaków varchar(255) tylko do odczytu
current_total_tax_set Bieżąca łączna kwota podatków naliczonych od zamówienia w walucie sklepu i w walucie prezentacji. Wartości kwot związane z tym polem odzwierciedlają zmiany zamówienia, zwroty i zwroty kosztów. object tylko do odczytu
customer Domyślnie: NULL Informacje o kliencie. Zamówienie może nie posiadać klienta i aplikacje nie powinny być uzależnione od istnienia obiektu typu klient. Wartością tą może być null, jeśli zamówienie zostało utworzone za pośrednictwem Shopify POS integer bigint(20)
customer_locale Domyślnie: NULL Dwu- lub trzyliterowy kod języka, po którym opcjonalnie może następować modyfikator regionu. ciąg znaków varchar(255) tylko do odczytu
discount_applications Uporządkowana lista ułożonych w stos aplikacji rabatowych.

Właściwość discount_applications obejmuje 3 typy: discount_code, manual i script. Wszystkie 3 typy mają wspólną strukturę i pewne atrybuty charakterystyczne dla typu.
array tylko do odczytu
discount_codes Lista rabatów zastosowanych w zamówieniu. array
email Adres e-mail klienta varchar(255)
estimated_taxes Wskazuje, czy szacowane są podatki od zamówienia. Między złożeniem zamówienia przez klienta a jego wysyłką może ulec zmianie wiele czynników, które mogą wpłynąć na obliczenie podatków. Właściwość ta zwraca wartość false, jeśli podatki w zamówieniu mają charakter ostateczny i nie podlegają żadnym zmianom. boolean tinyint(1)
financial_status
  • oczekujące
  • authorized
  • partially_paid
  • płatne
  • partially_refunded
  • refunded
Domyślnie: NULL
Status płatności związanych z zamówieniem. Można go ustawić tylko podczas tworzenia zlecenia. ciąg znaków varchar(255) tylko do odczytu
fulfillment_status
  • zrealizowane
  • niezrealizowane
  • null
  • częściowo
  • restocked
Domyślnie: unfulfilled
Status zamówienia pod względem zrealizowanych pozycji. ciąg znaków varchar(255)
realizacje Tablica realizacji związanych z zamówieniem array
id Domyślnie: NULL ID zamówienia używany do celów interfejsu API. Jest to inna właściwość niż order_number, która jest identyfikatorem używanym przez właściciela sklepu i klienta. integer bigint(20) tylko do odczytu
landing_site Domyślnie: NULL Adres URL strony, na którą trafił kupujący po wejściu do sklepu. ciąg znaków varchar(4096) tylko do odczytu
line_items Lista obiektów pozycji, z których każdy zawiera informacje o pozycji w zamówieniu array Y
location_id Domyślnie: NULL Identyfikator fizycznej lokalizacji, w której przetworzono zamówienie. Aby odnieść lokalizację do zamówienia, użyj zasobu FulfillmentOrder. integer bigint(20)
nazwa Domyślnie: NULL Nazwa zamówienia wygenerowana poprzez połączenie właściwości order_number z prefiksem i sufiksem zamówienia, które są zdefiniowane w ustawieniach ogólnych sprzedawcy. Różni się ona od właściwości ID, która jest identyfikatorem zamówienia używanym przez API. To pole może zostać również ustawione przez API na dowolną wartość ciągu znaków. ciąg znaków varchar(255)
uwaga Domyślnie: NULL Opcjonalna notatka, którą właściciel sklepu może dołączyć do zamówienia. ciąg znaków
note_attributes Domyślnie: NULL Dodatkowe informacje, które są dodawane do zamówienia. Pojawiają się w sekcji Dodatkowe szczegóły na stronie danych zamówienia. Każdy wpis tablicy musi zawierać skrót z kluczami nazwy i wartości. ciąg znaków
number Domyślnie: NULL Pozycja zamówienia w liczbie zamówień sklepu. Numery są sekwencyjne i rozpoczynają się od 1. integer int(11) tylko do odczytu
order_number Pozycja zamówienia w liczbie zamówień sklepu od 1001. Numery zamówień są sekwencyjne. integer bigint(20) tylko do odczytu
order_status_url Adres URL wskazujący stronę internetową ze statusem zamówienia, jeśli dotyczy. ciąg znaków varchar(255) tylko do odczytu
original_total_duties_set Pierwotna suma opłat celnych naliczonych od zamówienia w walucie sklepu i walucie prezentacji. object tylko do odczytu
payment_gateway_names Domyślnie: NULL Lista bramek płatniczych używanych na potrzeby zamówienia.
varchar(255) tylko do odczytu
payment_terms Domyślnie: NULL Zasady i warunki, na podstawie których powinna być przetwarzana płatność. object bigint(20) tylko do odczytu
telefon Domyślnie: NULL Numer telefonu klienta do otrzymywania powiadomień SMS. ciąg znaków varchar(255)
presentment_currency Domyślnie: NULL Waluta prezentacji, która została użyta do wyświetlenia cen klientowi. ciąg znaków (3)
processed_at Domyślnie: NULL Data i godzina (format ISO 8601) przetworzenia zamówienia. Ta wartość jest datą, która pojawia się w Twoich zamówieniach i jest używana w raportach analitycznych. Jeśli importujesz zamówienia z aplikacji lub innej platformy, możesz ustawić właściwość processed_at na datę i godzinę z przeszłości, aby dopasować ją do daty utworzenia oryginalnego zamówienia. date datetime(6)
processing_method
  • realizacja zakupu
  • bezpośredni
  • ręczne
  • offsite
  • express
  • gratis
Sposób przetworzenia płatności ciąg znaków varchar(255) tylko do odczytu
referring_site Domyślnie: NULL Strona internetowa, na której klient kliknął link do sklepu. ciąg znaków varchar(4096)
zwroty Lista zwrotów kosztów dokonanych w przypadku zamówienia array tylko do odczytu
shipping_address Domyślnie: NULL Adres pocztowy, na który zostanie wysłane zamówienie. Adres ten jest opcjonalny i nie będzie dostępny w przypadku zamówień, które nie wymagają wysyłki integer bigint(20)
shipping_lines Tablica obiektów, z których każdy zawiera informacje o zastosowanej metodzie wysyłki. array
Source_name Domyślnie: NULL Wskazuje miejsce pochodzenia zamówienia. Może zostać ustawiona tylko podczas tworzenia zamówienia i nie można jej później zapisać. Wartości dla kanałów Shopify są chronione i nie mogą zostać przypisane przez innych klientów API: web, pos, shopify_draft_order, iphone i android. Zamówieniom utworzonym za pośrednictwem interfejsu API można przypisać dowolny inny ciąg znaków. Jeśli nie zostanie on określony, nowym zamówieniom przypisywana będzie wartość ID Twojej aplikacji. ciąg znaków varchar(255)
subtotal_price Cena zamówienia w walucie sklepu po zastosowaniu rabatów, ale przed naliczeniem kosztów wysyłki, ceł, podatków i napiwków. integer bigint(20)
subtotal_price_set Suma częściowa zamówienia w walucie sklepu i walucie prezentacji po zastosowaniu rabatów, ale przed naliczeniem kosztów wysyłki, ceł, podatków i napiwków. object
tagi Tagi dołączone do zamówienia, sformatowane jako ciąg wartości oddzielonych przecinkami. Tagi to dodatkowe krótkie deskryptory, powszechnie używane do filtrowania i wyszukiwania. Długość każdego tagu jest ograniczona do 40 znaków. ciąg znaków varchar(4096)
tax_lines Tablica obiektów linii podatkowych, z których każdy zawiera szczegóły podatku, któremu podlega zamówienie. Każdy obiekt ma następujące właściwości:

Podczas tworzenia zamówienia za pośrednictwem API linie podatkowe mogą zostać zawarte w zamówieniu lub w pozycjach, ale nie w obu tych miejscach. Linie podatkowe określone w zamówieniu są podzielone na pozycje podlegające opodatkowaniu w utworzonym zamówieniu.
array
taxes_included
  • prawda
  • fałsz
Domyślnie: 0
Wskazuje, czy podatki są uwzględnione w sumie częściowej zamówienia. boolean tinyint(1)
test
  • prawda
  • fałsz
Domyślnie: 0
Wskazuje, czy jest to zamówienie testowe. boolean tinyint(1) tylko do odczytu
token Domyślnie: NULL Unikalna wartość przy odwoływaniu się do zamówienia. ciąg znaków varchar(32) tylko do odczytu
total_discounts Domyślnie: 0 Suma rabatów zastosowanych do ceny zamówienia w walucie sklepu. ciąg znaków decimal(21,3)
total_discounts_set Suma rabatów zastosowanych do ceny zamówienia w walucie sklepu i w walucie prezentacji. object
total_line_items_price Domyślnie: 0 Suma wszystkich cen pozycji w walucie sklepu. ciąg znaków decimal(21,3)
total_line_items_price_set Suma wszystkich cen pozycji w walucie sklepu i walucie prezentacji. object
total_outstanding Domyślnie: 0 Całkowita pozostała kwota do zapłaty za zamówienie w walucie sklepu. ciąg znaków decimal(21,3)
total_price Domyślnie: 0 Suma cen wszystkich pozycji, rabatów, kosztów wysyłki, podatków i napiwków w walucie sklepu. Musi być dodatnia. ciąg znaków decimal(21,3)
total_price_set Łączna cena zamówienia w walucie sklepu i w walucie prezentacji. object
total_shipping_price_set Całkowita cena wysyłki zamówienia, z wyłączeniem rabatów i zwrotów, w walucie sklepu i w walucie prezentacji. Jeśli wartość taxes_included to true, wówczas właściwość total_shipping_price_set zawiera podatki. object
total_tax Domyślnie: 0 Suma wszystkich podatków naliczonych w zamówieniu w walucie sklepu. Musi być dodatnia. ciąg znaków decimal(21,3)
total_tax_set Całkowity podatek naliczony w zamówieniu w walucie sklepu i w walucie prezentacji. object
total_tip_received Suma wszystkich napiwków w zamówieniu w walucie sklepu. integer bigint(20) tylko do odczytu
total_weight Domyślnie: 0 Suma wag wszystkich pozycji w gramach. Suma ta nie jest korygowana po usunięciu pozycji z zamówienia. integer bigint(20) unsigned
updated_at Data i godzina (w formacie ISO 8601) ostatniej modyfikacji zamówienia. date datetime(6) tylko do odczytu
user_id Domyślnie: NULL ID użytkownika zalogowanego do Shopify POS, który przetworzył zamówienie, jeśli dotyczy. integer bigint(20)

Product : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu Product interfejsu API panelu administracyjnego REST.

Dane dotyczące istotnych właściwości zasobu Product REST
Właściwość Wartości Opis Typ danych Długość pola Dostęp do pola Wymagane pole krytyczne
body_html Domyślnie: NULL Opis produktu. Obsługuje formatowanie HTML. ciąg znaków mediumtext
created_at Domyślnie: NULL Data i godzina (w formacie ISO 8601) utworzenia produktu. date datetime tylko do odczytu
handle Domyślnie: NULL ciąg znaków varchar(255)
id Domyślnie: NULL Niepodpisana 64-bitowa liczba całkowita, która jest używana jako unikalny identyfikator produktu. Każdy ID jest unikalny w całym systemie Shopify. Żadne dwa produkty nie mają takiego samego identyfikatora, nawet jeśli pochodzą z różnych sklepów. integer bigint(20) tylko do odczytu Y
zdjęcia Lista obiektów obrazów produktów, z których każdy reprezentuje obraz powiązany z produktem. [{ product_image }]
opcje Niestandardowe właściwości produktu, np. rozmiar, kolor i materiał. Każdy produkt może mieć maksymalnie 3 opcje, a wartość każdej opcji może mieć maksymalnie 255 znaków. Warianty produktu składają się z kombinacji wartości opcji. Opcji nie można utworzyć bez wartości. Aby utworzyć nowe opcje, należy również utworzyć wariant z powiązaną wartością opcji. array
product_type Domyślnie: NULL Kategoryzacja produktu używanego do filtrowania i wyszukiwania produktów. ciąg znaków varchar(255)
published_at Domyślnie: NULL Data i godzina (format ISO 8601) publikacji produktu. Można ustawić wartość null, aby cofnąć publikację produktu z kanału Sklep online. date datetime
published_scope
  • web
  • global
Wskazuje, czy produkt jest opublikowany w kanale Punkt sprzedaży. ciąg znaków
status
  • aktywne
  • zarchiwizowane
  • wersja robocza
Domyślnie: aktywne
Status produktu. ciąg znaków varchar(32)
tagi Ciąg tagów oddzielonych przecinkami, które są używane do filtrowania i wyszukiwania. Produkt może mieć maksymalnie 250 tagów. Każdy tag może mieć maksymalnie 255 znaków. ciąg znaków
template_suffix Domyślnie: NULL Sufiks szablonu Liquid używanego na potrzeby strony produktu. Jeśli ta właściwość jest określona, wówczas strona produktu używa szablonu o nazwie "product.suffix.liquid", gdzie "suffix" jest wartością tej właściwości. Jeśli ta właściwość ma wartość "" lub null, wówczas strona produktu używa domyślnego szablonu "product.liquid". ciąg znaków varchar(255)
title Domyślnie: NULL Nazwa produktu ciąg znaków varchar(255)
updated_at Domyślnie: NULL Data i godzina (format ISO 8601) ostatniej modyfikacji produktu. Wartość updated_at produktu może się zmienić z różnych powodów. Na przykład w przypadku złożenia zamówienia na produkt, który ma ustawione śledzenie zapasów, korekta zapasów jest traktowana jako aktualizacja. date datetime tylko do odczytu
warianty Tablica wariantów produktu, z których każdy reprezentuje inną wersję produktu. Właściwość „position” jest dostępna tylko w trybie do odczytu. Pozycja wariantów jest określana przez kolejność, w jakiej są one wymienione na liście. array
dostawca Domyślnie: NULL Nazwa dostawcy produktu. ciąg znaków varchar(255)

ProductImage : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu API panelu administracyjnego REST ProductImage. Dla tego zasobu nie ma wymaganych pól tylko do odczytu ani pól krytycznych.

Dane dotyczące istotnych właściwości związanych z zasobem ProductVariant REST
Właściwość Wartości Opis Typ danych Długość pola
created_at Domyślnie: NULL Data i godzina utworzenia obrazu. Interfejs API zwraca tę wartość w formacie ISO 8601. date datetime
height Domyślnie: NULL Wysokość obrazu określona podczas przesyłania. smallint(4) unsigned
id Domyślnie: NULL Unikalny numeryczny identyfikator obrazu produktu. (auto_increment) integer bigint(20)
position Domyślnie: 0 Kolejność obrazu produktu na liście. Pierwszy obraz produktu znajduje się na pozycji 1 i jest „głównym” obrazem produktu. smallint(5) unsigned
product_id Domyślnie: NULL ID produktu powiązanego z obrazem. bigint(20)
src Określa lokalizację obrazu produktu. Ten parametr obsługuje filtry URL, których można używać do pobierania zmodyfikowanych kopii obrazu. Przykład: dodaj _small do nazwy pliku, aby pobrać skalowaną kopię obrazu o rozdzielczości 100 x 100 px (np. ipod-nano_small.png), lub dodaj _2048x2048, aby pobrać kopię obrazu o rozdzielczości 2048 x 2048 px (np. ipod-nano_2048x2048.png).
updated_at Domyślnie: NULL Data i godzina ostatniej modyfikacji obrazu produktu. API zwraca tę wartość w formacie ISO 8601. date datetime
variant_ids Tablica identyfikatorów wariantów powiązanych z obrazem.
width Domyślnie: NULL Szerokość obrazu określona podczas przesyłania. smallint(4) unsigned

ProductVariant : właściwości zasobu

W poniższej tabeli przedstawiono przydatne informacje o właściwościach zasobu ProductVariant interfejsu API panelu administracyjnego REST. Dla tego zasobu nie ma wymaganych pól krytycznych.

Dane dotyczące istotnych właściwości związanych z zasobem ProductVariant REST
Właściwość Wartości Opis Typ danych Długość pola Dostęp do pola
kod kreskowy Domyślnie: NULL Kod kreskowy, UPC lub numer ISBN dla produktu. varchar(255)
compare_at_price Domyślnie: NULL Oryginalna cena pozycji przed korektą lub sprzedażą. decimal(20,2)
created_at Domyślnie: NULL Data i godzina (w formacie ISO 8601) utworzenia wariantu produktu. date datetime
fulfillment_service
  • ręczne
  • { handle of fulfillment service }
Domyślnie: manual
Usługa realizacji powiązana z wariantem produktu. varchar(255)
gramy Waga wariantu produktu w gramach.
id Domyślnie: NULL Unikalny numeryczny identyfikator wariantu produktu. Wartość ta jest automatycznie zwiększana. bigint(20)
image_id Domyślnie: NULL Unikalny numeryczny identyfikator obrazu produktu. Obraz musi być powiązany z tym samym produktem, co wariant. bigint(20)
inventory_item_id Unikalny identyfikator pozycji zapasów, który jest używany w interfejsie API zapasów do wysyłania zapytań o informacje dotyczące zapasów.
inventory_management
  • shopify
  • null
  • { handle of fulfillment service }
  • Domyślnie: NULL
    Usługa realizacji, która śledzi liczbę pozycji w magazynie dla wariantu produktu. varchar(255)
    inventory_policy
    • deny
    • continue
    Domyślnie: deny
    Czy klienci mogą zamawiać wariant produktu, gdy nie ma go na stanie. varchar(40)
    inventory_quantity Domyślnie: 1 Suma zapasów we wszystkich lokalizacjach. Aby dostosować status zapasów w konkretnej lokalizacji, należy użyć zasobu InventoryLevel. int(11) tylko do odczytu
    option Właściwości niestandardowe, których właściciel sklepu używa do definiowania wariantów produktów. Można zdefiniować trzy opcje dla wariantu produktu: option1, option2, option3. Wartość domyślna: Default Title. Pole tytułu jest konkatenacją pól option1, option2 i option3. Aktualizacja pól opcji powoduje aktualizację pola tytułu.
    position Domyślnie: 0 Kolejność wariantów produktu na liście wariantów produktu. Pierwszą pozycją na liście jest 1. Pozycję wariantów określa kolejność ich występowania na liście. smallint(5) unsigned tylko do odczytu
    presentment_prices Lista cen prezentacji wariantu i cen do porównania w każdej z walut prezentacji włączonych w sklepie. Każdy obiekt typu cena posiada następujące właściwości:
    -currency_code: Trzyliterowy kod (format ISO 4217) dla jednej z walut prezentacji włączonych w sklepie.
    -amount: Cena wariantu lub cena do porównania w walucie prezentacji.
    Wymaga nagłówka 'X-Shopify-API-Features': 'include-presentment-prices'.
    tylko do odczytu
    price Domyślnie: 0 Cena wariantu produktu. decimal(20,2)
    product_id Domyślnie: NULL Unikalny identyfikator numeryczny dla produktu. bigint(20)
    requires_shipping Domyślnie: 1 Ta właściwość jest nieaktualna. Użyj właściwości 'requires_shipping' w zasobie InventoryItem. boolean tinyint(1)
    sku Unikalny identyfikator wariantu produktu w sklepie. Wymagany do połączenia z FulfillmentService. varchar(255)
    tax_code Ten parametr dotyczy tylko sklepów, które mają zainstalowaną aplikację Avalara AvaTax. Określa kod podatku Avalara dla wariantu produktu.
    podlegające opodatkowaniu Domyślnie: 1 Czy podczas sprzedaży wariantu produktu naliczany jest podatek. boolean tinyint(1)
    title Tytuł wariantu produktu. Pole tytułu jest konkatenacją pól option1, option2 i option3. Możesz aktualizować tytuł tylko pośrednio, używając pól opcji. varchar(255) tylko do odczytu
    updated_at Domyślnie: NULL Data i godzina ostatniej modyfikacji wariantu produktu. Zwracana w formacie ISO 8601. date datetime
    weight Waga wariantu produktu w układzie jednostek określonym za pomocą właściwości weight_unit.
    weight_unit
    • g
    • kg
    • oz
    • lb
    Domyślnie: NULL
    Jednostka miary, którą stosuje się do wagi wariantu produktu. Jeśli nie określisz wartości dla weight_unit, zastosowana zostanie domyślna jednostka miary używana w sklepie. varchar(2)