Shopify Connector 1.0 Reference
Anypoint Connector for Shopify (Shopify Connector) enables you to access the Shopify REST Admin API.
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
Name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
Connection types for this configuration. |
x |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
60 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
SECONDS |
|
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
AUTO |
|
Name |
String |
ID used to reference this configuration. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
Connection Types
Basic Auth Connection Provider
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
|||
Query Parameters |
Array of Default Query Param. |
|||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections: * Mule uses persistent connections. * Mule closes the connection after the first request completes. |
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Username |
String |
Username to authenticate the requests. |
x |
|
Password |
String |
Password to authenticate the requests. |
||
Base Uri |
String |
Parameter base URI. Each instance and tenant gets its own. |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. |
HTTP |
|
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
Oauth2 Connection Provider
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header. |
|||
Query Parameters |
Array of Default Query Param. |
|||
Connection Timeout |
Number |
How long the connector waits before timing out when establishing a connection to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Timeout field. |
SECONDS |
|
Use Persistent Connections |
Boolean |
Indicates whether to use persistent connections: * Mule uses persistent connections. * Mule closes the connection after the first request completes. |
true |
|
Max Connections |
Number |
Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput. |
-1 |
|
Connection Idle Timeout |
Number |
When persistent connections are enabled, how long a connection can remain idle before Mule closes it. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit for the Connection Idle Timeout field. |
SECONDS |
|
Proxy Config |
Configures a proxy for outbound connections. |
|||
Stream Response |
Boolean |
If this value is |
false |
|
Response Buffer Size |
Number |
Size of the buffer that stores the HTTP response, in bytes. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance and tenant gets its own. |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. |
HTTP |
|
TLS Configuration |
Configures TLS. If using the HTTPS protocol, you must configure TLS. |
|||
Reconnection |
Configures a reconnection strategy to use when a connector operation fails to connect to an external server. |
|||
Consumer Key |
String |
OAuth consumer key, as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret, as registered with the service provider. |
x |
|
Authorization Url |
String |
URL of the service provider’s authorization endpoint. |
||
Access Token Url |
String |
URL of the service provider’s access token endpoint. |
||
Scopes |
String |
OAuth scopes to request during the OAuth dance. |
read_products write_products read_customers write_customers read_orders write_orders read_all_orders |
|
Resource Owner Id |
String |
Resource owner ID to use with the authorization code grant type. |
||
Before |
String |
Name of the flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of the flow to execute immediately after receiving the access token. |
||
Listener Config |
String |
Configuration for the HTTP listener that listens for requests on the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL. |
||
Object Store |
String |
Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store. |
Associated Operations
Shopify Connector operations use the 2021-10 event version for Webhook subscriptions.
|
Customer Count
<shopify-connector-mule-4:customer-count>
Retrieves a count of all customers. This operation makes an HTTP GET request to the /admin/api/2021-10/customers/count.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Create
<shopify-connector-mule-4:customer-create>
Creates a customer. This operation makes an HTTP POST request to the /admin/api/2021-10/customers.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Create Account Activation Url
<shopify-connector-mule-4:customer-create-account-activation-url>
Generate an account activation URL for a customer whose account is not yet enabled. This operation makes an HTTP POST request to the /admin/api/2021-10/customers/{customer_id}/account_activation_url.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Delete
<shopify-connector-mule-4:customer-delete>
Deletes a customer. A customer cannot be deleted if they have existing orders. This operation makes an HTTP DELETE request to the /admin/api/2021-10/customers/{customer_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Get
<shopify-connector-mule-4:customer-get>
Retrieves a single customer. This operation makes an HTTP GET request to the /admin/api/2021-10/customers/{customer_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer List
<shopify-connector-mule-4:customer-list>
Retrieves a list of customers. This operation makes an HTTP GET request to the /admin/api/2021-10/customers.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
ids |
String |
Restrict results to customers specified by a comma-separated list of IDs. |
||
Since ID |
Number |
Restrict results to those after the specified ID. |
||
Created at min |
String |
Show the customers created after a specified date. The format is |
||
Created at max |
String |
Show the customers created before a specified date. The format is |
||
Updated at min |
String |
Show the customers last updated after a specified date. The format is |
||
Updated at max |
String |
Show the customers last updated before a specified date. The format is |
||
limit |
Number |
Amount of results to return. The maximum is 250. |
50 |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer List Orders
<shopify-connector-mule-4:customer-list-orders>
Retrieves all of the orders belonging to a customer. This operation makes an HTTP GET request to the /admin/api/2021-10/customers/{customer_id}/orders.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Search
<shopify-connector-mule-4:customer-search>
Searches for customers that match a supplied query. This operation makes an HTTP GET request to the /admin/api/2021-10/customers/search.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
order |
String |
Set the field and direction by which to order results. |
last_order_date DESC |
|
query |
String |
Text to search in the shop’s customer data. Note that there is a set of supported queries (check Shopify documentation). All other queries return all customers. |
||
limit |
Number |
Amount of results to return. The maximum is 250. |
50 |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Send Account Invite
<shopify-connector-mule-4:customer-send-account-invite>
Sends an account invite to a customer. This operation makes an HTTP POST request to the /admin/api/2021-10/customers/{customer_id}/send_invite.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Customer Update
<shopify-connector-mule-4:customer-update>
Updates a customer. This operation makes an HTTP PUT request to the /admin/api/2021-10/customers/{customer_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Customer ID |
Number |
Customer ID. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Cancel
<shopify-connector-mule-4:order-cancel>
Cancels an order. Orders that have a fulfillment object cannot be cancelled. This operation makes an HTTP POST request to the /admin/api/2021-10/orders/{order_id}/cancel.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Close
<shopify-connector-mule-4:order-close>
Closes an order. This operation makes an HTTP POST request to the /admin/api/2021-10/orders/{order_id}/close.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Create
<shopify-connector-mule-4:order-create>
Creates an order. This operation makes an HTTP POST request to the /admin/api/2021-10/orders.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Delete
<shopify-connector-mule-4:order-delete>
Deletes an order. Orders that interact with an online gateway cannot be deleted. This operation makes an HTTP DELETE request to the /admin/api/2021-10/orders/{order_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Get
<shopify-connector-mule-4:order-get>
Retrieves a specific order. This operation makes an HTTP GET request to the /admin/api/2021-10/orders/{order_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order List
<shopify-connector-mule-4:order-list>
Retrieves a list of orders. This operation makes an HTTP GET request to the /admin/api/2021-10/orders.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
ids |
String |
Retrieve only orders specified by a comma-separated list of order IDs. |
||
limit |
Number |
Amount of results to return. The maximum is 250. |
50 |
|
Since ID |
Number |
Restrict results to those after the specified ID. |
||
Created at min |
String |
Show orders created at or after the date specified in this field. The format is |
||
Created at max |
String |
Show orders created at or before date. The format is |
||
Updated at min |
String |
Show orders last updated at or after the date specified in this field. The format is |
||
Updated at max |
String |
Show orders last updated at or before date. The format is |
||
Processed at min |
String |
Show orders imported at or after the date specified in this field. The format is |
||
Processed at max |
String |
Show orders imported at or before date. The format is |
||
Attribution app ID |
String |
Show orders attributed to a certain app, specified by the app ID. Set as |
||
status |
Enumeration, one of:
|
Filter orders by their status. |
||
Financial status |
Enumeration, one of:
|
Filter orders by their financial status. |
||
Fulfillment status |
Enumeration, one of:
|
Filter orders by their fulfillment status. |
||
fields |
String |
Comma-separated list of fields to include in the response. |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Reopen
<shopify-connector-mule-4:order-reopen>
Reopens a closed order. This operation makes an HTTP POST request to the /admin/api/2021-10/orders/{order_id}/open.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Order Update
<shopify-connector-mule-4:order-update>
Updates an order. Note that this operation is not for editing the items of an order. This operation makes an HTTP PUT request to the /admin/api/2021-10/orders/{order_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Count
<shopify-connector-mule-4:product-count>
Retrieves a count of products. This operation makes an HTTP GET request to the /admin/api/2021-10/products/count.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
vendor |
String |
Return the product count by product title. |
||
Product type |
String |
Return the product count by product type |
||
Collection ID |
Number |
Return the product count by product collection ID. |
||
Created at min |
String |
Return the product count created after a specified date. The format is |
||
Created at max |
String |
Return the product count before a specified date. The format is |
||
Updated at min |
String |
Return the product count last updated after date. The format is |
||
Updated at max |
String |
Return the product count published after date. The format is |
||
Published at min |
String |
Return the product count published after date. The format is |
||
Published at max |
String |
Return the product count published before date. The format is |
||
Published status |
Enumeration, one of:
|
Return the product count with a given published status. |
ANY |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Create
<shopify-connector-mule-4:product-create>
Creates a new product. This operation makes an HTTP POST request to the /admin/api/2021-10/products.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Delete
<shopify-connector-mule-4:product-delete>
Deletes a product. This operation makes an HTTP DELETE request to the /admin/api/2021-10/products/{product_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Get
<shopify-connector-mule-4:product-get>
Retrieves a single product. This operation makes an HTTP GET request to the /admin/api/2021-10/products/{product_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product List
<shopify-connector-mule-4:product-list>
Retrieves a list of products. This operation makes an HTTP GET request to the /admin/api/2021-10/products.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Published status |
Enumeration, one of:
|
Return products with a given published status. |
ANY |
|
Since ID |
Number |
Restrict results to those after the specified ID. |
||
Created at max |
String |
Return products created before a specified date. The format is |
||
Published at max |
String |
Return products published before date. The format is |
||
Collection ID |
Number |
Return products by product collection ID. The format is |
||
Updated at min |
String |
Return products last updated after date. The format is |
||
Updated at max |
String |
Return products published after date. The format is |
||
Published at min |
String |
Return products published after date. The format is |
||
limit |
Number |
Amount of results to return. The maximum is 250. |
50 |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
status |
Enumeration, one of:
|
Return only products specified by a comma-separated list of statuses. Default any |
||
Created at min |
String |
Return products created after a specified date. The format is |
||
ids |
String |
Return only products specified by a comma-separated list of product IDs. |
||
title |
String |
Return products by product title. |
||
vendor |
String |
Return products by product vendor. |
||
Presentment currencies |
String |
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. |
||
handle |
String |
Return only products specified by a comma-separated list of product handles. |
||
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Update
<shopify-connector-mule-4:product-update>
Updates a product and its variants and images. This operation makes an HTTP PUT request to the /admin/api/2021-10/products/{product_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant Count
<shopify-connector-mule-4:product-variant-count>
Retrieves a count of product variants. This operation makes an HTTP GET request to the /admin/api/2021-10/products/{product_id}/variants/count.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant Create
<shopify-connector-mule-4:product-variant-create>
Creates a new product variant. This operation makes an HTTP POST request to the /admin/api/2021-10/products/{product_id}/variants.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant Delete
<shopify-connector-mule-4:product-variant-delete>
Delete a product variant. This operation makes an HTTP DELETE request to the /admin/api/2021-10/products/{product_id}/variants/{variant_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
Variant ID |
Number |
Variant ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant Get
<shopify-connector-mule-4:product-variant-get>
Retrieves a single product variant by ID. This operation makes an HTTP GET request to the /admin/api/2021-10/variants/{variant_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Variant ID |
Number |
Variant ID. |
x |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant List
<shopify-connector-mule-4:product-variant-list>
Retrieves a list of product variants. This operation makes an HTTP GET request to the /admin/api/2021-10/products/{product_id}/variants.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
Number |
Product ID. |
x |
|
limit |
Number |
Amount of results to return. The maximum is 250. |
50 |
|
Presentment currencies |
String |
Return presentment prices in only certain currencies, specified by a comma-separated list of ISO 4217 currency codes. |
||
Since ID |
Number |
Restrict results to those after the specified ID. |
||
fields |
String |
Comma-separated list of fields to include in the response. |
||
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Output Mime Type |
String |
MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Product Variant Update
<shopify-connector-mule-4:product-variant-update>
Updates an existing product variant. This operation makes an HTTP PUT request to the /admin/api/2021-10/variants/{variant_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Variant ID |
Number |
Variant ID. |
x |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-presentment-prices to return a presentment_prices property. |
||
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Transaction Count
<shopify-connector-mule-4:transaction-count>
Retrieves a count of an order’s transactions. This operation makes an HTTP GET request to the /admin/api/2021-10/orders/{order_id}/transactions/count.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Transaction Create
<shopify-connector-mule-4:transaction-create>
Creates a transaction for an order. This operation makes an HTTP POST request to the /admin/api/2021-10/orders/{order_id}/transactions.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Body |
Any |
Content to use. |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
||
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Transaction Get
<shopify-connector-mule-4:transaction-get>
Retrieves a specific transaction. This operation makes an HTTP GET request to the /admin/api/2021-10/orders/{order_id}/transactions/{transaction_id}.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Transaction ID |
Number |
Transaction ID. |
x |
|
fields |
String |
Comma-separated list of fields to include in the response. |
||
In shop currency |
Boolean |
Show amounts in the shop currency for the underlying transaction. |
false |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-currency-exchange-adjustments to return a currency_exchange_adjustment property. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Transaction List
<shopify-connector-mule-4:transaction-list>
Retrieves a list of transactions. This operation makes an HTTP GET request to the /admin/api/2021-10/orders/{order_id}/transactions.json endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Order ID |
Number |
Order ID. |
x |
|
Since ID |
Number |
Restrict results to those after the specified ID. |
||
fields |
String |
Comma-separated list of fields to include in the response. |
||
In shop currency |
Boolean |
Show amounts in the shop currency for the underlying transaction. |
false |
|
X Shopify Api Features |
Enumeration, one of:
|
Must have a value for include-currency-exchange-adjustments to return a currency_exchange_adjustment property. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Custom Query Parameters |
Object |
Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration. |
#[null] |
|
Custom Headers |
Object |
Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration. |
||
Response Timeout |
Number |
How long Mule waits for a response to complete before the request times out. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit for the Response Timeout field. |
||
Streaming Type |
Enumeration, one of:
|
How the connector streams request content to the remote service: * Connector automatically uses the best streaming strategy based on the request content. * Connector always streams the request content. * Connector does not stream the request content. |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field. |
#[payload] |
|
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Throws
-
SHOPIFY-CONNECTOR-MULE-4:BAD_REQUEST
-
SHOPIFY-CONNECTOR-MULE-4:CLIENT_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:CONNECTIVITY
-
SHOPIFY-CONNECTOR-MULE-4:INTERNAL_SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:NOT_ACCEPTABLE
-
SHOPIFY-CONNECTOR-MULE-4:NOT_FOUND
-
SHOPIFY-CONNECTOR-MULE-4:RETRY_EXHAUSTED
-
SHOPIFY-CONNECTOR-MULE-4:SERVER_ERROR
-
SHOPIFY-CONNECTOR-MULE-4:SERVICE_UNAVAILABLE
-
SHOPIFY-CONNECTOR-MULE-4:TIMEOUT
-
SHOPIFY-CONNECTOR-MULE-4:TOO_MANY_REQUESTS
-
SHOPIFY-CONNECTOR-MULE-4:UNAUTHORIZED
-
SHOPIFY-CONNECTOR-MULE-4:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<shopify-connector-mule-4:unauthorize>
Deletes all the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Resource Owner Id |
String |
ID of the resource owner of which access must be invalidated. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
On New Customer Trigger
<shopify-connector-mule-4:on-new-customer-trigger>
Triggers an event for a new customer.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Since ID |
String |
Restrict results to those after the specified ID. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New Order Trigger
<shopify-connector-mule-4:on-new-order-trigger>
Triggers an event for a new order.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Since ID |
String |
Restrict results to those after the specified ID. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New Product Trigger
<shopify-connector-mule-4:on-new-product-trigger>
Triggers an event for a new product.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Since ID |
String |
Restrict results to those after the specified ID. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
On New Product Variant Trigger
<shopify-connector-mule-4:on-new-product-variant-trigger>
Triggers an event for a new product variant of a specified product.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
Name of the configuration to use. |
x |
|
Product ID |
String |
The unique numeric identifier for the product. |
x |
|
Since ID |
String |
Restrict results to those after the specified ID. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
x |
|
Primary Node Only |
Boolean |
Determines whether to execute this source on only the primary node when running Mule instances in a cluster. |
||
Scheduling Strategy |
scheduling-strategy |
Configures the scheduler that triggers the polling. |
x |
|
Streaming Strategy |
|
Configures how Mule processes streams. The default is to use repeatable streams. |
||
Redelivery Policy |
Defines a policy for processing the redelivery of the same message. |
|||
Reconnection Strategy |
Retry strategy in case of connectivity errors. |
Types
Default Header
Headers automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Default Query Param
Query parameters automatically added to every outbound request.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Key |
String |
Key for this type. |
x |
|
Value |
String |
Value for this type. |
x |
Proxy
Configures the settings used to connect through a proxy.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
Hostname or IP address of the proxy server. |
x |
|
Port |
Number |
Port of the proxy server. |
x |
|
Username |
String |
Username to authenticate against the proxy server. |
||
Password |
String |
Password to authenticate against the proxy server. |
||
Non Proxy Hosts |
String |
TLS
Configures TLS to provide secure communications for the Mule app.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
Comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
Comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
Configures the TLS truststore. |
|||
Key Store |
Configures the TLS keystore. |
|||
Revocation Check |
Configures a revocation checking mechanism. |
Truststore
Configures the truststore for TLS.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Password |
String |
Password used to protect the truststore. |
||
Type |
String |
Type of truststore. |
||
Algorithm |
String |
Encryption algorithm that the truststore uses. |
||
Insecure |
Boolean |
If |
Keystore
Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible. |
||
Type |
String |
Type of store used. |
||
Alias |
String |
Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file. |
||
Key Password |
String |
Password used to protect the private key. |
||
Password |
String |
Password used to protect the keystore. |
||
Algorithm |
String |
Encryption algorithm that the keystore uses. |
Standard Revocation Check
Configures standard revocation checks for TLS certificates.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Which elements to verify in the certificate chain:
Verify only the last element in the certificate chain.
Verify all elements in the certificate chain. |
||
Prefer Crls |
Boolean |
How to check certificate validity:
Check the Certification Revocation List (CRL) for certificate validity.
Use the Online Certificate Status Protocol (OCSP) to check certificate validity. |
||
No Fallback |
Boolean |
Whether to use the secondary method to check certificate validity:
Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.
Do not use the secondary method to check certificate validity. |
||
Soft Fail |
Boolean |
What to do if the revocation server can’t be reached or is busy:
Avoid verification failure.
Allow the verification to fail. |
Custom OCSP Responder
Configures a custom OCSP responder for certification revocation checks.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore. |
CRL File
Specifies the location of the certification revocation list (CRL) file.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
Path to the CRL file. |
Reconnection
Configures a reconnection strategy for an operation.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:
Allow the deployment to fail.
Ignore the results of the connectivity test. |
||
Reconnection Strategy |
Reconnection strategy to use. |
Reconnect
Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
||
Count |
Number |
How many reconnection attempts the Mule app can make. |
Reconnect Forever
Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often to attempt to reconnect, in milliseconds. |
||
Blocking |
Boolean |
If |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. |
||
Time Unit |
Enumeration, one of:
|
Time unit for the Max Idle Time field. |
HTTP Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value. |
||
Buffer Size Increment |
Number |
Amount by which the buffer size expands if it exceeds its initial size. Setting a value of |
||
Max Buffer Size |
Number |
Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a |
||
Buffer Unit |
Enumeration, one of:
|
Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields. |
Repeatable File Store Stream
Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:
|
||
Buffer Unit |
Enumeration, one of:
|
Unit for the In Memory Size field. |
Redelivery Policy
Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Redelivery Count |
Number |
Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error. |
||
Message Digest Algorithm |
String |
Secure hashing algorithm to use if the Use Secure Hash field is |
||
Message Identifier |
Defines which strategy is used to identify the messages. |
|||
Object Store |
ObjectStore |
Configures the object store that stores the redelivery counter for each message. |
Redelivery Policy Message Identifier
Configures how to identify a redelivered message and how to find out when the message was redelivered.
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Use Secure Hash |
Boolean |
If |
||
Id Expression |
String |
One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed. |