通过


Adobe Commerce (预览版)

Adobe Commerce 由 Magento 提供支持,提供电子商务平台和云解决方案。 连接到 Adobe Commerce 以检索订单并发送更新。

此连接器在以下产品和区域中可用:

Service Class 区域
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部(DoD)
联系人
名称 Microsoft Dynamics
URL https://aka.ms/iomsupport
Email iomdri@microsoft.com
连接器元数据
发布者 Microsoft
网站 https://business.adobe.com/products/magento/magento-commerce.html
隐私策略 https://www.adobe.com/privacy/policy.html
类别 商业;网站

Adobe Commerce 连接器已专门开发,用于 Dynamics 365 智能订单管理提供商集成。

先决条件

Adobe Commerce 云帐户已注册并部署网站。

如何获取凭据

访问令牌(集成令牌类型):

  • 登录到 Adobe Commerce 网站管理员
  • 单击“系统 > 扩展 > 集成”以显示“集成”页。
  • 单击“添加新集成”以显示“新建集成”页。
  • 在“名称”字段中输入集成的唯一名称,然后在“密码”字段中输入管理员密码。 让其他所有字段保留为空。
  • 单击“API”选项卡。选择集成可以访问的 Adobe Commerce 资源。 可以选择所有资源,或选择自定义列表。
  • 单击“保存”保存更改并返回到“集成”页。
  • 单击与新创建的集成相对应的网格中的“激活”链接。
  • 单击“允许”,然后打开一个对话框。
  • 从此对话框中找到“访问令牌”。

注意:主机 URL 是 Adobe Commerce 网站的主机名

连接器入门

按照以下步骤 https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider 启用 Adobe Commerce Provider。

已知问题和限制

此连接器专为 Dynamics 365 Intelligent Order Management 的 Adobe Commerce Provider 集成而开发。 对 Dynamics 365 智能订单管理之外的用例的支持将受到限制。

创建连接

连接器支持以下身份验证类型:

默认 用于创建连接的参数。 所有区域 不可共享

违约

适用:所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。

名称 类型 说明 必需
API 密钥 securestring 此 API 的 API 密钥 真 实
存储主机 URL 字符串 Adobe Commerce Store 主机 URL 真 实

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

创建或更新订单

创建或更新指定的订单。

取消订单

取消指定的订单。

按客户 ID 获取客户

按客户 ID 获取客户。

获取所有订单

列出与指定搜索条件匹配的订单。

创建或更新订单

创建或更新指定的订单。

返回

取消订单

取消指定的订单。

参数

名称 密钥 必需 类型 说明
唯一订单 ID
id True string

唯一订单 ID。

返回

响应
boolean

按客户 ID 获取客户

按客户 ID 获取客户。

参数

名称 密钥 必需 类型 说明
客户 ID
customerId True string

按 ID 获取客户。

返回

获取所有订单

列出与指定搜索条件匹配的订单。

参数

名称 密钥 必需 类型 说明
当前页
searchCriteria[currentPage] integer

返回当前页。

筛选条件
searchCriteria[filter_groups][0][filters][0][condition_type] string

订单筛选的条件。

对字段进行筛选
searchCriteria[filter_groups][0][filters][0][field] string

订单筛选器的字段。

筛选值
searchCriteria[filter_groups][0][filters][0][value] string

订单筛选器的值。

页面大小
searchCriteria[pageSize] integer

每页记录总数。

排序方向
searchCriteria[sortOrders][0][direction] string

按 asc 或 desc 排序。

排序字段
searchCriteria[sortOrders][0][field] string

对字段上的订单进行排序。

返回

名称 路径 类型 说明
物品
items array of itemsHeader
filter_groups
search_criteria.filter_groups array of object
filters
search_criteria.filter_groups.filters array of object
字段
search_criteria.filter_groups.filters.field string
value
search_criteria.filter_groups.filters.value string
condition_type
search_criteria.filter_groups.filters.condition_type string
sort_orders
search_criteria.sort_orders array of object
字段
search_criteria.sort_orders.field string
方向
search_criteria.sort_orders.direction string
page_size
search_criteria.page_size integer
current_page
search_criteria.current_page integer
total_count
total_count integer

定义

billing_address

名称 路径 类型 说明
address_type
address_type string
city
city string
company
company string
country_id
country_id string
customer_address_id
customer_address_id integer
customer_id
customer_id integer

客户 ID。

电子邮件
email string
entity_id
entity_id integer

实体 ID。

传真
fax string
firstname
firstname string
姓氏
lastname string
middlename
middlename string
parent_id
parent_id integer
邮政编码
postcode string
prefix
prefix string
区域
region string
region_code
region_code string
region_id
region_id integer
街道
street array of string
后缀
suffix string
telephone
telephone string
vat_id
vat_id string
vat_is_valid
vat_is_valid integer
vat_request_date
vat_request_date string
vat_request_id
vat_request_id string
vat_request_success
vat_request_success integer
vertex_vat_country_code
extension_attributes.vertex_vat_country_code string

付款

名称 路径 类型 说明
account_status
account_status string
additional_data
additional_data string
additional_information
additional_information array of string
address_status
address_status string
amount_authorized
amount_authorized float
amount_canceled
amount_canceled float
amount_ordered
amount_ordered float
amount_paid
amount_paid float
amount_refunded
amount_refunded float

退款金额。

anet_trans_method
anet_trans_method string
base_amount_authorized
base_amount_authorized float
base_amount_canceled
base_amount_canceled float
base_amount_ordered
base_amount_ordered float
base_amount_paid
base_amount_paid float
base_amount_paid_online
base_amount_paid_online float
base_amount_refunded
base_amount_refunded float

基本金额已退款。

base_amount_refunded_online
base_amount_refunded_online float
base_shipping_amount
base_shipping_amount float

基本发货金额。

base_shipping_captured
base_shipping_captured float
base_shipping_refunded
base_shipping_refunded float
cc_approval
cc_approval string
cc_avs_status
cc_avs_status string
cc_cid_status
cc_cid_status string
cc_debug_request_body
cc_debug_request_body string
cc_debug_response_body
cc_debug_response_body string
cc_debug_response_serialized
cc_debug_response_serialized string
cc_exp_month
cc_exp_month string
cc_exp_year
cc_exp_year string
cc_last4
cc_last4 string
cc_number_enc
cc_number_enc string
cc_owner
cc_owner string
cc_secure_verify
cc_secure_verify string
cc_ss_issue
cc_ss_issue string
cc_ss_start_month
cc_ss_start_month string
cc_ss_start_year
cc_ss_start_year string
cc_status
cc_status string
cc_status_description
cc_status_description string
cc_trans_id
cc_trans_id string
cc_type
cc_type string
echeck_account_name
echeck_account_name string
echeck_account_type
echeck_account_type string
echeck_bank_name
echeck_bank_name string
echeck_routing_number
echeck_routing_number string
echeck_type
echeck_type string
entity_id
entity_id integer

实体 ID。

last_trans_id
last_trans_id string
方法
method string
parent_id
parent_id integer
po_number
po_number string
protection_eligibility
protection_eligibility string
quote_payment_id
quote_payment_id integer
shipping_amount
shipping_amount float

发货金额。

shipping_captured
shipping_captured float
shipping_refunded
shipping_refunded float

发货退款。

notification_message
extension_attributes.notification_message string
entity_id
extension_attributes.vault_payment_token.entity_id integer

实体 ID。

customer_id
extension_attributes.vault_payment_token.customer_id integer

客户 ID。

public_hash
extension_attributes.vault_payment_token.public_hash string
payment_method_code
extension_attributes.vault_payment_token.payment_method_code string
类型
extension_attributes.vault_payment_token.type string
创建时间
extension_attributes.vault_payment_token.created_at string

创建位置。

过期时间
extension_attributes.vault_payment_token.expires_at string
gateway_token
extension_attributes.vault_payment_token.gateway_token string
token_details
extension_attributes.vault_payment_token.token_details string
is_active
extension_attributes.vault_payment_token.is_active boolean
is_visible
extension_attributes.vault_payment_token.is_visible boolean

status_histories

名称 路径 类型 说明
注释
comment string
创建时间
created_at string

创建位置。

entity_id
entity_id integer

实体 ID。

entity_name
entity_name string
is_customer_notified
is_customer_notified integer
is_visible_on_front
is_visible_on_front integer
parent_id
parent_id integer
状态
status string

订单状态。

extension_attributes
extension_attributes object

extension_attributes

名称 路径 类型 说明
payment_additional_info
payment_additional_info array of object
关键值
payment_additional_info.key string
value
payment_additional_info.value string
订单编号
company_order_attributes.order_id float

订单 ID。

company_id
company_order_attributes.company_id float
公司名称
company_order_attributes.company_name string
extension_attributes
company_order_attributes.extension_attributes object
applied_taxes
applied_taxes array of object
代码
applied_taxes.code string
标题
applied_taxes.title string
百分比
applied_taxes.percent float
amount
applied_taxes.amount float
base_amount
applied_taxes.base_amount float
applied_taxes.extension_attributes.rates array of object
物品
applied_taxes.extension_attributes.rates object
item_applied_taxes
item_applied_taxes array of object
类型
item_applied_taxes.type string
item_id
item_applied_taxes.item_id float

项 ID。

associated_item_id
item_applied_taxes.associated_item_id float
applied_taxes
item_applied_taxes.applied_taxes array of object
物品
item_applied_taxes.applied_taxes object
extension_attributes
item_applied_taxes.extension_attributes object
converting_from_quote
converting_from_quote boolean
base_customer_balance_amount
base_customer_balance_amount float
customer_balance_amount
customer_balance_amount float
base_customer_balance_invoiced
base_customer_balance_invoiced float
customer_balance_invoiced
customer_balance_invoiced float
base_customer_balance_refunded
base_customer_balance_refunded float
customer_balance_refunded
customer_balance_refunded float
base_customer_balance_total_refunded
base_customer_balance_total_refunded float
customer_balance_total_refunded
customer_balance_total_refunded float
gift_cards
gift_cards array of object
id
gift_cards.id float
代码
gift_cards.code string
amount
gift_cards.amount float
base_amount
gift_cards.base_amount float
base_gift_cards_amount
base_gift_cards_amount float
gift_cards_amount
gift_cards_amount float
base_gift_cards_invoiced
base_gift_cards_invoiced float
gift_cards_invoiced
gift_cards_invoiced float
base_gift_cards_refunded
base_gift_cards_refunded float
gift_cards_refunded
gift_cards_refunded float
gift_message_id
gift_message.gift_message_id float
customer_id
gift_message.customer_id float

客户 ID。

发送方
gift_message.sender string
收件人
gift_message.recipient string
消息
gift_message.message string
entity_id
gift_message.extension_attributes.entity_id string

实体 ID。

entity_type
gift_message.extension_attributes.entity_type string
wrapping_id
gift_message.extension_attributes.wrapping_id float
wrapping_allow_gift_receipt
gift_message.extension_attributes.wrapping_allow_gift_receipt boolean
wrapping_add_printed_card
gift_message.extension_attributes.wrapping_add_printed_card boolean
gw_id
gw_id string

Gw id。

gw_allow_gift_receipt
gw_allow_gift_receipt string
gw_add_card
gw_add_card string
gw_base_price
gw_base_price string

Gw 基价。

gw_price
gw_price string

格温价格。

gw_items_base_price
gw_items_base_price string
gw_items_price
gw_items_price string
gw_card_base_price
gw_card_base_price string
gw_card_price
gw_card_price string
gw_base_tax_amount
gw_base_tax_amount string

Gw 基税金额。

gw_tax_amount
gw_tax_amount string

Gw 基税金额。

gw_items_base_tax_amount
gw_items_base_tax_amount string
gw_items_tax_amount
gw_items_tax_amount string
gw_card_base_tax_amount
gw_card_base_tax_amount string
gw_card_tax_amount
gw_card_tax_amount string
gw_base_price_incl_tax
gw_base_price_incl_tax string
gw_price_incl_tax
gw_price_incl_tax string
gw_items_base_price_incl_tax
gw_items_base_price_incl_tax string
gw_items_price_incl_tax
gw_items_price_incl_tax string
gw_card_base_price_incl_tax
gw_card_base_price_incl_tax string
gw_card_price_incl_tax
gw_card_price_incl_tax string
gw_base_price_invoiced
gw_base_price_invoiced string

Gw 基价开票。

gw_price_invoiced
gw_price_invoiced string

Gw 价格已开票。

gw_items_base_price_invoiced
gw_items_base_price_invoiced string

已开票的 Gw 项目基准价格。

gw_items_price_invoiced
gw_items_price_invoiced string

已开票的 Gw 项目基准价格。

gw_card_base_price_invoiced
gw_card_base_price_invoiced string

已开票的 Gw 项目基准价格。

gw_card_price_invoiced
gw_card_price_invoiced string

已开票的 Gw 项目基准价格。

gw_base_tax_amount_invoiced
gw_base_tax_amount_invoiced string

已开票的 Gw 项目基准价格。

gw_tax_amount_invoiced
gw_tax_amount_invoiced string

已开票的 Gw 项目基准价格。

gw_items_base_tax_invoiced
gw_items_base_tax_invoiced string

已开票的 Gw 项目基准价格。

gw_items_tax_invoiced
gw_items_tax_invoiced string

已开票的 Gw 项目基准价格。

gw_card_base_tax_invoiced
gw_card_base_tax_invoiced string

已开票的 Gw 项目基准价格。

gw_card_tax_invoiced
gw_card_tax_invoiced string

已开票的 Gw 项目基准价格。

gw_base_price_refunded
gw_base_price_refunded string

Gw 项目基本价格已退款。

gw_price_refunded
gw_price_refunded string

Gw 项目基本价格已退款。

gw_items_base_price_refunded
gw_items_base_price_refunded string

Gw 项目基本价格已退款。

gw_items_price_refunded
gw_items_price_refunded string

Gw 项目基本价格已退款。

gw_card_base_price_refunded
gw_card_base_price_refunded string

Gw 项目基本价格已退款。

gw_card_price_refunded
gw_card_price_refunded string

Gw 项目基本价格已退款。

gw_base_tax_amount_refunded
gw_base_tax_amount_refunded string

Gw 项目基本价格已退款。

gw_tax_amount_refunded
gw_tax_amount_refunded string

Gw 项目基本价格已退款。

gw_items_base_tax_refunded
gw_items_base_tax_refunded string

Gw 项目基本价格已退款。

gw_items_tax_refunded
gw_items_tax_refunded string

Gw 项目基本价格已退款。

gw_card_base_tax_refunded
gw_card_base_tax_refunded string

Gw 卡退税。

gw_card_tax_refunded
gw_card_tax_refunded string

Gw 卡退税。

reward_points_balance
reward_points_balance float

Gw 卡退税。

reward_currency_amount
reward_currency_amount float

奖励货币金额。

base_reward_currency_amount
base_reward_currency_amount float

奖励货币金额。

amazon_order_reference_id
amazon_order_reference_id.amazon_order_reference_id string
订单编号
amazon_order_reference_id.order_id float

订单 ID。

物品

名称 路径 类型 说明
base_amount_refunded
base_amount_refunded float

基本金额已退款。

base_cost
base_cost float

基本成本。

base_discount_amount
base_discount_amount float

基本折扣金额。

base_discount_invoiced
base_discount_invoiced float

已开票的基本折扣。

base_discount_refunded
base_discount_refunded float

基本折扣已退款。

base_original_price
base_original_price float

基本价格。

base_price
base_price float

基本价格。

base_price_incl_tax
base_price_incl_tax float

基本价格税。

base_row_invoiced
base_row_invoiced float

已开票的基本行。

base_row_total
base_row_total float

基本行总数。

base_row_total_incl_tax
base_row_total_incl_tax float

基本行总税。

base_tax_amount
base_tax_amount float

基本税额。

base_tax_before_discount
base_tax_before_discount float

折扣前的基本税。

base_tax_invoiced
base_tax_invoiced float

已开票的基本税。

base_tax_refunded
base_tax_refunded float

基本退税。

创建时间
created_at string

创建位置。

说明
description string
discount_amount
discount_amount float

折扣金额。

discount_invoiced
discount_invoiced float

已开票折扣。

discount_percent
discount_percent float

已开票折扣。

discount_refunded
discount_refunded float

折扣退款。

event_id
event_id integer

已开票折扣。

ext_order_item_id
ext_order_item_id string

已开票折扣。

free_shipping
free_shipping integer

免费送货。

is_qty_decimal
is_qty_decimal integer

是 qty decimal。

is_virtual
is_virtual integer

是虚拟的。

item_id
item_id integer

项 ID。

locked_do_invoice
locked_do_invoice integer

锁定的发票。

locked_do_ship
locked_do_ship integer

锁定的发票。

名字
name string

的名称。

no_discount
no_discount integer

无折扣。

订单编号
order_id integer

订单 ID。

original_price
original_price float

原始价格。

parent_item_id
parent_item_id integer

父项 ID。

价格
price float

价格项。

price_incl_tax
price_incl_tax float

价格包括税。

product_id
product_id float

产品 ID。

product_type
product_type string

产品类型。

qty_backordered
qty_backordered float

Qty backordered.

qty_canceled
qty_canceled float

已取消季度。

qty_invoiced
qty_invoiced float

已开票数量。

qty_ordered
qty_ordered float

按数量排序。

qty_refunded
qty_refunded float

已退款。

qty_returned
qty_returned float

返回的数量。

qty_shipped
qty_shipped float

季度发货。

quote_item_id
quote_item_id integer

引号项 ID。

row_invoiced
row_invoiced float

已开票行。

row_total
row_total float

行总计。

row_total_incl_tax
row_total_incl_tax float

包括税款在内的行总计。

row_weight
row_weight float

行粗细。

sku
sku string

项的 SKU。

store_id
store_id integer

存储 ID。

tax_amount
tax_amount float

税额。

tax_before_discount
tax_before_discount float
tax_canceled
tax_canceled float

已取消税款。

tax_invoiced
tax_invoiced float

已开票税。

tax_percent
tax_percent float
tax_refunded
tax_refunded float

退款。

updated_at
updated_at string
weee_tax_applied
weee_tax_applied string

应用 Wee tax。

weee_tax_applied_amount
weee_tax_applied_amount float

Wee tax applied amount.

weee_tax_applied_row_amount
weee_tax_applied_row_amount float

Wee tax applied amount.

weee_tax_disposition
weee_tax_disposition float

Wee 税务处置。

weee_tax_row_disposition
weee_tax_row_disposition float

Wee 税务处置。

weight
weight float

项权重。

parent_item
parent_item object

父项。

custom_options
product_option.extension_attributes.custom_options array of object
物品
product_option.extension_attributes.custom_options object
bundle_options
product_option.extension_attributes.bundle_options array of object
物品
product_option.extension_attributes.bundle_options object
downloadable_links
product_option.extension_attributes.downloadable_option.downloadable_links array of object
物品
product_option.extension_attributes.downloadable_option.downloadable_links object
giftcard_amount
product_option.extension_attributes.giftcard_item_option.giftcard_amount string
custom_giftcard_amount
product_option.extension_attributes.giftcard_item_option.custom_giftcard_amount float
giftcard_sender_name
product_option.extension_attributes.giftcard_item_option.giftcard_sender_name string
giftcard_recipient_name
product_option.extension_attributes.giftcard_item_option.giftcard_recipient_name string
giftcard_sender_email
product_option.extension_attributes.giftcard_item_option.giftcard_sender_email string
giftcard_recipient_email
product_option.extension_attributes.giftcard_item_option.giftcard_recipient_email string
giftcard_message
product_option.extension_attributes.giftcard_item_option.giftcard_message string
giftcard_created_codes
product_option.extension_attributes.giftcard_item_option.extension_attributes.giftcard_created_codes array of
configurable_item_options
product_option.extension_attributes.configurable_item_options array of object
物品
product_option.extension_attributes.configurable_item_options object
gift_message_id
extension_attributes.gift_message.gift_message_id integer
customer_id
extension_attributes.gift_message.customer_id integer

客户 ID。

发送方
extension_attributes.gift_message.sender string

发件人名称。

收件人
extension_attributes.gift_message.recipient string

收件人姓名。

消息
extension_attributes.gift_message.message string

消息文本。

entity_id
extension_attributes.gift_message.extension_attributes.entity_id string

实体 ID。

entity_type
extension_attributes.gift_message.extension_attributes.entity_type string
wrapping_id
extension_attributes.gift_message.extension_attributes.wrapping_id integer
wrapping_allow_gift_receipt
extension_attributes.gift_message.extension_attributes.wrapping_allow_gift_receipt boolean
wrapping_add_printed_card
extension_attributes.gift_message.extension_attributes.wrapping_add_printed_card boolean
gw_id
extension_attributes.gw_id string

Gw id。

gw_base_price
extension_attributes.gw_base_price string

Gw 基价。

gw_price
extension_attributes.gw_price string

格温价格。

gw_base_tax_amount
extension_attributes.gw_base_tax_amount string

Gw 基税金额。

gw_tax_amount
extension_attributes.gw_tax_amount string

Gw 基税金额。

gw_base_price_invoiced
extension_attributes.gw_base_price_invoiced string

Gw 基价开票。

gw_price_invoiced
extension_attributes.gw_price_invoiced string

Gw 价格已开票。

gw_base_tax_amount_invoiced
extension_attributes.gw_base_tax_amount_invoiced string
gw_tax_amount_invoiced
extension_attributes.gw_tax_amount_invoiced string
gw_base_price_refunded
extension_attributes.gw_base_price_refunded string
gw_price_refunded
extension_attributes.gw_price_refunded string
gw_base_tax_amount_refunded
extension_attributes.gw_base_tax_amount_refunded string
gw_tax_amount_refunded
extension_attributes.gw_tax_amount_refunded string
vertex_tax_codes
extension_attributes.vertex_tax_codes array of string
invoice_text_codes
extension_attributes.invoice_text_codes array of string
tax_codes
extension_attributes.tax_codes array of string
代码
extension_attributes.vertex_commodity_code.code string
类型
extension_attributes.vertex_commodity_code.type string

itemsHeader

名称 路径 类型 说明
base_discount_amount
base_discount_amount float

基本折扣金额。

base_discount_canceled
base_discount_canceled float

基本折扣已取消。

base_discount_invoiced
base_discount_invoiced float

已开票的基本折扣。

base_discount_refunded
base_discount_refunded float

基本折扣已退款。

base_grand_total
base_grand_total float

基本总计。

base_subtotal
base_subtotal float

基本分类汇总。

base_subtotal_canceled
base_subtotal_canceled float

已取消基本分类汇总。

base_subtotal_incl_tax
base_subtotal_incl_tax float

基本分类汇总包括税。

base_subtotal_invoiced
base_subtotal_invoiced float

基本分类汇总已开票。

base_subtotal_refunded
base_subtotal_refunded float

已退款的基本分类汇总。

base_tax_amount
base_tax_amount float

基本税额。

base_tax_canceled
base_tax_canceled float

基本税已取消。

base_tax_invoiced
base_tax_invoiced float

已开票的基本税。

base_tax_refunded
base_tax_refunded float

基本退税。

base_total_canceled
base_total_canceled float

已取消基本总数。

base_total_due
base_total_due float

截止日期的基数。

base_total_invoiced
base_total_invoiced float

已开票的基数。

base_total_invoiced_cost
base_total_invoiced_cost float

开票总成本。

base_total_offline_refunded
base_total_offline_refunded float

基本脱机退款。

base_total_online_refunded
base_total_online_refunded float

基本在线退款总额。

base_total_paid
base_total_paid float

基本总付费。

base_total_qty_ordered
base_total_qty_ordered float

已排序的基数总数。

base_total_refunded
base_total_refunded float

基本退款总额。

base_to_global_rate
base_to_global_rate float

基数到全球费率。

base_to_order_rate
base_to_order_rate float

基本到订单率。

billing_address_id
billing_address_id float

帐单地址 ID。

can_ship_partially
can_ship_partially float

可以部分交付。

can_ship_partially_item
can_ship_partially_item float

可以交付部分项目。

coupon_code
coupon_code string

优惠券代码。

创建时间
created_at string

创建位置。

customer_dob
customer_dob string

客户 dob。

customer_email
customer_email string

客户电子邮件。

customer_firstname
customer_firstname string

客户名字。

customer_gender
customer_gender float

客户性别。

customer_group_id
customer_group_id float

客户组 ID。

customer_id
customer_id float

客户 ID。

customer_is_guest
customer_is_guest float

客户是来宾。

customer_lastname
customer_lastname string

客户姓氏。

customer_middlename
customer_middlename string

客户中间名。

customer_note
customer_note string

客户说明。

customer_note_notify
customer_note_notify float

客户备注通知。

customer_prefix
customer_prefix string

客户前缀。

customer_suffix
customer_suffix string

客户后缀。

customer_taxvat
customer_taxvat string

客户分类。

discount_amount
discount_amount float

折扣金额。

discount_canceled
discount_canceled float

已取消折扣。

discount_description
discount_description string

折扣说明。

discount_invoiced
discount_invoiced float

已开票折扣。

discount_refunded
discount_refunded float

折扣退款。

edit_increment
edit_increment float

编辑增量。

email_sent
email_sent float

发送电子邮件。

entity_id
entity_id float

实体 ID。

ext_customer_id
ext_customer_id string

Ext 客户 ID。

ext_order_id
ext_order_id string

Ext order ID。

forced_shipment_with_invoice
forced_shipment_with_invoice float

使用发票强制发货。

global_currency_code
global_currency_code string

全局货币代码。

grand_total
grand_total float

总计。

discount_tax_compensation_amount
discount_tax_compensation_amount float

折扣税补偿金额。

discount_tax_compensation_invoiced
discount_tax_compensation_invoiced float

已开具折扣税补偿发票。

discount_tax_compensation_refunded
discount_tax_compensation_refunded float

退款的折扣税补偿。

hold_before_state
hold_before_state string

在状态之前保留。

hold_before_status
hold_before_status string

在状态之前保留。

increment_id
increment_id string

增量 ID。

is_virtual
is_virtual float

是虚拟的。

order_currency_code
order_currency_code string

订购货币代码。

original_increment_id
original_increment_id string

原始增量 ID。

payment_authorization_amount
payment_authorization_amount float

付款授权金额。

payment_auth_expiration
payment_auth_expiration float

付款授权过期。

protect_code
protect_code string

保护代码。

quote_address_id
quote_address_id float

引号地址 ID。

quote_id
quote_id float

引号 ID。

relation_child_id
relation_child_id string

关系子 ID。

relation_child_real_id
relation_child_real_id string

关系子实 ID。

relation_parent_id
relation_parent_id string

关系父 ID。

relation_parent_real_id
relation_parent_real_id string

关系父实 ID。

remote_ip
remote_ip string

远程 IP。

shipping_amount
shipping_amount float

发货金额。

shipping_canceled
shipping_canceled float

发货已取消。

shipping_description
shipping_description string

发货描述符。

shipping_discount_amount
shipping_discount_amount float

发货折扣金额。

shipping_discount_tax_compensation_amount
shipping_discount_tax_compensation_amount float

发货折扣税补偿金额。

shipping_incl_tax
shipping_incl_tax float

发货税。

shipping_invoiced
shipping_invoiced float

已开具发票的发货。

shipping_refunded
shipping_refunded float

发货退款。

shipping_tax_amount
shipping_tax_amount float

发货税金额。

shipping_tax_refunded
shipping_tax_refunded float

发货退税。

状态
state string

订单状态。

状态
status string

订单状态。

store_currency_code
store_currency_code string

存储货币代码。

store_id
store_id float

存储 ID。

store_name
store_name string

存储名称。

store_to_base_rate
store_to_base_rate float

存储到基速率。

store_to_order_rate
store_to_order_rate float

存储到订单速率。

小计
subtotal float

订单分类汇总。

subtotal_canceled
subtotal_canceled float

已取消分类汇总。

subtotal_incl_tax
subtotal_incl_tax float

分类汇总总税。

subtotal_invoiced
subtotal_invoiced float

已开具小计发票。

subtotal_refunded
subtotal_refunded float

已退款小计。

tax_amount
tax_amount float

税额。

tax_canceled
tax_canceled float

已取消税款。

tax_invoiced
tax_invoiced float

已开票税。

tax_refunded
tax_refunded float

退款。

total_canceled
total_canceled float

已取消税款。

total_due
total_due float

截止日期总计。

total_invoiced
total_invoiced float

已开票的总发票。

total_item_count
total_item_count float

项总数。

total_offline_refunded
total_offline_refunded float

已脱机退款总数。

total_online_refunded
total_online_refunded float

在线退款总额。

total_paid
total_paid float

总付费。

total_qty_ordered
total_qty_ordered float

已排序的总数量。

total_refunded
total_refunded float

退款总额。

updated_at
updated_at string

更新时间。

weight
weight float

项权重。

x_forwarded_for
x_forwarded_for string

已转发。

物品
items items
billing_address
billing_address billing_address
付款
payment payment
status_histories
status_histories status_histories
extension_attributes
extension_attributes extension_attributes

CustomerCollectionResponse

名称 路径 类型 说明
id
id integer

客户 ID。

group_id
group_id integer

客户组 ID。

default_billing
default_billing string

客户默认计费。

default_shipping
default_shipping string

客户默认发货。

确认
confirmation string

客户确认。

创建时间
created_at string

创建日期。

updated_at
updated_at string

更新日期。

created_in
created_in string

在其中创建。

dob
dob string

出生日期。

电子邮件
email string

客户电子邮件。

firstname
firstname string

客户名字。

姓氏
lastname string

客户姓氏。

middlename
middlename string

客户中间名。

prefix
prefix string

使用的前缀。

后缀
suffix string

使用的后缀。

性别
gender integer

客户性别。

store_id
store_id integer

存储 ID。

taxvat
taxvat string

税务增值税。

website_id
website_id integer

网站 ID。

addresses
addresses CustomerAddresses

客户地址。

disable_auto_group_change
disable_auto_group_change integer

禁用自动组更改。

extension_attributes
extension_attributes CustomerExtensionAttributes

扩展属性。

custom_attributes
custom_attributes array of CustomerCustomAttributes

自定义属性

CustomerAddresses

客户地址。

名称 路径 类型 说明
id
id integer

地址 ID。

customer_id
customer_id integer

客户 ID。

region_code
region.region_code string

区域代码。

区域
region.region string
region_id
region.region_id integer

区域 ID。

region_id
region_id integer

区域 ID。

country_id
country_id string

国家/地区 ID。

街道
street array of string

街道地址。

company
company string

客户公司。

telephone
telephone string

客户电话。

传真
fax string

客户传真。

邮政编码
postcode string

客户邮政编码。

city
city string

客户城市。

firstname
firstname string

客户名字。

姓氏
lastname string

客户姓氏。

middlename
middlename string

客户中间名。

prefix
prefix string

客户前缀。

后缀
suffix string

客户后缀。

vat_id
vat_id string

Vat ID。

default_shipping
default_shipping boolean

默认发货。

default_billing
default_billing boolean

默认计费。

custom_attributes
custom_attributes array of object

自定义属性。

attribute_code
custom_attributes.attribute_code string

属性代码。

value
custom_attributes.value string

属性值。

CustomerExtensionAttributes

扩展属性。

名称 路径 类型 说明
customer_id
company_attributes.customer_id integer

客户 ID。

company_id
company_attributes.company_id integer

公司 ID。

职位名称
company_attributes.job_title string

职务。

状态
company_attributes.status integer

状态代码。

telephone
company_attributes.telephone string

客户电话。

is_subscribed
is_subscribed boolean

已订阅。

amazon_id
amazon_id string

Amazon ID。

vertex_customer_code
vertex_customer_code string

顶点客户代码。

vertex_customer_country
vertex_customer_country string

顶点客户国家/地区。

CustomerCustomAttributes

名称 路径 类型 说明
attribute_code
attribute_code string

属性代码。

value
value string

属性值。

布尔

这是基本数据类型“boolean”。