Overview
Configuration is provided for establishing connections with Shopify service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Configuration
Base URL address: https://[shop].myshopify.com/admin/api/2022-01.
- OAuth (deprecated)
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
X-Shopify-Access-Token:
{{=token.Access}}
Documentation: https://help.shopify.com/api/guides/authentication/oauth.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Password: Required. Specify your private app Admin API password.
The following request parameters will be automatically processed during the authentication process:
-
X-Shopify-Access-Token:
{{=connection.user.Password}}
Documentation: https://shopify.dev/tutorials/authenticate-a-private-app-with-shopify-admin.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/checkouts.json.
The result is extracted from:{{=response.checkouts}}.Documentation: https://help.shopify.com/api/reference/abandoned_checkouts#index.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- source
Template: ShortText.
- source_name
Template: ShortText.
- abandoned_checkout_url
Template: ShortText.
- billing_address
Template: Address.
- buyer_accepts_marketing
Data type: DT_BOOL
- cancel_reason
Template: ShortText.
- cart_token
Template: ShortText.
- closed_at
Template: DateTime.
- completed_at
Template: DateTime.
- currency
Template: Code3.
- source_identifier
Template: ShortText.
- source_url
Template: ShortText.
- customer
Template: Customer.
- discount_codes
Template: DiscountCodes.
Template: ShortText.
- gateway
Template: ShortText.
- landing_site
Template: ShortText.
- line_items
Field components:
- An array.
- Contains the following components: key, applied_discounts, compare_at_price, destination_location_id, fulfillment_service, fulfillment_status, gift_card, grams, line_price, price, origin_location_id, product_id, properties, quantity, requires_shipping, sku, tax_lines, taxable, title, variant_id, variant_title, vendor, name.
- note
Template: LongText.
- note_attributes
Template: LongText.
- referring_site
Template: ShortText.
- shipping_address
Template: Address.
- shipping_lines
Field components:
- An array.
- Contains the following components: id, code, price, source, title.
- subtotal_price
Template: Currency.
- tax_lines
Template: TaxLines.
- taxes_included
Data type: DT_BOOL
- token
Template: ShortText.
- total_discounts
Template: Currency.
- total_line_items_price
Template: Currency.
- total_price
Template: Currency.
- total_tax
Template: Currency.
- total_weight
Data type: DT_I4
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/application_charges.json.Documentation: https://help.shopify.com/api/reference/applicationcharge#index.
- [Create] action
-
Endpoint URL address:
/application_charges.json.Documentation: https://help.shopify.com/api/reference/applicationcharge#create.
- id
A key field. Template: Id.
- name
Template: ShortText.
- price
Template: Currency.
- return_url
Template: ShortText.
- test
Data type: DT_BOOL
- confirmation_url
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- api_client_id
Template: Id. A read-only field.
- charge_type
Template: ShortText. A read-only field.
- decorated_return_url
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/blogs/{{=parameters.blog_id}}/articles.json.The action has the following user-defined parameters:
- blog_id: Required. Specify blog identifier.
Documentation: https://help.shopify.com/api/reference/article#index.
- [Create] action
-
Endpoint URL address:
/blogs/{{=item.blog_id}}/articles.json.Documentation: https://help.shopify.com/api/reference/article#create.
- [Update] action
-
Endpoint URL address:
/blogs/{{=item.blog_id}}/articles/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/article#update.
- [Delete] action
-
Endpoint URL address:
/blogs/{{=parameters.blog_id}}/articles/{{=item.id}}.json.The action has the following user-defined parameters:
- blog_id: Required. Specify blog identifier.
Documentation: https://help.shopify.com/api/reference/article#destroy.
- id
A key field. Template: Id.
- author
Template: ShortText.
- blog_id
Template: Id.
- body_html
Template: LongerText.
- handle
Template: ShortText.
- image
Template: Image.
- metafields
Template: Metafields.
- published
Data type: DT_BOOL
- summary_html
Template: ShortText.
- tags
Template: ShortText.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- user_id
Template: Id.
- published_at
Template: DateTime.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/themes/{{=parameters.theme_id}}/assets.json.The action has the following user-defined parameters:
- theme_id: Required. Specify theme identifier.
Documentation: https://help.shopify.com/api/reference/asset#index.
- [Upsert] action
-
Endpoint URL address:
/themes/{{=item.theme_id}}/assets.json.
The result is extracted from:{{=response.asset}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ asset: item } }}
Documentation: https://help.shopify.com/api/reference/asset#update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/themes/{{=parameters.theme_id}}/assets.json.The action has the following user-defined parameters:
- theme_id: Required. Specify theme identifier.
The following request parameters will be automatically processed:
-
asset[key]:
{{=item.key}}
Documentation: https://help.shopify.com/api/reference/asset#destroy.
- key
A key field. Template: ShortText.
- attachment
Data type: DT_IMAGE The value is gathered from
{{=item.public_url}}address. Before setting, the value is processed with{{=!_.isUndefined(value) && getClrType('System.Convert').ToBase64String(value.readAll())}}expression.- content_type
Template: ShortText.
- public_url
Template: ShortText.
- size
Data type: DT_I4
- source_key
Template: ShortText.
- src
Template: ShortText.
- theme_id
Template: Id.
- value
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/blogs.json.Documentation: https://help.shopify.com/api/reference/blog#index.
- [Create] action
-
Endpoint URL address:
/blogs.json.
The result is extracted from:{{=response.blog}}.Documentation: https://help.shopify.com/api/reference/blog#create.
- [Update] action
-
Endpoint URL address:
/blogs/{{=item.id}}.json.
The result is extracted from:{{=response.blog}}.Documentation: https://help.shopify.com/api/reference/blog#update.
- [Delete] action
-
Endpoint URL address:
/blogs/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/blog#destroy.
- id
A key field. Template: Id.
- commentable
Template: ShortText.
- feedburner
Template: ShortText.
- feedburner_location
Template: ShortText.
- handle
Template: ShortText.
- metafields
Template: Metafields.
- tags
Template: ShortText.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/carrier_services.json.Documentation: https://help.shopify.com/api/reference/carrierservice#index.
- [Create] action
-
Endpoint URL address:
/carrier_services.json.
The result is extracted from:{{=response.carrier_service}}.Documentation: https://help.shopify.com/api/reference/carrierservice#create.
- [Update] action
-
Endpoint URL address:
/carrier_services/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/carrierservice#update.
- [Delete] action
-
Endpoint URL address:
/carrier_services/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/carrierservice#destroy.
- id
A key field. Template: Id.
- active
Data type: DT_BOOL
- callback_url
Template: ShortText.
- carrier_service_type
Template: ShortText.
- name
Template: ShortText.
- service_discovery
Data type: DT_BOOL
- format
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/collects.json.Documentation: https://help.shopify.com/api/reference/collect#index.
- [Create] action
-
Endpoint URL address:
/collects.json.
The result is extracted from:{{=response.collect}}.Documentation: https://help.shopify.com/api/reference/collect#create.
- [Delete] action
-
Endpoint URL address:
/collects/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/collect#destroy.
- id
A key field. Template: Id.
- collection_id
Data type: DT_I4
- featured
Data type: DT_BOOL
- position
Data type: DT_I4
- product_id
Data type: DT_I4
- sort_value
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/comments.json.Documentation: https://help.shopify.com/api/reference/comment#index.
- [Create] action
-
Endpoint URL address:
/comments.json.Documentation: https://help.shopify.com/api/reference/comment#create.
- [Update] action
-
Endpoint URL address:
/comments/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/comment#update.
- id
A key field. Template: Id.
- article_id
Template: Id.
- author
Template: ShortText.
- blog_id
Template: Id.
- body
Template: LongerText.
- body_html
Template: LongerText.
Template: ShortText.
- ip
Template: ShortText.
- published_at
Template: DateTime.
- status
Template: ShortText.
- user_agent
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/countries.json.Documentation: https://help.shopify.com/api/reference/country#index.
- [Create] action
-
Endpoint URL address:
/countries.json.Documentation: https://help.shopify.com/api/reference/country#create.
- [Update] action
-
Endpoint URL address:
/countries/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/country#update.
- [Delete] action
-
Endpoint URL address:
/countries/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/country#destroy.
- id
A key field. Template: Id.
- code
Template: Code2.
- name
Template: ShortText.
- provinces
Field components:
- An array.
-
Uses template:
Province.
- tax
Template: Currency.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/custom_collections.json.Documentation: https://help.shopify.com/api/reference/customcollection#index.
- [Create] action
-
Endpoint URL address:
/custom_collections.json.Documentation: https://help.shopify.com/api/reference/customcollection#create.
- [Update] action
-
Endpoint URL address:
/custom_collections/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customcollection#update.
- [Delete] action
-
Endpoint URL address:
/custom_collections/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customcollection#destroy.
- id
A key field. Template: Id.
- body_html
Template: LongerText.
- handle
Template: ShortText.
- image
Template: Image.
- metafields
Template: Metafields.
- published
Data type: DT_BOOL
- published_at
Template: DateTime.
- published_scope
Template: ShortText.
- sort_order
Template: ShortText.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customers.json.Documentation: https://help.shopify.com/api/reference/customer#index.
- [Read search] action
-
Endpoint URL address:
/customers/search.json.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://help.shopify.com/api/reference/customer#search.
- [Read saved_search] action
-
Endpoint URL address:
/customer_saved_searches/{{=parameters.saved_search}}/customers.json.The action has the following user-defined parameters:
- saved_search: Required. Specify saved search identifier.
Documentation: https://help.shopify.com/api/reference/customersavedsearch#other.
- [Create] action
-
Endpoint URL address:
/customers.json.Documentation: https://help.shopify.com/api/reference/customer#create.
- [Update] action
-
Endpoint URL address:
/customers/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customer#update.
- [Delete] action
-
Endpoint URL address:
/customers/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customer#destroy.
The resource includes the fields from the Customer template.
- metafields
Template: Metafields.
- addresses
Field components:
- An array.
-
Uses template:
Address.
- default_address
Template: Address. A read-only field. The value is sent to
/customers/{{=item.id}}/addresses/{{=item.default_address.id}}/default.jsonaddress. Field components:-
Uses template:
Id. - Contains the following components: id.
-
Uses template:
- [Read] action
-
Endpoint URL address:
/customers/{{=parameters.customer_id}}/addresses.json.
The result is extracted from:{{=response.addresses}}.The action has the following user-defined parameters:
- customer_id: Required. Specify customer identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://help.shopify.com/api/reference/customeraddress#index.
- [Create] action
-
Endpoint URL address:
/customers/{{=item.customer_id}}/addresses.json.
The result is extracted from:{{=response.customer_address}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{={ address: item } }}
Documentation: https://help.shopify.com/api/reference/customeraddress#create.
-
application/json:
- [Update] action
-
Endpoint URL address:
/customers/{{=item.customer_id}}/addresses/{{=item.id}}.json.
The result is extracted from:{{=response.customer_address}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ address: item } }}
Documentation: https://help.shopify.com/api/reference/customeraddress#update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/customers/{{=item.customer_id}}/addresses/{{=item.id}}.json.
The action uses DELETE method.Documentation: https://help.shopify.com/api/reference/customeraddress#destroy.
The resource includes the fields from the Address template.
- customer_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/customer_saved_searches.json.Documentation: https://help.shopify.com/api/reference/customersavedsearch#index.
- [Create] action
-
Endpoint URL address:
/customer_saved_searches.json.Documentation: https://help.shopify.com/api/reference/customersavedsearch#create.
- [Update] action
-
Endpoint URL address:
/customer_saved_searches/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customersavedsearch#update.
- [Delete] action
-
Endpoint URL address:
/customer_saved_searches/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/customersavedsearch#destroy.
- id
A key field. Template: Id.
- name
Template: ShortText.
- query
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/price_rules.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/pricerule#get-price-rules?since-id=106886545.
- [Create] action
-
Endpoint URL address:
/price_rules.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/pricerule#post-price-rules.
- [Update] action
-
Endpoint URL address:
/price_rules/{{=item.id}}.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/pricerule#put-price-rules-price-rule-id.
- [Delete] action
-
Endpoint URL address:
/price_rules/{{=item.id}}.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/pricerule#delete-price-rules-price-rule-id.
- id
A key field. Template: Id.
- allocation_method
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- customer_selection
Template: ShortText.
- ends_at
Template: DateTime.
- entitled_collection_ids
Template: LongText. A composite field.
- entitled_country_ids
Template: LongText. A composite field.
- entitled_product_ids
Template: LongText. A composite field.
- entitled_variant_ids
Template: LongText. A composite field.
- once_per_customer
Data type: DT_BOOL
- prerequisite_customer_ids
Template: LongText. A composite field.
- prerequisite_quantity_range
Field components:
- Contains the following components: greater_than_or_equal_to.
- customer_segment_prerequisite_ids
Template: LongText. A composite field.
- prerequisite_shipping_price_range
Field components:
-
Uses template:
ShortText. - Contains the following components: less_than_or_equal_to.
-
Uses template:
- prerequisite_subtotal_range
Field components:
-
Uses template:
ShortText. - Contains the following components: greater_than_or_equal_to.
-
Uses template:
- prerequisite_to_entitlement_purchase
Field components:
-
Uses template:
ShortText. - Contains the following components: prerequisite_amount.
-
Uses template:
- starts_at
Template: DateTime.
- target_selection
Template: ShortText.
- target_type
Template: ShortText.
- title
Template: ShortText.
- usage_limit
Data type: DT_I4
- prerequisite_product_ids
Template: LongText. A composite field.
- prerequisite_variant_ids
Template: LongText. A composite field.
- prerequisite_collection_ids
Template: LongText. A composite field.
- value
Data type: DT_R8
- value_type
Template: ShortText.
- prerequisite_to_entitlement_quantity_ratio
Field components:
- Contains the following components: prerequisite_quantity, entitled_quantity.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/price_rules/{{=parameters.price_rule_id}}/discount_codes.json.The action has the following user-defined parameters:
- price_rule_id: Required. Specify price rule identifier.
Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#get-price-rules-price-rule-id-discount-codes.
- [Read single] action
-
Endpoint URL address:
/price_rules/{{=parameters.price_rule_id}}/discount_codes/{{=parameters.discount_code_id}}.json.
The result is extracted from:{{=[response.discount_code]}}.The action has the following user-defined parameters:
- price_rule_id: Required. Specify price rule identifier.
- discount_code_id: Required. Specify discount code identifier.
Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#get-price-rules-price-rule-id-discount-codes-discount-code-id.
- [Read job] action
-
Endpoint URL address:
/price_rules/{{=parameters.price_rule_id}}/batch/{{=parameters.batch_id}}/discount_codes.json.The action has the following user-defined parameters:
- price_rule_id: Required. Specify price rule identifier.
- batch_id: Required. Specify id of the discount code creation job for the associated price rule..
Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#get-price-rules-price-rule-id-batch-batch-id-discount-codes.
- [Create] action
-
Endpoint URL address:
/price_rules/{{=item.price_rule_id}}/discount_codes.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#post-price-rules-price-rule-id-discount-codes.
- [Update] action
-
Endpoint URL address:
/price_rules/{{=item.price_rule_id}}/discount_codes/{{=item.id}}.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#put-price-rules-price-rule-id-discount-codes-discount-code-id.
- [Delete] action
-
Endpoint URL address:
/price_rules/{{=item.price_rule_id}}/discount_codes/{{=item.id}}.json.Documentation: https://shopify.dev/api/admin-rest/2022-10/resources/discountcode#delete-price-rules-price-rule-id-discount-codes-discount-code-id.
- id
A key field. Template: Id.
- code
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- price_rule_id
Template: Id.
- usage_count
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.resource}}/events.json.The action has the following user-defined parameters:
- resource: Required. Specify resource.
Documentation: https://help.shopify.com/api/reference/event#index.
- id
A key field. Template: Id.
- arguments
Template: ShortText.
- body
Template: LongerText.
- path
Template: ShortText.
- message
Template: ShortText.
- subject_id
Template: Id.
- subject_type
Template: ShortText.
- verb
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/fulfillments.json.The action has the following user-defined parameters:
- order_id: Required. Specify order_id identifier.
Documentation: https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment#get-orders-order-id-fulfillments.
- [Read single] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/fulfillments/{{=parameters.id}}.json.
The result is extracted from:{{=[response.fulfillment]}}.The action has the following user-defined parameters:
- order_id: Required. Specify order_id identifier.
- id: Required. Specify fulfillment identifier.
Documentation: https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment#get-orders-order-id-fulfillments-fulfillment-id.
- [Create] action
-
Endpoint URL address:
/fulfillments.json.Documentation: https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment#post-fulfillments.
- [Update] action
-
Endpoint URL address:
/fulfillments/{{=item.id}}/update_tracking.json.Documentation: https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment#post-fulfillments-fulfillment-id-update-tracking.
- [Delete] action
-
Endpoint URL address:
/fulfillments/{{=item.id}}/cancel.json.
The action uses POST method.Documentation: https://shopify.dev/docs/api/admin-rest/2024-07/resources/fulfillment#post-fulfillments-fulfillment-id-cancel.
The resource includes the fields from the Fulfillment template.
- line_items_by_fulfillment_order
Field components:
- An array.
- Contains the following components: fulfillment_order_id, fulfillment_order_line_items.
- message
Template: ShortText.
- notify_customer
Data type: DT_BOOL
- tracking_info
Field components:
-
Uses template:
ShortText. - Contains the following components: company, number, url.
-
Uses template:
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/fulfillments/{{=parameters.fulfillment_id}}/events.json.
The result is extracted from:{{=response.fulfillment_events}}.The action has the following user-defined parameters:
- order_id: Required. Specify order_id identifier.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://help.shopify.com/api/reference/fulfillmentevent#index.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/fulfillments/{{=item.fulfillment_id}}/events.json.
The result is extracted from:{{=response.fulfillment_event}}.The following request parameters will be automatically processed:
-
application/json:
{{={ event: item } }}
Documentation: https://help.shopify.com/api/reference/fulfillmentevent#create.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/fulfillments/{{=item.fulfillment_id}}/events/{{=item.id}}.json.
The action uses DELETE method.Documentation: https://help.shopify.com/api/reference/fulfillmentevent#destroy.
- id
A key field. Template: Id.
- shop_id
Template: Id.
- order_id
Template: Id.
- fulfillment_id
Template: Id.
- status
Template: ShortText.
- happened_at
Data type: DT_I4
- message
Template: ShortText.
- city
Template: ShortText.
- province
Template: Code2.
- zip
Template: ShortText.
- country
Template: ShortText.
- address1
Template: ShortText.
- latitude
Data type: DT_R8
- longitude
Data type: DT_R8
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/fulfillment_services.json.Documentation: https://help.shopify.com/api/reference/fulfillmentservice#index.
- [Create] action
-
Endpoint URL address:
/fulfillment_services.json.Documentation: https://help.shopify.com/api/reference/fulfillmentservice#create.
- [Update] action
-
Endpoint URL address:
/fulfillment_services/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/fulfillmentservice#update.
- [Delete] action
-
Endpoint URL address:
/fulfillment_services/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/fulfillmentservice#destroy.
- id
A key field. Template: Id.
- callback_url
Template: ShortText.
- format
Template: ShortText.
- handle
Template: ShortText.
- inventory_management
Data type: DT_BOOL
- name
Template: ShortText.
- provider_id
Template: Id.
- requires_shipping_method
Data type: DT_BOOL
- tracking_support
Data type: DT_BOOL
Template: ShortText.
- include_pending_stock
Data type: DT_BOOL
- service_name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/gift_cards.json.Documentation: https://help.shopify.com/api/reference/gift_card#index.
- [Read search] action
-
Endpoint URL address:
/gift_cards/search.json.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "query").
The following request parameters will be automatically processed:
-
query:
{{=parameters.search}}
Documentation: https://help.shopify.com/api/reference/gift_card#search.
- [Create] action
-
Endpoint URL address:
/gift_cards.json.Documentation: https://help.shopify.com/api/reference/gift_card#create.
- [Update] action
-
Endpoint URL address:
/gift_cards/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/gift_card#update.
- [Delete] action
-
Endpoint URL address:
/gift_cards/{{=item.id}}/disable.json.Documentation: https://help.shopify.com/api/reference/gift_card#disable.
- id
A key field. Template: Id.
- api_client_id
Template: Id.
- user_id
Template: Id.
- order_id
Template: Id.
- initial_value
Template: Currency.
- line_item_id
Template: Id.
- balance
Template: Currency.
- currency
Template: Code3.
- code
Template: ShortText.
- masked_code
Template: ShortText.
- last_characters
Data type: DT_WSTR ( length 4 )
- note
Template: LongText.
- template_suffix
Template: ShortText.
- expires_on
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- disabled_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/inventory_items.json.
The result is paginated.The action has the following user-defined parameters:
- ids: Specify comma separated list of inventory items identifier.
Documentation: https://help.shopify.com/en/api/reference/inventory/inventoryitem#index.
- [Update] action
-
Endpoint URL address:
/inventory_items/{{=item.id}}.json.Documentation: https://help.shopify.com/en/api/reference/inventory/inventoryitem#update.
- id
A key field. Template: Id.
- sku
Template: ShortText.
- tracked
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- requires_shipping
Data type: DT_BOOL
- cost
Template: ShortText.
- country_code_of_origin
Template: ShortText.
- province_code_of_origin
Template: ShortText.
- harmonized_system_code
Template: ShortText.
- country_harmonized_system_codes
Template: LongText. A composite field.
- admin_graphql_api_id
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/inventory_levels.json.
The result is extracted from:{{=response.inventory_levels}}.The action has the following user-defined parameters:
- inventory_item_ids: A comma-separated list of inventory item IDs.
- location_ids: A comma-separated list of location IDs.
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://help.shopify.com/en/api/reference/inventory/inventorylevel#index.
- [Create] action
-
Endpoint URL address:
/inventory_levels/connect.json.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=_.extend({ inventory_item_id: item.inventory_item_id, location_id: item.location_id }, item)}}
Documentation: https://help.shopify.com/en/api/reference/inventory/inventorylevel#connect.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/inventory_levels.json.
The action uses DELETE method.Documentation: https://help.shopify.com/en/api/reference/inventory/inventorylevel#destroy.
- inventory_item_id
A key field. Template: Id.
- location_id
A key field. Template: Id.
- available
Data type: DT_I4 The value is sent to
/inventory_levels/set.jsonaddress.- updated_at
Template: DateTime. A read-only field.
- available_adjustment
Data type: DT_I4 The value is sent to
/inventory_levels/adjust.jsonaddress.- relocate_if_necessary
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/locations.json.
The result is paginated.Documentation: https://help.shopify.com/en/api/reference/inventory/location#index.
- id
A key field. Template: Id.
- active
Data type: DT_BOOL
- address1
Template: ShortText.
- address2
Template: ShortText.
- city
Template: ShortText.
- country
Template: ShortText.
- country_code
Template: Code2.
- legacy
Data type: DT_BOOL
- name
Template: ShortText.
- phone
Template: ShortText.
- province
Template: ShortText.
- province_code
Template: Code2.
- zip
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- [Read] action
-
Endpoint URL address:
/locations.json.
The result is extracted from:{{=response.locations}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://help.shopify.com/api/reference/location#index.
-
_includeUserParameters:
- id
A key field. Template: Id.
- name
Template: ShortText.
- address1
Template: ShortText.
- address2
Template: ShortText.
- zip
Template: ShortText.
- city
Template: ShortText.
- province
Template: ShortText.
- country
Template: Code2.
- phone
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/{{=parameters.get('resource') || ''}}/metafields.json.The action has the following user-defined parameters:
- resource: Optional. Specify resource.
Documentation: https://help.shopify.com/api/reference/metafield#index.
- [Create] action
-
Endpoint URL address:
/{{=item.resource || ''}}/metafields.json.Documentation: https://help.shopify.com/api/reference/metafield#create.
- [Update] action
-
Endpoint URL address:
/{{=item.resource || ''}}/metafields/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/metafield#update.
- [Delete] action
-
Endpoint URL address:
/{{=parameters.get('resource') || ''}}/metafields/{{=item.id}}.json.The action has the following user-defined parameters:
- resource: Optional. Specify resource.
Documentation: https://help.shopify.com/api/reference/metafield#destroy.
- id
A key field. Template: Id.
- resource
Template: ShortText.
- description
Template: ShortText.
- key
Template: ShortText.
- namespace
Template: ShortText.
- owner_id
Template: Id.
- owner_resource
Template: ShortText.
- value
Template: ShortText.
- type
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders.json.Documentation: https://help.shopify.com/api/reference/order#index.
- [Create] action
-
Endpoint URL address:
/orders.json.Documentation: https://help.shopify.com/api/reference/order#create.
- [Update] action
-
Endpoint URL address:
/orders/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/order#update.
- [Delete] action
-
Endpoint URL address:
/orders/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/order#destroy.
- id
A key field. Template: Id.
- user_id
Template: Id.
- billing_address
Template: Address.
- browser_ip
Template: ShortText.
- buyer_accepts_marketing
Data type: DT_BOOL
- cancel_reason
Template: ShortText.
- cart_token
Template: ShortText.
- client_details
Field components:
-
Uses template:
ShortText. - Contains the following components: accept_language, browser_height, browser_ip, browser_width, session_hash, user_agent.
-
Uses template:
- currency
Template: Code3.
- customer
Template: Customer. Field components:
-
Uses template:
Id. - Contains the following components: order_id.
-
Uses template:
- discount_codes
Template: DiscountCodes.
Template: ShortText.
- financial_status
Template: ShortText.
- fulfillments
A read-only field. Field components:
- An array.
-
Uses template:
Fulfillment.
- fulfillment_status
Template: ShortText.
- tags
Template: ShortText.
- gateway
Template: ShortText.
- landing_site
Template: ShortText.
- line_items
Field components:
- An array.
-
Uses template:
LineItem.
- name
Template: ShortText.
- note
Template: LongText.
- note_attributes
Field components:
- An array.
- Contains the following components: name, value.
- number
Data type: DT_I4
- order_number
Data type: DT_I4
- payment_details
Field components:
- An array.
-
Uses template:
PaymentDetail.
- payment_gateway_names
Template: LongText. A composite field.
- processing_method
Template: ShortText.
- referring_site
Template: ShortText.
- refunds
A read-only field. Field components:
- An array.
- Contains the following components: id, created_at, note, refund_line_items, restock, transactions, user_id, order_adjustments.
- shipping_address
Template: Address.
- shipping_lines
Field components:
- An array.
- Contains the following components: code, price, source, title, tax_lines, carrier_identifier, requested_fulfillment_service_id.
- source_name
Template: ShortText.
- subtotal_price
Template: Currency.
- status
Template: ShortText.
- tax_lines
Template: TaxLines.
- taxes_included
Data type: DT_BOOL
- token
Template: ShortText.
- total_discounts
Template: Currency.
- total_line_items_price
Template: Currency.
- total_price
Template: Currency.
- total_tax
Template: Currency.
- total_weight
Data type: DT_I4
- transactions
Field components:
- An array.
-
Uses template:
Transaction.
- order_status_url
Template: ShortText.
- send_receipt
Data type: DT_BOOL
- send_fulfillment_receipt
Data type: DT_BOOL
- inventory_behaviour
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- closed_at
Template: DateTime. A read-only field.
- cancelled_at
Template: DateTime. A read-only field.
- processed_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/risks.json.The action has the following user-defined parameters:
- order_id: Required. Specify order identifier.
Documentation: https://help.shopify.com/api/reference/order_risks#index.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/risks.json.Documentation: https://help.shopify.com/api/reference/order_risks#create.
- [Update] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/risks/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/order_risks#update.
- [Delete] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/risks/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/order_risks#destroy.
- id
A key field. Template: Id.
- cause_cancel
Data type: DT_BOOL
- display
Data type: DT_BOOL
- order_id
Template: Id.
- message
Template: ShortText.
- recommendation
Template: ShortText.
- score
Data type: DT_R8
- source
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/pages.json.Documentation: https://help.shopify.com/api/reference/page#index.
- [Create] action
-
Endpoint URL address:
/pages.json.Documentation: https://help.shopify.com/api/reference/page#create.
- [Update] action
-
Endpoint URL address:
/pages/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/page#update.
- [Delete] action
-
Endpoint URL address:
/pages/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/page#destroy.
- id
A key field. Template: Id.
- author
Template: ShortText.
- body_html
Template: LongerText.
- handle
Template: ShortText.
- metafields
Template: Metafields.
- shop_id
Template: Id.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- published
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- published_at
Template: DateTime. A read-only field.
- [Read] action
-
Endpoint URL address:
/policies.json.
The result is extracted from:{{=response.policies}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
Documentation: https://help.shopify.com/api/reference/policy#index.
-
_includeUserParameters:
- title
Template: ShortText.
- body
Template: LongerText.
- url
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products.json.Documentation: https://help.shopify.com/api/reference/product#index.
- [Create] action
-
Endpoint URL address:
/products.json.Documentation: https://help.shopify.com/api/reference/product#create.
- [Update] action
-
Endpoint URL address:
/products/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/product#update.
- [Delete] action
-
Endpoint URL address:
/products/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/product#destroy.
- id
A key field. Template: Id.
- body_html
Template: LongerText.
- handle
Template: ShortText.
- images
Field components:
- An array.
-
Uses template:
Image.
- options
Field components:
- An array.
- Contains the following components: id, product_id, name, position, values.
- product_type
Template: ShortText.
- published_scope
Template: ShortText.
- tags
Template: ShortText.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- metafields_global_title_tag
Template: ShortText.
- metafields_global_description_tag
Template: ShortText.
- variants
Field components:
- An array.
-
Uses template:
Variant.
- vendor
Template: ShortText.
- published
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- published_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/images.json.
The result is paginated.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://help.shopify.com/api/reference/product_image#index.
- [Create] action
-
Endpoint URL address:
/products/{{=item.product_id}}/images.json.Documentation: https://help.shopify.com/api/reference/product_image#create.
- [Update] action
-
Endpoint URL address:
/products/{{=item.product_id}}/images/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/product_image#update.
- [Delete] action
-
Endpoint URL address:
/products/{{=item.product_id}}/images/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/product_image#destroy.
- id
A key field. Template: Id.
- position
Data type: DT_I4
- product_id
Template: Id.
- variant_ids
Template: LongText. A composite field.
- attachment
Data type: DT_IMAGE The value is gathered from
{{=item.src}}address. Before setting, the value is processed with{{=!_.isUndefined(value) && getClrType('System.Convert').ToBase64String(value.readAll())}}expression.- src
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- filename
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/variants.json.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://help.shopify.com/api/reference/product_variant#index.
- [Create] action
-
Endpoint URL address:
/products/{{=item.product_id}}/variants.json.Documentation: https://help.shopify.com/api/reference/product_variant#create.
- [Update] action
-
Endpoint URL address:
/variants/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/product_variant#update.
- [Delete] action
-
Endpoint URL address:
/products/{{=parameters.product_id}}/variants/{{=item.id}}.json.The action has the following user-defined parameters:
- product_id: Required. Specify product identifier.
Documentation: https://help.shopify.com/api/reference/product_variant#destroy.
The resource includes the fields from the Variant template.
- image_id
Template: Id.
- inventory_item_id
Template: Id.
- tax_code
Template: ShortText.
- old_inventory_quantity
Data type: DT_I4
- inventory_quantity_adjustment
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/countries/{{=parameters.country_id}}/provinces.json.The action has the following user-defined parameters:
- country_id: Required. Specify country identifier.
Documentation: https://help.shopify.com/api/reference/province#index.
- [Update] action
-
Endpoint URL address:
/countries/{{=item.country_id}}/provinces/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/province#update.
The resource includes the fields from the Province template.
- shipping_zone_id
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recurring_application_charges.json.Documentation: https://help.shopify.com/api/reference/recurringapplicationcharge#index.
- [Create] action
-
Endpoint URL address:
/recurring_application_charges.json.Documentation: https://help.shopify.com/api/reference/recurringapplicationcharge#create.
- [Update] action
-
Endpoint URL address:
/recurring_application_charges/{{=item.id}}/customize.json.Documentation: https://help.shopify.com/api/reference/recurringapplicationcharge#customize.
- [Delete] action
-
Endpoint URL address:
/recurring_application_charges/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/recurringapplicationcharge#destroy.
- id
A key field. Template: Id.
- capped_amount
Template: Currency.
- confirmation_url
Template: ShortText.
- name
Template: ShortText.
- price
Template: Currency.
- return_url
Template: ShortText.
- status
Template: ShortText.
- terms
Template: ShortText.
- test
Data type: DT_BOOL
- trial_days
Data type: DT_I4
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
- activated_on
Template: DateTime.
- billing_on
Template: DateTime.
- cancelled_on
Template: DateTime.
- trial_ends_on
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/redirects.json.Documentation: https://help.shopify.com/api/reference/redirect#index.
- [Create] action
-
Endpoint URL address:
/redirects.json.Documentation: https://help.shopify.com/api/reference/redirect#create.
- [Update] action
-
Endpoint URL address:
/redirects/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/redirect#update.
- [Delete] action
-
Endpoint URL address:
/redirects/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/redirect#destroy.
- id
A key field. Template: Id.
- path
Template: ShortText.
- target
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/refunds.json.The action has the following user-defined parameters:
- order_id: Required. Specify order identifier.
Documentation: https://help.shopify.com/api/reference/refund#index.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/refunds/calculate.json.Documentation: https://help.shopify.com/api/reference/refund#calculate.
- [Update] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/refunds.json.
The action uses POST method.Documentation: https://help.shopify.com/api/reference/refund#create.
- id
A key field. Template: Id.
- order_id
Template: Id.
- note
Template: LongText.
- refund_line_items
Field components:
- An array.
- Contains the following components: id, line_item, line_item_id, quantity.
- restock
Data type: DT_BOOL
- transactions
Field components:
- An array.
-
Uses template:
Transaction.
- user_id
Template: Id.
- order_adjustments
Template: LongText. A composite field.
- notify
Data type: DT_BOOL
- shipping
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/script_tags.json.Documentation: https://help.shopify.com/api/reference/scripttag#index.
- [Create] action
-
Endpoint URL address:
/script_tags.json.Documentation: https://help.shopify.com/api/reference/scripttag#create.
- [Update] action
-
Endpoint URL address:
/script_tags/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/scripttag#update.
- [Delete] action
-
Endpoint URL address:
/script_tags/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/scripttag#destroy.
- id
A key field. Template: Id.
- event
Template: ShortText.
- src
Template: ShortText.
- display_scope
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shipping_zones.json.Documentation: https://help.shopify.com/api/reference/shipping_zone#index.
- id
A key field. Template: Id.
- name
Template: ShortText.
- countries
Field components:
- An array.
- Contains the following components: id, code, name, tax, tax_name.
- provinces
Field components:
- An array.
-
Uses template:
Province.
- carrier_shipping_rate_providers
Field components:
- An array.
- Contains the following components: id, carrier_service_id, flat_modifier, percent_modifier, service_filter.
- price_based_shipping_rates
Field components:
- An array.
- Contains the following components: id, name, min_order_subtotal, price, max_order_subtotal.
- weight_based_shipping_rates
Field components:
- An array.
- Contains the following components: id, weight_low, weight_high, name, price.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smart_collections.json.Documentation: https://help.shopify.com/api/reference/smartcollection#index.
- [Create] action
-
Endpoint URL address:
/smart_collections.json.Documentation: https://help.shopify.com/api/reference/smartcollection#create.
- [Update] action
-
Endpoint URL address:
/smart_collections/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/smartcollection#update.
- [Delete] action
-
Endpoint URL address:
/smart_collections/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/smartcollection#destroy.
- id
A key field. Template: Id.
- body_html
Template: LongerText.
- handle
Template: ShortText.
- image
Template: Image.
- published_scope
Template: ShortText.
- rules
Field components:
- An array.
- Contains the following components: column, relation, condition.
- disjunctive
Data type: DT_BOOL
- sort_order
Template: ShortText.
- template_suffix
Template: ShortText.
- title
Template: ShortText.
- published
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- published_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/themes.json.Documentation: https://help.shopify.com/api/reference/theme#index.
- [Create] action
-
Endpoint URL address:
/themes.json.Documentation: https://help.shopify.com/api/reference/theme#create.
- [Update] action
-
Endpoint URL address:
/themes/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/theme#update.
- [Delete] action
-
Endpoint URL address:
/themes/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/theme#destroy.
- id
A key field. Template: Id.
- name
Template: ShortText.
- src
Template: ShortText.
- role
Template: ShortText.
- previewable
Data type: DT_BOOL
- processing
Data type: DT_BOOL
- theme_store_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orders/{{=parameters.order_id}}/transactions.json.The action has the following user-defined parameters:
- order_id: Required. Specify order identifier.
Documentation: https://help.shopify.com/api/reference/transaction#index.
- [Create] action
-
Endpoint URL address:
/orders/{{=item.order_id}}/transactions.json.Documentation: https://help.shopify.com/api/reference/transaction#create.
The resource includes the fields from the Transaction template.
- receipt
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: id, object, amount, amount_capturable, amount_received, canceled_at, cancellation_reason, capture_method, charges, confirmation_method, created, currency, last_payment_error, livemode, metadata, next_action, payment_method, payment_method_types, source, status.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recurring_application_charges/{{=parameters.recurring_application_charge_id}}/usage_charges.json.The action has the following user-defined parameters:
- recurring_application_charge_id: Required. Specify recurring application charge identifier.
Documentation: https://help.shopify.com/api/reference/usagecharge#index.
- [Create] action
-
Endpoint URL address:
/recurring_application_charges/{{=item.recurring_application_charge_id}}/usage_charges.json.Documentation: https://help.shopify.com/api/reference/usagecharge#create.
- id
A key field. Template: Id.
- description
Template: ShortText.
- price
Template: Currency.
- recurring_application_charge_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- billing_on
Template: DateTime. A read-only field.
- balance_used
Template: Currency. A read-only field.
- balance_remaining
Template: Currency. A read-only field.
- risk_level
Data type: DT_R8
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.json.Documentation: https://help.shopify.com/api/reference/user#index.
- id
A key field. Template: Id.
- account_owner
Data type: DT_BOOL
- bio
Template: LongText.
Template: ShortText.
- first_name
Template: ShortText.
- im
Template: ShortText.
- last_name
Template: ShortText.
- permissions
Template: LongText.
- phone
Template: ShortText.
- receive_announcements
Data type: DT_I4
- screen_name
Template: ShortText.
- url
Template: ShortText.
- user_type
Template: ShortText.
- phone_validated
Data type: DT_BOOL
- tfa_enabled
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.json.Documentation: https://help.shopify.com/api/reference/webhook#index.
- [Create] action
-
Endpoint URL address:
/webhooks.json.Documentation: https://help.shopify.com/api/reference/webhook#create.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/webhook#update.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.json.Documentation: https://help.shopify.com/api/reference/webhook#destroy.
- id
A key field. Template: Id.
- address
Template: ShortText.
- fields
Template: LongText. A composite field.
- format
Template: ShortText.
- metafield_namespaces
Template: LongText. A composite field.
- topic
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shopify_payments/payouts.json.Documentation: https://shopify.dev/api/admin-rest/2022-01/resources/payouts#[get]/admin/api/2022-01/shopify_payments/payouts.json.
- id
A key field. Template: Id.
- status
Template: ShortText.
- date
Data type: DT_DBDATE
- currency
Template: ShortText.
- amount
Template: Currency.
- summary
Field components:
-
Uses template:
Currency. - Contains the following components: adjustments_fee_amount, adjustments_gross_amount, charges_fee_amount, charges_gross_amount, refunds_fee_amount, refunds_gross_amount, reserved_funds_fee_amount, reserved_funds_gross_amount, retried_payouts_fee_amount, retried_payouts_gross_amount.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shopify_payments/balance.json.Documentation: https://shopify.dev/api/admin-rest/2022-01/resources/balance#get-shopify-payments-balance.
- currency
Template: ShortText.
- amount
Template: Currency.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shopify_payments/disputes.json.Documentation: https://shopify.dev/api/admin-rest/2022-01/resources/dispute#[get]/admin/api/2022-01/shopify_payments/disputes.json.
- id
A key field. Template: Id.
- order_id
Template: Id.
- type
Template: ShortText.
- amount
Template: Currency.
- currency
Template: ShortText.
- reason
Template: ShortText.
- network_reason_code
Template: ShortText.
- status
Template: ShortText.
- evidence_due_by
Template: DateTime.
- evidence_sent_on
Template: DateTime.
- finalized_on
Template: DateTime.
- initiated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/shopify_payments/balance/transactions.json.Documentation: https://shopify.dev/api/admin-rest/2022-01/resources/transactions#get-shopify-payments-balance-transactions.
- id
A key field. Template: Id.
- type
Template: ShortText.
- test
Data type: DT_BOOL
- payout_id
Data type: DT_I4
- payout_status
Template: ShortText.
- currency
Template: ShortText.
- amount
Template: Currency.
- fee
Template: Currency.
- net
Template: Currency.
- source_id
Template: Id.
- source_type
Template: ShortText.
- source_order_id
Template: Id.
- source_order_transaction_id
Template: Id.
- processed_at
Template: DateTime.
- [Read] action
-
The result is extracted from:{{=response[resource.objects]}}.
The result is paginated.The following request parameters will be automatically processed:
-
page_info:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
fields:
{{=_.filter(parameters.fields, function(item) { return item.indexOf('.') == -1; }).join()}} -
_includeUserParameters:
{{=parameters}}
-
page_info:
- [Create] action
-
The result is extracted from:{{=response[resource.object]}}.
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }}
-
application/json:
- [Update] action
-
The result is extracted from:{{=response[resource.object]}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{= function(item) { var result = {}; result[resource.object] = item; return result; }(item) }}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- LongerText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value * 1000).toUTCString()}}expression.- Currency
Data type: DT_CY
- Code2
Data type: DT_WSTR ( length 2 )
- Code3
Data type: DT_WSTR ( length 3 )
- Id
Data type: DT_UI8
- Address
Field components:
-
Uses template:
Id. - Contains the following components: id, address1, address2, city, company, country, country_code, first_name, last_name, latitude, longitude, name, phone, province, province_code, zip, default.
-
Uses template:
- Metafields
Field components:
- An array.
- Contains the following components: key, value, type, namespace, description.
- Image
Field components:
-
Uses template:
ShortText. - Contains the following components: attachment, src, created_at.
-
Uses template:
- DiscountCodes
Field components:
- An array.
- Contains the following components: amount, code, type.
- Receipt
Field components:
- Contains the following components: testcase, authorization.
- TaxLines
Field components:
- An array.
- Contains the following components: price, rate, title.
- LineItem
Field components:
-
Uses template:
Id. - Contains the following components: id, fulfillable_quantity, fulfillment_service, fulfillment_status, quantity, requires_shipping, taxable, gift_card, shipment_status, title, grams, price, total_discount, tax_lines, product_id, variant_inventory_management, properties, variant_id, variant_title, name, vendor, sku, product_exists.
-
Uses template:
- PaymentDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: avs_result_code, credit_card_bin, cvv_result_code, credit_card_number, credit_card_company.
-
Uses template:
- Transaction
Field components:
-
Uses template:
Id. - Contains the following components: id, amount, authorization, device_id, parent_id, gateway, source_name, payment_details, kind, order_id, error_code, status, message, test, user_id, currency, location_id, created_at.
-
Uses template:
- Province
Field components:
-
Uses template:
Id. - Contains the following components: id, code, country_id, name, tax, tax_name, tax_type, tax_percentage.
-
Uses template:
- Fulfillment
Field components:
-
Uses template:
Id. - Contains the following components: id, line_items, order_id, receipt, status, service, tracking_company, shipment_status, tracking_number, tracking_numbers, tracking_url, tracking_urls, variant_inventory_management, location_id, created_at, updated_at, name, origin_address.
-
Uses template:
- Customer
Field components:
-
Uses template:
Id. - Contains the following components: id, email, accepts_marketing, first_name, last_name, orders_count, state, total_spent, last_order_id, last_order_name, note, verified_email, multipass_identifier, tax_exempt, tags, default_address, created_at, updated_at.
-
Uses template:
- Variant
Field components:
-
Uses template:
Id. - Contains the following components: id, barcode, compare_at_price, fulfillment_service, grams, weight, weight_unit, inventory_management, inventory_policy, inventory_quantity, metafields, option1, option2, option3, position, price, product_id, requires_shipping, sku, taxable, title, created_at, updated_at.
-
Uses template:
- Metadata
Field components:
-
Uses template:
ShortText. - Contains the following components: shop_id, shop_name, transaction_fee_total_amount, transaction_fee_tax_amount, payments_charge_id, order_transaction_id, manual_entry, order_id.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the Shopify Connection?
- How to manually generate a Shopify Token?
What's New
- New: Updated Fulfillment resource to use the latest endpoints.
- Fixed: Two resources having the same Transaction name.
- New: Replaced deprecated 'Discount' resource with the new 'Discount | Price Rule' and 'Discount | Discount Code' resources.
- New: Support for 'Payout', 'Balance', 'Dispute', 'Transaction' resources.
- Fixed: Various fixes.
- New: Support for cursor-based pagination process.
- New: Support for 'Inventory Item', 'Inventory Level', 'Inventory Location' resources.
- Fixed: Various fixes (Thank you Moe, Gaurav).
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.