BigCommerce (プレビュー)
BigCommerce は柔軟で、オープンな SaaS プラットフォームです。 BigCommerce に接続して、注文、製品、および関連情報を取得できます。
このコネクタは、次の製品および地域で利用可能です:
Service | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Microsoft Dynamics |
[URL] | https://aka.ms/iomsupport |
メール | iomdri@microsoft.com |
Connector Metadata | |
---|---|
発行者 | マイクロソフト |
Web サイト | https://www.bigcommerce.com/ |
プライバシー ポリシー | https://www.bigcommerce.com/privacy/ |
カテゴリー | 生産性 |
このコネクタは、Dynamics 365 Intelligent Order Management の BigCommerce プロバイダー統合で使用するために特別に開発されています。
BigCommerce 開発者アカウントとテスト ストアが必要です。 お持ちでない場合は、https://developer.bigcommerce.com/ で作成できます。注: このコネクタは、特に Dynamics 365 Intelligent Order Management BigCommerce プロバイダーを設定するために使用することをお勧めします。
BigCommerce には認証用の API トークンが必要です。 API トークン https://store-XYZ.mybigcommerce.com/manage/settings/auth/api-accounts を生成し、それを使用してコネクタを構成できます。 注: XYZ はストアのハッシュ コードです。
API トークンを使用した接続を設定します。 BigCommerce の API については、https://developer.bigcommerce.com/api-docs の公開ドキュメントを参照してください
API レート制限の詳細については、https://developer.bigcommerce.com/api-docs/getting-started/best-practices#api-rate-limits のドキュメント トピックを、プラットフォーム制限の詳細については、https://developer.bigcommerce.com/api-docs/getting-started/best-practices#platform-limits のドキュメント トピックを参照してください
このコネクタは、Dynamics 365 Intelligent Order Management の BigCommerce プロバイダー統合で使用するために特別に開発されています。 Dynamics 365 Intelligent Order Management 以外のユースケースのサポートは制限されます。
このコネクタは、次の認証タイプをサポートしています。
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
件名 | タイプ | 内容 | 必要 |
---|---|---|---|
API キー | securestring | この API の API キー | True |
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
すべての顧客を取得 |
顧客の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。 |
受注の発送先住所を取得する |
受注 ID を使用して、受注の配送先住所をすべて取得します。 |
受注を 1 件取得する |
受注 ID を使用して受注を取得します。 |
受注を更新する |
受注 の更新。 受注の作成または更新の詳細については、受注の概要 をご覧ください。 |
明細行の受注製品 |
受注 ID を使用して、受注が含む受注製品をすべて一覧で表示します。 |
注文をすべて取得する |
フィルター クエリで注文をすべて取得します。 |
製品の取得 |
製品 一覧を返します。 オプションのフィルター パラメーターを渡すことができます。 |
製品を ID で取得する |
単一の 製品 を返します。 オプションのパラメーターを渡すことができます。 |
製品を更新する |
製品 を更新します。 読み取り専用フィールド
|
顧客の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
ページあたりの項目数です。
|
limit | number |
ページごとの項目カウント。 |
|
項目を ID でフィルター処理します。
|
id:in | array |
項目を ID でフィルター処理します。
|
|
項目を customer_group_id でフィルター処理します。
|
customer_group_id:in | array |
項目を customer_group_id でフィルター処理します。 |
|
項目を date_modified でフィルター処理します。
|
date_modified | date-time |
項目を date_modified でフィルター処理します。 |
|
項目を date_modified の最小値でフィルター処理します。
|
date_modified:min | string |
項目を date_modified の最小値でフィルター処理します。 |
|
項目を date_modified の最大値でフィルター処理します。
|
date_modified:max | date-time |
項目を date_modified |
|
顧客のサブリソースを含めるかどうかを示します。
|
include | string |
顧客のサブリソースを含めるかどうかを示します。
|
|
項目を並べ替えます。
|
sort | string |
date_created、date_modified、または last_name で項目を並べ替えます:* |
戻り値
- 顧客のコレクションの応答
- CustomerCollectionResponse
受注 ID を使用して、受注の配送先住所をすべて取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
Order ID
|
order_id | True | string |
受注の ID です。 |
ぺージ
|
page | number |
応答に入れて返すページです。 |
|
Limit
|
limit | number |
返される結果の数です。 |
戻り値
応答で返された注文発送住所。
受注 ID を使用して受注を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
Order ID
|
order_id | True | string |
受注の ID です。 |
戻り値
応答で返される注文オブジェクトです。
- order_Resp
- order_Resp
受注 の更新。 受注の作成または更新の詳細については、受注の概要 をご覧ください。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
order_id
|
order_id | True | integer |
受注の ID |
|
object |
戻り値
応答で返される注文オブジェクトです。
- order_Resp
- order_Resp
受注 ID を使用して、受注が含む受注製品をすべて一覧で表示します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
Order ID
|
order_id | True | string |
受注の ID です。 |
ぺージ
|
page | number |
応答に入れて返すページです。 |
|
Limit
|
limit | number |
返される結果の数です。 |
戻り値
応答で返された注文製品。
フィルター クエリで注文をすべて取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
最小 ID
|
min_id | integer |
最小受注 ID です。 |
|
最大受注 ID
|
max_id | integer |
最大受注 ID です。 |
|
最小合計
|
min_total | number |
浮動形式の最小受注の合計です。 |
|
最大合計
|
max_total | number |
浮動形式の最大受注の合計です。 |
|
Customer ID
|
customer_id | integer |
受注の顧客 ID です。 |
|
メール
|
string |
顧客の電子メールです。 |
||
状態 ID
|
status_id | integer |
受注の状態 ID。 |
|
カート ID
|
cart_id | string |
受注のカート ID です。 |
|
支払方法
|
payment_method | string |
受注で使用される支払方法です。 |
|
作成された最短日付
|
min_date_created | string |
RFC-2822 または ISO-8601 で注文が作成された最小日付。 RFC-2822: 2017 年 4 月 20 日、木曜日 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00。 |
|
作成の最長日付
|
max_date_created | string |
RFC-2822 または ISO-8601 で注文が作成された最大日付。 RFC-2822: 2017 年 4 月 20 日、木曜日 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00。 |
|
変更の最短日付
|
min_date_modified | string |
RFC-2822 または ISO-8601 で注文が変更された最小日付。 RFC-2822: 2017 年 4 月 20 日、木曜日 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00。 |
|
変更の最長日付
|
max_date_modified | string |
RFC-2822 または ISO-8601 で注文が変更された最大日付。 RFC-2822: 2017 年 4 月 20 日、木曜日 11:32:00 -0400 ISO-8601: 2017-04-20T11:32:00.000-04:00。 |
|
ぺージ
|
page | number |
応答に入れて返すページです。 |
|
Limit
|
limit | number |
返される結果の数です。 |
|
並び替え
|
sort | string |
順序を並べ替えるフィールドと方向です。 方向を指定するには、クエリ パラメータの末尾に「asc」または「desc」を追加します。 E.g. sort=date_created:desc。 |
|
Is Deleted
|
is_deleted | boolean |
受注が削除またはアーカイブされた場合。 |
|
Channel ID
|
channel_id | boolean |
受注のチャネル ID です。 |
戻り値
応答で返される受注の一覧です。
- アイテム
- orderCollection_Resp
製品 一覧を返します。 オプションのフィルター パラメーターを渡すことができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
Id
|
id | integer |
ID で項目をフィルターします。 |
|
名称
|
name | string |
名前で項目をフィルターします。 |
|
UPC
|
upc | string |
UPC で項目をフィルターします。 |
|
price
|
price | double |
価格で項目をフィルターします。 |
|
重量
|
weight | double |
重量で項目をフィルターします。 |
|
条件
|
condition | string |
条件で項目をフィルターします。 |
|
brand_id
|
brand_id | integer |
品目をブランドIDでフィルター処理します。 |
|
date_modified
|
date_modified | date-time |
|
|
date_modified:max
|
date_modified:max | string |
|
|
date_modified:min
|
date_modified:min | string |
|
|
date_last_imported
|
date_last_imported | date-time |
date_last_imported で項目をフィルターします。 |
|
date_last_imported:max
|
date_last_imported:max | string |
date_last_imported で項目をフィルターします。 たとえば、 |
|
date_last_imported:min
|
date_last_imported:min | string |
date_last_imported で項目をフィルターします。 たとえば、 |
|
is_visible
|
is_visible | boolean |
現在製品を店頭に表示しているかどうかに基づいて項目をフィルターします。 |
|
is_featured
|
is_featured | string |
is_featured で項目をフィルター処理します。 true の場合 |
|
is_free_shipping
|
is_free_shipping | integer |
is_free_shipping で項目をフィルターします。 |
|
inventory_level
|
inventory_level | integer |
inventory_level で項目をフィルターします。 |
|
inventory_level:in
|
inventory_level:in | integer |
在庫レベル |
|
inventory_level:not_in
|
inventory_level:not_in | integer |
在庫レベル: なし |
|
inventory_level:min
|
inventory_level:min | integer |
在庫レベル: 最少 |
|
inventory_level:max
|
inventory_level:max | integer |
在庫レベル: 最多 |
|
inventory_level:greater
|
inventory_level:greater | integer |
在庫レベル: 多い |
|
inventory_level:less
|
inventory_level:less | integer |
在庫レベル: 少ない |
|
inventory_low
|
inventory_low | integer |
inventory_low で項目をフィルター処理します。 値: 1、0。 |
|
out_of_stock
|
out_of_stock | integer |
out_of_stock で項目をフィルター処理します。 フィルター処理を有効にするには、 |
|
total_sold
|
total_sold | integer |
total_sold で項目をフィルターします。 |
|
タイプ
|
type | string |
種類で項目をフィルターします。 |
|
categories
|
categories | integer |
カテゴリで項目をフィルター処理します。
製品が複数のカテゴリに含まれる場合、このクエリを使用しても製品は返されません。 代わりに、 |
|
keyword
|
keyword | string |
|
|
keyword_context
|
keyword_context | string |
指定されたグループを対象とした結果を返すために検索アルゴリズムで使用されるコンテキストを設定します。 |
|
ステータス
|
status | integer |
状態で項目をフィルターします。 |
|
含む
|
include | string |
製品に含めるサブリソース (カンマ区切りリスト)。 |
|
include_fields
|
include_fields | string |
含めるフィールドのコンマ区切りリスト。 ID と指定されたフィールドが返されます。 |
|
exclude_fields
|
exclude_fields | string |
除外するフィールドのコンマ区切りリスト。 指定されたフィールドは応答から除外されます。 ID を除外できません。 |
|
空き時間
|
availability | string |
空き時間で項目をフィルター処理します。 値は、空き時間、無効、予約注文です。 |
|
page
|
page | integer |
商品の限定した (ページ分割した) リストのページ番号を指定します。 |
|
制限
|
limit | integer |
商品の限定した (ページ分割した) リストの、ページごとの項目数を制御します。 |
|
direction
|
direction | string |
ソート方向。 許容される値は、 |
|
並べ替え
|
sort | string |
並び替えるフィールド名。 メモ: 新しい製品を追加すると |
|
categories:in
|
categories:in | integer |
カテゴリで項目をフィルター処理します。 複数のカテゴリの製品に使用します。 たとえば、 |
戻り値
- ProductCollectionResponse
- ProductCollectionResponse
単一の 製品 を返します。 オプションのパラメーターを渡すことができます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
製品 ID
|
product_id | True | integer |
リソースが属する |
含む
|
include | string |
製品に含めるサブリソース (カンマ区切りリスト)。 |
|
include_fields
|
include_fields | string |
含めるフィールドのコンマ区切りリスト。 ID と指定されたフィールドが返されます。 |
|
exclude_fields
|
exclude_fields | string |
除外するフィールドのコンマ区切りリスト。 指定されたフィールドは応答から除外されます。 ID を除外できません。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
product_Full
|
data | product_Full | |
Meta
|
meta | object |
空のメタ オブジェクト。後で使用できます。 |
製品 を更新します。
読み取り専用フィールド
- id
- date_created
- date_modified
- calculated_price
- base_variant_id
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ストア ハッシュ
|
store_hash | True | string |
ストア ハッシュ コード。 |
製品 ID
|
product_id | True | integer |
リソースが属する |
|
object | |||
フィールドを含める
|
include_fields | string |
含めるフィールドのコンマ区切りリスト。 ID と指定されたフィールドが返されます。 |
戻り値
- ProductResponse
- ProductResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
first_name
|
first_name | string |
顧客の住所の名です。 |
姓
|
last_name | string |
顧客の住所の姓です。 |
会社名
|
company | string |
顧客の会社の住所です。 |
address1
|
address1 | string |
住所の 1 行目です。 |
address2
|
address2 | string |
住所の 2 行目です。 |
市
|
city | string |
顧客の住所の市区町村です。 |
state_or_province
|
state_or_province | string |
都道府県または群の名前 |
postal_code
|
postal_code | string |
顧客の住所の郵便番号です。 |
country_code
|
country_code | string |
顧客の住所の国番号です。 |
電話番号
|
phone | string |
顧客の住所の電話番号です。 |
住所の種類
|
address_type | string |
住所の種類。 住宅用または商業用 |
customer_id
|
customer_id | integer |
顧客 ID です。 |
id
|
id | integer |
住所を表す一意の数値 ID です。 |
国
|
country | string |
顧客の住所の国名です。 |
複雑な規則を調整する機能です。
名前 | パス | 型 | 説明 |
---|---|---|---|
調整機能
|
adjuster | Adjuster |
店舗で修飾子の値を選択するときの、バリアントの価格または重量に対する調整機能の種類。 |
adjuster_value
|
adjuster_value | double |
変更者の値が店頭で選択されている場合に、調整者が変更するバリアントの価格または重量の数値です。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
adjuster_Full
|
price | adjuster_Full |
複雑な規則を調整する機能です。 |
adjuster_Full
|
weight | adjuster_Full |
複雑な規則を調整する機能です。 |
image_url
|
image_url | string |
変更者の値が選択されている場合に、店頭に表示される画像の URL です。ファイルごとに 8 MB の制限があります。 |
PurchasingDisabled
|
purchasing_disabled | PurchasingDisabled |
名前 | パス | 型 | 説明 |
---|---|---|---|
attribute_id
|
attribute_id | integer |
属性 ID |
attribute_value
|
attribute_value | string |
属性値 |
customer_id
|
customer_id | integer |
Customer ID |
date_created
|
date_created | date-time |
顧客の属性が作成された日付 |
date_modified
|
date_modified | date-time |
顧客の属性が変更された日付 |
id
|
id | integer |
属性値 ID |
すべての要求と応答に共通の請求先住所プロパティです。
名前 | パス | 型 | 説明 |
---|---|---|---|
first_name
|
first_name | string | |
姓
|
last_name | string | |
会社名
|
company | string | |
street_1
|
street_1 | string |
番地 (1 行目)。 |
street_2
|
street_2 | string |
番地 (2 行目)。 |
市
|
city | string | |
州
|
state | string | |
郵便番号
|
zip | string |
請求先住所には郵便番号を含める必要があります。 郵便番号は 2 文字以上である必要があります。 |
国
|
country | string | |
country_iso2
|
country_iso2 | string |
国を表す 2 文字の ISO Alpha-2 コード。 |
電話番号
|
phone | string |
受信者の電話番号。 |
メールアドレス
|
string |
受信者のメール アドレス。 |
受注を作成するために必要です。
名前 | パス | 型 | 説明 |
---|---|---|---|
billingAddress_Base
|
billingAddress | billingAddress_Base |
すべての要求と応答に共通の請求先住所プロパティです。 |
form_fields
|
form_fields | array of formFields |
共通の一括価格設定規則プロパティ
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
一括価格設定ルール を表す一意の ID です。 読み取り専用。 |
quantity_min
|
quantity_min | integer |
このルールを満たす製品の最小数量。 ゼロ以上である必要があります。 POST は必須です。 |
quantity_max
|
quantity_max | integer |
このルールを満たす製品の最大数量。 |
タイプ
|
type | string |
実行している調整の種類。 値: |
amount
|
amount | integer |
値引きは、固定ドル額または固定ドル率です。 固定ドル額の場合は、整数として入力すると、応答が整数として返されます。 パーセンテージの場合は、文字列形式を使用してパーセンテージを 100 で割った金額を入力します。 たとえば、10% は ".10" になります。 応答は整数として返されます。 POST は必須です。 |
オプション構成の値は、作成した修飾子によって異なります。
名前 | パス | 型 | 説明 |
---|---|---|---|
default_value
|
default_value | string |
(日付、テキスト、multi_line_text、numbers_only_text) 既定値。 日付オプションでは ISO-8601 形式の文字列として、またはテキスト オプションでは文字列として表示されます。 |
checked_by_default
|
checked_by_default | boolean |
(チェックボックス) 既定でオンにするチェック ボックスを設定するフラグです。 |
checkbox_label
|
checkbox_label | string |
(チェックボックス) チェックボックス オプションに表示されるラベルです。 |
date_limited
|
date_limited | boolean |
(日付) 日付オプションに入力できる日付を制限するフラグです。 |
date_limit_mode
|
date_limit_mode | string |
(日付) 日付オプションへの入力制限の種類です。 |
date_earliest_value
|
date_earliest_value | date |
(日付) 日付オプションに ISO-8601 形式の文字列で入力できる最も早い日付です。 |
date_latest_value
|
date_latest_value | date |
(日付) 日付オプションに ISO-8601 形式の文字列で入力できる最も遅い日付です。 |
file_types_mode
|
file_types_mode | string |
(ファイル) ファイル アップロード オプションでアップロードできるファイル タイプの制限の種類。 値: |
file_types_supported
|
file_types_supported | array of string |
(ファイル) |
file_types_other
|
file_types_other | array of string |
(ファイル) ファイルのアップロード オプションで選択できる他のファイルの種類の一覧です。 |
file_max_size
|
file_max_size | integer |
(ファイル) ファイルのアップロード オプションで使用できるファイルの最大サイズです。 これもサーバーによって制限されます。 |
text_characters_limited
|
text_characters_limited | boolean |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキストへの入力の長さを検証するフラグです。 |
text_min_length
|
text_min_length | integer |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキスト オプションに入力できる最小長です。 |
text_max_length
|
text_max_length | integer |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキスト オプションに入力できる最大長です。 |
text_lines_limited
|
text_lines_limited | boolean |
(複数行テキスト) 複数行テキストに入力できる行の最大数を検証するフラグです。 |
text_max_lines
|
text_max_lines | integer |
(複数行テキスト) 複数行テキストに入力できる行の最大数です。 |
number_limited
|
number_limited | boolean |
(数値のみテキスト) 数値オプションの値を制限するフラグです。 |
number_limit_mode
|
number_limit_mode | string |
(数値のみテキスト) 数値オプションへの入力値に関する制限の種類です。 |
number_lowest_value
|
number_lowest_value | double |
(数値のみテキスト) |
number_highest_value
|
number_highest_value | double |
(数値のみテキスト) |
number_integers_only
|
number_integers_only | boolean |
(数値のみテキスト) 数値オプションへの入力を整数のみに制限するフラグです。 |
product_list_adjusts_inventory
|
product_list_adjusts_inventory | boolean |
(製品リスト、製品リスト画像あり) 一覧に含まれる製品の在庫を自動的に調整するためのフラグです。 |
product_list_adjusts_pricing
|
product_list_adjusts_pricing | boolean |
(製品リスト、製品リスト画像あり) オプション製品の価格をメイン製品の価格に追加するフラグです。 |
product_list_shipping_calc
|
product_list_shipping_calc | string |
(product_list、product_list_with_images) オプションの製品の重量とパッケージの寸法を配送見積もりに組み込む方法。 値: |
名前 | パス | 型 | 説明 |
---|---|---|---|
url
|
url | string |
API 要求のクーポンの URL |
resource
|
resource | string |
クーポンのリソース |
名前 | パス | 型 | 説明 |
---|---|---|---|
メールアドレス
|
string |
顧客の電子メールです。 一意である必要があります。 |
|
first_name
|
first_name | string |
顧客の名です。 |
姓
|
last_name | string |
顧客の姓です。 |
会社名
|
company | string |
顧客の会社です。 |
電話番号
|
phone | string |
顧客の電話番号。 |
registration_ip_address
|
registration_ip_address | string |
この顧客が登録された IP アドレスです。 |
メモ
|
notes | string |
顧客のメモです。 |
tax_exempt_category
|
tax_exempt_category | string |
顧客の非課税カテゴリ コードです。 |
customer_group_id
|
customer_group_id | integer |
この顧客が属するグループの ID です。 |
id
|
id | integer |
顧客を表す一意の数値 ID です。 |
date_modified
|
date_modified | date-time |
顧客が変更された日付です。 |
date_created
|
date_created | date-time |
顧客が作成された日付です。 |
address_count
|
address_count | integer |
顧客の住所の総数です。 |
attribute_count
|
attribute_count | integer |
顧客の属性の総数です。 |
force_password_reset
|
authentication.force_password_reset | boolean |
|
addresses
|
addresses | array of address_Full |
顧客アドレスの配列。 10 に制限。 |
attributes
|
attributes | array of attribute_Full |
顧客属性の配列。 10 に制限。 |
store_credit_amounts
|
store_credit_amounts | CustomerStoredCreditAmounts |
クレジットを保存します。 |
accepts_product_review_abandoned_cart_emails
|
accepts_product_review_abandoned_cart_emails | boolean |
顧客がサインアップして製品レビューを受信したか、カート破棄の電子メールを受信したか、またはその両方を受信したかを特定します。 |
customerChannelIds
|
channel_ids | customerChannelIds |
顧客がアクセス権を持つチャネル ID の配列です。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of customer_Full |
顧客がアクセス権を持つチャネル ID の配列です。
名前 | パス | 型 | 説明 |
---|---|---|---|
アイテム
|
integer |
クレジットを保存します。
名前 | パス | 型 | 説明 |
---|---|---|---|
amount
|
amount | float |
店頭の製品のカスタム URL です。
名前 | パス | 型 | 説明 |
---|---|---|---|
url
|
url | string |
店舗の製品 URL。 |
is_customized
|
is_customized | boolean |
URL が既定の状態 (BigCommerce が提供する自動割り当て URL) から変更されている場合は |
読み取り専用。 必須の住所フォーム フィールドがある場合は、API 経由で受注を作成する前に、それらをオプションに設定する必要があります。
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string |
読み取り専用。 必須の住所フォーム フィールドがある場合は、API 経由で受注を作成する前に、それらをオプションに設定する必要があります。 |
価値
|
value | string |
読み取り専用。 必須の住所フォーム フィールドがある場合は、API 経由で受注を作成する前に、それらをオプションに設定する必要があります。 |
ページ割り付けは、コレクション全体に対して前後の部分をリンクします。
名前 | パス | 型 | 説明 |
---|---|---|---|
前へ
|
previous | string |
応答で返された前のページへのリンク。 |
現在
|
current | string |
応答で返された現在のページへのリンク。 |
次
|
next | string |
応答で返された次のページへのリンク。 |
改ページやコレクション合計など、応答に関するデータです。
名前 | パス | 型 | 説明 |
---|---|---|---|
pagination_Full
|
pagination | pagination_Full |
改ページやコレクション合計など、応答に関するデータです。 |
応答で返される注文オブジェクトです。
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
読み取り専用。 受注の ID。 |
date_modified
|
date_modified | string |
注文の最終変更を表す読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 RFC-2822 |
date_shipped
|
date_shipped | string |
出荷日を表す読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 RFC-2822 |
cart_id
|
cart_id | string |
該当する場合、この注文の元となったカート ID。 カート API と関連付けられます。 これは読み取り専用フィールドです。POST または PUT 要求でその値を設定または変更しないでください。 |
ステータス
|
status | string |
状態には、[注文状態] で定義された (文字列、オプション) の値の 1 つが含まれます。 この値は読み取り専用です。 POST または PUT 操作でこの値を設定または変更しないでください。 |
subtotal_tax
|
subtotal_tax | string |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (Float、Float-As-String、Integer) |
shipping_cost_tax
|
shipping_cost_tax | string |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (Float、Float-As-String、Integer) |
Shipping_cost_tax_class_id
|
shipping_cost_tax_class_id | integer |
Shipping-cost tax class。 読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (注: ストアで自動税が有効になっている場合、値は無視されます。) |
handling_cost_tax
|
handling_cost_tax | string |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (Float、Float-As-String、Integer) |
handling_cost_tax_class_id
|
handling_cost_tax_class_id | integer |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (注: ストアで自動税が有効になっている場合、値は無視されます。) |
wrapping_cost_tax
|
wrapping_cost_tax | string |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (Float、Float-As-String、Integer) |
wrapping_cost_tax_class_id
|
wrapping_cost_tax_class_id | integer |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (注: ストアで自動税が有効になっている場合、値は無視されます。) |
PaymentStatus
|
payment_status | PaymentStatus |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 |
store_credit_amount
|
store_credit_amount | string |
買い物客がこの個別の注文で引き換えたストア クレジットを表します。 これは読み取り専用の値です。 POST または PUT を渡さないでください。 (Float、Float-As-String、Integer) |
gift_certificate_amount
|
gift_certificate_amount | string |
読み取り専用の値。 POST または PUT を渡さないでください。 (Float、Float-As-String、Integer) |
currency_id
|
currency_id | integer |
通貨 ID の表示。 取引通貨とは異なる場合があります。 読み取り専用の値。 POST または PUT を渡さないでください。 |
currency_code
|
currency_code | string |
店頭での価格の表示に使用される表示通貨の通貨コードです。 読み取り専用の値。 POST または PUT を渡さないでください。 |
currency_exchange_rate
|
currency_exchange_rate | string |
ストアの既定の通貨および表示通貨間の為替レート。 読み取り専用の値。 POST または PUT を渡さないでください。 (Float、Float-As-String、Integer) |
default_currency_id
|
default_currency_id | integer |
取引通貨 ID。 読み取り専用の値。 POST または PUT を渡さないでください。 |
coupon_discount
|
coupon_discount | string |
読み取り専用の値。 POST または PUT を渡さないでください。 (Float、Float-As-String、Integer) |
shipping_address_count
|
shipping_address_count | double |
この取引に関連付けられている配送先住所。 読み取り専用の値。 POST または PUT を渡さないでください。 |
is_email_opt_in
|
is_email_opt_in | boolean |
電子メールを受信するために、買い物客がオプトインのチェック ボックスを (チェックアウト ページで) オンにしたかどうかを示します。 読み取り専用の値。 POST または PUT を渡さないでください。 |
order_source
|
order_source | string |
ストアの Web サイト経由で送信された注文には、 |
products_Resource
|
products | products_Resource | |
shippingAddress_Resource
|
shipping_addresses | shippingAddress_Resource | |
coupons_Resource
|
coupons | coupons_Resource | |
status_id
|
status_id | integer |
受注の状態 ID。 |
base_handling_cost
|
base_handling_cost | string |
取り扱い基本手数料の値。 (Float、Float-As-String、Integer) |
base_shipping_cost
|
base_shipping_cost | string |
基本配送料の値。 (Float、Float-As-String、Integer) |
base_wrapping_cost
|
base_wrapping_cost | string |
基本梱包費の値。 (Float、Float-As-String、Integer) |
billingAddress_Full
|
billing_address | billingAddress_Full |
受注を作成するために必要です。 |
channel_id
|
channel_id | integer |
注文の発生元を表示します。 channel_id の既定値は 1 です。 |
customer_id
|
customer_id | double | |
customer_message
|
customer_message | string |
チェックアウト中に顧客が |
date_created
|
date_created | string |
この注文を作成した日付。 指定しない場合、既定の現在時刻が使用されます。 日付は、RFC 2822 形式である必要があります。 |
default_currency_code
|
default_currency_code | string |
買い物客が支払いを行うトランザクション通貨の通貨コードです。複数通貨が有効であれば書き込みが可能です。 |
discount_amount
|
discount_amount | string |
このトランザクションの割引金額。 (Float、Float-As-String、Integer) |
ebay_order_id
|
ebay_order_id | string |
受注が eBay を通じて作成された場合は、eBay 受注番号が含まれます。 それ以外の場合、この値は |
external_id
|
external_id | string |
他のシステムでの受注 ID。 たとえば、Amazon での注文の場合は、Amazon 受注 ID です。このフィールドは /POST で更新できますが、/PUT を使用して注文を更新すると 400 エラーが返されます。 フィールド "external_id" に書き込むことができません。 再試行する前に要求から削除してください。 一度設定すると上書きすることはできません。 |
external_source
|
external_source | string |
PUT または POST 操作を使用し、API を介して受注を送信または変更する際に、受注の生成に使用されるシステムを識別する値をオプションで渡すことができます。 例: |
geoip_country
|
geoip_country | string |
顧客が IP ベースで購入を行った国のフル ネームです。 |
geoip_country_iso2
|
geoip_country_iso2 | string |
顧客が ISO2 形式で、IP ベースで購入を行った国です。 |
handling_cost_ex_tax
|
handling_cost_ex_tax | string |
取り扱い手数料の値 (税抜き)。 (Float、Float-As-String、Integer) |
handling_cost_inc_tax
|
handling_cost_inc_tax | string |
取り扱い手数料の値 (税込み)。 (Float、Float-As-String、Integer) |
ip_address
|
ip_address | string |
顧客の IP アドレスです (既知の場合)。 |
is_deleted
|
is_deleted | boolean |
注文が削除されたかどうかを示します (アーカイブ)。 注文をアーカイブするには、true に設定します。 |
items_shipped
|
items_shipped | double |
発送された品目の数です。 |
items_total
|
items_total | double |
受注に含まれる品目の合計数です。 |
order_is_digital
|
order_is_digital | boolean |
これがデジタル製品の受注であるかどうかを示します。 |
PaymentMethod
|
payment_method | PaymentMethod |
この受注で使用される支払方法です。 |
payment_provider_id
|
payment_provider_id | string |
外部トランザクション ID、またはこの受注の支払プロバイダーの支払 ID (支払プロバイダーが使用された場合) です。 |
refunded_amount
|
refunded_amount | string |
このトランザクションで返金された金額。 (Float、Float-As-String、Integer) |
shipping_cost_ex_tax
|
shipping_cost_ex_tax | string |
配送料の値 (税抜き)。 (Float、Float-As-String、Integer) |
shipping_cost_inc_tax
|
shipping_cost_inc_tax | string |
配送料の値 (税込み)。 (Float、Float-As-String、Integer) |
staff_notes
|
staff_notes | string |
スタッフのための追加のメモです。 |
subtotal_ex_tax
|
subtotal_ex_tax | string |
税抜きの小計の値を上書きします。 指定した場合、フィールド |
subtotal_inc_tax
|
subtotal_inc_tax | string |
税込みの小計の値を上書きします。 指定した場合、フィールド |
TaxProviderId
|
tax_provider_id | TaxProviderId |
BasicTaxProvider - 税金は手動に設定されています。 AvaTaxProvider - これは、税金プロバイダーが自動に設定されており、注文が API によって作成されなかった場合に使用されます。 Avalara に使用されます。 "" (空白) - 税プロバイダーが不明な場合。 これには、従来の注文と、以前に API 経由で作成された注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。 |
customer_locale
|
customer_locale | string |
顧客のロケール |
total_ex_tax
|
total_ex_tax | string |
税抜きの合計の値を上書きします。 指定した場合、フィールド |
total_inc_tax
|
total_inc_tax | string |
税込みの合計の値を上書きします。 指定した場合、フィールド |
wrapping_cost_ex_tax
|
wrapping_cost_ex_tax | string |
梱包費の値 (税抜き)。 (Float、Float-As-String、Integer) |
wrapping_cost_inc_tax
|
wrapping_cost_inc_tax | string |
梱包費の値 (税込み)。 (Float、Float-As-String、Integer) |
応答で返される受注の一覧です。
名前 | パス | 型 | 説明 |
---|---|---|---|
order_Resp
|
order_Resp |
応答で返される注文オブジェクトです。 |
応答で返された注文製品。
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
この受注が含む、この製品の数値 ID。 |
order_id
|
order_id | integer |
関連付けられた受注の数値 ID。 |
product_id
|
product_id | integer |
製品の数値 ID。 |
order_address_id
|
order_address_id | integer |
受注の住所に関連付けられた数値 ID です。 |
名称
|
name | string |
name_customer の別名 - 店舗で顧客に表示する製品名。 |
sku
|
sku | string |
ユーザー定義の製品コード/在庫管理単位 (SKU)。 |
タイプ
|
type | string |
製品の種類。 |
base_price
|
base_price | string |
製品の基本価格。 (Float、Float-As-String、Integer)。 |
price_ex_tax
|
price_ex_tax | string |
製品の価格は税抜きです。 (Float、Float-As-String、Integer)。 |
price_inc_tax
|
price_inc_tax | string |
製品の価格は税込みです。 (Float、Float-As-String、Integer)。 |
price_tax
|
price_tax | string |
単一の製品に適用される税額。 価格税の計算方法: 'price_tax = price_inc_tax - price_ex_tax' (Float、Float-As-String、Integer)。 |
base_total
|
base_total | string |
合計基本価格。 (Float、Float-As-String、Integer)。 |
total_ex_tax
|
total_ex_tax | string |
税抜きの合計基本価格です。 (Float、Float-As-String、Integer)。 |
total_inc_tax
|
total_inc_tax | string |
税込みの合計基本価格です。 (Float、Float-As-String、Integer)。 |
total_tax
|
total_tax | string |
製品に適用される税金の合計。 たとえば、数量が 2 の場合、基本価格は 5、税率は 10% になります。 Price_tax は USD0.50、total_tax は USD1.00 になります。 手動割引が適用されている場合、total_tax は次のように計算されます。'(price_ex_tax -discount)*tax_rate=total_tax' (Float、Float-As-String、Integer)。 |
quantity
|
quantity | number |
受注済み製品の数量。 |
base_cost_price
|
base_cost_price | string |
製品の原価価格。 これはカタログ API を使用して設定できます。 (Float、Float-As-String、Integer) 読み取り専用。 |
cost_price_inc_tax
|
cost_price_inc_tax | string |
製品の原価価格は税込みです。 (Float、Float-As-String、Integer)。自社に対する製品コストです。顧客には表示されず、会計処理の目的で使用します。 読み取り専用。 |
cost_price_ex_tax
|
cost_price_ex_tax | string |
製品の原価価格は税抜きです。 (Float、Float-As-String、Integer)。自社に対する製品コストです。顧客には表示されず、会計処理の目的で使用します。 読み取り専用。 |
重量
|
weight | string |
製品の重量です。 (Float、Float-As-String、Integer)。 |
cost_price_tax
|
cost_price_tax | string |
製品の原価価格に適用された税です。 (Float、Float-As-String、Integer)。自社に対する製品コストです。顧客には表示されず、会計処理の目的で使用します。 読み取り専用。 |
is_refunded
|
is_refunded | boolean |
製品が返金されたかどうかを示します。 |
refunded_amount
|
refunded_amount | string |
このトランザクションで返金された金額。 (Float、Float-As-String、Integer)。 |
return_id
|
return_id | number |
払戻の数値 ID。 |
wrapping_name
|
wrapping_name | string |
ギフトラッピング オプションの名前。 |
base_wrapping_cost
|
base_wrapping_cost | string |
基本梱包費の値。 (Float、Float-As-String、Integer)。 |
wrapping_cost_ex_tax
|
wrapping_cost_ex_tax | string |
梱包費の値 (税抜き)。 (Float、Float-As-String、Integer)。 |
wrapping_cost_inc_tax
|
wrapping_cost_inc_tax | string |
梱包費の値 (税込み)。 (Float、Float-As-String、Integer)。 |
wrapping_cost_tax
|
wrapping_cost_tax | string |
ギフトラッピング オプションに適用された税。 (Float、Float-As-String、Integer)。 |
wrapping_message
|
wrapping_message | string |
ギフトラッピング オプションに添えるメッセージ。 |
quantity_shipped
|
quantity_shipped | number |
この品目の発送済み数量です。 |
event_name
|
event_name | string |
プロモーション イベントの名前/配信日。 |
event_date
|
event_date | date |
プロモーション イベントの日付/スケジュール済みの配信。 |
fixed_shipping_cost
|
fixed_shipping_cost | string |
この製品の送料は固定額です。 (Float、Float-As-String、Integer)。 |
ebay_item_id
|
ebay_item_id | string |
この製品の eBay での品目 ID です。 |
ebay_transaction_id
|
ebay_transaction_id | string |
この製品の eBay でのトランザクション ID です。 |
option_set_id
|
option_set_id | integer |
製品に適用されるオプション セットを表す数値 ID です。 |
parent_order_product_id
|
parent_order_product_id | integer |
親製品の ID です。 |
is_bundled_product
|
is_bundled_product | boolean |
この製品が他の製品とバンドルされるかどうかを示します。 |
bin_picking_number
|
bin_picking_number | string |
物理製品の在庫置場ピッキング番号です。 |
applied_discounts
|
applied_discounts | array of object |
製品に適用される割引を含むオブジェクトの配列です。 |
id
|
applied_discounts.id | string |
受注に適用されるクーポンの名前です。 |
amount
|
applied_discounts.amount | string |
割引額です。(Float、Float-As-String、Integer)。 |
名称
|
applied_discounts.name | string |
クーポンの名前。
|
code
|
applied_discounts.code | string |
クーポン コード。 手動割引を作成する場合、コードはありません。 |
ターゲット
|
applied_discounts.target | string |
割引に受注レベルと製品レベルのどちらが適用されたかを判断します。 読み取り専用。 |
product_options
|
product_options | array of object |
製品オプション オブジェクトの配列です。 |
id
|
product_options.id | integer |
オプションの一意の数値 ID です。順番にインクリメントします。 |
option_id
|
product_options.option_id | integer |
関連付けられているオプションの数値 ID です。 |
order_product_id
|
product_options.order_product_id | integer |
受注製品 ID です。 |
product_option_id
|
product_options.product_option_id | integer |
製品のオプション ID です。 |
display_name
|
product_options.display_name | string |
display_name_customer のエイリアス。 店頭で顧客に表示される製品オプション名です。 |
display_value
|
product_options.display_value | string |
display_value_customer のエイリアス。 店頭で顧客に表示される製品オプションの値です。 |
価値
|
product_options.value | string |
この値は、顧客ファイルのアップロードへのアクセスに使用されます。 |
タイプ
|
product_options.type | string |
オプションの種類です。 |
名称
|
product_options.name | string |
内部で使用されるオプションの名前です。 一意である必要があります。 |
display_style
|
product_options.display_style | string |
店頭に陳列されている様子。 例には、ドロップダウン、ラジオ ボタン、または四角形が含まれます。 |
display_name_customer
|
product_options.display_name_customer | string |
店頭で顧客に表示される製品オプション名です。 |
display_name_merchant
|
product_options.display_name_merchant | string |
コントロール パネルで店舗に表示される製品オプション名です。 |
display_value_customer
|
product_options.display_value_customer | string |
店頭で顧客に表示される製品オプションの値です。 |
display_value_merchant
|
product_options.display_value_merchant | string |
コントロール パネルで店舗に表示される製品オプションの値です。 |
external_id
|
external_id | string |
他のシステムでの受注 ID。 たとえば、Amazon での注文の場合は、Amazon 受注 ID です。このフィールドは /POST で更新できますが、/PUT を使用して注文を更新すると 400 エラーが返されます。 フィールド "external_id" に書き込むことができません。 再試行する前に要求から削除してください。 一度設定すると上書きすることはできません。 |
UPC
|
upc | string |
ユニバーサル製品コード。 カスタム製品やカタログ製品に対して書き込みできます。 |
variant_id
|
variant_id | integer |
製品 |
name_customer
|
name_customer | string |
店頭で顧客に表示される製品名です。 |
name_merchant
|
name_merchant | string |
コントロール パネルで店舗に表示される製品名です。 |
応答で返された注文製品。
名前 | パス | 型 | 説明 |
---|---|---|---|
orderProduct_Resp
|
orderProduct_Resp |
応答で返された注文製品。 |
応答で返された注文発送住所。
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
この発送先住所の ID。 |
order_id
|
order_id | integer |
受注の ID です。 |
items_total
|
items_total | number |
受注に含まれる品目の合計数です。 |
items_shipped
|
items_shipped | number |
発送された品目の数です。 |
base_cost
|
base_cost | string |
注文品目の基本価格。 (Float、Float-As-String、Integer)。 |
cost_ex_tax
|
cost_ex_tax | string |
注文品目の税抜き価格。 (Float、Float-As-String、Integer)。 |
cost_inc_tax
|
cost_inc_tax | string |
注文品目の税込み価格。 (Float、Float-As-String、Integer)。 |
cost_tax
|
cost_tax | string |
注文の税額です。 (Float、Float-As-String、Integer)。 |
cost_tax_class_id
|
cost_tax_class_id | integer |
製品に適用される税クラスの ID です。 (注: ストアで自動税が有効になっている場合、値は無視されます)。 |
handling_cost_ex_tax
|
handling_cost_ex_tax | string |
手数料は税別です。 (Float、Float-As-String、Integer)。 |
handling_cost_inc_tax
|
handling_cost_inc_tax | string |
手数料は税込みです。 (Float、Float-As-String、Integer)。 |
handling_cost_tax
|
handling_cost_tax | string | |
handling_cost_tax_class_id
|
handling_cost_tax_class_id | integer |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。 (注: ストアで自動税が有効になっている場合、値は無視されます)。 |
shipping_zone_id
|
shipping_zone_id | number |
発送ゾーンを表す数値 ID です。 |
shipping_zone_name
|
shipping_zone_name | string |
発送ゾーンの名前です。 |
form_fields
|
form_fields | array of formFields | |
shippingQuotes_Resource
|
shipping_quotes | shippingQuotes_Resource | |
shippingAddress_Base
|
shipping_addresses | shippingAddress_Base |
要求と応答にすべて共通する送付先住所のプロパティ。 |
応答で返された注文発送住所。
名前 | パス | 型 | 説明 |
---|---|---|---|
orderShippingAddress_Resp
|
orderShippingAddress_Resp |
応答で返された注文発送住所。 |
改ページやコレクション合計など、応答に関するデータです。
名前 | パス | 型 | 説明 |
---|---|---|---|
total
|
total | integer |
結果セット内の品目の合計数。 |
COUNT
|
count | integer |
コレクションの応答の品目の合計数。 |
per_page
|
per_page | integer |
ページごとにコレクションで返される品目の金額です。limit パラメーターによって制御されます。 |
current_page
|
current_page | integer |
コレクション内で現在表示されているページです。 |
total_pages
|
total_pages | integer |
コレクションに含まれるページの合計数です。 |
リンク
|
links | Links |
ページ割り付けは、コレクション全体に対して前後の部分をリンクします。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string |
製品名。 |
タイプ
|
type | string |
製品の種類。 いずれか: |
sku
|
sku | string |
ユーザー定義の製品コード/在庫管理単位 (SKU)。 |
description
|
description | string |
HTML 形式を使用できる製品の説明。 |
重量
|
weight | double |
送料の計算に使用する、商品の重量。 ストアで設定されている単位に基づいています |
幅
|
width | double |
発送コストの計算に使用できる製品の幅です。 |
depth
|
depth | double |
発送コストの計算に使用できる製品の奥行です。 |
高さ
|
height | double |
送料の計算に使用する、商品の高さ。 |
price
|
price | double |
製品の価格。 価格に税金を含めるか除外するかは、店舗の設定に基づきます。 |
cost_price
|
cost_price | double |
製品の原価価格。 参照目的でのみ保存され、ストアのどこかで使用または表示されることはありません。 |
retail_price
|
retail_price | double |
製品の小売原価。 入力すると、小売原価価格が製品ページに表示されます。 |
sale_price
|
sale_price | double |
入力すると、製品原価の計算時に、価格フィールドの値の代わりに販売価格を使用します。 |
map_price
|
map_price | double |
最小広告価格 |
tax_class_id
|
tax_class_id | integer |
製品に適用される税クラスの ID です。 (注: ストアで自動税が有効になっている場合、値は無視されます。) |
product_tax_code
|
product_tax_code | string |
特別な消費税カテゴリに分類される製品とサービスを識別する AvaTax システム税コードを受け入れます。 これらのコードを使用すると、BigCommerce の Avalara Premium 統合に登録している販売者は、消費税をより正確に計算できるようになります。 Avalara Premium に登録していない場合は、消費税を計算するときにコードを無視します。 複数のコードを渡さないでください。 コードは大文字と小文字が区別されます。 詳細については、Avalara のドキュメントを参照してください。 |
categories
|
categories | array of integer |
この製品が属するカテゴリの ID の配列。 製品を更新するときに、カテゴリの配列が指定されている場合、すべての製品カテゴリが上書きされます。 1,000 を超える ID 値は受け入れられません。 |
brand_id
|
brand_id | integer |
製品の /PUT または /POST の操作中に、製品を既存のブランドに追加できます。 |
inventory_level
|
inventory_level | integer |
製品の現在の在庫レベル。 有効にするには、単純な在庫追跡を有効にする必要があります ( |
inventory_warning_level
|
inventory_warning_level | integer |
製品の在庫警告レベル。 製品の在庫レベルが警告レベルを下回ると、ストア オーナーに通知されます。 有効にするには、単純な在庫追跡を有効にする必要があります ( |
inventory_tracking
|
inventory_tracking | string |
製品の在庫追跡の種類です。 使用できる値: |
fixed_cost_shipping_price
|
fixed_cost_shipping_price | double |
この製品の送料は固定額です。 指定されている場合は、通常の発送コストの計算を省略し、この値を使用してチェックアウトを行います。 |
is_free_shipping
|
is_free_shipping | boolean |
製品が送料無料かどうかを示すために使用されるフラグ。 |
is_visible
|
is_visible | boolean |
ストアを閲覧する顧客に商品を表示するかどうかを決定するフラグ。 |
is_featured
|
is_featured | boolean |
ストアの表示中に、その製品を |
related_products
|
related_products | array of integer |
関連する製品の ID の配列です。 |
warranty
|
warranty | string |
製品ページに表示される保証情報です。 HTML 形式を含めることができます。 |
bin_picking_number
|
bin_picking_number | string |
製品の在庫置場ピッキング番号です。 |
layout_file
|
layout_file | string |
この製品カテゴリをレンダリングするために使用されるレイアウト テンプレート ファイル。 このフィールドは、Blueprint テーマが適用されているストアに対してのみ書き込み可能です。 |
UPC
|
upc | string |
製品の UPC コード。ショッピング比較サイトや外部チャネル統合のフィードで使用します。 |
search_keywords
|
search_keywords | string |
ストアの検索時に製品を探すために使用できるキーワードをコンマで区切った一覧です。 |
空き時間
|
availability | string |
製品の使用可能性。 使用できる在庫状況オプション: |
availability_description
|
availability_description | string |
チェックアウト ページの商品タイトルの下に表示される在庫状況テキスト。 「通常は 24 時間以内に発送します」など、この商品の発送に通常かかる時間を顧客に伝えます。 |
gift_wrapping_options_type
|
gift_wrapping_options_type | string |
ギフトラッピング オプションのタイプ。 値: |
gift_wrapping_options_list
|
gift_wrapping_options_list | array of integer |
ギフトラッピング オプションの ID の一覧です。 |
並べ替え順序
|
sort_order | integer |
カテゴリ ページの商品リストや検索結果にこの商品が含まれている場合、この商品が優先されます。 整数が小さいほど、商品が上位の結果に近くなります。 |
条件
|
condition | string |
商品の状態。 |
is_condition_shown
|
is_condition_shown | boolean |
製品ページで製品の状態を顧客に表示するかどうかを決定するフラグ。 |
order_quantity_minimum
|
order_quantity_minimum | integer |
この製品の購入資格を得るために、注文に含めるべき最小数量。 |
order_quantity_maximum
|
order_quantity_maximum | integer |
製品の購入時に注文に含めることができる最大数量。 |
page_title
|
page_title | string |
商品ページのカスタム タイトル。 指定されない場合は、メタ タイトルが使用されます。 |
meta_keywords
|
meta_keywords | array of string |
商品ページのカスタム メタ キーワード。 指定がない場合は、店舗の既定のキーワードが使用されます。 |
meta_description
|
meta_description | string |
商品ページのカスタム メタ説明。 指定がない場合は、店舗の既定のメタ説明が使用されます。 |
view_count
|
view_count | integer |
製品が閲覧された回数。 |
preorder_release_date
|
preorder_release_date | date-time |
事前注文リリース日。 製品の事前注文に関する設定情報については、 |
preorder_message
|
preorder_message | string |
製品ページに表示するカスタムの予定日メッセージ。 指定されていない場合、メッセージは既定で店舗全体に設定されます。 リリース日の代わりに使用される |
is_preorder_only
|
is_preorder_only | boolean |
true に設定すると、事前注文のリリース日に事前注文の状態が自動的に削除されます。
false に設定すると、事前注文のリリース日に事前注文の状態が自動的に削除 されません。 コントロール パネルまたは API を使用して手動で変更する必要があります。 API を使用して |
is_price_hidden
|
is_price_hidden | boolean |
既定では False で、この製品の価格が製品ページに表示されることを示します。 |
price_hidden_label
|
price_hidden_label | string |
既定では空の文字列です。 |
customUrl_Full
|
custom_url | customUrl_Full |
店頭の製品のカスタム URL です。 |
open_graph_type
|
open_graph_type | string |
製品の種類です。既定値は |
open_graph_title
|
open_graph_title | string |
製品のタイトルです。指定されない場合は、製品名が使用されます。 |
open_graph_description
|
open_graph_description | string |
製品の使用説明です。指定しない場合は、メタ記述が使用されます。 |
open_graph_use_meta_description
|
open_graph_use_meta_description | boolean |
製品説明とオープン グラフ説明の、どちらを使用するかを決定するフラグ。 |
open_graph_use_product_name
|
open_graph_use_product_name | boolean |
製品名とオープン グラフ名の、どちらを使用するかを決定するフラグ。 |
open_graph_use_image
|
open_graph_use_image | boolean |
製品画像とオープン グラフ画像の、どちらを使用するかを決定するフラグ。 |
brand_name または brand_id
|
brand_name or brand_id | string |
ブランドは、製品の PUT または POST 要求中に作成できます。 ブランドがすでに存在する場合は、製品が追加されます。 ブランドが存在しない場合は、ブランドが作成され製品が追加されます。 |
GTIN
|
gtin | string |
グローバル貿易品目番号 |
MPN
|
mpn | string |
製造業者識別番号 |
reviews_rating_sum
|
reviews_rating_sum | integer |
製品の評価合計。 |
reviews_count
|
reviews_count | integer |
製品が評価された回数。 |
total_sold
|
total_sold | integer |
この製品の販売済み合計数量。 |
custom_fields
|
custom_fields | array of productCustomField_Put | |
bulk_pricing_rules
|
bulk_pricing_rules | array of bulkPricingRule_Full | |
images
|
images | array of productImage_Full | |
のビデオ
|
videos | array of productVideo_Full |
名前 | パス | 型 | 説明 |
---|---|---|---|
product_Base
|
schema | product_Base | |
date_created
|
date_created | date-time |
製品が作成された日付です。 |
date_modified
|
date_modified | date-time |
製品が変更された日付です。 |
id
|
id | integer |
製品の ID です。 読み取り専用。 |
base_variant_id
|
base_variant_id | integer |
シンプルな製品に関連付けられているベース バリアントの一意識別子です。 この値は、複雑な製品で使用する |
calculated_price
|
calculated_price | double |
店頭で見た商品の価格です。 設定されている場合は |
options
|
options | array of productOption_Base | |
modifiers
|
modifiers | array of productModifier_Full | |
option_set_id
|
option_set_id | integer |
製品がオプション セットに含まれることを示します (レガシ V2 の概念)。 |
option_set_display
|
option_set_display | string |
製品の画像や説明の横または下にオプション セットを表示するかどうかを制御するレガシ テンプレート設定です。 |
productVariant_Full
|
variants | productVariant_Full |
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of product_Full | |
metaCollection_Full
|
meta | metaCollection_Full |
改ページやコレクション合計など、応答に関するデータです。 |
製品に関連付けられたカスタム フィールドを取得します。 これらを使用すると、本の ISBN や DVD のリリース日など、製品のページに表示する追加情報を指定できます。
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
カスタム フィールドを表す一意の数値 ID です。連続的に増加します。 /PUT 要求の既存のカスタム フィールドを更新するために必要です。 読み取り専用 |
名称
|
name | string |
店舗や注文などに表示するフィールドの名前。/POST に必須 |
価値
|
value | string |
店舗や注文などに表示するフィールドの名前。/POST に必須 |
共通の製品画像プロパティです。
名前 | パス | 型 | 説明 |
---|---|---|---|
image_file
|
image_file | string |
BigCommerce にアップロードされた元の画像ファイルのローカル パスです。 |
is_thumbnail
|
is_thumbnail | boolean |
画像が製品のサムネイルとして使用されるかどうかを識別するフラグです。 |
並べ替え順序
|
sort_order | integer |
製品ページに画像を表示する順序。 整数が大きいほど、画像の優先順位が低くなります。 更新時に画像の優先順位が低い場合、画像の新しい |
description
|
description | string |
画像の説明です。 |
image_url
|
image_url | string |
プロトコルを含む、完全修飾の URL パスである必要があります。 ファイルごとに 8MB の制限。 |
id
|
id | integer |
画像を表す一意の数値 ID です。連続的に増加します。 |
product_id
|
product_id | integer |
画像を関連付けた製品を表す一意の数値識別子。 |
url_zoom
|
url_zoom | string |
この画像のズーム URL。 既定では、画像のズームが有効である場合に製品ページのズーム画像として使用されます。 |
url_standard
|
url_standard | string |
この画像の標準 URL。 既定では、商品ページの画像に使用されます。 |
url_thumbnail
|
url_thumbnail | string |
この画像のサムネイル URL。 既定では、これはカテゴリ ページとサイド パネルで使用される画像のサイズです。 |
url_tiny
|
url_tiny | string |
この画像の小さい URL。 既定では、これは製品ページで製品画像のすぐ下に表示されるサムネイルの画像サイズです。 |
date_modified
|
date_modified | date-time |
製品の画像が変更された日付です。 |
共通の変更者プロパティです。
名前 | パス | 型 | 説明 |
---|---|---|---|
タイプ
|
type | string |
BigCommerce API。店頭での表示方法を決定します。 許容される値: |
required
|
required | boolean |
この変更者がチェックアウト時に必要かどうかを示します。 /POST は必須です。 |
並べ替え順序
|
sort_order | integer |
製品の詳細ページに変更者が表示される順序です。 |
config_Full
|
config | config_Full |
オプション構成の値は、作成した修飾子によって異なります。 |
display_name
|
display_name | string |
店舗に表示するオプションの名前。 |
製品の変更者
名前 | パス | 型 | 説明 |
---|---|---|---|
productModifier_Base
|
schema | productModifier_Base |
共通の変更者プロパティです。 |
id
|
id | integer |
変更者を表す一意の数値 ID です。連続的に増加します。 |
product_id
|
product_id | integer |
オプションが属する製品を表す一意の数値 ID です。 |
名称
|
name | string |
一意のオプション名。 表示名、タイムスタンプ、および製品 ID から自動生成されます。 |
option_values
|
option_values | array of productModifierOptionValue_Full |
製品の修飾子 option_value
。
名前 | パス | 型 | 説明 |
---|---|---|---|
is_default
|
is_default | boolean |
店頭で既定として値を事前に選択するためのフラグ。 このフィールドは、見本のオプション/修飾子では対応していません。 |
label
|
label | string |
店舗の値を識別するテキスト表示。 /POST は必須です。 |
並べ替え順序
|
sort_order | integer |
製品ページに値を表示する順序。 /POST は必須です。 |
value_data
|
value_data | object |
値が関連付けられているオプションまたは修飾子のタイプに基づいて、値を説明する追加データ。 |
adjusters_Full
|
adjusters | adjusters_Full | |
id
|
id | integer |
値の一意の数値 ID。順番にインクリメントします。 |
option_id
|
option_id | integer |
共通のオプション プロパティです。
名前 | パス | 型 | 説明 |
---|---|---|---|
id
|
id | integer |
オプションの一意の数値 ID です。順番にインクリメントします。 |
product_id
|
product_id | integer |
オプションが属する製品を表す一意の数値 ID です。 |
display_name
|
display_name | string |
店舗に表示するオプションの名前。 |
タイプ
|
type | string |
店頭での表示方法を決定するオプションのタイプです。 許容される値: |
productOptionConfig_Full
|
config | productOptionConfig_Full |
オプション構成の値は、作成した修飾子によって異なります。 |
並べ替え順序
|
sort_order | integer |
店頭でオプションを表示する順序です。 |
productOptionOptionValue_Full
|
option_values | productOptionOptionValue_Full |
製品のオプション |
オプション構成の値は、作成した修飾子によって異なります。
名前 | パス | 型 | 説明 |
---|---|---|---|
default_value
|
default_value | string |
(日付、テキスト、multi_line_text、numbers_only_text) 既定値。 日付オプションでは ISO-8601 形式の文字列として、またはテキスト オプションでは文字列として表示されます。 |
checked_by_default
|
checked_by_default | boolean |
(チェックボックス) 既定でオンにするチェック ボックスを設定するフラグです。 |
checkbox_label
|
checkbox_label | string |
(チェックボックス) チェックボックス オプションに表示されるラベルです。 |
date_limited
|
date_limited | boolean |
(日付) 日付オプションに入力できる日付を制限するフラグです。 |
date_limit_mode
|
date_limit_mode | string |
(日付) 日付オプションへの入力制限の種類です。 |
date_earliest_value
|
date_earliest_value | date |
(日付) 日付オプションに ISO-8601 形式の文字列で入力できる最も早い日付です。 |
date_latest_value
|
date_latest_value | date |
(日付) 日付オプションに ISO-8601 形式の文字列で入力できる最も遅い日付です。 |
file_types_mode
|
file_types_mode | string |
(ファイル) ファイル アップロード オプションでアップロードできるファイル タイプの制限の種類。 値: |
file_types_supported
|
file_types_supported | array of string |
(ファイル) |
file_types_other
|
file_types_other | array of string |
(ファイル) ファイルのアップロード オプションで選択できる他のファイルの種類の一覧です。 |
file_max_size
|
file_max_size | integer |
(ファイル) ファイルのアップロード オプションで使用できるファイルの最大サイズです。 これもサーバーによって制限されます。 |
text_characters_limited
|
text_characters_limited | boolean |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキストへの入力の長さを検証するフラグです。 |
text_min_length
|
text_min_length | integer |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキスト オプションに入力できる最小長です。 |
text_max_length
|
text_max_length | integer |
(製品リスト、製品リスト画像あり) テキストまたは複数行テキスト オプションに入力できる最大長です。 |
text_lines_limited
|
text_lines_limited | boolean |
(複数行テキスト) 複数行テキストに入力できる行の最大数を検証するフラグです。 |
text_max_lines
|
text_max_lines | integer |
(複数行テキスト) 複数行テキストに入力できる行の最大数です。 |
number_limited
|
number_limited | boolean |
(数値のみテキスト) 数値オプションの値を制限するフラグです。 |
number_limit_mode
|
number_limit_mode | string |
(数値のみテキスト) 数値オプションへの入力値に関する制限の種類です。 |
number_lowest_value
|
number_lowest_value | double |
(数値のみテキスト) |
number_highest_value
|
number_highest_value | double |
(数値のみテキスト) |
number_integers_only
|
number_integers_only | boolean |
(数値のみテキスト) 数値オプションへの入力を整数のみに制限するフラグです。 |
product_list_adjusts_inventory
|
product_list_adjusts_inventory | boolean |
(製品リスト、製品リスト画像あり) 一覧に含まれる製品の在庫を自動的に調整するためのフラグです。 |
product_list_adjusts_pricing
|
product_list_adjusts_pricing | boolean |
(製品リスト、製品リスト画像あり) オプション製品の価格をメイン製品の価格に追加するフラグです。 |
product_list_shipping_calc
|
product_list_shipping_calc | string |
(product_list、product_list_with_images) オプションの製品の重量とパッケージの寸法を配送見積もりに組み込む方法。 値: |
製品のオプション option_value
です。
名前 | パス | 型 | 説明 |
---|---|---|---|
is_default
|
is_default | boolean |
店頭で既定として値を事前に選択するためのフラグ。 このフィールドは、見本のオプション/修飾子では対応していません。 |
label
|
label | string |
店舗の値を識別するテキスト表示。 /POST は必須です。 |
並べ替え順序
|
sort_order | integer |
製品ページに値を表示する順序。 /POST は必須です。 |
value_data
|
value_data | object |
値が関連付けられているオプションまたは修飾子のタイプに基づいて、値を説明する追加データ。 |
id
|
id | integer |
値の一意の数値 ID。順番にインクリメントします。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
product_Full
|
data | product_Full | |
meta
|
meta | object |
空のメタ オブジェクト。後で使用できます。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
url
|
url | string | |
resource
|
resource | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
cost_price
|
cost_price | double |
バリアントの原価価格。 価格表の価格には影響されません。 |
price
|
price | double |
このバリアントの店頭での基本価格。 価格表 ID が使用される場合、価格表の値が使用されます。 価格表 ID が使用されず、この値が |
sale_price
|
sale_price | double |
このバリアントの店頭での販売価格。 価格表 ID が使用される場合、価格表の値が使用されます。 価格表 ID が使用されず、この値が null 値の場合、製品の販売価格 (製品リソースの |
retail_price
|
retail_price | double |
このバリアントの店頭での小売価格。 価格表 ID が使用される場合、価格表の値が使用されます。 価格表 ID が使用されず、この値が null 値の場合、製品の小売価格 (製品リソースの |
重量
|
weight | double |
このバリアントの店頭での基本重量。 この値が null の場合は、(製品リソースの重量フィールドで設定する) 製品の既定重量を基本重量として使用します。 |
幅
|
width | double |
発送コストの計算に使用できるバリアントの幅です。 この値が |
高さ
|
height | double |
送料の計算に使用する、バリアントの高さ。 この値が |
depth
|
depth | double |
発送コストの計算に使用できるバリアントの奥行です。 この値が |
is_free_shipping
|
is_free_shipping | boolean |
バリアントが送料無料かどうかを示すために使用されるフラグ。 |
fixed_cost_shipping_price
|
fixed_cost_shipping_price | double |
このバリアントの送料は固定額です。 指定されている場合は、通常の発送コストの計算を省略し、この値を使用してチェックアウトを行います。 |
purchasing_disabled
|
purchasing_disabled | boolean |
|
purchasing_disabled_message
|
purchasing_disabled_message | string |
|
UPC
|
upc | string |
ショッピング比較サイトや外部チャネル統合のフィードに使用する UPC コード。 |
inventory_level
|
inventory_level | integer |
製品の在庫追跡を |
inventory_warning_level
|
inventory_warning_level | integer |
バライアントがこの在庫レベルに達すると、在庫不足と見なされます。 |
bin_picking_number
|
bin_picking_number | string |
倉庫内でバリアントを配置する位置を識別します。 |
MPN
|
mpn | string |
バリアントの製造元部品番号 (MPN) です。 |
id
|
id | integer | |
product_id
|
product_id | integer | |
sku
|
sku | string | |
sku_id
|
sku_id | integer |
v2 API の SKU ID への読み取り専用の参照。 基本バリアントの場合は null 値。 |
option_values
|
option_values | array of productVariantOptionValue_Full |
このバリアントを構成するオプションとオプション値 ID の配列。 バリアントが製品の基本バリアントの場合は空になります。 |
calculated_price
|
calculated_price | double |
店頭で見たバリアントの価格です。 この価格は、 |
calculated_weight
|
calculated_weight | double |
名前 | パス | 型 | 説明 |
---|---|---|---|
option_display_name
|
option_display_name | string |
オプションの名前です。 |
label
|
label | string |
オプション値のラベルです。 |
id
|
id | integer |
|
option_id
|
option_id | integer |
|
製品に関するビデオを作成する POST のモデルです。
名前 | パス | 型 | 説明 |
---|---|---|---|
肩書き
|
title | string |
ビデオのタイトル。 空の場合、ホスト サイトのデータに従って入力されます。 |
description
|
description | string |
ビデオの説明。 空の場合、ホスト サイトのデータに従って入力されます。 |
並べ替え順序
|
sort_order | integer |
製品ページにビデオを表示する順序。 整数が大きいほど、ビデオの優先順位が低くなります。 更新時にビデオの優先順位が低い場合、ビデオの新しい |
タイプ
|
type | string |
ビデオの種類 (ホスト サイトの短い名前) です。 |
video_id
|
video_id | string |
ホスト サイトのビデオの ID です。 |
製品ビデオ モデルです。
名前 | パス | 型 | 説明 |
---|---|---|---|
productVideo_Base
|
schema | productVideo_Base |
製品に関するビデオを作成する POST のモデルです。 |
id
|
id | integer |
製品ビデオを表す一意の数値 ID です。連続的に増加します。 |
product_id
|
product_id | integer |
画像を関連付けた製品を表す一意の数値識別子。 |
length
|
length | string |
ビデオの長さ。 ホスト サイトのデータに従って入力されます。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
ステータス
|
status | boolean |
店頭で選択されたときに修飾子の値が購入を無効にするかどうかを示すフラグ。 これは、特定の修飾子の値を一時的に無効にするために使用できます。 |
message
|
message | string |
購入無効状態が |
要求と応答にすべて共通する送付先住所のプロパティ。
名前 | パス | 型 | 説明 |
---|---|---|---|
first_name
|
first_name | string | |
姓
|
last_name | string | |
会社名
|
company | string | |
street_1
|
street_1 | string |
番地 (1 行目)。 |
street_2
|
street_2 | string |
番地 (2 行目)。 |
市
|
city | string | |
州
|
state | string | |
郵便番号
|
zip | string |
郵便番号 (文字列) です。 |
国
|
country | string | |
country_iso2
|
country_iso2 | string |
国を表す 2 文字の ISO Alpha-2 コード。 |
電話番号
|
phone | string |
受信者の電話番号。 |
メールアドレス
|
string |
受信者のメール アドレス。 |
|
shipping_method
|
shipping_method | string |
顧客が選択した BigCommerce 発送モジュールを識別するテキスト コードです。 |
名前 | パス | 型 | 説明 |
---|---|---|---|
url
|
url | string |
API 要求の発送先住所の URL です |
resource
|
resource | string |
名前 | パス | 型 | 説明 |
---|---|---|---|
url
|
url | string |
この URL は配送見積もりの 204 を返します。 発送の見積を返すには次を使用します。/shipping_addresses/shipping_address_id/shipping_quotes。 |
resource
|
resource | string |
この URL は配送見積もりの 204 を返します。 発送の見積を返すには次を使用します。/shipping_addresses/shipping_address_id/shipping_quotes。 |
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。
読み取り専用の値。 POST または PUT 操作でこの値を設定または変更しないでください。
- PaymentStatus
- string
この受注で使用される支払方法です。 Manual
、Credit Card
、cash
、Test Payment Gateway
などです。
この受注で使用される支払方法です。 Manual
、Credit Card
、cash
、Test Payment Gateway
などです。
- PaymentMethod
- string
BasicTaxProvider - 税金は手動に設定されています。
AvaTaxProvider - これは、税金プロバイダーが自動に設定されており、注文が API によって作成されなかった場合に使用されます。 Avalara に使用されます。
"" (空白) - 税プロバイダーが不明な場合。 これには、従来の注文と、以前に API 経由で作成された注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。
BasicTaxProvider - 税金は手動に設定されています。
AvaTaxProvider - これは、税金プロバイダーが自動に設定されており、注文が API によって作成されなかった場合に使用されます。 Avalara に使用されます。
"" (空白) - 税プロバイダーが不明な場合。 これには、従来の注文と、以前に API 経由で作成された注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。
- TaxProviderId
- string