ストア移行のデータディクショナリ
このページはMar 23, 2023に印刷されています。最新のバージョンについては、https://help.shopify.com/ja/partners/building-stores-for-merchants/data-dictionaryをご覧ください。
ストア移行のデータディクショナリには、REST Admin API Customer
、Order
、Product
のリソースに関する情報が含まれます。経験豊富なパートナーは、ストアをShopifyに移行する際、データディクショナリを補足参照資料として使用します。
Customer
リソースのプロパティ
以下の表には、REST Admin API Customer
リソースのプロパティに関する役立つ情報が列挙されています。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ | フィールドへのアクセス | 重要必須フィールド |
---|---|---|---|---|---|---|
accepts_marketing | Default: 0 | マーケティング資料の受領に関するお客様の同意の有無。 | Boolean | tinyint(1) | Y | |
accepts_marketing_ updated_at |
お客様がマーケティング資料をメールで受信することに同意した、あるいはそれを拒否した日時 (ISO 8601フォーマット)。 | Datetime | 住所 | お客様に関連付けられた住所のリスト。 | [{ Address }] | |
currency | お客様が最後の注文の支払いに使用した通貨の3文字コード (ISO 4217フォーマット)。 | String | ショップの通貨 | 読み取り専用 | ||
created_at | Default: NULL | お客様がストアに追加された日時 (ISO 8601フォーマット)。 | Datetime | datetime | 読み取り専用 | |
default_address | お客様のデフォルトの住所。 | { Address } | ||||
Default: NULL | お客様固有のメールアドレスです。 | String | varchar(255) | |||
名 | Default: NULL | お客様の名前 | String | varchar(255) | ||
id | Default: NULL | グローバル一意識別子 (この値は自動でインクリメントされます)。 | Integer | bigint(20) | Y | |
姓 | Default: NULL | お客様の氏名 | String | varchar(255) | ||
last_order_id | Default: NULL | お客様が直近で行った注文のID。 | Integer | bigint(20) | 読み取り専用 | |
last_order_name | Default: NULL | お客様が直近で行った注文の名前です。 | String | 読み取り専用 | ||
メタフィールド | Default: NULL | リソースに属するネームスペースとキーでメタフィールドを返します。 | { Metafield } | |||
marketing_opt_ in_level |
|
お客様がマーケティング資料をメールで受領することに同意した際に提示した、マーケティングサブスクリプションオプトインレベル (M3AAWGベストプラクティスガイドラインに記載)。 | String, enum | |||
multipass_identifier | Default: NULL | マルチパスログインで使用する、お客様の固有ID。 | String | varchar(255) | ||
note | Default: NULL | お客様に関するメモ。 | String | mediumtext | ||
orders_count | Default: 0 | これまでにお客様がストアで行った注文の数。 | Integer | int(11) | 読み取り専用 | |
電話番号 | Default: NULL | このお客様の一意 (ストア全体) の電話番号 (E.164フォーマット)。 | String | varchar(255) | ||
sms_marketing_ consent |
Default: NULL | お客様の電話番号に現在設定されているSMSマーケティングのステータス。 | String | |||
state |
|
ショップにおけるお客様のアカウントのステータス。 | String, enum | varchar(255) | 読み取り専用 | |
tags | Default: NULL | お客様に追加された最大250個のタグのカンマ区切りリスト | String | タグごとに255 | ||
tax_exempt | Default: 0 | お客様の注文に対する免除の可否 | Boolean | tinyint(1) | Y | |
tax_exemptions | すべての値のリストについては、お客様リソースを参照してください。 | お客様に適用される免税のリスト。 | String | |||
total_spent | Default: 0 | お客様がこれまでに注文で支払った金額の合計。ストア通貨で表示されます。複数通貨を使用している場合、金額は為替レートなしのデフォルトの通貨で表示されます。 | Number | decimal(21,3) | 読み取り専用 | |
updated_at | お客様が最後に更新された日時。ショップのタイムゾーンに基づきます。 | Datetime | datetime | 読み取り専用 | ||
verified_email | デフォルト: 1 | お客様がメールアドレスを確認したかどうか。お客様が管理画面またはAPIを通じて作成された場合、デフォルトはtrueです。 | Boolean | tinyint(1) | 読み取り専用 |
CustomerAddress
リソースのプロパティ
以下の表には、REST Admin API CustomerAddress
リソースのプロパティに関する役立つ情報が列挙されています。このリソースには、重要必須フィールドはありません。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ | フィールドへのアクセス |
---|---|---|---|---|---|
番地 | Default: NULL | お客様の郵送先住所。お客様アカウントごとに100。 | String | varchar(255) | |
address2 | Default: NULL | お客様の郵送先住所の追加フィールド。 | String | varchar(255) | |
city | Default: NULL | お客様の都市、町、または村。 | String | varchar(255) | |
company | Default: NULL | お客様の会社。 | String | varchar(255) | |
国 | Default: NULL | 顧客の国 | String | varchar(255) | |
名 | Default: NULL | お客様の名前 | String | varchar(255) | |
country_code | お客様の国に対応する2文字の国コード。 | String | 読み取り専用 | ||
country_name | お客様の国の標準名。 | String | |||
姓 | Default: NULL | お客様の氏名 | String | varchar(255) | |
name | お客様の氏名。 | String | |||
電話番号 | Default: NULL | この住所でのお客様の電話番号。 | String | varchar(255) | |
province | Default: NULL | お客様の地域名。通常、州、または都道府県です。 | String | varchar(255) | |
province_code | お客様の地域の2文字コード。 | String | 読み取り専用 | ||
zip | Default: NULL | お客様の郵便番号 (zip、postcode、Eircodesともいう) | String | varchar(255) |
Order
リソースのプロパティ
以下の表には、REST Admin API Order
リソースのプロパティに関する役立つ情報が列挙されています。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ | フィールドへのアクセス | 重要必須フィールド |
---|---|---|---|---|---|---|
app_id | Default: NULL | 注文を作成したアプリのID。 | 整数 | bigint(20) | 読み取り専用 | |
billing_address | Default: NULL | 決済方法に関連付けられた郵送先住所。この住所は、決済方法を必要としない注文では表示されないオプションフィールドです。 | 整数 | bigint(20) | ||
browser_ip | お客様が注文を行った際に使用したブラウザのIPアドレス。IPv4とIPv6の両方がサポートされています。 | 文字列 | varchar(255) | 読み取り専用 | ||
buyer_accepts_marketing | Default: 0 | お客様がショップから最新情報をメールで受領することに同意したかどうか。 | ブーリアン | tinyint(1) | ||
cancel_reason |
|
注文がキャンセルされた理由 | 文字列 | varchar(255) | ||
cancelled_at | Default: NULL | 注文がキャンセルされた日時。注文がキャンセルされていない場合、nullを返します。 | date | datetime | 読み取り専用 | |
cart_token | Default: NULL | 注文に関連付けられたカートを参照する際の固有の値。 | 文字列 | varchar(255) | 読み取り専用 | |
checkout_token | Default: NULL | 注文に関連付けられたチェックアウトを参照する際の固有の値。 | 文字列 | varchar(64) | 読み取り専用 | |
client_details |
|
お客様が注文を行った際に使用したブラウザに関する情報: accept_language: ブラウザが認識している言語とロケール。 browser_height: ブラウザの画面の高さ (ピクセル) (利用可能な場合)。 browser_ip: ブラウザのIPアドレス。 browser_width: ブラウザ画面の幅 (ピクセル) (利用可能な場合)。 session_hash: セッションのハッシュ。 user_agent: ソフトウェアおよびオペレーティングバージョンを含む閲覧しているクライアントの詳細。 |
オブジェクト | 読み取り専用 | ||
closed_at | Default: NULL | 注文が終了した日時 (ISO 8601フォーマット)。注文が終了していない場合、nullを返します。 | date | datetime | 読み取り専用 | |
created_at | Default: NULL | Shopifyで注文が作成された時の自動生成日時 (ISO 8601フォーマット)。このプロパティの値は変更できません。 | date | datetime(6) | 読み取り専用 | |
currency | Default: NULL | ショップ通貨の3文字コード (ISO 4217フォーマット)。 | 文字列 | char(3) | ||
current_subtotal_price | ショップの通貨による、注文価格の現在の小計。このフィールドの値には、注文の編集、返品、返金が反映されます。 | 文字列 | varchar(255) | 読み取り専用 | ||
current_subtotal_price_set | ショップの通貨と表示通貨による、注文価格の現在の小計。このフィールドに関連付けられた金額の値には、注文の編集、返品、返金が反映されます。 | オブジェクト | 読み取り専用 | |||
current_total_discounts | ショップの通貨による、注文に適用されたディスカウントの現在の合計。このフィールドの値には、注文の編集、返品、返金が反映されます。 | 文字列 | varchar(255) | 読み取り専用 | ||
current_total_discounts_set | ショップの通貨と表示通貨による、注文に適用されたディスカウントの現在の合計。このフィールドに関連付けられた金額の値には、注文の編集、返品、返金が反映されます。 | オブジェクト | 読み取り専用 | |||
current_total_duties_set | ショップの通貨、および表示通貨による、注文に適用された関税の現在の合計。このフィールドに関連付けられた金額の値には、注文の編集、返品、返金が反映されます。 | オブジェクト | 読み取り専用 | |||
current_total_price | ショップの通貨による、注文価格の現在の合計。このフィールドの値には、注文の編集、返品、返金が反映されます。 | 文字列 | varchar(255) | 読み取り専用 | ||
current_total_price_set | ショップの通貨、および表示通貨による、注文価格の現在の合計。このフィールドに関連付けられた金額値には、注文の編集、返品、返金が反映されます。 | オブジェクト | 読み取り専用 | |||
current_total_tax | ショップの通貨による、注文に適用された税金の現在の合計。このフィールドの値には、注文の編集、返品、または返金が反映されます。 | 文字列 | varchar(255) | 読み取り専用 | ||
current_total_tax_set | ショップの通貨と表示通貨による、注文に適用された税金の現在の合計。このフィールドに関連付けられた金額の値には、注文の編集、返品、返金が反映されます。 | オブジェクト | 読み取り専用 | |||
customer | Default: NULL | お客様に関する情報。注文にお客様が存在しない場合があるため、アプリはお客様オブジェクトの存在によって左右されない設定にする必要があります。Shopify POSで注文が作成された場合、この値はnullになる可能性があります。 | 整数 | bigint(20) | ||
customer_locale | Default: NULL | 2文字または3文字の言語コード (必要に応じて地域修飾子が続く)。 | 文字列 | varchar(255) | 読み取り専用 | |
discount_applications | 複数のディスカウントアプリケーションの順序付きリスト。 discount_applicationsプロパティには、discount_code、手動、スクリプトの3つのタイプが含まれます。これら3つのタイプの構造は同じですが、タイプ固有の属性があります。 |
配列 | 読み取り専用 | |||
discount_codes | 注文に適用されるディスカウントのリスト。 | 配列 | ||||
お客様のメールアドレス。 | varchar(255) | |||||
estimated_taxes | 注文の税金が想定額かどうか。お客様が注文を行った時点から注文が発送されるまでには多くの要素が変化し、これによって税金の計算が変わることがあります。注文にかかる税金が確定し、変更の対象ではなくなったときに、このプロパティの戻り値はfalseになります。 | ブーリアン | tinyint(1) | |||
financial_status |
|
注文に関連付けられた決済のステータス。注文が作成された場合にのみ設定できます。 | 文字列 | varchar(255) | 読み取り専用 | |
fulfillment_status |
|
フルフィルメントされた項目に関する注文のステータス。 | 文字列 | varchar(255) | ||
フルフィルメント | 注文に関連付けられたフルフィルメントの配列 | 配列 | ||||
id | Default: NULL | API目的で使用される注文のID。これは、order_numberプロパティ (ショップオーナーおよびお客様が使用するID) とは異なります。 | 整数 | bigint(20) | 読み取り専用 | |
landing_site | Default: NULL | 購入者がショップを訪問する際のランディングページのURL。 | 文字列 | varchar(4096) | 読み取り専用 | |
line_items | 注文内のアイテムに関する情報を含む項目オブジェクトのリスト | 配列 | Y | |||
location_id | Default: NULL | 注文が処理された物理的なロケーションのID。注文に対してロケーションを参照する必要がある場合は、FulfillmentOrderリソースを使用します。 | 整数 | bigint(20) | ||
name | Default: NULL | order_numberプロパティと、マーチャントの一般設定で設定された注文のプリフィックスおよびサフィックスを組み合わせて生成された注文名。これは、APIが使用する注文のIDであるidプロパティとは異なります。このフィールドは、APIを使用して文字列の値に設定することもできます。 | 文字列 | varchar(255) | ||
note | Default: NULL | ショップオーナーが注文に添付できるオプションのメモです。 | 文字列 | |||
note_attributes | Default: NULL | 注文に追加される追加情報。注文詳細ページの [追加の詳細] セクションに表示されます。入力される各配列には、名前キーと値キー付きのハッシュを含める必要があります。 | 文字列 | |||
number | Default: NULL | ショップの注文カウントにおける注文の順番。番号は1から始まる連続した数字です。 | 整数 | int(11) | 読み取り専用 | |
order_number | ショップの注文カウントにおける注文の順番。注文番号は1001から始まる連続した数字です。 | 整数 | bigint(20) | 読み取り専用 | ||
order_status_url | 注文状況ウェブページを指すURL (該当する場合)。 | 文字列 | varchar(255) | 読み取り専用 | ||
original_total_duties_set | ショップの通貨と表示通貨による、注文に適用された関税の当初の合計。 | オブジェクト | 読み取り専用 | |||
payment_gateway_names | Default: NULL | 注文に使用される決済ゲートウェイサービスのリスト。 |
varchar(255) | 読み取り専用 | ||
payment_terms | Default: NULL | 決済の処理に適用される利用規約。 | オブジェクト | bigint(20) | 読み取り専用 | |
電話番号 | Default: NULL | SMS通知を受け取るためのお客様の電話番号。 | 文字列 | varchar(255) | ||
presentment_currency | Default: NULL | お客様に価格を表示するために使用された表示通貨。 | 文字列 | char(3) | ||
processed_at | Default: NULL | 注文が処理された日時 (ISO 8601フォーマット)。この値は、注文に表示される日付で、分析レポートで使用されます。アプリまたはその他のプラットフォームから注文をインポートする場合、元の注文が作成された時点と一致させるため、processed_atを過去の日時に設定することができます。 | date | datetime(6) | ||
processing_method |
|
決済の処理方法 | 文字列 | varchar(255) | 読み取り専用 | |
referring_site | Default: NULL | お客様がショップへのリンクをクリックしたウェブサイト。 | 文字列 | varchar(4096) | ||
返金 | 注文に適用された返金のリスト | 配列 | 読み取り専用 | |||
shipping_address | Default: NULL | 注文が配送される郵送先住所。この住所はオプションで、配送を必要としない注文では表示されません。 | 整数 | bigint(20) | ||
shipping_lines | オブジェクトの配列。それぞれで、使用される配送方法の詳細が説明されています。 | 配列 | ||||
source_name | Default: NULL | 注文の発行元。注文の作成時にのみ設定可能で、その後は書き込みできません。Shopifyチャネルの値は保護され、他のAPIクライアント (ウェブ、POS、shopify_draft_order、iPhone、およびAndroid) から割り当てることはできません。APIを通して作成された注文には、他の任意の文字列を割り当てることができます。指定しない場合、新しい注文にはアプリIDの値が割り当てられます。 | 文字列 | varchar(255) | ||
subtotal_price | ショップ通貨での注文の価格。ディスカウントを適用しますが、配送料、関税、税金、チップは含めません。 | 整数 | bigint(20) | |||
subtotal_price_set | ショップ通貨と表示通貨での注文の小計。ディスカウントを適用しますが、配送料、関税、税金、チップは含めません。 | オブジェクト | ||||
tags | カンマで区切られた値の文字列での形式で表示される、注文に付けられたタグ。タグとは、一般に絞り込みや検索に使用される短い追加表記です。各タグの文字制限は40文字です。 | 文字列 | varchar(4096) | |||
tax_lines | 税金欄オブジェクトの配列。それぞれで注文に適用される税金の詳細が説明されます。各オブジェクトには以下のプロパティがあります。 APIを通して注文を作成する場合、税金欄は注文と項目の両方で指定できますが、両方で指定することはできません。注文で指定される税金欄は、作成された注文の課税対象の項目全体に分割されます。 |
配列 | ||||
taxes_included |
|
注文の小計に税金が含まれているかどうか。 | ブーリアン | tinyint(1) | ||
test |
|
これがテスト注文かどうか。 | ブーリアン | tinyint(1) | 読み取り専用 | |
token | Default: NULL | 注文を参照する際の固有の値。 | 文字列 | varchar(32) | 読み取り専用 | |
total_discounts | Default: 0 | ショップ通貨による、注文の価格に適用されるディスカウントの合計。 | 文字列 | decimal(21,3) | ||
total_discounts_set | ショップ通貨と表示通貨による、注文の価格に適用されるディスカウントの合計。 | オブジェクト | ||||
total_line_items_price | Default: 0 | ショップ通貨による、全項目の価格の合計。 | 文字列 | decimal(21,3) | ||
total_line_items_price_set | ショップ通貨と表示通貨による、全項目の価格の合計。 | オブジェクト | ||||
total_outstanding | Default: 0 | ショップ通貨による、注文の未払い金額の合計。 | 文字列 | decimal(21,3) | ||
total_price | Default: 0 | ショップ通貨による、全項目の価格、ディスカウント、配送料、税金、チップの合計。正数でなければなりません。 | 文字列 | decimal(21,3) | ||
total_price_set | ショップ通貨と表示通貨による、注文価格の合計。 | オブジェクト | ||||
total_shipping_price_set | ショップ通貨と表示通貨による、注文の配送価格の合計。ディスカウントや返品を除きます。taxes_includedがtrueに設定されている場合、total_shipping_price_setには税金が含まれます。 | オブジェクト | ||||
total_tax | Default: 0 | ショップ通貨による、注文に適用されるすべての税金の合計。正数でなければなりません。 | 文字列 | decimal(21,3) | ||
total_tax_set | ショップ通貨、および表示通貨による、注文に適用される税金の合計。 | オブジェクト | ||||
total_tip_received | ショップ通貨による、注文内のすべてのチップの合計。 | 整数 | bigint(20) | 読み取り専用 | ||
total_weight | Default: 0 | 全項目の重量の合計 (グラム単位)。アイテムが注文から削除されても合計は調整されません。 | 整数 | bigint(20) unsigned | ||
updated_at | 注文が最後に修正された日時 (ISO 8601フォーマット)。 | date | datetime(6) | 読み取り専用 | ||
user_id | Default: NULL | Shopify POSにログインして注文を処理するユーザーのID (該当する場合)。 | 整数 | bigint(20) |
Product
リソースのプロパティ
以下の表には、REST Admin API Product
リソースのプロパティに関する役立つ情報が列挙されています。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ | フィールドへのアクセス | 重要必須フィールド |
---|---|---|---|---|---|---|
body_html | Default: NULL | 商品の説明。HTMLフォーマットに対応しています。 | 文字列 | mediumtext | ||
created_at | Default: NULL | 商品が作成された日時 (ISO 8601フォーマット)。 | date | datetime | 読み取り専用 | |
handle | Default: NULL | 文字列 | varchar(255) | |||
id | Default: NULL | 商品の固有IDとして使用される64ビットの符号なし整数です。各IDはShopifyシステム全体で固有のものです。2つの商品が (異なるショップで販売される場合でも) 同一のIDを持つことはありません。 | 整数 | bigint(20) | 読み取り専用 | Y |
画像 | 商品画像オブジェクトのリスト。それぞれは商品に関連付けられた画像を表しています。 | [{ product_image }] | ||||
オプション | カスタム商品プロパティ。サイズ、色、材料など。各商品には最大3つのオプションを設定でき、各オプション値には最大255文字まで使用できます。商品バリエーションは、オプション値の組み合わせで作られたものです。値なしでオプションを作成することはできません。新しいオプションを作成するには、関連するオプション値を持つバリエーションも作成する必要があります。 | 配列 | ||||
product_type | Default: NULL | 商品の絞り込みと検索に使用される商品の分類。 | 文字列 | varchar(255) | ||
published_at | Default: NULL | 商品が公開された日時 (ISO 8601フォーマット)。nullに設定して、オンラインストアチャネルで商品を非公開にすることができます。 | date | datetime | ||
published_scope |
|
商品がPOSチャネルに公開されるかどうか。 | 文字列 | |||
ステータス |
|
商品のステータス。 | 文字列 | varchar(32) | ||
tags | カンマで区切られたタグの文字列。絞り込みと検索に使用されます。商品には最大250個のタグを含めることができます。各タグには最大255文字までを含めることができます。 | 文字列 | ||||
template_suffix | Default: NULL | 商品ページで使用される、Liquidテンプレートのサフィックス。このプロパティを指定すると、商品ページでは"product.suffix.liquid"というテンプレートが使用されます。"suffix"がこのプロパティの値です。このプロパティが "" またはnullの場合、商品ページにはデフォルトのテンプレート"product.liquid"が使用されます。 | 文字列 | varchar(255) | ||
title | Default: NULL | 商品の名前 | 文字列 | varchar(255) | ||
updated_at | Default: NULL | 商品が最後に変更された日時 (ISO 8601フォーマット)。商品のupdated_atの値は、さまざまな理由で変更されます。たとえば、在庫追跡が設定されている商品の注文が行なわれた場合、在庫調整による更新がカウントされます。 | date | datetime | 読み取り専用 | |
バリエーション | 商品バリエーションの配列。それぞれが商品のさまざまなバージョンを表しています。順番プロパティは、読み取り専用です。バリエーションの順番はそのバリエーションが表示されている順序で決まります。 | 配列 | ||||
vendor | Default: NULL | 商品の販売元の名前。 | 文字列 | varchar(255) |
ProductImage
リソースのプロパティ
以下の表には、REST Admin API ProductImage
リソースのプロパティに関する役立つ情報が列挙されています。このリソースの読み取り専用または重要必須フィールドはありません。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ |
---|---|---|---|---|
created_at | Default: NULL | 商品画像が作成された日時。APIはこの値をISO 8601フォーマットで返します。 | date | datetime |
height | Default: NULL | アップロード時に決定される画像の高さ寸法。 | smallint(4) unsigned | |
id | Default: NULL | 商品画像の固有数値ID (auto_increment) | 整数 | bigint(20) |
position | Default: 0 | リスト内の商品画像の順序。最初の商品画像の順番は1で、商品の「メイン」画像となります。 | smallint(5) unsigned | |
商品_id | Default: NULL | 画像に関連付けられた商品のID。 | bigint(20) | |
src | 商品画像の位置を指定します。このパラメーターは、修正済みの画像コピーを取得する際に使用できるURLフィルターをサポートしています。例えば、ファイル名に_smallを追加して、100 x 100ピクセルに縮尺された画像コピーを取得したり (ipod-nano_small.pngなど)、_2048x2048を追加して2048 x 2048ピクセルの解像度に限定された画像コピーを取得したりすることができます (ipod-nano_2048x2048.pngなど)。 | |||
updated_at | Default: NULL | 商品画像が最後に修正された日時。APIはこの値をISO 8601フォーマットで返します。 | date | datetime |
variant_ids | 画像に関連付けられたバリエーションIDの配列。 | |||
width | Default: NULL | アップロード時に決定される画像の幅の寸法。 | smallint(4) unsigned |
ProductVariant
リソースのプロパティ
以下の表には、REST Admin API ProductVariant
リソースのプロパティに関する役立つ情報が列挙されています。このリソースには、重要必須フィールドはありません。
プロパティ | 数値 | 説明 | データ型 | フィールドの長さ | フィールドへのアクセス |
---|---|---|---|---|---|
バーコード | Default: NULL | 商品のバーコード、UPC、またはISBNの番号。 | varchar(255) | ||
compare_at_price | Default: NULL | 調整前またはセール前のアイテムの元の価格。 | decimal(20,2) | ||
created_at | Default: NULL | 商品バリエーションが作成された日時 (ISO 8601フォーマット)。 | date | datetime | |
fulfillment_service |
|
商品バリエーションに関連付けられたフルフィルメントサービス。 | varchar(255) | ||
グラム | グラム単位での商品バリエーションの重量。 | ||||
id | Default: NULL | 商品バリエーションの固有数値ID。この値は自動でインクリメントされます。 | bigint(20) | ||
image_id | Default: NULL | 商品画像の固有数値ID。画像はバリエーションと同じ商品に関連付けられている必要があります。 | bigint(20) | ||
inventory_item_id | 在庫情報のクエリのために在庫APIで使用される、在庫アイテムの固有ID。 | ||||
inventory_management |
|
商品バリエーションの在庫アイテム数を追跡するフルフィルメントサービス。 | varchar(255) | ||
inventory_policy |
|
商品バリエーションが在庫切れでも、お客様が注文できるかどうか。 | varchar(40) | ||
inventory_quantity | デフォルト: 1 | すべてのロケーションの在庫の総合計。特定のロケーションの在庫を調整するには、InventoryLevelリソースを使用します。 | int(11) | 読み取り専用 | |
option | ショップオーナーが商品バリエーションを定義するために使用するカスタムプロパティです。商品バリエーションには、option1、option2、option3の3つのオプションを定義できます。デフォルト値: Default Title。タイトルフィールドは、option1、option2、option3のフィールドの連結です。オプションフィールドを更新すると、タイトルフィールドが更新されます。 | ||||
position | Default: 0 | 商品バリエーションのリストにある商品バリエーションの順序。リストの最初は1です。バリエーションの順番は、リストに表示された順序で決まります。 | smallint(5) unsigned | 読み取り専用 | |
presentment_prices | ショップで有効になっている各表示通貨での、バリエーションの表示価格と割引前価格のリストです。各価格オブジェクトには、以下のプロパティがあります。 ⁻currency_code: ショップで有効になっている表示通貨の1つの3文字コード (ISO 4217フォーマット)。 -amount: 表示価格での、バリエーションの価格または割引前価格 'X-Shopify-Api-Features'のヘッダーが必要: 'include-presentment-prices'。 |
読み取り専用 | |||
price | Default: 0 | 商品バリエーションの価格 | decimal(20,2) | ||
商品_id | Default: NULL | 商品の固有数値ID | bigint(20) | ||
requires_shipping | デフォルト: 1 | このプロパティは非推奨です。代わりに、inventoryItemリソースの「requires_shipping」プロパティを使用します。 | ブーリアン | tinyint(1) | |
sku | ショップの商品バリエーションの固有ID。FulfillmentServiceに接続するために必要です。 | varchar(255) | |||
tax_code | このパラメーターは、Avalara AvaTaxアプリがインストールされているストアにのみ適用されます。商品バリエーションのAvalara税コードを指定します。 | ||||
課税対象 | デフォルト: 1 | 商品バリエーションが売れたときに課税するかどうか。 | ブーリアン | tinyint(1) | |
title | 商品バリエーションのタイトル。タイトルフィールドは、option1、option2、option3のフィールドの連結です。オプションフィールドを使用して間接的にタイトルを更新することができます。 | varchar(255) | 読み取り専用 | ||
updated_at | Default: NULL | 商品バリエーションが最後に修正された日時。ISO 8601フォーマットで返されます。 | date | datetime | |
重量 | weight_unitで指定された単位方式での商品バリエーションの重量。 | ||||
weight_unit |
|
商品バリエーションの重量に適用される測定単位。weight_unitの値を指定しない場合、ショップのデフォルトの測定単位が適用されます。 | varchar(2) |