BigCommerce (プレビュー)

BigCommerce は、柔軟でオープンな SaaS プラットフォームです。 BigCommerce に接続して、注文、製品、関連情報を取得します。

このコネクタは、次の製品とリージョンで使用できます。

サービス	クラス	リージョン
ロジック アプリ	Standard	次を除くすべての Logic Apps リージョン :      - Azure Government リージョン      - Azure China リージョン      - 米国国防総省 (DoD)
Power Automate	Premium	次を除くすべての Power Automate リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)
Power Apps	Premium	次を除くすべての Power Apps リージョン :      - 米国政府 (GCC)      - 米国政府 (GCC High)      - 21Vianet が運営する China Cloud      - 米国国防総省 (DoD)

お問い合わせ
名前	Microsoft Dynamics
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

コネクタ メタデータ
Publisher	Microsoft
Web サイト	https://www.bigcommerce.com/
プライバシー ポリシー	https://www.bigcommerce.com/privacy/
カテゴリ	生産性

このコネクタは、Dynamics 365 Intelligent Order Management の Big Commerce プロバイダー統合に使用するために特別に開発されました。

[前提条件]

BigCommerce 開発者アカウントとテスト ストアが必要です。 お持ちでない場合は、 https://developer.bigcommerce.com/ メモで作成できます。このコネクタを使用して、Dynamics 365 Intelligent Order Management BigCommerce プロバイダーを設定することをお勧めします。

資格情報を取得する方法

BigCommerce では、認証に API トークンが必要です。 API トークンを生成し、これを使用してコネクタを構成できます。 注: 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 以外のユースケースのサポートは制限されます。

接続を作成する

コネクタでは、次の認証の種類がサポートされています。

デフォルト	接続を作成するためのパラメーター。	すべてのリージョン	共有不可

デフォルト

適用対象: すべてのリージョン

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

名前	タイプ	Description	必須
API キー	securestring	この API の API キー	正しい

調整制限

名前	呼び出し	更新期間
接続ごとの API 呼び出し	100	60 秒

アクション

Id で製品を取得する	1 つの Product を返します。 省略可能なパラメーターを渡すことができます。
すべての注文を取得する	フィルター クエリを使用して、すべての注文を取得します。
すべての顧客を取得する	顧客の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。
注文の配送先住所を取得する	注文 ID を使用して、注文のすべての配送先住所を取得します。
注文を取得する	注文 ID を使用して注文を取得します。
注文を更新する	注文を更新 します。 注文の作成または更新の詳細については、「 注文の概要」を参照してください。
注文製品を一覧表示する	注文 ID を使用して、注文のすべての注文製品を一覧表示します。
製品の更新	製品を更新 します。 Read-Only フィールド id date_created date_modified calculated_price base_variant_id
製品を入手する	製品の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。

Id で製品を取得する

操作 ID:

GetProductById

1 つの Product を返します。 省略可能なパラメーターを渡すことができます。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
製品 ID	product_id	True	integer	リソースが属する Product の ID。
含める	include		string	製品に含めるサブリソースをコンマ区切りリストに含めます。 optionsまたはmodifiersを使用する場合、結果は 1 ページあたり 10 に制限されます。
include_fields	include_fields		string	コンマ区切りリストに含めるフィールド。 ID と指定したフィールドが返されます。
exclude_fields	exclude_fields		string	コンマ区切りの一覧で除外するフィールド。 指定されたフィールドは応答から除外されます。 ID を除外できません。

戻り値

名前	パス	型	説明
product_Full	data	product_Full
Meta	meta	object	空のメタ オブジェクト。は後で使用できます。

すべての注文を取得する

操作 ID:

GetAllOrders

フィルター クエリを使用して、すべての注文を取得します。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
最小 ID	min_id		integer	最小注文 ID。
最大注文 ID	max_id		integer	最大注文 ID。
最小合計	min_total		number	float 形式の最小注文合計。
最大合計	max_total		number	float 形式の最大注文合計。
顧客ID	customer_id		integer	注文の顧客 ID。
Email	email		string	顧客の電子メール。
状態 ID	status_id		integer	注文の staus ID。
カート ID	cart_id		string	注文のカート ID。
支払い方法	payment_method		string	注文で使用される支払い方法。
作成された最小日付	min_date_created		string	RFC-2822 または ISO-8601 で注文が作成された最小日付。 RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'。
作成日の最大値	max_date_created		string	RFC-2822 または ISO-8601 で注文が作成された最大日付。 RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'。
変更日の最小	min_date_modified		string	RFC-2822 または ISO-8601 で注文が変更された最小日付。 RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'。
変更日の最大値	max_date_modified		string	RFC-2822 または ISO-8601 で注文が変更された最大日付。 RFC-2822: 'Thu, 20 Apr 2017 11:32:00 -0400' ISO-8601: '2017-04-20T11:32:00.000-04:00'。
ページ	page		number	応答で返されるページ。
極限	limit		number	返される結果の数。
ソート	sort		string	並べ替え順序のフィールドと方向。 方向を指定するには、クエリ パラメーターの末尾に ':asc' または ':d esc' を追加します。 例: 'sort=date_created:desc'.
削除済み	is_deleted		boolean	注文が削除またはアーカイブされた場合。
チャネル ID	channel_id		boolean	注文のチャネル ID。

戻り値

応答で返される注文リスト。

アイテム

orderCollection_Resp

すべての顧客を取得する

操作 ID:

GetCustomers

顧客の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
1 ページあたりのアイテム数。	limit		number	1 ページあたりのアイテム数。 limit=50。
ID で項目をフィルター処理します。	id:in		array	ID で項目をフィルター処理します。 id:in=4,5,6。
customer_group_idで項目をフィルター処理します。	customer_group_id:in		array	customer_group_idで項目をフィルター処理します。 customer_group_id:in=5,6。
date_modifiedで項目をフィルター処理します。	date_modified		date-time	date_modifiedで項目をフィルター処理します。 date_modified=2018-09-05T13:45:03。
最小date_modifiedで項目をフィルター処理します。	date_modified:min		string	ミニ数値date_modifiedで項目をフィルター処理します。 date_modified:min=2019-09-04T:00:00:00 または date_modified:min=2019-09-04。
最大date_modifiedでアイテムをフィルター処理します。	date_modified:max		date-time	最大date_modified date_modified:max=2018-09-05T13:45:03 または date_modified:max=2019-09-04で項目をフィルター処理します。
顧客のサブリソースを含めるかどうかを示します。	include		string	顧客のサブリソースを含めるかどうかを示します。 addresses - 顧客の住所 storecredit - クレジットを格納する attributes - 顧客属性と住所属性 formfields - 顧客フォームフィールドと住所フォーム フィールド include=addresses,storecredit,attributes,formfields。
アイテムを並べ替えます。	sort		string	アイテムをdate_created、date_modified、またはlast_name:* date_created:asc で並べ替えます。作成日、昇順* date_created:desc - 作成日、降順* last_name:asc - 姓、昇順* last_name:desc - 姓、降順 * date_modified:asc - 日付の変更日、昇順* date_modified:desc- 日付の変更、降順の例: sort=last_name:asc。

戻り値

顧客コレクションの応答

CustomerCollectionResponse

注文の配送先住所を取得する

操作 ID:

GetAllOrderShippingAddresses

注文 ID を使用して、注文のすべての配送先住所を取得します。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
注文 ID	order_id	True	string	注文の ID。
ページ	page		number	応答で返されるページ。
極限	limit		number	返される結果の数。

戻り値

応答で返される配送先住所を注文します。

アイテム

orderShippingAddressCollection_Resp

注文を取得する

操作 ID:

GetAnOrder

注文 ID を使用して注文を取得します。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
注文 ID	order_id	True	string	注文の ID。

戻り値

応答で返される Order オブジェクト。

order_Resp

order_Resp

注文を更新する

操作 ID:

UpdateAnOrder

注文を更新 します。 注文の作成または更新の詳細については、「 注文の概要」を参照してください。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
order_id	order_id	True	integer	注文の ID
			object

戻り値

応答で返される Order オブジェクト。

order_Resp

order_Resp

注文製品を一覧表示する

操作 ID:

GetAllOrderProducts

注文 ID を使用して、注文のすべての注文製品を一覧表示します。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
注文 ID	order_id	True	string	注文の ID。
ページ	page		number	応答で返されるページ。
極限	limit		number	返される結果の数。

戻り値

応答で返された製品を注文します。

アイテム

orderProductsCollection_Resp

製品の更新

操作 ID:

UpdateProduct

製品を更新 します。

Read-Only フィールド

• id
• date_created
• date_modified
• calculated_price
• base_variant_id

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
製品 ID	product_id	True	integer	リソースが属する Product の ID。
			object
フィールドを含める	include_fields		string	コンマ区切りリストに含めるフィールド。 ID と指定したフィールドが返されます。

戻り値

ProductResponse

ProductResponse

製品を入手する

操作 ID:

GetProducts

製品の一覧を返します。 オプションのフィルター パラメーターを渡すことができます。

パラメーター

名前	キー	必須	型	説明
ストア ハッシュ	store_hash	True	string	ストア ハッシュ コード。
ID (アイディー)	id		integer	ID で項目をフィルター処理します。
名前	name		string	名前で項目をフィルター処理します。
upc	upc		string	upc で項目をフィルター処理します。
価格	price		double	価格でアイテムをフィルター処理します。
重量	weight		double	アイテムを重みでフィルター処理します。
condition	condition		string	条件で項目をフィルター処理します。
brand_id	brand_id		integer	brand_idで項目をフィルター処理します。
date_modified	date_modified		date-time	date_modifiedで項目をフィルター処理します。
date_modified:max	date_modified:max		string	date_modifiedで項目をフィルター処理します。 たとえば、「 date_modified:max=2020-06-15 」のように入力します。
date_modified:min	date_modified:min		string	date_modifiedで項目をフィルター処理します。 たとえば、「 date_modified:min=2018-06-15 」のように入力します。
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:max=2020-06-15 」のように入力します。
date_last_imported:min	date_last_imported:min		string	date_last_importedで項目をフィルター処理します。 たとえば、「 date_last_imported:min=2018-06-15 」のように入力します。
is_visible	is_visible		boolean	商品がネットショップに現在表示されているかどうかに基づいてアイテムをフィルター処理します。
is_featured	is_featured		string	is_featuredで項目をフィルター処理します。 0 true の場合は 1 false。
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	在庫レベル NOT IN
inventory_level:min	inventory_level:min		integer	在庫レベル MIN
inventory_level:max	inventory_level:max		integer	インベントリ レベル MAX
inventory_level:greater	inventory_level:greater		integer	インベントリ レベルが大きい
inventory_level:less	inventory_level:less		integer	在庫レベル LESS
inventory_low	inventory_low		integer	inventory_lowで項目をフィルター処理します。 値: 1、0。
out_of_stock	out_of_stock		integer	out_of_stockで項目をフィルター処理します。 フィルターを有効にするには、 out_of_stock=1渡します。
total_sold	total_sold		integer	total_soldで項目をフィルター処理します。
型	type		string	種類別に項目をフィルター処理します。
categories	categories		integer	項目をカテゴリ別にフィルター処理します。 製品が複数のカテゴリにある場合、このクエリを使用しても製品は返されません。 代わりに categories:in=12 を使用します。
キーワード	keyword		string	name、description、またはskuフィールド、またはブランド名で見つかったキーワードでアイテムをフィルター処理します。
keyword_context	keyword_context		string	検索アルゴリズムで使用されるコンテキストを設定して、指定したグループを対象とする結果を返します。 merchantを使用して、販売者が自分のカタログを検索できるようにします。 shopperを使用して、買い物客向けの検索結果を返します。
状態	status		integer	状態でアイテムをフィルター処理します。
含める	include		string	製品に含めるサブリソースをコンマ区切りリストに含めます。 optionsまたはmodifiersを使用する場合、結果は 1 ページあたり 10 に制限されます。
include_fields	include_fields		string	コンマ区切りリストに含めるフィールド。 ID と指定したフィールドが返されます。
exclude_fields	exclude_fields		string	コンマ区切りの一覧で除外するフィールド。 指定されたフィールドは応答から除外されます。 ID を除外できません。
可用性	availability		string	可用性で項目をフィルター処理します。 値は、使用可能、無効、予約注文です。
page	page		integer	限定された (ページ分割された) 製品の一覧のページ番号を指定します。
limit	limit		integer	限られた (ページ分割された) 製品の一覧内の 1 ページあたりの項目数を制御します。
方向	direction		string	並べ替えの方向。 使用可能な値は、 asc、 descです。
並べ替え	sort		string	並べ替えの基準にするフィールド名。 注: id は新しい製品が追加されたときにインクリメントされるため、そのフィールドを使用して製品の作成日で並べ替えることができます。
categories:in	categories:in		integer	項目をカテゴリ別にフィルター処理します。 複数のカテゴリの製品に使用します。 たとえば、「 categories:in=12 」のように入力します。

戻り値

ProductCollectionResponse

ProductCollectionResponse

定義

address_Full

名前	パス	型	説明
first_name	first_name	string	顧客住所の名。
last_name	last_name	string	顧客の住所の姓。
会社	company	string	顧客住所の会社。
住所1	address1	string	アドレス 1 行。
住所2	address2	string	アドレス 2 行。
city	city	string	顧客住所の市区町村。
state_or_province	state_or_province	string	都道府県名
postal_code	postal_code	string	顧客住所の郵便番号。
country_code	country_code	string	顧客住所の国コード。
phone	phone	string	顧客の住所の電話番号。
住所の種類	address_type	string	アドレスの種類。 住宅または商業
customer_id	customer_id	integer	顧客 ID。
id	id	integer	アドレスの一意の数値 ID。
country	country	string	顧客住所の国名。

アジャスター

ネットショップで修飾子の値が選択されている場合の、バリアントの価格または重みのアジャスターの種類。

ネットショップで修飾子の値が選択されている場合の、バリアントの価格または重みのアジャスターの種類。

アジャスター

string

adjuster_Full

複雑なルールの調整ツール。

名前	パス	型	説明
アジャスター	adjuster	Adjuster	ネットショップで修飾子の値が選択されている場合の、バリアントの価格または重みのアジャスターの種類。
adjuster_value	adjuster_value	double	ネットショップで修飾子の値が選択されている場合に、アジャスターがバリアントの価格または重みを変更する数値。

adjusters_Full

名前	パス	型	説明
adjuster_Full	price	adjuster_Full	複雑なルールの調整ツール。
adjuster_Full	weight	adjuster_Full	複雑なルールの調整ツール。
image_url	image_url	string	修飾子の値が選択されたときにネットショップに表示されるイメージの URL。ファイルあたり 8 MB の制限。
PurchasingDisabled	purchasing_disabled	PurchasingDisabled

attribute_Full

名前	パス	型	説明
attribute_id	attribute_id	integer	属性 ID
attribute_value	attribute_value	string	属性値
customer_id	customer_id	integer	顧客ID
date_created	date_created	date-time	顧客属性が作成された日付
date_modified	date_modified	date-time	顧客属性が変更された日付
id	id	integer	属性値 ID

billingAddress_Base

すべての要求と応答に共通する請求先住所プロパティ。

名前	パス	型	説明
first_name	first_name	string
last_name	last_name	string
会社	company	string
street_1	street_1	string	番地 (最初の行)。
street_2	street_2	string	番地 (2 行目)。
city	city	string
状態	state	string
ジップ	zip	string	請求先住所には郵便番号を含める必要があります。 郵便番号は 2 文字以上にする必要があります。
country	country	string
country_iso2	country_iso2	string	国の 2 文字の ISO Alpha-2 コード。
phone	phone	string	受信者の電話番号。
メール	email	string	受信者のメール アドレス。

billingAddress_Full

注文を作成するために必要です。

名前	パス	型	説明
billingAddress_Base	billingAddress	billingAddress_Base	すべての要求と応答に共通する請求先住所プロパティ。
form_fields	form_fields	array of formFields

bulkPricingRule_Full

一括価格ルールの一般的なプロパティ

名前	パス	型	説明
id	id	integer	一括価格ルールの一意の ID。 読み取り専用です。
quantity_min	quantity_min	integer	このルールを満たす製品の最小包括数量。 0 以上である必要があります。 /POST で必須。
quantity_max	quantity_max	integer	このルールを満たす製品の最大包括数量。 quantity_min値より大きくする必要があります。このフィールドの値が 0 (ゼロ) の場合を除き、このルールの上限はありません。 /POST で必須。
型	type	string	行われる調整の種類。 値: price - 製品ごとの調整金額、 percent - 元の価格に対する割合としての調整、 fixed - 製品の調整済みの絶対価格。 /POST で必須。
量	amount	integer	割引には、固定のドル額またはパーセンテージを指定できます。 一定の金額の場合は整数として入力し、応答は整数として返されます。 [パーセンテージ] には、文字列形式を使用して割合を 100 で割った値を入力します。 たとえば、10%% は ".10" になります。 応答は整数として返されます。 /POST で必須。

config_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	(ファイル)ファイル アップロード オプションを使用してアップロードできるファイルの種類に関する制限の種類。 値: specific - アップロードを特定のファイルの種類に制限します。 all - すべてのファイルの種類を許可します。
file_types_supported	file_types_supported	array of string	(ファイル) file_type_option が specific に設定されている場合にアップロードできるファイルの種類。 値: images - 画像 MIME の種類 (bmp、 gif、 jpg、 jpeg、 jpe、 jif、 jfif、 jfi、 png、 wbmp、 xbm、 tiff) のアップロードを許可します。 documents - ドキュメント MIME の種類 (txt、 pdf、 rtf、 doc、 docx、 xls、 xlsxaccdb、 mdb、 one、 pps、 ppsx、 ppt、 pptx、 pub、 odt、 ods、 odp、 odg、 odf) のアップロードを許可します。 other - file_types_other 配列で定義されているファイルの種類を許可します。
file_types_other	file_types_other	array of string	(ファイル)ファイル アップロード オプションで許可されているその他のファイルの種類の一覧。
file_max_size	file_max_size	integer	(ファイル)ファイル アップロード オプションで使用できるファイルの最大サイズ。 これはサーバーによって引き続き制限されます。
text_characters_limited	text_characters_limited	boolean	(テキスト、multi_line_text)テキストまたは複数行テキスト入力の長さを検証するフラグ。
text_min_length	text_min_length	integer	(テキスト、multi_line_text)テキストまたは複数行のテキスト オプションに使用できる最小長。
text_max_length	text_max_length	integer	(テキスト、multi_line_text)テキストまたは複数行のテキスト オプションに使用できる最大長。
text_lines_limited	text_lines_limited	boolean	(multi_line_text)複数行テキスト入力で許可される行の最大数を検証するフラグ。
text_max_lines	text_max_lines	integer	(multi_line_text)複数行テキスト入力で許可される行の最大数。
number_limited	number_limited	boolean	(numbers_only_text)数値オプションの値を制限するフラグ。
number_limit_mode	number_limit_mode	string	(numbers_only_text)数値オプションに入力された値の制限の種類。
number_lowest_value	number_lowest_value	double	(numbers_only_text) number_limited が true の場合、数値オプションの最小値を指定します。
number_highest_value	number_highest_value	double	(numbers_only_text) number_limited が true の場合の数値オプションの最大値。
number_integers_only	number_integers_only	boolean	(numbers_only_text)数値オプションの入力を整数のみに制限するフラグ。
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list、product_list_with_images)リストに含まれる製品の在庫を自動的に調整するためのフラグ。
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list、product_list_with_images)オプションの製品の価格をメイン製品の価格に追加するフラグ。
product_list_shipping_calc	product_list_shipping_calc	string	(product_list、product_list_with_images)オプションの製品の重量とパッケージの寸法を出荷見積もりに組み込む方法。 値: none - 調整しないでください。 weight - 配送重量のみを使用し、 package - 重量と寸法を使用します。

coupons_Resource

名前	パス	型	説明
URL	url	string	API 要求のクーポンの URL
リソース	resource	string	クーポンのリソース

customer_Full

名前	パス	型	説明
メール	email	string	顧客の電子メール。 ユニークである必要があります。
first_name	first_name	string	顧客の名です。
last_name	last_name	string	顧客の姓です。
会社	company	string	顧客の会社。
phone	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	true場合、この顧客は次のログイン時にパスワードの変更を強制されます。
住所	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 の配列。

CustomerCollectionResponse

名前	パス	型	説明
データ	data	array of customer_Full

customerChannelIds

顧客がアクセスできるチャネル ID の配列。

名前	パス	型	説明
アイテム		integer

CustomerStoredCreditAmounts

クレジットを保存します。

名前	パス	型	説明
量	amount	float

customUrl_Full

ネットショップ上の製品のカスタム URL。

名前	パス	型	説明
URL	url	string	ネットショップの製品 URL。
is_customized	is_customized	boolean	URL が既定の状態 (BigCommerce が提供する自動割り当て URL) から変更された場合に true を返します。

formFields

読み取り専用です。 必要な住所フォーム フィールドがある場合は、API を使用して注文を作成する前に、そのフィールドを省略可能として設定する必要があります。

名前	パス	型	説明
名前	name	string	読み取り専用です。 必要な住所フォーム フィールドがある場合は、API を使用して注文を作成する前に、そのフィールドを省略可能として設定する必要があります。
value	value	string	読み取り専用です。 必要な住所フォーム フィールドがある場合は、API を使用して注文を作成する前に、そのフィールドを省略可能として設定する必要があります。

Links

コレクション全体の前の部分と次の部分の改ページ位置のリンク。

名前	パス	型	説明
先の	previous	string	応答で返された前のページへのリンク。
現在	current	string	応答で返された現在のページへのリンク。
次に	next	string	応答で返された次のページへのリンク。

metaCollection_Full

改ページ位置やコレクションの合計など、応答に関するデータ。

名前	パス	型	説明
pagination_Full	pagination	pagination_Full	改ページ位置やコレクションの合計など、応答に関するデータ。

order_Resp

応答で返される Order オブジェクト。

名前	パス	型	説明
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 (該当する場合)。 Cart API と関連付けられます。 これは READ-ONLY フィールドです。POST または PUT 要求でその値を設定または変更しないでください。
状態	status	string	状態には、(文字列、optiona) の 1 つ (Order Statuses で定義されている値) が含まれます。 この値は読み取り専用です。 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	出荷コストの税クラス。 読み取り専用の値。 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 サイト経由で送信された注文には、 www 値が含まれます。 API 経由で送信された注文は、 externalに設定されます。 読み取り専用の値。 POST または PUT を渡さないでください。
products_Resource	products	products_Resource
shippingAddress_Resource	shipping_addresses	shippingAddress_Resource
coupons_Resource	coupons	coupons_Resource
status_id	status_id	integer	注文の staus 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	チェックアウト時に顧客が入力したメッセージ (数値、省略可能) -o Order Comments ボックスに表示されます。
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 注文番号が含まれます。 それ以外の場合、値は 0されます。
external_id	external_id	string	別のシステムでの注文の ID。 たとえば、Amazon 注文の場合は Amazon 注文 ID です。このフィールドは /POST で更新できますが、/PUT を使用して注文を更新すると、400 エラーが返されます。 フィールド 'external_id' に書き込むことができません。 再試行する前に、要求から削除してください。 一度設定すると上書きできません。
external_source	external_source	string	API を介して送信または変更された注文の場合、PUT または POST 操作を使用して、必要に応じて、注文の生成に使用されるシステムを識別する値を渡すことができます。 たとえば、 POSと指定します。 それ以外の場合、値は null になります。
geoip_country	geoip_country	string	IP に基づいて、顧客が購入した国の完全な名前。
geoip_country_iso2	geoip_country_iso2	string	顧客が購入した国 (IP に基づく ISO2 形式)。
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	この注文の支払い方法。 Manual、Credit Card、cash、Test Payment Gatewayなどのいずれかです。
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 も必要です。 (Float、Float-As-String、Integer)
subtotal_inc_tax	subtotal_inc_tax	string	税を含む小計の値をオーバーライドします。 指定した場合は、フィールド subtotal_ex_tax も必要です。 (Float、Float-As-String、Integer)
TaxProviderId	tax_provider_id	TaxProviderId	BasicTaxProvider - 税は手動に設定されています。 AvaTaxProvider - これは、税プロバイダーが自動に設定されていて、注文が API によって作成されなかった場合に使用されます。 アバララに使用されます。 "" (空白) - 税プロバイダーが不明な場合。 これには、以前に API を使用して作成された従来の注文と注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。
customer_locale	customer_locale	string	顧客のロケール
total_ex_tax	total_ex_tax	string	税を除く合計の値をオーバーライドします。 指定した場合は、フィールド total_inc_tax も必要です。 (Float、Float-As-String、Integer)
total_inc_tax	total_inc_tax	string	合計の値 (税金を含む) をオーバーライドします。 指定した場合は、フィールド total_ex_tax も必要です。 (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)

orderCollection_Resp

応答で返される注文リスト。

名前	パス	型	説明
order_Resp		order_Resp	応答で返される Order オブジェクト。

orderProduct_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	1 つの製品に適用される税額。 価格税は、"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は $.50、total_taxは $1.00 になります。 手動割引が適用されている場合、total_taxは次のように計算されます: '(price_ex_tax - discount)*tax_rate=total_tax' (Float, Float-As-String, Integer)。
量	quantity	number	注文された製品の数量。
base_cost_price	base_cost_price	string	製品のコスト価格。 これは、Catalog 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	注文に適用されるクーポンの名前。
量	applied_discounts.amount	string	割引の金額。(Float、Float-As-String、Integer)。
名前	applied_discounts.name	string	クーポンの名前。 Manual Discount 手動割引を作成する場合は〘。
コード	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のエイリアス。 ネットショップで顧客に表示される製品オプションの値。
value	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	製品 variant_id。 PUT または POST。 このフィールドは、カスタム製品では使用できません。
name_customer	name_customer	string	ネットショップで顧客に表示される製品名。
name_merchant	name_merchant	string	コントロール パネルで販売者に表示される製品名。

orderProductsCollection_Resp

応答で返された製品を注文します。

名前	パス	型	説明
orderProduct_Resp		orderProduct_Resp	応答で返された製品を注文します。

orderShippingAddress_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	配送先住所のプロパティは、すべての要求と応答に共通です。

orderShippingAddressCollection_Resp

応答で返される配送先住所を注文します。

名前	パス	型	説明
orderShippingAddress_Resp		orderShippingAddress_Resp	応答で返される配送先住所を注文します。

pagination_Full

改ページ位置やコレクションの合計など、応答に関するデータ。

名前	パス	型	説明
トータル	total	integer	結果セット内のアイテムの合計数。
count	count	integer	コレクション応答内の項目の合計数。
per_page	per_page	integer	制限パラメーターによって制御される、ページごとのコレクションで返される項目の量。
current_page	current_page	integer	コレクション内で現在使用しているページ。
total_pages	total_pages	integer	コレクション内のページの合計数。
Links	links	Links	コレクション全体の前の部分と次の部分の改ページ位置のリンク。

product_Base

名前	パス	型	説明
名前	name	string	製品名。
型	type	string	製品の種類。 そのうちの 1 つ: physical - 物理ストック ユニット、 digital - デジタル ダウンロード。
sku	sku	string	ユーザー定義の製品コード/在庫保管単位 (SKU)。
説明	description	string	製品の説明。HTML 形式を含めることができます。
重量	weight	double	出荷コストを計算するときに使用できる製品の重み。 これは、ストアに設定された単位に基づいています
width	width	double	出荷コストを計算するときに使用できる製品の幅。
深さ	depth	double	出荷コストを計算するときに使用できる製品の深さ。
高さ	height	double	出荷コストを計算するときに使用できる製品の高さ。
価格	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_tracking ] フィールドを参照)。
inventory_warning_level	inventory_warning_level	integer	製品の在庫警告レベル。 製品の在庫レベルが警告レベルを下回ると、店舗所有者に通知されます。 これを有効にするには、単純な在庫追跡を有効にする必要があります ([ inventory_tracking ] フィールドを参照)。
inventory_tracking	inventory_tracking	string	製品の在庫追跡の種類。 値は、 none - 在庫レベルは追跡されません。 product - 在庫レベルは、 inventory_level フィールドと inventory_warning_level フィールドを使用して追跡されます。 variant - 在庫レベルは、独自の警告レベルと在庫レベルを維持するバリアントに基づいて追跡されます。
fixed_cost_shipping_price	fixed_cost_shipping_price	double	製品の固定出荷コスト。 定義されている場合、この値は通常の配送コスト計算ではなくチェックアウト時に使用されます。
is_free_shipping	is_free_shipping	boolean	製品に無料配送があるかどうかを示すために使用されるフラグ。 true場合、製品の出荷コストはゼロになります。
is_visible	is_visible	boolean	ストアを閲覧している顧客に製品を表示するかどうかを決定するフラグ。 trueすると、製品が表示されます。 false場合、製品はビューから非表示になります。
is_featured	is_featured	boolean	ストアを表示するときに、 featured products パネルに製品を含める必要があるかどうかを判断するフラグ。
related_products	related_products	array of integer	関連製品の ID の配列。
保証	warranty	string	製品ページに表示される保証情報。 HTML 形式を含めることができます。
bin_picking_number	bin_picking_number	string	製品の BIN ピッキング番号。
layout_file	layout_file	string	この製品カテゴリのレンダリングに使用するレイアウト テンプレート ファイル。 このフィールドは、ブループリント テーマが適用されているストアに対してのみ書き込み可能です。
upc	upc	string	ショッピング比較サイトと外部チャネル統合のフィードで使用される製品 UPC コード。
search_keywords	search_keywords	string	ストアを検索するときに製品を検索するために使用できるキーワードのコンマ区切りのリスト。
可用性	availability	string	製品の可用性。 利用可能なオプションは次のとおりです。 available - 製品はネットショップで購入できます。 disabled - 製品はネットショップに表示されますが、購入することはできません。 preorder - 製品は予約注文用に一覧表示されます。
availability_description	availability_description	string	チェックアウト ページの製品タイトルの下に表示される可用性テキスト。 "通常は 24 時間以内に出荷されます" など、この製品の発送に通常かかる時間を顧客に伝えます。
gift_wrapping_options_type	gift_wrapping_options_type	string	ギフトラッピングオプションの種類。 値: any - ストア内のギフト ラッピング オプションを許可します。 none - 製品のギフト ラッピングを禁止します。 list - gift_wrapping_options_list フィールドに ID の一覧を指定します。
gift_wrapping_options_list	gift_wrapping_options_list	array of integer	ギフト ラッピング オプション ID の一覧。
sort_order	sort_order	integer	カテゴリ ページおよび検索結果の製品リストに含まれる場合は、この製品を優先します。 整数を小さくすると、結果の上部に積が近くなります。
condition	condition	string	製品の条件。 is_condition_shown フィールドの値がtrue場合、製品ページに表示されます。 使用可能な値: New、 Used、 Refurbished。
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	予約購入のリリース日。 事前注文を受け付ける製品の可用性を設定する方法の詳細については、 availability フィールドを参照してください。
preorder_message	preorder_message	string	製品ページに表示するカスタムの予定日メッセージ。 未定義の場合、メッセージは既定でストア全体の設定になります。 %%DATE%%プレースホルダーを含めることができます。このプレースホルダーはリリース日に置き換えることができます。
is_preorder_only	is_preorder_only	boolean	true に設定すると、予約注文リリース日に予約注文の状態が自動的に削除されます。 false に設定すると、リリース日に予約注文の状態は削除 されません 。 コントロール パネルまたは API を使用して、手動で変更する必要があります。 API セットを使用すると、availableにavailability。
is_price_hidden	is_price_hidden	boolean	False 既定では、この製品の価格を製品ページに表示する必要があることを示します。 trueに設定すると、価格は非表示になります。 (注: is_price_hidden を trueに正常に設定するには、 availability 値を disabledする必要があります)。
price_hidden_label	price_hidden_label	string	既定では、空の文字列です。 is_price_hiddenがtrueの場合、価格の代わりにprice_hidden_labelの値が表示されます。 (注: is_price_hidden が true に設定された空でない文字列値を正常に設定するには、 availability 値を disabledする必要があります)。
customUrl_Full	custom_url	customUrl_Full	ネットショップ上の製品のカスタム URL。
open_graph_type	open_graph_type	string	製品の種類。既定値は product。
open_graph_title	open_graph_title	string	製品のタイトルが指定されていない場合は、代わりに製品名が使用されます。
open_graph_description	open_graph_description	string	製品に使用する説明 (指定されていない場合)、代わりにmeta_descriptionが使用されます。
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 要求中に作成できます。 ブランドが既に存在する場合は、製品が追加されます。 そうでない場合は、ブランドが作成され、製品が追加されます。 brand_nameを使用すると、あいまい一致が実行され、ブランドが追加されます。 eg. 「共通の良い」と「共通の良い」は同じです。 ブランド名は、製品の応答の一部として返されません。 brand_idのみ。
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	videos	array of productVideo_Full

product_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	単純な製品に関連付けられている基本バリアントの一意識別子。 この値は、複雑な製品に対して null されます。
calculated_price	calculated_price	double	ネットショップで見た製品の価格。 設定されている場合はsale_price、sale_priceがない場合はpriceと等しくなります。
options	options	array of productOption_Base
修飾子	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

ProductCollectionResponse

名前	パス	型	説明
データ	data	array of product_Full
metaCollection_Full	meta	metaCollection_Full	改ページ位置やコレクションの合計など、応答に関するデータ。

productCustomField_Put

製品に関連付けられているユーザー設定フィールドを取得します。 これにより、書籍の ISBN や DVD のリリース日など、製品のページに表示される追加情報を指定できます。

名前	パス	型	説明
id	id	integer	ユーザー設定フィールドの一意の数値 ID。は順番にインクリメントされます。 /PUT 要求の既存のユーザー設定フィールドを更新するために必要です。 Read-Only
名前	name	string	ネットショップや注文などに表示されるフィールドの名前。/POST に必須
value	value	string	ネットショップや注文などに表示されるフィールドの名前。/POST に必須

productImage_Full

ProductImage の一般的なプロパティ。

名前	パス	型	説明
image_file	image_file	string	BigCommerce にアップロードされた元のイメージ ファイルへのローカル パス。
is_thumbnail	is_thumbnail	boolean	画像が製品のサムネイルとして使用されているかどうかを識別するためのフラグ。
sort_order	sort_order	integer	製品ページに画像が表示される順序。 整数が大きいほど、画像の優先度が低くなります。 更新時に、イメージの優先度が低い場合、イメージの新しいsort_order値と同じか大きいsort_orderを持つすべてのイメージのsort_orderが並べ替えられます。
説明	description	string	イメージの説明。
image_url	image_url	string	プロトコルを含む完全修飾 URL パスである必要があります。 ファイルあたり 8 MB の制限。
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	製品イメージが変更された日付。

productModifier_Base

共通修飾子プロパティ。

名前	パス	型	説明
型	type	string	BigCommerce API。ネットショップでの表示方法を決定します。 使用できる値: date、 checkbox、 file、 text、 multi_line_text、 numbers_only_text、 radio_buttons、 rectangles、 dropdown、 product_list、 product_list_with_images、 swatch。 /POST で必須。
required	required	boolean	チェックアウト時にこのモディファーが必要かどうか。 /POST で必須。
sort_order	sort_order	integer	製品の詳細ページに修飾子が表示される注文。
config_Full	config	config_Full	オプション構成の値は、作成された修飾子によって異なる場合があります。
display_name	display_name	string	ネットショップに表示されるオプションの名前。

productModifier_Full

製品修飾子

名前	パス	型	説明
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

productModifierOptionValue_Full

Product Modifer option_value。

名前	パス	型	説明
is_default	is_default	boolean	ネットショップの既定値として値を事前選択するためのフラグ。 このフィールドは、見本のオプション/修飾子ではサポートされていません。
ラベル	label	string	ネットショップの値を識別するテキスト表示。 /POST で必須。
sort_order	sort_order	integer	値が製品ページに表示される順序。 /POST で必須。
value_data	value_data	object	値が関連付けられているオプションまたは修飾子の種類に基づいて、値を記述する追加データ。 swatch型オプションでは、最大 3 つの 16 進数カラー キーを持つcolorsの配列、またはプロトコルを含む完全なイメージ URL パスであるimage_urlを受け取ることができます。 product list型オプションには、product_idが必要です。 checkbox型オプションでは、チェック状態と見なされる値を決定するために、checked_valueと呼ばれるブール型フラグが必要です。 使用可能なデータがない場合は、 nullを返します。
adjusters_Full	adjusters	adjusters_Full
id	id	integer	値の一意の数値 ID。は順番にインクリメントされます。
option_id	option_id	integer

productOption_Base

一般的なオプションのプロパティ。

名前	パス	型	説明
id	id	integer	オプションの一意の数値 ID は、順番にインクリメントされます。
product_id	product_id	integer	オプションが属する製品の一意の数値 ID。
display_name	display_name	string	ネットショップに表示されるオプションの名前。
型	type	string	ネットショップでの表示方法を決定するオプションの種類。 使用可能な値: radio_buttons、 rectangles、 dropdown、 product_list、 product_list_with_images、 swatch。 以前の v2 API の値は、RB = radio_buttons、RT = 四角形、S = ドロップダウン、P = product_list、PI = product_list_with_images、CS = 見本です。
productOptionConfig_Full	config	productOptionConfig_Full	オプション構成の値は、作成された修飾子によって異なる場合があります。
sort_order	sort_order	integer	ネットショップにオプションが表示される順序。
productOptionOptionValue_Full	option_values	productOptionOptionValue_Full	製品オプションの option_value。

productOptionConfig_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	(ファイル)ファイル アップロード オプションを使用してアップロードできるファイルの種類に関する制限の種類。 値: specific - アップロードを特定のファイルの種類に制限します。 all - すべてのファイルの種類を許可します。
file_types_supported	file_types_supported	array of string	(ファイル) file_type_option が specific に設定されている場合にアップロードできるファイルの種類。 値: images - 画像 MIME の種類 (bmp、 gif、 jpg、 jpeg、 jpe、 jif、 jfif、 jfi、 png、 wbmp、 xbm、 tiff) のアップロードを許可します。 documents - ドキュメント MIME の種類 (txt、 pdf、 rtf、 doc、 docx、 xls、 xlsxaccdb、 mdb、 one、 pps、 ppsx、 ppt、 pptx、 pub、 odt、 ods、 odp、 odg、 odf) のアップロードを許可します。 other - file_types_other 配列で定義されているファイルの種類を許可します。
file_types_other	file_types_other	array of string	(ファイル)ファイル アップロード オプションで許可されているその他のファイルの種類の一覧。
file_max_size	file_max_size	integer	(ファイル)ファイル アップロード オプションで使用できるファイルの最大サイズ。 これはサーバーによって引き続き制限されます。
text_characters_limited	text_characters_limited	boolean	(テキスト、multi_line_text)テキストまたは複数行テキスト入力の長さを検証するフラグ。
text_min_length	text_min_length	integer	(テキスト、multi_line_text)テキストまたは複数行のテキスト オプションに使用できる最小長。
text_max_length	text_max_length	integer	(テキスト、multi_line_text)テキストまたは複数行のテキスト オプションに使用できる最大長。
text_lines_limited	text_lines_limited	boolean	(multi_line_text)複数行テキスト入力で許可される行の最大数を検証するフラグ。
text_max_lines	text_max_lines	integer	(multi_line_text)複数行テキスト入力で許可される行の最大数。
number_limited	number_limited	boolean	(numbers_only_text)数値オプションの値を制限するフラグ。
number_limit_mode	number_limit_mode	string	(numbers_only_text)数値オプションに入力された値の制限の種類。
number_lowest_value	number_lowest_value	double	(numbers_only_text) number_limited が true の場合、数値オプションの最小値を指定します。
number_highest_value	number_highest_value	double	(numbers_only_text) number_limited が true の場合の数値オプションの最大値。
number_integers_only	number_integers_only	boolean	(numbers_only_text)数値オプションの入力を整数のみに制限するフラグ。
product_list_adjusts_inventory	product_list_adjusts_inventory	boolean	(product_list、product_list_with_images)リストに含まれる製品の在庫を自動的に調整するためのフラグ。
product_list_adjusts_pricing	product_list_adjusts_pricing	boolean	(product_list、product_list_with_images)オプションの製品の価格をメイン製品の価格に追加するフラグ。
product_list_shipping_calc	product_list_shipping_calc	string	(product_list、product_list_with_images)オプションの製品の重量とパッケージの寸法を出荷見積もりに組み込む方法。 値: none - 調整しないでください。 weight - 配送重量のみを使用し、 package - 重量と寸法を使用します。

productOptionOptionValue_Full

製品オプションの option_value。

名前	パス	型	説明
is_default	is_default	boolean	ネットショップの既定値として値を事前選択するためのフラグ。 このフィールドは、見本のオプション/修飾子ではサポートされていません。
ラベル	label	string	ネットショップの値を識別するテキスト表示。 /POST で必須。
sort_order	sort_order	integer	値が製品ページに表示される順序。 /POST で必須。
value_data	value_data	object	値が関連付けられているオプションまたは修飾子の種類に基づいて、値を記述する追加データ。 swatch型オプションでは、最大 3 つの 16 進数カラー キーを持つcolorsの配列、またはプロトコルを含む完全なイメージ URL パスであるimage_urlを受け取ることができます。 product list型オプションには、product_idが必要です。 checkbox型オプションでは、チェック状態と見なされる値を決定するために、checked_valueと呼ばれるブール型フラグが必要です。 使用可能なデータがない場合は、 nullを返します。
id	id	integer	値の一意の数値 ID。は順番にインクリメントされます。

ProductResponse

名前	パス	型	説明
product_Full	data	product_Full
メタ	meta	object	空のメタ オブジェクト。は後で使用できます。

products_Resource

名前	パス	型	説明
URL	url	string
リソース	resource	string

productVariant_Full

名前	パス	型	説明
cost_price	cost_price	double	バリアントの原価価格。 価格表価格の影響を受けません。
価格	price	double	ネットショップでのこのバリアントの基本価格。 価格表 ID を使用する場合は、価格表の値が使用されます。 価格表 ID が使用されておらず、この値が nullされている場合は、基本価格として製品の既定の価格 ([製品リソースの price ] フィールドで設定) が使用されます。
sale_price	sale_price	double	ネットショップでのこのバリアントの販売価格。 価格表 ID を使用する場合は、価格表の値が使用されます。 価格表 ID が使用されておらず、この値が null の場合、製品の販売価格 (製品リソースの [ price ] フィールドで設定) が販売価格として使用されます。
retail_price	retail_price	double	ネットショップでのこのバリアントの小売価格。 価格表 ID を使用する場合は、価格表の値が使用されます。 価格表 ID が使用されておらず、この値が null の場合、製品の小売価格 (製品リソースの [ price ] フィールドで設定) が小売価格として使用されます。
重量	weight	double	ネットショップでのこのバリアントの基本重み。 この値が null の場合、製品の既定の重み (Product リソースの重みフィールドに設定) が基本重みとして使用されます。
width	width	double	バリアントの幅。配送料を計算するときに使用できます。 この値が nullの場合、製品の既定の幅 (Product リソースの [ width ] フィールドに設定) が基本幅として使用されます。
高さ	height	double	バリアントの高さ。これは、配送料を計算するときに使用できます。 この値が nullの場合、製品の既定の高さ (Product リソースの [ height ] フィールドで設定) が基本の高さとして使用されます。
深さ	depth	double	バリアントの深さ。これは、配送料を計算するときに使用できます。 この値が nullの場合、製品の既定の深度 (Product リソースの [ depth ] フィールドに設定) が基本深度として使用されます。
is_free_shipping	is_free_shipping	boolean	バリアントに無料配送があるかどうかを示すために使用されるフラグ。 true場合、バリアントの出荷コストは 0 になります。
fixed_cost_shipping_price	fixed_cost_shipping_price	double	バリアントの固定出荷コスト。 定義されている場合、この値は通常の配送コスト計算ではなくチェックアウト時に使用されます。
purchasing_disabled	purchasing_disabled	boolean	true場合、このバリエーションはネットショップでは購入できません。
purchasing_disabled_message	purchasing_disabled_message	string	purchasing_disabledがtrueされている場合、バリアントが選択されている場合、このメッセージはネットショップに表示されます。
upc	upc	string	ショッピング比較サイトと外部チャネル統合のフィードで使用される UPC コード。
inventory_level	inventory_level	integer	バリアントの在庫レベル。製品のinventory_trackingが variantに設定されている場合に使用されます。
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	ネットショップに表示されるバリアントの価格。 この価格では、 sale_price と、このバリアントに適用される価格調整ルールが考慮されます。
calculated_weight	calculated_weight	double

productVariantOptionValue_Full

名前	パス	型	説明
option_display_name	option_display_name	string	オプションの名前。
ラベル	label	string	オプション値のラベル。
id	id	integer	option_value 身分証明書。
option_id	option_id	integer	option 身分証明書。

productVideo_Base

製品にビデオを作成するための POST のモデル。

名前	パス	型	説明
title	title	string	ビデオのタイトル。 空白のままにすると、ホスト サイト上のデータに従って入力されます。
説明	description	string	ビデオの説明。 空白のままにすると、ホスト サイト上のデータに従って入力されます。
sort_order	sort_order	integer	製品ページにビデオが表示される順序。 整数が大きいほど、ビデオの優先度が低くなります。 更新時にビデオの優先度が低い場合、ビデオの新しいsort_order値と同じか大きいsort_orderを持つすべてのビデオのsort_orderが並べ替えられます。
型	type	string	ビデオの種類 (ホスト サイトの短い名前)。
video_id	video_id	string	ホスト サイト上のビデオの ID。

productVideo_Full

製品ビデオ モデル。

名前	パス	型	説明
productVideo_Base	schema	productVideo_Base	製品にビデオを作成するための POST のモデル。
id	id	integer	製品ビデオの一意の数値 ID。は順番にインクリメントされます。
product_id	product_id	integer	イメージが関連付けられている製品の一意の数値識別子。
length	length	string	ビデオの長さ。 これは、ホスト サイト上のデータに従って入力されます。

PurchasingDisabled

名前	パス	型	説明
状態	status	boolean	ネットショップで選択したときに修飾子の値が購入を無効にするかどうかを示すフラグ。 これは、特定の修飾子値を一時的に無効にするために使用できます。
メッセージ	message	string	購入が無効な状態が trueされたときにネットショップに表示されるメッセージ。

shippingAddress_Base

配送先住所のプロパティは、すべての要求と応答に共通です。

名前	パス	型	説明
first_name	first_name	string
last_name	last_name	string
会社	company	string
street_1	street_1	string	番地 (最初の行)。
street_2	street_2	string	番地 (2 行目)。
city	city	string
状態	state	string
ジップ	zip	string	文字列としての郵便番号。
country	country	string
country_iso2	country_iso2	string	国の 2 文字の ISO Alpha-2 コード。
phone	phone	string	受信者の電話番号。
メール	email	string	受信者のメール アドレス。
shipping_method	shipping_method	string	顧客が選択した BigCommerce 出荷モジュールを識別するテキスト コード。

shippingAddress_Resource

名前	パス	型	説明
URL	url	string	API 要求の配送先住所の URL
リソース	resource	string

shippingQuotes_Resource

名前	パス	型	説明
URL	url	string	この URL は、見積もりを発送するために 204 を返します。 配送見積もりを返すには:'/shipping_addresses/shipping_address_id/shipping_quotes'。
リソース	resource	string	この URL は、見積もりを発送するために 204 を返します。 配送見積もりを返すには:'/shipping_addresses/shipping_address_id/shipping_quotes'。

PaymentStatus

読み取り専用の値。 POST または PUT 操作では、この値を設定または変更しないでください。

読み取り専用の値。 POST または PUT 操作では、この値を設定または変更しないでください。

PaymentStatus

string

PaymentMethod

この注文の支払い方法。 Manual、Credit Card、cash、Test Payment Gatewayなどのいずれかです。

この注文の支払い方法。 Manual、Credit Card、cash、Test Payment Gatewayなどのいずれかです。

PaymentMethod

string

TaxProviderId

BasicTaxProvider - 税は手動に設定されています。

AvaTaxProvider - これは、税プロバイダーが自動に設定されていて、注文が API によって作成されなかった場合に使用されます。 アバララに使用されます。

"" (空白) - 税プロバイダーが不明な場合。 これには、以前に API を使用して作成された従来の注文と注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。

BasicTaxProvider - 税は手動に設定されています。

AvaTaxProvider - これは、税プロバイダーが自動に設定されていて、注文が API によって作成されなかった場合に使用されます。 アバララに使用されます。

"" (空白) - 税プロバイダーが不明な場合。 これには、以前に API を使用して作成された従来の注文と注文が含まれます。 これは、POST を使用して注文を作成するときに設定できます。

TaxProviderId

string