Shopify (Independent Publisher) (Preview)
REST interface for Shopify's merchants to receive, process, and manage their orders.
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) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Dynamics |
| URL | https://dynamics.microsoft.com/en-us/support/ |
| bennettray@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Ray Bennett (MSFT) |
| Website | https://www.shopify.com/ |
| Privacy policy | https://www.shopify.com/legal/privacy |
| Categories | Productivity |
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 access token for this API. | True |
| Store URL | string | Shopify store URL | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Cancel an order |
Cancel an order by ID. |
| Retrieves a list of customers |
Retrieves a list of customers that meet the specified criteria |
| Retrieves a list of orders |
Retrieves a list of orders that meet the specified criteria |
| Updates an order |
Updates an order with the provided information. |
Cancel an order
Cancel an order by ID.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
order_id | True | string |
ID of the order that will be cancelled. |
|
Refund The actual amount
|
amount | string |
The amount to refund. If set, Shopify attempts to void or refund the payment, depending on its status. Shopify refunds through a manual gateway in cases where the original transaction was not made in Shopify. Refunds through a manual gateway are recorded as a refund on Shopify, but the customer is not refunded. |
|
|
Refund currency
|
currency | string |
The currency of the refund that's issued when the order is canceled. Required for multi-currency orders whenever the amount property is provided. |
|
|
Restock refunded items
|
restock | string |
Whether to restock refunded items back to your store's inventory. |
|
|
Order cancellation reason
|
reason | string |
The reason for the order cancellation. Valid values: customer, inventory, fraud, declined, and other. |
|
|
Cancellation email
|
string |
Whether to send an email to the customer notifying them of the cancellation. |
||
|
Refund
|
refund | string |
The refund transactions to perform. |
|
|
|
object |
Returns
Order
- Body
- order
Retrieves a list of customers
Retrieves a list of customers that meet the specified criteria
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Customer IDs
|
ids | string |
Restrict results to customers specified by a comma-separated list of IDs. |
|
|
Since ID
|
since_id | string |
Restrict results after the specified ID. |
|
|
Created at min
|
created_at_min | string |
Show customers created after a specified date (format: 2014-04-25T16:15:47-04:00). |
|
|
Created at max
|
created_at_max | string |
Show customers created before a specified date (format: 2014-04-25T16:15:47-04:00). |
|
|
Updated at min
|
updated_at_min | string |
Show customers last updated after a specified date (format: 2014-04-25T16:15:47-04:00). |
|
|
Updated at max
|
updated_at_max | string |
Show customers last updated before a specified date (format: 2014-04-25T16:15:47-04:00). |
|
|
Limit
|
limit | string |
The maximum number of results to show. (default: 50)(maximum: 250). |
|
|
Fields
|
fields | string |
Show only certain fields, specified by a comma-separated list of fields. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
customers
|
customers | array of customer |
Retrieves a list of orders
Retrieves a list of orders that meet the specified criteria
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order IDs
|
ids | string |
Retrieve only orders specified by a comma-separated list of order IDs. |
|
|
Limit
|
limit | string |
The maximum number of results to show on a page. |
|
|
Since ID
|
since_id | string |
Show orders after the specified ID. |
|
|
Created at min
|
created_at_min | string |
Show orders created at or after date (format: 2014-04-25T16:15:47-04:00). |
|
|
Created at max
|
created_at_max | string |
Show orders created at or before date (format: 2014-04-25T16:15:47-04:00). |
|
|
Updated at min
|
updated_at_min | string |
Show orders last updated at or after date (format: 2014-04-25T16:15:47-04:00). |
|
|
Updated at max
|
updated_at_max | string |
Show orders last updated at or before date (format: 2014-04-25T16:15:47-04:00). |
|
|
Processed at min
|
processed_at_min | string |
Show orders imported at or after date (format: 2014-04-25T16:15:47-04:00). |
|
|
Processed at max
|
processed_at_max | string |
Show orders imported at or before date (format: 2014-04-25T16:15:47-04:00). |
|
|
Attribution App ID
|
attribution_app_id | string |
Show orders attributed to a certain app, specified by the app ID. |
|
|
Order status
|
status | string |
Filter orders by their status. |
|
|
Financial status
|
financial_status | string |
Filter orders by their financial status. |
|
|
Fulfillment status
|
fulfillment_status | string |
Filter orders by their fulfillment status. |
|
|
Fields
|
fields | string |
Retrieve only certain fields, specified by a comma-separated list of fields. |
|
|
Sequence order of records
|
order | string |
Field and direction to sort orders. To specify the direction, add ' asc' or ' desc' to the end of the query parameter. E.g. 'order=updated_at asc'. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
orders
|
orders | array of order |
Updates an order
Updates an order with the provided information.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Order ID
|
order_id | True | string |
ID of the order which will update. |
|
|
object |
Returns
Order
- Body
- order
Definitions
order
Order
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The ID of the app that created the order. |
|
email
|
string |
The customer's email address. |
|
|
closed_at
|
closed_at | string |
The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed. |
|
created_at
|
created_at | string |
The three-letter code (ISO 4217 format) for the shop currency. |
|
updated_at
|
updated_at | string |
The date and time (ISO 8601 format) when the order was last modified. |
|
number
|
number | integer |
The order's position in the shop's count of orders. Numbers are sequential and start at 1. |
|
note
|
note | string |
An optional note that a shop owner can attach to the order. |
|
token
|
token | string |
A unique value when referencing the order. |
|
gateway
|
gateway | string |
The payment gateway used. |
|
test
|
test | boolean |
Whether this is a test order. |
|
total_price
|
total_price | string |
The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive. |
|
subtotal_price
|
subtotal_price | string |
The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips. |
|
total_weight
|
total_weight | integer |
The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order. |
|
total_tax
|
total_tax | string |
The sum of all the taxes applied to the order in the shop currency. Must be positive. |
|
taxes_included
|
taxes_included | boolean |
Whether taxes are included in the order subtotal. |
|
currency
|
currency | string |
The three-letter code (ISO 4217 format) for the shop currency. |
|
financial_status
|
financial_status | string |
The status of payments associated with the order. Can only be set when the order is created. |
|
confirmed
|
confirmed | boolean |
Order confirmed. |
|
total_discounts
|
total_discounts | string |
The total discounts applied to the price of the order in the shop currency. |
|
total_line_items_price
|
total_line_items_price | string |
The sum of all line item prices in the shop currency. |
|
cart_token
|
cart_token | string |
A unique value when referencing the cart that's associated with the order. |
|
buyer_accepts_marketing
|
buyer_accepts_marketing | boolean |
Whether the customer consented to receive email updates from the shop. |
|
name
|
name | string |
The order name, generated by combining the order_number property with the order prefix and suffix that are set in the merchant's general settings. |
|
referring_site
|
referring_site | string |
The website where the customer clicked a link to the shop. |
|
landing_site
|
landing_site | string |
The URL for the page where the buyer landed when they entered the shop. |
|
cancelled_at
|
cancelled_at | string |
The date and time when the order was canceled. Returns null if the order isn't canceled. |
|
cancel_reason
|
cancel_reason | string |
The reason why the order was canceled. |
|
total_price_usd
|
total_price_usd | string |
Total price usd. |
|
checkout_token
|
checkout_token | string |
A unique value when referencing the checkout that's associated with the order. |
|
reference
|
reference | string |
Order reference. |
|
user_id
|
user_id | integer |
The ID of the user logged into Shopify POS who processed the order, if applicable. |
|
location_id
|
location_id | integer |
The ID of the physical location where the order was processed. If you need to reference the location against an order, then use the FulfillmentOrder resource. |
|
source_identifier
|
source_identifier | string |
Source identifier. |
|
source_url
|
source_url | string |
Source url. |
|
processed_at
|
processed_at | string |
The date and time (ISO 8601 format) when an order was processed. |
|
device_id
|
device_id | string |
The ID for the device. |
|
phone
|
phone | string |
The customer's phone number for receiving SMS notifications. |
|
customer_locale
|
customer_locale | string |
The two or three-letter language code, optionally followed by a region modifier. |
|
app_id
|
app_id | integer |
The ID of the app that created the order. |
|
browser_ip
|
browser_ip | string |
The IP address of the browser used by the customer when they placed the order. |
|
landing_site_ref
|
landing_site_ref | string |
Landing site ref. |
|
order_number
|
order_number | integer |
The order's position in the shop's count of orders starting at 1001. |
|
discount_applications
|
discount_applications | discount_applications |
The description of the discount application, as defined by the merchant or the Shopify Script. |
|
discount_codes
|
discount_codes | discount_codes |
A list of discounts applied to the order. |
|
note_attributes
|
note_attributes | note_attributes |
Extra information that is added to the order. |
|
payment_gateway_names
|
payment_gateway_names | payment_gateway_names |
The list of payment gateways used for the order. |
|
processing_method
|
processing_method | string |
How the payment was processed. |
|
checkout_id
|
checkout_id | integer |
Checkout id. |
|
source_name
|
source_name | string |
Where the order originated. |
|
fulfillment_status
|
fulfillment_status | string |
The order's status in terms of fulfilled line items. |
|
tax_lines
|
tax_lines | tax_lines |
A list of tax line objects, each of which details a tax applied to the item. |
|
tags
|
tags | string |
Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. |
|
contact_email
|
contact_email | string |
Contact email. |
|
order_status_url
|
order_status_url | string |
The URL pointing to the order status web page, if applicable. |
|
presentment_currency
|
presentment_currency | string |
The presentment currency that was used to display prices to the customer. |
|
total_line_items_price_set
|
total_line_items_price_set | subtotal_tax_discount_price_set | |
|
total_discounts_set
|
total_discounts_set | subtotal_tax_discount_price_set | |
|
total_shipping_price_set
|
total_shipping_price_set | subtotal_tax_discount_price_set | |
|
subtotal_price_set
|
subtotal_price_set | subtotal_tax_discount_price_set | |
|
total_price_set
|
total_price_set | subtotal_tax_discount_price_set | |
|
total_tax_set
|
total_tax_set | subtotal_tax_discount_price_set | |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
|
shipping_lines
|
shipping_lines | shipping_lines |
Details of which shipping method used. |
|
billing_address
|
billing_address | billing_address |
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method. |
|
shipping_address
|
shipping_address | shipping_address |
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping. |
|
client_details
|
client_details | client_detail |
Information about the browser that the customer used when they placed their order. |
|
payment_details
|
payment_details | payment_detail |
An object containing information about the payment. |
|
customer
|
customer | customer |
Information about the customer. |
|
line_items
|
line_items | line_items | |
|
fulfillments
|
fulfillments | fulfillments |
An array of fulfillments associated with the order. |
|
refunds
|
refunds | refunds |
Refunds |
customer
Information about the customer.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
A unique identifier for the customer. |
|
email
|
string |
The unique email address of the customer. Attempting to assign the same email address to multiple customers returns an error. |
|
|
accepts_marketing
|
accepts_marketing | boolean |
Whether the customer has consented to receive marketing material via email. |
|
created_at
|
created_at | string |
The date and time (ISO 8601 format) when the customer was created. |
|
updated_at
|
updated_at | string |
The date and time (ISO 8601 format) when the customer information was last updated. |
|
first_name
|
first_name | string |
The customer's first name. |
|
last_name
|
last_name | string |
The customer's last name. |
|
orders_count
|
orders_count | integer |
The number of orders associated with this customer. |
|
state
|
state | string |
The state of the customer's account with a shop. Default value: disabled. |
|
total_spent
|
total_spent | string |
The total amount of money that the customer has spent across their order history. |
|
last_order_id
|
last_order_id | integer |
The ID of the customer's last order. |
|
note
|
note | string |
A note about the customer. |
|
verified_email
|
verified_email | boolean |
Whether the customer has verified their email address. |
|
multipass_identifier
|
multipass_identifier | string |
A unique identifier for the customer that's used with Multipass login. |
|
tax_exempt
|
tax_exempt | boolean |
Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout. |
|
phone
|
phone | string |
The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error. |
|
tags
|
tags | string |
Tags that the shop owner has attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters. |
|
last_order_name
|
last_order_name | string |
The name of the customer's last order. This is directly related to the name field on the Order resource. |
|
currency
|
currency | string |
The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. |
|
addresses
|
addresses | addresses |
A list of the ten most recently updated addresses for the customer. |
|
accepts_marketing_updated_at
|
accepts_marketing_updated_at | string |
The date and time (ISO 8601 format) when the customer consented or objected to receiving marketing material by email. |
|
marketing_opt_in_level
|
marketing_opt_in_level | string |
The marketing subscription opt-in level that the customer gave when they consented to receive marketing material by email. |
|
tax_exemptions
|
tax_exemptions | array of |
Whether the customer is exempt from paying specific taxes on their order. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
|
default_address
|
default_address | default_address |
default_address
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
A unique identifier for the address. |
|
customer_id
|
customer_id | integer |
A unique identifier for the customer. |
|
first_name
|
first_name | string |
The customer's first name. |
|
last_name
|
last_name | string |
The customer's last name. |
|
company
|
company | string |
The customer's company. |
|
address1
|
address1 | string |
The first line of the customer's mailing address. |
|
address2
|
address2 | string |
An additional field for the customer's mailing address. |
|
city
|
city | string |
The customer's city, town, or village. |
|
province
|
province | string |
The customer's region name. Typically a province, a state, or a prefecture. |
|
country
|
country | string |
The customer's country. |
|
zip
|
zip | string |
The customer's postal code, also known as zip, postcode, Eircode, etc. |
|
phone
|
phone | string |
The customer's phone number at this address. |
|
name
|
name | string |
The customer's first and last names. |
|
province_code
|
province_code | string |
The two-letter code for the customer's region. |
|
country_code
|
country_code | string |
The two-letter country code corresponding to the customer's country. |
|
country_name
|
country_name | string |
The customer's normalized country name. |
|
default
|
default | boolean |
Returns true for each default address. |
shipping_address
The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.
| Name | Path | Type | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
The first name of the person associated with the shipping address. |
|
address1
|
address1 | string |
The street address of the shipping address. |
|
phone
|
phone | string |
The phone number at the shipping address. |
|
city
|
city | string |
The city, town, or village of the shipping address. |
|
zip
|
zip | string |
The postal code (for example, zip, postcode, or Eircode) of the shipping address. |
|
province
|
province | string |
The name of the region (for example, province, state, or prefecture) of the shipping address. |
|
country
|
country | string |
The name of the country of the shipping address. |
|
last_name
|
last_name | string |
The last name of the person associated with the shipping address. |
|
address2
|
address2 | string |
An optional additional field for the street address of the shipping address. |
|
company
|
company | string |
The company of the person associated with the shipping address. |
|
latitude
|
latitude | float |
The latitude of the shipping address. |
|
longitude
|
longitude | float |
The longitude of the shipping address. |
|
name
|
name | string |
The full name of the person associated with the payment method. |
|
country_code
|
country_code | string |
The two-letter code (ISO 3166-1 format) for the country of the shipping address. |
|
province_code
|
province_code | string |
The two-letter abbreviation of the region of the shipping address. |
billing_address
The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.
| Name | Path | Type | Description |
|---|---|---|---|
|
first_name
|
first_name | string |
The first name of the person associated with the payment method. |
|
address1
|
address1 | string |
The street address of the billing address. |
|
phone
|
phone | string |
The phone number at the billing address. |
|
city
|
city | string |
The city, town, or village of the billing address. |
|
zip
|
zip | string |
The postal code (for example, zip, postcode, or Eircode) of the billing address. |
|
province
|
province | string |
The name of the region (for example, province, state, or prefecture) of the billing address. |
|
country
|
country | string |
The name of the country of the billing address. |
|
last_name
|
last_name | string |
The last name of the person associated with the payment method. |
|
address2
|
address2 | string |
An optional additional field for the street address of the billing address. |
|
company
|
company | string |
The company of the person associated with the billing address. |
|
latitude
|
latitude | float |
The latitude of the billing address. |
|
longitude
|
longitude | float |
The longitude of the billing address. |
|
name
|
name | string |
The full name of the person associated with the payment method. |
|
country_code
|
country_code | string |
The two-letter code (ISO 3166-1 format) for the country of the billing address. |
|
province_code
|
province_code | string |
The two-letter abbreviation of the region of the billing address. |
addresses
A list of the ten most recently updated addresses for the customer.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
default_address |
shipping_line
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
A globally-unique identifier. |
|
title
|
title | string |
The title of the shipping method. |
|
price
|
price | string |
The price of this shipping method in the shop currency. |
|
code
|
code | string |
A reference to the shipping method. |
|
source
|
source | string |
The source of the shipping method. |
|
phone
|
phone | string |
The phone number at the shipping address. |
|
requested_fulfillment_service_id
|
requested_fulfillment_service_id | string |
A reference to the fulfillment service that is being requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service; null otherwise. |
|
delivery_category
|
delivery_category | string |
Delivery category. |
|
carrier_identifier
|
carrier_identifier | string |
A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. |
|
discounted_price
|
discounted_price | string |
The price of the shipping method after line-level discounts have been applied. Doesn't reflect cart-level or order-level discounts. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
discounted_price_set
|
discounted_price_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
An ordered list of amounts allocated by discount applications. |
|
tax_lines
|
tax_lines | tax_lines |
A list of tax line objects, each of which details a tax applied to the item. |
client_detail
Information about the browser that the customer used when they placed their order.
| Name | Path | Type | Description |
|---|---|---|---|
|
browser_ip
|
browser_ip | string |
The browser IP address. |
|
accept_language
|
accept_language | string |
The languages and locales that the browser understands. |
|
user_agent
|
user_agent | string |
Details of the browsing client, including software and operating versions. |
|
session_hash
|
session_hash | string |
A hash of the session. |
|
browser_width
|
browser_width | integer |
The browser screen width in pixels, if available. |
|
browser_height
|
browser_height | integer |
The browser screen height in pixels, if available. |
payment_detail
An object containing information about the payment.
| Name | Path | Type | Description |
|---|---|---|---|
|
credit_card_bin
|
credit_card_bin | string |
The issuer identification number (IIN), formerly known as the bank identification number (BIN), of the customer's credit card. |
|
avs_result_code
|
avs_result_code | string |
The response code from the address verification system (AVS). The code is a single letter. |
|
cvv_result_code
|
cvv_result_code | string |
The response code from the credit card company indicating whether the customer entered the card security code (card verification value) correctly. The code is a single letter or empty string. |
|
credit_card_number
|
credit_card_number | string |
The customer's credit card number, with most of the leading digits redacted. |
|
credit_card_company
|
credit_card_company | string |
The name of the company who issued the customer's credit card. |
subtotal_tax_discount_price_set
| Name | Path | Type | Description |
|---|---|---|---|
|
amount
|
shop_money.amount | string |
The actual amount. |
|
currency_code
|
shop_money.currency_code | string |
In ISO 4217 format. |
|
amount
|
presentment_money.amount | string |
The actual amount. |
|
currency_code
|
presentment_money.currency_code | string |
In ISO 4217 format. |
line_item_property
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
The product name. |
|
value
|
value | string |
The product value. |
line_item_properties
Properties.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
line_item_property |
fulfillment
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The ID for the fulfillment. |
|
order_id
|
order_id | integer |
The unique numeric identifier for the order. |
|
status
|
status | string |
The status of the fulfillment. |
|
created_at
|
created_at | string |
The date and time when the fulfillment was created. |
|
service
|
service | string |
The type of service used. |
|
updated_at
|
updated_at | string |
The date and time (ISO 8601 format) when the fulfillment was last modified. |
|
tracking_company
|
tracking_company | string |
The name of the tracking company. |
|
shipment_status
|
shipment_status | string |
The current shipment status of the fulfillment. |
|
location_id
|
location_id | integer |
The unique identifier of the location that the fulfillment should be processed for. |
|
tracking_number
|
tracking_number | string |
A tracking number, provided by the shipping company. |
|
tracking_numbers
|
tracking_numbers | array of string |
A list of tracking numbers, provided by the shipping company. |
|
tracking_url
|
tracking_url | string |
The URL of tracking page for the fulfillment. |
|
tracking_urls
|
tracking_urls | array of string |
The URLs of tracking pages for the fulfillment. |
|
receipt
|
receipt | receipt |
A text field that provides information about the receipt. |
|
name
|
name | string |
The uniquely identifying fulfillment name. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
|
line_items
|
line_items | line_items |
fulfillments
An array of fulfillments associated with the order.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
fulfillment |
transaction
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The ID for the transaction. |
|
order_id
|
order_id | integer |
The ID for the order that the transaction is associated with. |
|
kind
|
kind | string |
The transaction's type. |
|
gateway
|
gateway | string |
The name of the gateway the transaction was issued through. |
|
status
|
status | string |
The status of the transaction. |
|
message
|
message | string |
A string generated by the payment provider with additional information about why the transaction succeeded or failed. |
|
created_at
|
created_at | string |
The date and time (ISO 8601 format) when the transaction was created. |
|
test
|
test | boolean |
Whether the transaction is a test transaction. |
|
authorization
|
authorization | string |
The authorization code associated with the transaction. |
|
location_id
|
location_id | string |
The ID of the physical location where the transaction was processed. |
|
user_id
|
user_id | string |
The ID for the user who was logged into the Shopify POS device when the order was processed, if applicable. |
|
parent_id
|
parent_id | integer |
The ID of an associated transaction. |
|
processed_at
|
processed_at | string |
The date and time (ISO 8601 format) when a transaction was processed. |
|
device_id
|
device_id | string |
The ID for the device. |
|
error_code
|
error_code | string |
A standardized error code, independent of the payment provider. |
|
source_name
|
source_name | string |
The origin of the transaction. This is set by Shopify and can't be overridden. |
|
amount
|
amount | string |
The amount of money included in the transaction. |
|
currency
|
currency | string |
The three-letter code (ISO 4217 format) for the currency used for the payment. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
transactions
A list of transactions involved in the refund.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
transaction |
tax_line
| Name | Path | Type | Description |
|---|---|---|---|
|
price
|
price | string |
The amount of tax to be charged in the shop currency. |
|
rate
|
rate | float |
The rate of tax to be applied. |
|
title
|
title | string |
The name of the tax. |
|
price_set
|
price_set | subtotal_tax_discount_price_set |
tax_lines
A list of tax line objects, each of which details a tax applied to the item.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
tax_line |
refunds
Refunds
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
refund |
refund
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The unique identifier for the refund. |
|
order_id
|
order_id | integer |
The ID of the order, used for API purposes. |
|
created_at
|
created_at | string |
The date and time (ISO 8601 format) when the refund was created. |
|
note
|
note | string |
An optional note attached to a refund. |
|
user_id
|
user_id | integer |
The unique identifier of the user who performed the refund. |
|
processed_at
|
processed_at | string |
The date and time (ISO 8601 format) when the refund was imported. |
|
restock
|
restock | boolean |
Whether to add the line items back to the store's inventory. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
|
transactions
|
transactions | transactions |
A list of transactions involved in the refund. |
|
order_adjustments
|
order_adjustments | array of |
A list of order adjustments attached to the refund. |
line_item
A list of line item objects, each containing information about an item in the order.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The ID of the line item. |
|
variant_id
|
variant_id | integer |
The ID of the product variant. |
|
title
|
title | string |
The title of the product. |
|
quantity
|
quantity | integer |
The number of items that were purchased. |
|
sku
|
sku | string |
The item's SKU (stock keeping unit). |
|
variant_title
|
variant_title | string |
The title of the product variant. |
|
vendor
|
vendor | string |
The name of the item's supplier. |
|
fulfillment_service
|
fulfillment_service | string |
The service provider that's fulfilling the item. |
|
product_id
|
product_id | integer |
The ID of the product that the line item belongs to. |
|
requires_shipping
|
requires_shipping | boolean |
Whether the item requires shipping. |
|
taxable
|
taxable | boolean |
Whether the item is taxable. |
|
gift_card
|
gift_card | boolean |
Whether the line item is a gift card. |
|
name
|
name | string |
The name of the product variant. |
|
variant_inventory_management
|
variant_inventory_management | string |
The name of the inventory management service. |
|
properties
|
properties | line_item_properties |
Properties. |
|
product_exists
|
product_exists | boolean |
Whether the product exists. |
|
fulfillable_quantity
|
fulfillable_quantity | integer |
The amount available to fulfill. |
|
grams
|
grams | integer |
The weight of the item in grams. |
|
price
|
price | string |
The price of the item before discounts have been applied in the shop currency. |
|
total_discount
|
total_discount | string |
The total amount of the discount allocated to the line item in the shop currency. |
|
fulfillment_status
|
fulfillment_status | string |
The status of an order in terms of the line items being fulfilled. |
|
price_set
|
price_set | subtotal_tax_discount_price_set | |
|
total_discount_set
|
total_discount_set | subtotal_tax_discount_price_set | |
|
discount_allocations
|
discount_allocations | array of |
An ordered list of amounts allocated by discount applications. |
|
admin_graphql_api_id
|
admin_graphql_api_id | string |
Admin graphql api id. |
|
tax_lines
|
tax_lines | tax_lines |
A list of tax line objects, each of which details a tax applied to the item. |
line_items
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
line_item |
A list of line item objects, each containing information about an item in the order. |
shipping_lines
Details of which shipping method used.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
shipping_line |
payment_gateway_names
The list of payment gateways used for the order.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
string |
note_attribute
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Note attribute name. |
|
value
|
value | string |
Note attribute value. |
note_attributes
Extra information that is added to the order.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
note_attribute |
discount_code
| Name | Path | Type | Description |
|---|---|---|---|
|
code
|
code | string |
When the associated discount application is of type code, this property returns the discount code that was entered at checkout. |
|
amount
|
amount | string |
The amount that's deducted from the order total. When you create an order, this value is the percentage or monetary amount to deduct. |
|
type
|
type | string |
The type of discount. |
discount_codes
A list of discounts applied to the order.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
discount_code |
discount_application
| Name | Path | Type | Description |
|---|---|---|---|
|
type
|
type | string |
The discount application type. |
|
value
|
value | string |
The value of the discount application as a decimal. This represents the intention of the discount application. |
|
value_type
|
value_type | string |
The type of the value. |
|
allocation_method
|
allocation_method | string |
The method by which the discount application value has been allocated to entitled lines. |
|
target_selection
|
target_selection | string |
The lines on the order, of the type defined by target_type, that the discount is allocated over. |
|
target_type
|
target_type | string |
The type of line on the order that the discount is applicable on. |
|
code
|
code | string |
The discount code that was used to apply the discount. Available only for discount code applications. |
discount_applications
The description of the discount application, as defined by the merchant or the Shopify Script.
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
discount_application |
receipt
A text field that provides information about the receipt.
| Name | Path | Type | Description |
|---|---|---|---|
|
testcase
|
testcase | boolean |
Whether the fulfillment was a testcase. |
|
authorization
|
authorization | string |
The authorization code. |