Adobe Commerce (Preview)

Adobe Commerce, powered by Magento, provides ecommerce platforms and cloud solutions. Connect to Adobe Commerce to retrieve orders and send updates.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)

Contact
Name	Microsoft Dynamics
URL	https://aka.ms/iomsupport
Email	iomdri@microsoft.com

Connector Metadata
Publisher	Microsoft
Website	https://business.adobe.com/products/magento/magento-commerce.html
Privacy policy	https://www.adobe.com/privacy/policy.html
Categories	Commerce;Website

Adobe Commerce connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's Provider integration.

Prerequisites

Adobe Commerce Cloud account is registered and Website is deployed.

How to get credentials

Access Token (Integration Token Type):

• Log in to Adobe Commerce Website Admin
• Click System > Extensions > Integrations to display the Integrations page.
• Click 'Add New Integration' to display the New Integration page.
• Enter a unique name for the integration in the Name field and then enter your admin password in the Your Password field. Leave all other fields blank.
• Click the API tab. Select the Adobe Commerce resources the integration can access. You can select all resources, or select a custom list.
• Click Save to save your changes and return to the Integrations page.
• Click the Activate link in the grid that corresponds to the newly-created integration.
• Click Allow and a dialog opens.
• Find the 'Access Token' from this dialog.

Note: Host URL is the Adobe Commerce Website's Host name

Getting started with your connector

Follow https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider to enable Adobe Commerce Provider.

Known issues and limitations

This connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's Adobe Commerce Provider integration. Support for use cases outside of Dynamics 365 Intelligent Order Management will be limited.

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True
Store Host URL	string	Adobe Commerce Store Host URL	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Cancel An Order	Cancels a specified order.
Create or Update An Order	Creates or Updates a specified order.
Get All Orders	Lists orders that match specified search criteria.
Get customer by Customer ID	Get customer by Customer ID.

Cancel An Order

Operation ID:

Cancel_An_Order

Cancels a specified order.

Parameters

Name	Key	Required	Type	Description
Unique Order id	id	True	string	Unique Order id.

Returns

Response

boolean

Create or Update An Order

Operation ID:

Create_Or_Update_An_Order

Creates or Updates a specified order.

Returns

Body

itemsHeader

Get All Orders

Operation ID:

Get_All_Orders

Lists orders that match specified search criteria.

Parameters

Name	Key	Required	Type	Description
Current page	searchCriteria[currentPage]		integer	Returns the current page.
Filter condition	searchCriteria[filter_groups][0][filters][0][condition_type]		string	Condition for filter on orders.
Filter on field	searchCriteria[filter_groups][0][filters][0][field]		string	Field for filter on orders.
Filter value	searchCriteria[filter_groups][0][filters][0][value]		string	Value for filter on orders.
Page size	searchCriteria[pageSize]		integer	Total number of records per page.
Sort direction	searchCriteria[sortOrders][0][direction]		string	Sort in asc or desc.
Sort field	searchCriteria[sortOrders][0][field]		string	Sort orders on field.

Returns

Name	Path	Type	Description
items	items	array of itemsHeader
filter_groups	search_criteria.filter_groups	array of object
filters	search_criteria.filter_groups.filters	array of object
field	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
field	search_criteria.sort_orders.field	string
direction	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

Get customer by Customer ID

Operation ID:

Get_Customer_By_Customer_ID

Get customer by Customer ID.

Parameters

Name	Key	Required	Type	Description
Customer id	customerId	True	string	Get customer by id.

Returns

Body

CustomerCollectionResponse

Definitions

billing_address

Name	Path	Type	Description
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	Customer id.
email	email	string
entity_id	entity_id	integer	Entity id.
fax	fax	string
firstname	firstname	string
lastname	lastname	string
middlename	middlename	string
parent_id	parent_id	integer
postcode	postcode	string
prefix	prefix	string
region	region	string
region_code	region_code	string
region_id	region_id	integer
street	street	array of string
suffix	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

payment

Name	Path	Type	Description
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	Amount refunded.
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.
base_amount_refunded_online	base_amount_refunded_online	float
base_shipping_amount	base_shipping_amount	float	Base shipping amount.
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	Entity id.
last_trans_id	last_trans_id	string
method	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 amount.
shipping_captured	shipping_captured	float
shipping_refunded	shipping_refunded	float	Shipping refunded.
notification_message	extension_attributes.notification_message	string
entity_id	extension_attributes.vault_payment_token.entity_id	integer	Entity id.
customer_id	extension_attributes.vault_payment_token.customer_id	integer	Customer id.
public_hash	extension_attributes.vault_payment_token.public_hash	string
payment_method_code	extension_attributes.vault_payment_token.payment_method_code	string
type	extension_attributes.vault_payment_token.type	string
created_at	extension_attributes.vault_payment_token.created_at	string	Created at.
expires_at	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

Name	Path	Type	Description
comment	comment	string
created_at	created_at	string	Created at.
entity_id	entity_id	integer	Entity 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	status	string	Order status.
extension_attributes	extension_attributes	object

extension_attributes

Name	Path	Type	Description
payment_additional_info	payment_additional_info	array of object
key	payment_additional_info.key	string
value	payment_additional_info.value	string
order_id	company_order_attributes.order_id	float	Order id.
company_id	company_order_attributes.company_id	float
company_name	company_order_attributes.company_name	string
extension_attributes	company_order_attributes.extension_attributes	object
applied_taxes	applied_taxes	array of object
code	applied_taxes.code	string
title	applied_taxes.title	string
percent	applied_taxes.percent	float
amount	applied_taxes.amount	float
base_amount	applied_taxes.base_amount	float
rates	applied_taxes.extension_attributes.rates	array of object
items	applied_taxes.extension_attributes.rates	object
item_applied_taxes	item_applied_taxes	array of object
type	item_applied_taxes.type	string
item_id	item_applied_taxes.item_id	float	Item id.
associated_item_id	item_applied_taxes.associated_item_id	float
applied_taxes	item_applied_taxes.applied_taxes	array of object
items	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
code	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	Customer id.
sender	gift_message.sender	string
recipient	gift_message.recipient	string
message	gift_message.message	string
entity_id	gift_message.extension_attributes.entity_id	string	Entity 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 base price.
gw_price	gw_price	string	Gw price.
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 base tax amount.
gw_tax_amount	gw_tax_amount	string	Gw base tax amount.
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 base price invoiced.
gw_price_invoiced	gw_price_invoiced	string	Gw price invoiced.
gw_items_base_price_invoiced	gw_items_base_price_invoiced	string	Gw items base price invoiced.
gw_items_price_invoiced	gw_items_price_invoiced	string	Gw items base price invoiced.
gw_card_base_price_invoiced	gw_card_base_price_invoiced	string	Gw items base price invoiced.
gw_card_price_invoiced	gw_card_price_invoiced	string	Gw items base price invoiced.
gw_base_tax_amount_invoiced	gw_base_tax_amount_invoiced	string	Gw items base price invoiced.
gw_tax_amount_invoiced	gw_tax_amount_invoiced	string	Gw items base price invoiced.
gw_items_base_tax_invoiced	gw_items_base_tax_invoiced	string	Gw items base price invoiced.
gw_items_tax_invoiced	gw_items_tax_invoiced	string	Gw items base price invoiced.
gw_card_base_tax_invoiced	gw_card_base_tax_invoiced	string	Gw items base price invoiced.
gw_card_tax_invoiced	gw_card_tax_invoiced	string	Gw items base price invoiced.
gw_base_price_refunded	gw_base_price_refunded	string	Gw items base price refunded.
gw_price_refunded	gw_price_refunded	string	Gw items base price refunded.
gw_items_base_price_refunded	gw_items_base_price_refunded	string	Gw items base price refunded.
gw_items_price_refunded	gw_items_price_refunded	string	Gw items base price refunded.
gw_card_base_price_refunded	gw_card_base_price_refunded	string	Gw items base price refunded.
gw_card_price_refunded	gw_card_price_refunded	string	Gw items base price refunded.
gw_base_tax_amount_refunded	gw_base_tax_amount_refunded	string	Gw items base price refunded.
gw_tax_amount_refunded	gw_tax_amount_refunded	string	Gw items base price refunded.
gw_items_base_tax_refunded	gw_items_base_tax_refunded	string	Gw items base price refunded.
gw_items_tax_refunded	gw_items_tax_refunded	string	Gw items base price refunded.
gw_card_base_tax_refunded	gw_card_base_tax_refunded	string	Gw card tax refunded.
gw_card_tax_refunded	gw_card_tax_refunded	string	Gw card tax refunded.
reward_points_balance	reward_points_balance	float	Gw card tax refunded.
reward_currency_amount	reward_currency_amount	float	Reward currency amount.
base_reward_currency_amount	base_reward_currency_amount	float	Reward currency amount.
amazon_order_reference_id	amazon_order_reference_id.amazon_order_reference_id	string
order_id	amazon_order_reference_id.order_id	float	Order id.

items

Name	Path	Type	Description
base_amount_refunded	base_amount_refunded	float	Base amount refunded.
base_cost	base_cost	float	Base cost.
base_discount_amount	base_discount_amount	float	Base discount amount.
base_discount_invoiced	base_discount_invoiced	float	Base discount invoiced.
base_discount_refunded	base_discount_refunded	float	Base discount refunded.
base_original_price	base_original_price	float	Base price.
base_price	base_price	float	Base price.
base_price_incl_tax	base_price_incl_tax	float	Base price tax.
base_row_invoiced	base_row_invoiced	float	Base row invoiced.
base_row_total	base_row_total	float	Base row total.
base_row_total_incl_tax	base_row_total_incl_tax	float	Base row total tax.
base_tax_amount	base_tax_amount	float	Base tax amount.
base_tax_before_discount	base_tax_before_discount	float	Base tax before discount.
base_tax_invoiced	base_tax_invoiced	float	Base tax invoiced.
base_tax_refunded	base_tax_refunded	float	Base tax refunded.
created_at	created_at	string	Created at.
description	description	string
discount_amount	discount_amount	float	Discount amount.
discount_invoiced	discount_invoiced	float	Discount invoiced.
discount_percent	discount_percent	float	Discount invoiced.
discount_refunded	discount_refunded	float	Discount refunded.
event_id	event_id	integer	Discount invoiced.
ext_order_item_id	ext_order_item_id	string	Discount invoiced.
free_shipping	free_shipping	integer	Free shipping.
is_qty_decimal	is_qty_decimal	integer	Is qty decimal.
is_virtual	is_virtual	integer	Is virtual.
item_id	item_id	integer	Item id.
locked_do_invoice	locked_do_invoice	integer	Locked do invoice.
locked_do_ship	locked_do_ship	integer	Locked do invoice.
name	name	string	Name of.
no_discount	no_discount	integer	No discount.
order_id	order_id	integer	Order id.
original_price	original_price	float	Original price.
parent_item_id	parent_item_id	integer	Parent item id.
price	price	float	Price item.
price_incl_tax	price_incl_tax	float	Price incl tax.
product_id	product_id	float	Product id.
product_type	product_type	string	Product type.
qty_backordered	qty_backordered	float	Qty backordered.
qty_canceled	qty_canceled	float	Qty cancelled.
qty_invoiced	qty_invoiced	float	Qty invoiced.
qty_ordered	qty_ordered	float	Qty ordered.
qty_refunded	qty_refunded	float	Qty refunded.
qty_returned	qty_returned	float	Qty returned.
qty_shipped	qty_shipped	float	Qty shipped.
quote_item_id	quote_item_id	integer	Quote item ID.
row_invoiced	row_invoiced	float	Row invoiced.
row_total	row_total	float	Row total.
row_total_incl_tax	row_total_incl_tax	float	Row total including tax.
row_weight	row_weight	float	Row weight.
sku	sku	string	SKU of item.
store_id	store_id	integer	Store id.
tax_amount	tax_amount	float	Tax amount.
tax_before_discount	tax_before_discount	float
tax_canceled	tax_canceled	float	Tax cancelled.
tax_invoiced	tax_invoiced	float	Tax invoiced.
tax_percent	tax_percent	float
tax_refunded	tax_refunded	float	Tax refunded.
updated_at	updated_at	string
weee_tax_applied	weee_tax_applied	string	Wee tax applied.
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 tax disposition.
weee_tax_row_disposition	weee_tax_row_disposition	float	Wee tax disposition.
weight	weight	float	Item weight.
parent_item	parent_item	object	Parent item.
custom_options	product_option.extension_attributes.custom_options	array of object
items	product_option.extension_attributes.custom_options	object
bundle_options	product_option.extension_attributes.bundle_options	array of object
items	product_option.extension_attributes.bundle_options	object
downloadable_links	product_option.extension_attributes.downloadable_option.downloadable_links	array of object
items	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
items	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	Customer id.
sender	extension_attributes.gift_message.sender	string	Sender Name.
recipient	extension_attributes.gift_message.recipient	string	Recipient Name.
message	extension_attributes.gift_message.message	string	Message Text.
entity_id	extension_attributes.gift_message.extension_attributes.entity_id	string	Entity 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 base price.
gw_price	extension_attributes.gw_price	string	Gw price.
gw_base_tax_amount	extension_attributes.gw_base_tax_amount	string	Gw base tax amount.
gw_tax_amount	extension_attributes.gw_tax_amount	string	Gw base tax amount.
gw_base_price_invoiced	extension_attributes.gw_base_price_invoiced	string	Gw base price invoiced.
gw_price_invoiced	extension_attributes.gw_price_invoiced	string	Gw price invoiced.
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
code	extension_attributes.vertex_commodity_code.code	string
type	extension_attributes.vertex_commodity_code.type	string

itemsHeader

Name	Path	Type	Description
base_discount_amount	base_discount_amount	float	Base discount amount.
base_discount_canceled	base_discount_canceled	float	Base discount cancelled.
base_discount_invoiced	base_discount_invoiced	float	Base discount invoiced.
base_discount_refunded	base_discount_refunded	float	Base discount refunded.
base_grand_total	base_grand_total	float	Base grand total.
base_subtotal	base_subtotal	float	Base subtotal.
base_subtotal_canceled	base_subtotal_canceled	float	Base subtotal cancelled.
base_subtotal_incl_tax	base_subtotal_incl_tax	float	Base subtotal included tax.
base_subtotal_invoiced	base_subtotal_invoiced	float	Base subtotal innvoiced.
base_subtotal_refunded	base_subtotal_refunded	float	Base subtotal refunded.
base_tax_amount	base_tax_amount	float	Base tax amount.
base_tax_canceled	base_tax_canceled	float	Base tax cancelled.
base_tax_invoiced	base_tax_invoiced	float	Base tax invoiced.
base_tax_refunded	base_tax_refunded	float	Base tax refunded.
base_total_canceled	base_total_canceled	float	Base total canceled.
base_total_due	base_total_due	float	Base total due.
base_total_invoiced	base_total_invoiced	float	Base total invoiced.
base_total_invoiced_cost	base_total_invoiced_cost	float	Base total invoiced cost.
base_total_offline_refunded	base_total_offline_refunded	float	Base total offline refunded.
base_total_online_refunded	base_total_online_refunded	float	Base total online refunded.
base_total_paid	base_total_paid	float	Base total paid.
base_total_qty_ordered	base_total_qty_ordered	float	Base total quantity ordered.
base_total_refunded	base_total_refunded	float	Base total refunded.
base_to_global_rate	base_to_global_rate	float	Base to global rate.
base_to_order_rate	base_to_order_rate	float	Base to order rate.
billing_address_id	billing_address_id	float	Billing address id.
can_ship_partially	can_ship_partially	float	Can ship partially.
can_ship_partially_item	can_ship_partially_item	float	Can ship partially item.
coupon_code	coupon_code	string	Coupon code.
created_at	created_at	string	Created at.
customer_dob	customer_dob	string	Customer dob.
customer_email	customer_email	string	Customer email.
customer_firstname	customer_firstname	string	Customer firstname.
customer_gender	customer_gender	float	Customer gender.
customer_group_id	customer_group_id	float	Customer group id.
customer_id	customer_id	float	Customer id.
customer_is_guest	customer_is_guest	float	Customer is guest.
customer_lastname	customer_lastname	string	Customer lastname.
customer_middlename	customer_middlename	string	Customer middlename.
customer_note	customer_note	string	Customer note.
customer_note_notify	customer_note_notify	float	Customer note notify.
customer_prefix	customer_prefix	string	Customer prefix.
customer_suffix	customer_suffix	string	Customer suffix.
customer_taxvat	customer_taxvat	string	Customer taxvat.
discount_amount	discount_amount	float	Discount amount.
discount_canceled	discount_canceled	float	Discount cancelled.
discount_description	discount_description	string	Discount description.
discount_invoiced	discount_invoiced	float	Discount invoiced.
discount_refunded	discount_refunded	float	Discount refunded.
edit_increment	edit_increment	float	Edit increment.
email_sent	email_sent	float	Email sent.
entity_id	entity_id	float	Entity id.
ext_customer_id	ext_customer_id	string	Ext customer id.
ext_order_id	ext_order_id	string	Ext order id.
forced_shipment_with_invoice	forced_shipment_with_invoice	float	Forced shipment with invoice.
global_currency_code	global_currency_code	string	Global currency code.
grand_total	grand_total	float	Grand total.
discount_tax_compensation_amount	discount_tax_compensation_amount	float	Discount tax compensation amount.
discount_tax_compensation_invoiced	discount_tax_compensation_invoiced	float	Discount tax compensation invoiced.
discount_tax_compensation_refunded	discount_tax_compensation_refunded	float	Discount tax compensation refunded.
hold_before_state	hold_before_state	string	Hold before state.
hold_before_status	hold_before_status	string	Hold before status.
increment_id	increment_id	string	Increment id.
is_virtual	is_virtual	float	Is virtual.
order_currency_code	order_currency_code	string	Order currency code.
original_increment_id	original_increment_id	string	Original increment id.
payment_authorization_amount	payment_authorization_amount	float	Payment authorization amount.
payment_auth_expiration	payment_auth_expiration	float	Payment authorization expiration.
protect_code	protect_code	string	Protect code.
quote_address_id	quote_address_id	float	Quote address id.
quote_id	quote_id	float	Quote id.
relation_child_id	relation_child_id	string	Relation child id.
relation_child_real_id	relation_child_real_id	string	Relation child real id.
relation_parent_id	relation_parent_id	string	Relation parent id.
relation_parent_real_id	relation_parent_real_id	string	Relation parent real id.
remote_ip	remote_ip	string	Remote ip.
shipping_amount	shipping_amount	float	Shipping amount.
shipping_canceled	shipping_canceled	float	Shipping cancelled.
shipping_description	shipping_description	string	Shipping descripton.
shipping_discount_amount	shipping_discount_amount	float	Shipping discount amount.
shipping_discount_tax_compensation_amount	shipping_discount_tax_compensation_amount	float	Shipping discount tax compensation amount.
shipping_incl_tax	shipping_incl_tax	float	Shipping incl tax.
shipping_invoiced	shipping_invoiced	float	Shipping invoiced.
shipping_refunded	shipping_refunded	float	Shipping refunded.
shipping_tax_amount	shipping_tax_amount	float	Shipping tax amount.
shipping_tax_refunded	shipping_tax_refunded	float	Shipping tax refunded.
state	state	string	Order state.
status	status	string	Order status.
store_currency_code	store_currency_code	string	Store currency code.
store_id	store_id	float	Store id.
store_name	store_name	string	Store name.
store_to_base_rate	store_to_base_rate	float	Store to base rate.
store_to_order_rate	store_to_order_rate	float	Store to order rate.
subtotal	subtotal	float	Order subtotal.
subtotal_canceled	subtotal_canceled	float	Subtotal cancelled.
subtotal_incl_tax	subtotal_incl_tax	float	Subtotal incl tax.
subtotal_invoiced	subtotal_invoiced	float	Subtotal invoiced.
subtotal_refunded	subtotal_refunded	float	Subtotal refunded.
tax_amount	tax_amount	float	Tax amount.
tax_canceled	tax_canceled	float	Tax cancelled.
tax_invoiced	tax_invoiced	float	Tax invoiced.
tax_refunded	tax_refunded	float	Tax refunded.
total_canceled	total_canceled	float	Tax cancelled.
total_due	total_due	float	Total due.
total_invoiced	total_invoiced	float	Total invoiced.
total_item_count	total_item_count	float	Total item count.
total_offline_refunded	total_offline_refunded	float	Total offline refunded.
total_online_refunded	total_online_refunded	float	Total online refunded.
total_paid	total_paid	float	Total paid.
total_qty_ordered	total_qty_ordered	float	Total quantity ordered.
total_refunded	total_refunded	float	Total refunded.
updated_at	updated_at	string	Updated at.
weight	weight	float	Item weight.
x_forwarded_for	x_forwarded_for	string	Forwarded for.
items	items	items
billing_address	billing_address	billing_address
payment	payment	payment
status_histories	status_histories	status_histories
extension_attributes	extension_attributes	extension_attributes

CustomerCollectionResponse

Name	Path	Type	Description
id	id	integer	Customer id.
group_id	group_id	integer	Customer group id.
default_billing	default_billing	string	Customer default billing.
default_shipping	default_shipping	string	Customer default shipping.
confirmation	confirmation	string	Customer confirmation.
created_at	created_at	string	Created at date.
updated_at	updated_at	string	Updated at date.
created_in	created_in	string	Created in.
dob	dob	string	Date of birth.
email	email	string	Customer email.
firstname	firstname	string	Customer firstname.
lastname	lastname	string	Customer lastname.
middlename	middlename	string	Customer middlename.
prefix	prefix	string	Prefix used.
suffix	suffix	string	Suffix used.
gender	gender	integer	Customer gender.
store_id	store_id	integer	Store id.
taxvat	taxvat	string	Tax vat.
website_id	website_id	integer	Website id.
addresses	addresses	CustomerAddresses	Customer addresses.
disable_auto_group_change	disable_auto_group_change	integer	Disable auto group change.
extension_attributes	extension_attributes	CustomerExtensionAttributes	Extension attributes.
custom_attributes	custom_attributes	array of CustomerCustomAttributes	Custom Attributes

CustomerAddresses

Customer addresses.

Name	Path	Type	Description
id	id	integer	Address id.
customer_id	customer_id	integer	Customer id.
region_code	region.region_code	string	Region code.
region	region.region	string
region_id	region.region_id	integer	Region id.
region_id	region_id	integer	Region id.
country_id	country_id	string	Country id.
street	street	array of string	Street address.
company	company	string	Customer company.
telephone	telephone	string	Customer telephone.
fax	fax	string	Customer fax.
postcode	postcode	string	Customer postcode.
city	city	string	Customer city.
firstname	firstname	string	Customer firstname.
lastname	lastname	string	Customer lastname.
middlename	middlename	string	Customer middlename.
prefix	prefix	string	Customer prefix.
suffix	suffix	string	Customer suffix.
vat_id	vat_id	string	Vat id.
default_shipping	default_shipping	boolean	Default shipping.
default_billing	default_billing	boolean	Default billing.
custom_attributes	custom_attributes	array of object	Custom attributes.
attribute_code	custom_attributes.attribute_code	string	Attribute code.
value	custom_attributes.value	string	Attribute value.

CustomerExtensionAttributes

Extension attributes.

Name	Path	Type	Description
customer_id	company_attributes.customer_id	integer	Customer id.
company_id	company_attributes.company_id	integer	Company id.
job_title	company_attributes.job_title	string	Job title.
status	company_attributes.status	integer	Status code.
telephone	company_attributes.telephone	string	Customer telephone.
is_subscribed	is_subscribed	boolean	Is subscribed.
amazon_id	amazon_id	string	Amazon id.
vertex_customer_code	vertex_customer_code	string	Vertex customer code.
vertex_customer_country	vertex_customer_country	string	Vertex customer country.

CustomerCustomAttributes

Name	Path	Type	Description
attribute_code	attribute_code	string	Attribute code.
value	value	string	Attribute value.

boolean

This is the basic data type 'boolean'.